diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000000..77a8dc7c04 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,7 @@ +language: go +go: + - 1.6 + +# Don't want default ./... here: +install: go get -t -v ./test +script: go test -v ./test diff --git a/OWNERS b/OWNERS new file mode 100644 index 0000000000..247d39ea5e --- /dev/null +++ b/OWNERS @@ -0,0 +1,7 @@ +assignees: +- lavalamp +- smarterclayton +- janetkuo +- pwittrock +- kelseyhightower +- jaredbhatti diff --git a/README.md b/README.md index 1a41fe8c53..c6c27f9d3f 100644 --- a/README.md +++ b/README.md @@ -4,44 +4,55 @@ Welcome! We are very pleased you want to contribute to the documentation and/or You can click the "Fork" button in the upper-right area of the screen to create a copy of our site on your GitHub account called a "fork." Make any changes you want in your fork, and when you are ready to send those changes to us, go to the index page for your fork and click "New Pull Request" to let us know about it. +## Staging the site on GitHub Pages + If you want to see your changes staged without having to install anything locally, remove the CNAME file in this directory and change the name of the fork to be: YOUR_GITHUB_USERNAME.github.io -Then, visit: [http://YOUR_GITHUB_USERNAME.github.io](http://YOUR_GITHUB_USERNAME.github.io) +Then make your changes. -You should see a special-to-you version of the site. +When you visit [http://YOUR_GITHUB_USERNAME.github.io](http://YOUR_GITHUB_USERNAME.github.io) you should see a special-to-you version of the site that contains the changes you just made. -## Editing/staging the site locally +## Staging the site locally (using Docker) -If you have files to upload, or just want to work offline, run the below commands to setup -your environment for running GitHub pages locally. Then, any edits you make will be viewable +Don't like installing stuff? Download and run a local staging server with a single `docker run` command. + + git clone https://github.com/kubernetes/kubernetes.github.io.git + cd kubernetes.github.io + docker run -ti --rm -v "$PWD":/k8sdocs -p 4000:4000 johndmulhausen/k8sdocs + +Then visit [http://localhost:4000](http://localhost:4000) to see our site. Any changes you make on your local machine will be automatically staged. + +If you're interested you can view [the Dockerfile for this image](https://gist.github.com/johndmulhausen/f8f0ab8d82d2c755af3a4709729e1859). + +## Staging the site locally (from scratch setup) + +The below commands to setup your environment for running GitHub pages locally. Then, any edits you make will be viewable on a lightweight webserver that runs on your local machine. -First install rvm +This will typically be the fastest way (by far) to iterate on docs changes and see them staged, once you get this set up, but it does involve several install steps that take awhile to complete, and makes system-wide modifications. - curl -sSL https://get.rvm.io | bash -s stable +Install Ruby 2.2 or higher. If you're on Linux, run these commands: -Then load it into your environment + apt-get install software-properties-common + apt-add-repository ppa:brightbox/ruby-ng + apt-get install ruby2.2 + apt-get install ruby2.2-dev - source ${HOME}/.rvm/scripts/rvm (or whatever is prompted by the installer) +* If you're on a Mac, follow [these instructions](https://gorails.com/setup/osx/). +* If you're on a Windows machine you can use the [Ruby Installer](http://rubyinstaller.org/downloads/). During the installation make sure to check the option for *Add Ruby executables to your PATH*. -Then install Ruby 2.2 or higher +The remainder of the steps should work the same across operating systems. - rvm install ruby-2.2.4 - rvm use ruby-2.2.4 --default +To confirm you've installed Ruby correctly, at the command prompt run `gem --version` and you should get a response with your version number. Likewise you can confirm you have Git installed properly by running `git --version`, which will respond with your version of Git. -Verify that this new version is running (optional) - - which ruby - ruby -v - -Install the GitHub Pages package, which includes Jekyll +Install the GitHub Pages package, which includes Jekyll: gem install github-pages -Clone our site +Clone our site: git clone https://github.com/kubernetes/kubernetes.github.io.git @@ -51,15 +62,14 @@ Make any changes you want. Then, to see your changes locally: jekyll serve Your copy of the site will then be viewable at: [http://localhost:4000](http://localhost:4000) -(or wherever Ruby tells you). +(or wherever Jekyll tells you). + + +## GitHub help If you're a bit rusty with git/GitHub, you might wanna read [this](http://readwrite.com/2013/10/02/github-for-beginners-part-2) for a refresher. -The above instructions work on Mac and Linux. -[These instructions ](https://martinbuberl.com/blog/setup-jekyll-on-windows-and-host-it-on-github-pages/) -might help for Windows users. - ## Common Tasks ### Edit Page Titles or Change the Left Navigation @@ -105,7 +115,7 @@ In English, this would read: "Create a set of tabs with the alias `servicesample and have tabs visually labeled "JSON" and "YAML" that use `json` and `yaml` Rouge syntax highlighting, which display the contents of `service-sample.{extension}` on the page, and link to the file in GitHub at (full path)." -Example file: [Pods: Multi-Container](/docs/user-guide/pods/multi-container/). +Example file: [Pods: Multi-Container](http://kubernetes.io/docs/user-guide/pods/multi-container/). ## Use a global variable diff --git a/_config.yml b/_config.yml index c3eaba8b58..5094499bfe 100644 --- a/_config.yml +++ b/_config.yml @@ -16,9 +16,9 @@ defaults: scope: path: "" values: - version: "v1.2" - githubbranch: "release-1.2" - docsbranch: "master" + version: "v1.3" + githubbranch: "master" + docsbranch: "release-1.3" - scope: path: "docs" diff --git a/_data/guides.yml b/_data/guides.yml index f5654a6efd..3f076b7af9 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -58,6 +58,19 @@ toc: path: /docs/user-guide/config-best-practices/ - title: Using kubectl to Manage Resources path: /docs/user-guide/working-with-resources/ + - title: Garbage collection + path: /docs/user-guide/garbage-collector/ + +- title: Batch Jobs + section: + - title: Jobs + path: /docs/user-guide/jobs/ + - title: Parallel Processing using Expansions + path: /docs/user-guide/jobs/expansions/ + - title: Coarse Parallel Processing using a Work Queue + path: /docs/user-guide/jobs/work-queue-1/ + - title: Fine Parallel Processing using a Work Queue + path: /docs/user-guide/jobs/work-queue-2/ - title: Service Discovery and Load Balancing section: @@ -69,6 +82,8 @@ toc: path: /docs/user-guide/load-balancer/ - title: Configuring Your Cloud Provider's Firewalls path: /docs/user-guide/services-firewalls/ + - title: Cross-cluster Service Discovery using Federated Services + path: /docs/user-guide/federation/federated-services/ - title: Containers and Pods section: @@ -102,6 +117,8 @@ toc: path: /docs/user-guide/downward-api/volume - title: Persistent Volumes Walkthrough path: /docs/user-guide/persistent-volumes/walkthrough/ + - title: Bootstrapping Pet Sets + path: /docs/user-guide/petset/bootstrapping/ - title: Monitoring, Logging, and Debugging Containers section: @@ -111,8 +128,6 @@ toc: path: /docs/getting-started-guides/logging/ - title: Logging with Elasticsearch and Kibana path: /docs/getting-started-guides/logging-elasticsearch/ - - title: Elasticsearch/Kibana Logging Demo - path: /docs/user-guide/logging-demo - title: Running Commands in a Container with kubectl exec path: /docs/user-guide/getting-into-containers/ - title: Connect with Proxies @@ -120,7 +135,7 @@ toc: - title: Connect with Port Forwarding path: /docs/user-guide/connecting-to-applications-port-forward/ - title: Using Explorer to Examine the Runtime Environment - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/explorer + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/explorer - title: Creating a Cluster section: @@ -128,12 +143,10 @@ toc: path: /docs/getting-started-guides/ - title: Running Kubernetes on Your Local Machine section: - - title: Running Kubernetes Locally via Docker - path: /docs/getting-started-guides/docker/ - - title: Running Kubernetes Locally with No VM - path: /docs/getting-started-guides/locally/ - - title: Running Kubernetes Locally with Vagrant - path: /docs/getting-started-guides/vagrant/ + - title: Running Kubernetes Locally via Minikube + path: /docs/getting-started-guides/minikube/ + - title: Deprecated Alternatives + path: /docs/getting-started-guides/alternatives/ - title: Running Kubernetes on Turn-key Cloud Solutions section: - title: Running Kubernetes on Google Container Engine @@ -142,18 +155,12 @@ toc: path: /docs/getting-started-guides/gce/ - title: Running Kubernetes on AWS EC2 path: /docs/getting-started-guides/aws/ - - title: Running Kubernetes on Azure + - title: Running Kubernetes on Azure (Weave-based) path: /docs/getting-started-guides/coreos/azure/ + - title: Running Kubernetes on Azure (Flannel-based) + path: /docs/getting-started-guides/azure/ - title: Running Kubernetes on CenturyLink Cloud path: /docs/getting-started-guides/clc/ - - title: Portable Multi-Node Clusters - section: - - title: Installing a Kubernetes Master Node via Docker - path: /docs/getting-started-guides/docker-multinode/master/ - - title: Adding a Kubernetes Worker Node via Docker - path: /docs/getting-started-guides/docker-multinode/worker/ - - title: Deploying DNS - path: /docs/getting-started-guides/docker-multinode/deployDNS/ - title: Running Kubernetes on Custom Solutions section: - title: Creating a Custom Cluster from Scratch @@ -172,8 +179,10 @@ toc: path: /docs/getting-started-guides/coreos/ - title: Cloudstack path: /docs/getting-started-guides/cloudstack/ - - title: VMWare + - title: VMware vSphere path: /docs/getting-started-guides/vsphere/ + - title: VMware Photon Controller + path: /docs/getting-started-guides/photon-controller/ - title: Juju path: /docs/getting-started-guides/juju/ - title: DCOS @@ -190,9 +199,9 @@ toc: path: /docs/getting-started-guides/fedora/fedora-calico/ - title: rkt section: - - title: Running Kubernetes on rkt + - title: Running Kubernetes with rkt path: /docs/getting-started-guides/rkt/ - - title: Notes on Different UX with rkt Container Runtime + - title: Known Issues when Using rkt path: /docs/getting-started-guides/rkt/notes/ - title: Kubernetes on Mesos path: /docs/getting-started-guides/mesos/ @@ -210,12 +219,16 @@ toc: path: /docs/getting-started-guides/fedora/flannel_multi_node_cluster/ - title: CentOS path: /docs/getting-started-guides/centos/centos_manual_config/ - - title: Ubuntu - path: /docs/getting-started-guides/ubuntu/ + - title: CoreOS + path: /docs/getting-started-guides/coreos - title: CoreOS with Calico path: /docs/getting-started-guides/coreos/bare_metal_calico/ + - title: Ubuntu + path: /docs/getting-started-guides/ubuntu/ - title: Ubuntu Nodes with Calico path: /docs/getting-started-guides/ubuntu-calico/ + - title: Portable Multi-Node Cluster + path: /docs/getting-started-guides/docker-multinode/ - title: Building Large Clusters path: /docs/admin/cluster-large/ - title: Running in Multiple Zones @@ -243,6 +256,8 @@ toc: path: /docs/admin/cluster-components/ - title: Configuring Kubernetes Use of etcd path: /docs/admin/etcd/ + - title: Federating Clusters + path: /docs/admin/federation/ - title: Using Multiple Clusters path: /docs/admin/multi-cluster/ - title: Changing Cluster Size @@ -254,14 +269,18 @@ toc: - title: Using DNS Pods and Services path: /docs/admin/dns/ - title: Setting Up and Configuring DNS - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/cluster-dns + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/cluster-dns - title: Master <-> Node Communication path: /docs/admin/master-node-communication/ - title: Network Plugins path: /docs/admin/network-plugins/ - title: Static Pods path: /docs/admin/static-pods/ - - title: Configuring Garbage Collection + - title: Configuring kubelet Garbage Collection path: /docs/admin/garbage-collection/ + - title: Configuring Out Of Resource Handling + path: /docs/admin/out-of-resource/ - title: Configuring Kubernetes with Salt path: /docs/admin/salt/ + - title: Monitoring Node Health + path: /docs/admin/node-problem/ diff --git a/_data/overrides.yml b/_data/overrides.yml index 7fd399130c..ef820044e9 100644 --- a/_data/overrides.yml +++ b/_data/overrides.yml @@ -1,15 +1,17 @@ overrides: - path: docs/api-reference - path: docs/user-guide/kubectl +- path: docs/admin/federation-apiserver.md +- path: docs/admin/federation-controller-manager.md - path: docs/admin/kube-apiserver.md - path: docs/admin/kube-controller-manager.md - path: docs/admin/kube-proxy.md - path: docs/admin/kube-scheduler.md - path: docs/admin/kubelet.md -- changedpath: docs/api-reference/extensions/v1beta1/definitions.html _includes/v1.2/extensions-v1beta1-definitions.html -- changedpath: docs/api-reference/extensions/v1beta1/operations.html _includes/v1.2/extensions-v1beta1-operations.html -- changedpath: docs/api-reference/v1/definitions.html _includes/v1.2/v1-definitions.html -- changedpath: docs/api-reference/v1/operations.html _includes/v1.2/v1-operations.html +- changedpath: docs/api-reference/extensions/v1beta1/definitions.html _includes/v1.3/extensions-v1beta1-definitions.html +- changedpath: docs/api-reference/extensions/v1beta1/operations.html _includes/v1.3/extensions-v1beta1-operations.html +- changedpath: docs/api-reference/v1/definitions.html _includes/v1.3/v1-definitions.html +- changedpath: docs/api-reference/v1/operations.html _includes/v1.3/v1-operations.html - copypath: k8s/cluster/saltbase/salt/fluentd-gcp/fluentd-gcp.yaml docs/getting-started-guides/fluentd-gcp.yaml - copypath: k8s/examples/blog-logging/counter-pod.yaml docs/getting-started-guides/counter-pod.yaml - copypath: k8s/examples/blog-logging/counter-pod.yaml docs/user-guide/counter-pod.yaml diff --git a/_data/reference.yml b/_data/reference.yml index 3b9b864cc7..f4ddb977f8 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -27,13 +27,6 @@ toc: - title: Kubernetes API Swagger Spec path: /kubernetes/third_party/swagger-ui/ -- title: Extensions API - section: - - title: Extensions API Operations - path: /docs/api-reference/extensions/v1beta1/operations/ - - title: Extensions API Definitions - path: /docs/api-reference/extensions/v1beta1/definitions/ - - title: Autoscaling API section: - title: Autoscaling API Operations @@ -47,6 +40,13 @@ toc: path: /docs/api-reference/batch/v1/operations/ - title: Batch API Definitions path: /docs/api-reference/batch/v1/definitions/ + +- title: Extensions API + section: + - title: Extensions API Operations + path: /docs/api-reference/extensions/v1beta1/operations/ + - title: Extensions API Definitions + path: /docs/api-reference/extensions/v1beta1/definitions/ - title: kubectl CLI section: @@ -171,71 +171,75 @@ toc: section: - title: kube-apiserver path: /docs/admin/kube-apiserver/ + - title: kube-controller-manager + path: /docs/admin/kube-controller-manager/ - title: kube-proxy path: /docs/admin/kube-proxy/ - title: kube-scheduler path: /docs/admin/kube-scheduler/ - title: kubelet path: /docs/admin/kubelet/ - - title: kube-controller-manager - path: /docs/admin/kube-controller-manager/ - title: Glossary section: + - title: Annotations + path: /docs/user-guide/annotations/ + - title: Daemon Sets + path: /docs/admin/daemons/ + - title: Deployments + path: /docs/user-guide/deployments/ + - title: Horizontal Pod Autoscaling + path: /docs/user-guide/horizontal-pod-autoscaling/ - title: Images path: /docs/user-guide/images/ - - title: Pods - path: /docs/user-guide/pods/ + - title: Ingress Resources + path: /docs/user-guide/ingress/ + - title: Jobs + path: /docs/user-guide/jobs/ - title: Labels and Selectors path: /docs/user-guide/labels/ - - title: Replication Controller - path: /docs/user-guide/replication-controller/ - - title: Services - path: /docs/user-guide/services/ - - title: Volumes - path: /docs/user-guide/volumes/ - - title: Persistent Volumes - path: /docs/user-guide/persistent-volumes/ - - title: Secrets - path: /docs/user-guide/secrets/ - title: Names path: /docs/user-guide/identifiers/ - title: Namespaces path: /docs/user-guide/namespaces/ + - title: Network Policies + path: /docs/user-guide/networkpolicies/ - title: Nodes - path: /docs/admin/node/ - - title: Security Context - path: /docs/user-guide/security-context/ - - title: Service Accounts - path: /docs/user-guide/service-accounts/ - - title: Annotations - path: /docs/user-guide/annotations/ - - title: Daemon Sets - path: /docs/admin/daemons/ - - title: Deployments - path: /docs/user-guide/deployments/ - - title: Ingress Resources - path: /docs/user-guide/ingress/ - - title: Horizontal Pod Autoscaling - path: /docs/user-guide/horizontal-pod-autoscaling/ - - title: Jobs - path: /docs/user-guide/jobs/ - - title: Resource Quotas - path: /docs/admin/resource-quota/ + path: /docs/admin/node/ + - title: Persistent Volumes + path: /docs/user-guide/persistent-volumes/ + - title: Pet Sets + path: /docs/user-guide/petset/ + - title: Pods + path: /docs/user-guide/pods/ - title: Replica Sets path: /docs/user-guide/replicasets/ + - title: Replication Controller + path: /docs/user-guide/replication-controller/ + - title: Resource Quotas + path: /docs/admin/resource-quota/ + - title: Secrets + path: /docs/user-guide/secrets/ + - title: Security Context + path: /docs/user-guide/security-context/ + - title: Services + path: /docs/user-guide/services/ + - title: Service Accounts + path: /docs/user-guide/service-accounts/ + - title: Volumes + path: /docs/user-guide/volumes/ - title: Kubernetes Design Docs section: - title: Kubernetes Architecture - path: https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/design/architecture.md + path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/architecture.md - title: Kubernetes Design Overview - path: https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/design/ - - title: Security in Kubernetes - path: https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/design/security.md + path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/ - title: Kubernetes Identity and Access Management - path: https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/design/access.md - - title: Security Contexts - path: https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/design/security_context.md + path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/access.md - title: Kubernetes OpenVSwitch GRE/VxLAN networking - path: /docs/admin/ovs-networking/ + path: /docs/admin/ovs-networking/ + - title: Security Contexts + path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/security_context.md + - title: Security in Kubernetes + path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/security.md diff --git a/_data/samples.yml b/_data/samples.yml index 3ad519c6be..52ac8d572a 100644 --- a/_data/samples.yml +++ b/_data/samples.yml @@ -7,73 +7,71 @@ toc: - title: Storage / Database / KV section: - title: Apache Cassandra Database - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/cassandra + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/cassandra - title: Ceph - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/rbd/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/rbd/ - title: CephFS - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/cephfs/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/cephfs/ - title: GlusterFS - path: /https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/glusterfs/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/glusterfs/ - title: Hazelcast - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/hazelcast + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/hazelcast - title: iSCSI - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/iscsi/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/iscsi/ - title: MySQL Galera - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/mysql-galera + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/mysql-galera - title: NFS - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/nfs/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/nfs/ - title: Redis - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/redis/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/redis/ - title: RethinkDB - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/rethinkdb/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/rethinkdb/ - title: Vitess - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/vitess/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/vitess/ - title: Big Data section: - title: Apache Spark - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/spark + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/spark - title: Apache Storm - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/storm + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/storm - title: Messaging / Queueing section: - title: Celery + RabbitMQ - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/celery-rabbitmq + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/celery-rabbitmq - title: Hazelcast - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/hazelcast + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/hazelcast - title: Miscellaneous section: - title: Meteor Applications - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/meteor/ - - title: Elasticsearch - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/elasticsearch/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/meteor/ - title: OpenShift Origin - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/openshift-origin/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/openshift-origin/ - title: Selenium - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/selenium/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/selenium/ - title: Monitoring and Logging section: - - title: Elasticsearch/Kibana Logging Demonstration - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/logging-demo/ + - title: Elasticsearch + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/elasticsearch/ - title: NewRelic - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/newrelic + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/newrelic - title: Multi-tier Applications section: - title: Guestbook - Go Server - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/guestbook-go/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/guestbook-go/ - title: GuestBook - PHP Server - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/guestbook/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/guestbook/ - title: MEAN stack on Google Cloud Platform path: /docs/getting-started-guides/meanstack/ - title: MySQL + Wordpress - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/mysql-wordpress-pd/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/mysql-wordpress-pd/ - title: MySQL + Phabricator Server - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/phabricator/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/phabricator/ - title: Nodejs + Mongo - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/nodesjs-mongodb + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/nodesjs-mongodb - title: Petstore - path: https://github.com/kubernetes/kubernetes/tree/release-1.2/examples/k8spetstore/ + path: https://github.com/kubernetes/kubernetes/tree/release-1.3/examples/k8petstore/ diff --git a/_data/support.yml b/_data/support.yml index 4ca3eeff0a..4ca3b339c8 100644 --- a/_data/support.yml +++ b/_data/support.yml @@ -40,3 +40,5 @@ toc: path: https://github.com/kubernetes/kubernetes/milestones/ - title: Contributing to Kubernetes Documentation path: /editdocs/ + - title: New Template Instructions + path: /docs/templatedemos/ diff --git a/_includes/footer.html b/_includes/footer.html index e8d26bbe1f..00ee5554fc 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -14,7 +14,7 @@
Stack Overflow - Mailing List + Mailing List Events Calendar
diff --git a/_includes/head-header.html b/_includes/head-header.html index 48e6a4ab62..12de81d975 100644 --- a/_includes/head-header.html +++ b/_includes/head-header.html @@ -57,7 +57,7 @@ Github Slack Stack Overflow - Mailing List + Mailing List Events Calendar
diff --git a/_includes/templates/_errorthrower.md b/_includes/templates/_errorthrower.md new file mode 100644 index 0000000000..f956a75709 --- /dev/null +++ b/_includes/templates/_errorthrower.md @@ -0,0 +1,16 @@ +### ERROR: You must define a `{{ include.missing_block }}` block +{: style="color:red" } + +This template requires that you provide text that {{ include.purpose }}. The text in this block will +be displayed under the heading **{{ include.heading }}**. + +To get rid of this message and take advantage of this template, define the `{{ include.missing_block }}` +variable and populate it with content. + +```liquid +{% raw %}{%{% endraw %} capture {{ include.missing_block }} {% raw %}%}{% endraw %} +Text that {{ include.purpose }}. +{% raw %}{%{% endraw %} endcapture {% raw %}%}{% endraw %} +``` + + \ No newline at end of file diff --git a/_includes/templates/concept-overview.md b/_includes/templates/concept-overview.md index 07a0d14ce0..0cb0831a81 100644 --- a/_includes/templates/concept-overview.md +++ b/_includes/templates/concept-overview.md @@ -10,20 +10,8 @@ {% else %} -### ERROR: You must define a "what_is" block -{: style="color:red" } +{% include templates/_errorthrower.md missing_block='what_is' heading='What is a (Concept)?' purpose='explains what this concept is and its purpose.' %} -This template requires that you explain what this concept is. This explanation will -be displayed under the heading, **What is a {{ concept }}?** - -To get rid of this message and take advantage of this template, define the `what_is` -variable and populate it with content. - -```liquid -{% raw %}{% capture what_is %}{% endraw %} -A {{ concept }} does x and y and z...(etc, etc, text goes on) -{% raw %}{% endcapture %}{% endraw %} -``` {% endif %} @@ -35,45 +23,21 @@ A {{ concept }} does x and y and z...(etc, etc, text goes on) {% else %} -### ERROR: You must define a "when_to_use" block -{: style="color:red" } +{% include templates/_errorthrower.md missing_block='when_to_use' heading='When to use (Concept)' purpose='explains when to use this object.' %} -This template requires that you explain when to use this object. This explanation will -be displayed under the heading, **When to use {{ concept }}s** - -To get rid of this message and take advantage of this template, define the `when_to_use` -variable and populate it with content. - -```liquid -{% raw %}{% capture when_to_use %}{% endraw %} -You should use {{ concept }} when... -{% raw %}{% endcapture %}{% endraw %} -``` {% endif %} {% if when_not_to_use %} -### When not to use {{ concept }}s (alternatives) +### When not to use {{ concept }}s {{ when_not_to_use }} {% else %} -### ERROR: You must define a "when_not_to_use" block -{: style="color:red" } +{% include templates/_errorthrower.md missing_block='when_not_to_use' heading='When not to use (Concept)' purpose='explains when not to use this object.' %} -This template requires that you explain when not to use this object. This explanation will -be displayed under the heading, **When not to use {{ concept }}s (alternatives)** - -To get rid of this message and take advantage of this template, define the `when_not_to_use` -block and populate it with content. - -```liquid -{% raw %}{% capture when_not_to_use %}{% endraw %} -You should not use {{ concept }} if... -{% raw %}{% endcapture %}{% endraw %} -``` {% endif %} @@ -85,69 +49,23 @@ You should not use {{ concept }} if... {% else %} -### ERROR: You must define a "status" block -{: style="color:red" } +{% include templates/_errorthrower.md missing_block='status' heading='Retrieving status for a (Concept)' purpose='explains how to retrieve a status description for this object.' %} -This template requires that you explain the current status of support for this object. -This explanation will be displayed under the heading, **{{ concept }} status**. - -To get rid of this message and take advantage of this template, define the `status` -block and populate it with content. - -```liquid -{% raw %}{% capture status %}{% endraw %} -The current status of {{ concept }}s is... -{% raw %}{% endcapture %}{% endraw %} -``` {% endif %} -{% if required_fields %} +{% if usage %} -### {{ concept }} spec +#### Usage -#### Required Fields - -{{ required_fields }} +{{ usage }} {% else %} -### ERROR: You must define a "required_fields" block -{: style="color:red" } - -This template requires that you provide a Markdown list of required fields for this -object. This list will be displayed under the heading **Required Fields**. - -To get rid of this message and take advantage of this template, define the `required_fields` -block and populate it with content. - -```liquid -{% raw %}{% capture required_fields %} -* `kind`: Always `Pod`. -* `apiVersion`: Currently `v1`. -* `metadata`: An object containing: - * `name`: Required if `generateName` is not specified. The name of this pod. - It must be an - [RFC1035](https://www.ietf.org/rfc/rfc1035.txt) compatible value and be - unique within the namespace. -{% endcapture %}{% endraw %} -``` - -**Note**: You can also define a `common_fields` block that will go under a heading -directly underneath **Required Fields** called **Common Fields**, but it is -not required. -{% endif %} - - -{% if common_fields %} - -#### Common Fields - -{{ common_fields }} +{% include templates/_errorthrower.md missing_block='usage' heading='Usage' purpose='shows the most basic, common use case for this object, in the form of a code sample, command, etc, using tabs to show multiple approaches' %} {% endif %} - {% else %} diff --git a/_includes/templates/kubectl.md b/_includes/templates/kubectl.md new file mode 100644 index 0000000000..1b50a7b95d --- /dev/null +++ b/_includes/templates/kubectl.md @@ -0,0 +1,37 @@ +{% if command %} + +# {% if site.data.kubectl[command].name != "kubectl" %}kubectl {% endif %}{{ site.data.kubectl[command].name }} + +{{ site.data.kubectl[command].synopsis }} + +## Description + +{{ site.data.kubectl[command].description }} + +{% if site.data.kubectl[command].options %} +## Options + +| Option | Shorthand | Default Value | Usage | +|--------------------|---------------|-------|{% for option in site.data.kubectl[command].options %} +| `{{option.name | strip}}` | {% if option.shorthand %}`{{ option.shorthand | strip }}`{% endif %} | {% if option.default_value %}`{{option.default_value| strip}}`{% endif %} | {% if option.usage %}{{option.usage| strip | replace:'|',', '}}{% endif %} |{% endfor %} +{% endif %} + +{% if site.data.kubectl[command].inherited_options %} +## Inherited Options + +| Option | Shorthand | Default Value | Usage | +|--------------------|---------------|-------|{% for option in site.data.kubectl[command].inherited_options %} +| `{{option.name | strip}}` | {% if option.shorthand %}`{{ option.shorthand | strip }}`{% endif %} | {% if option.default_value %}`{{option.default_value| strip}}`{% endif %} | {% if option.usage %}{{option.usage| strip | replace:'|',', '}}{% endif %} |{% endfor %} +{% endif %} + +## See also + +{% for seealso in site.data.kubectl[command].see_also %} +- [`{{ seealso }}`](/docs/kubectl/{% if seealso != "kubectl" %}kubectl_{{seealso}}{% endif %}) +{% endfor %} + +{% else %} + +{% include templates/_errorthrower.md missing_block='command' heading='kubectl (command)' purpose='names the kubectl command, so that the appropriate YAML file (from _data/kubectl) can be transformed into a page.' %} + +{% endif %} \ No newline at end of file diff --git a/_includes/templates/task.md b/_includes/templates/task.md new file mode 100644 index 0000000000..abb7ea6b10 --- /dev/null +++ b/_includes/templates/task.md @@ -0,0 +1,36 @@ +{% if purpose %} + +### Purpose + +{{ purpose }} + +{% else %} + +{% include templates/_errorthrower.md missing_block='purpose' heading='Purpose' purpose='states, in one sentence, what the purpose of this document is, so that the user will know what they are able to achieve if they follow the provided steps.' %} + +{% endif %} + +{% if recommended_background %} + +### Recommended background + +{{ recommended_background }} + +{% else %} + +{% include templates/_errorthrower.md missing_block='recommended_background' heading='Recommended background' purpose='lists assumptions of baseline knowledge that you expect the user to have before reading ahead.' %} + +{% endif %} + + +{% if step_by_step %} + +### Step by step + +{{ step_by_step }} + +{% else %} + +{% include templates/_errorthrower.md missing_block='step_by_step' heading='Step by step' purpose='lists a series of linear, numbered steps that accomplish the described task.' %} + +{% endif %} \ No newline at end of file diff --git a/_includes/v1.2/extensions-v1beta1-definitions.html b/_includes/v1.3/extensions-v1beta1-definitions.html similarity index 81% rename from _includes/v1.2/extensions-v1beta1-definitions.html rename to _includes/v1.3/extensions-v1beta1-definitions.html index e9c9e2d632..7ecddc8d7b 100755 --- a/_includes/v1.2/extensions-v1beta1-definitions.html +++ b/_includes/v1.3/extensions-v1beta1-definitions.html @@ -1,3 +1,4 @@ + @@ -39,12 +40,18 @@

v1beta1.Scale

  • -

    v1beta1.DaemonSet

    +

    v1beta1.ThirdPartyResource

    +
    • +
  • +

    v1beta1.ThirdPartyResourceList

  • v1beta1.DaemonSetList

  • +

    v1beta1.DaemonSet

    +
    • +

  • v1beta1.Ingress

  • @@ -56,6 +63,12 @@

  • v1beta1.ReplicaSetList

    • +
  • +

    v1beta1.NetworkPolicy

    +
    • +
  • +

    v1beta1.NetworkPolicyList

    +
    • @@ -150,21 +163,21 @@

    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.2/docs/admin/daemons.md

    +

    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.2/docs/admin/daemons.md

    +

    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.2/docs/admin/daemons.md

    +

    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)

    @@ -198,35 +211,35 @@

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -234,6 +247,40 @@ + +
    +

    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

    @@ -375,6 +422,13 @@

    string

    + +

    subPath

    +

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

    +

    false

    +

    string

    + + @@ -411,7 +465,7 @@

    tls

    -

    TLS configuration. Currently the Ingress only supports a single TLS port, 443, and assumes TLS termination. 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.

    +

    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

    @@ -467,75 +521,6 @@ -
    -
    -

    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.2/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.2/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.2/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.2/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.2/examples/cephfs/README.md#how-to-use-it

    false

    boolean

    false

    -

    v1beta1.ReplicaSetList

    @@ -562,28 +547,28 @@

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/user-guide/replication-controller.md

    +

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

    true

    v1beta1.ReplicaSet array

    @@ -591,6 +576,75 @@ +
    +
    +

    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

    @@ -711,6 +765,61 @@ Examples:
    +
    +
    +

    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

    @@ -740,28 +849,28 @@ Examples:

    pdName

    -

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

    +

    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.2/docs/user-guide/volumes.md#gcepersistentdisk

    +

    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.2/docs/user-guide/volumes.md#gcepersistentdisk

    +

    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.2/docs/user-guide/volumes.md#gcepersistentdisk

    +

    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

    @@ -873,7 +982,7 @@ Examples:

    name

    -

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

    +

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

    false

    string

    @@ -938,44 +1047,7 @@ Examples:
    -

    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

    +

    *versioned.Event

    @@ -1003,7 +1075,7 @@ Examples:

    conditions

    -

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

    +

    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

    @@ -1046,6 +1118,47 @@ Examples:
    +
    +
    +

    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

    @@ -1072,7 +1185,7 @@ Examples:

    name

    -

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

    +

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

    false

    string

    @@ -1140,7 +1253,7 @@ Examples:

    name

    -

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

    +

    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

    @@ -1151,7 +1264,7 @@ Examples:

    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.2/docs/devel/api-conventions.md#idempotency

    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#idempotency

    false

    string

    @@ -1160,7 +1273,7 @@ Applied only if Name is not specified. More info:

    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.2/docs/user-guide/namespaces.md

    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

    false

    string

    @@ -1176,7 +1289,7 @@ Must be a DNS_LABEL. Cannot be updated. More info:

    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.2/docs/user-guide/identifiers.md#uids

    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

    false

    string

    @@ -1185,7 +1298,7 @@ Populated by the system. Read-only. More info:

    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.2/docs/devel/api-conventions.md#concurrency-control-and-consistency

    +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

    @@ -1201,7 +1314,7 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a

    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.2/docs/devel/api-conventions.md#metadata

    +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

    @@ -1210,7 +1323,7 @@ Populated by the system. Read-only. Null for lists. More info:

    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.2/docs/devel/api-conventions.md#metadata

    +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

    @@ -1224,16 +1337,30 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    labels

    -

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

    +

    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

    -

    any

    +

    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.2/docs/user-guide/annotations.md

    +

    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

    -

    any

    +

    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

    @@ -1265,21 +1392,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    replicas

    -

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

    +

    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.2/docs/user-guide/labels.md#label-selectors

    +

    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.2/docs/user-guide/replication-controller.md#pod-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

    @@ -1313,14 +1440,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    selector

    -

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

    +

    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.2/docs/user-guide/replication-controller.md#pod-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

    @@ -1354,14 +1481,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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

    @@ -1438,6 +1565,10 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    types.UID

    +

    v1.ISCSIVolumeSource

    @@ -1492,7 +1623,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    fsType

    -

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

    +

    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

    @@ -1533,7 +1664,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    medium

    -

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

    +

    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

    @@ -1567,21 +1698,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#metadata

    +

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

    false

    unversioned.ListMeta

    @@ -1696,7 +1827,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    claimName

    -

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

    +

    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

    @@ -1744,7 +1875,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    resourceVersion

    -

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

    +

    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

    @@ -1778,28 +1909,28 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status.

    +

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

    false

    v1beta1.HorizontalPodAutoscalerSpec

    @@ -1874,11 +2005,18 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    secretName

    -

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

    +

    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

    + + @@ -1914,6 +2052,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +

    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

    @@ -1970,7 +2115,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    secretRef

    -

    Optional: SecretRef is reference to the authentication secret for User, default is empty.

    +

    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

    @@ -1986,7 +2131,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    options

    Optional: Extra command options if any.

    false

    -

    any

    +

    object

    @@ -2102,6 +2247,40 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    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

    @@ -2143,6 +2322,47 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    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

    @@ -2169,14 +2389,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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

    @@ -2184,10 +2404,24 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    gracePeriodSeconds

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

    -

    true

    +

    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

    + @@ -2217,35 +2451,35 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    name

    -

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

    +

    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.2/docs/user-guide/volumes.md#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.2/docs/user-guide/volumes.md#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.2/docs/user-guide/volumes.md#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.2/docs/user-guide/volumes.md#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

    @@ -2259,42 +2493,42 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    secret

    -

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

    +

    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.2/docs/user-guide/volumes.md#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.2/examples/iscsi/README.md

    +

    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.2/examples/glusterfs/README.md

    +

    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.2/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    +

    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.2/examples/rbd/README.md

    +

    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

    @@ -2308,7 +2542,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    cinder

    -

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

    +

    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

    @@ -2355,6 +2589,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    v1.ConfigMapVolumeSource

    + +

    vsphereVolume

    +

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

    +

    false

    +

    v1.VsphereVirtualDiskVolumeSource

    + + @@ -2384,21 +2625,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#metadata

    +

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

    false

    unversioned.ListMeta

    @@ -2415,7 +2656,51 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
    -

    integer

    +

    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

    @@ -2464,14 +2749,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    initialDelaySeconds

    -

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

    +

    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.2/docs/user-guide/pod-states.md#container-probes

    +

    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)

    @@ -2583,6 +2868,61 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    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

    @@ -2609,7 +2949,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    name

    -

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

    +

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

    false

    string

    @@ -2628,6 +2968,54 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    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

    @@ -2662,10 +3050,17 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    fieldRef

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

    -

    true

    +

    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

    + + @@ -2757,21 +3152,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    volumes

    -

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

    +

    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.2/docs/user-guide/containers.md

    +

    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.2/docs/user-guide/pod-states.md#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

    @@ -2799,14 +3194,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    nodeSelector

    -

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

    +

    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

    -

    any

    +

    object

    serviceAccountName

    -

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

    +

    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

    @@ -2855,11 +3250,25 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    imagePullSecrets

    -

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

    +

    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

    + + @@ -2889,14 +3298,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    postStart

    -

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

    +

    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.2/docs/user-guide/container-environment.md#hook-details

    +

    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

    @@ -2904,6 +3313,54 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    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

    @@ -2952,54 +3409,6 @@ Populated by the system when a graceful deletion is requested. Read-only. More i -
    -
    -

    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.2/examples/glusterfs/README.md#create-a-pod

    true

    string

    path

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

    true

    string

    readOnly

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

    false

    boolean

    false

    -

    v1beta1.IngressTLS

    @@ -3067,14 +3476,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    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.2/docs/user-guide/identifiers.md#names

    +

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

    false

    string

    @@ -3122,35 +3531,35 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status.

    +

    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.2/docs/devel/api-conventions.md#spec-and-status. Read-only.

    +

    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

    @@ -3184,56 +3593,56 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    monitors

    -

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

    +

    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.2/examples/rbd/README.md#how-to-use-it

    +

    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.2/docs/user-guide/volumes.md#rbd

    +

    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.2/examples/rbd/README.md#how-to-use-it.

    -

    true

    +

    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.2/examples/rbd/README.md#how-to-use-it

    -

    true

    +

    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.2/examples/rbd/README.md#how-to-use-it

    -

    true

    +

    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 empty. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it

    -

    true

    +

    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.2/examples/rbd/README.md#how-to-use-it

    +

    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

    @@ -3241,6 +3650,58 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    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

    @@ -3274,14 +3735,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    selector

    -

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

    +

    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

    -

    any

    +

    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.2/docs/user-guide/labels.md#label-selectors

    +

    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

    @@ -3289,6 +3750,44 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    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

    @@ -3315,21 +3814,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    server

    -

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

    +

    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.2/docs/user-guide/volumes.md#nfs

    +

    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.2/docs/user-guide/volumes.md#nfs

    +

    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

    @@ -3363,14 +3862,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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

    @@ -3418,14 +3917,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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

    @@ -3441,7 +3940,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    updatedAnnotations

    The annotations to be updated to a deployment

    false

    -

    any

    +

    object

    @@ -3612,6 +4111,68 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    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

    @@ -3759,21 +4320,21 @@ Both these may change in the future. Incoming requests are matched against the h

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#metadata

    +

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

    false

    unversioned.ListMeta

    @@ -3788,6 +4349,44 @@ Both these may change in the future. Incoming requests are matched against the h +
    +
    +

    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

    @@ -3828,7 +4427,7 @@ Both these may change in the future. Incoming requests are matched against the h

    kind

    -

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

    +

    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

    @@ -4010,21 +4609,21 @@ Both these may change in the future. Incoming requests are matched against the h

    image

    -

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

    +

    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.2/docs/user-guide/containers.md#containers-and-commands

    +

    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.2/docs/user-guide/containers.md#containers-and-commands

    +

    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

    @@ -4052,28 +4651,28 @@ Both these may change in the future. Incoming requests are matched against the h

    resources

    -

    Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#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 filesyste. Cannot be updated.

    +

    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.2/docs/user-guide/pod-states.md#container-probes

    +

    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.2/docs/user-guide/pod-states.md#container-probes

    +

    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

    @@ -4094,14 +4693,14 @@ Both these may change in the future. Incoming requests are matched against the h

    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.2/docs/user-guide/images.md#updating-images

    +

    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.2/docs/design/security_context.md

    +

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

    false

    v1.SecurityContext

    @@ -4179,7 +4778,7 @@ Both these may change in the future. Incoming requests are matched against the h

    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] array

    +

    integer (int32) array

    @@ -4194,6 +4793,109 @@ Both these may change in the future. Incoming requests are matched against the h +
    +
    +

    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

    @@ -4220,7 +4922,7 @@ Both these may change in the future. Incoming requests are matched against the h

    replicas

    -

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

    +

    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)

    @@ -4270,7 +4972,7 @@ Both these may change in the future. Incoming requests are matched against the h

    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

    -

    any

    +

    object

    @@ -4283,40 +4985,6 @@ Both these may change in the future. Incoming requests are matched against the h -
    -
    -

    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.2/docs/user-guide/volumes.md#hostpath

    true

    string

    -

    v1beta1.ReplicaSet

    @@ -4343,35 +5011,35 @@ Both these may change in the future. Incoming requests are matched against the h

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -4379,6 +5047,40 @@ Both these may change in the future. Incoming requests are matched against the h +
    +
    +

    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

    @@ -4405,35 +5107,35 @@ Both these may change in the future. Incoming requests are matched against the h

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -4441,44 +5143,6 @@ Both these may change in the future. Incoming requests are matched against the h -
    -
    -

    json.WatchEvent

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

    type

    the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR

    false

    string

    object

    the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR

    false

    string

    -

    v1.CinderVolumeSource

    @@ -4505,21 +5169,21 @@ Both these may change in the future. Incoming requests are matched against the h

    volumeID

    -

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

    +

    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.2/examples/mysql-cinder-pd/README.md

    +

    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.2/examples/mysql-cinder-pd/README.md

    +

    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

    @@ -4596,6 +5260,10 @@ Both these may change in the future. Incoming requests are matched against the h +
    +
    +

    v1.Protocol

    +

    v1.AWSElasticBlockStoreVolumeSource

    @@ -4625,14 +5293,14 @@ Both these may change in the future. Incoming requests are matched against the h

    volumeID

    -

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

    +

    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.2/docs/user-guide/volumes.md#awselasticblockstore

    +

    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

    @@ -4646,7 +5314,7 @@ Both these may change in the future. Incoming requests are matched against the h

    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.2/docs/user-guide/volumes.md#awselasticblockstore

    +

    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

    @@ -4831,16 +5499,16 @@ Both these may change in the future. Incoming requests are matched against the h

    limits

    -

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

    +

    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

    -

    any

    +

    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.2/docs/design/resources.md#resource-specifications

    +

    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

    -

    any

    +

    object

    @@ -4872,14 +5540,14 @@ Both these may change in the future. Incoming requests are matched against the h

    metadata

    -

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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

    @@ -4887,6 +5555,44 @@ Both these may change in the future. Incoming requests are matched against the h +
    +
    +

    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

    @@ -4913,14 +5619,14 @@ Both these may change in the future. Incoming requests are matched against the h

    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.2/docs/user-guide/jobs.md

    +

    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.2/docs/user-guide/jobs.md

    +

    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)

    @@ -4934,21 +5640,21 @@ Both these may change in the future. Incoming requests are matched against the h

    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.2/docs/user-guide/labels.md#label-selectors

    +

    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.2/docs/design/selector-generation.md

    +

    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.2/docs/user-guide/jobs.md

    +

    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

    @@ -4982,28 +5688,28 @@ Both these may change in the future. Incoming requests are matched against the h

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -5065,14 +5771,14 @@ Both these may change in the future. Incoming requests are matched against the h

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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

    @@ -5120,7 +5826,7 @@ Both these may change in the future. Incoming requests are matched against the h

    name

    -

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

    +

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

    false

    string

    @@ -5202,35 +5908,35 @@ Both these may change in the future. Incoming requests are matched against the h

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -5238,6 +5944,61 @@ Both these may change in the future. Incoming requests are matched against the h +
    +
    +

    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

    @@ -5250,8 +6011,8 @@ Both these may change in the future. Incoming requests are matched against the h
    - + \ No newline at end of file diff --git a/_includes/v1.2/extensions-v1beta1-operations.html b/_includes/v1.3/extensions-v1beta1-operations.html similarity index 70% rename from _includes/v1.2/extensions-v1beta1-operations.html rename to _includes/v1.3/extensions-v1beta1-operations.html index ff79dedd17..be39609140 100755 --- a/_includes/v1.2/extensions-v1beta1-operations.html +++ b/_includes/v1.3/extensions-v1beta1-operations.html @@ -1,3 +1,4 @@ + @@ -38,7 +39,7 @@

    default

    success

    -

    string

    +

    unversioned.APIResourceList

    @@ -54,6 +55,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -67,6 +71,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -181,7 +188,7 @@

    200

    success

    -

    v1beta1.DaemonSetList

    +

    v1beta1.DaemonSetList

    @@ -207,6 +214,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -321,7 +331,7 @@

    200

    success

    -

    v1beta1.DeploymentList

    +

    v1beta1.DeploymentList

    @@ -347,6 +357,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -461,7 +474,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscalerList

    +

    v1beta1.HorizontalPodAutoscalerList

    @@ -487,6 +500,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -601,7 +617,7 @@

    200

    success

    -

    v1beta1.IngressList

    +

    v1beta1.IngressList

    @@ -627,6 +643,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -741,7 +760,7 @@

    200

    success

    -

    v1beta1.JobList

    +

    v1beta1.JobList

    @@ -767,6 +786,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -889,7 +911,7 @@

    200

    success

    -

    v1beta1.DaemonSetList

    +

    v1beta1.DaemonSetList

    @@ -915,6 +937,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1037,7 +1062,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -1063,6 +1088,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1119,7 +1147,7 @@

    body

    true

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1153,7 +1181,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1179,6 +1207,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1285,7 +1316,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1311,6 +1342,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1367,7 +1401,7 @@

    body

    true

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1409,7 +1443,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1435,6 +1469,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1491,7 +1528,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -1533,7 +1570,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -1559,6 +1596,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1615,7 +1655,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -1657,7 +1697,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1689,6 +1729,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1704,10 +1747,10 @@
    -

    replace status of the specified DaemonSet

    +

    read status of the specified DaemonSet

    -
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
    @@ -1741,14 +1784,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1beta1.DaemonSet

    - - -

    PathParameter

    namespace

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

    @@ -1787,7 +1822,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1813,6 +1848,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1828,10 +1866,10 @@
    -

    list or watch objects of kind Deployment

    +

    replace status of the specified DaemonSet

    -
    GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments
    +
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
    @@ -1865,43 +1903,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    v1beta1.DaemonSet

    @@ -1912,6 +1918,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the DaemonSet

    +

    true

    +

    string

    + + @@ -1935,7 +1949,7 @@

    200

    success

    -

    v1beta1.DeploymentList

    +

    v1beta1.DaemonSet

    @@ -1961,6 +1975,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1976,10 +1993,10 @@
    -

    delete collection of Deployment

    +

    partially update status of the specified DaemonSet

    -
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments
    +
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status
    @@ -2013,6 +2030,139 @@ +

    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

    + ++++++++ + + + + + + + + + + + + + + + + + + + + @@ -2065,7 +2215,7 @@
    -

    Responses

    +

    Responses

    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.
    @@ -2083,14 +2233,14 @@ - +

    200

    success

    unversioned.Status

    v1beta1.DeploymentList
    -

    Consumes

    +

    Consumes

    • @@ -2100,7 +2250,7 @@
    -

    Produces

    +

    Produces

    • @@ -2109,11 +2259,165 @@

    • application/yaml

      • +
    • +

      application/vnd.kubernetes.protobuf

      +
    -

    Tags

    +

    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

    • @@ -2131,7 +2435,7 @@
    -

    Parameters

    +

    Parameters

    @@ -2165,7 +2469,7 @@ - + @@ -2181,7 +2485,7 @@
    -

    Responses

    +

    Responses

    body

    true

    v1beta1.Deployment

    v1beta1.Deployment
    @@ -2199,14 +2503,14 @@ - +

    200

    success

    v1beta1.Deployment

    v1beta1.Deployment
    -

    Consumes

    +

    Consumes

    • @@ -2216,7 +2520,7 @@
    -

    Produces

    +

    Produces

    • @@ -2225,11 +2529,14 @@

    • application/yaml

      • +
    • +

      application/vnd.kubernetes.protobuf

      +
    -

    Tags

    +

    Tags

    • @@ -2247,7 +2554,7 @@
    -

    Parameters

    +

    Parameters

    @@ -2311,254 +2618,6 @@
    -
    -
    -

    Responses

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

    200

    success

    v1beta1.Deployment

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

    @@ -2579,7 +2638,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1beta1.Deployment

    @@ -2605,6 +2664,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -2620,10 +2682,10 @@
    -

    partially update the specified Deployment

    +

    replace the specified Deployment

    -
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
    +
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
    @@ -2661,7 +2723,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1beta1.Deployment

    @@ -2703,7 +2765,7 @@

    200

    success

    -

    v1beta1.Deployment

    +

    v1beta1.Deployment

    @@ -2714,13 +2776,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -2735,6 +2791,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -2750,10 +2809,10 @@
    -

    create rollback of a DeploymentRollback

    +

    delete a Deployment

    -
    POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/rollback
    +
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
    @@ -2791,7 +2850,7 @@

    body

    true

    -

    v1beta1.DeploymentRollback

    +

    v1.DeleteOptions

    @@ -2805,7 +2864,7 @@

    PathParameter

    name

    -

    name of the DeploymentRollback

    +

    name of the Deployment

    true

    string

    @@ -2833,7 +2892,7 @@

    200

    success

    -

    v1beta1.DeploymentRollback

    +

    unversioned.Status

    @@ -2859,6 +2918,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -2874,10 +2936,10 @@
    -

    read scale of the specified Scale

    +

    partially update the specified Deployment

    -
    GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
    +
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}
    @@ -2911,6 +2973,14 @@ +

    BodyParameter

    +

    body

    + +

    true

    +

    unversioned.Patch

    + + +

    PathParameter

    namespace

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

    @@ -2921,7 +2991,7 @@

    PathParameter

    name

    -

    name of the Scale

    +

    name of the Deployment

    true

    string

    @@ -2949,7 +3019,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Deployment

    @@ -2960,7 +3030,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -2975,6 +3051,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -2990,10 +3069,10 @@
    -

    replace scale of the specified Scale

    +

    create rollback of a DeploymentRollback

    -
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
    +
    POST /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/rollback
    @@ -3031,7 +3110,7 @@

    body

    true

    -

    v1beta1.Scale

    +

    v1beta1.DeploymentRollback

    @@ -3045,7 +3124,7 @@

    PathParameter

    name

    -

    name of the Scale

    +

    name of the DeploymentRollback

    true

    string

    @@ -3073,7 +3152,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.DeploymentRollback

    @@ -3099,6 +3178,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3114,10 +3196,10 @@
    -

    partially update scale of the specified Scale

    +

    read scale of the specified Scale

    -
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
    @@ -3151,14 +3233,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    unversioned.Patch

    - - -

    PathParameter

    namespace

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

    @@ -3197,7 +3271,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -3208,13 +3282,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -3229,6 +3297,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3244,10 +3315,10 @@
    -

    replace status of the specified Deployment

    +

    replace scale of the specified Scale

    -
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
    +
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
    @@ -3285,7 +3356,7 @@

    body

    true

    -

    v1beta1.Deployment

    +

    v1beta1.Scale

    @@ -3299,7 +3370,7 @@

    PathParameter

    name

    -

    name of the Deployment

    +

    name of the Scale

    true

    string

    @@ -3327,7 +3398,7 @@

    200

    success

    -

    v1beta1.Deployment

    +

    v1beta1.Scale

    @@ -3353,6 +3424,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3368,10 +3442,10 @@
    -

    list or watch objects of kind HorizontalPodAutoscaler

    +

    partially update scale of the specified Scale

    -
    GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
    +
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/scale
    @@ -3405,43 +3479,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    unversioned.Patch

    @@ -3452,6 +3494,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the Scale

    +

    true

    +

    string

    + + @@ -3475,7 +3525,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscalerList

    +

    v1beta1.Scale

    @@ -3486,7 +3536,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -3501,6 +3557,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3516,10 +3575,10 @@
    -

    delete collection of HorizontalPodAutoscaler

    +

    read status of the specified Deployment

    -
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
    @@ -3553,49 +3612,17 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

    +

    name

    +

    name of the Deployment

    true

    string

    @@ -3623,7 +3650,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1beta1.Deployment

    @@ -3649,6 +3676,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3664,10 +3694,10 @@
    -

    create a HorizontalPodAutoscaler

    +

    replace status of the specified Deployment

    -
    POST /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers
    +
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status
    @@ -3705,7 +3735,7 @@

    body

    true

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.Deployment

    @@ -3716,6 +3746,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the Deployment

    +

    true

    +

    string

    + + @@ -3739,7 +3777,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.Deployment

    @@ -3765,6 +3803,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3780,6 +3821,560 @@
    +

    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

    @@ -3787,7 +4382,7 @@
    -

    Parameters

    +

    Parameters

    @@ -3851,508 +4446,6 @@
    -
    -
    -

    Responses

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

    200

    success

    v1beta1.HorizontalPodAutoscaler

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

    @@ -4373,7 +4466,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -4399,6 +4492,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4414,10 +4510,10 @@
    -

    list or watch objects of kind Ingress

    +

    replace the specified HorizontalPodAutoscaler

    -
    GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
    +
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
    @@ -4451,43 +4547,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -4498,6 +4562,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the HorizontalPodAutoscaler

    +

    true

    +

    string

    + + @@ -4521,7 +4593,7 @@

    200

    success

    -

    v1beta1.IngressList

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -4547,6 +4619,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4562,10 +4637,10 @@
    -

    delete collection of Ingress

    +

    delete a HorizontalPodAutoscaler

    -
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
    +
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
    @@ -4599,43 +4674,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    v1.DeleteOptions

    @@ -4646,6 +4689,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the HorizontalPodAutoscaler

    +

    true

    +

    string

    + + @@ -4669,7 +4720,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -4695,6 +4746,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4710,10 +4764,10 @@
    -

    create a Ingress

    +

    partially update the specified HorizontalPodAutoscaler

    -
    POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
    +
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
    @@ -4751,7 +4805,7 @@

    body

    true

    -

    v1beta1.Ingress

    +

    unversioned.Patch

    @@ -4762,6 +4816,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the HorizontalPodAutoscaler

    +

    true

    +

    string

    + + @@ -4785,7 +4847,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -4796,7 +4858,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -4811,6 +4879,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4826,10 +4897,10 @@
    -

    read the specified Ingress

    +

    read status of the specified HorizontalPodAutoscaler

    -
    GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
    @@ -4863,22 +4934,6 @@ -

    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

    @@ -4889,7 +4944,7 @@

    PathParameter

    name

    -

    name of the Ingress

    +

    name of the HorizontalPodAutoscaler

    true

    string

    @@ -4917,7 +4972,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -4943,6 +4998,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4958,10 +5016,10 @@
    -

    replace the specified Ingress

    +

    replace status of the specified HorizontalPodAutoscaler

    -
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
    +
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
    @@ -4999,7 +5057,7 @@

    body

    true

    -

    v1beta1.Ingress

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -5013,7 +5071,7 @@

    PathParameter

    name

    -

    name of the Ingress

    +

    name of the HorizontalPodAutoscaler

    true

    string

    @@ -5041,7 +5099,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -5067,6 +5125,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5082,10 +5143,10 @@
    -

    delete a Ingress

    +

    partially update status of the specified HorizontalPodAutoscaler

    -
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
    +
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
    @@ -5123,7 +5184,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    unversioned.Patch

    @@ -5137,7 +5198,7 @@

    PathParameter

    name

    -

    name of the Ingress

    +

    name of the HorizontalPodAutoscaler

    true

    string

    @@ -5165,7 +5226,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -5176,7 +5237,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -5191,6 +5258,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5206,10 +5276,10 @@
    -

    partially update the specified Ingress

    +

    list or watch objects of kind Ingress

    -
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
    @@ -5243,11 +5313,43 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    +

    string

    -

    true

    -

    unversioned.Patch

    + + +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -5258,14 +5360,6 @@

    string

    - -

    PathParameter

    -

    name

    -

    name of the Ingress

    -

    true

    -

    string

    - - @@ -5289,7 +5383,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    v1beta1.IngressList

    @@ -5300,13 +5394,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -5321,6 +5409,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5336,10 +5427,10 @@
    -

    replace status of the specified Ingress

    +

    delete collection of Ingress

    -
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
    +
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
    @@ -5373,11 +5464,43 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    +

    string

    -

    true

    -

    v1beta1.Ingress

    + + +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -5388,14 +5511,6 @@

    string

    - -

    PathParameter

    -

    name

    -

    name of the Ingress

    -

    true

    -

    string

    - - @@ -5419,7 +5534,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    unversioned.Status

    @@ -5445,6 +5560,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5460,10 +5578,10 @@
    -

    list or watch objects of kind Job

    +

    create a Ingress

    -
    GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs
    +
    POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
    @@ -5497,43 +5615,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    v1beta1.Ingress

    @@ -5567,7 +5653,7 @@

    200

    success

    -

    v1beta1.JobList

    +

    v1beta1.Ingress

    @@ -5593,6 +5679,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5608,10 +5697,10 @@
    -

    delete collection of Job

    +

    read the specified Ingress

    -
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/jobs
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
    @@ -5646,270 +5735,6 @@

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    read the specified Job

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

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - @@ -5935,7 +5760,261 @@ - + + + + + + +
    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

    PathParameter

    name

    name of the Job

    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 a Ingress

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

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -5963,7 +6042,7 @@ - +
    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

    200

    success

    v1beta1.Job

    unversioned.Status
    @@ -5989,6 +6068,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6004,10 +6086,10 @@
    -

    replace the specified Job

    +

    partially update the specified Ingress

    -
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
    +
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
    @@ -6045,7 +6127,7 @@

    body

    true

    -

    v1beta1.Job

    +

    unversioned.Patch

    @@ -6059,7 +6141,7 @@

    PathParameter

    name

    -

    name of the Job

    +

    name of the Ingress

    true

    string

    @@ -6087,7 +6169,7 @@

    200

    success

    -

    v1beta1.Job

    +

    v1beta1.Ingress

    @@ -6098,7 +6180,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -6113,6 +6201,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6128,10 +6219,10 @@
    -

    delete a Job

    +

    read status of the specified Ingress

    -
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
    @@ -6165,14 +6256,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1.DeleteOptions

    - - -

    PathParameter

    namespace

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

    @@ -6183,7 +6266,7 @@

    PathParameter

    name

    -

    name of the Job

    +

    name of the Ingress

    true

    string

    @@ -6211,7 +6294,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1beta1.Ingress

    @@ -6237,6 +6320,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6252,10 +6338,10 @@
    -

    partially update the specified Job

    +

    replace status of the specified Ingress

    -
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
    +
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
    @@ -6293,7 +6379,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1beta1.Ingress

    @@ -6307,7 +6393,7 @@

    PathParameter

    name

    -

    name of the Job

    +

    name of the Ingress

    true

    string

    @@ -6335,7 +6421,7 @@

    200

    success

    -

    v1beta1.Job

    +

    v1beta1.Ingress

    @@ -6346,13 +6432,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -6367,6 +6447,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6382,10 +6465,10 @@
    -

    replace status of the specified Job

    +

    partially update status of the specified Ingress

    -
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
    +
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
    @@ -6423,7 +6506,7 @@

    body

    true

    -

    v1beta1.Job

    +

    unversioned.Patch

    @@ -6437,7 +6520,7 @@

    PathParameter

    name

    -

    name of the Job

    +

    name of the Ingress

    true

    string

    @@ -6465,7 +6548,7 @@

    200

    success

    -

    v1beta1.Job

    +

    v1beta1.Ingress

    @@ -6476,7 +6559,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -6491,6 +6580,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6506,10 +6598,10 @@
    -

    list or watch objects of kind ReplicaSet

    +

    list or watch objects of kind Job

    -
    GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs
    @@ -6613,7 +6705,7 @@

    200

    success

    -

    v1beta1.ReplicaSetList

    +

    v1beta1.JobList

    @@ -6639,6 +6731,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6654,10 +6749,10 @@
    -

    delete collection of ReplicaSet

    +

    delete collection of Job

    -
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
    +
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/jobs
    @@ -6761,7 +6856,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -6787,6 +6882,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6802,10 +6900,10 @@
    -

    create a ReplicaSet

    +

    create a Job

    -
    POST /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
    +
    POST /apis/extensions/v1beta1/namespaces/{namespace}/jobs
    @@ -6843,7 +6941,7 @@

    body

    true

    -

    v1beta1.ReplicaSet

    +

    v1beta1.Job

    @@ -6877,7 +6975,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.Job

    @@ -6903,6 +7001,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6918,10 +7019,10 @@
    -

    read the specified ReplicaSet

    +

    read the specified Job

    -
    GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
    @@ -6981,7 +7082,7 @@

    PathParameter

    name

    -

    name of the ReplicaSet

    +

    name of the Job

    true

    string

    @@ -7009,7 +7110,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.Job

    @@ -7035,6 +7136,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -7050,10 +7154,10 @@
    -

    replace the specified ReplicaSet

    +

    replace the specified Job

    -
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
    +
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
    @@ -7091,7 +7195,7 @@

    body

    true

    -

    v1beta1.ReplicaSet

    +

    v1beta1.Job

    @@ -7105,7 +7209,7 @@

    PathParameter

    name

    -

    name of the ReplicaSet

    +

    name of the Job

    true

    string

    @@ -7133,7 +7237,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.Job

    @@ -7159,6 +7263,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -7174,10 +7281,10 @@
    -

    delete a ReplicaSet

    +

    delete a Job

    -
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
    +
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
    @@ -7215,7 +7322,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -7229,7 +7336,7 @@

    PathParameter

    name

    -

    name of the ReplicaSet

    +

    name of the Job

    true

    string

    @@ -7257,7 +7364,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -7283,6 +7390,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -7298,10 +7408,10 @@
    -

    partially update the specified ReplicaSet

    +

    partially update the specified Job

    -
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}
    +
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}
    @@ -7339,7 +7449,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -7353,7 +7463,7 @@

    PathParameter

    name

    -

    name of the ReplicaSet

    +

    name of the Job

    true

    string

    @@ -7381,7 +7491,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.Job

    @@ -7413,6 +7523,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -7428,10 +7541,10 @@
    -

    read scale of the specified Scale

    +

    read status of the specified Job

    -
    GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
    @@ -7475,7 +7588,7 @@

    PathParameter

    name

    -

    name of the Scale

    +

    name of the Job

    true

    string

    @@ -7503,7 +7616,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Job

    @@ -7529,6 +7642,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -7544,10 +7660,10 @@
    -

    replace scale of the specified Scale

    +

    replace status of the specified Job

    -
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
    +
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
    @@ -7585,7 +7701,7 @@

    body

    true

    -

    v1beta1.Scale

    +

    v1beta1.Job

    @@ -7599,7 +7715,7 @@

    PathParameter

    name

    -

    name of the Scale

    +

    name of the Job

    true

    string

    @@ -7627,7 +7743,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Job

    @@ -7653,6 +7769,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -7668,10 +7787,10 @@
    -

    partially update scale of the specified Scale

    +

    partially update status of the specified Job

    -
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/scale
    +
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status
    @@ -7709,7 +7828,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -7723,7 +7842,7 @@

    PathParameter

    name

    -

    name of the Scale

    +

    name of the Job

    true

    string

    @@ -7751,7 +7870,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Job

    @@ -7783,6 +7902,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -7798,10 +7920,10 @@
    -

    replace status of the specified ReplicaSet

    +

    list or watch objects of kind NetworkPolicy

    -
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
    @@ -7835,11 +7957,43 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    +

    string

    -

    true

    -

    v1beta1.ReplicaSet

    + + +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -7850,14 +8004,6 @@

    string

    - -

    PathParameter

    -

    name

    -

    name of the ReplicaSet

    -

    true

    -

    string

    - - @@ -7881,7 +8027,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.NetworkPolicyList

    @@ -7907,6 +8053,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -7922,10 +8071,10 @@
    -

    read scale of the specified Scale

    +

    delete collection of NetworkPolicy

    -
    GET /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
    +
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
    @@ -7959,17 +8108,49 @@ -

    PathParameter

    -

    namespace

    -

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

    -

    true

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    string

    +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

    When specified with a watch call, shows changes that occur after that particular version 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 Scale

    +

    namespace

    +

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

    true

    string

    @@ -7997,7 +8178,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    unversioned.Status

    @@ -8023,6 +8204,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -8038,10 +8222,10 @@
    -

    replace scale of the specified Scale

    +

    create a NetworkPolicy

    -
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
    +
    POST /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies
    @@ -8079,7 +8263,7 @@

    body

    true

    -

    v1beta1.Scale

    +

    v1beta1.NetworkPolicy

    @@ -8090,14 +8274,6 @@

    string

    - -

    PathParameter

    -

    name

    -

    name of the Scale

    -

    true

    -

    string

    - - @@ -8121,7 +8297,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.NetworkPolicy

    @@ -8147,6 +8323,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -8162,10 +8341,10 @@
    -

    partially update scale of the specified Scale

    +

    read the specified NetworkPolicy

    -
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicationcontrollers/{name}/scale
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
    @@ -8199,11 +8378,19 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    export

    +

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

    +

    false

    +

    boolean

    -

    true

    -

    unversioned.Patch

    + + +

    QueryParameter

    +

    exact

    +

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

    +

    false

    +

    boolean

    @@ -8217,7 +8404,7 @@

    PathParameter

    name

    -

    name of the Scale

    +

    name of the NetworkPolicy

    true

    string

    @@ -8245,7 +8432,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.NetworkPolicy

    @@ -8256,13 +8443,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -8277,6 +8458,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -8292,10 +8476,10 @@
    -

    list or watch objects of kind ReplicaSet

    +

    replace the specified NetworkPolicy

    -
    GET /apis/extensions/v1beta1/replicasets
    +
    PUT /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
    @@ -8329,45 +8513,29 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1beta1.NetworkPolicy

    + + + +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the NetworkPolicy

    +

    true

    string

    - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -8391,7 +8559,7 @@

    200

    success

    -

    v1beta1.ReplicaSetList

    +

    v1beta1.NetworkPolicy

    @@ -8417,6 +8585,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -8432,10 +8603,10 @@
    -

    watch individual changes to a list of DaemonSet

    +

    delete a NetworkPolicy

    -
    GET /apis/extensions/v1beta1/watch/daemonsets
    +
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
    @@ -8469,45 +8640,29 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.DeleteOptions

    + + + +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the NetworkPolicy

    +

    true

    string

    - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -8531,7 +8686,7 @@

    200

    success

    -

    json.WatchEvent

    +

    unversioned.Status

    @@ -8554,6 +8709,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -8569,10 +8730,10 @@
    -

    watch individual changes to a list of Deployment

    +

    partially update the specified NetworkPolicy

    -
    GET /apis/extensions/v1beta1/watch/deployments
    +
    PATCH /apis/extensions/v1beta1/namespaces/{namespace}/networkpolicies/{name}
    @@ -8606,45 +8767,29 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    BodyParameter

    +

    body

    + +

    true

    +

    unversioned.Patch

    + + + +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the NetworkPolicy

    +

    true

    string

    - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -8668,7 +8813,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1beta1.NetworkPolicy

    @@ -8679,7 +8824,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -8691,6 +8842,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -8706,10 +8863,10 @@
    -

    watch individual changes to a list of HorizontalPodAutoscaler

    +

    list or watch objects of kind ReplicaSet

    -
    GET /apis/extensions/v1beta1/watch/horizontalpodautoscalers
    +
    GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
    @@ -8782,6 +8939,14 @@

    integer (int32)

    + +

    PathParameter

    +

    namespace

    +

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

    +

    true

    +

    string

    + + @@ -8805,7 +8970,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1beta1.ReplicaSetList

    @@ -8828,6 +8993,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -8843,10 +9014,10 @@
    -

    watch individual changes to a list of Ingress

    +

    delete collection of ReplicaSet

    -
    GET /apis/extensions/v1beta1/watch/ingresses
    +
    DELETE /apis/extensions/v1beta1/namespaces/{namespace}/replicasets
    @@ -8919,280 +9090,6 @@

    integer (int32)

    - - - -
    -
    -

    Responses

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

    200

    success

    json.WatchEvent

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    -
    -
    -
    -

    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

    json.WatchEvent

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apisextensionsv1beta1

      -
      • -
    -
    -
    -
    -
    -

    watch individual changes to a list of DaemonSet

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

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -9204,6 +9101,260 @@
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

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

    false

    string

    QueryParameter

    fieldSelector

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

    false

    string

    QueryParameter

    watch

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

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version 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
    +
    +
    +

    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

    @@ -9224,7 +9375,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1beta1.ReplicaSet

    @@ -9247,6 +9398,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -9262,6 +9419,3587 @@
    +

    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

    @@ -9269,7 +13007,7 @@
    -

    Parameters

    +

    Parameters

    @@ -9359,7 +13097,7 @@
    -

    Responses

    +

    Responses

    @@ -9377,14 +13115,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -9394,17 +13132,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -9422,7 +13169,7 @@
    -

    Parameters

    +

    Parameters

    @@ -9504,7 +13251,7 @@
    -

    Responses

    +

    Responses

    @@ -9522,14 +13269,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -9539,17 +13286,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -9567,7 +13323,7 @@
    -

    Parameters

    +

    Parameters

    @@ -9657,7 +13413,7 @@
    -

    Responses

    +

    Responses

    @@ -9675,14 +13431,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -9692,17 +13448,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -9720,7 +13485,7 @@
    -

    Parameters

    +

    Parameters

    @@ -9802,7 +13567,7 @@
    -

    Responses

    +

    Responses

    @@ -9820,14 +13585,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -9837,17 +13602,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -9865,7 +13639,7 @@
    -

    Parameters

    +

    Parameters

    @@ -9955,7 +13729,7 @@
    -

    Responses

    +

    Responses

    @@ -9973,14 +13747,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -9990,17 +13764,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -10018,7 +13801,7 @@
    -

    Parameters

    +

    Parameters

    @@ -10100,7 +13883,7 @@
    -

    Responses

    +

    Responses

    @@ -10118,14 +13901,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -10135,17 +13918,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -10163,7 +13955,7 @@
    -

    Parameters

    +

    Parameters

    @@ -10253,7 +14045,7 @@
    -

    Responses

    +

    Responses

    @@ -10271,14 +14063,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -10288,17 +14080,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -10316,7 +14117,7 @@
    -

    Parameters

    +

    Parameters

    @@ -10398,7 +14199,7 @@
    -

    Responses

    +

    Responses

    @@ -10416,14 +14217,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -10433,17 +14234,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -10461,7 +14271,7 @@
    -

    Parameters

    +

    Parameters

    @@ -10551,7 +14361,7 @@
    -

    Responses

    +

    Responses

    @@ -10569,14 +14379,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -10586,17 +14396,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -10607,14 +14426,14 @@
    -

    watch individual changes to a list of ReplicaSet

    +

    watch individual changes to a list of NetworkPolicy

    -
    GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/replicasets
    +
    GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies
    -

    Parameters

    +

    Parameters

    @@ -10696,7 +14515,7 @@
    -

    Responses

    +

    Responses

    @@ -10714,14 +14533,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -10731,17 +14550,342 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    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

    • @@ -10759,7 +14903,7 @@
    -

    Parameters

    +

    Parameters

    @@ -10849,7 +14993,7 @@
    -

    Responses

    +

    Responses

    @@ -10867,14 +15011,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -10884,17 +15028,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -10905,14 +15058,14 @@
    -

    watch individual changes to a list of ReplicaSet

    +

    watch individual changes to a list of NetworkPolicy

    -
    GET /apis/extensions/v1beta1/watch/replicasets
    +
    GET /apis/extensions/v1beta1/watch/networkpolicies
    -

    Parameters

    +

    Parameters

    @@ -10986,7 +15139,7 @@
    -

    Responses

    +

    Responses

    @@ -11004,14 +15157,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -11021,17 +15174,472 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    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

    • @@ -11046,8 +15654,8 @@
    - + \ No newline at end of file diff --git a/_includes/v1.2/v1-definitions.html b/_includes/v1.3/v1-definitions.html similarity index 85% rename from _includes/v1.2/v1-definitions.html rename to _includes/v1.3/v1-definitions.html index eba9865932..e833b003ea 100755 --- a/_includes/v1.2/v1-definitions.html +++ b/_includes/v1.3/v1-definitions.html @@ -1,3 +1,4 @@ + @@ -148,35 +149,35 @@

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -210,28 +211,28 @@

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    +

    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

    @@ -239,6 +240,40 @@ +
    +
    +

    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

    @@ -414,6 +449,13 @@

    string

    + +

    subPath

    +

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

    +

    false

    +

    string

    + + @@ -443,14 +485,21 @@

    accessModes

    -

    AccessModes contains the desired access modes the volume should have. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#access-modes-1

    +

    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.2/docs/user-guide/persistent-volumes.md#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

    @@ -491,7 +540,7 @@

    monitors

    -

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

    +

    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

    @@ -505,28 +554,28 @@

    user

    -

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

    +

    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.2/examples/cephfs/README.md#how-to-use-it

    +

    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.2/examples/cephfs/README.md#how-to-use-it

    +

    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.2/examples/cephfs/README.md#how-to-use-it

    +

    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

    @@ -649,28 +698,28 @@ Examples:

    pdName

    -

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

    +

    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.2/docs/user-guide/volumes.md#gcepersistentdisk

    +

    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.2/docs/user-guide/volumes.md#gcepersistentdisk

    +

    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.2/docs/user-guide/volumes.md#gcepersistentdisk

    +

    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

    @@ -704,9 +753,9 @@ Examples:

    hard

    -

    Hard is the set of desired hard limits for each named resource. More info: http://releases.k8s.io/release-1.2/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

    +

    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

    -

    any

    +

    object

    @@ -745,7 +794,7 @@ Examples:

    phase

    -

    Phase is the current lifecycle phase of the namespace. More info: http://releases.k8s.io/release-1.2/docs/design/namespaces.md#phases

    +

    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

    @@ -779,7 +828,7 @@ Examples:

    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.2/docs/design/namespaces.md#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

    @@ -791,7 +840,7 @@ Examples:

    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.2/docs/user-guide/persistent-volumes.md

    +

    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

    @@ -813,35 +862,35 @@ Examples:
    - + - + - + - + - + @@ -875,21 +924,21 @@ Examples:
    - + - + - + @@ -897,7 +946,7 @@ Examples:
    - + @@ -930,7 +979,7 @@ Examples:
    - + @@ -981,7 +1030,7 @@ Examples:
    - + @@ -996,6 +1045,10 @@ Examples:

    kind

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

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/user-guide/persistent-volumes.md#persistent-volumes

    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.2/docs/user-guide/persistent-volumes.md#persistent-volumes

    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

    kind

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

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.

    false

    true

    v1.ConfigMap array

    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.2/docs/user-guide/persistent-volumes.md#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

    name

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

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

    false

    string
    +
    +
    +

    *versioned.Event

    +

    v1.EndpointsList

    @@ -1022,21 +1075,21 @@ Examples:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

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

    false

    unversioned.ListMeta

    @@ -1132,7 +1185,7 @@ Examples:

    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.2/docs/user-guide/labels.md#label-selectors

    +

    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

    @@ -1140,61 +1193,6 @@ Examples:
    -
    -
    -

    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.2/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

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

    false

    string

    metadata

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

    false

    v1.ObjectMeta

    data

    Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.

    false

    any

    -

    v1.Capabilities

    @@ -1236,6 +1234,61 @@ Examples:
    +
    +
    +

    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

    @@ -1262,21 +1315,21 @@ Examples:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

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

    false

    unversioned.ListMeta

    @@ -1386,7 +1439,7 @@ Examples:

    name

    -

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

    +

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

    false

    string

    @@ -1420,16 +1473,16 @@ Examples:

    hard

    -

    Hard is the set of enforced hard limits for each named resource. More info: http://releases.k8s.io/release-1.2/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

    +

    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

    -

    any

    +

    object

    used

    Used is the current observed total usage of the resource in the namespace.

    false

    -

    any

    +

    object

    @@ -1495,7 +1548,7 @@ Examples:

    name

    -

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

    +

    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

    @@ -1506,7 +1559,7 @@ Examples:

    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.2/docs/devel/api-conventions.md#idempotency

    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#idempotency

    false

    string

    @@ -1515,7 +1568,7 @@ Applied only if Name is not specified. More info:

    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.2/docs/user-guide/namespaces.md

    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

    false

    string

    @@ -1531,7 +1584,7 @@ Must be a DNS_LABEL. Cannot be updated. More info:

    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.2/docs/user-guide/identifiers.md#uids

    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

    false

    string

    @@ -1540,7 +1593,7 @@ Populated by the system. Read-only. More info:

    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.2/docs/devel/api-conventions.md#concurrency-control-and-consistency

    +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

    @@ -1556,7 +1609,7 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a

    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.2/docs/devel/api-conventions.md#metadata

    +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

    @@ -1565,7 +1618,7 @@ Populated by the system. Read-only. Null for lists. More info:

    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.2/docs/devel/api-conventions.md#metadata

    +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

    @@ -1579,16 +1632,30 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    labels

    -

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

    +

    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

    -

    any

    +

    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.2/docs/user-guide/annotations.md

    +

    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

    -

    any

    +

    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

    @@ -1628,6 +1695,10 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    types.UID

    +

    v1.AzureFileVolumeSource

    @@ -1730,7 +1801,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    fsType

    -

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

    +

    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

    @@ -1771,7 +1842,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    medium

    -

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

    +

    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

    @@ -1805,21 +1876,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

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

    false

    unversioned.ListMeta

    @@ -1840,68 +1911,6 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

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

    -
    -
    -

    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.2/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

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

    false

    string

    metadata

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

    false

    v1.ObjectMeta

    spec

    Spec defines the desired characteristics of a volume requested by a pod author. More info: http://releases.k8s.io/release-1.2/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.2/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    false

    v1.PersistentVolumeClaimStatus

    -

    v1.NamespaceList

    @@ -1928,28 +1937,28 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/user-guide/namespaces.md

    +

    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

    @@ -1957,6 +1966,68 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    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

    @@ -1983,35 +2054,35 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/user-guide/secrets.md

    +

    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.2/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret

    +

    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

    @@ -2086,35 +2157,35 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -2182,7 +2253,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    claimName

    -

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

    +

    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

    @@ -2230,7 +2301,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    resourceVersion

    -

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

    +

    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

    @@ -2264,28 +2335,28 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

    +

    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

    @@ -2326,7 +2397,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    accessModes

    -

    AccessModes contains the actual access modes the volume backing the PVC has. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#access-modes-1

    +

    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

    @@ -2335,7 +2406,52 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    capacity

    Represents the actual resources of the underlying volume.

    false

    -

    any

    +

    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.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + @@ -2425,11 +2541,18 @@ The resulting set of endpoints can be viewed as:
    - + + + + + + + +
    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

    secretName

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

    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
    @@ -2473,7 +2596,7 @@ The resulting set of endpoints can be viewed as:

    secretRef

    -

    Optional: SecretRef is reference to the authentication secret for User, default is empty.

    +

    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

    @@ -2489,7 +2612,7 @@ The resulting set of endpoints can be viewed as:

    options

    Optional: Extra command options if any.

    false

    -

    any

    +

    object

    @@ -2527,6 +2650,13 @@ The resulting set of endpoints can be viewed as:
    +

    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

    @@ -2569,35 +2699,35 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status.

    +

    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.2/docs/devel/api-conventions.md#spec-and-status. Read-only.

    +

    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

    @@ -2713,35 +2843,35 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -2749,6 +2879,47 @@ The resulting set of endpoints can be viewed as:
    +
    +
    +

    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

    @@ -2775,28 +2946,28 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/design/service_accounts.md#service-accounts

    +

    List of ServiceAccounts. More info: http://releases.k8s.io/release-1.3/docs/design/service_accounts.md#service-accounts

    true

    v1.ServiceAccount array

    @@ -2830,28 +3001,28 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/design/admission_control_limit_range.md

    +

    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

    @@ -2896,21 +3067,21 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#metadata

    +

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

    false

    v1.ObjectMeta

    @@ -2951,14 +3122,14 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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

    @@ -2966,10 +3137,24 @@ The resulting set of endpoints can be viewed as:

    gracePeriodSeconds

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

    -

    true

    +

    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

    + @@ -2999,35 +3184,35 @@ The resulting set of endpoints can be viewed as:

    name

    -

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

    +

    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.2/docs/user-guide/volumes.md#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.2/docs/user-guide/volumes.md#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.2/docs/user-guide/volumes.md#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.2/docs/user-guide/volumes.md#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

    @@ -3041,42 +3226,42 @@ The resulting set of endpoints can be viewed as:

    secret

    -

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

    +

    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.2/docs/user-guide/volumes.md#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.2/examples/iscsi/README.md

    +

    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.2/examples/glusterfs/README.md

    +

    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.2/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    +

    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.2/examples/rbd/README.md

    +

    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

    @@ -3090,7 +3275,7 @@ The resulting set of endpoints can be viewed as:

    cinder

    -

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

    +

    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

    @@ -3137,12 +3322,63 @@ The resulting set of endpoints can be viewed as:

    v1.ConfigMapVolumeSource

    + +

    vsphereVolume

    +

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

    +

    false

    +

    v1.VsphereVirtualDiskVolumeSource

    + +
    -

    integer

    +

    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

    @@ -3191,14 +3427,14 @@ The resulting set of endpoints can be viewed as:

    initialDelaySeconds

    -

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

    +

    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.2/docs/user-guide/pod-states.md#container-probes

    +

    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)

    @@ -3227,6 +3463,61 @@ The resulting set of endpoints can be viewed as:
    +
    +
    +

    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

    @@ -3253,7 +3544,7 @@ The resulting set of endpoints can be viewed as:

    name

    -

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

    +

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

    false

    string

    @@ -3294,35 +3585,35 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -3334,6 +3625,54 @@ The resulting set of endpoints can be viewed as:

    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

    @@ -3360,14 +3699,14 @@ The resulting set of endpoints can be viewed as:

    phase

    -

    Current condition of the pod. More info: http://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#pod-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.2/docs/user-guide/pod-states.md#pod-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

    @@ -3409,7 +3748,7 @@ The resulting set of endpoints can be viewed as:

    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.2/docs/user-guide/pod-states.md#container-statuses

    +

    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

    @@ -3443,28 +3782,28 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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

    @@ -3506,10 +3845,17 @@ The resulting set of endpoints can be viewed as:

    fieldRef

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

    -

    true

    +

    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

    + + @@ -3539,21 +3885,21 @@ The resulting set of endpoints can be viewed as:

    volumes

    -

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

    +

    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.2/docs/user-guide/containers.md

    +

    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.2/docs/user-guide/pod-states.md#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

    @@ -3581,14 +3927,14 @@ The resulting set of endpoints can be viewed as:

    nodeSelector

    -

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

    +

    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

    -

    any

    +

    object

    serviceAccountName

    -

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

    +

    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

    @@ -3637,11 +3983,25 @@ The resulting set of endpoints can be viewed as:

    imagePullSecrets

    -

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

    +

    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

    + + @@ -3733,35 +4093,35 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -3795,21 +4155,21 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

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

    false

    unversioned.ListMeta

    @@ -3850,14 +4210,14 @@ The resulting set of endpoints can be viewed as:

    postStart

    -

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

    +

    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.2/docs/user-guide/container-environment.md#hook-details

    +

    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

    @@ -3891,21 +4251,21 @@ The resulting set of endpoints can be viewed as:

    replicas

    -

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

    +

    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.2/docs/user-guide/labels.md#label-selectors

    +

    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

    -

    any

    +

    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.2/docs/user-guide/replication-controller.md#pod-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

    @@ -3913,137 +4273,6 @@ The resulting set of endpoints can be viewed as:
    -
    -
    -

    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.2/docs/user-guide/persistent-volumes.md#capacity for more details.

    false

    any

    allocatable

    Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.

    false

    any

    phase

    NodePhase is the recently observed lifecycle phase of the node. More info: http://releases.k8s.io/release-1.2/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.2/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.2/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.2/docs/admin/node.md#node-info

    false

    v1.NodeSystemInfo

    images

    List of container images on this node

    true

    v1.ContainerImage 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.2/examples/glusterfs/README.md#create-a-pod

    true

    string

    path

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

    true

    string

    readOnly

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

    false

    boolean

    false

    -

    v1.Handler

    @@ -4092,6 +4321,192 @@ The resulting set of endpoints can be viewed as:
    +
    +
    +

    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

    @@ -4159,14 +4574,14 @@ The resulting set of endpoints can be viewed as:

    type

    -

    Type is the type of the condition. Currently only Ready. More info: http://releases.k8s.io/release-1.2/docs/user-guide/pod-states.md#pod-conditions

    +

    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.2/docs/user-guide/pod-states.md#pod-conditions

    +

    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

    @@ -4228,56 +4643,56 @@ The resulting set of endpoints can be viewed as:

    monitors

    -

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

    +

    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.2/examples/rbd/README.md#how-to-use-it

    +

    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.2/docs/user-guide/volumes.md#rbd

    +

    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.2/examples/rbd/README.md#how-to-use-it.

    -

    true

    +

    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.2/examples/rbd/README.md#how-to-use-it

    -

    true

    +

    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.2/examples/rbd/README.md#how-to-use-it

    -

    true

    +

    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 empty. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it

    -

    true

    +

    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.2/examples/rbd/README.md#how-to-use-it

    +

    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

    @@ -4311,28 +4726,28 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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

    @@ -4400,21 +4815,21 @@ The resulting set of endpoints can be viewed as:

    server

    -

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

    +

    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.2/docs/user-guide/volumes.md#nfs

    +

    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.2/docs/user-guide/volumes.md#nfs

    +

    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

    @@ -4640,7 +5055,7 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    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

    @@ -4784,28 +5199,28 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/user-guide/secrets.md

    +

    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

    @@ -4846,21 +5261,21 @@ The resulting set of endpoints can be viewed as:

    image

    -

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

    +

    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.2/docs/user-guide/containers.md#containers-and-commands

    +

    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.2/docs/user-guide/containers.md#containers-and-commands

    +

    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

    @@ -4888,28 +5303,28 @@ The resulting set of endpoints can be viewed as:

    resources

    -

    Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#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 filesyste. Cannot be updated.

    +

    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.2/docs/user-guide/pod-states.md#container-probes

    +

    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.2/docs/user-guide/pod-states.md#container-probes

    +

    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

    @@ -4930,14 +5345,14 @@ The resulting set of endpoints can be viewed as:

    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.2/docs/user-guide/images.md#updating-images

    +

    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.2/docs/design/security_context.md

    +

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

    false

    v1.SecurityContext

    @@ -5015,7 +5430,7 @@ The resulting set of endpoints can be viewed as:

    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] array

    +

    integer (int32) array

    @@ -5056,49 +5471,49 @@ The resulting set of endpoints can be viewed as:

    capacity

    -

    A description of the persistent volume’s resources and capacity. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#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

    -

    any

    +

    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.2/docs/user-guide/volumes.md#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.2/docs/user-guide/volumes.md#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.2/docs/user-guide/volumes.md#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.2/examples/glusterfs/README.md

    +

    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.2/docs/user-guide/volumes.md#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.2/examples/rbd/README.md

    +

    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

    @@ -5112,7 +5527,7 @@ The resulting set of endpoints can be viewed as:

    cinder

    -

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

    +

    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

    @@ -5153,22 +5568,29 @@ The resulting set of endpoints can be viewed as:
    +

    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.2/docs/user-guide/persistent-volumes.md#access-modes

    +

    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.2/docs/user-guide/persistent-volumes.md#binding

    +

    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.2/docs/user-guide/persistent-volumes.md#recycling-policy

    +

    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

    @@ -5202,7 +5624,7 @@ The resulting set of endpoints can be viewed as:

    replicas

    -

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

    +

    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)

    @@ -5275,14 +5697,14 @@ The resulting set of endpoints can be viewed as:

    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.2/docs/user-guide/services.md#defining-a-service

    +

    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.2/docs/user-guide/services.md#type—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)

    @@ -5345,6 +5767,68 @@ The resulting set of endpoints can be viewed as:
    +
    +
    +

    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

    @@ -5405,21 +5889,21 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

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

    false

    unversioned.ListMeta

    @@ -5460,7 +5944,7 @@ The resulting set of endpoints can be viewed as:

    path

    -

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

    +

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

    true

    string

    @@ -5468,44 +5952,6 @@ The resulting set of endpoints can be viewed as:
    -
    -
    -

    json.WatchEvent

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

    type

    the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR

    false

    string

    object

    the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR

    false

    string

    -

    v1.ContainerStateTerminated

    @@ -5608,21 +6054,21 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#metadata

    +

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

    false

    v1.ObjectMeta

    @@ -5663,21 +6109,21 @@ The resulting set of endpoints can be viewed as:

    volumeID

    -

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

    +

    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.2/examples/mysql-cinder-pd/README.md

    +

    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.2/examples/mysql-cinder-pd/README.md

    +

    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

    @@ -5831,14 +6277,14 @@ The resulting set of endpoints can be viewed as:

    volumeID

    -

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

    +

    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.2/docs/user-guide/volumes.md#awselasticblockstore

    +

    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

    @@ -5852,7 +6298,7 @@ The resulting set of endpoints can be viewed as:

    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.2/docs/user-guide/volumes.md#awselasticblockstore

    +

    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

    @@ -5921,7 +6367,7 @@ The resulting set of endpoints can be viewed as:

    image

    -

    The image the container is running. More info: http://releases.k8s.io/release-1.2/docs/user-guide/images.md

    +

    The image the container is running. More info: http://releases.k8s.io/release-1.3/docs/user-guide/images.md

    true

    string

    @@ -5935,7 +6381,7 @@ The resulting set of endpoints can be viewed as:

    containerID

    -

    Container’s ID in the format docker://<container_id>. More info: http://releases.k8s.io/release-1.2/docs/user-guide/container-environment.md#container-information

    +

    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

    @@ -6014,28 +6460,28 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/user-guide/replication-controller.md

    +

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

    true

    v1.ReplicationController array

    @@ -6103,21 +6549,21 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#metadata

    +

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

    false

    v1.ObjectMeta

    @@ -6126,7 +6572,7 @@ The resulting set of endpoints can be viewed as:

    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

    -

    any

    +

    object

    @@ -6165,21 +6611,21 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#metadata

    +

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

    true

    v1.ObjectMeta

    @@ -6291,6 +6737,10 @@ The resulting set of endpoints can be viewed as:
    +
    +
    +

    v1.PersistentVolumeAccessMode

    +

    v1.ResourceRequirements

    @@ -6317,25 +6767,21 @@ The resulting set of endpoints can be viewed as:

    limits

    -

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

    +

    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

    -

    any

    +

    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.2/docs/design/resources.md#resource-specifications

    +

    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

    -

    any

    +

    object

    -
    -
    -

    v1.PersistentVolumeAccessMode

    -

    v1.ComponentStatus

    @@ -6362,21 +6808,21 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#metadata

    +

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

    false

    v1.ObjectMeta

    @@ -6426,35 +6872,35 @@ The resulting set of endpoints can be viewed as:

    max

    Max usage constraints on this kind by resource name.

    false

    -

    any

    +

    object

    min

    Min usage constraints on this kind by resource name.

    false

    -

    any

    +

    object

    default

    Default resource requirement limit value by resource name if resource limit is omitted.

    false

    -

    any

    +

    object

    defaultRequest

    DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.

    false

    -

    any

    +

    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

    -

    any

    +

    object

    @@ -6486,14 +6932,14 @@ The resulting set of endpoints can be viewed as:

    metadata

    -

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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

    @@ -6527,28 +6973,28 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/user-guide/pods.md

    +

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

    true

    v1.Pod array

    @@ -6582,21 +7028,21 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

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

    false

    unversioned.ListMeta

    @@ -6637,28 +7083,28 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/user-guide/persistent-volumes.md

    +

    List of persistent volumes. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md

    true

    v1.PersistentVolume array

    @@ -6692,28 +7138,28 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    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.2/docs/user-guide/namespaces.md

    +

    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.2/docs/user-guide/identifiers.md#names

    +

    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.2/docs/user-guide/identifiers.md#uids

    +

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

    false

    string

    @@ -6727,7 +7173,7 @@ The resulting set of endpoints can be viewed as:

    resourceVersion

    -

    Specific resourceVersion to which this reference is made, if any. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#concurrency-control-and-consistency

    +

    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

    @@ -6742,6 +7188,54 @@ The resulting set of endpoints can be viewed as:
    +
    +
    +

    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

    @@ -6809,28 +7303,28 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -6892,7 +7386,7 @@ The resulting set of endpoints can be viewed as:

    name

    -

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

    +

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

    false

    string

    @@ -6987,6 +7481,20 @@ The resulting set of endpoints can be viewed as:

    string

    + +

    operatingSystem

    +

    The Operating System reported by the node

    +

    true

    +

    string

    + + + +

    architecture

    +

    The Architecture reported by the node

    +

    true

    +

    string

    + + @@ -7016,28 +7524,28 @@ The resulting set of endpoints can be viewed as:

    ports

    -

    The list of ports that are exposed by this service. More info: http://releases.k8s.io/release-1.2/docs/user-guide/services.md#virtual-ips-and-service-proxies

    +

    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.2/docs/user-guide/services.md#overview

    +

    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

    -

    any

    +

    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.2/docs/user-guide/services.md#virtual-ips-and-service-proxies

    +

    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.2/docs/user-guide/services.md#external-services

    +

    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

    @@ -7058,7 +7566,7 @@ The resulting set of endpoints can be viewed as:

    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.2/docs/user-guide/services.md#virtual-ips-and-service-proxies

    +

    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

    @@ -7070,6 +7578,13 @@ The resulting set of endpoints can be viewed as:

    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

    + + @@ -7099,35 +7614,35 @@ The resulting set of endpoints can be viewed as:

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -7182,7 +7697,7 @@ The resulting set of endpoints can be viewed as:

    unschedulable

    -

    Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: http://releases.k8s.io/release-1.2/docs/admin/node.md#manual-node-administration"`

    +

    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

    @@ -7216,12 +7731,19 @@ The resulting set of endpoints can be viewed as:

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

    +

    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

    @@ -7277,8 +7799,8 @@ The resulting set of endpoints can be viewed as:
    - + \ No newline at end of file diff --git a/_includes/v1.2/v1-operations.html b/_includes/v1.3/v1-operations.html similarity index 91% rename from _includes/v1.2/v1-operations.html rename to _includes/v1.3/v1-operations.html index eecf1a5c1e..24e21c4f53 100755 --- a/_includes/v1.2/v1-operations.html +++ b/_includes/v1.3/v1-operations.html @@ -1,3 +1,4 @@ + @@ -38,7 +39,7 @@

    default

    success

    -

    string

    +

    unversioned.APIResourceList

    @@ -54,6 +55,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -67,6 +71,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -181,7 +188,7 @@

    200

    success

    -

    v1.ComponentStatusList

    +

    v1.ComponentStatusList

    @@ -207,6 +214,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -289,7 +299,7 @@

    200

    success

    -

    v1.ComponentStatus

    +

    v1.ComponentStatus

    @@ -315,6 +325,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -429,7 +442,7 @@

    200

    success

    -

    v1.ConfigMapList

    +

    v1.ConfigMapList

    @@ -455,6 +468,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -569,7 +585,7 @@

    200

    success

    -

    v1.EndpointsList

    +

    v1.EndpointsList

    @@ -595,6 +611,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -709,7 +728,7 @@

    200

    success

    -

    v1.EventList

    +

    v1.EventList

    @@ -735,6 +754,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -849,7 +871,7 @@

    200

    success

    -

    v1.LimitRangeList

    +

    v1.LimitRangeList

    @@ -875,6 +897,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -989,7 +1014,7 @@

    200

    success

    -

    v1.NamespaceList

    +

    v1.NamespaceList

    @@ -1015,6 +1040,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1129,7 +1157,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -1155,6 +1183,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1211,7 +1242,7 @@

    body

    true

    -

    v1.Namespace

    +

    v1.Namespace

    @@ -1237,7 +1268,7 @@

    200

    success

    -

    v1.Namespace

    +

    v1.Namespace

    @@ -1263,6 +1294,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1319,7 +1353,7 @@

    body

    true

    -

    v1.Binding

    +

    v1.Binding

    @@ -1353,7 +1387,7 @@

    200

    success

    -

    v1.Binding

    +

    v1.Binding

    @@ -1379,6 +1413,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1501,7 +1538,7 @@

    200

    success

    -

    v1.ConfigMapList

    +

    v1.ConfigMapList

    @@ -1527,6 +1564,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1649,7 +1689,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -1675,6 +1715,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1731,7 +1774,7 @@

    body

    true

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -1765,7 +1808,7 @@

    200

    success

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -1791,6 +1834,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1897,7 +1943,7 @@

    200

    success

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -1923,6 +1969,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1979,7 +2028,7 @@

    body

    true

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -2021,7 +2070,7 @@

    200

    success

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -2047,6 +2096,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -2103,7 +2155,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -2145,7 +2197,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -2171,6 +2223,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -2227,7 +2282,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -2269,7 +2324,7 @@

    200

    success

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -2301,6 +2356,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -2423,7 +2481,7 @@

    200

    success

    -

    v1.EndpointsList

    +

    v1.EndpointsList

    @@ -2449,6 +2507,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -2571,7 +2632,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -2597,6 +2658,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -2653,7 +2717,7 @@

    body

    true

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -2687,7 +2751,7 @@

    200

    success

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -2713,6 +2777,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -2819,7 +2886,7 @@

    200

    success

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -2845,6 +2912,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -2901,7 +2971,7 @@

    body

    true

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -2943,7 +3013,7 @@

    200

    success

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -2969,6 +3039,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3025,7 +3098,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -3067,7 +3140,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -3093,6 +3166,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3149,7 +3225,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -3191,7 +3267,7 @@

    200

    success

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -3223,6 +3299,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3345,7 +3424,7 @@

    200

    success

    -

    v1.EventList

    +

    v1.EventList

    @@ -3371,6 +3450,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3493,7 +3575,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -3519,6 +3601,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3575,7 +3660,7 @@

    body

    true

    -

    v1.Event

    +

    v1.Event

    @@ -3609,7 +3694,7 @@

    200

    success

    -

    v1.Event

    +

    v1.Event

    @@ -3635,6 +3720,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3741,7 +3829,7 @@

    200

    success

    -

    v1.Event

    +

    v1.Event

    @@ -3767,6 +3855,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3823,7 +3914,7 @@

    body

    true

    -

    v1.Event

    +

    v1.Event

    @@ -3865,7 +3956,7 @@

    200

    success

    -

    v1.Event

    +

    v1.Event

    @@ -3891,6 +3982,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -3947,7 +4041,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -3989,7 +4083,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -4015,6 +4109,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4071,7 +4168,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -4113,7 +4210,7 @@

    200

    success

    -

    v1.Event

    +

    v1.Event

    @@ -4145,6 +4242,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4267,7 +4367,7 @@

    200

    success

    -

    v1.LimitRangeList

    +

    v1.LimitRangeList

    @@ -4293,6 +4393,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4415,7 +4518,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -4441,6 +4544,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4497,7 +4603,7 @@

    body

    true

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -4531,7 +4637,7 @@

    200

    success

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -4557,6 +4663,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4663,7 +4772,7 @@

    200

    success

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -4689,6 +4798,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4745,7 +4857,7 @@

    body

    true

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -4787,7 +4899,7 @@

    200

    success

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -4813,6 +4925,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4869,7 +4984,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -4911,7 +5026,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -4937,6 +5052,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -4993,7 +5111,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -5035,7 +5153,7 @@

    200

    success

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -5067,6 +5185,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5189,7 +5310,7 @@

    200

    success

    -

    v1.PersistentVolumeClaimList

    +

    v1.PersistentVolumeClaimList

    @@ -5215,6 +5336,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5337,7 +5461,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -5363,6 +5487,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5419,7 +5546,7 @@

    body

    true

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -5453,7 +5580,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -5479,6 +5606,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5585,7 +5715,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -5611,6 +5741,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5667,7 +5800,7 @@

    body

    true

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -5709,7 +5842,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -5735,6 +5868,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5791,7 +5927,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -5833,7 +5969,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -5859,6 +5995,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -5915,7 +6054,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -5957,7 +6096,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -5989,6 +6128,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6004,10 +6146,10 @@
    -

    replace status of the specified PersistentVolumeClaim

    +

    read status of the specified PersistentVolumeClaim

    -
    PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
    +
    GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
    @@ -6041,14 +6183,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1.PersistentVolumeClaim

    - - -

    PathParameter

    namespace

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

    @@ -6087,7 +6221,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -6113,6 +6247,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6128,10 +6265,10 @@
    -

    list or watch objects of kind Pod

    +

    replace status of the specified PersistentVolumeClaim

    -
    GET /api/v1/namespaces/{namespace}/pods
    +
    PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
    @@ -6165,43 +6302,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    v1.PersistentVolumeClaim

    @@ -6212,6 +6317,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the PersistentVolumeClaim

    +

    true

    +

    string

    + + @@ -6235,7 +6348,7 @@

    200

    success

    -

    v1.PodList

    +

    v1.PersistentVolumeClaim

    @@ -6261,6 +6374,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6276,10 +6392,10 @@
    -

    delete collection of Pod

    +

    partially update status of the specified PersistentVolumeClaim

    -
    DELETE /api/v1/namespaces/{namespace}/pods
    +
    PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
    @@ -6313,6 +6429,139 @@ +

    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

    + ++++++++ + + + + + + + + + + + + + + + + + + + + @@ -6365,7 +6614,7 @@
    -

    Responses

    +

    Responses

    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.
    @@ -6383,14 +6632,14 @@ - +

    200

    success

    unversioned.Status

    v1.PodList
    -

    Consumes

    +

    Consumes

    • @@ -6400,7 +6649,7 @@
    -

    Produces

    +

    Produces

    • @@ -6409,11 +6658,165 @@

    • application/yaml

      • +
    • +

      application/vnd.kubernetes.protobuf

      +
    -

    Tags

    +

    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

    • @@ -6431,7 +6834,7 @@
    -

    Parameters

    +

    Parameters

    @@ -6465,7 +6868,7 @@ - + @@ -6481,7 +6884,7 @@
    -

    Responses

    +

    Responses

    body

    true

    v1.Pod

    v1.Pod
    @@ -6499,14 +6902,14 @@ - +

    200

    success

    v1.Pod

    v1.Pod
    -

    Consumes

    +

    Consumes

    • @@ -6516,7 +6919,7 @@
    -

    Produces

    +

    Produces

    • @@ -6525,11 +6928,14 @@

    • application/yaml

      • +
    • +

      application/vnd.kubernetes.protobuf

      +
    -

    Tags

    +

    Tags

    • @@ -6547,7 +6953,7 @@
    -

    Parameters

    +

    Parameters

    @@ -6611,254 +7017,6 @@
    -
    -
    -

    Responses

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

    200

    success

    v1.Pod

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

    @@ -6879,7 +7037,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.Pod

    @@ -6905,6 +7063,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -6920,10 +7081,10 @@
    -

    partially update the specified Pod

    +

    replace the specified Pod

    -
    PATCH /api/v1/namespaces/{namespace}/pods/{name}
    +
    PUT /api/v1/namespaces/{namespace}/pods/{name}
    @@ -6961,7 +7122,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1.Pod

    @@ -7003,7 +7164,7 @@

    200

    success

    -

    v1.Pod

    +

    v1.Pod

    @@ -7014,13 +7175,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -7035,6 +7190,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -7050,10 +7208,10 @@
    -

    connect GET requests to attach of Pod

    +

    delete a Pod

    -
    GET /api/v1/namespaces/{namespace}/pods/{name}/attach
    +
    DELETE /api/v1/namespaces/{namespace}/pods/{name}
    @@ -7080,45 +7238,21 @@

    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.

    +

    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

    @@ -7155,9 +7289,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    unversioned.Status

    @@ -7178,7 +7312,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -7195,10 +7335,10 @@
    -

    connect POST requests to attach of Pod

    +

    partially update the specified Pod

    -
    POST /api/v1/namespaces/{namespace}/pods/{name}/attach
    +
    PATCH /api/v1/namespaces/{namespace}/pods/{name}
    @@ -7225,6 +7365,139 @@

    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

    + ++++++++ + + + + + + + + + + + + + @@ -7284,7 +7557,7 @@
    -

    Responses

    +

    Responses

    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    stdin

    Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

    false
    @@ -7307,127 +7580,6 @@
    -
    -
    -

    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

    @@ -7444,10 +7596,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -7464,10 +7613,10 @@
    -

    connect GET requests to exec of Pod

    +

    connect POST requests to attach of Pod

    -
    GET /api/v1/namespaces/{namespace}/pods/{name}/exec
    +
    POST /api/v1/namespaces/{namespace}/pods/{name}/attach
    @@ -7495,7 +7644,7 @@

    QueryParameter

    stdin

    -

    Redirect the standard input stream of the pod for this call. Defaults to false.

    +

    Stdin if true, redirects the standard input stream of the pod for this call. Defaults to false.

    false

    boolean

    @@ -7503,7 +7652,7 @@

    QueryParameter

    stdout

    -

    Redirect the standard output stream of the pod for this call. Defaults to true.

    +

    Stdout if true indicates that stdout is to be redirected for the attach call. Defaults to true.

    false

    boolean

    @@ -7511,7 +7660,7 @@

    QueryParameter

    stderr

    -

    Redirect the standard error stream of the pod for this call. Defaults to true.

    +

    Stderr if true indicates that stderr is to be redirected for the attach call. Defaults to true.

    false

    boolean

    @@ -7519,7 +7668,7 @@

    QueryParameter

    tty

    -

    TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

    +

    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

    @@ -7527,15 +7676,7 @@

    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.

    +

    The container in which to execute the command. Defaults to only container if there is only one container in the pod.

    false

    string

    @@ -7617,10 +7758,10 @@
    -

    connect POST requests to exec of Pod

    +

    create binding of a Binding

    -
    POST /api/v1/namespaces/{namespace}/pods/{name}/exec
    +
    POST /api/v1/namespaces/{namespace}/pods/{name}/binding
    @@ -7647,6 +7788,133 @@

    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

    + ++++++++ + + + + + + + + + + + + + @@ -7714,7 +7982,7 @@
    -

    Responses

    +

    Responses

    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    stdin

    Redirect the standard input stream of the pod for this call. Defaults to false.

    false
    @@ -7739,7 +8007,7 @@
    -

    Consumes

    +

    Consumes

    • @@ -7749,7 +8017,7 @@
    -

    Produces

    +

    Produces

    • @@ -7759,7 +8027,160 @@
    -

    Tags

    +

    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

    • @@ -7777,7 +8198,7 @@
    -

    Parameters

    +

    Parameters

    @@ -7891,7 +8312,7 @@
    -

    Responses

    +

    Responses

    @@ -7909,220 +8330,7 @@ - - - -

    200

    success

    v1.Pod

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    -
    -
    -
    -

    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

    v1.Pod
    @@ -8143,7 +8351,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -8160,10 +8374,10 @@
    -

    connect GET requests to proxy of Pod

    +

    connect GET requests to portforward of Pod

    -
    GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
    +
    GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
    @@ -8189,14 +8403,6 @@ -

    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

    @@ -8273,10 +8479,10 @@
    -

    connect PUT requests to proxy of Pod

    +

    connect POST requests to portforward of Pod

    -
    PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
    +
    POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
    @@ -8302,14 +8508,6 @@ -

    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

    @@ -8386,10 +8584,10 @@
    -

    connect DELETE requests to proxy of Pod

    +

    connect GET requests to proxy of Pod

    -
    DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
    +
    GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
    @@ -8499,10 +8697,10 @@
    -

    connect POST requests to proxy of Pod

    +

    connect PUT requests to proxy of Pod

    -
    POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
    +
    PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
    @@ -8612,10 +8810,10 @@
    -

    connect GET requests to proxy of Pod

    +

    connect DELETE requests to proxy of Pod

    -
    GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    +
    DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
    @@ -8664,14 +8862,6 @@

    string

    - -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    -

    string

    - - @@ -8733,10 +8923,10 @@
    -

    connect PUT requests to proxy of Pod

    +

    connect POST requests to proxy of Pod

    -
    PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    +
    POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
    @@ -8785,14 +8975,6 @@

    string

    - -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    -

    string

    - - @@ -8854,10 +9036,10 @@
    -

    connect DELETE requests to proxy of Pod

    +

    connect GET requests to proxy of Pod

    -
    DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    +
    GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    @@ -8975,10 +9157,10 @@
    -

    connect POST requests to proxy of Pod

    +

    connect PUT requests to proxy of Pod

    -
    POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    +
    PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    @@ -9096,10 +9278,10 @@
    -

    replace status of the specified Pod

    +

    connect DELETE requests to proxy of Pod

    -
    PUT /api/v1/namespaces/{namespace}/pods/{name}/status
    +
    DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    @@ -9126,21 +9308,13 @@

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    +

    path

    +

    Path is the URL path to use for the current proxy request to pod.

    false

    string

    -

    BodyParameter

    -

    body

    - -

    true

    -

    v1.Pod

    - - -

    PathParameter

    namespace

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

    @@ -9156,6 +9330,14 @@

    string

    + +

    PathParameter

    +

    path

    +

    path to the resource

    +

    true

    +

    string

    + + @@ -9177,9 +9359,9 @@ -

    200

    +

    default

    success

    -

    v1.Pod

    +

    string

    @@ -9200,10 +9382,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -9220,10 +9399,10 @@
    -

    list or watch objects of kind PodTemplate

    +

    connect POST requests to proxy of Pod

    -
    GET /api/v1/namespaces/{namespace}/podtemplates
    +
    POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    @@ -9250,53 +9429,13 @@

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    +

    path

    +

    Path is the URL path to use for the current proxy request to pod.

    false

    string

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

    @@ -9304,6 +9443,22 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the Pod

    +

    true

    +

    string

    + + + +

    PathParameter

    +

    path

    +

    path to the resource

    +

    true

    +

    string

    + + @@ -9325,9 +9480,9 @@ -

    200

    +

    default

    success

    -

    v1.PodTemplateList

    +

    string

    @@ -9348,10 +9503,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -9368,10 +9520,10 @@
    -

    delete collection of PodTemplate

    +

    read status of the specified Pod

    -
    DELETE /api/v1/namespaces/{namespace}/podtemplates
    +
    GET /api/v1/namespaces/{namespace}/pods/{name}/status
    @@ -9405,49 +9557,17 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

    +

    name

    +

    name of the Pod

    true

    string

    @@ -9475,7 +9595,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.Pod

    @@ -9501,6 +9621,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -9516,10 +9639,10 @@
    -

    create a PodTemplate

    +

    replace status of the specified Pod

    -
    POST /api/v1/namespaces/{namespace}/podtemplates
    +
    PUT /api/v1/namespaces/{namespace}/pods/{name}/status
    @@ -9557,7 +9680,7 @@

    body

    true

    -

    v1.PodTemplate

    +

    v1.Pod

    @@ -9568,6 +9691,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the Pod

    +

    true

    +

    string

    + + @@ -9591,7 +9722,7 @@

    200

    success

    -

    v1.PodTemplate

    +

    v1.Pod

    @@ -9617,6 +9748,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -9632,10 +9766,10 @@
    -

    read the specified PodTemplate

    +

    partially update status of the specified Pod

    -
    GET /api/v1/namespaces/{namespace}/podtemplates/{name}
    +
    PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
    @@ -9669,19 +9803,11 @@ -

    QueryParameter

    -

    export

    -

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

    -

    false

    -

    boolean

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    exact

    -

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

    -

    false

    -

    boolean

    +

    true

    +

    unversioned.Patch

    @@ -9695,7 +9821,7 @@

    PathParameter

    name

    -

    name of the PodTemplate

    +

    name of the Pod

    true

    string

    @@ -9723,7 +9849,7 @@

    200

    success

    -

    v1.PodTemplate

    +

    v1.Pod

    @@ -9734,7 +9860,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -9749,6 +9881,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -9764,10 +9899,10 @@
    -

    replace the specified PodTemplate

    +

    list or watch objects of kind PodTemplate

    -
    PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
    +
    GET /api/v1/namespaces/{namespace}/podtemplates
    @@ -9801,11 +9936,43 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    +

    string

    -

    true

    -

    v1.PodTemplate

    + + +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -9816,14 +9983,6 @@

    string

    - -

    PathParameter

    -

    name

    -

    name of the PodTemplate

    -

    true

    -

    string

    - - @@ -9847,7 +10006,7 @@

    200

    success

    -

    v1.PodTemplate

    +

    v1.PodTemplateList

    @@ -9873,6 +10032,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -9888,10 +10050,10 @@
    -

    delete a PodTemplate

    +

    delete collection of PodTemplate

    -
    DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
    +
    DELETE /api/v1/namespaces/{namespace}/podtemplates
    @@ -9925,11 +10087,43 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    +

    string

    -

    true

    -

    v1.DeleteOptions

    + + +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -9940,14 +10134,6 @@

    string

    - -

    PathParameter

    -

    name

    -

    name of the PodTemplate

    -

    true

    -

    string

    - - @@ -9971,7 +10157,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -9997,6 +10183,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -10012,10 +10201,10 @@
    -

    partially update the specified PodTemplate

    +

    create a PodTemplate

    -
    PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
    +
    POST /api/v1/namespaces/{namespace}/podtemplates
    @@ -10053,7 +10242,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1.PodTemplate

    @@ -10064,14 +10253,6 @@

    string

    - -

    PathParameter

    -

    name

    -

    name of the PodTemplate

    -

    true

    -

    string

    - - @@ -10095,7 +10276,7 @@

    200

    success

    -

    v1.PodTemplate

    +

    v1.PodTemplate

    @@ -10106,13 +10287,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -10127,6 +10302,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -10142,10 +10320,10 @@
    -

    list or watch objects of kind ReplicationController

    +

    read the specified PodTemplate

    -
    GET /api/v1/namespaces/{namespace}/replicationcontrollers
    +
    GET /api/v1/namespaces/{namespace}/podtemplates/{name}
    @@ -10180,42 +10358,18 @@

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    +

    export

    +

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

    false

    boolean

    QueryParameter

    -

    resourceVersion

    -

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

    +

    exact

    +

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

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    boolean

    @@ -10226,6 +10380,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the PodTemplate

    +

    true

    +

    string

    + + @@ -10249,7 +10411,7 @@

    200

    success

    -

    v1.ReplicationControllerList

    +

    v1.PodTemplate

    @@ -10275,6 +10437,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -10290,10 +10455,10 @@
    -

    delete collection of ReplicationController

    +

    replace the specified PodTemplate

    -
    DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
    +
    PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
    @@ -10327,43 +10492,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    v1.PodTemplate

    @@ -10374,6 +10507,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the PodTemplate

    +

    true

    +

    string

    + + @@ -10397,7 +10538,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.PodTemplate

    @@ -10423,6 +10564,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -10438,10 +10582,10 @@
    -

    create a ReplicationController

    +

    delete a PodTemplate

    -
    POST /api/v1/namespaces/{namespace}/replicationcontrollers
    +
    DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
    @@ -10479,7 +10623,7 @@

    body

    true

    -

    v1.ReplicationController

    +

    v1.DeleteOptions

    @@ -10490,6 +10634,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the PodTemplate

    +

    true

    +

    string

    + + @@ -10513,7 +10665,7 @@

    200

    success

    -

    v1.ReplicationController

    +

    unversioned.Status

    @@ -10539,6 +10691,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -10554,6 +10709,560 @@
    +

    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

    @@ -10561,7 +11270,7 @@
    -

    Parameters

    +

    Parameters

    @@ -10625,500 +11334,6 @@
    -
    -
    -

    Responses

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

    200

    success

    v1.ReplicationController

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

    @@ -11139,7 +11354,7 @@

    200

    success

    -

    v1.Scale

    +

    v1.ReplicationController

    @@ -11165,6 +11380,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -11180,10 +11398,10 @@
    -

    replace scale of the specified Scale

    +

    replace the specified ReplicationController

    -
    PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
    +
    PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
    @@ -11221,7 +11439,7 @@

    body

    true

    -

    v1.Scale

    +

    v1.ReplicationController

    @@ -11235,7 +11453,7 @@

    PathParameter

    name

    -

    name of the Scale

    +

    name of the ReplicationController

    true

    string

    @@ -11263,7 +11481,7 @@

    200

    success

    -

    v1.Scale

    +

    v1.ReplicationController

    @@ -11289,6 +11507,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -11304,10 +11525,10 @@
    -

    partially update scale of the specified Scale

    +

    delete a ReplicationController

    -
    PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
    +
    DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
    @@ -11345,7 +11566,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1.DeleteOptions

    @@ -11359,7 +11580,7 @@

    PathParameter

    name

    -

    name of the Scale

    +

    name of the ReplicationController

    true

    string

    @@ -11387,7 +11608,7 @@

    200

    success

    -

    v1.Scale

    +

    unversioned.Status

    @@ -11398,13 +11619,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -11419,6 +11634,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -11434,10 +11652,10 @@
    -

    replace status of the specified ReplicationController

    +

    partially update the specified ReplicationController

    -
    PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
    +
    PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
    @@ -11475,7 +11693,7 @@

    body

    true

    -

    v1.ReplicationController

    +

    unversioned.Patch

    @@ -11517,7 +11735,7 @@

    200

    success

    -

    v1.ReplicationController

    +

    v1.ReplicationController

    @@ -11528,7 +11746,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -11543,6 +11767,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -11558,10 +11785,10 @@
    -

    list or watch objects of kind ResourceQuota

    +

    read scale of the specified Scale

    -
    GET /api/v1/namespaces/{namespace}/resourcequotas
    +
    GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
    @@ -11595,49 +11822,17 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

    +

    name

    +

    name of the Scale

    true

    string

    @@ -11665,7 +11860,7 @@

    200

    success

    -

    v1.ResourceQuotaList

    +

    v1.Scale

    @@ -11691,6 +11886,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -11706,10 +11904,10 @@
    -

    delete collection of ResourceQuota

    +

    replace scale of the specified Scale

    -
    DELETE /api/v1/namespaces/{namespace}/resourcequotas
    +
    PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
    @@ -11743,43 +11941,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    v1.Scale

    @@ -11790,6 +11956,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the Scale

    +

    true

    +

    string

    + + @@ -11813,7 +11987,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.Scale

    @@ -11839,6 +12013,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -11854,10 +12031,10 @@
    -

    create a ResourceQuota

    +

    partially update scale of the specified Scale

    -
    POST /api/v1/namespaces/{namespace}/resourcequotas
    +
    PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
    @@ -11895,7 +12072,7 @@

    body

    true

    -

    v1.ResourceQuota

    +

    unversioned.Patch

    @@ -11906,6 +12083,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the Scale

    +

    true

    +

    string

    + + @@ -11929,7 +12114,7 @@

    200

    success

    -

    v1.ResourceQuota

    +

    v1.Scale

    @@ -11940,7 +12125,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -11955,6 +12146,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -11970,10 +12164,10 @@
    -

    read the specified ResourceQuota

    +

    read status of the specified ReplicationController

    -
    GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
    +
    GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
    @@ -12007,22 +12201,6 @@ -

    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

    @@ -12033,7 +12211,7 @@

    PathParameter

    name

    -

    name of the ResourceQuota

    +

    name of the ReplicationController

    true

    string

    @@ -12061,7 +12239,7 @@

    200

    success

    -

    v1.ResourceQuota

    +

    v1.ReplicationController

    @@ -12087,6 +12265,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -12102,10 +12283,10 @@
    -

    replace the specified ResourceQuota

    +

    replace status of the specified ReplicationController

    -
    PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
    +
    PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
    @@ -12143,7 +12324,7 @@

    body

    true

    -

    v1.ResourceQuota

    +

    v1.ReplicationController

    @@ -12157,7 +12338,7 @@

    PathParameter

    name

    -

    name of the ResourceQuota

    +

    name of the ReplicationController

    true

    string

    @@ -12185,7 +12366,7 @@

    200

    success

    -

    v1.ResourceQuota

    +

    v1.ReplicationController

    @@ -12211,6 +12392,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -12226,10 +12410,10 @@
    -

    delete a ResourceQuota

    +

    partially update status of the specified ReplicationController

    -
    DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
    +
    PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
    @@ -12267,7 +12451,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    unversioned.Patch

    @@ -12281,7 +12465,7 @@

    PathParameter

    name

    -

    name of the ResourceQuota

    +

    name of the ReplicationController

    true

    string

    @@ -12309,7 +12493,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.ReplicationController

    @@ -12320,7 +12504,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -12335,6 +12525,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -12350,10 +12543,10 @@
    -

    partially update the specified ResourceQuota

    +

    list or watch objects of kind ResourceQuota

    -
    PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
    +
    GET /api/v1/namespaces/{namespace}/resourcequotas
    @@ -12387,11 +12580,43 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    +

    string

    -

    true

    -

    unversioned.Patch

    + + +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -12402,14 +12627,6 @@

    string

    - -

    PathParameter

    -

    name

    -

    name of the ResourceQuota

    -

    true

    -

    string

    - - @@ -12433,7 +12650,7 @@

    200

    success

    -

    v1.ResourceQuota

    +

    v1.ResourceQuotaList

    @@ -12444,13 +12661,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -12465,6 +12676,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -12480,10 +12694,10 @@
    -

    replace status of the specified ResourceQuota

    +

    delete collection of ResourceQuota

    -
    PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
    +
    DELETE /api/v1/namespaces/{namespace}/resourcequotas
    @@ -12517,11 +12731,43 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    +

    string

    -

    true

    -

    v1.ResourceQuota

    + + +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -12532,14 +12778,6 @@

    string

    - -

    PathParameter

    -

    name

    -

    name of the ResourceQuota

    -

    true

    -

    string

    - - @@ -12563,7 +12801,7 @@

    200

    success

    -

    v1.ResourceQuota

    +

    unversioned.Status

    @@ -12589,6 +12827,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -12604,10 +12845,10 @@
    -

    list or watch objects of kind Secret

    +

    create a ResourceQuota

    -
    GET /api/v1/namespaces/{namespace}/secrets
    +
    POST /api/v1/namespaces/{namespace}/resourcequotas
    @@ -12641,43 +12882,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    v1.ResourceQuota

    @@ -12711,7 +12920,7 @@

    200

    success

    -

    v1.SecretList

    +

    v1.ResourceQuota

    @@ -12737,6 +12946,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -12752,10 +12964,10 @@
    -

    delete collection of Secret

    +

    read the specified ResourceQuota

    -
    DELETE /api/v1/namespaces/{namespace}/secrets
    +
    GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
    @@ -12790,270 +13002,6 @@

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apiv1

      -
      • -
    -
    -
    -
    -
    -

    read the specified Secret

    -
    -
    -
    GET /api/v1/namespaces/{namespace}/secrets/{name}
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - @@ -13079,7 +13027,261 @@ - + + + + + + +
    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

    PathParameter

    name

    name of the Secret

    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

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -13107,7 +13309,7 @@ - +
    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

    200

    success

    v1.Secret

    unversioned.Status
    @@ -13133,6 +13335,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -13148,10 +13353,10 @@
    -

    replace the specified Secret

    +

    partially update the specified ResourceQuota

    -
    PUT /api/v1/namespaces/{namespace}/secrets/{name}
    +
    PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
    @@ -13189,7 +13394,7 @@

    body

    true

    -

    v1.Secret

    +

    unversioned.Patch

    @@ -13203,7 +13408,7 @@

    PathParameter

    name

    -

    name of the Secret

    +

    name of the ResourceQuota

    true

    string

    @@ -13231,7 +13436,7 @@

    200

    success

    -

    v1.Secret

    +

    v1.ResourceQuota

    @@ -13242,7 +13447,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -13257,6 +13468,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -13272,10 +13486,10 @@
    -

    delete a Secret

    +

    read status of the specified ResourceQuota

    -
    DELETE /api/v1/namespaces/{namespace}/secrets/{name}
    +
    GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
    @@ -13309,14 +13523,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1.DeleteOptions

    - - -

    PathParameter

    namespace

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

    @@ -13327,7 +13533,7 @@

    PathParameter

    name

    -

    name of the Secret

    +

    name of the ResourceQuota

    true

    string

    @@ -13355,7 +13561,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.ResourceQuota

    @@ -13381,6 +13587,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -13396,10 +13605,10 @@
    -

    partially update the specified Secret

    +

    replace status of the specified ResourceQuota

    -
    PATCH /api/v1/namespaces/{namespace}/secrets/{name}
    +
    PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
    @@ -13437,7 +13646,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1.ResourceQuota

    @@ -13451,7 +13660,7 @@

    PathParameter

    name

    -

    name of the Secret

    +

    name of the ResourceQuota

    true

    string

    @@ -13479,7 +13688,7 @@

    200

    success

    -

    v1.Secret

    +

    v1.ResourceQuota

    @@ -13490,13 +13699,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -13511,6 +13714,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -13526,10 +13732,10 @@
    -

    list or watch objects of kind ServiceAccount

    +

    partially update status of the specified ResourceQuota

    -
    GET /api/v1/namespaces/{namespace}/serviceaccounts
    +
    PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
    @@ -13563,43 +13769,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    unversioned.Patch

    @@ -13610,6 +13784,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the ResourceQuota

    +

    true

    +

    string

    + + @@ -13633,7 +13815,7 @@

    200

    success

    -

    v1.ServiceAccountList

    +

    v1.ResourceQuota

    @@ -13644,7 +13826,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -13659,6 +13847,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -13674,10 +13865,10 @@
    -

    delete collection of ServiceAccount

    +

    list or watch objects of kind Secret

    -
    DELETE /api/v1/namespaces/{namespace}/serviceaccounts
    +
    GET /api/v1/namespaces/{namespace}/secrets
    @@ -13781,7 +13972,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.SecretList

    @@ -13807,6 +13998,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -13822,10 +14016,10 @@
    -

    create a ServiceAccount

    +

    delete collection of Secret

    -
    POST /api/v1/namespaces/{namespace}/serviceaccounts
    +
    DELETE /api/v1/namespaces/{namespace}/secrets
    @@ -13859,632 +14053,6 @@ -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apiv1

      -
      • -
    -
    -
    -
    -
    -

    list or watch objects of kind Service

    -
    -
    -
    GET /api/v1/namespaces/{namespace}/services
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - @@ -14537,7 +14105,7 @@
    -

    Responses

    +

    Responses

    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.
    @@ -14555,14 +14123,14 @@ - +

    200

    success

    v1.ServiceList

    unversioned.Status
    -

    Consumes

    +

    Consumes

    • @@ -14572,7 +14140,7 @@
    -

    Produces

    +

    Produces

    • @@ -14581,11 +14149,14 @@

    • application/yaml

      • +
    • +

      application/vnd.kubernetes.protobuf

      +
    -

    Tags

    +

    Tags

    • @@ -14596,14 +14167,14 @@
    -

    create a Service

    +

    create a Secret

    -
    POST /api/v1/namespaces/{namespace}/services
    +
    POST /api/v1/namespaces/{namespace}/secrets
    -

    Parameters

    +

    Parameters

    @@ -14637,7 +14208,680 @@ - + + + + + + + + + + + + +

    body

    true

    v1.Service

    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

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -14671,7 +14915,7 @@ - +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

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

    false

    string

    QueryParameter

    fieldSelector

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

    false

    string

    QueryParameter

    watch

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

    false

    boolean

    QueryParameter

    resourceVersion

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

    false

    string

    QueryParameter

    timeoutSeconds

    Timeout for the list/watch call.

    false

    integer (int32)

    200

    success

    v1.Service

    v1.ServiceAccountList
    @@ -14697,6 +14941,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -14712,6 +14959,1068 @@
    +

    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

    @@ -14719,7 +16028,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14783,952 +16092,6 @@
    -
    -
    -

    Responses

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

    200

    success

    v1.Service

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

    @@ -15747,9 +16110,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.Service

    @@ -15770,7 +16133,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -15787,10 +16156,10 @@
    -

    connect PUT requests to proxy of Service

    +

    replace the specified Service

    -
    PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    +
    PUT /api/v1/namespaces/{namespace}/services/{name}
    @@ -15817,13 +16186,21 @@

    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.

    +

    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

    @@ -15839,14 +16216,6 @@

    string

    - -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    -

    string

    - - @@ -15868,9 +16237,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.Service

    @@ -15891,7 +16260,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -15908,10 +16283,10 @@
    -

    connect DELETE requests to proxy of Service

    +

    delete a Service

    -
    DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    +
    DELETE /api/v1/namespaces/{namespace}/services/{name}
    @@ -15938,8 +16313,8 @@

    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.

    +

    pretty

    +

    If true, then the output is pretty printed.

    false

    string

    @@ -15960,14 +16335,6 @@

    string

    - -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    -

    string

    - - @@ -15989,9 +16356,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    unversioned.Status

    @@ -16012,7 +16379,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -16029,10 +16402,10 @@
    -

    connect POST requests to proxy of Service

    +

    partially update the specified Service

    -
    POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    +
    PATCH /api/v1/namespaces/{namespace}/services/{name}
    @@ -16059,127 +16432,6 @@

    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

      -
      • -
    -
    -
    -
    -
    -

    replace status of the specified Service

    -
    -
    -
    PUT /api/v1/namespaces/{namespace}/services/{name}/status
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - @@ -16191,7 +16443,132 @@ - + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    body

    true

    v1.Service

    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

    + ++++++++ + + + + + + + + + + + + + + + + + @@ -16231,9 +16608,9 @@ - + - +
    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

    200

    default

    success

    v1.Service

    string
    @@ -16254,10 +16631,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -16274,10 +16648,10 @@
    -

    read the specified Namespace

    +

    connect PUT requests to proxy of Service

    -
    GET /api/v1/namespaces/{name}
    +
    PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
    @@ -16304,32 +16678,24 @@

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    +

    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

    -

    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 Namespace

    +

    name of the Service

    true

    string

    @@ -16355,9 +16721,9 @@ -

    200

    +

    default

    success

    -

    v1.Namespace

    +

    string

    @@ -16378,10 +16744,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -16398,10 +16761,10 @@
    -

    replace the specified Namespace

    +

    connect DELETE requests to proxy of Service

    -
    PUT /api/v1/namespaces/{name}
    +
    DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
    @@ -16428,24 +16791,24 @@

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    +

    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

    -

    BodyParameter

    -

    body

    - +

    PathParameter

    +

    namespace

    +

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

    true

    -

    v1.Namespace

    +

    string

    PathParameter

    name

    -

    name of the Namespace

    +

    name of the Service

    true

    string

    @@ -16471,9 +16834,9 @@ -

    200

    +

    default

    success

    -

    v1.Namespace

    +

    string

    @@ -16494,10 +16857,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -16514,10 +16874,10 @@
    -

    delete a Namespace

    +

    connect POST requests to proxy of Service

    -
    DELETE /api/v1/namespaces/{name}
    +
    POST /api/v1/namespaces/{namespace}/services/{name}/proxy
    @@ -16544,24 +16904,24 @@

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    +

    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

    -

    BodyParameter

    -

    body

    - +

    PathParameter

    +

    namespace

    +

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

    true

    -

    v1.DeleteOptions

    +

    string

    PathParameter

    name

    -

    name of the Namespace

    +

    name of the Service

    true

    string

    @@ -16587,9 +16947,9 @@ -

    200

    +

    default

    success

    -

    unversioned.Status

    +

    string

    @@ -16610,10 +16970,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -16630,10 +16987,10 @@
    -

    partially update the specified Namespace

    +

    connect GET requests to proxy of Service

    -
    PATCH /api/v1/namespaces/{name}
    +
    GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    @@ -16660,24 +17017,32 @@

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    +

    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

    -

    BodyParameter

    -

    body

    - +

    PathParameter

    +

    namespace

    +

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

    true

    -

    unversioned.Patch

    +

    string

    PathParameter

    name

    -

    name of the Namespace

    +

    name of the Service

    +

    true

    +

    string

    + + + +

    PathParameter

    +

    path

    +

    path to the resource

    true

    string

    @@ -16703,9 +17068,9 @@ -

    200

    +

    default

    success

    -

    v1.Namespace

    +

    string

    @@ -16716,13 +17081,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -16732,10 +17091,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -16752,10 +17108,10 @@
    -

    replace finalize of the specified Namespace

    +

    connect PUT requests to proxy of Service

    -
    PUT /api/v1/namespaces/{name}/finalize
    +
    PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    @@ -16782,24 +17138,32 @@

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    +

    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

    -

    BodyParameter

    -

    body

    - +

    PathParameter

    +

    namespace

    +

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

    true

    -

    v1.Namespace

    +

    string

    PathParameter

    name

    -

    name of the Namespace

    +

    name of the Service

    +

    true

    +

    string

    + + + +

    PathParameter

    +

    path

    +

    path to the resource

    true

    string

    @@ -16825,9 +17189,9 @@ -

    200

    +

    default

    success

    -

    v1.Namespace

    +

    string

    @@ -16848,10 +17212,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -16868,10 +17229,10 @@
    -

    replace status of the specified Namespace

    +

    connect DELETE requests to proxy of Service

    -
    PUT /api/v1/namespaces/{name}/status
    +
    DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    @@ -16898,24 +17259,32 @@

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    +

    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

    -

    BodyParameter

    -

    body

    - +

    PathParameter

    +

    namespace

    +

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

    true

    -

    v1.Namespace

    +

    string

    PathParameter

    name

    -

    name of the Namespace

    +

    name of the Service

    +

    true

    +

    string

    + + + +

    PathParameter

    +

    path

    +

    path to the resource

    true

    string

    @@ -16941,9 +17310,9 @@ -

    200

    +

    default

    success

    -

    v1.Namespace

    +

    string

    @@ -16964,10 +17333,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -16984,10 +17350,10 @@
    -

    list or watch objects of kind Node

    +

    connect POST requests to proxy of Service

    -
    GET /api/v1/nodes
    +
    POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    @@ -17014,52 +17380,36 @@

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    +

    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

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Service

    +

    true

    string

    -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    +

    PathParameter

    +

    path

    +

    path to the resource

    +

    true

    string

    - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -17081,9 +17431,9 @@ -

    200

    +

    default

    success

    -

    v1.NodeList

    +

    string

    @@ -17104,10 +17454,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -17124,10 +17471,10 @@
    -

    delete collection of Node

    +

    read status of the specified Service

    -
    DELETE /api/v1/nodes
    +
    GET /api/v1/namespaces/{namespace}/services/{name}/status
    @@ -17161,45 +17508,21 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Service

    +

    true

    string

    - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -17223,7 +17546,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.Service

    @@ -17249,6 +17572,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -17264,10 +17590,10 @@
    -

    create a Node

    +

    replace status of the specified Service

    -
    POST /api/v1/nodes
    +
    PUT /api/v1/namespaces/{namespace}/services/{name}/status
    @@ -17305,7 +17631,23 @@

    body

    true

    -

    v1.Node

    +

    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

    @@ -17331,7 +17673,7 @@

    200

    success

    -

    v1.Node

    +

    v1.Service

    @@ -17357,6 +17699,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -17372,10 +17717,10 @@
    -

    read the specified Node

    +

    partially update status of the specified Service

    -
    GET /api/v1/nodes/{name}
    +
    PATCH /api/v1/namespaces/{namespace}/services/{name}/status
    @@ -17409,6 +17754,139 @@ +

    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

    + ++++++++ + + + + + + + + + + + + + + + + + + + + @@ -17427,123 +17905,7 @@ - - - - - - -
    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.

    PathParameter

    name

    name of the Node

    true

    string

    - -
    -
    -

    Responses

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

    200

    success

    v1.Node

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    -
    -
    -
    -

    Tags

    -
    -
      -
    • -

      apiv1

      -
      • -
    -
    -
    -
    -
    -

    replace the specified Node

    -
    -
    -
    PUT /api/v1/nodes/{name}
    -
    -
    -
    -

    Parameters

    - -------- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -17571,7 +17933,7 @@ - +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1.Node

    PathParameter

    name

    name of the Node

    name of the Namespace

    true

    string

    200

    success

    v1.Node

    v1.Namespace
    @@ -17597,6 +17959,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -17612,10 +17977,10 @@
    -

    delete a Node

    +

    replace the specified Namespace

    -
    DELETE /api/v1/nodes/{name}
    +
    PUT /api/v1/namespaces/{name}
    @@ -17653,13 +18018,13 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.Namespace

    PathParameter

    name

    -

    name of the Node

    +

    name of the Namespace

    true

    string

    @@ -17687,7 +18052,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.Namespace

    @@ -17713,6 +18078,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -17728,10 +18096,10 @@
    -

    partially update the specified Node

    +

    delete a Namespace

    -
    PATCH /api/v1/nodes/{name}
    +
    DELETE /api/v1/namespaces/{name}
    @@ -17769,13 +18137,13 @@

    body

    true

    -

    unversioned.Patch

    +

    v1.DeleteOptions

    PathParameter

    name

    -

    name of the Node

    +

    name of the Namespace

    true

    string

    @@ -17803,7 +18171,7 @@

    200

    success

    -

    v1.Node

    +

    unversioned.Status

    @@ -17814,13 +18182,7 @@
    • -

      application/json-patch+json

      -
      • -
    • -

      application/merge-patch+json

      -
      • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -17835,6 +18197,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -17850,10 +18215,10 @@
    -

    connect GET requests to proxy of Node

    +

    partially update the specified Namespace

    -
    GET /api/v1/nodes/{name}/proxy
    +
    PATCH /api/v1/namespaces/{name}
    @@ -17880,16 +18245,24 @@

    QueryParameter

    -

    path

    -

    Path is the URL path to use for the current proxy request to node.

    +

    pretty

    +

    If true, then the output is pretty printed.

    false

    string

    +

    BodyParameter

    +

    body

    + +

    true

    +

    unversioned.Patch

    + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Namespace

    true

    string

    @@ -17915,9 +18288,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.Namespace

    @@ -17928,7 +18301,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -17938,7 +18317,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -17955,10 +18340,10 @@
    -

    connect PUT requests to proxy of Node

    +

    replace finalize of the specified Namespace

    -
    PUT /api/v1/nodes/{name}/proxy
    +
    PUT /api/v1/namespaces/{name}/finalize
    @@ -17985,16 +18370,24 @@

    QueryParameter

    -

    path

    -

    Path is the URL path to use for the current proxy request to node.

    +

    pretty

    +

    If true, then the output is pretty printed.

    false

    string

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.Namespace

    + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Namespace

    true

    string

    @@ -18020,9 +18413,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.Namespace

    @@ -18043,7 +18436,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -18060,10 +18459,10 @@
    -

    connect DELETE requests to proxy of Node

    +

    read status of the specified Namespace

    -
    DELETE /api/v1/nodes/{name}/proxy
    +
    GET /api/v1/namespaces/{name}/status
    @@ -18090,8 +18489,8 @@

    QueryParameter

    -

    path

    -

    Path is the URL path to use for the current proxy request to node.

    +

    pretty

    +

    If true, then the output is pretty printed.

    false

    string

    @@ -18099,7 +18498,7 @@

    PathParameter

    name

    -

    name of the Node

    +

    name of the Namespace

    true

    string

    @@ -18125,9 +18524,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.Namespace

    @@ -18148,7 +18547,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -18165,10 +18570,10 @@
    -

    connect POST requests to proxy of Node

    +

    replace status of the specified Namespace

    -
    POST /api/v1/nodes/{name}/proxy
    +
    PUT /api/v1/namespaces/{name}/status
    @@ -18195,16 +18600,24 @@

    QueryParameter

    -

    path

    -

    Path is the URL path to use for the current proxy request to node.

    +

    pretty

    +

    If true, then the output is pretty printed.

    false

    string

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.Namespace

    + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Namespace

    true

    string

    @@ -18230,9 +18643,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.Namespace

    @@ -18253,7 +18666,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -18270,10 +18689,10 @@
    -

    connect GET requests to proxy of Node

    +

    partially update status of the specified Namespace

    -
    GET /api/v1/nodes/{name}/proxy/{path}
    +
    PATCH /api/v1/namespaces/{name}/status
    @@ -18300,24 +18719,24 @@

    QueryParameter

    -

    path

    -

    Path is the URL path to use for the current proxy request to node.

    +

    pretty

    +

    If true, then the output is pretty printed.

    false

    string

    -

    PathParameter

    -

    name

    -

    name of the Node

    +

    BodyParameter

    +

    body

    +

    true

    -

    string

    +

    unversioned.Patch

    PathParameter

    -

    path

    -

    path to the resource

    +

    name

    +

    name of the Namespace

    true

    string

    @@ -18343,9 +18762,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.Namespace

    @@ -18356,7 +18775,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -18366,7 +18791,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -18383,10 +18814,10 @@
    -

    connect PUT requests to proxy of Node

    +

    list or watch objects of kind Node

    -
    PUT /api/v1/nodes/{name}/proxy/{path}
    +
    GET /api/v1/nodes
    @@ -18413,28 +18844,52 @@

    QueryParameter

    -

    path

    -

    Path is the URL path to use for the current proxy request to node.

    +

    pretty

    +

    If true, then the output is pretty printed.

    false

    string

    -

    PathParameter

    -

    name

    -

    name of the Node

    -

    true

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    string

    -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    string

    + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    + + @@ -18456,9 +18911,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.NodeList

    @@ -18479,7 +18934,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -18496,10 +18957,10 @@
    -

    connect DELETE requests to proxy of Node

    +

    delete collection of Node

    -
    DELETE /api/v1/nodes/{name}/proxy/{path}
    +
    DELETE /api/v1/nodes
    @@ -18526,28 +18987,52 @@

    QueryParameter

    -

    path

    -

    Path is the URL path to use for the current proxy request to node.

    +

    pretty

    +

    If true, then the output is pretty printed.

    false

    string

    -

    PathParameter

    -

    name

    -

    name of the Node

    -

    true

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    string

    -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    string

    + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    + + @@ -18569,9 +19054,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    unversioned.Status

    @@ -18592,7 +19077,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -18609,10 +19100,10 @@
    -

    connect POST requests to proxy of Node

    +

    create a Node

    -
    POST /api/v1/nodes/{name}/proxy/{path}
    +
    POST /api/v1/nodes
    @@ -18639,26 +19130,18 @@

    QueryParameter

    -

    path

    -

    Path is the URL path to use for the current proxy request to node.

    +

    pretty

    +

    If true, then the output is pretty printed.

    false

    string

    -

    PathParameter

    -

    name

    -

    name of the Node

    -

    true

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    PathParameter

    -

    path

    -

    path to the resource

    true

    -

    string

    +

    v1.Node

    @@ -18682,9 +19165,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.Node

    @@ -18705,7 +19188,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -18722,10 +19211,10 @@
    -

    replace status of the specified Node

    +

    read the specified Node

    -
    PUT /api/v1/nodes/{name}/status
    +
    GET /api/v1/nodes/{name}
    @@ -18759,11 +19248,19 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    export

    +

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

    +

    false

    +

    boolean

    -

    true

    -

    v1.Node

    + + +

    QueryParameter

    +

    exact

    +

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

    +

    false

    +

    boolean

    @@ -18797,7 +19294,7 @@

    200

    success

    -

    v1.Node

    +

    v1.Node

    @@ -18823,6 +19320,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -18838,10 +19338,10 @@
    -

    list or watch objects of kind PersistentVolumeClaim

    +

    replace the specified Node

    -
    GET /api/v1/persistentvolumeclaims
    +
    PUT /api/v1/nodes/{name}
    @@ -18875,45 +19375,21 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.Node

    + + + +

    PathParameter

    +

    name

    +

    name of the Node

    +

    true

    string

    - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -18937,7 +19413,7 @@

    200

    success

    -

    v1.PersistentVolumeClaimList

    +

    v1.Node

    @@ -18963,6 +19439,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -18978,10 +19457,10 @@
    -

    list or watch objects of kind PersistentVolume

    +

    delete a Node

    -
    GET /api/v1/persistentvolumes
    +
    DELETE /api/v1/nodes/{name}
    @@ -19015,45 +19494,21 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.DeleteOptions

    + + + +

    PathParameter

    +

    name

    +

    name of the Node

    +

    true

    string

    - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -19077,7 +19532,7 @@

    200

    success

    -

    v1.PersistentVolumeList

    +

    unversioned.Status

    @@ -19103,6 +19558,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -19118,10 +19576,10 @@
    -

    delete collection of PersistentVolume

    +

    partially update the specified Node

    -
    DELETE /api/v1/persistentvolumes
    +
    PATCH /api/v1/nodes/{name}
    @@ -19155,6 +19613,1358 @@ +

    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

    + ++++++++ + + + + + + + + + + + + + + + + + + + + @@ -19199,7 +21009,7 @@
    -

    Responses

    +

    Responses

    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.
    @@ -19217,14 +21027,14 @@ - +

    200

    success

    unversioned.Status

    v1.PersistentVolumeClaimList
    -

    Consumes

    +

    Consumes

    • @@ -19234,7 +21044,7 @@
    -

    Produces

    +

    Produces

    • @@ -19243,11 +21053,300 @@

    • application/yaml

      • +
    • +

      application/vnd.kubernetes.protobuf

      +
    -

    Tags

    +

    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

    • @@ -19265,7 +21364,7 @@
    -

    Parameters

    +

    Parameters

    @@ -19299,7 +21398,7 @@ - + @@ -19307,7 +21406,7 @@
    -

    Responses

    +

    Responses

    body

    true

    v1.PersistentVolume

    v1.PersistentVolume
    @@ -19325,14 +21424,14 @@ - +

    200

    success

    v1.PersistentVolume

    v1.PersistentVolume
    -

    Consumes

    +

    Consumes

    • @@ -19342,7 +21441,7 @@
    -

    Produces

    +

    Produces

    • @@ -19351,11 +21450,14 @@

    • application/yaml

      • +
    • +

      application/vnd.kubernetes.protobuf

      +
    -

    Tags

    +

    Tags

    • @@ -19373,7 +21475,7 @@
    -

    Parameters

    +

    Parameters

    @@ -19429,1631 +21531,6 @@
    -
    -
    -

    Responses

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

    200

    success

    v1.PersistentVolume

    - -
    -
    -

    Consumes

    -
    -
      -
    • -

      /

      -
      • -
    -
    -
    -
    -

    Produces

    -
    -
      -
    • -

      application/json

      -
      • -
    • -

      application/yaml

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

      -
      • -
    -
    -
    -
    -

    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

    @@ -21072,9 +21549,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.PersistentVolume

    @@ -21095,7 +21572,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -21112,10 +21595,10 @@
    -

    proxy GET requests to Service

    +

    replace the specified PersistentVolume

    -
    GET /api/v1/proxy/namespaces/{namespace}/services/{name}
    +
    PUT /api/v1/persistentvolumes/{name}
    @@ -21141,17 +21624,25 @@ -

    PathParameter

    -

    namespace

    -

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

    -

    true

    +

    QueryParameter

    +

    pretty

    +

    If true, then the output is pretty printed.

    +

    false

    string

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.PersistentVolume

    + + +

    PathParameter

    name

    -

    name of the Service

    +

    name of the PersistentVolume

    true

    string

    @@ -21177,9 +21668,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.PersistentVolume

    @@ -21200,7 +21691,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -21217,10 +21714,10 @@
    -

    proxy PUT requests to Service

    +

    delete a PersistentVolume

    -
    PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
    +
    DELETE /api/v1/persistentvolumes/{name}
    @@ -21246,17 +21743,25 @@ -

    PathParameter

    -

    namespace

    -

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

    -

    true

    +

    QueryParameter

    +

    pretty

    +

    If true, then the output is pretty printed.

    +

    false

    string

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.DeleteOptions

    + + +

    PathParameter

    name

    -

    name of the Service

    +

    name of the PersistentVolume

    true

    string

    @@ -21282,9 +21787,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    unversioned.Status

    @@ -21305,7 +21810,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -21322,10 +21833,10 @@
    -

    proxy DELETE requests to Service

    +

    partially update the specified PersistentVolume

    -
    DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
    +
    PATCH /api/v1/persistentvolumes/{name}
    @@ -21351,17 +21862,25 @@ -

    PathParameter

    -

    namespace

    -

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

    -

    true

    +

    QueryParameter

    +

    pretty

    +

    If true, then the output is pretty printed.

    +

    false

    string

    +

    BodyParameter

    +

    body

    + +

    true

    +

    unversioned.Patch

    + + +

    PathParameter

    name

    -

    name of the Service

    +

    name of the PersistentVolume

    true

    string

    @@ -21387,9 +21906,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.PersistentVolume

    @@ -21400,7 +21919,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -21410,7 +21935,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -21427,10 +21958,10 @@
    -

    proxy POST requests to Service

    +

    read status of the specified PersistentVolume

    -
    POST /api/v1/proxy/namespaces/{namespace}/services/{name}
    +
    GET /api/v1/persistentvolumes/{name}/status
    @@ -21456,17 +21987,17 @@ -

    PathParameter

    -

    namespace

    -

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

    -

    true

    +

    QueryParameter

    +

    pretty

    +

    If true, then the output is pretty printed.

    +

    false

    string

    PathParameter

    name

    -

    name of the Service

    +

    name of the PersistentVolume

    true

    string

    @@ -21492,9 +22023,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.PersistentVolume

    @@ -21515,7 +22046,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -21532,10 +22069,10 @@
    -

    proxy GET requests to Service

    +

    replace status of the specified PersistentVolume

    -
    GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    +
    PUT /api/v1/persistentvolumes/{name}/status
    @@ -21561,25 +22098,25 @@ -

    PathParameter

    -

    namespace

    -

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

    -

    true

    +

    QueryParameter

    +

    pretty

    +

    If true, then the output is pretty printed.

    +

    false

    string

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.PersistentVolume

    + + +

    PathParameter

    name

    -

    name of the Service

    -

    true

    -

    string

    - - - -

    PathParameter

    -

    path

    -

    path to the resource

    +

    name of the PersistentVolume

    true

    string

    @@ -21605,9 +22142,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.PersistentVolume

    @@ -21628,7 +22165,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -21645,10 +22188,10 @@
    -

    proxy PUT requests to Service

    +

    partially update status of the specified PersistentVolume

    -
    PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    +
    PATCH /api/v1/persistentvolumes/{name}/status
    @@ -21674,25 +22217,25 @@ -

    PathParameter

    -

    namespace

    -

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

    -

    true

    +

    QueryParameter

    +

    pretty

    +

    If true, then the output is pretty printed.

    +

    false

    string

    +

    BodyParameter

    +

    body

    + +

    true

    +

    unversioned.Patch

    + + +

    PathParameter

    name

    -

    name of the Service

    -

    true

    -

    string

    - - - -

    PathParameter

    -

    path

    -

    path to the resource

    +

    name of the PersistentVolume

    true

    string

    @@ -21718,9 +22261,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.PersistentVolume

    @@ -21731,7 +22274,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -21741,7 +22290,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -21758,10 +22313,10 @@
    -

    proxy DELETE requests to Service

    +

    list or watch objects of kind Pod

    -
    DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    +
    GET /api/v1/pods
    @@ -21787,29 +22342,53 @@ -

    PathParameter

    -

    namespace

    -

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

    -

    true

    +

    QueryParameter

    +

    pretty

    +

    If true, then the output is pretty printed.

    +

    false

    string

    -

    PathParameter

    -

    name

    -

    name of the Service

    -

    true

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    string

    -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    string

    + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    + + @@ -21831,9 +22410,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.PodList

    @@ -21854,7 +22433,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -21871,10 +22456,10 @@
    -

    proxy POST requests to Service

    +

    list or watch objects of kind PodTemplate

    -
    POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    +
    GET /api/v1/podtemplates
    @@ -21900,29 +22485,53 @@ -

    PathParameter

    -

    namespace

    -

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

    -

    true

    +

    QueryParameter

    +

    pretty

    +

    If true, then the output is pretty printed.

    +

    false

    string

    -

    PathParameter

    -

    name

    -

    name of the Service

    -

    true

    +

    QueryParameter

    +

    labelSelector

    +

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

    +

    false

    string

    -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    +

    QueryParameter

    +

    fieldSelector

    +

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

    +

    false

    string

    + +

    QueryParameter

    +

    watch

    +

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

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

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

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    + + @@ -21944,9 +22553,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.PodTemplateList

    @@ -21967,7 +22576,13 @@
    • -

      /

      +

      application/json

      +
      • +
    • +

      application/yaml

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -21984,10 +22599,10 @@
    -

    proxy GET requests to Node

    +

    proxy GET requests to Pod

    -
    GET /api/v1/proxy/nodes/{name}
    +
    GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
    @@ -22014,8 +22629,16 @@

    PathParameter

    +

    namespace

    +

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

    +

    true

    +

    string

    + + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Pod

    true

    string

    @@ -22081,10 +22704,10 @@
    -

    proxy PUT requests to Node

    +

    proxy PUT requests to Pod

    -
    PUT /api/v1/proxy/nodes/{name}
    +
    PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
    @@ -22111,8 +22734,16 @@

    PathParameter

    +

    namespace

    +

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

    +

    true

    +

    string

    + + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Pod

    true

    string

    @@ -22178,10 +22809,10 @@
    -

    proxy DELETE requests to Node

    +

    proxy DELETE requests to Pod

    -
    DELETE /api/v1/proxy/nodes/{name}
    +
    DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
    @@ -22208,8 +22839,16 @@

    PathParameter

    +

    namespace

    +

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

    +

    true

    +

    string

    + + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Pod

    true

    string

    @@ -22275,10 +22914,10 @@
    -

    proxy POST requests to Node

    +

    proxy POST requests to Pod

    -
    POST /api/v1/proxy/nodes/{name}
    +
    POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
    @@ -22305,8 +22944,16 @@

    PathParameter

    +

    namespace

    +

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

    +

    true

    +

    string

    + + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Pod

    true

    string

    @@ -22372,10 +23019,10 @@
    -

    proxy GET requests to Node

    +

    proxy GET requests to Pod

    -
    GET /api/v1/proxy/nodes/{name}/{path}
    +
    GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    @@ -22402,8 +23049,16 @@

    PathParameter

    +

    namespace

    +

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

    +

    true

    +

    string

    + + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Pod

    true

    string

    @@ -22477,10 +23132,10 @@
    -

    proxy PUT requests to Node

    +

    proxy PUT requests to Pod

    -
    PUT /api/v1/proxy/nodes/{name}/{path}
    +
    PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    @@ -22507,8 +23162,16 @@

    PathParameter

    +

    namespace

    +

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

    +

    true

    +

    string

    + + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Pod

    true

    string

    @@ -22582,10 +23245,10 @@
    -

    proxy DELETE requests to Node

    +

    proxy DELETE requests to Pod

    -
    DELETE /api/v1/proxy/nodes/{name}/{path}
    +
    DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    @@ -22612,8 +23275,16 @@

    PathParameter

    +

    namespace

    +

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

    +

    true

    +

    string

    + + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Pod

    true

    string

    @@ -22687,10 +23358,10 @@
    -

    proxy POST requests to Node

    +

    proxy POST requests to Pod

    -
    POST /api/v1/proxy/nodes/{name}/{path}
    +
    POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    @@ -22717,8 +23388,16 @@

    PathParameter

    +

    namespace

    +

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

    +

    true

    +

    string

    + + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Pod

    true

    string

    @@ -22792,10 +23471,10 @@
    -

    list or watch objects of kind ReplicationController

    +

    proxy GET requests to Service

    -
    GET /api/v1/replicationcontrollers
    +
    GET /api/v1/proxy/namespaces/{namespace}/services/{name}
    @@ -22821,53 +23500,21 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Service

    +

    true

    string

    - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -22889,9 +23536,9 @@ -

    200

    +

    default

    success

    -

    v1.ReplicationControllerList

    +

    string

    @@ -22912,10 +23559,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -22932,10 +23576,10 @@
    -

    list or watch objects of kind ResourceQuota

    +

    proxy PUT requests to Service

    -
    GET /api/v1/resourcequotas
    +
    PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
    @@ -22961,53 +23605,21 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Service

    +

    true

    string

    - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -23029,9 +23641,9 @@ -

    200

    +

    default

    success

    -

    v1.ResourceQuotaList

    +

    string

    @@ -23052,10 +23664,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -23072,10 +23681,10 @@
    -

    list or watch objects of kind Secret

    +

    proxy DELETE requests to Service

    -
    GET /api/v1/secrets
    +
    DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
    @@ -23101,53 +23710,21 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Service

    +

    true

    string

    - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -23169,9 +23746,9 @@ -

    200

    +

    default

    success

    -

    v1.SecretList

    +

    string

    @@ -23192,10 +23769,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -23212,10 +23786,10 @@
    -

    list or watch objects of kind ServiceAccount

    +

    proxy POST requests to Service

    -
    GET /api/v1/serviceaccounts
    +
    POST /api/v1/proxy/namespaces/{namespace}/services/{name}
    @@ -23241,53 +23815,21 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Service

    +

    true

    string

    - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -23309,9 +23851,9 @@ -

    200

    +

    default

    success

    -

    v1.ServiceAccountList

    +

    string

    @@ -23332,10 +23874,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -23352,10 +23891,10 @@
    -

    list or watch objects of kind Service

    +

    proxy GET requests to Service

    -
    GET /api/v1/services
    +
    GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    @@ -23381,53 +23920,29 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Service

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    +

    PathParameter

    +

    path

    +

    path to the resource

    +

    true

    string

    - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -23449,9 +23964,9 @@ -

    200

    +

    default

    success

    -

    v1.ServiceList

    +

    string

    @@ -23472,10 +23987,7 @@
    • -

      application/json

      -
      • -
    • -

      application/yaml

      +

      /

    @@ -23492,10 +24004,10 @@
    -

    watch individual changes to a list of ConfigMap

    +

    proxy PUT requests to Service

    -
    GET /api/v1/watch/configmaps
    +
    PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    @@ -23521,53 +24033,29 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Service

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    +

    PathParameter

    +

    path

    +

    path to the resource

    +

    true

    string

    - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -23589,9 +24077,9 @@ -

    200

    +

    default

    success

    -

    json.WatchEvent

    +

    string

    @@ -23612,7 +24100,7 @@
    • -

      application/json

      +

      /

    @@ -23629,10 +24117,10 @@
    -

    watch individual changes to a list of Endpoints

    +

    proxy DELETE requests to Service

    -
    GET /api/v1/watch/endpoints
    +
    DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    @@ -23658,53 +24146,29 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Service

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    +

    PathParameter

    +

    path

    +

    path to the resource

    +

    true

    string

    - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -23726,9 +24190,9 @@ -

    200

    +

    default

    success

    -

    json.WatchEvent

    +

    string

    @@ -23749,7 +24213,7 @@
    • -

      application/json

      +

      /

    @@ -23766,10 +24230,10 @@
    -

    watch individual changes to a list of Event

    +

    proxy POST requests to Service

    -
    GET /api/v1/watch/events
    +
    POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    @@ -23795,53 +24259,29 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Service

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    +

    PathParameter

    +

    path

    +

    path to the resource

    +

    true

    string

    - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -23863,9 +24303,9 @@ -

    200

    +

    default

    success

    -

    json.WatchEvent

    +

    string

    @@ -23886,7 +24326,7 @@
    • -

      application/json

      +

      /

    @@ -23903,10 +24343,10 @@
    -

    watch individual changes to a list of LimitRange

    +

    proxy GET requests to Node

    -
    GET /api/v1/watch/limitranges
    +
    GET /api/v1/proxy/nodes/{name}
    @@ -23932,53 +24372,13 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Node

    +

    true

    string

    - -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -24000,9 +24400,9 @@ -

    200

    +

    default

    success

    -

    json.WatchEvent

    +

    string

    @@ -24023,7 +24423,7 @@
    • -

      application/json

      +

      /

    @@ -24040,10 +24440,10 @@
    -

    watch individual changes to a list of Namespace

    +

    proxy PUT requests to Node

    -
    GET /api/v1/watch/namespaces
    +
    PUT /api/v1/proxy/nodes/{name}
    @@ -24069,53 +24469,13 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Node

    +

    true

    string

    - -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -24137,9 +24497,9 @@ -

    200

    +

    default

    success

    -

    json.WatchEvent

    +

    string

    @@ -24160,7 +24520,7 @@
    • -

      application/json

      +

      /

    @@ -24177,10 +24537,10 @@
    -

    watch individual changes to a list of ConfigMap

    +

    proxy DELETE requests to Node

    -
    GET /api/v1/watch/namespaces/{namespace}/configmaps
    +
    DELETE /api/v1/proxy/nodes/{name}
    @@ -24206,57 +24566,9 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

    +

    name

    +

    name of the Node

    true

    string

    @@ -24282,9 +24594,9 @@ -

    200

    +

    default

    success

    -

    json.WatchEvent

    +

    string

    @@ -24305,7 +24617,7 @@
    • -

      application/json

      +

      /

    @@ -24322,10 +24634,10 @@
    -

    watch changes to an object of kind ConfigMap

    +

    proxy POST requests to Node

    -
    GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
    +
    POST /api/v1/proxy/nodes/{name}
    @@ -24351,65 +24663,9 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

    +

    name of the Node

    true

    string

    @@ -24435,9 +24691,9 @@ -

    200

    +

    default

    success

    -

    json.WatchEvent

    +

    string

    @@ -24458,7 +24714,7 @@
    • -

      application/json

      +

      /

    @@ -24475,10 +24731,10 @@
    -

    watch individual changes to a list of Endpoints

    +

    proxy GET requests to Node

    -
    GET /api/v1/watch/namespaces/{namespace}/endpoints
    +
    GET /api/v1/proxy/nodes/{name}/{path}
    @@ -24504,57 +24760,17 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Node

    +

    true

    string

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

    +

    path

    +

    path to the resource

    true

    string

    @@ -24580,9 +24796,9 @@ -

    200

    +

    default

    success

    -

    json.WatchEvent

    +

    string

    @@ -24603,7 +24819,7 @@
    • -

      application/json

      +

      /

    @@ -24620,10 +24836,10 @@
    -

    watch changes to an object of kind Endpoints

    +

    proxy PUT requests to Node

    -
    GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
    +
    PUT /api/v1/proxy/nodes/{name}/{path}
    @@ -24649,65 +24865,17 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

    +

    name

    +

    name of the Node

    true

    string

    PathParameter

    -

    name

    -

    name of the Endpoints

    +

    path

    +

    path to the resource

    true

    string

    @@ -24733,9 +24901,9 @@ -

    200

    +

    default

    success

    -

    json.WatchEvent

    +

    string

    @@ -24756,7 +24924,7 @@
    • -

      application/json

      +

      /

    @@ -24773,10 +24941,10 @@
    -

    watch individual changes to a list of Event

    +

    proxy DELETE requests to Node

    -
    GET /api/v1/watch/namespaces/{namespace}/events
    +
    DELETE /api/v1/proxy/nodes/{name}/{path}
    @@ -24802,57 +24970,17 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Node

    +

    true

    string

    -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

    +

    path

    +

    path to the resource

    true

    string

    @@ -24878,9 +25006,9 @@ -

    200

    +

    default

    success

    -

    json.WatchEvent

    +

    string

    @@ -24901,7 +25029,7 @@
    • -

      application/json

      +

      /

    @@ -24918,10 +25046,10 @@
    -

    watch changes to an object of kind Event

    +

    proxy POST requests to Node

    -
    GET /api/v1/watch/namespaces/{namespace}/events/{name}
    +
    POST /api/v1/proxy/nodes/{name}/{path}
    @@ -24947,65 +25075,17 @@ -

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

    When specified with a watch call, shows changes that occur after that particular version 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

    +

    name

    +

    name of the Node

    true

    string

    PathParameter

    -

    name

    -

    name of the Event

    +

    path

    +

    path to the resource

    true

    string

    @@ -25031,9 +25111,9 @@ -

    200

    +

    default

    success

    -

    json.WatchEvent

    +

    string

    @@ -25054,7 +25134,7 @@
    • -

      application/json

      +

      /

    @@ -25071,10 +25151,10 @@
    -

    watch individual changes to a list of LimitRange

    +

    list or watch objects of kind ReplicationController

    -
    GET /api/v1/watch/namespaces/{namespace}/limitranges
    +
    GET /api/v1/replicationcontrollers
    @@ -25147,14 +25227,6 @@

    integer (int32)

    - -

    PathParameter

    -

    namespace

    -

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

    -

    true

    -

    string

    - - @@ -25178,7 +25250,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1.ReplicationControllerList

    @@ -25201,6 +25273,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -25216,10 +25294,10 @@
    -

    watch changes to an object of kind LimitRange

    +

    list or watch objects of kind ResourceQuota

    -
    GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
    +
    GET /api/v1/resourcequotas
    @@ -25292,22 +25370,6 @@

    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

    - - @@ -25331,7 +25393,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1.ResourceQuotaList

    @@ -25354,6 +25416,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -25369,10 +25437,10 @@
    -

    watch individual changes to a list of PersistentVolumeClaim

    +

    list or watch objects of kind Secret

    -
    GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
    +
    GET /api/v1/secrets
    @@ -25445,14 +25513,6 @@

    integer (int32)

    - -

    PathParameter

    -

    namespace

    -

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

    -

    true

    -

    string

    - - @@ -25476,7 +25536,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1.SecretList

    @@ -25499,6 +25559,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -25514,10 +25580,10 @@
    -

    watch changes to an object of kind PersistentVolumeClaim

    +

    list or watch objects of kind ServiceAccount

    -
    GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
    +
    GET /api/v1/serviceaccounts
    @@ -25590,22 +25656,6 @@

    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

    - - @@ -25629,7 +25679,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1.ServiceAccountList

    @@ -25652,6 +25702,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -25667,10 +25723,10 @@
    -

    watch individual changes to a list of Pod

    +

    list or watch objects of kind Service

    -
    GET /api/v1/watch/namespaces/{namespace}/pods
    +
    GET /api/v1/services
    @@ -25743,14 +25799,6 @@

    integer (int32)

    - -

    PathParameter

    -

    namespace

    -

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

    -

    true

    -

    string

    - - @@ -25774,7 +25822,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1.ServiceList

    @@ -25797,6 +25845,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -25812,10 +25866,10 @@
    -

    watch changes to an object of kind Pod

    +

    watch individual changes to a list of ConfigMap

    -
    GET /api/v1/watch/namespaces/{namespace}/pods/{name}
    +
    GET /api/v1/watch/configmaps
    @@ -25888,22 +25942,6 @@

    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

    - - @@ -25927,7 +25965,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -25950,6 +25988,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -25965,10 +26012,10 @@
    -

    watch individual changes to a list of PodTemplate

    +

    watch individual changes to a list of Endpoints

    -
    GET /api/v1/watch/namespaces/{namespace}/podtemplates
    +
    GET /api/v1/watch/endpoints
    @@ -26041,14 +26088,6 @@

    integer (int32)

    - -

    PathParameter

    -

    namespace

    -

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

    -

    true

    -

    string

    - - @@ -26072,7 +26111,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -26095,6 +26134,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -26110,10 +26158,10 @@
    -

    watch changes to an object of kind PodTemplate

    +

    watch individual changes to a list of Event

    -
    GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
    +
    GET /api/v1/watch/events
    @@ -26186,22 +26234,6 @@

    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

    - - @@ -26225,7 +26257,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -26248,6 +26280,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -26263,10 +26304,10 @@
    -

    watch individual changes to a list of ReplicationController

    +

    watch individual changes to a list of LimitRange

    -
    GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
    +
    GET /api/v1/watch/limitranges
    @@ -26339,14 +26380,6 @@

    integer (int32)

    - -

    PathParameter

    -

    namespace

    -

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

    -

    true

    -

    string

    - - @@ -26370,7 +26403,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -26393,6 +26426,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -26408,10 +26450,10 @@
    -

    watch changes to an object of kind ReplicationController

    +

    watch individual changes to a list of Namespace

    -
    GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
    +
    GET /api/v1/watch/namespaces
    @@ -26484,22 +26526,6 @@

    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

    - - @@ -26523,7 +26549,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -26546,6 +26572,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -26561,10 +26596,10 @@
    -

    watch individual changes to a list of ResourceQuota

    +

    watch individual changes to a list of ConfigMap

    -
    GET /api/v1/watch/namespaces/{namespace}/resourcequotas
    +
    GET /api/v1/watch/namespaces/{namespace}/configmaps
    @@ -26668,7 +26703,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -26691,6 +26726,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -26706,10 +26750,10 @@
    -

    watch changes to an object of kind ResourceQuota

    +

    watch changes to an object of kind ConfigMap

    -
    GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
    +
    GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
    @@ -26793,7 +26837,7 @@

    PathParameter

    name

    -

    name of the ResourceQuota

    +

    name of the ConfigMap

    true

    string

    @@ -26821,7 +26865,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -26844,6 +26888,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -26859,10 +26912,10 @@
    -

    watch individual changes to a list of Secret

    +

    watch individual changes to a list of Endpoints

    -
    GET /api/v1/watch/namespaces/{namespace}/secrets
    +
    GET /api/v1/watch/namespaces/{namespace}/endpoints
    @@ -26966,7 +27019,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -26989,6 +27042,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -27004,10 +27066,10 @@
    -

    watch changes to an object of kind Secret

    +

    watch changes to an object of kind Endpoints

    -
    GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
    +
    GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
    @@ -27091,7 +27153,7 @@

    PathParameter

    name

    -

    name of the Secret

    +

    name of the Endpoints

    true

    string

    @@ -27119,7 +27181,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -27142,6 +27204,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -27157,10 +27228,10 @@
    -

    watch individual changes to a list of ServiceAccount

    +

    watch individual changes to a list of Event

    -
    GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
    +
    GET /api/v1/watch/namespaces/{namespace}/events
    @@ -27264,7 +27335,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -27287,6 +27358,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -27302,10 +27382,10 @@
    -

    watch changes to an object of kind ServiceAccount

    +

    watch changes to an object of kind Event

    -
    GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
    +
    GET /api/v1/watch/namespaces/{namespace}/events/{name}
    @@ -27389,7 +27469,7 @@

    PathParameter

    name

    -

    name of the ServiceAccount

    +

    name of the Event

    true

    string

    @@ -27417,7 +27497,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -27440,6 +27520,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -27455,10 +27544,10 @@
    -

    watch individual changes to a list of Service

    +

    watch individual changes to a list of LimitRange

    -
    GET /api/v1/watch/namespaces/{namespace}/services
    +
    GET /api/v1/watch/namespaces/{namespace}/limitranges
    @@ -27562,7 +27651,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -27585,6 +27674,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -27600,6 +27698,2534 @@
    +

    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

    @@ -27607,7 +30233,7 @@
    -

    Parameters

    +

    Parameters

    @@ -27697,7 +30323,7 @@
    -

    Responses

    +

    Responses

    @@ -27715,14 +30341,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -27732,17 +30358,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -27760,7 +30395,7 @@
    -

    Parameters

    +

    Parameters

    @@ -27842,7 +30477,7 @@
    -

    Responses

    +

    Responses

    @@ -27860,14 +30495,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -27877,17 +30512,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -27905,7 +30549,7 @@
    -

    Parameters

    +

    Parameters

    @@ -27979,7 +30623,7 @@
    -

    Responses

    +

    Responses

    @@ -27997,14 +30641,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -28014,17 +30658,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -28042,7 +30695,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28124,7 +30777,7 @@
    -

    Responses

    +

    Responses

    @@ -28142,14 +30795,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -28159,17 +30812,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -28187,7 +30849,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28261,7 +30923,7 @@
    -

    Responses

    +

    Responses

    @@ -28279,14 +30941,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -28296,17 +30958,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -28324,7 +30995,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28398,7 +31069,7 @@
    -

    Responses

    +

    Responses

    @@ -28416,14 +31087,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -28433,17 +31104,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -28461,7 +31141,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28543,7 +31223,7 @@
    -

    Responses

    +

    Responses

    @@ -28561,14 +31241,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -28578,17 +31258,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -28606,7 +31295,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28680,7 +31369,7 @@
    -

    Responses

    +

    Responses

    @@ -28698,14 +31387,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -28715,17 +31404,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -28743,7 +31441,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28817,7 +31515,7 @@
    -

    Responses

    +

    Responses

    @@ -28835,14 +31533,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -28852,17 +31550,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -28880,7 +31587,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28954,7 +31661,7 @@
    -

    Responses

    +

    Responses

    @@ -28972,14 +31679,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -28989,17 +31696,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -29017,7 +31733,7 @@
    -

    Parameters

    +

    Parameters

    @@ -29091,7 +31807,7 @@
    -

    Responses

    +

    Responses

    @@ -29109,14 +31825,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -29126,17 +31842,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -29154,7 +31879,7 @@
    -

    Parameters

    +

    Parameters

    @@ -29228,7 +31953,7 @@
    -

    Responses

    +

    Responses

    @@ -29246,14 +31971,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -29263,17 +31988,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -29291,7 +32025,7 @@
    -

    Parameters

    +

    Parameters

    @@ -29365,7 +32099,7 @@
    -

    Responses

    +

    Responses

    @@ -29383,14 +32117,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -29400,17 +32134,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -29428,7 +32171,7 @@
    -

    Parameters

    +

    Parameters

    @@ -29502,7 +32245,7 @@
    -

    Responses

    +

    Responses

    @@ -29520,14 +32263,14 @@ - +

    200

    success

    json.WatchEvent

    *versioned.Event
    -

    Consumes

    +

    Consumes

    • @@ -29537,17 +32280,26 @@
    -

    Produces

    +

    Produces

    • application/json

      • +
    • +

      application/json;stream=watch

      +
      • +
    • +

      application/vnd.kubernetes.protobuf

      +
      • +
    • +

      application/vnd.kubernetes.protobuf;stream=watch

      +
    -

    Tags

    +

    Tags

    • @@ -29562,8 +32314,8 @@
    - + \ No newline at end of file diff --git a/community.html b/community.html index 67fa2f3152..e6acc42b6f 100644 --- a/community.html +++ b/community.html @@ -70,6 +70,7 @@ title: Community +
    diff --git a/docs/admin/OWNERS b/docs/admin/OWNERS new file mode 100644 index 0000000000..498d076a5f --- /dev/null +++ b/docs/admin/OWNERS @@ -0,0 +1,4 @@ +assignees: +- derekwaynecarr +- mikedanese + diff --git a/docs/admin/accessing-the-api.md b/docs/admin/accessing-the-api.md index 27ee393ac3..6569ac93f8 100644 --- a/docs/admin/accessing-the-api.md +++ b/docs/admin/accessing-the-api.md @@ -1,72 +1,157 @@ --- +assignees: +- bgrant0607 +- erictune +- lavalamp + --- -This document describes what ports the Kubernetes apiserver -may serve on and how to reach them. The audience is -cluster administrators who want to customize their cluster -or understand the details. +This document describes how access to the Kubernetes API is controlled. -Most questions about accessing the cluster are covered -in [Accessing the cluster](/docs/user-guide/accessing-the-cluster). +## Overview + +Users [access the API](/docs/user-guide/accessing-the-cluster) using `kubectl`, +client libraries, or by making REST requests. Both human users and +[Kubernetes service accounts](/docs/user-guide/service-accounts/) can be +authorized for API access. +When a request reaches the API, it goes through several stages, illustrated in the +following diagram: + +![Diagram of request handling steps for Kubernetes API request](/images/docs/admin/access-control-overview.svg) + +## Transport Security + +In a typical Kubernetes cluster, the API served on port 443. A TLS connection is +established. The API server presents a certificate. This certificate is +often self-signed, so `$USER/.kube/config` on the user's machine typically +contains the root certficate for the API server's certificate, which when specified +is used in place of the system default root certificates. This certificate is typically +automatically written into your `$USER/.kube/config` when you create a cluster yourself +using `kube-up.sh`. If the cluster has multiple users, then the creator needs to share +the certificate with other users. + +## Authentication + +Once TLS is established, the HTTP request moves to the Authentication step. +This is shown as step **1** in the diagram. +The cluster creation script or cluster admin configures the API server to run +one or more Authenticator Modules. +Authenticators are described in more detail [here](/docs/admin/authentication/). + +The input to the authentication step is the entire HTTP request, however, it typically +just examines the headers and/or client certificate. + +Authentication modules include Client Certificates, Password, and Plain Tokens, +and JWT Tokens (used for service accounts). + +Multiple authentication modules can be specified, in which case each one is tried in sequence, +until one of them succeeds. + +On GCE, Client Certificates, Password, Plain Tokens, and JWT Tokens are all enabled. + +If the request cannot be authenticated, it is rejected with HTTP status code 401. +Otherwise, the user is authenticated as a specific `username`, and the user name +is available to subsequent steps to use in their decisions. Some authenticators +may also provide the group memberships of the user, while other authenticators +do not (and expect the authorizer to determine these). + +While Kubernetes uses "usernames" for access control decisions and in request logging, +it does not have a `user` object nor does it store usernames or other information about +users in its object store. + +## Authorization + +Once the request is authenticated as coming from a specific user, +it moves to a generic authorization step. This is shown as step **2** in the +diagram. + +The input to the Authorization step are attributes of the REST request, including: + - the username determined by the Authentication step. + - a `verb` associated with the API request. Most object support these common operations: `list, watch, create, update, patch, delete`. Some objects have "special verbs"; for example pods and services can be `proxy`-ed. + - any subresource associated with the API request (e.g. `status`). + - the Group, Version, and Kind of the API resource (e.g. `v1 pod`, or `batch/v1 job`) being + operated on. + - the name and namespace of the object. + +There are multiple supported Authorization Modules. The cluster creator configures the API +server with which Authorization Modules should be used. When multiple Authorization Modules +are configured, each is checked in sequence, and if any Module authorizes the request, +then the request can proceed. If all deny the request, then the request is denied (HTTP status +code 403). + +The [Authorization Modules](/docs/admin/authorization) page describes what authorization modules +are available and how to configure them. + +For version 1.2, clusters created by `kube-up.sh` are configured so that no authorization is +required for any request. + +As of version 1.3, clusters created by `kube-up.sh` are configured so that the ABAC authorization +modules is enabled. However, its input file is initially set to allow all users to do all +operations. The cluster administrator needs to edit that file, or configure a different authorizer +to restrict what users can do. -## Ports and IPs Served On +The Authorization step is designed to operate on attributes that are likely to be common to most +REST requests, such as object name, kind, etc. This is intended to facilitate interation with +existing organization-wide or cloud-provider-wide access control systems (which may handle +other APIs besides the Kubernetes API. -The Kubernetes API is served by the Kubernetes apiserver process. Typically, -there is one of these running on a single kubernetes-master node. +Access controls and policies that depend on specific fields of specific Kinds of objects +are handled by Admission Controllers. + +## Admission Control + +Admission Control Modules are software modules that can modify or reject requests. +In addition to the attributes available to Authorization Modules, Admission +Control Modules can access the contents of the object that is being created or updated. +They act on objects being created, deleted, updated or connected (proxy), but not reads. + +Multiple admission controllers can be configured. Each is called in order. + +This is shown as step **3** in the diagram. + +Unlike Authentication and Authorization Modules, if any admission controller module +rejects, then the request is immediately rejected. + +In addition to rejecting objects, admission controllers can also set complex defaults for +fields. + +The available Admission Control Modules are described [here](/docs/admin/admission-controllers/). + +Once a request passes all admission controllers, it is validated using the validation routines +for the corresponding API object, and then written to the object store (shown as step **4**). + + +## API Server Ports and IPs + +The previous discussion applies to requests sent to the secure port of the API server +(the typical case). The API server can actually serve on 2 ports: By default the Kubernetes APIserver serves HTTP on 2 ports: 1. `Localhost Port`: - - serves HTTP + - is intended for testing and bootstrap, and for other components of the master node + (scheduler, controller-manager) to talk to the API + - no TLS - default is port 8080, change with `--insecure-port` flag. - defaults IP is localhost, change with `--insecure-bind-address` flag. - - no authentication or authorization checks in HTTP + - request **bypasses** authentication and authorization modules. + - request handled by admission control module(s). - protected by need to have host access + 2. `Secure Port`: - + + - use whenever possible + - uses TLS. Set cert with `--tls-cert-file` and key with `--tls-private-key-file` flag. - default is port 6443, change with `--secure-port` flag. - default IP is first non-localhost network interface, change with `--bind-address` flag. - - serves HTTPS. Set cert with `--tls-cert-file` and key with `--tls-private-key-file` flag. - - uses token-file or client-certificate based [authentication](/docs/admin/authentication). - - uses policy-based [authorization](/docs/admin/authorization). - 3. Removed: `ReadOnly Port` - - - For security reasons, this had to be removed. Use the [service account](/docs/user-guide/service-accounts) feature instead. + - request handled by authentication and authorization modules. + - request handled by admission control module(s). + - authentication and authoriation modules run. -## Proxies and Firewall rules +When the cluster is created by `kube-up.sh`, on Google Compute Engine (GCE), +and on several other cloud providers, the API server serves on port 443. On +GCE, a firewall rule is configured on the project to allow external HTTPS +access to the API. Other cluster setup methods vary. -Additionally, in some configurations there is a proxy (nginx) running -on the same machine as the apiserver process. The proxy serves HTTPS protected -by Basic Auth on port 443, and proxies to the apiserver on localhost:8080. In -these configurations the secure port is typically set to 6443. - -A firewall rule is typically configured to allow external HTTPS access to port -443. - -The above are defaults and reflect how Kubernetes is deployed to Google Compute -Engine using `kube-up.sh.` Other cloud providers may vary. - -## Use Cases vs IP:Ports - -There are differently configured serving ports to serve a variety of uses cases: - - 1. Clients outside of a Kubernetes cluster, such as human running `kubectl` -on a desktop machine. Currently, accesses the Localhost Port via a proxy (nginx) -running on the `kubernetes-master` machine. The proxy can use cert-based -authentication or token-based authentication. - 2. Processes running in Containers on Kubernetes that need to read from -the apiserver. Currently, these can use a [service account](/docs/user-guide/service-accounts). - 3. Scheduler and Controller-manager processes, which need to do read-write -API operations, using service accounts to avoid the need to be co-located. - 4. Kubelets, which need to do read-write API operations and are necessarily -on different machines than the apiserver. Kubelet uses the Secure Port -to get their pods, to find the services that a pod can see, and to -write events. Credentials are distributed to kubelets at cluster -setup time. Kubelet and kube-proxy can use cert-based authentication or -token-based authentication. - -## Expected changes - - - Policy will limit the actions kubelets can do via the authed port. diff --git a/docs/admin/admission-controllers.md b/docs/admin/admission-controllers.md index 59e998b83d..a99b44f339 100644 --- a/docs/admin/admission-controllers.md +++ b/docs/admin/admission-controllers.md @@ -1,4 +1,12 @@ --- +assignees: +- bprashanth +- davidopp +- derekwaynecarr +- erictune +- janetkuo +- thockin + --- * TOC @@ -145,5 +153,5 @@ For Kubernetes >= 1.2.0, we strongly recommend running the following set of admi For Kubernetes >= 1.0.0, we strongly recommend running the following set of admission control plug-ins (order matters): ```shell ---admission-control=NamespaceLifecycle,LimitRanger,SecurityContextDeny,ServiceAccount,ResourceQuota +--admission-control=NamespaceLifecycle,LimitRanger,SecurityContextDeny,ServiceAccount,PersistentVolumeLabel,ResourceQuota ``` diff --git a/docs/admin/authentication.md b/docs/admin/authentication.md index 52b5bf925d..b4f7d8c639 100644 --- a/docs/admin/authentication.md +++ b/docs/admin/authentication.md @@ -1,17 +1,69 @@ --- +assignees: +- erictune +- lavalamp +- ericchiang +- deads2k + --- -Kubernetes uses client certificates, tokens, or http basic auth to authenticate users for API calls. -**Client certificate authentication** is enabled by passing the `--client-ca-file=SOMEFILE` -option to apiserver. The referenced file must contain one or more certificates authorities -to use to validate client certificates presented to the apiserver. If a client certificate +## Users in Kubernetes + +All Kubernetes clusters have two categories of users: service accounts managed +by Kubernetes, and normal users. + +Normal users are assumed to be managed by an outside, independent service. An +admin distributing private keys, a user store like Keystone or Google Accounts, +even a file with a list of usernames and passwords. In this regard, _Kubernetes +does not have objects which represent normal user accounts._ Regular users +cannot be added to a cluster through an API call. + +In contrast, service accounts are users managed by the Kubernetes API. They are +bound to specific namespaces, and created automatically by the API server or +manually through API calls. Service accounts are tied to a set of credentials +stored as `Secrets`, which are mounted into pods allowing in cluster processes +to talk to the Kubernetes API. + +All API requests are tied to either a normal user or a service account. This +means every process inside or outside the cluster, from a human user typing +`kubectl` on a workstation, to `kubelets` on nodes, to members of the control +plane, must authenticate when making requests to the the API server. + +## Authentication strategies + +Kubernetes uses client certificates, bearer tokens, or HTTP basic auth to +authenticate API requests through authentication plugins. As HTTP request are +made to the API server plugins attempts to associate the following attributes +with the request: + +* Username: a string which identifies the end user. Common values might be `kube-admin` or `jane@example.com`. +* UID: a string which identifies the end user and attempts to be more consistent and unique than username. +* Groups: a set of strings which associate users with as set of commonly grouped users. +* Extra fields: a map of strings to list of strings which holds additional information authorizers may find useful. + +All values are opaque to the authentication system and only hold significance +when interpreted by an [authorizer](/docs/admin/authorization/). + +Multiple authentication methods may be enabled at once. In these cases, the first +authenticator to successfully authenticate the request short-circuits evaluation. +The API server does not guarantee the order authenticators run in. + +### X509 Client Certs + +Client certificate authentication is enabled by passing the `--client-ca-file=SOMEFILE` +option to API server. The referenced file must contain one or more certificates authorities +to use to validate client certificates presented to the API server. If a client certificate is presented and verified, the common name of the subject is used as the user name for the request. -**Token File** is enabled by passing the `--token-auth-file=SOMEFILE` option -to apiserver. Currently, tokens last indefinitely, and the token list cannot -be changed without restarting apiserver. +See [APPENDIX](#appendix) for how to generate a client cert. + +### Static Token File + +Token file is enabled by passing the `--token-auth-file=SOMEFILE` option to the +API server. Currently, tokens last indefinitely, and the token list cannot be +changed without restarting API server. The token file format is implemented in `plugin/pkg/auth/authenticator/token/tokenfile/...` and is a csv file with a minimum of 3 columns: token, user name, user uid, followed by @@ -21,53 +73,261 @@ optional group names. Note, if you have more than one group the column must be d token,user,uid,"group1,group2,group3" ``` -When using token authentication from an http client the apiserver expects an `Authorization` +When using token authentication from an http client the API server expects an `Authorization` header with a value of `Bearer SOMETOKEN`. -**OpenID Connect ID Token** is enabled by passing the following options to the apiserver: +### Static Password File -- `--oidc-issuer-url` (required) tells the apiserver where to connect to the OpenID provider. Only HTTPS scheme will be accepted. -- `--oidc-client-id` (required) is used by apiserver to verify the audience of the token. -A valid [ID token](http://openid.net/specs/openid-connect-core-1_0.html#IDToken) MUST have this -client-id in its `aud` claims. -- `--oidc-ca-file` (optional) is used by apiserver to establish and verify the secure connection -to the OpenID provider. -- `--oidc-username-claim` (optional, experimental) specifies which OpenID claim to use as the user name. By default, `sub` -will be used, which should be unique and immutable under the issuer's domain. Cluster administrator can -choose other claims such as `email` to use as the user name, but the uniqueness and immutability is not guaranteed. -- `--oidc-groups-claim` (optional, experimental) the name of a custom OpenID Connect claim for specifying user groups. The claim -value is expected to be an array of strings. - -Please note that this flag is still experimental until we settle more on how to handle the mapping of the OpenID user to the Kubernetes user. Thus further changes are possible. - -Currently, the ID token will be obtained by some third-party app. This means the app and apiserver -MUST share the `--oidc-client-id`. - -Like **Token File**, when using token authentication from an http client the apiserver expects -an `Authorization` header with a value of `Bearer SOMETOKEN`. - -**Basic authentication** is enabled by passing the `--basic-auth-file=SOMEFILE` -option to apiserver. Currently, the basic auth credentials last indefinitely, -and the password cannot be changed without restarting apiserver. Note that basic +Basic authentication is enabled by passing the `--basic-auth-file=SOMEFILE` +option to API server. Currently, the basic auth credentials last indefinitely, +and the password cannot be changed without restarting API server. Note that basic authentication is currently supported for convenience while we finish making the more secure modes described above easier to use. The basic auth file format is implemented in `plugin/pkg/auth/authenticator/password/passwordfile/...` and is a csv file with 3 columns: password, user name, user id. -When using basic authentication from an http client, the apiserver expects an `Authorization` header +```conf +password,user,uid +``` + +When using basic authentication from an http client, the API server expects an `Authorization` header with a value of `Basic BASE64ENCODED(USER:PASSWORD)`. -**Keystone authentication** is enabled by passing the `--experimental-keystone-url=` -option to the apiserver during startup. The plugin is implemented in -`plugin/pkg/auth/authenticator/password/keystone/keystone.go`. +### Service Account Tokens + +Service accounts are an automatically enabled authenticator that uses signed +bearer tokens to verify requests. The plugin takes two optional flags: + +* `--service-account-key-file` A file containing a PEM encoded key for signing bearer tokens. +If unspecified, the API server's TLS private key will be used. +* `--service-account-lookup` If enabled, tokens which are deleted from the API will be revoked. + +Service accounts are usually created automatically by the API server and +associated with pods running in the cluster through the `ServiceAccount` +[Admission Controller](/docs/admin/admission-controllers/). Bearer tokens are +mounted into pods at well known locations, and allow in cluster processes to +talk to the API server. Accounts may be explicitly associated with pods using the +`serviceAccountName` field of a `PodSpec`. + +NOTE: `serviceAccountName` is usually omitted because this is done automatically. + +``` +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: nginx-deployment + namespace: default +spec: + replicas: 3 + template: + metadata: + # ... + spec: + containers: + - name: nginx + image: nginx:1.7.9 + serviceAccountName: bob-the-bot +``` + +Service account bearer tokens are perfectly valid to use outside the cluster and +can be used to create identities for long standing jobs that wish to talk to the +Kubernetes API. To manually create a service account, simply use the `kubectl +create serviceaccount (NAME)` command. This creates a service account in the +current namespace and an associated secret. + +``` +$ kubectl create serviceaccount jenkins +serviceaccount "jenkins" created +$ kubectl get serviceaccounts jenkins -o yaml +apiVersion: v1 +kind: ServiceAccount +metadata: + # ... +secrets: +- name: jenkins-token-1yvwg +``` + +The created secret holds the public CA of the API server and a signed JSON Web +Token (JWT). + +``` +$ kubectl get secret jenkins-token-1yvwg -o yaml +apiVersion: v1 +data: + ca.crt: (APISERVER'S CA BASE64 ENCODED) + token: (BEARER TOKEN BASE64 ENCODED) +kind: Secret +metadata: + # ... +type: kubernetes.io/service-account-token +``` + +Note: values are base64 encoded because secrets are always base64 encoded. + +The signed JWT can be used as a bearer token to authenticate as the given service +account. Normally these secrets are mounted into pods for in-cluster access to +the API server, but can be used from outside the cluster as well. + +Service accounts authenticate with the username `system:serviceaccount:(NAMESPACE):(SERVICEACCOUNT)`, +and are assigned to the groups `system:serviceaccounts` and `system:serviceaccounts:(NAMESPACE)`. + +WARNING: Because service account tokens are stored in secrets, any user with +read access to those secrets can authenticate as the service account. Be cautious +when granting permissions to service accounts and read capabilities for secrets. + +### OpenID Connect Tokens + +[OpenID Connect](https://openid.net/connect/) is a flavor of OAuth2 supported by +some OAuth2 providers, notably Azure Active Directory, Salesforce, and Google. +The protocol's main extension of OAuth2 is an additional field returned with +the access token called an [ID Token](https://openid.net/specs/openid-connect-core-1_0.html#IDToken). +This token is a JSON Web Token (JWT) with well known fields, such as a user's +email, signed by the server. When used as a bearer token, the API server can +verify ID token's signature and determine the end users identity. + +To enable the plugin, pass the following required flags: + +* `--oidc-issuer-url` URL of the provider which allows the API server to discover +public signing keys. Only URLs which use the `https://` scheme are accepted. +* `--oidc-client-id` A client id that all tokens must be issued for. + +Importantly, the API server is not an OAuth2 client, rather it can only be +configured to trust a single client. This allows the use of public providers, +such as Google, without trusting credentials issued to third parties. Admins who +wish utilize multiple OAuth clients should explore providers which support the +`azp` (authorized party) claim, a mechanism for allowing one client to issue +tokens on behalf of another. + +The plugin also accepts the following optional flags: + +* `--oidc-ca-file` Used by the API server to establish and verify the secure +connection to the issuer. Defaults to the host's root CAs. + +And experimental flags: + +* `--oidc-username-claim` JWT claim to use as the user name. By default `sub`, +which is expected to be a unique identifier of the end user. Admins can choose +other claims, such as `email`, depending on their provider. +* `--oidc-groups-claim` JWT claim to use as the user's group. If the claim is present +it must be an array of strings. + +### Webhook Token Authentication + +Webhook authentication is a hook for verifying bearer tokens. + +* `--authentication-token-webhook-config-file` a kubeconfig file describing how to access the remote webhook service. +* `--authentication-token-webhook-cache-ttl` how long to cache authentication decisions. Defaults to two minutes. + +The configuration file uses the [kubeconfig](/docs/user-guide/kubeconfig-file/) +file format. Within the file "users" refers to the API server webhook and +"clusters" refers to the remote service. An example would be: + +```yaml +# clusters refers to the remote service. +clusters: + - name: name-of-remote-authn-service + cluster: + certificate-authority: /path/to/ca.pem # CA for verifying the remote service. + server: https://authn.example.com/authenticate # URL of remote service to query. Must use 'https'. + +# users refers to the API server's webhook configuration. +users: + - name: name-of-api-server + user: + client-certificate: /path/to/cert.pem # cert for the webhook plugin to use + client-key: /path/to/key.pem # key matching the cert + +# kubeconfig files require a context. Provide one for the API server. +current-context: webhook +contexts: +- context: + cluster: name-of-remote-authn-service + user: name-of-api-sever + name: webhook +``` + +When a client attempts to authenticate with the API server using a bearer token, +using the `Authorization: Bearer (TOKEN)` HTTP header the authentication webhook +queries the remote service with a review object containing the token. Kubernetes +will not challenge request that lack such a header. + +Note that webhook API objects are subject to the same [versioning compatibility rules](/docs/api/) +as other Kubernetes API objects. Implementers should be aware of looser +compatibility promises for beta objects and check the "apiVersion" field of the +request to ensure correct deserialization. Additionally, the API server must +enable the `authentication.k8s.io/v1beta1` API extensions group (`--runtime-config=authentication.k8s.io/v1beta1=true`). + +The request body will be of the following format: + +```json +{ + "apiVersion": "authentication.k8s.io/v1beta1", + "kind": "TokenReview", + "spec": { + "token": "(BEARERTOKEN)" + } +} +``` + +The remote service is expected to fill the `TokenAccessReviewStatus` field of +the request to indicate the success of the login. The response body's "spec" +field is ignored and may be omitted. A successful validation of the bearer +token would return: + +```json +{ + "apiVersion": "authentication.k8s.io/v1beta1", + "kind": "TokenReview", + "status": { + "authenticated": true, + "user": { + "username": "janedoe@example.com", + "uid": "42", + "groups": [ + "developers", + "qa" + ], + "extra": { + "extrafield1": [ + "extravalue1", + "extravalue2" + ] + } + } + } +} +``` + +An unsuccessful request would return: + +```json +{ + "apiVersion": "authentication.k8s.io/v1beta1", + "kind": "TokenReview", + "status": { + "authenticated": false + } +} +``` + +HTTP status codes can be used to supply additional error context. + +### Keystone Password + +Keystone authentication is enabled by passing the `--experimental-keystone-url=` +option to the API server during startup. The plugin is implemented in +`plugin/pkg/auth/authenticator/password/keystone/keystone.go` and currently uses +basic auth to verify used by username and password. For details on how to use keystone to manage projects and users, refer to the -[Keystone documentation](http://docs.openstack.org/developer/keystone/). Please note that -this plugin is still experimental which means it is subject to changes. +[Keystone documentation](http://docs.openstack.org/developer/keystone/). Please +note that this plugin is still experimental, under active development, and likely +to change in subsequent releases. -Please refer to the [discussion](https://github.com/kubernetes/kubernetes/pull/11798#issuecomment-129655212) -and the [blueprint](https://github.com/kubernetes/kubernetes/issues/11626) for more details. +Please refer to the [discussion](https://github.com/kubernetes/kubernetes/pull/11798#issuecomment-129655212), +[blueprint](https://github.com/kubernetes/kubernetes/issues/11626) and [proposed +changes](https://github.com/kubernetes/kubernetes/pull/25536) for more details. ## Plugin Development @@ -86,15 +346,15 @@ using an existing deployment script or manually through `easyrsa` or `openssl.`` #### Using an Existing Deployment Script -**Using an existing deployment script** is implemented at +**Using an existing deployment script** is implemented at `cluster/saltbase/salt/generate-cert/make-ca-cert.sh`. Execute this script with two parameters. The first is the IP address -of apiserver. The second is a list of subject alternate names in the form `IP: or DNS:`. +of API server. The second is a list of subject alternate names in the form `IP: or DNS:`. The script will generate three files: `ca.crt`, `server.crt`, and `server.key`. -Finally, add the following parameters into apiserver start parameters: +Finally, add the following parameters into API server start parameters: - `--client-ca-file=/srv/kubernetes/ca.crt` - `--tls-cert-file=/srv/kubernetes/server.cert` @@ -118,13 +378,13 @@ Finally, add the following parameters into apiserver start parameters: ./easyrsa --subject-alt-name="IP:${MASTER_IP}" build-server-full kubernetes-master nopass 1. Copy `pki/ca.crt`, `pki/issued/kubernetes-master.crt`, and `pki/private/kubernetes-master.key` to your directory. -1. Fill in and add the following parameters into the apiserver start parameters: +1. Fill in and add the following parameters into the API server start parameters: --client-ca-file=/yourdirectory/ca.crt --tls-cert-file=/yourdirectory/server.cert --tls-private-key-file=/yourdirectory/server.key -#### openssl +#### openssl **openssl** can also be use to manually generate certificates for your cluster. @@ -147,4 +407,4 @@ Finally, add the following parameters into apiserver start parameters: openssl x509 -noout -text -in ./server.crt -Finally, do not forget to fill out and add the same parameters into the apiserver start parameters. +Finally, do not forget to fill out and add the same parameters into the API server start parameters. diff --git a/docs/admin/authorization.md b/docs/admin/authorization.md index 3b521b5df1..b1efc1202c 100644 --- a/docs/admin/authorization.md +++ b/docs/admin/authorization.md @@ -1,9 +1,13 @@ --- +assignees: +- erictune +- lavalamp + --- In Kubernetes, authorization happens as a separate step from authentication. -See the [authentication documentation](/docs/admin/authentication) for an -overview of authentication. +See the [Accessing Control Overview](/docs/admin/accessing-the-api/) for an +overview of how authentication and authorization are applied to requests. Authorization applies to all HTTP accesses on the main (secure) apiserver port. @@ -16,36 +20,53 @@ The following implementations are available, and are selected by flag: - `--authorization-mode=AlwaysDeny` blocks all requests (used in tests). - `--authorization-mode=AlwaysAllow` allows all requests; use if you don't need authorization. - - `--authorization-mode=ABAC`allows for user-configured authorization policy. -ABAC stands for - Attribute-Based Access Control. + - `--authorization-mode=ABAC` allows for a simple local-file-based user-configured +authorization policy. ABAC stands for Attribute-Based Access Control. +authorization policy. + - `--authorization-mode=RBAC` is an experimental implementation which allows +for authorization to be driven by the Kubernetes API. +RBAC stands for Roles-Based Access Control. - `--authorization-mode=Webhook` allows for authorization to be driven by a remote service using REST. -## ABAC Mode +If multiple modes are provided the set is unioned, and only a single authorizer is required to admit the action. This means the flag: -### Request Attributes +``` +--authorization-mode=AlwaysDeny,AlwaysAllow +``` + +will always allow. + +## Request Attributes A request has the following attributes that can be considered for authorization: - user (the user-string which a user was authenticated as). - group (the list of group names the authenticated user is a member of). + - "extra" (a map of arbitrary string keys to string values, provided by the authentication layer) - whether the request is for an API resource. - the request path. - - allows authorizing access to miscellaneous endpoints like `/api` or -`/healthz` (see [kubectl](#kubectl)). + - allows authorizing access to miscellaneous non-resource endpoints like `/api` or `/healthz` (see [kubectl](#kubectl)). - the request verb. - - API verbs like `get`, `list`, `create`, `update`, `watch`, `delete`, and -`deletecollection` are used for API requests - - HTTP verbs like `get`, `post`, `put`, and `delete` are used for non-API -requests - - what resource is being accessed (for API requests only) - - the namespace of the object being accessed (for namespaced API requests -only) - - the API group being accessed (for API requests only) + - API verbs `get`, `list`, `create`, `update`, `patch`, `watch`, `proxy`, `redirect`, `delete`, and `deletecollection` are used for resource requests + - HTTP verbs `get`, `post`, `put`, and `delete` are used for non-resource requests + - what resource is being accessed (for resource requests only) + - what subresource is being accessed (for resource requests only) + - the namespace of the object being accessed (for namespaced resource requests only) + - the API group being accessed (for resource requests only) -We anticipate adding more attributes to allow finer grained access control and -to assist in policy management. +The request verb for a resource API endpoint can be determined by the HTTP verb used and whether or not the request acts on an individual resource or a collection of resources: + +HTTP verb | request verb +----------|--------------- +POST | create +GET, HEAD | get (for individual resources), list (for collections) +PUT | update +PATCH | patch +DELETE | delete (for individual resources), deletecollection (for collections) + + +## ABAC Mode ### Policy File Format @@ -86,17 +107,17 @@ A request has attributes which correspond to the properties of a policy object. When a request is received, the attributes are determined. Unknown attributes are set to the zero value of its type (e.g. empty string, 0, false). -A property set to "*" will match any value of the corresponding attribute. +A property set to `"*"` will match any value of the corresponding attribute. The tuple of attributes is checked for a match against every policy in the policy file. If at least one line matches the request attributes, then the request is authorized (but may fail later validation). To permit any user to do something, write a policy with the user property set to -"*". +`"*"`. To permit a user to do anything, write a policy with the apiGroup, namespace, -resource, and nonResourcePath properties set to "*". +resource, and nonResourcePath properties set to `"*"`. ### Kubectl @@ -119,11 +140,31 @@ up the verbosity: ### Examples - 1. Alice can do anything to all resources: `{"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "alice", "namespace": "*", "resource": "*", "apiGroup": "*"}}` - 2. Kubelet can read any pods: `{"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "kubelet", "namespace": "*", "resource": "pods", "readonly": true}}` - 3. Kubelet can read and write events: `{"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "kubelet", "namespace": "*", "resource": "events"}}` - 4. Bob can just read pods in namespace "projectCaribou": `{"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "bob", "namespace": "projectCaribou", "resource": "pods", "readonly": true}}` - 5. Anyone can make read-only requests to all non-API paths: `{"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "*", "readonly": true, "nonResourcePath": "*"}}` + 1. Alice can do anything to all resources: + + ```json + {"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "alice", "namespace": "*", "resource": "*", "apiGroup": "*"}} + ``` + 2. Kubelet can read any pods: + + ```json + {"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "kubelet", "namespace": "*", "resource": "pods", "readonly": true}} + ``` + 3. Kubelet can read and write events: + + ```json + {"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "kubelet", "namespace": "*", "resource": "events"}} + ``` + 4. Bob can just read pods in namespace "projectCaribou": + + ```json + {"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "bob", "namespace": "projectCaribou", "resource": "pods", "readonly": true}} + ``` + 5. Anyone can make read-only requests to all non-resource paths: + + ```json + {"apiVersion": "abac.authorization.kubernetes.io/v1beta1", "kind": "Policy", "spec": {"user": "*", "readonly": true, "nonResourcePath": "*"}} + ``` [Complete file example](http://releases.k8s.io/{{page.githubbranch}}/pkg/auth/authorizer/abac/example_policy_file.jsonl) @@ -136,7 +177,7 @@ according to the naming convention: system:serviceaccount:: ``` Creating a new namespace also causes a new service account to be created, of -this form:* +this form: ```shell system:serviceaccount::default @@ -147,11 +188,164 @@ kube-system full privilege to the API, you would add this line to your policy file: ```json -{"apiVersion":"abac.authorization.kubernetes.io/v1beta1","kind":"Policy","user":"system:serviceaccount:kube-system:default","namespace":"*","resource":"*","apiGroup":"*"} +{"apiVersion":"abac.authorization.kubernetes.io/v1beta1","kind":"Policy","spec":{"user":"system:serviceaccount:kube-system:default","namespace":"*","resource":"*","apiGroup":"*"}} ``` The apiserver will need to be restarted to pickup the new policy lines. +## RBAC Mode + +When specified "RBAC" (Role-Based Access Control) uses the +"rbac.authorization.k8s.io" API group to drive authorization decisions, +allowing admins to dynamically configure permission policies through the +Kubernetes API. + +As of 1.3 RBAC mode is in alpha and considered experimental. + +To use RBAC, you must both enable the authorization module with `--authorization-mode=RBAC`, +and [enable the API version]( +docs/admin/cluster-management.md/#Turn-on-or-off-an-api-version-for-your-cluster), +with a `--runtime-config=` that includes `rbac.authorization.k8s.io/v1alpha1`. + +### Roles, RolesBindings, ClusterRoles, and ClusterRoleBindings + +The RBAC API Group declares four top level types which will be covered in this +section. Users can interact with these resources as they would with any other +API resource. Through `kubectl`, direct calls to the API, etc. For instance, +`kubectl create -f (resource).yml` can be used with any of these examples, +though readers who wish to follow along should review the following section on +bootstrapping first. + +In the RBAC API Group, roles hold a logical grouping of permissions. These +permissions map very closely to ABAC policies, but only contain information +about requests being made. Permission are purely additive, rules may only omit +permissions they do not wish to grant. + +Here's an example of a role which grants read access to pods within the +"default" namespace. + +```yaml +kind: Role +apiVersion: rbac.authorization.k8s.io/v1alpha1 +metadata: + namespace: default + name: pod-reader +rules: + - apiGroups: [""] # The API group "" indicates the default API Group. + resources: ["pods"] + verbs: ["get", "watch", "list"] + nonResourceURLs: [] +``` + +`ClusterRoles` hold the same information as a `Role` but can apply to any +namespace as well as non-namespaced resources (such as `Nodes`, +`PersistentVolume`, etc.). The following `ClusterRole` can grant permissions to +read secrets in any namespace. + +```yaml +kind: ClusterRole +apiVersion: rbac.authorization.k8s.io/v1alpha1 +metadata: + # "namespace" omitted since ClusterRoles are not namespaced. + name: secret-reader +rules: + - apiGroups: [""] + resources: ["secrets"] + verbs: ["get", "watch", "list"] + nonResourceURLs: [] +``` + +`RoleBindings` perform the task of granting the permission to a user or set of +users. They hold a list of subjects which they apply to, and a reference to the +`Role` being assigned. + +The following `RoleBinding` assigns the "pod-reader" role to the user "jane" +within the "default" namespace, and allows jane to read pods. + +```yaml +# This role binding allows "jane" to read pods in the namespace "default" +kind: RoleBinding +apiVersion: rbac.authorization.k8s.io/v1alpha1 +metadata: + name: read-pods + namespace: default +subjects: + - kind: User # May be "User", "Group" or "ServiceAccount" + name: jane +roleRef: + kind: Role + namespace: default + name: pod-reader + apiVersion: rbac.authorization.k8s.io/v1alpha1 +``` + +`RoleBindings` may also refer to a `ClusterRole`. However, a `RoleBinding` that +refers to a `ClusterRole` only applies in the `RoleBinding`'s namespace, not at +the cluster level. This allows admins to define a set of common roles for the +entire cluster, then reuse them in multiple namespaces. + +For instance, even though the following `RoleBinding` refers to a `ClusterRole`, +"dave" (the subject) will only be able read secrets in the "development" +namespace, the namespace of the `RoleBinding`. + +```yaml +# This role binding allows "dave" to read secrets in the namespace "development" +kind: RoleBinding +apiVersion: rbac.authorization.k8s.io/v1alpha1 +metadata: + name: read-secrets + namespace: development # This binding only applies in the "development" namespace +subjects: + - kind: User # May be "User", "Group" or "ServiceAccount" + name: dave +roleRef: + kind: ClusterRole + name: secret-reader + apiVersion: rbac.authorization.k8s.io/v1alpha1 +``` + +Finally a `ClusterRoleBinding` may be used to grant permissions in all +namespaces. The following `ClusterRoleBinding` allows any user in the group +"manager" to read secrets in any namepsace. + +```yaml +# This cluster role binding allows anyone in the "manager" group to read secrets in any namespace. +kind: ClusterRoleBinding +apiVersion: rbac.authorization.k8s.io/v1alpha1 +metadata: + name: read-secrets +subjects: + - kind: Group # May be "User", "Group" or "ServiceAccount" + name: manager +roleRef: + kind: ClusterRole + name: secret-reader + apiVersion: rbac.authorization.k8s.io/v1alpha1 +``` + +### Privilege Escalation Prevention and Bootstrapping + +The `rbac.authorization.k8s.io` API group inherently attempts to prevent users +from escalating privileges. Simply put, __a user can't grant permissions they +don't already have even when the RBAC authorizer it disabled__. If "user-1" +does not have the ability to read secrets in "namespace-a", they cannot create +a binding that would grant that permission to themselves or any other user. + +For bootstrapping the first roles, it becomes necessary for someone to get +around these limitations. For the alpha release of RBAC, an API Server flag was +added to allow one user to step around all RBAC authorization and privilege +escalation checks. NOTE: _This is subject to change with future releases._ + +``` +--authorization-rbac-super-user=admin +``` + +Once set the specified super user, in this case "admin", can be used to create +the roles and role bindings to initialize the system. + +This flag is optional and once the initial bootstrapping is performed can be +unset. + ## Webhook Mode When specified, mode `Webhook` causes Kubernetes to query an outside REST @@ -285,7 +479,7 @@ restricting access to the REST api. For further documentation refer to the authorization.v1beta1 API objects and plugin/pkg/auth/authorizer/webhook/webhook.go. -## Plugin Development +## Module Development Other implementations can be developed fairly easily. The APIserver calls the Authorizer interface: diff --git a/docs/admin/cluster-components.md b/docs/admin/cluster-components.md index 2e7e663f42..c1bcae8577 100644 --- a/docs/admin/cluster-components.md +++ b/docs/admin/cluster-components.md @@ -1,4 +1,7 @@ --- +assignees: +- lavalamp + --- This document outlines the various binary components that need to run to diff --git a/docs/admin/cluster-large.md b/docs/admin/cluster-large.md index be05cb627f..6df6bca474 100644 --- a/docs/admin/cluster-large.md +++ b/docs/admin/cluster-large.md @@ -1,4 +1,8 @@ --- +assignees: +- davidopp +- lavalamp + --- diff --git a/docs/admin/cluster-management.md b/docs/admin/cluster-management.md index 613ec8afa2..1be4fc8a02 100644 --- a/docs/admin/cluster-management.md +++ b/docs/admin/cluster-management.md @@ -1,6 +1,13 @@ --- +assignees: +- lavalamp +- thockin + --- +* TOC +{:toc} + This document describes several topics related to the lifecycle of a cluster: creating a new cluster, upgrading your cluster's master and worker nodes, performing node maintenance (e.g. kernel upgrades), and upgrading the Kubernetes API version of a @@ -66,78 +73,86 @@ Instance Group will take care of putting appropriate image on new machines and s In other environments you may need to configure the machine yourself and tell the Kubelet on which machine API server is running. -### Horizontal auto-scaling of nodes (GCE) +### Cluster autoscaling -If you are using GCE, you can configure your cluster so that the number of nodes will be automatically scaled based on: +If you are using GCE or GKE, you can configure your cluster so that it is automatically rescaled based on +pod needs. - * CPU and memory utilization. - * Amount of of CPU and memory requested by the pods (called also reservation). +As described in [Compute Resource](/docs/user-guide/compute-resources/), users can reserve how much CPU and memory is allocated to pods. +This information is used by the Kubernetes scheduler to find a place to run the pod. If there is +no node that has enough free capacity (or doesn't match other pod requirements) then the pod has +to wait until some pods are terminated or a new node is added. -Before setting up the cluster by `kube-up.sh`, you can set `KUBE_ENABLE_NODE_AUTOSCALER` environment variable to `true` and export it. -The script will create an autoscaler for the instance group managing your nodes. +Cluster autoscaler looks for the pods that cannot be scheduled and checks if adding a new node, similar +to the other in the cluster, would help. If yes, then it resizes the cluster to accomodate the waiting pods. -The autoscaler will try to maintain the average CPU/memory utilization and reservation of nodes within the cluster close to the target value. -The target value can be configured by `KUBE_TARGET_NODE_UTILIZATION` environment variable (default: 0.7) for ``kube-up.sh`` when creating the cluster. -Node utilization is the total node's CPU/memory usage (OS + k8s + user load) divided by the node's capacity. -Node reservation is the total CPU/memory requested by pods that are running on the node divided by the node's capacity. -If the desired numbers of nodes in the cluster resulting from CPU/memory utilization/reservation are different, -the autoscaler will choose the bigger number. The number of nodes in the cluster set by the autoscaler will be limited from `KUBE_AUTOSCALER_MIN_NODES` (default: 1) -to `KUBE_AUTOSCALER_MAX_NODES` (default: the initial number of nodes in the cluster). +Cluster autoscaler also scales down the cluster if it notices that some node is not needed anymore for +an extended period of time (10min but it may change in the future). -The autoscaler is implemented as a Compute Engine Autoscaler. -The initial values of the autoscaler parameters set by `kube-up.sh` and some more advanced options can be tweaked on -`Compute > Compute Engine > Instance groups > your group > Edit group`[Google Cloud Console page](https://console.developers.google.com) -or using gcloud CLI: +Cluster autoscaler is configured per instance group (GCE) or node pool (GKE). + +If you are using GCE then you can either enable it while creating a cluster with kube-up.sh script. +To configure cluser autoscaler you have to set 3 environment variables: + +* `KUBE_ENABLE_CLUSTER_AUTOSCALER` - it enables cluster autoscaler if set to true. +* `KUBE_AUTOSCALING_MIN_NODES` - minimum number of nodes in the cluster. +* `KUBE_AUTOSCALING_MAX_NODES` - maximum number of nodes in the cluster. + +Example: ```shell -gcloud alpha compute autoscaler --zone $ZONE +KUBE_ENABLE_CLUSTER_AUTOSCALER=true KUBE_AUTOSCALING_MIN_NODES=3 KUBE_AUTOSCALING_MAX_NODES=10 NUM_NODES=5 ./cluster/kube-up.sh ``` -Note that autoscaling will work properly only if node metrics are accessible in Google Cloud Monitoring. -To make the metrics accessible, you need to create your cluster with `KUBE_ENABLE_CLUSTER_MONITORING` -equal to `google` or `googleinfluxdb` (`googleinfluxdb` is the default value). Please also make sure -that you have Google Cloud Monitoring API enabled in Google Developer Console. +On GKE you configure cluster autoscaler either on cluster creation or update or when creating a particular node pool +(which you want to be autoscaled) by passing flags `--enable-autoscaling` `--min-nodes` and `--max-nodes` +to the corresponding `gcloud` commands. + +Examples: + +```shell +gcloud container clusters create mytestcluster --zone=us-central1-b --enable-autoscaling=true --min-nodes=3 --max-nodes=10 --num-nodes=5 +``` + +```shell +gcloud container clusters update mytestcluster --enable-autoscaling=true --min-nodes=1 --max-nodes=15 +``` + +**Cluster autoscaler expects that nodes have not been manually modified (e.g. by adding labels via kubectl) as those properties would not be propagated to the new nodes within the same instance group.** ## Maintenance on a Node If you need to reboot a node (such as for a kernel upgrade, libc upgrade, hardware repair, etc.), and the downtime is -brief, then when the Kubelet restarts, it will attempt to restart the pods scheduled to it. If the reboot takes longer, +brief, then when the Kubelet restarts, it will attempt to restart the pods scheduled to it. If the reboot takes longer +(the default time is 5 minutes, controlled by `--pod-eviction-timeout` on the controller-manager), then the node controller will terminate the pods that are bound to the unavailable node. If there is a corresponding -replication controller, then a new copy of the pod will be started on a different node. So, in the case where all +replica set (or replication controller), then a new copy of the pod will be started on a different node. So, in the case where all pods are replicated, upgrades can be done without special coordination, assuming that not all nodes will go down at the same time. If you want more control over the upgrading process, you may use the following workflow: -Mark the node to be rebooted as unschedulable: +Use `kubectl drain` to gracefully terminate all pods on the node while marking the node as unschedulable: ```shell -kubectl replace nodes $NODENAME --patch='{"apiVersion": "v1", "spec": {"unschedulable": true}}' +kubectl drain $NODENAME ``` This keeps new pods from landing on the node while you are trying to get them off. -Get the pods off the machine, via any of the following strategies: - * Wait for finite-duration pods to complete. - * Delete pods with: +For pods with a replica set, the pod will be replaced by a new pod which will be scheduled to a new node. Additionally, if the pod is part of a service, then clients will automatically be redirected to the new pod. -```shell -kubectl delete pods $PODNAME -``` - -For pods with a replication controller, the pod will eventually be replaced by a new pod which will be scheduled to a new node. Additionally, if the pod is part of a service, then clients will automatically be redirected to the new pod. - -For pods with no replication controller, you need to bring up a new copy of the pod, and assuming it is not part of a service, redirect clients to it. +For pods with no replica set, you need to bring up a new copy of the pod, and assuming it is not part of a service, redirect clients to it. Perform maintenance work on the node. Make the node schedulable again: ```shell -kubectl replace nodes $NODENAME --patch='{"apiVersion": "v1", "spec": {"unschedulable": false}}' +kubectl uncordon $NODENAME ``` If you deleted the node's VM instance and created a new one, then a new schedulable node resource will -be created automatically when you create a new VM instance (if you're using a cloud provider that supports +be created automatically (if you're using a cloud provider that supports node discovery; currently this is only Google Compute Engine, not including CoreOS on Google Compute Engine using kube-register). See [Node](/docs/admin/node) for more details. ## Advanced Topics diff --git a/docs/admin/cluster-troubleshooting.md b/docs/admin/cluster-troubleshooting.md index 22d461cd70..8bab089ce6 100644 --- a/docs/admin/cluster-troubleshooting.md +++ b/docs/admin/cluster-troubleshooting.md @@ -1,4 +1,7 @@ --- +assignees: +- davidopp + --- This doc is about cluster troubleshooting; we assume you have already ruled out your application as the root cause of the diff --git a/docs/admin/daemons.md b/docs/admin/daemons.md index f2b5463e8d..be3137bc93 100644 --- a/docs/admin/daemons.md +++ b/docs/admin/daemons.md @@ -1,4 +1,7 @@ --- +assignees: +- erictune + --- * TOC @@ -71,9 +74,11 @@ a node for testing. If you specify a `.spec.template.spec.nodeSelector`, then the DaemonSet controller will create pods on nodes which match that [node -selector](https://github.com/kubernetes/kubernetes.github.io/tree/{{page.docsbranch}}/docs/user-guide/node-selection). +selector](https://github.com/kubernetes/kubernetes.github.io/tree/{{page.docsbranch}}/docs/user-guide/node-selection). +If you specify a `scheduler.alpha.kubernetes.io/affinity` annotation in `.spec.template.metadata.annotations`, +then DaemonSet controller will create pods on nodes which match that [node affinity](../../user-guide/node-selection/#alpha-feature-in-kubernetes-v12-node-affinity). -If you do not specify a `.spec.template.spec.nodeSelector`, then the DaemonSet controller will +If you do not specify a `.spec.template.spec.nodeSelector` nor `node affinity`, then the DaemonSet controller will create pods on all nodes. ## How Daemon Pods are Scheduled diff --git a/docs/admin/dns.md b/docs/admin/dns.md index 2e37cdaf83..bdd0848cf9 100644 --- a/docs/admin/dns.md +++ b/docs/admin/dns.md @@ -1,8 +1,15 @@ --- +assignees: +- ArtfulCoder +- davidopp +- lavalamp + --- -As of Kubernetes 0.8, DNS is offered as a [cluster add-on](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/README.md). -If enabled, a DNS Pod and Service will be scheduled on the cluster, and the kubelets will be +## Introduction + +As of Kubernetes 1.3, DNS is a built-in service launched automatically using the addon manager [cluster add-on](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/README.md). +A DNS Pod and Service will be scheduled on the cluster, and the kubelets will be configured to tell individual containers to use the DNS Service's IP to resolve DNS names. Every Service defined in the cluster (including the DNS server itself) will be @@ -15,25 +22,29 @@ in namespace `bar` can look up this service by simply doing a DNS query for `foo`. A Pod running in namespace `quux` can look up this service by doing a DNS query for `foo.bar`. -The cluster DNS server ([SkyDNS](https://github.com/skynetservices/skydns)) -supports forward lookups (A records) and service lookups (SRV records). +The Kubernetes cluster DNS server (based off the [SkyDNS](https://github.com/skynetservices/skydns) library) +supports forward lookups (A records), service lookups (SRV records) and reverse IP address lookups (PTR records). + ## How it Works -The running DNS pod holds 4 containers - skydns, etcd (a private instance which skydns uses), -a Kubernetes-to-skydns bridge called kube2sky, and a health check called healthz. The kube2sky process -watches the Kubernetes master for changes in Services, and then writes the -information to etcd, which skydns reads. This etcd instance is not linked to -any other etcd clusters that might exist, including the Kubernetes master. +The running Kubernetes DNS pod holds 3 containers - kubedns, dnsmasq and a health check called healthz. +The kubedns process watches the Kubernetes master for changes in Services and Endpoints, and maintains +in-memory lookup structures to service DNS requests. The dnsmasq container adds DNS caching to improve +performance. The healthz container provides a single health check endpoint while performing dual healthchecks +(for dnsmasq and kubedns). -## Issues +## Kubernetes Federation (Multiple Zone support) -The skydns service is reachable directly from Kubernetes nodes (outside -of any container) and DNS resolution works if the skydns service is targeted -explicitly. However, nodes are not configured to use the cluster DNS service or -to search the cluster's DNS domain by default. This may be resolved at a later -time. +Release 1.3 introduced Cluster Federation support for multi-site +Kubernetes installations. This required some minor +(backward-compatible) changes to the way +the Kubernetes cluster DNS server processes DNS queries, to facilitate +the lookup of federated services (which span multiple Kubernetes clusters). +See the [Cluster Federation Administrators' Guide](/docs/admin/federation/index.md) for more +details on Cluster Federation and multi-site support. -## For more information +## References + +- [Docs for the DNS cluster addon](http://releases.k8s.io/{{page.githubbranch}}/build/kube-dns/README.md) -See [the docs for the DNS cluster addon](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/dns/README.md). \ No newline at end of file diff --git a/docs/admin/etcd.md b/docs/admin/etcd.md index f17b555cd8..14b36a33be 100644 --- a/docs/admin/etcd.md +++ b/docs/admin/etcd.md @@ -1,4 +1,7 @@ --- +assignees: +- lavalamp + --- diff --git a/docs/admin/federation-apiserver.md b/docs/admin/federation-apiserver.md new file mode 100644 index 0000000000..4e3cc81bf8 --- /dev/null +++ b/docs/admin/federation-apiserver.md @@ -0,0 +1,89 @@ +--- +--- + +## federation-apiserver + + + +### Synopsis + + +The Kubernetes federation API server validates and configures data +for the api objects which include pods, services, replicationcontrollers, and +others. The API Server services REST operations and provides the frontend to the +cluster's shared state through which all other components interact. + +``` +federation-apiserver +``` + +### Options + +``` + --admission-control="AlwaysAdmit": Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysAdmit, AlwaysDeny + --admission-control-config-file="": File with admission control configuration. + --advertise-address=: The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used. + --apiserver-count=1: The number of apiservers running in the cluster + --authorization-mode="AlwaysAllow": Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC + --authorization-policy-file="": File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port. + --authorization-rbac-super-user="": If specified, a username which avoids RBAC authorization checks and role binding privilege escalation checks, to be used with --authorization-mode=RBAC. + --authorization-webhook-cache-authorized-ttl=5m0s: The duration to cache 'authorized' responses from the webhook authorizer. Default is 5m. + --authorization-webhook-cache-unauthorized-ttl=30s: The duration to cache 'unauthorized' responses from the webhook authorizer. Default is 30s. + --authorization-webhook-config-file="": File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port. + --basic-auth-file="": If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication. + --bind-address=0.0.0.0: The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0). + --cert-dir="/var/run/kubernetes": The directory where the TLS certs are located (by default /var/run/kubernetes). If --tls-cert-file and --tls-private-key-file are provided, this flag will be ignored. + --client-ca-file="": If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate. + --cloud-config="": The path to the cloud provider configuration file. Empty string for no configuration file. + --cloud-provider="": The provider for cloud services. Empty string for no provider. + --cors-allowed-origins=[]: List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled. + --delete-collection-workers=1: Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. + --deserialization-cache-size=50000: Number of deserialized json objects to cache in memory. + --enable-swagger-ui[=false]: Enables swagger ui on the apiserver at /swagger-ui + --etcd-cafile="": SSL Certificate Authority file used to secure etcd communication + --etcd-certfile="": SSL certification file used to secure etcd communication + --etcd-keyfile="": SSL key file used to secure etcd communication + --etcd-prefix="/registry": The prefix for all resource paths in etcd. + --etcd-quorum-read[=false]: If true, enable quorum read + --etcd-servers=[]: List of etcd servers to connect with (http://ip:port), comma separated. + --etcd-servers-overrides=[]: Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated. + --experimental-keystone-url="": If passed, activates the keystone authentication plugin + --external-hostname="": The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs.) + --insecure-bind-address=127.0.0.1: The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost. + --insecure-port=8080: The port on which to serve unsecured, unauthenticated access. Default 8080. It is assumed that firewall rules are set up such that this port is not reachable from outside of the cluster and that port 443 on the cluster's public address is proxied to this port. This is performed by nginx in the default setup. + --kubernetes-service-node-port=0: If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP. + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --long-running-request-regexp="(/|^)((watch|proxy)(/|$)|(logs?|portforward|exec|attach)/?$)": A regular expression matching long running requests which should be excluded from maximum inflight request handling. + --master-service-namespace="default": The namespace from which the kubernetes master services should be injected into pods + --max-requests-inflight=400: The maximum number of requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit. + --min-request-timeout=1800: An optional field indicating the minimum number of seconds a handler must keep a request open before timing it out. Currently only honored by the watch request handler, which picks a randomized value above this number as the connection timeout, to spread out load. + --oidc-ca-file="": If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used + --oidc-client-id="": The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set + --oidc-groups-claim="": If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be an array of strings. This flag is experimental, please see the authentication documentation for further details. + --oidc-issuer-url="": The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT) + --oidc-username-claim="sub": The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details. + --profiling[=true]: Enable profiling via web interface host:port/debug/pprof/ + --runtime-config=: A set of key=value pairs that describe runtime configuration that may be passed to apiserver. apis/ key can be used to turn on/off specific api versions. apis// can be used to turn on/off specific resources. api/all and api/legacy are special keys to control all and legacy api versions respectively. + --secure-port=6443: The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. + --service-cluster-ip-range=: A CIDR notation IP range from which to assign service cluster IPs. This must not overlap with any IP ranges assigned to nodes for pods. + --service-node-port-range=: A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. + --storage-backend="": The storage backend for persistence. Options: 'etcd2' (default), 'etcd3'. + --storage-media-type="application/json": The media type to use to store objects in storage. Defaults to application/json. Some resources may only support a specific media type and will ignore this setting. + --storage-versions="apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,componentconfig/v1alpha1,extensions/v1beta1,federation/v1beta1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,v1": The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. + --tls-cert-file="": File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to /var/run/kubernetes. + --tls-private-key-file="": File containing x509 private key matching --tls-cert-file. + --token-auth-file="": If set, the file that will be used to secure the secure port of the API server via token authentication. + --watch-cache[=true]: Enable watch caching in the apiserver + --watch-cache-sizes=[]: List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource#size, where size is a number. It takes effect when watch-cache is enabled. +``` + +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/federation-apiserver.md?pixel)]() + diff --git a/docs/admin/federation-controller-manager.md b/docs/admin/federation-controller-manager.md new file mode 100644 index 0000000000..2402aa2c30 --- /dev/null +++ b/docs/admin/federation-controller-manager.md @@ -0,0 +1,56 @@ +--- +--- + +## federation-controller-manager + + + +### Synopsis + + +The federation controller manager is a daemon that embeds +the core control loops shipped with federation. In applications of robotics and +automation, a control loop is a non-terminating loop that regulates the state of +the system. In federation, a controller is a control loop that watches the shared +state of the federation cluster through the apiserver and makes changes attempting +to move the current state towards the desired state. Examples of controllers that +ship with federation today is the cluster controller. + +``` +federation-controller-manager +``` + +### Options + +``` + --address=0.0.0.0: The IP address to serve on (set to 0.0.0.0 for all interfaces) + --cluster-monitor-period=40s: The period for syncing ClusterStatus in ClusterController. + --concurrent-service-syncs=10: The number of service syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load + --dns-provider="": DNS provider. Valid values are: ["aws-route53" "google-clouddns"] + --dns-provider-config="": Path to config file for configuring DNS provider. + --federated-api-burst=30: Burst to use while talking with federation apiserver + --federated-api-qps=20: QPS to use while talking with federation apiserver + --federation-name="": Federation name. + --kube-api-content-type="": ContentType of requests sent to apiserver. Passing application/vnd.kubernetes.protobuf is an experimental feature now. + --kubeconfig="": Path to kubeconfig file with authorization and master location information. + --leader-elect[=false]: Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. + --leader-elect-lease-duration=15s: The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate. This is only applicable if leader election is enabled. + --leader-elect-renew-deadline=10s: The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration. This is only applicable if leader election is enabled. + --leader-elect-retry-period=2s: The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --master="": The address of the federation API server (overrides any value in kubeconfig) + --port=10253: The port that the controller-manager's http service runs on + --profiling[=true]: Enable profiling via web interface host:port/debug/pprof/ + --zone-name="": Zone name, like example.com. +``` + +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/federation-controller-manager.md?pixel)]() + diff --git a/docs/admin/federation/OWNERS b/docs/admin/federation/OWNERS new file mode 100644 index 0000000000..321cd31a2c --- /dev/null +++ b/docs/admin/federation/OWNERS @@ -0,0 +1,4 @@ +assignees: +- mml +- nikhiljindal + diff --git a/docs/admin/federation/index.md b/docs/admin/federation/index.md new file mode 100644 index 0000000000..f1dc41f9ac --- /dev/null +++ b/docs/admin/federation/index.md @@ -0,0 +1,200 @@ +--- +assignees: +- mml +- nikhiljindal + +--- +This guide explains how to set up cluster federation that lets us control multiple Kubernetes clusters. + + +* TOC +{:toc} + +## Prerequisites + +This guide assumes that we have a running Kubernetes cluster. +If not, then head over to the [getting started guides](/docs/getting-started-guides/) to bring up a cluster. + +This guide also assumes that we have the Kubernetes source code that can be +[downloaded from here](/docs/getting-started-guides/binary_release/). + +## Setting up a federation control plane + +Setting up federation requires running the federation control plane which +consists of etcd, federation-apiserver and federation-controller-manager. +We can run these binaries as pods on an existing Kubernetes cluster. + +### Getting images + +To run these as pods, we first need images for all the components. We can use +official release images or we can build from HEAD. + +#### Using official release images + +As part of every release, images are pushed to `gcr.io/google_containers`. To use +these images, we set env var `FEDERATION_PUSH_REPO_BASE=gcr.io/google_containers` +This will always use the latest image. +To use federation-apiserver and federation-controller-manager images from a specific release, we can set `FEDERATION_IMAGE_TAG`. + +#### Building and pushing images from HEAD + +To run the code from HEAD, we need to build and push our own images. +We can build the images using the following command: + +```shell +$ FEDERATION=true KUBE_RELEASE_RUN_TESTS=n make quick-release +``` + +Next, we need to push these images to a registry such as Google Container Registry or Docker Hub, so that our cluster can pull them. +If Kubernetes cluster is running on Google Compute Engine (GCE), then we can push the images to `gcr.io/`. +The command to push the images will look like: + +```shell +$ FEDERATION=true FEDERATION_PUSH_REPO_BASE=gcr.io/ ./build/push-federation-images.sh +``` + +### Running the federation control plane + +Once we have the images, we can run these as pods on our existing kubernetes cluster. +The command to run these pods on an existing GCE cluster will look like: + +```shell +$ KUBERNETES_PROVIDER=gce FEDERATION_DNS_PROVIDER=google-clouddns FEDERATION_NAME=myfederation DNS_ZONE_NAME=myfederation.example FEDERATION_PUSH_REPO_BASE=gcr.io/google_containers ./federation/cluster/federation-up.sh +``` + +`KUBERNETES_PROVIDER` is the cloud provider. + +`FEDERATION_DNS_PROVIDER` can be `google-clouddns` or `aws-route53`. It will be +set appropriately if it is missing and `KUBERNETES_PROVIDER` is one of `gce`, `gke` and `aws`. +This is used to resolve DNS requests for federation services. The service +controller keeps DNS records with the provider updated as services/pods are +updated in underlying kubernetes clusters. + +`FEDERATION_NAME` is a name we can choose for our federation. This is the name that will appear in DNS routes. + +`DNS_ZONE_NAME` is the domain to be used for DNS records. This is a domain that we +need to buy and then configure it such that DNS queries for that domain are +routed to the appropriate provider as per `FEDERATION_DNS_PROVIDER`. + +Running that command creates a namespace `federation` and creates 2 deployments: `federation-apiserver` and `federation-controller-manager`. +We can verify that the pods are available by running the following command: + +```shell +$ kubectl get deployments --namespace=federation +NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE +federation-apiserver 1 1 1 1 1m +federation-controller-manager 1 1 1 1 1m +``` + +Running `federation-up.sh` also creates a new record in our kubeconfig for us +to be able to talk to federation apiserver. We can view this by running +`kubectl config view`. + +Note: `federation-up.sh` creates the federation-apiserver pod with an etcd +container that is backed by a persistent volume, so as to persist data. This +currently works only on AWS, GKE, and GCE. You can edit +`federation/manifests/federation-apiserver-deployment.yaml` to suit your needs, +if required. + +## Registering Kubernetes clusters for federation + +Now that we have the federation control plane up and running, we can start registering Kubernetes clusters. + +First of all, we need to create a secret containing kubeconfig for that Kubernetes cluster, which federation control plane will use to talk to that Kubernetes cluster. +For now, we create this secret in the host Kubernetes cluster (that hosts federation control plane). When we start supporting secrets in federation control plane, we will create this secret there. +Suppose that our kubeconfig for Kubernetes cluster is at `/cluster1/kubeconfig`, we can run the following command to create the secret: + +```shell +$ kubectl create secret generic cluster1 --namespace=federation --from-file=/cluster1/kubeconfig +``` + +Note that the file name should be `kubeconfig` since file name determines the name of the key in the secret. + +Now that the secret is created, we are ready to register the cluster. The YAML file for cluster will look like: + +```yaml +apiVersion: federation/v1beta1 +kind: Cluster +metadata: + name: cluster1 +spec: + serverAddressByClientCIDRs: + - clientCIDR: + serverAddress: + secretRef: + name: +``` + +We need to insert the appropriate values for ``, `` and ``. +`` here is name of the secret that we just created. +serverAddressByClientCIDRs contains the various server addresses that clients +can use as per their CIDR. We can set the server's public IP address with CIDR +`"0.0.0.0/0"` which all clients will match. In addition, if we want internal +clients to use server's clusterIP, we can set that as serverAddress. The client +CIDR in that case will be a CIDR that only matches IPs of pods running in that +cluster. + +Assuming our YAML file is located at `/cluster1/cluster.yaml`, we can run the following command to register this cluster: + + +```shell +$ kubectl create -f /cluster1/cluster.yaml --context=federation-cluster + +``` + +By specifying `--context=federation-cluster`, we direct the request to federation apiserver. +we can ensure that the cluster registration was successful by running: + +```shell +$ kubectl get clusters --context=federation-cluster +NAME STATUS VERSION AGE +cluster1 Ready 3m +``` + +### Updating KubeDNS + +Once the cluster is registered with the federation, we are all ready to use it. +But for the cluster to be able to route federation service requests, we need to restart +KubeDNS and pass it a `--federations` flag which tells it about valid federation DNS hostnames. +Format of the flag is like this: + +``` +--federations=${FEDERATION_NAME}=${DNS_DOMAIN_NAME} +``` + +To update KubeDNS with federations flag, we can edit the existing kubedns replication controller to +include that flag in pod template spec and then delete the existing pod. Replication controller will +recreate the pod with updated template. + +To find the name of existing kubedns replication controller, run + +```shell +$ kubectl get rc --namespace=kube-system +``` + +This will list all the replication controllers. Name of the kube-dns replication +controller will look like `kube-dns-v18`. You can then edit it by running: + +```shell +$ kubectl edit rc --namespace=kube-system +``` +Add the `--federations` flag as args to kube-dns container in the YAML file that +pops up after running the above command. + +To delete the existing kube dns pod, you can first find it by running: + +```shell +$ kubectl get pods --namespace=kube-system +``` + +And then delete it by running: + +```shell +$ kubectl delete pods --namespace=kube-system +``` + +We are now all set to start using federation. + +## For more information + + * [Federation proposal](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/proposals/federation.md) details use cases that motivated this work. diff --git a/docs/admin/garbage-collection.md b/docs/admin/garbage-collection.md index 2ccd4bd2e9..bb7f2c2133 100644 --- a/docs/admin/garbage-collection.md +++ b/docs/admin/garbage-collection.md @@ -1,10 +1,13 @@ --- +assignees: +- mikedanese + --- * TOC {:toc} -Garbage collection is a helpful function of kubelet that will clean up unreferenced images and unused containers. kubelet will perform garbage collection for containers every minute and garbage collection for images every five minutes. +Garbage collection is a helpful function of kubelet that will clean up unused images and unused containers. kubelet will perform garbage collection for containers every minute and garbage collection for images every five minutes. External garbage collection tools are not recommended as these tools can potentially break the behavior of kubelet by removing containers expected to exist. diff --git a/docs/admin/high-availability/OWNERS b/docs/admin/high-availability/OWNERS new file mode 100644 index 0000000000..0ebc2894ee --- /dev/null +++ b/docs/admin/high-availability/OWNERS @@ -0,0 +1,4 @@ +assignees: +- davidopp +- lavalamp + diff --git a/docs/admin/high-availability/index.md b/docs/admin/high-availability/index.md index 01ded6eb05..f88f6bf796 100644 --- a/docs/admin/high-availability/index.md +++ b/docs/admin/high-availability/index.md @@ -1,4 +1,5 @@ --- + --- ## Introduction @@ -111,7 +112,7 @@ and etcdctl cluster-health ``` -You can also validate that this is working with `etcdctl set foo bar` on one node, and `etcd get foo` +You can also validate that this is working with `etcdctl set foo bar` on one node, and `etcdctl get foo` on a different node. ### Even more reliable storage diff --git a/docs/admin/index.md b/docs/admin/index.md index 1fc64186ea..4df7fb3375 100644 --- a/docs/admin/index.md +++ b/docs/admin/index.md @@ -1,4 +1,8 @@ --- +assignees: +- davidopp +- lavalamp + --- The cluster admin guide is for anyone creating or administering a Kubernetes cluster. diff --git a/docs/admin/kube-apiserver.md b/docs/admin/kube-apiserver.md index 43fe66d37c..97b6bc5520 100644 --- a/docs/admin/kube-apiserver.md +++ b/docs/admin/kube-apiserver.md @@ -20,13 +20,18 @@ kube-apiserver ### Options ``` - --admission-control="AlwaysAdmit": Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DenyEscalatingExec, DenyExecOnPrivileged, InitialResources, LimitRanger, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, PersistentVolumeLabel, ResourceQuota, SecurityContextDeny, ServiceAccount + --admission-control="AlwaysAdmit": Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DenyEscalatingExec, DenyExecOnPrivileged, InitialResources, LimitPodHardAntiAffinityTopology, LimitRanger, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, PersistentVolumeLabel, PodSecurityPolicy, ResourceQuota, SecurityContextDeny, ServiceAccount --admission-control-config-file="": File with admission control configuration. --advertise-address=: The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used. --allow-privileged[=false]: If true, allow privileged containers. --apiserver-count=1: The number of apiservers running in the cluster - --authorization-mode="AlwaysAllow": Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook + --authentication-token-webhook-cache-ttl=2m0s: The duration to cache responses from the webhook token authenticator. Default is 2m + --authentication-token-webhook-config-file="": File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens. + --authorization-mode="AlwaysAllow": Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC --authorization-policy-file="": File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port. + --authorization-rbac-super-user="": If specified, a username which avoids RBAC authorization checks and role binding privilege escalation checks, to be used with --authorization-mode=RBAC. + --authorization-webhook-cache-authorized-ttl=5m0s: The duration to cache 'authorized' responses from the webhook authorizer. Default is 5m. + --authorization-webhook-cache-unauthorized-ttl=30s: The duration to cache 'unauthorized' responses from the webhook authorizer. Default is 30s. --authorization-webhook-config-file="": File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port. --basic-auth-file="": If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication. --bind-address=0.0.0.0: The IP address on which to listen for the --secure-port port. The associated interface(s) must be reachable by the rest of the cluster, and by CLI/web clients. If blank, all interfaces will be used (0.0.0.0). @@ -36,12 +41,15 @@ kube-apiserver --cloud-provider="": The provider for cloud services. Empty string for no provider. --cors-allowed-origins=[]: List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled. --delete-collection-workers=1: Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. + --deserialization-cache-size=50000: Number of deserialized json objects to cache in memory. + --enable-garbage-collector[=false]: Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager. + --enable-swagger-ui[=false]: Enables swagger ui on the apiserver at /swagger-ui --etcd-cafile="": SSL Certificate Authority file used to secure etcd communication --etcd-certfile="": SSL certification file used to secure etcd communication --etcd-keyfile="": SSL key file used to secure etcd communication --etcd-prefix="/registry": The prefix for all resource paths in etcd. --etcd-quorum-read[=false]: If true, enable quorum read - --etcd-servers=[]: List of etcd servers to watch (http://ip:port), comma separated. Mutually exclusive with -etcd-config + --etcd-servers=[]: List of etcd servers to connect with (http://ip:port), comma separated. --etcd-servers-overrides=[]: Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated. --event-ttl=1h0m0s: Amount of time to retain events. Default 1 hour. --experimental-keystone-url="": If passed, activates the keystone authentication plugin @@ -76,7 +84,9 @@ kube-apiserver --service-node-port-range=: A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. --ssh-keyfile="": If non-empty, use secure SSH proxy to the nodes, using this user keyfile --ssh-user="": If non-empty, use secure SSH proxy to the nodes, using this user name - --storage-versions="authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,componentconfig/v1alpha1,extensions/v1beta1,metrics/v1alpha1,v1": The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. + --storage-backend="": The storage backend for persistence. Options: 'etcd2' (default), 'etcd3'. + --storage-media-type="application/json": The media type to use to store objects in storage. Defaults to application/json. Some resources may only support a specific media type and will ignore this setting. + --storage-versions="apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,componentconfig/v1alpha1,extensions/v1beta1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,v1": The per-group version to store resources in. Specified in the format "group1/version1,group2/version2,...". In the case where objects are moved from one group to the other, you may specify the format "group1=group2/v1beta1,group3/v1beta1,...". You only need to pass the groups you wish to change from the defaults. It defaults to a list of preferred versions of all registered groups, which is derived from the KUBE_API_VERSIONS environment variable. --tls-cert-file="": File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If HTTPS serving is enabled, and --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to /var/run/kubernetes. --tls-private-key-file="": File containing x509 private key matching --tls-cert-file. --token-auth-file="": If set, the file that will be used to secure the secure port of the API server via token authentication. @@ -84,4 +94,13 @@ kube-apiserver --watch-cache-sizes=[]: List of watch cache sizes for every resource (pods, nodes, etc.), comma separated. The individual override format: resource#size, where size is a number. It takes effect when watch-cache is enabled. ``` -###### Auto generated by spf13/cobra on 6-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/kube-apiserver.md?pixel)]() + diff --git a/docs/admin/kube-controller-manager.md b/docs/admin/kube-controller-manager.md index 70a1e576d4..1c63d998c4 100644 --- a/docs/admin/kube-controller-manager.md +++ b/docs/admin/kube-controller-manager.md @@ -36,14 +36,20 @@ kube-controller-manager --concurrent-replicaset-syncs=5: The number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load --concurrent-resource-quota-syncs=5: The number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) load --concurrent_rc_syncs=5: The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load + --configure-cloud-routes[=true]: Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider. + --controller-start-interval=0: Interval between starting controller managers. --daemonset-lookup-cache-size=1024: The the size of lookup cache for daemonsets. Larger number = more responsive daemonsets, but more MEM load. - --deleting-pods-burst=10: Number of nodes on which pods are bursty deleted in case of node failure. For more details look into RateLimiter. + --deleting-pods-burst=1: Number of nodes on which pods are bursty deleted in case of node failure. For more details look into RateLimiter. --deleting-pods-qps=0.1: Number of nodes per second on which pods are deleted in case of node failure. --deployment-controller-sync-period=30s: Period for syncing the deployments. + --enable-dynamic-provisioning[=true]: Enable dynamic provisioning for environments that support it. + --enable-garbage-collector[=false]: Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-apiserver. WARNING: the generic garbage collector is an alpha feature. --enable-hostpath-provisioner[=false]: Enable HostPath PV provisioning when running without a cloud provider. This allows testing and development of provisioning features. HostPath provisioning is not supported in any way, won't work in a multi-node cluster, and should not be used for anything other than testing or development. + --flex-volume-plugin-dir="/usr/libexec/kubernetes/kubelet-plugins/volume/exec/": Full path of the directory in which the flex volume plugin should search for additional third party volume plugins. --google-json-key="": The Google Cloud Platform Service Account JSON Key to use for authentication. --horizontal-pod-autoscaler-sync-period=30s: The period for syncing the number of pods in horizontal pod autoscaler. --kube-api-burst=30: Burst to use while talking with kubernetes apiserver + --kube-api-content-type="application/vnd.kubernetes.protobuf": Content type of requests sent to apiserver. --kube-api-qps=20: QPS to use while talking with kubernetes apiserver --kubeconfig="": Path to kubeconfig file with authorization and master location information. --leader-elect[=false]: Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. @@ -54,6 +60,7 @@ kube-controller-manager --master="": The address of the Kubernetes API server (overrides any value in kubeconfig) --min-resync-period=12h0m0s: The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod --namespace-sync-period=5m0s: The period for syncing namespace life-cycle updates + --node-cidr-mask-size=24: Mask size for node cidr in cluster. --node-monitor-grace-period=40s: Amount of time which we allow running Node to be unresponsive before marking it unhealty. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status. --node-monitor-period=5s: The period for syncing NodeStatus in NodeController. --node-startup-grace-period=1m0s: Amount of time which we allow starting Node to be unresponsive before marking it unhealty. @@ -67,14 +74,24 @@ kube-controller-manager --pv-recycler-pod-template-filepath-hostpath="": The file path to a pod definition used as a template for HostPath persistent volume recycling. This is for development and testing only and will not work in a multi-node cluster. --pv-recycler-pod-template-filepath-nfs="": The file path to a pod definition used as a template for NFS persistent volume recycling --pv-recycler-timeout-increment-hostpath=30: the increment of time added per Gi to ActiveDeadlineSeconds for a HostPath scrubber pod. This is for development and testing only and will not work in a multi-node cluster. - --pvclaimbinder-sync-period=10m0s: The period for syncing persistent volumes and persistent volume claims + --pvclaimbinder-sync-period=15s: The period for syncing persistent volumes and persistent volume claims --replicaset-lookup-cache-size=4096: The the size of lookup cache for replicatsets. Larger number = more responsive replica management, but more MEM load. --replication-controller-lookup-cache-size=4096: The the size of lookup cache for replication controllers. Larger number = more responsive replica management, but more MEM load. --resource-quota-sync-period=5m0s: The period for syncing quota usage status in the system --root-ca-file="": If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle. --service-account-private-key-file="": Filename containing a PEM-encoded private RSA key used to sign service account tokens. + --service-cluster-ip-range="": CIDR Range for Services in cluster. --service-sync-period=5m0s: The period for syncing services with their external load balancers --terminated-pod-gc-threshold=12500: Number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods. If <= 0, the terminated pod garbage collector is disabled. ``` -###### Auto generated by spf13/cobra on 29-Feb-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/kube-controller-manager.md?pixel)]() + diff --git a/docs/admin/kube-proxy.md b/docs/admin/kube-proxy.md index ff2a5af980..3b8fe94209 100644 --- a/docs/admin/kube-proxy.md +++ b/docs/admin/kube-proxy.md @@ -25,8 +25,10 @@ kube-proxy ``` --bind-address=0.0.0.0: The IP address for the proxy server to serve on (set to 0.0.0.0 for all interfaces) --cleanup-iptables[=false]: If true cleanup iptables rules and exit. + --cluster-cidr="": The CIDR range of pods in the cluster. It is used to bridge traffic coming from outside of the cluster. If not provided, no off-cluster bridging will be performed. --config-sync-period=15m0s: How often configuration from the apiserver is refreshed. Must be greater than 0. - --conntrack-max=262144: Maximum number of NAT connections to track (0 to leave as-is) + --conntrack-max=0: Maximum number of NAT connections to track (0 to leave as-is). + --conntrack-max-per-core=32768: Maximum number of NAT connections to track per CPU core (0 to leave as-is). This is only considered if conntrack-max is 0. --conntrack-tcp-timeout-established=24h0m0s: Idle timeout for established TCP connections (0 to leave as-is) --google-json-key="": The Google Cloud Platform Service Account JSON Key to use for authentication. --healthz-bind-address=127.0.0.1: The IP address for the health check server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces) @@ -35,6 +37,7 @@ kube-proxy --iptables-masquerade-bit=14: If using the pure iptables proxy, the bit of the fwmark space to mark packets requiring SNAT with. Must be within the range [0, 31]. --iptables-sync-period=30s: How often iptables rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0. --kube-api-burst=10: Burst to use while talking with kubernetes apiserver + --kube-api-content-type="application/vnd.kubernetes.protobuf": Content type of requests sent to apiserver. --kube-api-qps=5: QPS to use while talking with kubernetes apiserver --kubeconfig="": Path to kubeconfig file with authorization information (the master location is set by the master flag). --log-flush-frequency=5s: Maximum number of seconds between log flushes @@ -46,4 +49,13 @@ kube-proxy --udp-timeout=250ms: How long an idle UDP connection will be kept open (e.g. '250ms', '2s'). Must be greater than 0. Only applicable for proxy-mode=userspace ``` -###### Auto generated by spf13/cobra on 7-Feb-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/kube-proxy.md?pixel)]() + diff --git a/docs/admin/kube-scheduler.md b/docs/admin/kube-scheduler.md index e0f6e35fa6..285a314d87 100644 --- a/docs/admin/kube-scheduler.md +++ b/docs/admin/kube-scheduler.md @@ -25,8 +25,11 @@ kube-scheduler ``` --address="0.0.0.0": The IP address to serve on (set to 0.0.0.0 for all interfaces) --algorithm-provider="DefaultProvider": The scheduling algorithm provider to use, one of: DefaultProvider + --failure-domains="kubernetes.io/hostname,failure-domain.beta.kubernetes.io/zone,failure-domain.beta.kubernetes.io/region": Indicate the "all topologies" set for an empty topologyKey when it's used for PreferredDuringScheduling pod anti-affinity. --google-json-key="": The Google Cloud Platform Service Account JSON Key to use for authentication. + --hard-pod-affinity-symmetric-weight=1: RequiredDuringScheduling affinity is not symmetric, but there is an implicit PreferredDuringScheduling affinity rule corresponding to every RequiredDuringScheduling affinity rule. --hard-pod-affinity-symmetric-weight represents the weight of implicit PreferredDuringScheduling affinity rule. --kube-api-burst=100: Burst to use while talking with kubernetes apiserver + --kube-api-content-type="application/vnd.kubernetes.protobuf": Content type of requests sent to apiserver. --kube-api-qps=50: QPS to use while talking with kubernetes apiserver --kubeconfig="": Path to kubeconfig file with authorization and master location information. --leader-elect[=false]: Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. @@ -41,4 +44,13 @@ kube-scheduler --scheduler-name="default-scheduler": Name of the scheduler, used to select which pods will be processed by this scheduler, based on pod's annotation with key 'scheduler.alpha.kubernetes.io/name' ``` -###### Auto generated by spf13/cobra on 28-Jan-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/kube-scheduler.md?pixel)]() + diff --git a/docs/admin/kubelet.md b/docs/admin/kubelet.md index e52da6d5c8..d3123f6d6c 100644 --- a/docs/admin/kubelet.md +++ b/docs/admin/kubelet.md @@ -41,8 +41,8 @@ kubelet --cgroup-root="": Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default. --chaos-chance=0: If > 0.0, introduce random client errors and latency. Intended for testing. [default=0.0] --cloud-config="": The path to the cloud provider configuration file. Empty string for no configuration file. - --cloud-provider="": The provider for cloud services. Empty string for no provider. - --cluster-dns="": IP address for a cluster DNS server. If set, kubelet will configure all containers to use this for DNS resolution in addition to the host's DNS servers + --cloud-provider="auto-detect": The provider for cloud services. By default, kubelet will attempt to auto-detect the cloud provider. Specify empty string for running with no cloud provider. [default=auto-detect] + --cluster-dns="": IP address for a cluster DNS server. This value is used for containers' DNS server in case of Pods with "dnsPolicy=ClusterFirst" --cluster-domain="": Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains --config="": Path to the config file or directory of files --configure-cbr0[=false]: If true, kubelet will configure cbr0 based on Node.Spec.PodCIDR. @@ -51,12 +51,20 @@ kubelet --cpu-cfs-quota[=true]: Enable CPU CFS quota enforcement for containers that specify CPU limits --docker-endpoint="": If non-empty, use this for the docker endpoint to communicate with --docker-exec-handler="native": Handler to use when executing a command in a container. Valid values are 'native' and 'nsenter'. Defaults to 'native'. + --enable-controller-attach-detach[=true]: Enables the Attach/Detach controller to manage attachment/detachment of volumes scheduled to this node, and disables kubelet from executing any attach/detach operations --enable-custom-metrics[=false]: Support for gathering custom metrics. --enable-debugging-handlers[=true]: Enables server endpoints for log collection and local running of containers and commands --enable-server[=true]: Enable the Kubelet's server --event-burst=10: Maximum size of a bursty event records, temporarily allows event records to burst to this number, while still not exceeding event-qps. Only used if --event-qps > 0 --event-qps=5: If > 0, limit event creations per second to this value. If 0, unlimited. + --eviction-hard="": A set of eviction thresholds (e.g. memory.available<1Gi) that if met would trigger a pod eviction. + --eviction-max-pod-grace-period=0: Maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. If negative, defer to pod specified value. + --eviction-pressure-transition-period=5m0s: Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition. + --eviction-soft="": A set of eviction thresholds (e.g. memory.available<1.5Gi) that if met over a corresponding grace period would trigger a pod eviction. + --eviction-soft-grace-period="": A set of eviction grace periods (e.g. memory.available=1m30s) that correspond to how long a soft eviction threshold must hold before triggering a pod eviction. + --exit-on-lock-contention[=false]: Whether kubelet should exit upon lock-file contention. --experimental-flannel-overlay[=false]: Experimental support for starting the kubelet with the default overlay network (flannel). Assumes flanneld is already running in client mode. [default=false] + --experimental-nvidia-gpus=0: Number of NVIDIA GPU devices on this node. Only 0 (default) and 1 are currently supported. --file-check-frequency=20s: Duration between checking config files for new data --google-json-key="": The Google Cloud Platform Service Account JSON Key to use for authentication. --hairpin-mode="promiscuous-bridge": How should the kubelet setup hairpin NAT. This allows endpoints of a Service to loadbalance back to themselves if they should try to access their own Service. Valid values are "promiscuous-bridge", "hairpin-veth" and "none". @@ -70,8 +78,9 @@ kubelet --image-gc-high-threshold=90: The percent of disk usage after which image garbage collection is always run. Default: 90% --image-gc-low-threshold=80: The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. Default: 80% --kube-api-burst=10: Burst to use while talking with kubernetes apiserver + --kube-api-content-type="application/vnd.kubernetes.protobuf": Content type of requests sent to apiserver. --kube-api-qps=5: QPS to use while talking with kubernetes apiserver - --kube-reserved=: A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for kubernetes system components. Currently only cpu and memory are supported. See http://releases.k8s.io/HEAD/docs/user-guide/compute-resources.md for more detail. [default=none] + --kube-reserved=: A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for kubernetes system components. Currently only cpu and memory are supported. See http://releases.k8s.io/release-1.3/docs/user-guide/compute-resources.md for more detail. [default=none] --kubeconfig="/var/lib/kubelet/kubeconfig": Path to a kubeconfig file, specifying how to authenticate to API server (the master location is set by the api-servers flag). --kubelet-cgroups="": Optional absolute name of cgroups to create and run the Kubelet in. --lock-file="": The path to file for kubelet to use as a lock file. @@ -95,7 +104,8 @@ kubelet --oom-score-adj=-999: The oom-score-adj value for kubelet process. Values must be within the range [-1000, 1000] --outofdisk-transition-frequency=5m0s: Duration for which the kubelet has to wait before transitioning out of out-of-disk node condition status. Default: 5m0s --pod-cidr="": The CIDR to use for pod IP addresses, only used in standalone mode. In cluster mode, this is obtained from the master. - --pod-infra-container-image="gcr.io/google_containers/pause:2.0": The image whose network/ipc namespaces containers in each pod will use. + --pod-infra-container-image="gcr.io/google_containers/pause-amd64:3.0": The image whose network/ipc namespaces containers in each pod will use. + --pods-per-core=0: Number of Pods per core that can run on this Kubelet. The total number of Pods on this Kubelet cannot exceed max-pods, so max-pods will be used if this calculation results in a larger number of Pods allowed on the Kubelet. A value of 0 disables this limit. --port=10250: The port for the Kubelet to serve on. --read-only-port=10255: The read-only port for the Kubelet to serve on with no authentication/authorization (set to 0 to disable) --really-crash-for-testing[=false]: If true, when panics occur crash. Intended for testing. @@ -105,20 +115,31 @@ kubelet --registry-burst=10: Maximum size of a bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry-qps. Only used if --registry-qps > 0 --registry-qps=5: If > 0, limit registry pull QPS to this value. If 0, unlimited. [default=5.0] --resolv-conf="/etc/resolv.conf": Resolver configuration file used as the basis for the container DNS resolution configuration. - --rkt-path="": Path of rkt binary. Leave empty to use the first rkt in $PATH. Only used if --container-runtime='rkt' - --rkt-stage1-image="": image to use as stage1. Local paths and http/https URLs are supported. If empty, the 'stage1.aci' in the same directory as '--rkt-path' will be used + --rkt-api-endpoint="localhost:15441": The endpoint of the rkt API service to communicate with. Only used if --container-runtime='rkt'. + --rkt-path="": Path of rkt binary. Leave empty to use the first rkt in $PATH. Only used if --container-runtime='rkt'. --root-dir="/var/lib/kubelet": Directory path for managing kubelet files (volume mounts,etc). --runonce[=false]: If true, exit after spawning pods from local manifests or remote urls. Exclusive with --api-servers, and --enable-server --runtime-cgroups="": Optional absolute name of cgroups to create and run the runtime in. + --runtime-request-timeout=2m0s: Timeout of all runtime requests except long running request - pull, logs, exec and attach. When timeout exceeded, kubelet will cancel the request, throw out an error and retry later. Default: 2m0s + --seccomp-profile-root="/var/lib/kubelet/seccomp": Directory path for seccomp profiles. --serialize-image-pulls[=true]: Pull images one at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Aufs storage backend. Issue #10959 has more details. [default=true] --streaming-connection-idle-timeout=4h0m0s: Maximum time a streaming connection can be idle before the connection is automatically closed. 0 indicates no timeout. Example: '5m' --sync-frequency=1m0s: Max period between synchronizing running containers and config --system-cgroups="": Optional absolute name of cgroups in which to place all non-kernel processes that are not already inside a cgroup under `/`. Empty for no container. Rolling back the flag requires a reboot. (Default: ""). - --system-reserved=: A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for non-kubernetes components. Currently only cpu and memory are supported. See http://releases.k8s.io/HEAD/docs/user-guide/compute-resources.md for more detail. [default=none] + --system-reserved=: A set of ResourceName=ResourceQuantity (e.g. cpu=200m,memory=150G) pairs that describe resources reserved for non-kubernetes components. Currently only cpu and memory are supported. See http://releases.k8s.io/release-1.3/docs/user-guide/compute-resources.md for more detail. [default=none] --tls-cert-file="": File containing x509 Certificate for HTTPS. (CA cert, if any, concatenated after server cert). If --tls-cert-file and --tls-private-key-file are not provided, a self-signed certificate and key are generated for the public address and saved to the directory passed to --cert-dir. --tls-private-key-file="": File containing x509 private key matching --tls-cert-file. --volume-plugin-dir="/usr/libexec/kubernetes/kubelet-plugins/volume/exec/": The full path of the directory in which to search for additional third party volume plugins --volume-stats-agg-period=1m0s: Specifies interval for kubelet to calculate and cache the volume disk usage for all pods and volumes. To disable volume calculations, set to 0. Default: '1m' ``` -###### Auto generated by spf13/cobra on 15-Mar-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/admin/kubelet.md?pixel)]() + diff --git a/docs/admin/limitrange/OWNERS b/docs/admin/limitrange/OWNERS new file mode 100644 index 0000000000..1dac6f1017 --- /dev/null +++ b/docs/admin/limitrange/OWNERS @@ -0,0 +1,4 @@ +assignees: +- derekwaynecarr +- janetkuo + diff --git a/docs/admin/limitrange/index.md b/docs/admin/limitrange/index.md index 7c89b3058b..f38737981d 100644 --- a/docs/admin/limitrange/index.md +++ b/docs/admin/limitrange/index.md @@ -1,5 +1,9 @@ ---- ---- +--- +assignees: +- derekwaynecarr +- janetkuo + +--- By default, pods run with unbounded CPU and memory limits. This means that any pod in the system will be able to consume as much CPU and memory on the node that executes the pod. @@ -40,32 +44,32 @@ This example will work in a custom namespace to demonstrate the concepts involve Let's create a new namespace called limit-example: -```shell -$ kubectl create namespace limit-example -namespace "limit-example" created -``` - -Note that `kubectl` commands will print the type and name of the resource created or mutated, which can then be used in subsequent commands: - -```shell +```shell +$ kubectl create namespace limit-example +namespace "limit-example" created +``` + +Note that `kubectl` commands will print the type and name of the resource created or mutated, which can then be used in subsequent commands: + +```shell $ kubectl get namespaces -NAME STATUS AGE -default Active 51s -limit-example Active 45s -``` - +NAME STATUS AGE +default Active 51s +limit-example Active 45s +``` + ## Step 2: Apply a limit to the namespace Let's create a simple limit in our namespace. -```shell +```shell $ kubectl create -f docs/admin/limitrange/limits.yaml --namespace=limit-example limitrange "mylimits" created -``` - +``` + Let's describe the limits that we have imposed in our namespace. -```shell +```shell $ kubectl describe limits mylimits --namespace=limit-example Name: mylimits Namespace: limit-example @@ -75,8 +79,8 @@ Pod cpu 200m 2 - - Pod memory 6Mi 1Gi - - - Container cpu 100m 2 200m 300m - Container memory 3Mi 1Gi 100Mi 200Mi - -``` - +``` + In this scenario, we have said the following: 1. If a max constraint is specified for a resource (2 CPU and 1Gi memory in this case), then a limit @@ -103,108 +107,108 @@ of creation explaining why. Let's first spin up a [Deployment](/docs/user-guide/deployments) that creates a single container Pod to demonstrate how default values are applied to each pod. -```shell +```shell $ kubectl run nginx --image=nginx --replicas=1 --namespace=limit-example deployment "nginx" created -``` - -Note that `kubectl run` creates a Deployment named "nginx" on Kubernetes cluster >= v1.2. If you are running older versions, it creates replication controllers instead. -If you want to obtain the old behavior, use `--generator=run/v1` to create replication controllers. See [`kubectl run`](/docs/user-guide/kubectl/kubectl_run/) for more details. -The Deployment manages 1 replica of single container Pod. Let's take a look at the Pod it manages. First, find the name of the Pod: - -```shell +``` + +Note that `kubectl run` creates a Deployment named "nginx" on Kubernetes cluster >= v1.2. If you are running older versions, it creates replication controllers instead. +If you want to obtain the old behavior, use `--generator=run/v1` to create replication controllers. See [`kubectl run`](/docs/user-guide/kubectl/kubectl_run/) for more details. +The Deployment manages 1 replica of single container Pod. Let's take a look at the Pod it manages. First, find the name of the Pod: + +```shell $ kubectl get pods --namespace=limit-example -NAME READY STATUS RESTARTS AGE -nginx-2040093540-s8vzu 1/1 Running 0 11s -``` - -Let's print this Pod with yaml output format (using `-o yaml` flag), and then `grep` the `resources` field. Note that your pod name will be different. - -``` shell +NAME READY STATUS RESTARTS AGE +nginx-2040093540-s8vzu 1/1 Running 0 11s +``` + +Let's print this Pod with yaml output format (using `-o yaml` flag), and then `grep` the `resources` field. Note that your pod name will be different. + +``` shell $ kubectl get pods nginx-2040093540-s8vzu --namespace=limit-example -o yaml | grep resources -C 8 - resourceVersion: "57" - selfLink: /api/v1/namespaces/limit-example/pods/nginx-2040093540-ivimu - uid: 67b20741-f53b-11e5-b066-64510658e388 -spec: - containers: - - image: nginx - imagePullPolicy: Always - name: nginx - resources: - limits: - cpu: 300m - memory: 200Mi - requests: - cpu: 200m - memory: 100Mi - terminationMessagePath: /dev/termination-log - volumeMounts: -``` - + resourceVersion: "57" + selfLink: /api/v1/namespaces/limit-example/pods/nginx-2040093540-ivimu + uid: 67b20741-f53b-11e5-b066-64510658e388 +spec: + containers: + - image: nginx + imagePullPolicy: Always + name: nginx + resources: + limits: + cpu: 300m + memory: 200Mi + requests: + cpu: 200m + memory: 100Mi + terminationMessagePath: /dev/termination-log + volumeMounts: +``` + Note that our nginx container has picked up the namespace default cpu and memory resource *limits* and *requests*. Let's create a pod that exceeds our allowed limits by having it have a container that requests 3 cpu cores. -```shell +```shell $ kubectl create -f docs/admin/limitrange/invalid-pod.yaml --namespace=limit-example Error from server: error when creating "docs/admin/limitrange/invalid-pod.yaml": Pod "invalid-pod" is forbidden: [Maximum cpu usage per Pod is 2, but limit is 3., Maximum cpu usage per Container is 2, but limit is 3.] -``` - +``` + Let's create a pod that falls within the allowed limit boundaries. -```shell +```shell $ kubectl create -f docs/admin/limitrange/valid-pod.yaml --namespace=limit-example pod "valid-pod" created -``` - -Now look at the Pod's resources field: - -```shell +``` + +Now look at the Pod's resources field: + +```shell $ kubectl get pods valid-pod --namespace=limit-example -o yaml | grep -C 6 resources - uid: 3b1bfd7a-f53c-11e5-b066-64510658e388 -spec: - containers: - - image: gcr.io/google_containers/serve_hostname - imagePullPolicy: Always - name: kubernetes-serve-hostname - resources: - limits: - cpu: "1" - memory: 512Mi - requests: - cpu: "1" - memory: 512Mi -``` - + uid: 3b1bfd7a-f53c-11e5-b066-64510658e388 +spec: + containers: + - image: gcr.io/google_containers/serve_hostname + imagePullPolicy: Always + name: kubernetes-serve-hostname + resources: + limits: + cpu: "1" + memory: 512Mi + requests: + cpu: "1" + memory: 512Mi +``` + Note that this pod specifies explicit resource *limits* and *requests* so it did not pick up the namespace default values. Note: The *limits* for CPU resource are enforced in the default Kubernetes setup on the physical node that runs the container unless the administrator deploys the kubelet with the folllowing flag: -```shell +```shell $ kubelet --help Usage of kubelet .... --cpu-cfs-quota[=true]: Enable CPU CFS quota enforcement for containers that specify CPU limits $ kubelet --cpu-cfs-quota=false ... -``` - +``` + ## Step 4: Cleanup To remove the resources used by this example, you can just delete the limit-example namespace. -```shell +```shell $ kubectl delete namespace limit-example namespace "limit-example" deleted $ kubectl get namespaces -NAME STATUS AGE -default Active 12m -``` - +NAME STATUS AGE +default Active 12m +``` + ## Summary Cluster operators that want to restrict the amount of resources a single container or pod may consume are able to define allowable ranges per Kubernetes namespace. In the absence of any explicit assignments, the Kubernetes system is able to apply default resource *limits* and *requests* if desired in order to -constrain the amount of resource a pod consumes on a node. +constrain the amount of resource a pod consumes on a node. diff --git a/docs/admin/master-node-communication.md b/docs/admin/master-node-communication.md index 1d40b265f6..e574ce6481 100644 --- a/docs/admin/master-node-communication.md +++ b/docs/admin/master-node-communication.md @@ -1,4 +1,8 @@ --- +assignees: +- dchen1107 +- roberthbailey + --- * TOC diff --git a/docs/admin/multi-cluster.md b/docs/admin/multi-cluster.md index 47e433e29b..6359782409 100644 --- a/docs/admin/multi-cluster.md +++ b/docs/admin/multi-cluster.md @@ -1,13 +1,14 @@ --- +assignees: +- davidopp + --- You may want to set up multiple Kubernetes clusters, both to have clusters in different regions to be nearer to your users, and to tolerate failures and/or invasive maintenance. This document describes some of the issues to consider when making a decision about doing so. -Note that at present, -Kubernetes does not offer a mechanism to aggregate multiple clusters into a single virtual cluster. However, -we [plan to do this in the future](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/proposals/federation.md). +If you decide to have multiple clusters, kubernetes provides a way to [federate them](/docs/admin/federation/) ## Scope of a single cluster @@ -56,11 +57,10 @@ users in the event of a cluster failure), then you need to have `R * (U + 1)` cl (`U + 1` in each of `R` regions). In any case, try to put each cluster in a different zone. Finally, if any of your clusters would need more than the maximum recommended number of nodes for a Kubernetes cluster, then -you may need even more clusters. Kubernetes v1.0 currently supports clusters up to 100 nodes in size, but we are targeting -1000-node clusters by early 2016. +you may need even more clusters. Kubernetes v1.3 supports clusters up to 1000 nodes in size. ## Working with multiple clusters When you have multiple clusters, you would typically create services with the same config in each cluster and put each of those service instances behind a load balancer (AWS Elastic Load Balancer, GCE Forwarding Rule or HTTP Load Balancer) spanning all of them, so that -failures of a single cluster are not visible to end users. \ No newline at end of file +failures of a single cluster are not visible to end users. diff --git a/docs/admin/multiple-schedulers.md b/docs/admin/multiple-schedulers.md index a481831e50..8ba152ac04 100644 --- a/docs/admin/multiple-schedulers.md +++ b/docs/admin/multiple-schedulers.md @@ -1,4 +1,8 @@ --- +assignees: +- davidopp +- madhusudancs + --- Kubernetes ships with a default scheduler that is described [here](/docs/admin/kube-scheduler/). diff --git a/docs/admin/multiple-schedulers/OWNERS b/docs/admin/multiple-schedulers/OWNERS new file mode 100644 index 0000000000..3941099ffc --- /dev/null +++ b/docs/admin/multiple-schedulers/OWNERS @@ -0,0 +1,4 @@ +assignees: +- davidopp +- madhusudancs + diff --git a/docs/admin/multiple-zones.md b/docs/admin/multiple-zones.md index e420bda304..e5d1367862 100644 --- a/docs/admin/multiple-zones.md +++ b/docs/admin/multiple-zones.md @@ -1,18 +1,23 @@ --- +assignees: +- jlowdermilk +- justinsb +- quinton-hoole + --- ## Introduction Kubernetes 1.2 adds support for running a single cluster in multiple failure zones (GCE calls them simply "zones", AWS calls them "availability zones", here we'll refer to them as "zones"). -This is a lightweight version of a broader effort for federating multiple -Kubernetes clusters together (sometimes referred to by the affectionate -nickname ["Ubernetes"](https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/federation.md). -Full federation will allow combining separate -Kubernetes clusters running in different regions or clouds. However, many +This is a lightweight version of a broader Cluster Federation feature (previously referred to by the affectionate +nickname ["Ubernetes"](https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/federation.md)). +Full Cluster Federation allows combining separate +Kubernetes clusters running in different regions or cloud providers +(or on-premise data centers). However, many users simply want to run a more available Kubernetes cluster in multiple zones -of their cloud provider, and this is what the multizone support in 1.2 allows -(we nickname this "Ubernetes Lite"). +of their single cloud provider, and this is what the multizone support in 1.2 allows +(this previously went by the nickname "Ubernetes Lite"). Multizone support is deliberately limited: a single Kubernetes cluster can run in multiple zones, but only within the same region (and cloud provider). Only @@ -73,7 +78,7 @@ plane should follow the [high availability](/docs/admin/high-availability) instr We're now going to walk through setting up and using a multi-zone cluster on both GCE & AWS. To do so, you bring up a full cluster -(specifying `MULTIZONE=1`), and then you add nodes in additional zones +(specifying `MULTIZONE=true`), and then you add nodes in additional zones by running `kube-up` again (specifying `KUBE_USE_EXISTING_MASTER=true`). ### Bringing up your cluster @@ -83,17 +88,17 @@ Create the cluster as normal, but pass MULTIZONE to tell the cluster to manage m GCE: ```shell -curl -sS https://get.k8s.io | MULTIZONE=1 KUBERNETES_PROVIDER=gce KUBE_GCE_ZONE=us-central1-a NUM_NODES=3 bash +curl -sS https://get.k8s.io | MULTIZONE=true KUBERNETES_PROVIDER=gce KUBE_GCE_ZONE=us-central1-a NUM_NODES=3 bash ``` AWS: ```shell -curl -sS https://get.k8s.io | MULTIZONE=1 KUBERNETES_PROVIDER=aws KUBE_AWS_ZONE=us-west-2a NUM_NODES=3 bash +curl -sS https://get.k8s.io | MULTIZONE=true KUBERNETES_PROVIDER=aws KUBE_AWS_ZONE=us-west-2a NUM_NODES=3 bash ``` This step brings up a cluster as normal, still running in a single zone -(but `MULTIZONE=1` has enabled multi-zone capabilities). +(but `MULTIZONE=true` has enabled multi-zone capabilities). ### Nodes are labeled @@ -117,21 +122,21 @@ kubernetes-minion-a12q Ready 6m beta.kubernetes.io Let's add another set of nodes to the existing cluster, reusing the existing master, running in a different zone (us-central1-b or us-west-2b). -We run kube-up again, but by specifying `KUBE_USE_EXISTING_MASTER=1` +We run kube-up again, but by specifying `KUBE_USE_EXISTING_MASTER=true` kube-up will not create a new master, but will reuse one that was previously created instead. GCE: ```shell -KUBE_USE_EXISTING_MASTER=true MULTIZONE=1 KUBERNETES_PROVIDER=gce KUBE_GCE_ZONE=us-central1-b NUM_NODES=3 kubernetes/cluster/kube-up.sh +KUBE_USE_EXISTING_MASTER=true MULTIZONE=true KUBERNETES_PROVIDER=gce KUBE_GCE_ZONE=us-central1-b NUM_NODES=3 kubernetes/cluster/kube-up.sh ``` On AWS we also need to specify the network CIDR for the additional subnet, along with the master internal IP address: ```shell -KUBE_USE_EXISTING_MASTER=true MULTIZONE=1 KUBERNETES_PROVIDER=aws KUBE_AWS_ZONE=us-west-2b NUM_NODES=3 KUBE_SUBNET_CIDR=172.20.1.0/24 MASTER_INTERNAL_IP=172.20.0.9 kubernetes/cluster/kube-up.sh +KUBE_USE_EXISTING_MASTER=true MULTIZONE=true KUBERNETES_PROVIDER=aws KUBE_AWS_ZONE=us-west-2b NUM_NODES=3 KUBE_SUBNET_CIDR=172.20.1.0/24 MASTER_INTERNAL_IP=172.20.0.9 kubernetes/cluster/kube-up.sh ``` @@ -183,7 +188,7 @@ EOF The PV is also labeled with the zone & region it was created in. For version 1.2, dynamic persistent volumes are always created in the zone -of the cluster master (here us-centaral1-a / us-west-2a); this will +of the cluster master (here us-central1-a / us-west-2a); this will be improved in a future version (issue [#23330](https://github.com/kubernetes/kubernetes/issues/23330).) ```shell @@ -235,13 +240,13 @@ across zones. First, let's launch more nodes in a third zone: GCE: ```shell -KUBE_USE_EXISTING_MASTER=true MULTIZONE=1 KUBERNETES_PROVIDER=gce KUBE_GCE_ZONE=us-central1-f NUM_NODES=3 kubernetes/cluster/kube-up.sh +KUBE_USE_EXISTING_MASTER=true MULTIZONE=true KUBERNETES_PROVIDER=gce KUBE_GCE_ZONE=us-central1-f NUM_NODES=3 kubernetes/cluster/kube-up.sh ``` AWS: ```shell -KUBE_USE_EXISTING_MASTER=true MULTIZONE=1 KUBERNETES_PROVIDER=aws KUBE_AWS_ZONE=us-west-2c NUM_NODES=3 KUBE_SUBNET_CIDR=172.20.2.0/24 MASTER_INTERNAL_IP=172.20.0.9 kubernetes/cluster/kube-up.sh +KUBE_USE_EXISTING_MASTER=true MULTIZONE=true KUBERNETES_PROVIDER=aws KUBE_AWS_ZONE=us-west-2c NUM_NODES=3 KUBE_SUBNET_CIDR=172.20.2.0/24 MASTER_INTERNAL_IP=172.20.0.9 kubernetes/cluster/kube-up.sh ``` Verify that you now have nodes in 3 zones: diff --git a/docs/admin/namespaces/OWNERS b/docs/admin/namespaces/OWNERS new file mode 100644 index 0000000000..1dac6f1017 --- /dev/null +++ b/docs/admin/namespaces/OWNERS @@ -0,0 +1,4 @@ +assignees: +- derekwaynecarr +- janetkuo + diff --git a/docs/admin/namespaces/index.md b/docs/admin/namespaces/index.md index 2b9f14e835..574f41b10a 100644 --- a/docs/admin/namespaces/index.md +++ b/docs/admin/namespaces/index.md @@ -1,4 +1,8 @@ --- +assignees: +- derekwaynecarr +- janetkuo + --- A Namespace is a mechanism to partition resources created by users into @@ -46,6 +50,7 @@ kube-system Active ``` Kubernetes starts with two initial namespaces: + * `default` The default namespace for objects with no other namespace * `kube-system` The namespace for objects created by the Kubernetes system @@ -98,17 +103,20 @@ metadata: name: ``` -Note that the name of your namespace must be a DNS compatible label. - -More information on the `finalizers` field can be found in the namespace [design doc](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/namespaces.md#finalizers). - Then run: ```shell $ kubectl create -f ./my-namespace.yaml ``` -## Working in namespaces +Note that the name of your namespace must be a DNS compatible label. + +There's an optional field `finalizers`, which allows observables to purge resources whenever the namespace is deleted. Keep in mind that if you specify a nonexistent finalizer, the namespace will be created but will get stuck in the `Terminating` state if the user tries to delete it. + +More information on `finalizers` can be found in the namespace [design doc](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/namespaces.md#finalizers). + + +### Working in namespaces See [Setting the namespace for a request](/docs/user-guide/namespaces/#setting-the-namespace-for-a-request) and [Setting the namespace preference](/docs/user-guide/namespaces/#setting-the-namespace-preference). diff --git a/docs/admin/namespaces/walkthrough.md b/docs/admin/namespaces/walkthrough.md index e3b87c7f65..2a3e6298ea 100644 --- a/docs/admin/namespaces/walkthrough.md +++ b/docs/admin/namespaces/walkthrough.md @@ -1,4 +1,8 @@ --- +assignees: +- derekwaynecarr +- janetkuo + --- Kubernetes _namespaces_ help different projects, teams, or customers to share a Kubernetes cluster. diff --git a/docs/admin/network-plugins.md b/docs/admin/network-plugins.md index 4034c8a467..ee85126961 100644 --- a/docs/admin/network-plugins.md +++ b/docs/admin/network-plugins.md @@ -1,6 +1,14 @@ --- +assignees: +- dcbw +- freehan +- thockin + --- +* TOC +{:toc} + __Disclaimer__: Network plugins are in alpha. Its contents will change rapidly. Network plugins in Kubernetes come in a few flavors: @@ -18,24 +26,31 @@ The kubelet has a single default network plugin, and a default network common to ## Network Plugin Requirements -Besides providing the [`NetworkPlugin` interface](https://github.com/kubernetes/kubernetes/tree/{{page.version}}/pkg/kubelet/network/plugins.go) to configure and clean up pod networking, the plugin may also need specific support for kube-proxy. The iptables proxy obviously depends on iptables, and the plugin may need to ensure that container traffic is made available to iptables. For example, if the plugin connects containers to a Linux bridge, the plugin must set the `net/bridge/bridge-nf-call-iptables` sysctl to `1` to ensure that the iptables proxy functions correctly. If the plugin does not use a Linux bridge (but instead something like Open vSwitch or some other mechanism) it should ensure container traffic is appropriately routed for the proxy. +Besides providing the [`NetworkPlugin` interface](https://github.com/kubernetes/kubernetes/tree/{{page.version}}.0/pkg/kubelet/network/plugins.go) to configure and clean up pod networking, the plugin may also need specific support for kube-proxy. The iptables proxy obviously depends on iptables, and the plugin may need to ensure that container traffic is made available to iptables. For example, if the plugin connects containers to a Linux bridge, the plugin must set the `net/bridge/bridge-nf-call-iptables` sysctl to `1` to ensure that the iptables proxy functions correctly. If the plugin does not use a Linux bridge (but instead something like Open vSwitch or some other mechanism) it should ensure container traffic is appropriately routed for the proxy. By default if no kubelet network plugin is specified, the `noop` plugin is used, which sets `net/bridge/bridge-nf-call-iptables=1` to ensure simple configurations (like docker with a bridge) work correctly with the iptables proxy. ### Exec -Place plugins in `network-plugin-dir/plugin-name/plugin-name`, i.e if you have a bridge plugin and `network-plugin-dir` is `/usr/lib/kubernetes`, you'd place the bridge plugin executable at `/usr/lib/kubernetes/bridge/bridge`. See [this comment](https://github.com/kubernetes/kubernetes/tree/{{page.version}}/pkg/kubelet/network/exec/exec.go) for more details. +Place plugins in `network-plugin-dir/plugin-name/plugin-name`, i.e if you have a bridge plugin and `network-plugin-dir` is `/usr/lib/kubernetes`, you'd place the bridge plugin executable at `/usr/lib/kubernetes/bridge/bridge`. See [this comment](https://github.com/kubernetes/kubernetes/tree/{{page.version}}.0/pkg/kubelet/network/exec/exec.go) for more details. ### CNI -The CNI plugin is selected by passing Kubelet the `--network-plugin=cni` command-line option. Kubelet reads the first CNI configuration file from `--network-plugin-dir` and uses the CNI configuration from that file to set up each pod's network. The CNI configuration file must match the [CNI specification](https://github.com/appc/cni/blob/master/SPEC.md), and any required CNI plugins referenced by the configuration must be present in `/opt/cni/bin`. +The CNI plugin is selected by passing Kubelet the `--network-plugin=cni` command-line option. Kubelet reads the first CNI configuration file from `--network-plugin-dir` and uses the CNI configuration from that file to set up each pod's network. The CNI configuration file must match the [CNI specification](https://github.com/containernetworking/cni/blob/master/SPEC.md), and any required CNI plugins referenced by the configuration must be present in `/opt/cni/bin`. ### kubenet -The Linux-only kubenet plugin provides functionality similar to the `--configure-cbr0` kubelet command-line option. It creates a Linux bridge named `cbr0` and creates a veth pair for each pod with the host end of each pair connected to `cbr0`. The pod end of the pair is assigned an IP address allocated from a range assigned to the node through either configuration or by the controller-manager. `cbr0` is assigned an MTU matching the smallest MTU of an enabled normal interface on the host. The kubenet plugin is currently mutually exclusive with, and will eventually replace, the --configure-cbr0 option. It is also currently incompatible with the flannel experimental overlay. +The Linux-only kubenet plugin provides functionality similar to the `--configure-cbr0` kubelet command-line option. It creates a Linux bridge named `cbr0` and creates a veth pair for each pod with the host end of each pair connected to `cbr0`. The pod end of the pair is assigned an IP address allocated from a range assigned to the node either through configuration or by the controller-manager. `cbr0` is assigned an MTU matching the smallest MTU of an enabled normal interface on the host. The kubenet plugin is currently mutually exclusive with, and will eventually replace, the --configure-cbr0 option. It is also currently incompatible with the flannel experimental overlay. The plugin requires a few things: -* The standard CNI `bridge` and `host-local` plugins to be placed in `/opt/cni/bin`. + +* The standard CNI `bridge` and `host-local` plugins are required. Kubenet will first search for them in `/opt/cni/bin`. Specify `network-plugin-dir` to supply additional search path. The first found match will take effect. * Kubelet must be run with the `--network-plugin=kubenet` argument to enable the plugin * Kubelet must also be run with the `--reconcile-cidr` argument to ensure the IP subnet assigned to the node by configuration or the controller-manager is propagated to the plugin -* The node must be assigned an IP subnet through either the `--pod-cidr` kubelet command-line option or the `--allocate-node-cidrs=true --cluster-cidr=` controller-manager command-line options. \ No newline at end of file +* The node must be assigned an IP subnet through either the `--pod-cidr` kubelet command-line option or the `--allocate-node-cidrs=true --cluster-cidr=` controller-manager command-line options. + +## Usage Summary + +* `--network-plugin=exec` specifies that we use the `exec` plugin, with executables located in `--network-plugin-dir`. +* `--network-plugin=cni` specifies that we use the `cni` network plugin with actual CNI plugin binaries located in `/opt/cni/bin` and CNI plugin configuration located in `network-plugin-dir`, config location defaults to `/etc/cni/net.d`. +* `--network-plugin=kubenet` specifies that we use the `kubenet` network plugin with CNI `bridge` and `host-local` plugins placed in `/opt/cni/bin` or `network-plugin-dir`. \ No newline at end of file diff --git a/docs/admin/networking.md b/docs/admin/networking.md index 3557d7da49..cd8aaa09cf 100644 --- a/docs/admin/networking.md +++ b/docs/admin/networking.md @@ -1,4 +1,8 @@ --- +assignees: +- lavalamp +- thockin + --- Kubernetes approaches networking somewhat differently than Docker does by @@ -156,9 +160,9 @@ Lars Kellogg-Stedman. ### Weave Net from Weaveworks -[Weave Net](https://www.weave.works/documentation/net-1-5-0-introducing-weave/) is a +[Weave Net](https://www.weave.works/documentation/net-1-6-0-introducing-weave/) is a resilient and simple to use network for Kubernetes and its hosted applications. -Weave Net runs as a [CNI plug-in](https://www.weave.works/documentation/net-1-5-0-cni-plugin/) +Weave Net runs as a [CNI plug-in](https://www.weave.works/docs/net/latest/cni-plugin/) or stand-alone. In either version, it doesn’t require any configuration or extra code to run, and in both cases, the network provides one IP address per pod - as is standard for Kubernetes. @@ -177,10 +181,13 @@ complicated way to build an overlay network. This is endorsed by several of the "Big Shops" for networking. -### Calico +### Project Calico -[Calico](https://github.com/projectcalico/calico-containers) uses BGP to enable real container -IPs. +[Project Calico](https://github.com/projectcalico/calico-containers/blob/master/docs/cni/kubernetes/README.md) is an open source container networking provider and network policy engine. + +Calico provides a highly scalable networking and network policy solution for connecting Kubernetes pods based on the same IP networking principles as the internet. Calico can be deployed without encapsulation or overlays to provide high-performance, high-scale data center networking. Calico also provides fine-grained, intent based network security policy for Kubernetes pods via its distributed firewall. + +Calico can also be run in policy enforcement mode in conjunction with other networking solutions such as Flannel, aka [canal](https://github.com/tigera/canal), or native GCE networking. ### Romana diff --git a/docs/admin/node-problem.md b/docs/admin/node-problem.md new file mode 100644 index 0000000000..fdb557311c --- /dev/null +++ b/docs/admin/node-problem.md @@ -0,0 +1,249 @@ +--- +assignees: +- Random-Liu +- dchen1107 + +--- + +* TOC +{:toc} + +## Node Problem Detector + +*Node problem detector* is a [DaemonSet](/docs/admin/daemons/) monitoring the +node health. It collects node problems from various daemons and reports them +to the apiserver as [NodeCondition](/docs/admin/node/#node-condition) and +[Event](/docs/api-reference/v1/definitions/#_v1_event). + +It supports some known kernel issue detection now, and will detect more and +more node problems over time. + +Currently Kubernetes won't take any action on the node conditions and events +generated by node problem detector. In the future, a remedy system could be +introduced to deal with node problems. + +See more information +[here](https://github.com/kubernetes/node-problem-detector). + +## Limitations + +* The kernel issue detection of node problem detector only supports file based +kernel log now. It doesn't support log tools like journald. + +* The kernel issue detection of node problem detector has assumption on kernel +log format, now it only works on Ubuntu and Debian. However, it is easy to extend +it to [support other log format](/docs/admin/node-problem/#support-other-log-format). + +## Enable/Disable in GCE cluster + +Node problem detector is [running as a cluster +addon](/docs/admin/cluster-large/#addon-resources) enabled by default in the +gce cluster. + +You can enable/disable it by setting the environment variable +`KUBE_ENABLE_NODE_PROBLEM_DETECTOR` before `kube-up.sh`. + +## Use in Other Environment + +To enable node problem detector in other environment outside of GCE, you can use +either `kubectl` or addon pod. + +### Kubectl + +This is the recommanded way to start node problem detector outside of GCE. It +provides more flexible management, such as overwriting the default +configuration to fit it into your environment or detect +customized node problems. + +* **Step 1:** Create `node-problem-detector.yaml`: + +```yaml +apiVersion: extensions/v1beta1 +kind: DaemonSet +metadata: + name: node-problem-detector-v0.1 + namespace: kube-system + labels: + k8s-app: node-problem-detector + version: v0.1 + kubernetes.io/cluster-service: "true" +spec: + template: + metadata: + labels: + k8s-app: node-problem-detector + version: v0.1 + kubernetes.io/cluster-service: "true" + spec: + hostNetwork: true + containers: + - name: node-problem-detector + image: gcr.io/google_containers/node-problem-detector:v0.1 + securityContext: + privileged: true + resources: + limits: + cpu: "200m" + memory: "100Mi" + requests: + cpu: "20m" + memory: "20Mi" + volumeMounts: + - name: log + mountPath: /log + readOnly: true + volumes: + - name: log + hostPath: + path: /var/log/ +``` + +***Notice that you should make sure the system log directory is right for your +OS distro.*** + +* **Step 2:** Start node problem detector with `kubectl`: + +```shell +kubectl create -f node-problem-detector.yaml +``` + +### Addon Pod + +This is for those who have their own cluster bootstrap solution, and don't need +to overwrite the default configuration. They could leverage the addon pod to +further automate the deployment. + +Just create `node-problem-detector.yaml`, and put it under the addon pods directory +`/etc/kubernetes/addons/node-problem-detector` on master node. + +## Overwrite the Configuration + +The [default configuration](https://github.com/kubernetes/node-problem-detector/tree/v0.1/config) +is embedded when building the docker image of node problem detector. + +However, you can use [ConfigMap](/docs/user-guide/configmap/) to overwrite it +following the steps: + +* **Step 1:** Change the config files in `config/`. +* **Step 2:** Create the ConfigMap `node-problem-detector-config` with `kubectl create configmap +node-problem-detector-config --from-file=config/`. +* **Step 3:** Change the `node-problem-detector.yaml` to use the ConfigMap: + +```yaml +apiVersion: extensions/v1beta1 +kind: DaemonSet +metadata: + name: node-problem-detector-v0.1 + namespace: kube-system + labels: + k8s-app: node-problem-detector + version: v0.1 + kubernetes.io/cluster-service: "true" +spec: + template: + metadata: + labels: + k8s-app: node-problem-detector + version: v0.1 + kubernetes.io/cluster-service: "true" + spec: + hostNetwork: true + containers: + - name: node-problem-detector + image: gcr.io/google_containers/node-problem-detector:v0.1 + securityContext: + privileged: true + resources: + limits: + cpu: "200m" + memory: "100Mi" + requests: + cpu: "20m" + memory: "20Mi" + volumeMounts: + - name: log + mountPath: /log + readOnly: true + - name: config # Overwrite the config/ directory with ConfigMap volume + mountPath: /config + readOnly: true + volumes: + - name: log + hostPath: + path: /var/log/ + - name: config # Define ConfigMap volume + configMap: + name: node-problem-detector-config +``` + +* **Step 4:** Re-create the node problem detector with the new yaml file: + +```shell +kubectl delete -f node-problem-detector.yaml # If you have a node-problem-detector running +kubectl create -f node-problem-detector.yaml +``` + +***Notice that this approach only applies to node problem detector started with `kubectl`.*** + +For node problem detector running as cluster addon, because addon manager doesn't support +ConfigMap, configuration overwriting is not supported now. + +## Kernel Monitor + +*Kernel Monitor* is a problem daemon in node problem detector. It monitors kernel log +and detects known kernel issues following predefined rules. + +The Kernel Monitor matches kernel issues according to a set of predefined rule list in +[`config/kernel-monitor.json`](https://github.com/kubernetes/node-problem-detector/blob/v0.1/config/kernel-monitor.json). +The rule list is extensible, you can always extend it by [overwriting the +configuration](/docs/admin/node-problem/#overwrite-the-configuration). + +### Add New NodeConditions + +To support new node conditions, you can extend the `conditions` field in +`config/kernel-monitor.json` with new condition definition: + +```json +{ + "type": "NodeConditionType", + "reason": "CamelCaseDefaultNodeConditionReason", + "message": "arbitrary default node condition message" +} +``` + +### Detect New Problems + +To detect new problems, you can extend the `rules` field in `config/kernel-monitor.json` +with new rule definition: + +```json +{ + "type": "temporary/permanent", + "condition": "NodeConditionOfPermanentIssue", + "reason": "CamelCaseShortReason", + "message": "regexp matching the issue in the kernel log" +} +``` + +### Change Log Path + +Kernel log in different OS distros may locate in different path. The `log` +field in `config/kernel-monitor.json` is the log path inside the container. +You can always configure it to match your OS distro. + +### Support Other Log Format + +Kernel monitor uses [`Translator`](https://github.com/kubernetes/node-problem-detector/blob/v0.1/pkg/kernelmonitor/translator/translator.go) +plugin to translate kernel log the internal data structure. It is easy to +implement a new translator for a new log format. + +## Caveats + +It is recommanded to run the node problem detector in your cluster to monitor +the node health. However, you should be aware that this will introduce extra +resource overhead on each node. Usually this is fine, because: + +* The kernel log is generated relatively slowly. +* Resource limit is set for node problem detector. +* Even under high load, the resource usage is acceptable. +(see [benchmark result](https://github.com/kubernetes/node-problem-detector/issues/2#issuecomment-220255629)) diff --git a/docs/admin/node.md b/docs/admin/node.md index 13332012b8..1f1c89b4cb 100644 --- a/docs/admin/node.md +++ b/docs/admin/node.md @@ -1,4 +1,9 @@ --- +assignees: +- caesarxuchao +- dchen1107 +- lavalamp + --- * TOC @@ -47,15 +52,15 @@ must have appropriate conditions, see below. ### Node Condition -Node Condition describes the conditions of `Running` nodes. Currently the only -node condition is Ready. The Status of this condition can be True, False, or -Unknown. True means the Kubelet is healthy and ready to accept pods. -False means the Kubelet is not healthy and is not accepting pods. Unknown -means the Node Controller, which manages node lifecycle and is responsible for -setting the Status of the condition, has not heard from the -node recently (currently 40 seconds). -Node condition is represented as a json object. For example, -the following conditions mean the node is in sane state: +The `conditions` field describes the status of all `Running` nodes. + +| Node Condition | Description | +|----------------|-------------| +| `OutOfDisk` | `True` if insufficient free space on the node for adding new pods, otherwise `False` | +| `Ready` | `True` if the node is healthy ready to accept pods, `False` if the node is not healthy and is not accepting pods, and `Unknown` if the Node Controller has not heard from the node in the last 40 seconds | + +Node condition is represented as a JSON object. For example, the following response describes a healthy node: +conditions mean the node is in sane state: ```json "conditions": [ diff --git a/docs/admin/out-of-resource.md b/docs/admin/out-of-resource.md new file mode 100644 index 0000000000..16b8cc9e1e --- /dev/null +++ b/docs/admin/out-of-resource.md @@ -0,0 +1,225 @@ +--- +assignees: +- derekwaynecarr +- vishh +- timstclair + +--- + +* TOC +{:toc} + +The `kubelet` needs to preserve node stability when available compute resources are low. + +This is especially important when dealing with incompressible resources such as memory or disk. + +If either resource is exhausted, the node would become unstable. + +## Eviction Policy + +The `kubelet` can pro-actively monitor for and prevent against total starvation of a compute resource. In +cases where it could appear to occur, the `kubelet` can pro-actively fail one or more pods in order to reclaim +the starved resource. When the `kubelet` fails a pod, it terminates all containers in the pod, and the `PodPhase` +is transitioned to `Failed`. + +### Eviction Signals + +The `kubelet` can support the ability to trigger eviction decisions on the signals described in the +table below. The value of each signal is described in the description column based on the `kubelet` +summary API. + +| Eviction Signal | Description | +|------------------|---------------------------------------------------------------------------------| +| `memory.available` | `memory.available` := `node.status.capacity[memory]` - `node.stats.memory.workingSet` | + +In future releases, the `kubelet` will support the ability to trigger eviction decisions based on disk pressure. + +Until that time, it is recommended users take advantage of [garbage collection](/docs/admin/garbage-collection/). + +### Eviction Thresholds + +The `kubelet` supports the ability to specify eviction thresholds that trigger the `kubelet` to reclaim resources. + +Each threshold is of the following form: + +`` + +* valid `eviction-signal` tokens as defined above. +* valid `operator` tokens are `<` +* valid `quantity` tokens must match the quantity representation used by Kubernetes + +#### Soft Eviction Thresholds + +A soft eviction threshold pairs an eviction threshold with a required +administrator specified grace period. No action is taken by the `kubelet` +to reclaim resources associated with the eviction signal until that grace +period has been exceeded. If no grace period is provided, the `kubelet` will +error on startup. + +In addition, if a soft eviction threshold has been met, an operator can +specify a maximum allowed pod termination grace period to use when evicting +pods from the node. If specified, the `kubelet` will use the lesser value among +the `pod.Spec.TerminationGracePeriodSeconds` and the max allowed grace period. +If not specified, the `kubelet` will kill pods immediately with no graceful +termination. + +To configure soft eviction thresholds, the following flags are supported: + +* `eviction-soft` describes a set of eviction thresholds (e.g. `memory.available<1.5Gi`) that if met over a +corresponding grace period would trigger a pod eviction. +* `eviction-soft-grace-period` describes a set of eviction grace periods (e.g. `memory.available=1m30s`) that +correspond to how long a soft eviction threshold must hold before triggering a pod eviction. +* `eviction-max-pod-grace-period` describes the maximum allowed grace period (in seconds) to use when terminating +pods in response to a soft eviction threshold being met. + +#### Hard Eviction Thresholds + +A hard eviction threshold has no grace period, and if observed, the `kubelet` +will take immediate action to reclaim the associated starved resource. If a +hard eviction threshold is met, the `kubelet` will kill the pod immediately +with no graceful termination. + +To configure hard eviction thresholds, the following flag is supported: + +* `eviction-hard` describes a set of eviction thresholds (e.g. `memory.available<1Gi`) that if met +would trigger a pod eviction. + +### Eviction Monitoring Interval + +The `kubelet` evaluates eviction thresholds per its configured housekeeping interval. + +* `housekeeping-interval` is the interval between container housekeepings. + +### Node Conditions + +The `kubelet` will map one or more eviction signals to a corresponding node condition. + +If a hard eviction threshold has been met, or a soft eviction threshold has been met +independent of its associated grace period, the `kubelet` will report a condition that +reflects the node is under pressure. + +The following node conditions are defined that correspond to the specified eviction signal. + +| Node Condition | Eviction Signal | Description | +|----------------|------------------|------------------------------------------------------------------| +| `MemoryPressure` | `memory.available` | Available memory on the node has satisfied an eviction threshold | + +The `kubelet` will continue to report node status updates at the frequency specified by +`--node-status-update-frequency` which defaults to `10s`. + +### Oscillation of node conditions + +If a node is oscillating above and below a soft eviction threshold, but not exceeding +its associated grace period, it would cause the corresponding node condition to +constantly oscillate between true and false, and could cause poor scheduling decisions +as a consequence. + +To protect against this oscillation, the following flag is defined to control how +long the `kubelet` must wait before transitioning out of a pressure condition. + +* `eviction-pressure-transition-period` is the duration for which the `kubelet` has +to wait before transitioning out of an eviction pressure condition. + +The `kubelet` would ensure that it has not observed an eviction threshold being met +for the specified pressure condition for the period specified before toggling the +condition back to `false`. + +### Eviction of Pods + +If an eviction threshold has been met and the grace period has passed, +the `kubelet` will initiate the process of evicting pods until it has observed +the signal has gone below its defined threshold. + +The `kubelet` ranks pods for eviction 1) by their quality of service, +2) and among those with the same quality of service by the consumption of the +starved compute resource relative to the pods scheduling request. + +* `BestEffort` pods that consume the most of the starved resource are failed +first. +* `Burstable` pods that consume the greatest amount of the starved resource +relative to their request for that resource are killed first. If no pod +has exceeded its request, the strategy targets the largest consumer of the +starved resource. +* `Guaranteed` pods that consume the greatest amount of the starved resource +relative to their request are killed first. If no pod has exceeded its request, +the strategy targets the largest consumer of the starved resource. + +A `Guaranteed` pod is guaranteed to never be evicted because of another pod's +resource consumption. If a system daemon (i.e. `kubelet`, `docker`, `journald`, etc.) +is consuming more resources than were reserved via `system-reserved` or `kube-reserved` allocations, +and the node only has `Guaranteed` pod(s) remaining, then the node must choose to evict a +`Guaranteed` pod in order to preserve node stability, and to limit the impact +of the unexpected consumption to other `Guaranteed` pod(s). + +### Scheduler + +The node will report a condition when a compute resource is under pressure. The +scheduler views that condition as a signal to dissuade placing additional +pods on the node. + +| Node Condition | Scheduler Behavior | +| ---------------- | ------------------------------------------------ | +| `MemoryPressure` | `BestEffort` pods are not scheduled to the node. | + +## Node OOM Behavior + +If the node experiences a system OOM (out of memory) event prior to the `kubelet` is able to reclaim memory, +the node depends on the [oom_killer](https://lwn.net/Articles/391222/) to respond. + +The `kubelet` sets a `oom_score_adj` value for each container based on the quality of service for the pod. + +| Quality of Service | oom_score_adj | +| ----------------- | ------------- | +| `Guaranteed` | -998 | +| `BestEffort` | 1000 | +| `Burstable` | min(max(2, 1000 - (1000 * memoryRequestBytes) / machineMemoryCapacityBytes), 999) | + +If the `kubelet` is unable to reclaim memory prior to a node experiencing system OOM, the `oom_killer` will calculate +an `oom_score` based on the percentage of memory its using on the node, and then add the `oom_score_adj` to get an +effective `oom_score` for the container, and then kills the container with the highest score. + +The intended behavior should be that containers with the lowest quality of service that +are consuming the largest amount of memory relative to the scheduling request should be killed first in order +to reclaim memory. + +Unlike pod eviction, if a pod container is OOM killed, it may be restarted by the `kubelet` based on its `RestartPolicy`. + +## Best Practices + +### Schedulable resources and eviction policies + +Let's imagine the following scenario: + +* Node memory capacity: `10Gi` +* Operator wants to reserve 10% of memory capacity for system daemons (kernel, `kubelet`, etc.) +* Operator wants to evict pods at 95% memory utilization to reduce thrashing and incidence of system OOM. + +To facilitate this scenario, the `kubelet` would be launched as follows: + +``` +--eviction-hard=memory.available<500Mi +--system-reserved=memory=1.5Gi +``` + +Implicit in this configuration is the understanding that "System reserved" should include the amount of memory +covered by the eviction threshold. + +To reach that capacity, either some pod is using more than its request, or the system is using more than `500Mi`. + +This configuration will ensure that the scheduler does not place pods on a node that immediately induce memory pressure +and trigger eviction assuming those pods use less than their configured request. + +### DaemonSet + +It is never desired for a `kubelet` to evict a pod that was derived from +a `DaemonSet` since the pod will immediately be recreated and rescheduled +back to the same node. + +At the moment, the `kubelet` has no ability to distinguish a pod created +from `DaemonSet` versus any other object. If/when that information is +available, the `kubelet` could pro-actively filter those pods from the +candidate set of pods provided to the eviction strategy. + +In general, it is strongly recommended that `DaemonSet` not +create `BestEffort` pods to avoid being identified as a candidate pod +for eviction. Instead `DaemonSet` should ideally launch `Guaranteed` pods. diff --git a/docs/admin/ovs-networking.md b/docs/admin/ovs-networking.md index f5a279339a..7a8f89506c 100644 --- a/docs/admin/ovs-networking.md +++ b/docs/admin/ovs-networking.md @@ -1,4 +1,8 @@ --- +assignees: +- lavalamp +- thockin + --- This document describes how OpenVSwitch is used to setup networking between pods across nodes. diff --git a/docs/admin/resourcequota/OWNERS b/docs/admin/resourcequota/OWNERS new file mode 100644 index 0000000000..dc809362b2 --- /dev/null +++ b/docs/admin/resourcequota/OWNERS @@ -0,0 +1,3 @@ +assignees: +- derekwaynecarr + diff --git a/docs/admin/resourcequota/best-effort.yaml b/docs/admin/resourcequota/best-effort.yaml new file mode 100644 index 0000000000..5bd6efdcfd --- /dev/null +++ b/docs/admin/resourcequota/best-effort.yaml @@ -0,0 +1,9 @@ +apiVersion: v1 +kind: ResourceQuota +metadata: + name: best-effort +spec: + hard: + pods: "10" + scopes: + - BestEffort diff --git a/docs/admin/resourcequota/compute-resources.yaml b/docs/admin/resourcequota/compute-resources.yaml new file mode 100644 index 0000000000..9757018f19 --- /dev/null +++ b/docs/admin/resourcequota/compute-resources.yaml @@ -0,0 +1,11 @@ +apiVersion: v1 +kind: ResourceQuota +metadata: + name: compute-resources +spec: + hard: + pods: "4" + requests.cpu: "1" + requests.memory: 1Gi + limits.cpu: "2" + limits.memory: 2Gi diff --git a/docs/admin/resourcequota/index.md b/docs/admin/resourcequota/index.md index 40559f058e..d3073848ba 100644 --- a/docs/admin/resourcequota/index.md +++ b/docs/admin/resourcequota/index.md @@ -1,32 +1,32 @@ --- +assignees: +- derekwaynecarr + --- When several users or teams share a cluster with a fixed number of nodes, there is a concern that one team could use more than its fair share of resources. -Resource quotas are a tool for administrators to address this concern. Resource quotas -work like this: +Resource quotas are a tool for administrators to address this concern. + +A resource quota, defined by a `ResourceQuota` object, provides constraints that limit +aggregate resource consumption per namespace. It can limit the quantity of objects that can +be created in a namespace by type, as well as the total amount of compute resources that may +be consumed by resources in that project. + +Resource quotas work like this: - Different teams work in different namespaces. Currently this is voluntary, but support for making this mandatory via ACLs is planned. -- The administrator creates a Resource Quota for each namespace. -- Users put compute resource requests on their pods. The sum of all resource requests across - all pods in the same namespace must not exceed any hard resource limit in any Resource Quota - document for the namespace. Note that we used to verify Resource Quota by taking the sum of - resource limits of the pods, but this was altered to use resource requests. Backwards compatibility - for those pods previously created is preserved because pods that only specify a resource limit have - their resource requests defaulted to match their defined limits. The user is only charged for the - resources they request in the Resource Quota versus their limits because the request is the minimum - amount of resource guaranteed by the cluster during scheduling. For more information on over commit, - see [compute-resources](/docs/user-guide/compute-resources). -- If creating a pod would cause the namespace to exceed any of the limits specified in the - the Resource Quota for that namespace, then the request will fail with HTTP status - code `403 FORBIDDEN`. -- If quota is enabled in a namespace and the user does not specify *requests* on the pod for each - of the resources for which quota is enabled, then the POST of the pod will fail with HTTP - status code `403 FORBIDDEN`. Hint: Use the LimitRange admission controller to force default - values of *limits* (then resource *requests* would be equal to *limits* by default, see - [admission controller](/docs/admin/admission-controllers)) before the quota is checked to avoid this problem. +- The administrator creates one or more Resource Quota objects for each namespace. +- Users create resources (pods, services, etc.) in the namespace, and the quota system + tracks usage to ensure it does not exceed hard resource limits defined in a Resource Quota. +- If creating or updating a resource violates a quota constraint, the request will fail with HTTP + status code `403 FORBIDDEN` with a message explaining the constraint that would have been violated. +- If quota is enabled in a namespace for compute resources like `cpu` and `memory`, users must specify + requests or limits for those values; otherwise, the quota system may reject pod creation. Hint: Use + the LimitRange admission controller to force defaults for pods that make no compute resource requirements. + See the [walkthrough](/docs/admin/resourcequota/walkthrough/) for an example to avoid this problem. Examples of policies that could be created using namespaces and quotas are: @@ -38,7 +38,7 @@ Examples of policies that could be created using namespaces and quotas are: In the case where the total capacity of the cluster is less than the sum of the quotas of the namespaces, there may be contention for resources. This is handled on a first-come-first-served basis. -Neither contention nor changes to quota will affect already-running pods. +Neither contention nor changes to quota will affect already created resources. ## Enabling Resource Quota @@ -55,27 +55,31 @@ Resource Quota is enforced in a particular namespace when there is a The total sum of [compute resources](/docs/user-guide/compute-resources) requested by pods in a namespace can be limited. The following compute resource types are supported: -| ResourceName | Description | +| Resource Name | Description | | ------------ | ----------- | -| cpu | Total cpu requests of containers | -| memory | Total memory requests of containers - -For example, `cpu` quota sums up the `resources.requests.cpu` fields of every -container of every pod in the namespace, and enforces a maximum on that sum. +| `cpu` | Across all pods in a non-terminal state, the sum of CPU requests cannot exceed this value. | +| `limits.cpu` | Across all pods in a non-terminal state, the sum of CPU limits cannot exceed this value. | +| `limits.memory` | Across all pods in a non-terminal state, the sum of memory limits cannot exceed this value. | +| `memory` | Across all pods in a non-terminal state, the sum of memory requests cannot exceed this value. | +| `requests.cpu` | Across all pods in a non-terminal state, the sum of CPU requests cannot exceed this value. | +| `requests.memory` | Across all pods in a non-terminal state, the sum of memory requests cannot exceed this value. | ## Object Count Quota The number of objects of a given type can be restricted. The following types are supported: -| ResourceName | Description | +| Resource Name | Description | | ------------ | ----------- | -| pods | Total number of pods | -| services | Total number of services | -| replicationcontrollers | Total number of replication controllers | -| resourcequotas | Total number of [resource quotas](/docs/admin/admission-controllers/#resourcequota) | -| secrets | Total number of secrets | -| persistentvolumeclaims | Total number of [persistent volume claims](/docs/user-guide/persistent-volumes/#persistentvolumeclaims) | +| `configmaps` | The total number of config maps that can exist in the namespace. | +| `persistentvolumeclaims` | The total number of [persistent volume claims](/docs/user-guide/persistent-volumes/#persistentvolumeclaims) that can exist in the namespace. | +| `pods` | The total number of pods in a non-terminal state that can exist in the namespace. A pod is in a terminal state if `status.phase in (Failed, Succeeded)` is true. | +| `replicationcontrollers` | The total number of replication controllers that can exist in the namespace. | +| `resourcequotas` | The total number of [resource quotas](/docs/admin/admission-controllers/#resourcequota) that can exist in the namespace. | +| `services` | The total number of services that can exist in the namespace. | +| `services.loadbalancers` | The total number of services of type load balancer that can exist in the namespace. | +| `services.nodeports` | The total number of services of type node port that can exist in the namespace. | +| `secrets` | The total number of secrets that can exist in the namespace. | For example, `pods` quota counts and enforces a maximum on the number of `pods` created in a single namespace. @@ -84,45 +88,107 @@ You might want to set a pods quota on a namespace to avoid the case where a user creates many small pods and exhausts the cluster's supply of Pod IPs. +## Quota Scopes + +Each quota can have an associated set of scopes. A quota will only measure usage for a resource if it matches +the intersection of enumerated scopes. + +When a scope is added to the quota, it limits the number of resources it supports to those that pertain to the scope. +Resources specified on the quota outside of the allowed set results in a validation error. + +| Scope | Description | +| ----- | ----------- | +| `Terminating` | Match pods where `spec.activeDeadlineSeconds >= 0` | +| `NotTerminating` | Match pods where `spec.activeDeadlineSeconds is nil` | +| `BestEffort` | Match pods that have best effort quality of service. | +| `NotBestEffort` | Match pods that do not have best effort quality of service. | + +The `BestEffort` scope restricts a quota to tracking the following resource: `pods` + +The `Terminating`, `NotTerminating`, and `NotBestEffort` scopes restrict a quota to tracking the following resources: + +* `cpu` +* `limits.cpu` +* `limits.memory` +* `memory` +* `pods` +* `requests.cpu` +* `requests.memory` + +## Requests vs Limits + +When allocating compute resources, each container may specify a request and a limit value for either CPU or memory. +The quota can be configured to quota either value. + +If the quota has a value specified for `requests.cpu` or `requests.memory`, then it requires that every incoming +container makes an explicit request for those resources. If the quota has a value specified for `limits.cpu` or `limits.memory`, +then it requires that every incoming container specifies an explict limit for those resources. + ## Viewing and Setting Quotas Kubectl supports creating, updating, and viewing quotas: ```shell -$ kubectl namespace myspace -$ cat < quota.json -{ - "apiVersion": "v1", - "kind": "ResourceQuota", - "metadata": { - "name": "quota" - }, - "spec": { - "hard": { - "memory": "1Gi", - "cpu": "20", - "pods": "10", - "services": "5", - "replicationcontrollers":"20", - "resourcequotas":"1" - } - } -} +$ kubectl create namespace myspace + +$ cat < compute-resources.yaml +apiVersion: v1 +kind: ResourceQuota +metadata: + name: compute-resources +spec: + hard: + pods: "4" + requests.cpu: "1" + requests.memory: 1Gi + limits.cpu: "2" + limits.memory: 2Gi EOF -$ kubectl create -f ./quota.json -$ kubectl get quota -NAME -quota -$ kubectl describe quota quota -Name: quota +$ kubectl create -f ./compute-resources.yaml --namespace=myspace + +$ cat < object-counts.yaml +apiVersion: v1 +kind: ResourceQuota +metadata: + name: object-counts +spec: + hard: + configmaps: "10" + persistentvolumeclaims: "4" + replicationcontrollers: "20" + secrets: "10" + services: "10" + services.loadbalancers: "2" +EOF +$ kubectl create -f ./object-counts.yaml --namespace=myspace + +$ kubectl get quota --namespace=myspace +NAME AGE +compute-resources 30s +object-counts 32s + +$ kubectl describe quota compute-resources --namespace=myspace +Name: compute-resources +Namespace: myspace +Resource Used Hard +-------- ---- ---- +limits.cpu 0 2 +limits.memory 0 2Gi +pods 0 4 +requests.cpu 0 1 +requests.memory 0 1Gi + +$ kubectl describe quota object-counts --namespace=myspace +Name: object-counts +Namespace: myspace Resource Used Hard -------- ---- ---- -cpu 0m 20 -memory 0 1Gi -pods 5 10 -replicationcontrollers 5 20 -resourcequotas 1 1 -services 3 5 +configmaps 0 10 +persistentvolumeclaims 0 4 +replicationcontrollers 0 20 +secrets 1 10 +services 0 10 +services.loadbalancers 0 2 ``` ## Quota and Cluster Capacity diff --git a/docs/admin/resourcequota/not-best-effort.yaml b/docs/admin/resourcequota/not-best-effort.yaml new file mode 100644 index 0000000000..82666058e1 --- /dev/null +++ b/docs/admin/resourcequota/not-best-effort.yaml @@ -0,0 +1,13 @@ +apiVersion: v1 +kind: ResourceQuota +metadata: + name: not-best-effort +spec: + hard: + pods: "4" + requests.cpu: "1" + requests.memory: 1Gi + limits.cpu: "2" + limits.memory: 2Gi + scopes: + - NotBestEffort diff --git a/docs/admin/resourcequota/object-counts.yaml b/docs/admin/resourcequota/object-counts.yaml new file mode 100644 index 0000000000..b36f14611a --- /dev/null +++ b/docs/admin/resourcequota/object-counts.yaml @@ -0,0 +1,9 @@ +apiVersion: v1 +kind: ResourceQuota +metadata: + name: object-counts +spec: + hard: + persistentvolumeclaims: "2" + services.loadbalancers: "2" + services.nodeports: "0" \ No newline at end of file diff --git a/docs/admin/resourcequota/quota.yaml b/docs/admin/resourcequota/quota.yaml deleted file mode 100644 index 6885efc6d1..0000000000 --- a/docs/admin/resourcequota/quota.yaml +++ /dev/null @@ -1,14 +0,0 @@ -apiVersion: v1 -kind: ResourceQuota -metadata: - name: quota -spec: - hard: - cpu: "20" - memory: 1Gi - persistentvolumeclaims: "10" - pods: "10" - replicationcontrollers: "20" - resourcequotas: "1" - secrets: "10" - services: "5" diff --git a/docs/admin/resourcequota/walkthrough.md b/docs/admin/resourcequota/walkthrough.md index eeacbddabf..7422f2abcf 100644 --- a/docs/admin/resourcequota/walkthrough.md +++ b/docs/admin/resourcequota/walkthrough.md @@ -1,12 +1,34 @@ --- +assignees: +- derekwaynecarr +- janetkuo + --- -This example demonstrates how [resource quota](/docs/admin/admission-controllers/#resourcequota) and -[limitsranger](/docs/admin/admission-controllers/#limitranger) can be applied to a Kubernetes namespace. -See [ResourceQuota design doc](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/admission_control_resource_quota.md) for more information. +This example demonstrates a typical setup to control for resource usage in a namespace. + +It demonstrates using the following resources: + +* [Namespace](/docs/admin/namespaces) +* [Resource Quota](/docs/admin/resourcequota/) +* [Limit Range](/docs/admin/limitrange/) This example assumes you have a functional Kubernetes setup. +## Scenario + +The cluster-admin is operating a cluster on behalf of a user population and the cluster-admin +wants to control the amount of resources that can be consumed in a particular namespace to promote +fair sharing of the cluster and control cost. + +The cluster-admin has the following goals: + +* Limit the amount of compute resource for running pods +* Limit the number of persistent volume claims to control access to storage +* Limit the number of load balancers to control cost +* Prevent the use of node ports to preserve scarce resources +* Provide default compute resource requests to enable better scheduling decisions + ## Step 1: Create a namespace This example will work in a custom namespace to demonstrate the concepts involved. @@ -14,151 +36,331 @@ This example will work in a custom namespace to demonstrate the concepts involve Let's create a new namespace called quota-example: ```shell -$ kubectl create namespace quota-example +$ kubectl create -f docs/admin/resourcequota/namespace.yaml namespace "quota-example" created -``` - -Note that `kubectl` commands will print the type and name of the resource created or mutated, which can then be used in subsequent commands: - -```shell $ kubectl get namespaces NAME STATUS AGE -default Active 50m -quota-example Active 2s +default Active 2m +kube-system Active 2m +quota-example Active 39s ``` -## Step 2: Apply a quota to the namespace +## Step 2: Apply an object-count quota to the namespace -By default, a pod will run with unbounded CPU and memory requests/limits. This means that any pod in the -system will be able to consume as much CPU and memory on the node that executes the pod. +The cluster-admin wants to control the following resources: -Users may want to restrict how much of the cluster resources a given namespace may consume -across all of its pods in order to manage cluster usage. To do this, a user applies a quota to -a namespace. A quota lets the user set hard limits on the total amount of node resources (cpu, memory) -and API resources (pods, services, etc.) that a namespace may consume. In term of resources, Kubernetes -checks the total resource *requests*, not resource *limits* of all containers/pods in the namespace. +* persistent volume claims +* load balancers +* node ports -Let's create a simple quota in our namespace: +Let's create a simple quota that controls object counts for those resource types in this namespace. ```shell -$ kubectl create -f docs/admin/resourcequota/quota.yaml --namespace=quota-example -resourcequota "quota" created +$ kubectl create -f docs/admin/resourcequota/object-counts.yaml --namespace=quota-example +resourcequota "object-counts" created ``` -Once your quota is applied to a namespace, the system will restrict any creation of content -in the namespace until the quota usage has been calculated. This should happen quickly. +The quota system will observe that a quota has been created, and will calculate consumption +in the namespace in response. This should happen quickly. -You can describe your current quota usage to see what resources are being consumed in your -namespace. +Let's describe the quota to see what is currently being consumed in this namespace: ```shell -$ kubectl describe quota quota --namespace=quota-example -Name: quota -Namespace: quota-example -Resource Used Hard --------- ---- ---- -cpu 0 20 -memory 0 1Gi -persistentvolumeclaims 0 10 -pods 0 10 -replicationcontrollers 0 20 -resourcequotas 1 1 -secrets 1 10 -services 0 5 +$ kubectl describe quota object-counts --namespace=quota-example +Name: object-counts +Namespace: quota-example +Resource Used Hard +-------- ---- ---- +persistentvolumeclaims 0 2 +services.loadbalancers 0 2 +services.nodeports 0 0 ``` -## Step 3: Applying default resource requests and limits +The quota system will now prevent users from creating more than the specified amount for each resource. + + +## Step 3: Apply a compute-resource quota to the namespace + +To limit the amount of compute resource that can be consumed in this namespace, +let's create a quota that tracks compute resources. + +```shell +$ kubectl create -f docs/admin/resourcequota/compute-resources.yaml --namespace=quota-example +resourcequota "compute-resources" created +``` + +Let's describe the quota to see what is currently being consumed in this namespace: + +```shell +$ kubectl describe quota compute-resources --namespace=quota-example +Name: compute-resources +Namespace: quota-example +Resource Used Hard +-------- ---- ---- +limits.cpu 0 2 +limits.memory 0 2Gi +pods 0 4 +requests.cpu 0 1 +requests.memory 0 1Gi +``` + +The quota system will now prevent the namespace from having more than 4 non-terminal pods. In +addition, it will enforce that each container in a pod makes a `request` and defines a `limit` for +`cpu` and `memory`. + +## Step 4: Applying default resource requests and limits Pod authors rarely specify resource requests and limits for their pods. Since we applied a quota to our project, let's see what happens when an end-user creates a pod that has unbounded cpu and memory by creating an nginx container. -To demonstrate, lets create a Deployment that runs nginx: +To demonstrate, lets create a deployment that runs nginx: ```shell $ kubectl run nginx --image=nginx --replicas=1 --namespace=quota-example deployment "nginx" created ``` -This creates a Deployment "nginx" with its underlying resource, a ReplicaSet, which handles the creation and deletion of Pod replicas. Now let's look at the pods that were created. +Now let's look at the pods that were created. ```shell $ kubectl get pods --namespace=quota-example -NAME READY STATUS RESTARTS AGE ``` -What happened? I have no pods! Let's describe the ReplicaSet managed by the nginx Deployment to get a view of what is happening. -Note that `kubectl describe rs` works only on kubernetes cluster >= v1.2. If you are running older versions, use `kubectl describe rc` instead. -If you want to obtain the old behavior, use `--generator=run/v1` to create replication controllers. See [`kubectl run`](/docs/user-guide/kubectl/kubectl_run/) for more details. +What happened? I have no pods! Let's describe the deployment to get a view of what is happening. ```shell -$ kubectl describe rs -l run=nginx --namespace=quota-example -Name: nginx-2040093540 -Namespace: quota-example -Image(s): nginx -Selector: pod-template-hash=2040093540,run=nginx -Labels: pod-template-hash=2040093540,run=nginx -Replicas: 0 current / 1 desired -Pods Status: 0 Running / 0 Waiting / 0 Succeeded / 0 Failed -No volumes. -Events: - FirstSeen LastSeen Count From SubobjectPath Type Reason Message - --------- -------- ----- ---- ------------- -------- ------ ------- - 48s 26s 4 {replicaset-controller } Warning FailedCreate Error creating: pods "nginx-2040093540-" is forbidden: Failed quota: quota: must specify cpu,memory +$ kubectl describe deployment nginx --namespace=quota-example +Name: nginx +Namespace: quota-example +CreationTimestamp: Mon, 06 Jun 2016 16:11:37 -0400 +Labels: run=nginx +Selector: run=nginx +Replicas: 0 updated | 1 total | 0 available | 1 unavailable +StrategyType: RollingUpdate +MinReadySeconds: 0 +RollingUpdateStrategy: 1 max unavailable, 1 max surge +OldReplicaSets: +NewReplicaSet: nginx-3137573019 (0/1 replicas created) +... ``` -The Kubernetes API server is rejecting the ReplicaSet requests to create a pod because our pods -do not specify any memory usage *request*. +A deployment created a corresponding replica set and attempted to size it to create a single pod. -So let's set some default values for the amount of cpu and memory a pod can consume: +Let's look at the replica set to get more detail. + +```shell +$ kubectl describe rs nginx-3137573019 --namespace=quota-example +Name: nginx-3137573019 +Namespace: quota-example +Image(s): nginx +Selector: pod-template-hash=3137573019,run=nginx +Labels: pod-template-hash=3137573019 + run=nginx +Replicas: 0 current / 1 desired +Pods Status: 0 Running / 0 Waiting / 0 Succeeded / 0 Failed +No volumes. +Events: + FirstSeen LastSeen Count From SubobjectPath Type Reason Message + --------- -------- ----- ---- ------------- -------- ------ ------- + 4m 7s 11 {replicaset-controller } Warning FailedCreate Error creating: pods "nginx-3137573019-" is forbidden: Failed quota: compute-resources: must specify limits.cpu,limits.memory,requests.cpu,requests.memory +``` + +The Kubernetes API server is rejecting the replica set requests to create a pod because our pods +do not specify `requests` or `limits` for `cpu` and `memory`. + +So let's set some default values for the amount of `cpu` and `memory` a pod can consume: ```shell $ kubectl create -f docs/admin/resourcequota/limits.yaml --namespace=quota-example limitrange "limits" created $ kubectl describe limits limits --namespace=quota-example -Name: limits -Namespace: quota-example -Type Resource Min Max Default Request Default Limit Max Limit/Request Ratio ----- -------- --- --- --------------- ------------- ----------------------- -Container cpu - - 100m 200m - -Container memory - - 256Mi 512Mi - +Name: limits +Namespace: quota-example +Type Resource Min Max Default Request Default Limit Max Limit/Request Ratio +---- -------- --- --- --------------- ------------- ----------------------- +Container memory - - 256Mi 512Mi - +Container cpu - - 100m 200m - ``` -Now any time a pod is created in this namespace, if it has not specified any resource request/limit, the default -amount of cpu and memory per container will be applied, and the request will be used as part of admission control. +If the Kubernetes API server observes a request to create a pod in this namespace, and the containers +in that pod do not make any compute resource requests, a default request and default limit will be applied +as part of admission control. -Now that we have applied default resource *request* for our namespace, our Deployment should be able to -create its pods. +In this example, each pod created will have compute resources equivalent to the following: + +```shell +$ kubectl run nginx \ + --image=nginx \ + --replicas=1 \ + --requests=cpu=100m,memory=256Mi \ + --limits=cpu=200m,memory=512Mi \ + --namespace=quota-example +``` + +Now that we have applied default compute resources for our namespace, our replica set should be able to create +its pods. ```shell $ kubectl get pods --namespace=quota-example NAME READY STATUS RESTARTS AGE -nginx-2040093540-miohp 1/1 Running 0 5s +nginx-3137573019-fvrig 1/1 Running 0 6m ``` And if we print out our quota usage in the namespace: ```shell -$ kubectl describe quota quota --namespace=quota-example -Name: quota -Namespace: quota-example -Resource Used Hard --------- ---- ---- -cpu 100m 20 -memory 256Mi 1Gi -persistentvolumeclaims 0 10 -pods 1 10 -replicationcontrollers 1 20 -resourcequotas 1 1 -secrets 1 10 -services 0 5 +$ kubectl describe quota --namespace=quota-example +Name: compute-resources +Namespace: quota-example +Resource Used Hard +-------- ---- ---- +limits.cpu 200m 2 +limits.memory 512Mi 2Gi +pods 1 4 +requests.cpu 100m 1 +requests.memory 256Mi 1Gi + + +Name: object-counts +Namespace: quota-example +Resource Used Hard +-------- ---- ---- +persistentvolumeclaims 0 2 +services.loadbalancers 0 2 +services.nodeports 0 0 ``` -You can now see the pod that was created is consuming explicit amounts of resources (specified by resource *request*), and the usage is being tracked by the Kubernetes system properly. +As you can see, the pod that was created is consuming explict amounts of compute resources, and the usage is being +tracked by Kubernetes properly. + +## Step 5: Advanced quota scopes + +Let's imagine you did not want to specify default compute resource consumption in your namespace. + +Instead, you want to let users run a specific number of `BestEffort` pods in their namespace to take +advantage of slack compute resources, and then require that users make an explicit resource request for +pods that require a higher quality of service. + +Let's create a new namespace with two quotas to demonstrate this behavior: + +```shell +$ kubectl create namespace quota-scopes +namespace "quota-scopes" created +$ kubectl create -f docs/admin/resourcequota/best-effort.yaml --namespace=quota-scopes +resourcequota "best-effort" created +$ kubectl create -f docs/admin/resourcequota/not-best-effort.yaml --namespace=quota-scopes +resourcequota "not-best-effort" created +$ kubectl describe quota --namespace=quota-scopes +Name: best-effort +Namespace: quota-scopes +Scopes: BestEffort + * Matches all pods that have best effort quality of service. +Resource Used Hard +-------- ---- ---- +pods 0 10 + + +Name: not-best-effort +Namespace: quota-scopes +Scopes: NotBestEffort + * Matches all pods that do not have best effort quality of service. +Resource Used Hard +-------- ---- ---- +limits.cpu 0 2 +limits.memory 0 2Gi +pods 0 4 +requests.cpu 0 1 +requests.memory 0 1Gi +``` + +In this scenario, a pod that makes no compute resource requests will be tracked by the `best-effort` quota. + +A pod that does make compute resource requests will be tracked by the `not-best-effort` quota. + +Let's demonstrate this by creating two deployments: + +```shell +$ kubectl run best-effort-nginx --image=nginx --replicas=8 --namespace=quota-scopes +deployment "best-effort-nginx" created +$ kubectl run not-best-effort-nginx \ + --image=nginx \ + --replicas=2 \ + --requests=cpu=100m,memory=256Mi \ + --limits=cpu=200m,memory=512Mi \ + --namespace=quota-scopes +deployment "not-best-effort-nginx" created +``` + +Even though no default limits were specified, the `best-effort-nginx` deployment will create +all 8 pods. This is because it is tracked by the `best-effort` quota, and the `not-best-effort` +quota will just ignore it. The `not-best-effort` quota will track the `not-best-effort-nginx` +deployment since it creates pods with `Burstable` quality of service. + +Let's list the pods in the namespace: + +```shell +$ kubectl get pods --namespace=quota-scopes +NAME READY STATUS RESTARTS AGE +best-effort-nginx-3488455095-2qb41 1/1 Running 0 51s +best-effort-nginx-3488455095-3go7n 1/1 Running 0 51s +best-effort-nginx-3488455095-9o2xg 1/1 Running 0 51s +best-effort-nginx-3488455095-eyg40 1/1 Running 0 51s +best-effort-nginx-3488455095-gcs3v 1/1 Running 0 51s +best-effort-nginx-3488455095-rq8p1 1/1 Running 0 51s +best-effort-nginx-3488455095-udhhd 1/1 Running 0 51s +best-effort-nginx-3488455095-zmk12 1/1 Running 0 51s +not-best-effort-nginx-2204666826-7sl61 1/1 Running 0 23s +not-best-effort-nginx-2204666826-ke746 1/1 Running 0 23s +``` + +As you can see, all 10 pods have been allowed to be created. + +Let's describe current quota usage in the namespace: + +```shell +$ kubectl describe quota --namespace=quota-scopes +Name: best-effort +Namespace: quota-scopes +Scopes: BestEffort + * Matches all pods that have best effort quality of service. +Resource Used Hard +-------- ---- ---- +pods 8 10 + + +Name: not-best-effort +Namespace: quota-scopes +Scopes: NotBestEffort + * Matches all pods that do not have best effort quality of service. +Resource Used Hard +-------- ---- ---- +limits.cpu 400m 2 +limits.memory 1Gi 2Gi +pods 2 4 +requests.cpu 200m 1 +requests.memory 512Mi 1Gi +``` + +As you can see, the `best-effort` quota has tracked the usage for the 8 pods we created in +the `best-effort-nginx` deployment, and the `not-best-effort` quota has tracked the usage for +the 2 pods we created in the `not-best-effort-nginx` quota. + +Scopes provide a mechanism to subdivide the set of resources that are tracked by +any quota document to allow greater flexibility in how operators deploy and track resource +consumption. + +In addition to `BestEffort` and `NotBestEffort` scopes, there are scopes to restrict +long-running versus time-bound pods. The `Terminating` scope will match any pod +where `spec.activeDeadlineSeconds is not nil`. The `NotTerminating` scope will match any pod +where `spec.activeDeadlineSeconds is nil`. These scopes allow you to quota pods based on their +anticipated permanence on a node in your cluster. ## Summary -Actions that consume node resources for cpu and memory can be subject to hard quota limits defined by the namespace quota. The resource consumption is measured by resource *request* in pod specification. +Actions that consume node resources for cpu and memory can be subject to hard quota limits defined by the namespace quota. Any action that consumes those resources can be tweaked, or can pick up namespace level defaults to meet your end goal. + +Quota can be apportioned based on quality of service and anticipated permanence on a node in your cluster. diff --git a/docs/admin/salt.md b/docs/admin/salt.md index 6210e59055..2cb634d7c6 100644 --- a/docs/admin/salt.md +++ b/docs/admin/salt.md @@ -1,5 +1,9 @@ ---- ---- +--- +assignees: +- davidopp +- lavalamp + +--- The Kubernetes cluster can be configured using Salt. @@ -13,11 +17,11 @@ The **salt-minion** service runs on the kubernetes-master and each kubernetes-no Each salt-minion service is configured to interact with the **salt-master** service hosted on the kubernetes-master via the **master.conf** file [(except on GCE)](#standalone-salt-configuration-on-gce). -```shell +```shell [root@kubernetes-master] $ cat /etc/salt/minion.d/master.conf master: kubernetes-master -``` - +``` + The salt-master is contacted by each salt-minion and depending upon the machine information presented, the salt-master will provision the machine as either a kubernetes-master or kubernetes-node with all the required capabilities needed to run Kubernetes. If you are running the Vagrant based environment, the **salt-api** service is running on the kubernetes-master. It is configured to enable the vagrant user to introspect the salt cluster in order to find out about machines in the Vagrant environment via a REST API. @@ -34,27 +38,27 @@ All remaining sections that refer to master/minion setups should be ignored for Security is not enabled on the salt-master, and the salt-master is configured to auto-accept incoming requests from minions. It is not recommended to use this security configuration in production environments without deeper study. (In some environments this isn't as bad as it might sound if the salt master port isn't externally accessible and you trust everyone on your network.) -```shell +```shell [root@kubernetes-master] $ cat /etc/salt/master.d/auto-accept.conf open_mode: True auto_accept: True -``` - +``` + ## Salt minion configuration Each minion in the salt cluster has an associated configuration that instructs the salt-master how to provision the required resources on the machine. An example file is presented below using the Vagrant based environment. -```shell +```shell [root@kubernetes-master] $ cat /etc/salt/minion.d/grains.conf grains: etcd_servers: $MASTER_IP cloud: vagrant roles: - kubernetes-master -``` - +``` + Each hosting environment has a slightly different grains.conf file that is used to build conditional logic where required in the Salt files. The following enumerates the set of defined key/value pairs that are supported today. If you add new ones, please make sure to update this list. @@ -77,16 +81,16 @@ These keys may be leveraged by the Salt sls files to branch behavior. In addition, a cluster may be running a Debian based operating system or Red Hat based operating system (Centos, Fedora, RHEL, etc.). As a result, it's important to sometimes distinguish behavior based on operating system using if branches like the following. -```liquid +```liquid {% raw %} {% if grains['os_family'] == 'RedHat' %} // something specific to a RedHat environment (Centos, Fedora, RHEL) where you may use yum, systemd, etc. {% else %} // something specific to Debian environment (apt-get, initd) -{% endif %} +{% endif %} {% endraw %} -``` - +``` + ## Best Practices 1. When configuring default arguments for processes, it's best to avoid the use of EnvironmentFiles (Systemd in Red Hat environments) or init.d files (Debian distributions) to hold default values that should be common across operating system environments. This helps keep our Salt template files easy to understand for editors who may not be familiar with the particulars of each distribution. diff --git a/docs/admin/service-accounts-admin.md b/docs/admin/service-accounts-admin.md index 146f91310b..810f4d7515 100644 --- a/docs/admin/service-accounts-admin.md +++ b/docs/admin/service-accounts-admin.md @@ -1,4 +1,10 @@ --- +assignees: +- bprashanth +- davidopp +- lavalamp +- liggitt + --- *This is a Cluster Administrator guide to service accounts. It assumes knowledge of diff --git a/docs/admin/static-pods.md b/docs/admin/static-pods.md index a341376c8a..ea9468f31c 100644 --- a/docs/admin/static-pods.md +++ b/docs/admin/static-pods.md @@ -1,4 +1,7 @@ --- +assignees: +- jsafrane + --- **If you are running clustered Kubernetes and are using static pods to run a pod on every node, you should probably be using a [DaemonSet](/docs/admin/daemons/)!** diff --git a/docs/api-reference/README.md b/docs/api-reference/README.md new file mode 100644 index 0000000000..c16807023b --- /dev/null +++ b/docs/api-reference/README.md @@ -0,0 +1,20 @@ +--- +--- + +# API Reference + +Use the following reference docs to understand the kubernetes REST API for various API group versions: + +* v1: [operations](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/v1.3.0-beta.0/docs/api-reference/v1/operations.html), [model definitions](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/v1.3.0-beta.0/docs/api-reference/v1/definitions.html) +* extensions/v1beta1: [operations](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/v1.3.0-beta.0/docs/api-reference/extensions/v1beta1/operations.html), [model definitions](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/v1.3.0-beta.0/docs/api-reference/extensions/v1beta1/definitions.html) +* batch/v1: [operations](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/v1.3.0-beta.0/docs/api-reference/batch/v1/operations.html), [model definitions](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/v1.3.0-beta.0/docs/api-reference/batch/v1/definitions.html) +* autoscaling/v1: [operations](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/v1.3.0-beta.0/docs/api-reference/autoscaling/v1/operations.html), [model definitions](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/v1.3.0-beta.0/docs/api-reference/autoscaling/v1/definitions.html) + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/api-reference/README.md?pixel)]() + diff --git a/docs/api-reference/autoscaling/v1/definitions.html b/docs/api-reference/autoscaling/v1/definitions.html index 1ce0dfa376..232ba081fa 100755 --- a/docs/api-reference/autoscaling/v1/definitions.html +++ b/docs/api-reference/autoscaling/v1/definitions.html @@ -61,14 +61,14 @@

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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

    @@ -76,10 +76,24 @@

    gracePeriodSeconds

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

    -

    true

    +

    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

    + @@ -109,14 +123,14 @@

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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

    @@ -178,7 +192,7 @@

    kind

    -

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

    +

    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

    @@ -200,6 +214,10 @@ + +
    +

    *versioned.Event

    +

    unversioned.ListMeta

    @@ -233,7 +251,7 @@

    resourceVersion

    -

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

    +

    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

    @@ -241,6 +259,40 @@ +
    +
    +

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

    @@ -267,14 +319,14 @@

    kind

    -

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

    +

    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.2/docs/user-guide/identifiers.md#names

    +

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

    true

    string

    @@ -289,6 +341,61 @@ +
    +
    +

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

    @@ -315,28 +422,28 @@

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status.

    +

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

    false

    v1.HorizontalPodAutoscalerSpec

    @@ -377,28 +484,28 @@

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -434,6 +541,54 @@ +
    +
    +

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

    @@ -577,7 +732,7 @@

    name

    -

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

    +

    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

    @@ -588,7 +743,7 @@
    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.2/docs/devel/api-conventions.md#idempotency

    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#idempotency

    false

    string

    @@ -597,7 +752,7 @@ Applied only if Name is not specified. More info:

    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.2/docs/user-guide/namespaces.md

    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

    false

    string

    @@ -613,7 +768,7 @@ Must be a DNS_LABEL. Cannot be updated. More info:

    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.2/docs/user-guide/identifiers.md#uids

    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

    false

    string

    @@ -622,7 +777,7 @@ Populated by the system. Read-only. More info:

    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.2/docs/devel/api-conventions.md#concurrency-control-and-consistency

    +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

    @@ -638,7 +793,7 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a

    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.2/docs/devel/api-conventions.md#metadata

    +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

    @@ -647,7 +802,7 @@ Populated by the system. Read-only. Null for lists. More info:

    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.2/docs/devel/api-conventions.md#metadata

    +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

    @@ -661,21 +816,101 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    labels

    -

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

    +

    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

    -

    any

    +

    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.2/docs/user-guide/annotations.md

    +

    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

    -

    any

    +

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

    + +
    +
    +

    types.UID

    +

    unversioned.StatusCause

    @@ -728,44 +963,6 @@ Examples:
    -
    -
    -

    json.WatchEvent

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

    type

    the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR

    false

    string

    object

    the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR

    false

    string

    -

    any

    @@ -778,8 +975,8 @@ Examples:
    - + \ No newline at end of file diff --git a/docs/api-reference/autoscaling/v1/operations.html b/docs/api-reference/autoscaling/v1/operations.html index a0db63a947..2ad7f66bdc 100755 --- a/docs/api-reference/autoscaling/v1/operations.html +++ b/docs/api-reference/autoscaling/v1/operations.html @@ -41,7 +41,7 @@

    default

    success

    -

    string

    +

    unversioned.APIResourceList

    @@ -57,6 +57,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -70,6 +73,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -184,7 +190,7 @@

    200

    success

    -

    v1.HorizontalPodAutoscalerList

    +

    v1.HorizontalPodAutoscalerList

    @@ -210,6 +216,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -332,7 +341,7 @@

    200

    success

    -

    v1.HorizontalPodAutoscalerList

    +

    v1.HorizontalPodAutoscalerList

    @@ -358,6 +367,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -480,7 +492,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -506,6 +518,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -562,7 +577,7 @@

    body

    true

    -

    v1.HorizontalPodAutoscaler

    +

    v1.HorizontalPodAutoscaler

    @@ -596,7 +611,7 @@

    200

    success

    -

    v1.HorizontalPodAutoscaler

    +

    v1.HorizontalPodAutoscaler

    @@ -622,6 +637,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -728,7 +746,7 @@

    200

    success

    -

    v1.HorizontalPodAutoscaler

    +

    v1.HorizontalPodAutoscaler

    @@ -754,6 +772,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -810,7 +831,7 @@

    body

    true

    -

    v1.HorizontalPodAutoscaler

    +

    v1.HorizontalPodAutoscaler

    @@ -852,7 +873,7 @@

    200

    success

    -

    v1.HorizontalPodAutoscaler

    +

    v1.HorizontalPodAutoscaler

    @@ -878,6 +899,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -934,7 +958,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -976,7 +1000,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -1002,6 +1026,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1058,7 +1085,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -1100,7 +1127,7 @@

    200

    success

    -

    v1.HorizontalPodAutoscaler

    +

    v1.HorizontalPodAutoscaler

    @@ -1132,6 +1159,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1147,10 +1177,10 @@
    -

    replace status of the specified HorizontalPodAutoscaler

    +

    read status of the specified HorizontalPodAutoscaler

    -
    PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
    +
    GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
    @@ -1184,14 +1214,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1.HorizontalPodAutoscaler

    - - -

    PathParameter

    namespace

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

    @@ -1230,7 +1252,7 @@

    200

    success

    -

    v1.HorizontalPodAutoscaler

    +

    v1.HorizontalPodAutoscaler

    @@ -1256,6 +1278,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1271,10 +1296,10 @@
    -

    watch individual changes to a list of HorizontalPodAutoscaler

    +

    replace status of the specified HorizontalPodAutoscaler

    -
    GET /apis/autoscaling/v1/watch/horizontalpodautoscalers
    +
    PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
    @@ -1308,45 +1333,29 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.HorizontalPodAutoscaler

    + + + +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the HorizontalPodAutoscaler

    +

    true

    string

    - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -1370,7 +1379,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1.HorizontalPodAutoscaler

    @@ -1393,6 +1402,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1408,10 +1423,10 @@
    -

    watch individual changes to a list of HorizontalPodAutoscaler

    +

    partially update status of the specified HorizontalPodAutoscaler

    -
    GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers
    +
    PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
    @@ -1445,43 +1460,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    unversioned.Patch

    @@ -1492,6 +1475,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the HorizontalPodAutoscaler

    +

    true

    +

    string

    + + @@ -1515,7 +1506,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1.HorizontalPodAutoscaler

    @@ -1526,7 +1517,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -1538,6 +1535,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1553,10 +1556,10 @@
    -

    watch changes to an object of kind HorizontalPodAutoscaler

    +

    watch individual changes to a list of HorizontalPodAutoscaler

    -
    GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
    +
    GET /apis/autoscaling/v1/watch/horizontalpodautoscalers
    @@ -1629,22 +1632,6 @@

    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

    - - @@ -1668,7 +1655,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -1691,6 +1678,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -1705,13 +1701,329 @@ +
    +

    watch individual changes to a list of HorizontalPodAutoscaler

    +
    +
    +
    GET /apis/autoscaling/v1/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

    +
    +
      +
    • +

      apisautoscalingv1

      +
      • +
    +
    +
    +
    +
    +

    watch changes to an object of kind HorizontalPodAutoscaler

    +
    +
    +
    GET /apis/autoscaling/v1/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

    +
    +
      +
    • +

      apisautoscalingv1

      +
      • +
    +
    +
    +
    - + \ No newline at end of file diff --git a/docs/api-reference/batch/v1/definitions.html b/docs/api-reference/batch/v1/definitions.html index c822d573b3..c1b65d1513 100755 --- a/docs/api-reference/batch/v1/definitions.html +++ b/docs/api-reference/batch/v1/definitions.html @@ -31,6 +31,40 @@

    Definitions

    +

    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

    @@ -170,6 +204,13 @@

    string

    + +

    subPath

    +

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

    +

    false

    +

    string

    + + @@ -199,21 +240,21 @@

    server

    -

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

    +

    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.2/docs/user-guide/volumes.md#nfs

    +

    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.2/docs/user-guide/volumes.md#nfs

    +

    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

    @@ -249,7 +290,7 @@

    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

    -

    any

    +

    object

    @@ -288,7 +329,7 @@

    monitors

    -

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

    +

    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

    @@ -302,28 +343,28 @@

    user

    -

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

    +

    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.2/examples/cephfs/README.md#how-to-use-it

    +

    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.2/examples/cephfs/README.md#how-to-use-it

    +

    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.2/examples/cephfs/README.md#how-to-use-it

    +

    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

    @@ -542,28 +583,28 @@ Examples:

    pdName

    -

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

    +

    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.2/docs/user-guide/volumes.md#gcepersistentdisk

    +

    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.2/docs/user-guide/volumes.md#gcepersistentdisk

    +

    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.2/docs/user-guide/volumes.md#gcepersistentdisk

    +

    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

    @@ -634,7 +675,7 @@ Examples:

    name

    -

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

    +

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

    false

    string

    @@ -649,6 +690,10 @@ Examples:
    +
    +
    +

    *versioned.Event

    +

    unversioned.StatusDetails

    @@ -689,7 +734,7 @@ Examples:

    kind

    -

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

    +

    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

    @@ -888,7 +933,7 @@ Examples:

    name

    -

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

    +

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

    false

    string

    @@ -929,21 +974,21 @@ Examples:

    image

    -

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

    +

    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.2/docs/user-guide/containers.md#containers-and-commands

    +

    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.2/docs/user-guide/containers.md#containers-and-commands

    +

    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

    @@ -971,28 +1016,28 @@ Examples:

    resources

    -

    Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.2/docs/user-guide/persistent-volumes.md#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 filesyste. Cannot be updated.

    +

    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.2/docs/user-guide/pod-states.md#container-probes

    +

    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.2/docs/user-guide/pod-states.md#container-probes

    +

    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

    @@ -1013,14 +1058,14 @@ Examples:

    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.2/docs/user-guide/images.md#updating-images

    +

    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.2/docs/design/security_context.md

    +

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

    false

    v1.SecurityContext

    @@ -1098,7 +1143,7 @@ Examples:

    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] array

    +

    integer (int32) array

    @@ -1173,7 +1218,7 @@ Examples:

    conditions

    -

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

    +

    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

    v1.JobCondition array

    @@ -1242,7 +1287,7 @@ Examples:

    name

    -

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

    +

    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

    @@ -1253,7 +1298,7 @@ Examples:

    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.2/docs/devel/api-conventions.md#idempotency

    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#idempotency

    false

    string

    @@ -1262,7 +1307,7 @@ Applied only if Name is not specified. More info:

    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.2/docs/user-guide/namespaces.md

    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

    false

    string

    @@ -1278,7 +1323,7 @@ Must be a DNS_LABEL. Cannot be updated. More info:

    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.2/docs/user-guide/identifiers.md#uids

    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

    false

    string

    @@ -1287,7 +1332,7 @@ Populated by the system. Read-only. More info:

    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.2/docs/devel/api-conventions.md#concurrency-control-and-consistency

    +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

    @@ -1303,7 +1348,7 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a

    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.2/docs/devel/api-conventions.md#metadata

    +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

    @@ -1312,7 +1357,7 @@ Populated by the system. Read-only. Null for lists. More info:

    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.2/docs/devel/api-conventions.md#metadata

    +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

    @@ -1326,21 +1371,101 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    labels

    -

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

    +

    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

    -

    any

    +

    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.2/docs/user-guide/annotations.md

    +

    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

    -

    any

    +

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

    + +
    +
    +

    types.UID

    +

    v1.HostPathVolumeSource

    @@ -1367,7 +1492,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    path

    -

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

    +

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

    true

    string

    @@ -1477,7 +1602,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    fsType

    -

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

    +

    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

    @@ -1492,44 +1617,6 @@ Populated by the system when a graceful deletion is requested. Read-only. More i -
    -
    -

    json.WatchEvent

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

    type

    the type of watch event; may be ADDED, MODIFIED, DELETED, or ERROR

    false

    string

    object

    the object being watched; will match the type of the resource endpoint or be a Status object if the type is ERROR

    false

    string

    -

    v1.EmptyDirVolumeSource

    @@ -1556,7 +1643,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    medium

    -

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

    +

    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

    @@ -1596,21 +1683,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    volumeID

    -

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

    +

    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.2/examples/mysql-cinder-pd/README.md

    +

    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.2/examples/mysql-cinder-pd/README.md

    +

    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

    @@ -1713,7 +1800,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    claimName

    -

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

    +

    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

    @@ -1757,14 +1844,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    volumeID

    -

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

    +

    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.2/docs/user-guide/volumes.md#awselasticblockstore

    +

    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

    @@ -1778,7 +1865,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    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.2/docs/user-guide/volumes.md#awselasticblockstore

    +

    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

    @@ -1853,7 +1940,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    resourceVersion

    -

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

    +

    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

    @@ -1887,35 +1974,35 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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

    v1.JobSpec

    status

    -

    Status is a structure describing current status of a job. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#spec-and-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

    v1.JobStatus

    @@ -2018,21 +2105,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#metadata

    +

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

    false

    unversioned.ListMeta

    @@ -2076,11 +2163,18 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    secretName

    -

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

    +

    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

    + + @@ -2206,16 +2300,16 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    limits

    -

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

    +

    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

    -

    any

    +

    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.2/docs/design/resources.md#resource-specifications

    +

    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

    -

    any

    +

    object

    @@ -2261,7 +2355,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    secretRef

    -

    Optional: SecretRef is reference to the authentication secret for User, default is empty.

    +

    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

    @@ -2277,7 +2371,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    options

    Optional: Extra command options if any.

    false

    -

    any

    +

    object

    @@ -2315,6 +2409,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +

    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

    @@ -2357,14 +2458,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    metadata

    -

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.2/docs/devel/api-conventions.md#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.2/docs/devel/api-conventions.md#spec-and-status

    +

    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

    @@ -2413,6 +2514,47 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    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

    @@ -2439,14 +2581,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    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.2/docs/user-guide/jobs.md

    +

    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.2/docs/user-guide/jobs.md

    +

    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)

    @@ -2460,21 +2602,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    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.2/docs/user-guide/labels.md#label-selectors

    +

    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

    v1.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/release-1.2/docs/design/selector-generation.md

    +

    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/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.2/docs/user-guide/jobs.md

    +

    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

    @@ -2508,14 +2650,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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

    @@ -2523,10 +2665,24 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    gracePeriodSeconds

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

    -

    true

    +

    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

    + @@ -2556,35 +2712,35 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    name

    -

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

    +

    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.2/docs/user-guide/volumes.md#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.2/docs/user-guide/volumes.md#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.2/docs/user-guide/volumes.md#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.2/docs/user-guide/volumes.md#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

    @@ -2598,42 +2754,42 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    secret

    -

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

    +

    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.2/docs/user-guide/volumes.md#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.2/examples/iscsi/README.md

    +

    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.2/examples/glusterfs/README.md

    +

    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.2/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    +

    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.2/examples/rbd/README.md

    +

    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

    @@ -2647,7 +2803,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    cinder

    -

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

    +

    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

    @@ -2694,12 +2850,63 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    v1.ConfigMapVolumeSource

    + +

    vsphereVolume

    +

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

    +

    false

    +

    v1.VsphereVirtualDiskVolumeSource

    + +
    -

    integer

    +

    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

    @@ -2748,14 +2955,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    initialDelaySeconds

    -

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

    +

    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.2/docs/user-guide/pod-states.md#container-probes

    +

    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)

    @@ -2784,6 +2991,61 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

    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

    @@ -2810,7 +3072,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    name

    -

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

    +

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

    false

    string

    @@ -2851,28 +3113,28 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    kind

    -

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

    +

    Kind is a string value representing the 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.2/docs/devel/api-conventions.md#resources

    +

    APIVersion defines the versioned 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.2/docs/devel/api-conventions.md#types-kinds

    +

    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.2/docs/devel/api-conventions.md#spec-and-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

    @@ -2912,6 +3174,54 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    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

    @@ -2946,10 +3256,17 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    fieldRef

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

    -

    true

    +

    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

    + + @@ -2979,21 +3296,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    volumes

    -

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

    +

    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.2/docs/user-guide/containers.md

    +

    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.2/docs/user-guide/pod-states.md#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

    @@ -3021,14 +3338,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    nodeSelector

    -

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

    +

    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

    -

    any

    +

    object

    serviceAccountName

    -

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

    +

    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

    @@ -3077,11 +3394,25 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    imagePullSecrets

    -

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

    +

    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

    + + @@ -3173,14 +3504,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    postStart

    -

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

    +

    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.2/docs/user-guide/container-environment.md#hook-details

    +

    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

    @@ -3214,7 +3545,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    name

    -

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

    +

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

    false

    string

    @@ -3229,54 +3560,6 @@ Populated by the system when a graceful deletion is requested. Read-only. More i -
    -
    -

    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.2/examples/glusterfs/README.md#create-a-pod

    true

    string

    path

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

    true

    string

    readOnly

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

    false

    boolean

    false

    -

    v1.Handler

    @@ -3325,6 +3608,54 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
    +
    +

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

    @@ -3351,56 +3682,56 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    monitors

    -

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

    +

    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.2/examples/rbd/README.md#how-to-use-it

    +

    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.2/docs/user-guide/volumes.md#rbd

    +

    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.2/examples/rbd/README.md#how-to-use-it.

    -

    true

    +

    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.2/examples/rbd/README.md#how-to-use-it

    -

    true

    +

    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.2/examples/rbd/README.md#how-to-use-it

    -

    true

    +

    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 empty. More info: http://releases.k8s.io/release-1.2/examples/rbd/README.md#how-to-use-it

    -

    true

    +

    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.2/examples/rbd/README.md#how-to-use-it

    +

    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

    @@ -3420,7 +3751,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i
    diff --git a/docs/api-reference/batch/v1/operations.html b/docs/api-reference/batch/v1/operations.html index ae7d44159b..ce3327b500 100755 --- a/docs/api-reference/batch/v1/operations.html +++ b/docs/api-reference/batch/v1/operations.html @@ -41,7 +41,7 @@

    default

    success

    -

    string

    +

    unversioned.APIResourceList

    @@ -57,6 +57,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -70,6 +73,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -184,7 +190,7 @@

    200

    success

    -

    v1.JobList

    +

    v1.JobList

    @@ -210,6 +216,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -332,7 +341,7 @@

    200

    success

    -

    v1.JobList

    +

    v1.JobList

    @@ -358,6 +367,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -480,7 +492,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -506,6 +518,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -562,7 +577,7 @@

    body

    true

    -

    v1.Job

    +

    v1.Job

    @@ -596,7 +611,7 @@

    200

    success

    -

    v1.Job

    +

    v1.Job

    @@ -622,6 +637,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -728,7 +746,7 @@

    200

    success

    -

    v1.Job

    +

    v1.Job

    @@ -754,6 +772,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -810,7 +831,7 @@

    body

    true

    -

    v1.Job

    +

    v1.Job

    @@ -852,7 +873,7 @@

    200

    success

    -

    v1.Job

    +

    v1.Job

    @@ -878,6 +899,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -934,7 +958,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -976,7 +1000,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -1002,6 +1026,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1058,7 +1085,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -1100,7 +1127,7 @@

    200

    success

    -

    v1.Job

    +

    v1.Job

    @@ -1132,6 +1159,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1147,10 +1177,10 @@
    -

    replace status of the specified Job

    +

    read status of the specified Job

    -
    PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
    +
    GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
    @@ -1184,14 +1214,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1.Job

    - - -

    PathParameter

    namespace

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

    @@ -1230,7 +1252,7 @@

    200

    success

    -

    v1.Job

    +

    v1.Job

    @@ -1256,6 +1278,9 @@

  • application/yaml

    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1271,10 +1296,10 @@
    -

    watch individual changes to a list of Job

    +

    replace status of the specified Job

    -
    GET /apis/batch/v1/watch/jobs
    +
    PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
    @@ -1308,45 +1333,29 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.Job

    + + + +

    PathParameter

    +

    namespace

    +

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

    +

    true

    string

    -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    +

    PathParameter

    +

    name

    +

    name of the Job

    +

    true

    string

    - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    - - @@ -1370,7 +1379,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1.Job

    @@ -1393,6 +1402,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1408,10 +1423,10 @@
    -

    watch individual changes to a list of Job

    +

    partially update status of the specified Job

    -
    GET /apis/batch/v1/watch/namespaces/{namespace}/jobs
    +
    PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
    @@ -1445,43 +1460,11 @@ -

    QueryParameter

    -

    labelSelector

    -

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

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    - - -

    QueryParameter

    -

    fieldSelector

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    watch

    -

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

    -

    false

    -

    boolean

    - - - -

    QueryParameter

    -

    resourceVersion

    -

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

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    true

    +

    unversioned.Patch

    @@ -1492,6 +1475,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the Job

    +

    true

    +

    string

    + + @@ -1515,7 +1506,7 @@

    200

    success

    -

    json.WatchEvent

    +

    v1.Job

    @@ -1526,7 +1517,13 @@
    • -

      /

      +

      application/json-patch+json

      +
      • +
    • +

      application/merge-patch+json

      +
      • +
    • +

      application/strategic-merge-patch+json

    @@ -1538,6 +1535,12 @@

  • application/json

    • +
  • +

    application/yaml

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • @@ -1553,10 +1556,10 @@
    -

    watch changes to an object of kind Job

    +

    watch individual changes to a list of Job

    -
    GET /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}
    +
    GET /apis/batch/v1/watch/jobs
    @@ -1629,22 +1632,6 @@

    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

    - - @@ -1668,7 +1655,7 @@

    200

    success

    -

    json.WatchEvent

    +

    *versioned.Event

    @@ -1691,6 +1678,15 @@

  • application/json

    • +
  • +

    application/json;stream=watch

    +
    • +
  • +

    application/vnd.kubernetes.protobuf

    +
    • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
    • @@ -1705,13 +1701,329 @@ +
    +

    watch individual changes to a list of Job

    +
    +
    +
    GET /apis/batch/v1/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

    +
    +
      +
    • +

      apisbatchv1

      +
      • +
    +
    +
    +
    +
    +

    watch changes to an object of kind Job

    +
    +
    +
    GET /apis/batch/v1/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

    +
    +
      +
    • +

      apisbatchv1

      +
      • +
    +
    +
    +
    - + \ No newline at end of file diff --git a/docs/api-reference/extensions/v1beta1/definitions.html b/docs/api-reference/extensions/v1beta1/definitions.html new file mode 100755 index 0000000000..663419ea60 --- /dev/null +++ b/docs/api-reference/extensions/v1beta1/definitions.html @@ -0,0 +1,6020 @@ +--- +--- + + + + + + +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 a 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 a 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 a 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/docs/api-reference/extensions/v1beta1/definitions.md b/docs/api-reference/extensions/v1beta1/definitions.md index 624570626a..e124eab376 100644 --- a/docs/api-reference/extensions/v1beta1/definitions.md +++ b/docs/api-reference/extensions/v1beta1/definitions.md @@ -1,3 +1,15 @@ --- --- -{% include v1.2/extensions-v1beta1-definitions.html %} + +{% include v1.3/extensions-v1beta1-definitions.html %} + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/api-reference/extensions/v1beta1/definitions.md?pixel)]() + diff --git a/docs/api-reference/extensions/v1beta1/operations.html b/docs/api-reference/extensions/v1beta1/operations.html new file mode 100755 index 0000000000..b0e56bf69c --- /dev/null +++ b/docs/api-reference/extensions/v1beta1/operations.html @@ -0,0 +1,15663 @@ +--- +--- + + + + + + +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 a 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 a 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/docs/api-reference/extensions/v1beta1/operations.md b/docs/api-reference/extensions/v1beta1/operations.md index 19debfc6da..8d32dd5e9d 100644 --- a/docs/api-reference/extensions/v1beta1/operations.md +++ b/docs/api-reference/extensions/v1beta1/operations.md @@ -1,3 +1,15 @@ --- --- -{% include v1.2/extensions-v1beta1-operations.html %} + +{% include v1.3/extensions-v1beta1-operations.html %} + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/api-reference/extensions/v1beta1/operations.md?pixel)]() + diff --git a/docs/api-reference/v1/definitions.html b/docs/api-reference/v1/definitions.html new file mode 100755 index 0000000000..9e0ec44846 --- /dev/null +++ b/docs/api-reference/v1/definitions.html @@ -0,0 +1,7808 @@ +--- +--- + + + + + + +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 a 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 a 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 a 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. ["gcr.io/google_containers/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/docs/api-reference/v1/definitions.md b/docs/api-reference/v1/definitions.md index de7a131dcb..2e1b53938a 100644 --- a/docs/api-reference/v1/definitions.md +++ b/docs/api-reference/v1/definitions.md @@ -1,3 +1,15 @@ --- --- -{% include v1.2/v1-definitions.html %} + +{% include v1.3/v1-definitions.html %} + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/api-reference/v1/definitions.md?pixel)]() + diff --git a/docs/api-reference/v1/operations.html b/docs/api-reference/v1/operations.html new file mode 100755 index 0000000000..4f8d8286af --- /dev/null +++ b/docs/api-reference/v1/operations.html @@ -0,0 +1,32323 @@ +--- +--- + + + + + + +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 a 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 a 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 a 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 a 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/docs/api-reference/v1/operations.md b/docs/api-reference/v1/operations.md index 23023f6665..ec775b411b 100644 --- a/docs/api-reference/v1/operations.md +++ b/docs/api-reference/v1/operations.md @@ -1,3 +1,15 @@ --- --- -{% include v1.2/v1-operations.html %} + +{% include v1.3/v1-operations.html %} + + + + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/api-reference/v1/operations.md?pixel)]() + diff --git a/docs/api.md b/docs/api.md index e466962df2..aa9aea1d7f 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,4 +1,9 @@ --- +assignees: +- bgrant0607 +- erictune +- lavalamp + --- Primary system and API concepts are documented in the [User guide](/docs/user-guide/). @@ -25,13 +30,15 @@ Complete API details are documented using [Swagger v1.2](http://swagger.io/). Th We also host a version of the [latest API documentation UI](http://kubernetes.io/kubernetes/third_party/swagger-ui/). This is updated with the latest release, so if you are using a different version of Kubernetes you will want to use the spec from your apiserver. +Kubernetes implements an alternative Protobuf based serialization format for the API that is primarily intended for intra-cluster communication, documented in the [design proposal](https://github.com/kubernetes/kubernetes/blob/{{ page.githubbranch }}/docs/proposals/protobuf.md) and the IDL files for each schema are located in the Go packages that define the API objects. + ## API versioning To make it easier to eliminate fields or restructure resource representations, Kubernetes supports multiple API versions, each at a different API path, such as `/api/v1` or `/apis/extensions/v1beta1`. -We chose to version at the API level rather than at the resource or field level to ensure that the API presents a clear, consistent view of system resources and behavior, and to enable controlling access to end-of-lifed and/or experimental APIs. +We chose to version at the API level rather than at the resource or field level to ensure that the API presents a clear, consistent view of system resources and behavior, and to enable controlling access to end-of-lifed and/or experimental APIs. The JSON and Protobuf serialization schemas follow the same guidelines for schema changes - all descriptions below cover both formats. Note that API versioning and Software versioning are only indirectly related. The [API and release versioning proposal](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/versioning.md) describes the relationship between API versioning and diff --git a/docs/getting-started-guides/OWNERS b/docs/getting-started-guides/OWNERS new file mode 100644 index 0000000000..d13cb1c42c --- /dev/null +++ b/docs/getting-started-guides/OWNERS @@ -0,0 +1,3 @@ +assignees: +- errordeveloper + diff --git a/docs/getting-started-guides/alternatives.md b/docs/getting-started-guides/alternatives.md new file mode 100644 index 0000000000..b235ea0bdd --- /dev/null +++ b/docs/getting-started-guides/alternatives.md @@ -0,0 +1,9 @@ +--- +assignees: +- pwittrock +--- + +# *Stop. These guides are superseded by [Minikube](../minikube/). They are only listed here for completeness.* + +* [Using Vagrant](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/local-cluster/vagrant.md) +* *Advanced:* [Directly using Kubernetes raw binaries (Linux Only)](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/local-cluster/local.md) \ No newline at end of file diff --git a/docs/getting-started-guides/aws.md b/docs/getting-started-guides/aws.md index 319393c03c..df4a6cdeb3 100644 --- a/docs/getting-started-guides/aws.md +++ b/docs/getting-started-guides/aws.md @@ -1,4 +1,8 @@ --- +assignees: +- justinsb +- lavalamp + --- * TOC @@ -7,11 +11,11 @@ ## Prerequisites 1. You need an AWS account. Visit [http://aws.amazon.com](http://aws.amazon.com) to get started -2. Install and configure [AWS Command Line Interface](http://aws.amazon.com/cli) -3. You need an AWS [instance profile and role](http://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html) with EC2 full access. +2. Install and configure the [AWS Command Line Interface](http://aws.amazon.com/cli) +3. We recommend installing using an account which has full access to the AWS APIs. NOTE: This script use the 'default' AWS profile by default. -You may explicitly set AWS profile to use using the `AWS_DEFAULT_PROFILE` environment variable: +You may explicitly set the AWS profile to use using the `AWS_DEFAULT_PROFILE` environment variable: ```shell export AWS_DEFAULT_PROFILE=myawsprofile @@ -36,7 +40,7 @@ This process takes about 5 to 10 minutes. Once the cluster is up, the IP address as well as information about the default services running in the cluster (monitoring, logging, dns). User credentials and security tokens are written in `~/.kube/config`, they will be necessary to use the CLI or the HTTP Basic Auth. -By default, the script will provision a new VPC and a 4 node k8s cluster in us-west-2a (Oregon) with EC2 instances running on Ubuntu. +By default, the script will provision a new VPC and a 4 node k8s cluster in us-west-2a (Oregon) with EC2 instances running on Debian. You can override the variables defined in [config-default.sh](http://releases.k8s.io/{{page.githubbranch}}/cluster/aws/config-default.sh) to change this behavior as follows: ```shell @@ -46,17 +50,17 @@ export MASTER_SIZE=m3.medium export NODE_SIZE=m3.medium export AWS_S3_REGION=eu-west-1 export AWS_S3_BUCKET=mycompany-kubernetes-artifacts -export INSTANCE_PREFIX=k8s +export KUBE_AWS_INSTANCE_PREFIX=k8s ... ``` If you don't specify master and minion sizes, the scripts will attempt to guess the correct size of the master and worker nodes based on `${NUM_NODES}`. In -version 1.2 these default are: +version 1.3 these default are: -* For the master, for clusters of less than 150 nodes it will use an - `m3.medium`, for clusters of greater than 150 nodes it will use an - `m3.large`. +* For the master, for clusters of less than 5 nodes it will use an + `m3.medium`, for 6-10 nodes it will use an `m3.large`; + for 11-100 nodes it will use an `m3.xlarge`. * For worker nodes, for clusters less than 50 nodes it will use a `t2.micro`, for clusters between 50 and 150 nodes it will use a `t2.small` and for @@ -95,7 +99,10 @@ NOTE: If using an existing keypair named "kubernetes" then you must set the `AWS ### Alternatives -CoreOS maintains [a CLI tool](https://coreos.com/kubernetes/docs/latest/kubernetes-on-aws.html), `kube-aws` that will create and manage a Kubernetes cluster based on [CoreOS](http://www.coreos.com), using AWS tools: EC2, CloudFormation and Autoscaling. +* [kops](https://github.com/kubernetes/kops) "kubernetes-ops" is a complete Kubernetes cluster lifecycle management tool, + that supports AWS. + +* CoreOS maintains [a CLI tool](https://coreos.com/kubernetes/docs/latest/kubernetes-on-aws.html), `kube-aws` that will create and manage a Kubernetes cluster based on [CoreOS](http://www.coreos.com), using AWS tools: EC2, CloudFormation and Autoscaling. ## Getting started with your cluster @@ -127,6 +134,10 @@ The "Guestbook" application is another popular example to get started with Kuber For more complete applications, please look in the [examples directory](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/) +## Scaling the cluster + +Adding and removing nodes through `kubectl` is not supported. You can still scale the amount of nodes manually through adjustments of the 'Desired' and 'Max' properties within the [Auto Scaling Group](http://docs.aws.amazon.com/autoscaling/latest/userguide/as-manual-scaling.html), which was created during the installation. + ## Tearing down the cluster Make sure the environment variables you used to provision your cluster are still exported, then call the following script inside the @@ -139,10 +150,11 @@ cluster/kube-down.sh ## Support Level -IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level --------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ---------------------------- -AWS | CoreOS | CoreOS | flannel | [docs](/docs/getting-started-guides/aws) | | Community -AWS | Saltstack | Ubuntu | OVS | [docs](/docs/getting-started-guides/aws) | | Community ([@justinsb](https://github.com/justinsb)) +IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level +-------------------- | ------------ | ------------- | ---------- | --------------------------------------------- | ---------| ---------------------------- +AWS | Saltstack | Debian/Ubuntu | k8s (VPC) | [docs](/docs/getting-started-guides/aws) | | Community ([@justinsb](https://github.com/justinsb)) +AWS | kops | Debian | k8s (VPC) | [docs](https://github.com/kubernetes/kops) | | Community ([@justinsb](https://github.com/justinsb)) +AWS | CoreOS | CoreOS | flannel | [docs](/docs/getting-started-guides/aws) | | Community For support level information on all solutions, see the [Table of solutions](/docs/getting-started-guides/#table-of-solutions) chart. diff --git a/docs/getting-started-guides/azure.md b/docs/getting-started-guides/azure.md new file mode 100644 index 0000000000..bb01c8641d --- /dev/null +++ b/docs/getting-started-guides/azure.md @@ -0,0 +1,178 @@ +--- +assignees: +- colemickens +- jeffmendoza + +--- + +* TOC +{:toc} + + +## Prerequisites + +1. An Azure subscription. If you don't already have one, you may create one on [azure.microsoft.com](https://azure.microsoft.com). +2. An account with Owner access to the subscription. +3. Both `docker` and `jq` need to be installed and available on `$PATH`. + + +## Cluster operations + +### Cluster bring-up + +```shell +export KUBERNETES_PROVIDER=azure; curl -sS https://get.k8s.io | bash +``` + +Note: if you receive an error "the input device is not a TTY", then you need to start the deployment manually. + +```shell +cd ~/kubernetes +./cluster/kube-up.sh +``` + +NOTE: This script calls [cluster/kube-up.sh](http://releases.k8s.io/{{page.githubbranch}}/cluster/kube-up.sh) +which in turn calls [cluster/azure/util.sh](http://releases.k8s.io/{{page.githubbranch}}/cluster/azure/util.sh) +using [cluster/azure/config-default.sh](http://releases.k8s.io/{{page.githubbranch}}/cluster/azure/config-default.sh). + +You must set `AZURE_SUBSCRIPTION_ID` or you will receive errors. Prior to Kubernetes 1.3.0, you must also set `AZURE_TENANT_ID`. +These may be set in `cluster/azure/config-default.sh` or set as environment variables: + +```shell +export AZURE_SUBSCRIPTION_ID="" +export AZURE_TENANT_ID="" # only needed for Kubernetes < v1.3.0. +``` + +These values can be overriden by setting them in `cluster/azure/config-default.sh` or as environment variables. They are shown here with their default values: + +```shell +export AZURE_DEPLOY_ID="" # autogenerated if blank +export AZURE_LOCATION="westus" +export AZURE_RESOURCE_GROUP="" # generated from AZURE_DEPLOY_ID if unset +export AZURE_MASTER_SIZE="Standard_A1" +export AZURE_NODE_SIZE="Standard_A1" +export AZURE_USERNAME="kube" +export NUM_NODES=3 +export AZURE_AUTH_METHOD="device" +``` + + +By default, this will deploy a cluster with 4 `Standard_A1`-sized VMs: one master node, three worker nodes. This process takes about 5 to 10 minutes. Once the cluster is up, connection information to the cluster will be displayed. Additionally, your `kubectl` configuration will be updated to know about this cluster and this new cluster will be set as the active context. + +The Azure deployment process produces an output directory `cluster/azure/_deployments/${AZURE_DEPLOY_ID}`. In this directory you will find the PKI and SSH assets created for the cluster, as well as a script named `util.sh`. Here are some examples of its usage: + +```shell +$ cd cluster/azure/_deployments/kube-20160316-001122/ + +# This uses the client cert with curl to make an http call to the apiserver. +$ ./util.sh curl api/v1/nodes + +# This uses the client cert with kubectl to target this deployment's apiserver. +$ ./util.sh kubectl get nodes + +# This alters the current kubectl configuration to point at this cluster. +$ ./util.sh configure-kubectl + +# This will deploy the kube-system namespace, the SkyDNS addon, and the kube-dashboard addon. +$ ./util.sh deploy-addons + +# This uses the ssh private key to copy the private key itself to the master node. +$ ./util.sh copykey + +# This uses the ssh private key to open an ssh connection to the master. +$ ./util.sh ssh +``` + +### Cluster deployment examples + +#### Deploy the `kube-system` namespace + +The cluster addons are created in the `kube-system` namespace. + +For versions of Kubernetes before 1.3.0, this must be done manually. Starting with 1.3.0, the +namespace is created automatically as part of the Azure bring-up. For versions prior to 1.3.0, you may +execute this to create the `kube-system` namespace: + +```shell +kubectl create -f https://raw.githubusercontent.com/colemickens/azkube/v0.0.5/templates/coreos/addons/kube-system.yaml +``` + +#### Using `kubectl proxy` + +`kubectl proxy` is currently used to access to access deployed services. + +```shell +kubectl proxy --port=8001 +``` + +Deployed services are available at: `http://localhost:8001/api/v1/proxy/namespaces//services/`. + + +#### Addon: SkyDNS + +You can deploy the [SkyDNS addon](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/cluster/addons/dns): + +```shell +kubectl create -f https://raw.githubusercontent.com/colemickens/azkube/v0.0.5/templates/coreos/addons/skydns.yaml +``` + + +#### Addon: Kube-Dashboard + +This will deploy the [`kube-dashboard`](https://github.com/kubernetes/dashboard) addon: + +```shell +kubectl create -f https://raw.githubusercontent.com/colemickens/azkube/v0.0.5/templates/coreos/addons/kube-dashboard.yaml +``` + +The dashboard is then available at: `http://localhost:8001/api/v1/proxy/namespaces/kube-system/services/dashboard-canary`. + +#### Example: Guestbook + +This will deploy the [`guestbook example`](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/examples/guestbook/README.md) (the all-in-one variant): + +```shell +kubectl create -f https://raw.githubusercontent.com/kubernetes/kubernetes/release-1.2/examples/guestbook/all-in-one/guestbook-all-in-one.yaml +``` + +The guestbook is then available at: `http://localhost:8001/api/v1/proxy/namespaces/default/services/frontend`. + + +### Cluster scaling + +The `azkube` tool used internally during `kube-up` can also be used to scale your cluster. +Here's an example of scaling a default deployment of 3 nodes to 10 nodes: + +```shell +export AZURE_DEPLOY_ID="kube-20160316-001122" +$ docker run -it -v "$HOME/.azkube:/.azkube" -v "/tmp:/tmp" \ + colemickens/azkube:v0.0.5 /opt/azkube/azkube scale \ + --deployment-name="${AZURE_DEPLOY_ID}" \ + --node-size="Standard_A1" \ + --node-count=10 +``` + +### Cluster tear-down + +You can tear-down a cluster using `kube-down.sh`: + +```shell +export AZURE_DEPLOY_ID="kube-20160316-001122" +$ ./cluster/kube-down.sh +``` + +Prior to Kubernetes 1.3, the cluster must be deleted manually with the Azure CLI or via the Azure Portal. + +### Notes + +1. The user account used for these operations must have Owner access to the subscription. +2. You can find your subscription ID in the [Azure Portal](https://portal.microsoft.com). (All Resources → Subscriptions) +3. The `AZURE_AUTH_METHOD` environment variable controls what authentication mechanism is used when bringing up the cluster. By default it is set to `device`. This allows the user to login via the a web browser. This interactive step can be automated by creating a Service Principal, setting `AZURE_AUTH_METHOD=client_secret` and setting `AZURE_CLIENT_ID` + `AZURE_CLIENT_SECRET` as appropriate for your Service Principal. +4. The `--node-size` used in the `scale` command must be the same size deployed initially or it will not have the desired effect. +5. Cluster tear-down requires manual intervention, due to the fact that it deletes the entire resource group and someone else may have deployed other resources since the initial deployment. For this reason you must confirm the list of resources that are to be deleted. If you wish to skip it, you may set `AZURE_DOWN_SKIP_CONFIRM` to `true`. This will delete everything in the resource group that was deployed to. +6. If you are deploying from a checkout of `kubernetes`, then you will need to take an additional step to ensure that a `hyperkube` image is available. You can set `AZURE_DOCKER_REGISTRY` and `AZURE_DOCKER_REPO` and the deployment will ensure that a hyperkube container is built and available in the specified Docker registry. That `hyperkube` image will then be used throughout the cluster for running the Kubernetes services. Alternatively, you may set `AZURE_HYPERKUBE_SPEC` to point to a custom `hyperkube` image. + + +## Further reading + +* Please see the [azkube](https://github.com/colemickens/azkube) repository for more information about the deployment tool that manages the deployment. diff --git a/docs/getting-started-guides/binary_release.md b/docs/getting-started-guides/binary_release.md index 667b5f025d..d3b2886f87 100644 --- a/docs/getting-started-guides/binary_release.md +++ b/docs/getting-started-guides/binary_release.md @@ -1,8 +1,15 @@ --- +assignees: +- david-mcmahon +- jbeda + --- You can either build a release from sources or download a pre-built release. If you do not plan on developing Kubernetes itself, we suggest a pre-built release. +If you just want to run Kubernetes locally for development, we recommend using Minikube. You can download Minikube [here](https://github.com/kubernetes/minikube/releases/latest). +Minikube sets up a local VM that runs a Kubernetes cluster securely, and makes it easy to work with that cluster. + * TOC {:toc} diff --git a/docs/getting-started-guides/centos/OWNERS b/docs/getting-started-guides/centos/OWNERS new file mode 100644 index 0000000000..fee1e705d6 --- /dev/null +++ b/docs/getting-started-guides/centos/OWNERS @@ -0,0 +1,4 @@ +assignees: +- lavalamp +- thockin + diff --git a/docs/getting-started-guides/centos/centos_manual_config.md b/docs/getting-started-guides/centos/centos_manual_config.md index 9e09cabfcf..d2d12e9e15 100644 --- a/docs/getting-started-guides/centos/centos_manual_config.md +++ b/docs/getting-started-guides/centos/centos_manual_config.md @@ -1,4 +1,8 @@ --- +assignees: +- lavalamp +- thockin + --- * TOC @@ -20,6 +24,8 @@ The Kubernetes package provides a few services: kube-apiserver, kube-scheduler, Hosts: +Please replace host IP with your environment. + ```conf centos-master = 192.168.121.9 centos-minion = 192.168.121.65 @@ -27,7 +33,7 @@ centos-minion = 192.168.121.65 **Prepare the hosts:** -* Create a virt7-docker-common-release repo on all hosts - centos-{master,minion} with following information. +* Create a /etc/yum.repos.d/virt7-docker-common-release.repo on all hosts - centos-{master,minion} with following information. ```conf [virt7-docker-common-release] @@ -36,10 +42,10 @@ baseurl=http://cbs.centos.org/repos/virt7-docker-common-release/x86_64/os/ gpgcheck=0 ``` -* Install Kubernetes on all hosts - centos-{master,minion}. This will also pull in etcd, docker, and cadvisor. +* Install Kubernetes and etcd on all hosts - centos-{master,minion}. This will also pull in docker and cadvisor. ```shell -yum -y install --enablerepo=virt7-docker-common-release kubernetes +yum -y install --enablerepo=virt7-docker-common-release kubernetes etcd ``` * Add master and node to /etc/hosts on all machines (not needed if hostnames already in DNS) @@ -63,6 +69,9 @@ KUBE_LOG_LEVEL="--v=0" # Should this cluster be allowed to run privileged docker containers KUBE_ALLOW_PRIV="--allow-privileged=false" + +# How the replication controller and scheduler find the kube-apiserver +KUBE_MASTER="--master=http://centos-master:8080" ``` * Disable the firewall on both the master and node, as docker does not play well with other firewall rule managers @@ -74,6 +83,18 @@ systemctl stop iptables-services firewalld **Configure the Kubernetes services on the master.** +* Edit /etc/etcd/etcd.conf to appear as such: + +```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" +``` + * Edit /etc/kubernetes/apiserver to appear as such: ```shell @@ -83,9 +104,6 @@ KUBE_API_ADDRESS="--address=0.0.0.0" # The port on the local server to listen on. KUBE_API_PORT="--port=8080" -# How the replication controller and scheduler find the kube-apiserver -KUBE_MASTER="--master=http://centos-master:8080" - # Port kubelets listen on KUBELET_PORT="--kubelet-port=10250" @@ -99,10 +117,10 @@ KUBE_API_ARGS="" * Start the appropriate services on master: ```shell -for SERVICES in etcd kube-apiserver kube-controller-manager kube-scheduler; do +for SERVICES in etcd kube-apiserver kube-controller-manager kube-scheduler; do systemctl restart $SERVICES systemctl enable $SERVICES - systemctl status $SERVICES + systemctl status $SERVICES done ``` @@ -132,10 +150,10 @@ KUBELET_ARGS="" * Start the appropriate services on node (centos-minion). ```shell -for SERVICES in kube-proxy kubelet docker; do +for SERVICES in kube-proxy kubelet docker; do systemctl restart $SERVICES systemctl enable $SERVICES - systemctl status $SERVICES + systemctl status $SERVICES done ``` diff --git a/docs/getting-started-guides/clc.md b/docs/getting-started-guides/clc.md index 3e9b3f0858..11470ca475 100644 --- a/docs/getting-started-guides/clc.md +++ b/docs/getting-started-guides/clc.md @@ -1,4 +1,5 @@ --- + --- * TOC {: toc} diff --git a/docs/getting-started-guides/cloudstack.md b/docs/getting-started-guides/cloudstack.md index 313c97de65..2361a4fd79 100644 --- a/docs/getting-started-guides/cloudstack.md +++ b/docs/getting-started-guides/cloudstack.md @@ -1,4 +1,8 @@ --- +assignees: +- lavalamp +- thockin + --- CloudStack is a software to build public and private clouds based on hardware virtualization principles (traditional IaaS). To deploy Kubernetes on CloudStack there are several possibilities depending on the Cloud being used and what images are made available. [Exoscale](http://exoscale.ch) for instance makes a [CoreOS](http://coreos.com) template available, therefore instructions to deploy Kubernetes on coreOS can be used. CloudStack also has a vagrant plugin available, hence Vagrant could be used to deploy Kubernetes either using the existing shell provisioner or using new Salt based recipes. diff --git a/docs/getting-started-guides/coreos/OWNERS b/docs/getting-started-guides/coreos/OWNERS new file mode 100644 index 0000000000..d13cb1c42c --- /dev/null +++ b/docs/getting-started-guides/coreos/OWNERS @@ -0,0 +1,3 @@ +assignees: +- errordeveloper + diff --git a/docs/getting-started-guides/coreos/azure/addons/skydns-rc.yaml b/docs/getting-started-guides/coreos/azure/addons/skydns-rc.yaml deleted file mode 100644 index ee31c5107c..0000000000 --- a/docs/getting-started-guides/coreos/azure/addons/skydns-rc.yaml +++ /dev/null @@ -1,99 +0,0 @@ -apiVersion: v1 -kind: ReplicationController -metadata: - name: kube-dns-v9 - namespace: kube-system - labels: - k8s-app: kube-dns - version: v9 - kubernetes.io/cluster-service: "true" -spec: - replicas: 3 - selector: - k8s-app: kube-dns - version: v9 - template: - metadata: - labels: - k8s-app: kube-dns - version: v9 - kubernetes.io/cluster-service: "true" - spec: - containers: - - name: etcd - image: gcr.io/google_containers/etcd:2.0.9 - resources: - limits: - cpu: 100m - memory: 50Mi - command: - - /usr/local/bin/etcd - - -data-dir - - /var/etcd/data - - -listen-client-urls - - http://127.0.0.1:2379,http://127.0.0.1:4001 - - -advertise-client-urls - - http://127.0.0.1:2379,http://127.0.0.1:4001 - - -initial-cluster-token - - skydns-etcd - volumeMounts: - - name: etcd-storage - mountPath: /var/etcd/data - - name: kube2sky - image: gcr.io/google_containers/kube2sky:1.11 - resources: - limits: - cpu: 100m - memory: 50Mi - args: - # command = "/kube2sky" - - -domain=kube.local - - -kube_master_url=http://kube-00:8080 - - name: skydns - image: gcr.io/google_containers/skydns:2015-03-11-001 - resources: - limits: - cpu: 100m - memory: 50Mi - args: - # command = "/skydns" - - -machines=http://localhost:4001 - - -addr=0.0.0.0:53 - - -domain=kube.local - ports: - - containerPort: 53 - name: dns - protocol: UDP - - containerPort: 53 - name: dns-tcp - protocol: TCP - livenessProbe: - httpGet: - path: /healthz - port: 8080 - scheme: HTTP - initialDelaySeconds: 30 - timeoutSeconds: 5 - readinessProbe: - httpGet: - path: /healthz - port: 8080 - scheme: HTTP - initialDelaySeconds: 1 - timeoutSeconds: 5 - - name: healthz - image: gcr.io/google_containers/exechealthz:1.0 - resources: - limits: - cpu: 10m - memory: 20Mi - args: - - -cmd=nslookup kubernetes.default.svc.kube.local localhost >/dev/null - - -port=8080 - ports: - - containerPort: 8080 - protocol: TCP - volumes: - - name: etcd-storage - emptyDir: {} - dnsPolicy: Default # Don't use cluster DNS. diff --git a/docs/getting-started-guides/coreos/azure/addons/skydns-svc.yaml b/docs/getting-started-guides/coreos/azure/addons/skydns-svc.yaml deleted file mode 100644 index c15822d6bc..0000000000 --- a/docs/getting-started-guides/coreos/azure/addons/skydns-svc.yaml +++ /dev/null @@ -1,20 +0,0 @@ -apiVersion: v1 -kind: Service -metadata: - name: kube-dns - namespace: kube-system - labels: - k8s-app: kube-dns - kubernetes.io/cluster-service: "true" - kubernetes.io/name: "KubeDNS" -spec: - selector: - k8s-app: kube-dns - clusterIP: 10.16.0.3 - ports: - - name: dns - port: 53 - protocol: UDP - - name: dns-tcp - port: 53 - protocol: TCP diff --git a/docs/getting-started-guides/coreos/azure/azure-login.js b/docs/getting-started-guides/coreos/azure/azure-login.js deleted file mode 100755 index 624916b2b5..0000000000 --- a/docs/getting-started-guides/coreos/azure/azure-login.js +++ /dev/null @@ -1,3 +0,0 @@ -#!/usr/bin/env node - -require('child_process').fork('node_modules/azure-cli/bin/azure', ['login'].concat(process.argv)); diff --git a/docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-etcd-node-template.yml b/docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-etcd-node-template.yml deleted file mode 100644 index 4cbb480e53..0000000000 --- a/docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-etcd-node-template.yml +++ /dev/null @@ -1,19 +0,0 @@ -## This file is used as input to deployment script, which amends it as needed. -## More specifically, we need to add peer hosts for each but the elected peer. - -coreos: - units: - - name: etcd2.service - enable: true - command: start - etcd2: - name: '%H' - initial-cluster-token: 'etcd-cluster' - initial-advertise-peer-urls: 'http://%H:2380' - listen-peer-urls: 'http://%H:2380' - listen-client-urls: 'http://0.0.0.0:2379,http://0.0.0.0:4001' - advertise-client-urls: 'http://%H:2379,http://%H:4001' - initial-cluster-state: 'new' - update: - group: stable - reboot-strategy: off diff --git a/docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-main-nodes-template.yml b/docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-main-nodes-template.yml index b3f3331429..d44b26318d 100644 --- a/docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-main-nodes-template.yml +++ b/docs/getting-started-guides/coreos/azure/cloud_config_templates/kubernetes-cluster-main-nodes-template.yml @@ -184,7 +184,7 @@ coreos: Documentation=http://kubernetes.io/ Requires=network-online.target [Service] - Environment=KUBE_RELEASE_TARBALL=https://github.com/kubernetes/kubernetes/releases/download/v1.1.2/kubernetes.tar.gz + Environment=KUBE_RELEASE_TARBALL=https://github.com/kubernetes/kubernetes/releases/download/v1.2.2/kubernetes.tar.gz ExecStartPre=/bin/mkdir -p /opt/ ExecStart=/opt/bin/curl-retry.sh --silent --location $KUBE_RELEASE_TARBALL --output /tmp/kubernetes.tgz ExecStart=/bin/tar xzvf /tmp/kubernetes.tgz -C /tmp/ @@ -217,10 +217,10 @@ coreos: ExecStart=/opt/kubernetes/server/bin/kube-apiserver \ --insecure-bind-address=0.0.0.0 \ --advertise-address=$public_ipv4 \ - --port=8080 \ + --insecure-port=8080 \ $ETCD_SERVERS \ --service-cluster-ip-range=10.16.0.0/12 \ - --cloud-provider=vagrant \ + --cloud-provider= \ --logtostderr=true Restart=always RestartSec=10 @@ -281,7 +281,7 @@ coreos: [Service] ExecStartPre=/bin/mkdir -p /etc/kubernetes/manifests/ ExecStart=/opt/kubernetes/server/bin/kubelet \ - --docker-endpoint=unix:/var/run/weave/weave.sock \ + --docker-endpoint=unix://var/run/weave/weave.sock \ --address=0.0.0.0 \ --port=10250 \ --hostname-override=%H \ diff --git a/docs/getting-started-guides/coreos/azure/create-kubernetes-cluster.js b/docs/getting-started-guides/coreos/azure/create-kubernetes-cluster.js deleted file mode 100755 index 70248c596c..0000000000 --- a/docs/getting-started-guides/coreos/azure/create-kubernetes-cluster.js +++ /dev/null @@ -1,15 +0,0 @@ -#!/usr/bin/env node - -var azure = require('./lib/azure_wrapper.js'); -var kube = require('./lib/deployment_logic/kubernetes.js'); - -azure.create_config('kube', { 'etcd': 3, 'kube': 3 }); - -azure.run_task_queue([ - azure.queue_default_network(), - azure.queue_storage_if_needed(), - azure.queue_machines('etcd', 'stable', - kube.create_etcd_cloud_config), - azure.queue_machines('kube', 'stable', - kube.create_node_cloud_config), -]); diff --git a/docs/getting-started-guides/coreos/azure/destroy-cluster.js b/docs/getting-started-guides/coreos/azure/destroy-cluster.js deleted file mode 100755 index ce441e538a..0000000000 --- a/docs/getting-started-guides/coreos/azure/destroy-cluster.js +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/env node - -var azure = require('./lib/azure_wrapper.js'); - -azure.destroy_cluster(process.argv[2]); - -console.log('The cluster had been destroyed, you can delete the state file now.'); diff --git a/docs/getting-started-guides/coreos/azure/expose_guestbook_app_port.sh b/docs/getting-started-guides/coreos/azure/expose_guestbook_app_port.sh deleted file mode 100755 index 65dfaf5d3a..0000000000 --- a/docs/getting-started-guides/coreos/azure/expose_guestbook_app_port.sh +++ /dev/null @@ -1,29 +0,0 @@ -#!/bin/bash - -# Copyright 2014 The Kubernetes Authors All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -set -e - -[ ! -z $1 ] || (echo Usage: $0 ssh_conf; exit 1) - -fe_port=$(ssh -F $1 kube-00 \ - "/opt/bin/kubectl get -o template --template='{{(index .spec.ports 0).nodePort}}' services frontend -L name=frontend" \ -) - -echo "Guestbook app is on port $fe_port, will map it to port 80 on kube-00" - -./node_modules/.bin/azure vm endpoint create kube-00 80 $fe_port - -./node_modules/.bin/azure vm endpoint show kube-00 tcp-80-${fe_port} diff --git a/docs/getting-started-guides/coreos/azure/index.md b/docs/getting-started-guides/coreos/azure/index.md index 7101ae7ee7..589cf81fcc 100644 --- a/docs/getting-started-guides/coreos/azure/index.md +++ b/docs/getting-started-guides/coreos/azure/index.md @@ -1,247 +1,246 @@ ---- ---- - -* TOC -{:toc} - - -In this guide I will demonstrate how to deploy a Kubernetes cluster to Azure cloud. You will be using CoreOS with Weave, which implements simple and secure networking, in a transparent, yet robust way. The purpose of this guide is to provide an out-of-the-box implementation that can ultimately be taken into production with little change. It will demonstrate how to provision a dedicated Kubernetes master and etcd nodes, and show how to scale the cluster with ease. - -### Prerequisites - -1. You need an Azure account. - -## Let's go! - -To get started, you need to checkout the code: - -```shell -git clone https://github.com/kubernetes/kubernetes -cd kubernetes/docs/getting-started-guides/coreos/azure/ -``` - -You will need to have [Node.js installed](http://nodejs.org/download/) on you machine. If you have previously used Azure CLI, you should have it already. - -First, you need to install some of the dependencies with - -```shell -npm install -``` - -Now, all you need to do is: - -```shell -./azure-login.js -u -./create-kubernetes-cluster.js -``` - -This script will provision a cluster suitable for production use, where there is a ring of 3 dedicated etcd nodes: 1 kubernetes master and 2 kubernetes nodes. The `kube-00` VM will be the master, your work loads are only to be deployed on the nodes, `kube-01` and `kube-02`. Initially, all VMs are single-core, to ensure a user of the free tier can reproduce it without paying extra. I will show how to add more bigger VMs later. -If you need to pass Azure specific options for the creation script you can do this via additional environment variables e.g. - -```shell -AZ_SUBSCRIPTION= AZ_LOCATION="East US" ./create-kubernetes-cluster.js -# or -AZ_VM_COREOS_CHANNEL=beta ./create-kubernetes-cluster.js -``` - -![VMs in Azure](/images/docs/initial_cluster.png) - -Once the creation of Azure VMs has finished, you should see the following: - -```shell -... -azure_wrapper/info: Saved SSH config, you can use it like so: `ssh -F ./output/kube_1c1496016083b4_ssh_conf ` -azure_wrapper/info: The hosts in this deployment are: - [ 'etcd-00', 'etcd-01', 'etcd-02', 'kube-00', 'kube-01', 'kube-02' ] -azure_wrapper/info: Saved state into `./output/kube_1c1496016083b4_deployment.yml` -``` - -Let's login to the master node like so: - -```shell -ssh -F ./output/kube_1c1496016083b4_ssh_conf kube-00 -``` - -> Note: config file name will be different, make sure to use the one you see. - -Check there are 2 nodes in the cluster: - -```shell -core@kube-00 ~ $ kubectl get nodes -NAME LABELS STATUS -kube-01 kubernetes.io/hostname=kube-01 Ready -kube-02 kubernetes.io/hostname=kube-02 Ready -``` - -## Deploying the workload - -Let's follow the Guestbook example now: - -```shell -kubectl create -f ~/guestbook-example -``` - -You need to wait for the pods to get deployed, run the following and wait for `STATUS` to change from `Pending` to `Running`. - -```shell -kubectl get pods --watch -``` - -> Note: the most time it will spend downloading Docker container images on each of the nodes. - -Eventually you should see: - -```shell -NAME READY STATUS RESTARTS AGE -frontend-0a9xi 1/1 Running 0 4m -frontend-4wahe 1/1 Running 0 4m -frontend-6l36j 1/1 Running 0 4m -redis-master-talmr 1/1 Running 0 4m -redis-slave-12zfd 1/1 Running 0 4m -redis-slave-3nbce 1/1 Running 0 4m -``` - -## Scaling - -Two single-core nodes are certainly not enough for a production system of today. Let's scale the cluster by adding a couple of bigger nodes. - -You will need to open another terminal window on your machine and go to the same working directory (e.g. `~/Workspace/kubernetes/docs/getting-started-guides/coreos/azure/`). - -First, lets set the size of new VMs: - -```shell -export AZ_VM_SIZE=Large -``` - -Now, run scale script with state file of the previous deployment and number of nodes to add: - -```shell -core@kube-00 ~ $ ./scale-kubernetes-cluster.js ./output/kube_1c1496016083b4_deployment.yml 2 -... -azure_wrapper/info: Saved SSH config, you can use it like so: `ssh -F ./output/kube_8f984af944f572_ssh_conf ` -azure_wrapper/info: The hosts in this deployment are: - [ 'etcd-00', - 'etcd-01', - 'etcd-02', - 'kube-00', - 'kube-01', - 'kube-02', - 'kube-03', - 'kube-04' ] -azure_wrapper/info: Saved state into `./output/kube_8f984af944f572_deployment.yml` -``` - -> Note: this step has created new files in `./output`. - -Back on `kube-00`: - -```shell -core@kube-00 ~ $ kubectl get nodes -NAME LABELS STATUS -kube-01 kubernetes.io/hostname=kube-01 Ready -kube-02 kubernetes.io/hostname=kube-02 Ready -kube-03 kubernetes.io/hostname=kube-03 Ready -kube-04 kubernetes.io/hostname=kube-04 Ready -``` - -You can see that two more nodes joined happily. Let's scale the number of Guestbook instances now. - -First, double-check how many replication controllers there are: - -```shell -core@kube-00 ~ $ kubectl get rc -ONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS -frontend php-redis kubernetes/example-guestbook-php-redis:v2 name=frontend 3 -redis-master master redis name=redis-master 1 -redis-slave worker kubernetes/redis-slave:v2 name=redis-slave 2 -``` - -As there are 4 nodes, let's scale proportionally: - -```shell -core@kube-00 ~ $ kubectl scale --replicas=4 rc redis-slave ->>>>>>> coreos/azure: Updates for 1.0 -scaled -core@kube-00 ~ $ kubectl scale --replicas=4 rc frontend -scaled -``` - -Check what you have now: - -```shell -core@kube-00 ~ $ kubectl get rc -CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS -frontend php-redis kubernetes/example-guestbook-php-redis:v2 name=frontend 4 -redis-master master redis name=redis-master 1 -redis-slave worker kubernetes/redis-slave:v2 name=redis-slave 4 -``` - -You now will have more instances of front-end Guestbook apps and Redis slaves; and, if you look up all pods labeled `name=frontend`, you should see one running on each node. - -```shell -core@kube-00 ~/guestbook-example $ kubectl get pods -l name=frontend -NAME READY STATUS RESTARTS AGE -frontend-0a9xi 1/1 Running 0 22m -frontend-4wahe 1/1 Running 0 22m -frontend-6l36j 1/1 Running 0 22m -frontend-z9oxo 1/1 Running 0 41s -``` - -## Exposing the app to the outside world - -There is no native Azure load-balancer support in Kubernetes 1.0, however here is how you can expose the Guestbook app to the Internet. - -```shell -./expose_guestbook_app_port.sh ./output/kube_1c1496016083b4_ssh_conf -Guestbook app is on port 31605, will map it to port 80 on kube-00 -info: Executing command vm endpoint create -+ Getting virtual machines -+ Reading network configuration -+ Updating network configuration -info: vm endpoint create command OK -info: Executing command vm endpoint show -+ Getting virtual machines -data: Name : tcp-80-31605 -data: Local port : 31605 -data: Protcol : tcp -data: Virtual IP Address : 137.117.156.164 -data: Direct server return : Disabled -info: vm endpoint show command OK -``` - -You then should be able to access it from anywhere via the Azure virtual IP for `kube-00` displayed above, i.e. `http://137.117.156.164/` in my case. - -## Next steps - -You now have a full-blow cluster running in Azure, congrats! - -You should probably try deploy other [example apps](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/) or write your own ;) - -## Tear down... - -If you don't wish care about the Azure bill, you can tear down the cluster. It's easy to redeploy it, as you can see. - -```shell -./destroy-cluster.js ./output/kube_8f984af944f572_deployment.yml -``` - -> Note: make sure to use the _latest state file_, as after scaling there is a new one. - -By the way, with the scripts shown, you can deploy multiple clusters, if you like :) - -## Support Level - - -IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level --------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ---------------------------- -Azure | CoreOS | CoreOS | Weave | [docs](/docs/getting-started-guides/coreos/azure/) | | Community ([@errordeveloper](https://github.com/errordeveloper), [@squillace](https://github.com/squillace), [@chanezon](https://github.com/chanezon), [@crossorigin](https://github.com/crossorigin)) - - -For support level information on all solutions, see the [Table of solutions](/docs/getting-started-guides/#table-of-solutions) chart. - - -## Further reading - -Please see the [Kubernetes docs](/docs/) for more details on administering -and using a Kubernetes cluster - +--- +--- + +* TOC +{:toc} + + +In this guide I will demonstrate how to deploy a Kubernetes cluster to Azure cloud. You will be using CoreOS with Weave, which implements simple and secure networking, in a transparent, yet robust way. The purpose of this guide is to provide an out-of-the-box implementation that can ultimately be taken into production with little change. It will demonstrate how to provision a dedicated Kubernetes master and etcd nodes, and show how to scale the cluster with ease. + +### Prerequisites + +1. You need an Azure account. + +## Let's go! + +To get started, you need to checkout the code: + +```shell +https://github.com/weaveworks-guides/weave-kubernetes-coreos-azure +cd weave-kubernetes-coreos-azure +``` + +You will need to have [Node.js installed](http://nodejs.org/download/) on you machine. If you have previously used Azure CLI, you should have it already. + +First, you need to install some of the dependencies with + +```shell +npm install +``` + +Now, all you need to do is: + +```shell +./azure-login.js -u +./create-kubernetes-cluster.js +``` + +This script will provision a cluster suitable for production use, where there is a ring of 3 dedicated etcd nodes: 1 kubernetes master and 2 kubernetes nodes. The `kube-00` VM will be the master, your work loads are only to be deployed on the nodes, `kube-01` and `kube-02`. Initially, all VMs are single-core, to ensure a user of the free tier can reproduce it without paying extra. I will show how to add more bigger VMs later. +If you need to pass Azure specific options for the creation script you can do this via additional environment variables e.g. + +```shell +AZ_SUBSCRIPTION= AZ_LOCATION="East US" ./create-kubernetes-cluster.js +# or +AZ_VM_COREOS_CHANNEL=beta ./create-kubernetes-cluster.js +``` + +![VMs in Azure](/images/docs/initial_cluster.png) + +Once the creation of Azure VMs has finished, you should see the following: + +```shell +... +azure_wrapper/info: Saved SSH config, you can use it like so: `ssh -F ./output/kube_1c1496016083b4_ssh_conf ` +azure_wrapper/info: The hosts in this deployment are: + [ 'etcd-00', 'etcd-01', 'etcd-02', 'kube-00', 'kube-01', 'kube-02' ] +azure_wrapper/info: Saved state into `./output/kube_1c1496016083b4_deployment.yml` +``` + +Let's login to the master node like so: + +```shell +ssh -F ./output/kube_1c1496016083b4_ssh_conf kube-00 +``` + +> Note: config file name will be different, make sure to use the one you see. + +Check there are 2 nodes in the cluster: + +```shell +core@kube-00 ~ $ kubectl get nodes +NAME LABELS STATUS +kube-01 kubernetes.io/hostname=kube-01 Ready +kube-02 kubernetes.io/hostname=kube-02 Ready +``` + +## Deploying the workload + +Let's follow the Guestbook example now: + +```shell +kubectl create -f ~/guestbook-example +``` + +You need to wait for the pods to get deployed, run the following and wait for `STATUS` to change from `Pending` to `Running`. + +```shell +kubectl get pods --watch +``` + +> Note: the most time it will spend downloading Docker container images on each of the nodes. + +Eventually you should see: + +```shell +NAME READY STATUS RESTARTS AGE +frontend-0a9xi 1/1 Running 0 4m +frontend-4wahe 1/1 Running 0 4m +frontend-6l36j 1/1 Running 0 4m +redis-master-talmr 1/1 Running 0 4m +redis-slave-12zfd 1/1 Running 0 4m +redis-slave-3nbce 1/1 Running 0 4m +``` + +## Scaling + +Two single-core nodes are certainly not enough for a production system of today. Let's scale the cluster by adding a couple of bigger nodes. + +You will need to open another terminal window on your machine and go to the same working directory (e.g. `~/Workspace/kubernetes/docs/getting-started-guides/coreos/azure/`). + +First, lets set the size of new VMs: + +```shell +export AZ_VM_SIZE=Large +``` + +Now, run scale script with state file of the previous deployment and number of nodes to add: + +```shell +core@kube-00 ~ $ ./scale-kubernetes-cluster.js ./output/kube_1c1496016083b4_deployment.yml 2 +... +azure_wrapper/info: Saved SSH config, you can use it like so: `ssh -F ./output/kube_8f984af944f572_ssh_conf ` +azure_wrapper/info: The hosts in this deployment are: + [ 'etcd-00', + 'etcd-01', + 'etcd-02', + 'kube-00', + 'kube-01', + 'kube-02', + 'kube-03', + 'kube-04' ] +azure_wrapper/info: Saved state into `./output/kube_8f984af944f572_deployment.yml` +``` + +> Note: this step has created new files in `./output`. + +Back on `kube-00`: + +```shell +core@kube-00 ~ $ kubectl get nodes +NAME LABELS STATUS +kube-01 kubernetes.io/hostname=kube-01 Ready +kube-02 kubernetes.io/hostname=kube-02 Ready +kube-03 kubernetes.io/hostname=kube-03 Ready +kube-04 kubernetes.io/hostname=kube-04 Ready +``` + +You can see that two more nodes joined happily. Let's scale the number of Guestbook instances now. + +First, double-check how many replication controllers there are: + +```shell +core@kube-00 ~ $ kubectl get rc +ONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS +frontend php-redis kubernetes/example-guestbook-php-redis:v2 name=frontend 3 +redis-master master redis name=redis-master 1 +redis-slave worker kubernetes/redis-slave:v2 name=redis-slave 2 +``` + +As there are 4 nodes, let's scale proportionally: + +```shell +core@kube-00 ~ $ kubectl scale --replicas=4 rc redis-slave +scaled +core@kube-00 ~ $ kubectl scale --replicas=4 rc frontend +scaled +``` + +Check what you have now: + +```shell +core@kube-00 ~ $ kubectl get rc +CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS +frontend php-redis kubernetes/example-guestbook-php-redis:v2 name=frontend 4 +redis-master master redis name=redis-master 1 +redis-slave worker kubernetes/redis-slave:v2 name=redis-slave 4 +``` + +You now will have more instances of front-end Guestbook apps and Redis slaves; and, if you look up all pods labeled `name=frontend`, you should see one running on each node. + +```shell +core@kube-00 ~/guestbook-example $ kubectl get pods -l name=frontend +NAME READY STATUS RESTARTS AGE +frontend-0a9xi 1/1 Running 0 22m +frontend-4wahe 1/1 Running 0 22m +frontend-6l36j 1/1 Running 0 22m +frontend-z9oxo 1/1 Running 0 41s +``` + +## Exposing the app to the outside world + +There is no native Azure load-balancer support in Kubernetes 1.0, however here is how you can expose the Guestbook app to the Internet. + +```shell +./expose_guestbook_app_port.sh ./output/kube_1c1496016083b4_ssh_conf +Guestbook app is on port 31605, will map it to port 80 on kube-00 +info: Executing command vm endpoint create ++ Getting virtual machines ++ Reading network configuration ++ Updating network configuration +info: vm endpoint create command OK +info: Executing command vm endpoint show ++ Getting virtual machines +data: Name : tcp-80-31605 +data: Local port : 31605 +data: Protcol : tcp +data: Virtual IP Address : 137.117.156.164 +data: Direct server return : Disabled +info: vm endpoint show command OK +``` + +You then should be able to access it from anywhere via the Azure virtual IP for `kube-00` displayed above, i.e. `http://137.117.156.164/` in my case. + +## Next steps + +You now have a full-blown cluster running in Azure, congrats! + +You should probably try deploy other [example apps](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/) or write your own ;) + +## Tear down... + +If you don't wish care about the Azure bill, you can tear down the cluster. It's easy to redeploy it, as you can see. + +```shell +./destroy-cluster.js ./output/kube_8f984af944f572_deployment.yml +``` + +> Note: make sure to use the _latest state file_, as after scaling there is a new one. + +By the way, with the scripts shown, you can deploy multiple clusters, if you like :) + +## Support Level + + +IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level +-------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ---------------------------- +Azure | CoreOS | CoreOS | Weave | [docs](/docs/getting-started-guides/coreos/azure/) | | Community ([@errordeveloper](https://github.com/errordeveloper), [@squillace](https://github.com/squillace), [@chanezon](https://github.com/chanezon), [@crossorigin](https://github.com/crossorigin)) + + +For support level information on all solutions, see the [Table of solutions](/docs/getting-started-guides/#table-of-solutions) chart. + + +## Further reading + +Please see the [Kubernetes docs](/docs/) for more details on administering +and using a Kubernetes cluster + diff --git a/docs/getting-started-guides/coreos/azure/lib/azure_wrapper.js b/docs/getting-started-guides/coreos/azure/lib/azure_wrapper.js deleted file mode 100644 index 93402c10ed..0000000000 --- a/docs/getting-started-guides/coreos/azure/lib/azure_wrapper.js +++ /dev/null @@ -1,286 +0,0 @@ -var _ = require('underscore'); - -var fs = require('fs'); -var cp = require('child_process'); - -var yaml = require('js-yaml'); - -var openssl = require('openssl-wrapper'); - -var clr = require('colors'); -var inspect = require('util').inspect; - -var util = require('./util.js'); - -var coreos_image_ids = { - 'stable': '2b171e93f07c4903bcad35bda10acf22__CoreOS-Stable-835.12.0', // untested - 'beta': '2b171e93f07c4903bcad35bda10acf22__CoreOS-Beta-899.6.0', - 'alpha': '2b171e93f07c4903bcad35bda10acf22__CoreOS-Alpha-942.0.0' // untested -}; - -var conf = {}; - -var hosts = { - collection: [], - ssh_port_counter: 2200, -}; - -var task_queue = []; - -exports.run_task_queue = function (dummy) { - var tasks = { - todo: task_queue, - done: [], - }; - - var pop_task = function() { - console.log(clr.yellow('azure_wrapper/task:'), clr.grey(inspect(tasks))); - var ret = {}; - ret.current = tasks.todo.shift(); - ret.remaining = tasks.todo.length; - return ret; - }; - - (function iter (task) { - if (task.current === undefined) { - if (conf.destroying === undefined) { - create_ssh_conf(); - save_state(); - } - return; - } else { - if (task.current.length !== 0) { - console.log(clr.yellow('azure_wrapper/exec:'), clr.blue(inspect(task.current))); - cp.fork('node_modules/azure-cli/bin/azure', task.current) - .on('exit', function (code, signal) { - tasks.done.push({ - code: code, - signal: signal, - what: task.current.join(' '), - remaining: task.remaining, - }); - if (code !== 0 && conf.destroying === undefined) { - console.log(clr.red('azure_wrapper/fail: Exiting due to an error.')); - save_state(); - console.log(clr.cyan('azure_wrapper/info: You probably want to destroy and re-run.')); - process.abort(); - } else { - iter(pop_task()); - } - }); - } else { - iter(pop_task()); - } - } - })(pop_task()); -}; - -var save_state = function () { - var file_name = util.join_output_file_path(conf.name, 'deployment.yml'); - try { - conf.hosts = hosts.collection; - fs.writeFileSync(file_name, yaml.safeDump(conf)); - console.log(clr.yellow('azure_wrapper/info: Saved state into `%s`'), file_name); - } catch (e) { - console.log(clr.red(e)); - } -}; - -var load_state = function (file_name) { - try { - conf = yaml.safeLoad(fs.readFileSync(file_name, 'utf8')); - console.log(clr.yellow('azure_wrapper/info: Loaded state from `%s`'), file_name); - return conf; - } catch (e) { - console.log(clr.red(e)); - } -}; - -var create_ssh_key = function (prefix) { - var opts = { - x509: true, - nodes: true, - newkey: 'rsa:2048', - subj: '/O=Weaveworks, Inc./L=London/C=GB/CN=weave.works', - keyout: util.join_output_file_path(prefix, 'ssh.key'), - out: util.join_output_file_path(prefix, 'ssh.pem'), - }; - openssl.exec('req', opts, function (err, buffer) { - if (err) console.log(clr.red(err)); - openssl.exec('rsa', { in: opts.keyout, out: opts.keyout }, function (err, buffer) { - if (err) console.log(clr.red(err)); - fs.chmod(opts.keyout, '0600', function (err) { - if (err) console.log(clr.red(err)); - }); - }); - }); - return { - key: opts.keyout, - pem: opts.out, - } -} - -var create_ssh_conf = function () { - var file_name = util.join_output_file_path(conf.name, 'ssh_conf'); - var ssh_conf_head = [ - "Host *", - "\tHostname " + conf.resources['service'] + ".cloudapp.net", - "\tUser core", - "\tCompression yes", - "\tLogLevel FATAL", - "\tStrictHostKeyChecking no", - "\tUserKnownHostsFile /dev/null", - "\tIdentitiesOnly yes", - "\tIdentityFile " + conf.resources['ssh_key']['key'], - "\n", - ]; - - fs.writeFileSync(file_name, ssh_conf_head.concat(_.map(hosts.collection, function (host) { - return _.template("Host <%= name %>\n\tPort <%= port %>\n")(host); - })).join('\n')); - console.log(clr.yellow('azure_wrapper/info:'), clr.green('Saved SSH config, you can use it like so: `ssh -F ', file_name, '`')); - console.log(clr.yellow('azure_wrapper/info:'), clr.green('The hosts in this deployment are:\n'), _.map(hosts.collection, function (host) { return host.name; })); -}; - -var get_location = function () { - if (process.env['AZ_AFFINITY']) { - return '--affinity-group=' + process.env['AZ_AFFINITY']; - } else if (process.env['AZ_LOCATION']) { - return '--location=' + process.env['AZ_LOCATION']; - } else { - return '--location=West Europe'; - } -} -var get_vm_size = function () { - if (process.env['AZ_VM_SIZE']) { - return '--vm-size=' + process.env['AZ_VM_SIZE']; - } else { - return '--vm-size=Small'; - } -} - -var get_subscription= function () { - if (process.env['AZ_SUBSCRIPTION']) { - return '--subscription=' + process.env['AZ_SUBSCRIPTION']; - } -} - -exports.queue_default_network = function () { - task_queue.push([ - 'network', 'vnet', 'create', - get_location(), - '--address-space=172.16.0.0', - get_subscription(), - conf.resources['vnet'], - ]); -} - -exports.queue_storage_if_needed = function() { - if (!process.env['AZURE_STORAGE_ACCOUNT']) { - conf.resources['storage_account'] = util.rand_suffix; - task_queue.push([ - 'storage', 'account', 'create', - '--type=LRS', - get_location(), - get_subscription(), - conf.resources['storage_account'], - ]); - process.env['AZURE_STORAGE_ACCOUNT'] = conf.resources['storage_account']; - } else { - // Preserve it for resizing, so we don't create a new one by accident, - // when the environment variable is unset - conf.resources['storage_account'] = process.env['AZURE_STORAGE_ACCOUNT']; - } -}; - -exports.queue_machines = function (name_prefix, coreos_update_channel, cloud_config_creator) { - var x = conf.nodes[name_prefix]; - var vm_create_base_args = [ - 'vm', 'create', - get_location(), - get_vm_size(), - '--connect=' + conf.resources['service'], - '--virtual-network-name=' + conf.resources['vnet'], - '--no-ssh-password', - '--ssh-cert=' + conf.resources['ssh_key']['pem'], - get_subscription(), - ]; - - var cloud_config = cloud_config_creator(x, conf); - - var next_host = function (n) { - hosts.ssh_port_counter += 1; - var host = { name: util.hostname(n, name_prefix), port: hosts.ssh_port_counter }; - if (cloud_config instanceof Array) { - host.cloud_config_file = cloud_config[n]; - } else { - host.cloud_config_file = cloud_config; - } - hosts.collection.push(host); - return _.map([ - "--vm-name=<%= name %>", - "--ssh=<%= port %>", - "--custom-data=<%= cloud_config_file %>", - ], function (arg) { return _.template(arg)(host); }); - }; - - task_queue = task_queue.concat(_(x).times(function (n) { - if (conf.resizing && n < conf.old_size) { - return []; - } else { - if (process.env['AZ_VM_COREOS_CHANNEL']) { - coreos_update_channel = process.env['AZ_VM_COREOS_CHANNEL'] - } - return vm_create_base_args.concat(next_host(n), [ - coreos_image_ids[coreos_update_channel], 'core', - ]); - } - })); -}; - -exports.create_config = function (name, nodes) { - conf = { - name: name, - nodes: nodes, - weave_salt: util.rand_string(), - resources: { - vnet: [name, 'internal-vnet', util.rand_suffix].join('-'), - service: [name, util.rand_suffix].join('-'), - ssh_key: create_ssh_key(name), - } - }; - -}; - -exports.destroy_cluster = function (state_file) { - load_state(state_file); - if (conf.hosts === undefined) { - console.log(clr.red('azure_wrapper/fail: Nothing to delete.')); - process.abort(); - } - - conf.destroying = true; - task_queue = _.map(conf.hosts, function (host) { - return ['vm', 'delete', '--quiet', '--blob-delete', host.name, get_subscription()]; - }); - - task_queue.push(['network', 'vnet', 'delete', '--quiet', conf.resources['vnet'], get_subscription()]); - task_queue.push(['storage', 'account', 'delete', '--quiet', conf.resources['storage_account'], get_subscription()]); - - exports.run_task_queue(); -}; - -exports.load_state_for_resizing = function (state_file, node_type, new_nodes) { - load_state(state_file); - if (conf.hosts === undefined) { - console.log(clr.red('azure_wrapper/fail: Nothing to look at.')); - process.abort(); - } - conf.resizing = true; - conf.old_size = conf.nodes[node_type]; - conf.old_state_file = state_file; - conf.nodes[node_type] += new_nodes; - hosts.collection = conf.hosts; - hosts.ssh_port_counter += conf.hosts.length; - process.env['AZURE_STORAGE_ACCOUNT'] = conf.resources['storage_account']; -} diff --git a/docs/getting-started-guides/coreos/azure/lib/cloud_config.js b/docs/getting-started-guides/coreos/azure/lib/cloud_config.js deleted file mode 100644 index d08b3f06ae..0000000000 --- a/docs/getting-started-guides/coreos/azure/lib/cloud_config.js +++ /dev/null @@ -1,58 +0,0 @@ -var _ = require('underscore'); -var fs = require('fs'); -var yaml = require('js-yaml'); -var colors = require('colors/safe'); - -var write_cloud_config_from_object = function (data, output_file) { - try { - fs.writeFileSync(output_file, [ - '#cloud-config', - yaml.safeDump(data), - ].join("\n")); - return output_file; - } catch (e) { - console.log(colors.red(e)); - } -}; - -exports.generate_environment_file_entry_from_object = function (hostname, environ) { - var data = { - hostname: hostname, - environ_array: _.map(environ, function (value, key) { - return [key.toUpperCase(), JSON.stringify(value.toString())].join('='); - }), - }; - - return { - permissions: '0600', - owner: 'root', - content: _.template("<%= environ_array.join('\\n') %>\n")(data), - path: _.template("/etc/weave.<%= hostname %>.env")(data), - }; -}; - -exports.process_template = function (input_file, output_file, processor) { - var data = {}; - try { - data = yaml.safeLoad(fs.readFileSync(input_file, 'utf8')); - } catch (e) { - console.log(colors.red(e)); - } - return write_cloud_config_from_object(processor(_.clone(data)), output_file); -}; - -exports.write_files_from = function (local_dir, remote_dir) { - try { - return _.map(fs.readdirSync(local_dir), function (fn) { - return { - path: [remote_dir, fn].join('/'), - owner: 'root', - permissions: '0640', - encoding: 'base64', - content: fs.readFileSync([local_dir, fn].join('/')).toString('base64'), - }; - }); - } catch (e) { - console.log(colors.red(e)); - } -}; diff --git a/docs/getting-started-guides/coreos/azure/lib/deployment_logic/kubernetes.js b/docs/getting-started-guides/coreos/azure/lib/deployment_logic/kubernetes.js deleted file mode 100644 index 2002b43a53..0000000000 --- a/docs/getting-started-guides/coreos/azure/lib/deployment_logic/kubernetes.js +++ /dev/null @@ -1,77 +0,0 @@ -var _ = require('underscore'); -_.mixin(require('underscore.string').exports()); - -var util = require('../util.js'); -var cloud_config = require('../cloud_config.js'); - - -etcd_initial_cluster_conf_self = function (conf) { - var port = '2380'; - - var data = { - nodes: _(conf.nodes.etcd).times(function (n) { - var host = util.hostname(n, 'etcd'); - return [host, [host, port].join(':')].join('=http://'); - }), - }; - - return { - 'name': 'etcd2.service', - 'drop-ins': [{ - 'name': '50-etcd-initial-cluster.conf', - 'content': _.template("[Service]\nEnvironment=ETCD_INITIAL_CLUSTER=<%= nodes.join(',') %>\n")(data), - }], - }; -}; - -etcd_initial_cluster_conf_kube = function (conf) { - var port = '4001'; - - var data = { - nodes: _(conf.nodes.etcd).times(function (n) { - var host = util.hostname(n, 'etcd'); - return 'http://' + [host, port].join(':'); - }), - }; - - return { - 'name': 'kube-apiserver.service', - 'drop-ins': [{ - 'name': '50-etcd-initial-cluster.conf', - 'content': _.template("[Service]\nEnvironment=ETCD_SERVERS=--etcd-servers=<%= nodes.join(',') %>\n")(data), - }], - }; -}; - -exports.create_etcd_cloud_config = function (node_count, conf) { - var input_file = './cloud_config_templates/kubernetes-cluster-etcd-node-template.yml'; - var output_file = util.join_output_file_path('kubernetes-cluster-etcd-nodes', 'generated.yml'); - - return cloud_config.process_template(input_file, output_file, function(data) { - data.coreos.units.push(etcd_initial_cluster_conf_self(conf)); - return data; - }); -}; - -exports.create_node_cloud_config = function (node_count, conf) { - var elected_node = 0; - - var input_file = './cloud_config_templates/kubernetes-cluster-main-nodes-template.yml'; - var output_file = util.join_output_file_path('kubernetes-cluster-main-nodes', 'generated.yml'); - - var make_node_config = function (n) { - return cloud_config.generate_environment_file_entry_from_object(util.hostname(n, 'kube'), { - weave_password: conf.weave_salt, - weave_peers: n === elected_node ? "" : util.hostname(elected_node, 'kube'), - breakout_route: util.ipv4([10, 2, 0, 0], 16), - bridge_address_cidr: util.ipv4([10, 2, n, 1], 24), - }); - }; - - var write_files_extra = cloud_config.write_files_from('addons', '/etc/kubernetes/addons'); - return cloud_config.process_template(input_file, output_file, function(data) { - data.write_files = data.write_files.concat(_(node_count).times(make_node_config), write_files_extra); - data.coreos.units.push(etcd_initial_cluster_conf_kube(conf)); - return data; - }); -}; diff --git a/docs/getting-started-guides/coreos/azure/lib/util.js b/docs/getting-started-guides/coreos/azure/lib/util.js deleted file mode 100644 index 2c88b8cff3..0000000000 --- a/docs/getting-started-guides/coreos/azure/lib/util.js +++ /dev/null @@ -1,33 +0,0 @@ -var _ = require('underscore'); -_.mixin(require('underscore.string').exports()); - -exports.ipv4 = function (ocets, prefix) { - return { - ocets: ocets, - prefix: prefix, - toString: function () { - return [ocets.join('.'), prefix].join('/'); - } - } -}; - -exports.hostname = function hostname (n, prefix) { - return _.template("<%= pre %>-<%= seq %>")({ - pre: prefix || 'core', - seq: _.pad(n, 2, '0'), - }); -}; - -exports.rand_string = function () { - var crypto = require('crypto'); - var shasum = crypto.createHash('sha256'); - shasum.update(crypto.randomBytes(256)); - return shasum.digest('hex'); -}; - - -exports.rand_suffix = exports.rand_string().substring(50); - -exports.join_output_file_path = function(prefix, suffix) { - return './output/' + [prefix, exports.rand_suffix, suffix].join('_'); -}; diff --git a/docs/getting-started-guides/coreos/azure/package.json b/docs/getting-started-guides/coreos/azure/package.json index 3f7e05f737..2ab720ea45 100644 --- a/docs/getting-started-guides/coreos/azure/package.json +++ b/docs/getting-started-guides/coreos/azure/package.json @@ -9,7 +9,7 @@ "author": "Ilya Dmitrichenko ", "license": "Apache 2.0", "dependencies": { - "azure-cli": "^0.9.9", + "azure-cli": "^0.10.1", "colors": "^1.0.3", "js-yaml": "^3.2.5", "openssl-wrapper": "^0.2.1", diff --git a/docs/getting-started-guides/coreos/azure/scale-kubernetes-cluster.js b/docs/getting-started-guides/coreos/azure/scale-kubernetes-cluster.js deleted file mode 100755 index f606898874..0000000000 --- a/docs/getting-started-guides/coreos/azure/scale-kubernetes-cluster.js +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/bin/env node - -var azure = require('./lib/azure_wrapper.js'); -var kube = require('./lib/deployment_logic/kubernetes.js'); - -azure.load_state_for_resizing(process.argv[2], 'kube', parseInt(process.argv[3] || 1)); - -azure.run_task_queue([ - azure.queue_machines('kube', 'stable', kube.create_node_cloud_config), -]); diff --git a/docs/getting-started-guides/coreos/bare_metal_calico.md b/docs/getting-started-guides/coreos/bare_metal_calico.md index b3f4890398..a8e6fe6be3 100644 --- a/docs/getting-started-guides/coreos/bare_metal_calico.md +++ b/docs/getting-started-guides/coreos/bare_metal_calico.md @@ -1,4 +1,5 @@ --- + --- This document describes how to deploy Kubernetes with Calico networking on _bare metal_ CoreOS. For more information on Project Calico, visit [projectcalico.org](http://projectcalico.org) and the [calico-containers repository](https://github.com/projectcalico/calico-containers). @@ -168,7 +169,7 @@ kubectl create -f https://raw.githubusercontent.com/projectcalico/calico-cni/k8s ## Launch other Services With Calico-Kubernetes -At this point, you have a fully functioning cluster running on Kubernetes with a master and two nodes networked with Calico. You can now follow any of the [standard documentation](https://github.com/kubernetes/kubernetes/tree/{{page.version}}/examples/) to set up other services on your cluster. +At this point, you have a fully functioning cluster running on Kubernetes with a master and two nodes networked with Calico. You can now follow any of the [standard documentation](https://github.com/kubernetes/kubernetes/tree/{{page.version}}.0/examples/) to set up other services on your cluster. ## Connectivity to outside the cluster diff --git a/docs/getting-started-guides/coreos/bare_metal_offline.md b/docs/getting-started-guides/coreos/bare_metal_offline.md index f243caf81d..e513831f4e 100644 --- a/docs/getting-started-guides/coreos/bare_metal_offline.md +++ b/docs/getting-started-guides/coreos/bare_metal_offline.md @@ -1,7 +1,11 @@ --- +assignees: +- erictune +- thockin + --- -Deploy a CoreOS running Kubernetes environment. This particular guild is made to help those in an OFFLINE system, wither for testing a POC before the real deal, or you are restricted to be totally offline for your applications. +Deploy a CoreOS running Kubernetes environment. This particular guide is made to help those in an OFFLINE system, wither for testing a POC before the real deal, or you are restricted to be totally offline for your applications. * TOC {:toc} diff --git a/docs/getting-started-guides/coreos/coreos_multinode_cluster.md b/docs/getting-started-guides/coreos/coreos_multinode_cluster.md index cc786e3ec4..fe1a164df6 100644 --- a/docs/getting-started-guides/coreos/coreos_multinode_cluster.md +++ b/docs/getting-started-guides/coreos/coreos_multinode_cluster.md @@ -1,4 +1,7 @@ --- +assignees: +- dchen1107 + --- Use the [master.yaml](/docs/getting-started-guides/coreos/cloud-configs/master.yaml) and [node.yaml](/docs/getting-started-guides/coreos/cloud-configs/node.yaml) cloud-configs to provision a multi-node Kubernetes cluster. diff --git a/docs/getting-started-guides/coreos/index.md b/docs/getting-started-guides/coreos/index.md index e56ebd16e0..c119477b19 100644 --- a/docs/getting-started-guides/coreos/index.md +++ b/docs/getting-started-guides/coreos/index.md @@ -1,4 +1,5 @@ --- + --- * TOC @@ -16,6 +17,10 @@ Guide and CLI tool for setting up a multi-node cluster on AWS. CloudFormation is
    +[**Bare Metal Multi-Node**](https://coreos.com/kubernetes/docs/latest/kubernetes-on-baremetal.html#automated-provisioning) + +Guide and HTTP/API service for PXE booting and provisioning a multi-node cluster on bare metal. [Ignition](https://coreos.com/ignition/docs/latest/) is used to provision a master and multiple workers on the first boot from disk. + [**Vagrant Multi-Node**](https://coreos.com/kubernetes/docs/latest/kubernetes-on-vagrant.html) Guide to setting up a multi-node cluster on Vagrant. The deployer can independently configure the number of etcd nodes, master nodes, and worker nodes to bring up a fully HA control plane. @@ -82,6 +87,12 @@ Guide to running an HA etcd cluster with a single master on Azure. Uses the Azur Configure a single master, single worker cluster on VMware ESXi. +
    + +[**Single/Multi-node cluster using cloud-config, CoreOS and Foreman**](https://github.com/johscheuer/theforeman-coreos-kubernetes) + +Configure a standalone Kubernetes or a Kubernetes cluster with [Foreman](https://theforeman.org). + ## Support Level diff --git a/docs/getting-started-guides/dcos.md b/docs/getting-started-guides/dcos.md index 442c485bf9..43c6d28e36 100644 --- a/docs/getting-started-guides/dcos.md +++ b/docs/getting-started-guides/dcos.md @@ -1,4 +1,7 @@ --- +assignees: +- karlkfi + --- This guide will walk you through installing [Kubernetes-Mesos](https://github.com/mesosphere/kubernetes-mesos) on [Datacenter Operating System (DCOS)](https://mesosphere.com/product/) with the [DCOS CLI](https://github.com/mesosphere/dcos-cli) and operating Kubernetes with the [DCOS Kubectl plugin](https://github.com/mesosphere/dcos-kubectl). diff --git a/docs/getting-started-guides/docker-multinode.md b/docs/getting-started-guides/docker-multinode.md new file mode 100644 index 0000000000..5826a1bb20 --- /dev/null +++ b/docs/getting-started-guides/docker-multinode.md @@ -0,0 +1,118 @@ +--- +--- + +* TOC +{:toc} + + +## Prerequisites + +The only thing you need is a linux machine with **Docker 1.10.0 or higher** + +## Overview + +This guide will set up a 2-node Kubernetes cluster, consisting of a _master_ node which hosts the API server and orchestrates work +and a _worker_ node which receives work from the master. You can repeat the process of adding worker nodes an arbitrary number of +times to create larger clusters. + +Here's a diagram of what the final result will look like: +![Kubernetes on Docker](https://github.com/kubernetes/kubernetes/blob/master/docs/getting-started-guides/k8s-docker.png) + +### Bootstrap Docker + +This guide uses a pattern of running two instances of the Docker daemon: + 1) A _bootstrap_ Docker instance which is used to start `etcd` and `flanneld`, on which the Kubernetes components depend + 2) A _main_ Docker instance which is used for the Kubernetes infrastructure and user's scheduled containers + +This pattern is necessary because the `flannel` daemon is responsible for setting up and managing the network that interconnects +all of the Docker containers created by Kubernetes. To achieve this, it must run outside of the _main_ Docker daemon. However, +it is still useful to use containers for deployment and management, so we create a simpler _bootstrap_ daemon to achieve this. + +### Versions supported + +v1.2.x and v1.3.x are supported versions for this deployment. +v1.3.0 alphas and betas might work, but be sure you know what you're doing if you're trying them out. + +### Multi-arch solution + +Yeah, it's true. You may run this deployment setup seamlessly on `amd64`, `arm`, `arm64` and `ppc64le` hosts. +See this tracking issue for more details: https://github.com/kubernetes/kubernetes/issues/17981 + +v1.3.0 ships with support for amd64, arm and arm64. ppc64le isn't supported, due to a bug in the Go runtime, `hyperkube` (only!) isn't built for the stable v1.3.0 release, and therefore this guide can't run it. But you may still run Kubernetes on ppc64le via custom deployments. + +hyperkube was pushed for ppc64le at versions `v1.3.0-alpha.3` and `v1.3.0-alpha.4`, feel free to try them out, but there might be some unexpected bugs. + +### Options/configuration + +The scripts will output something like this when starting: + +```shell ++++ [0611 12:50:12] K8S_VERSION is set to: v1.3.0 ++++ [0611 12:50:12] ETCD_VERSION is set to: 2.2.5 ++++ [0611 12:50:12] FLANNEL_VERSION is set to: 0.5.5 ++++ [0611 12:50:12] FLANNEL_IPMASQ is set to: true ++++ [0611 12:50:12] FLANNEL_NETWORK is set to: 10.1.0.0/16 ++++ [0611 12:50:12] FLANNEL_BACKEND is set to: udp ++++ [0611 12:50:12] RESTART_POLICY is set to: unless-stopped ++++ [0611 12:50:12] MASTER_IP is set to: 192.168.1.50 ++++ [0611 12:50:12] ARCH is set to: amd64 ++++ [0611 12:50:12] NET_INTERFACE is set to: eth0 +``` + +Each of these options are overridable by `export`ing the values before running the script. + +## Setup the master node + +The first step in the process is to initialize the master node. + +Clone the `kube-deploy` repo, and run [master.sh](master.sh) on the master machine _with root_: + +```shell +$ git clone https://github.com/kubernetes/kube-deploy +$ cd kube-deploy/docker-multinode +$ ./master.sh +``` + +First, the `bootstrap` docker daemon is started, then `etcd` and `flannel` are started as containers in the bootstrap daemon. +Then, the main docker daemon is restarted, and this is an OS/distro-specific tasks, so if it doesn't work for your distro, feel free to contribute! + +Lastly, it launches `kubelet` in the main docker daemon, and the `kubelet` in turn launches the control plane (apiserver, controller-manager and scheduler) as static pods. + +## Adding a worker node + +Once your master is up and running you can add one or more workers on different machines. + +Clone the `kube-deploy` repo, and run [worker.sh](worker.sh) on the worker machine _with root_: + +```shell +$ git clone https://github.com/kubernetes/kube-deploy +$ cd docker-multinode +$ export MASTER_IP=${SOME_IP} +$ ./worker.sh +``` + +First, the `bootstrap` docker daemon is started, then `flannel` is started as a container in the bootstrap daemon, in order to set up the overlay network. +Then, the main docker daemon is restarted and lastly `kubelet` is launched as a container in the main docker daemon. + +## Addons + +kube-dns and the dashboard are deployed automatically with v1.3.0 + +### Deploy DNS manually for v1.2.x + +Just specify the architecture, and deploy via these commands: + +```shell +# Possible options: amd64, arm, arm64 and ppc64le +$ export ARCH=amd64 + +# If the kube-system namespace isn't already created, create it +$ kubectl get ns +$ kubectl create namespace kube-system + +$ sed -e "s/ARCH/${ARCH}/g;" skydns.yaml | kubectl create -f - +``` + +### Test if DNS works + +Follow [this link](https://releases.k8s.io/release-1.2/cluster/addons/dns#how-do-i-test-if-it-is-working) to check it out. diff --git a/docs/getting-started-guides/docker-multinode/OWNERS b/docs/getting-started-guides/docker-multinode/OWNERS new file mode 100644 index 0000000000..934690d3cf --- /dev/null +++ b/docs/getting-started-guides/docker-multinode/OWNERS @@ -0,0 +1,4 @@ +assignees: +- dchen1107 +- resouer + diff --git a/docs/getting-started-guides/docker-multinode/deployDNS.md b/docs/getting-started-guides/docker-multinode/deployDNS.md deleted file mode 100644 index e970807e48..0000000000 --- a/docs/getting-started-guides/docker-multinode/deployDNS.md +++ /dev/null @@ -1,36 +0,0 @@ ---- ---- - -### Get the template file - -First of all, download the dns template - -[skydns template](/docs/getting-started-guides/docker-multinode/skydns.yaml.in) - -### Set environment variables - -Then you need to set `DNS_REPLICAS`, `DNS_DOMAIN` and `DNS_SERVER_IP` envs - -```shell -$ export DNS_REPLICAS=1 - -$ export DNS_DOMAIN=cluster.local # specify in startup parameter `--cluster-domain` for containerized kubelet - -$ export DNS_SERVER_IP=10.0.0.10 # specify in startup parameter `--cluster-dns` for containerized kubelet -``` - -### Replace the corresponding value in the template and create the pod - -```shell{% raw %} -$ sed -e "s/{{ pillar\['dns_replicas'\] }}/${DNS_REPLICAS}/g;s/{{ pillar\['dns_domain'\] }}/${DNS_DOMAIN}/g;s/{{ pillar\['dns_server'\] }}/${DNS_SERVER_IP}/g" skydns.yaml.in > ./skydns.yaml - -# If the kube-system namespace isn't already created, create it -$ kubectl get ns -$ kubectl create namespace kube-system - -$ kubectl create -f ./skydns.yaml{% endraw %} -``` - -### Test if DNS works - -Follow [this link](https://releases.k8s.io/{{page.githubbranch}}/cluster/addons/dns#how-do-i-test-if-it-is-working) to check it out. diff --git a/docs/getting-started-guides/docker-multinode/index.md b/docs/getting-started-guides/docker-multinode/index.md deleted file mode 100644 index ec7e033e1b..0000000000 --- a/docs/getting-started-guides/docker-multinode/index.md +++ /dev/null @@ -1,99 +0,0 @@ ---- ---- - -_Note_: -These instructions are somewhat significantly more advanced than the [single node](/docs/getting-started-guides/docker) instructions. If you are -interested in just starting to explore Kubernetes, we recommend that you start there. - -* TOC -{:toc} - -## Prerequisites - -The only thing you need is a machine with **Docker 1.7.1 or higher** - -## Overview - -This guide will set up a 2-node Kubernetes cluster, consisting of a _master_ node which hosts the API server and orchestrates work -and a _worker_ node which receives work from the master. You can repeat the process of adding worker nodes an arbitrary number of -times to create larger clusters. - -Here's a diagram of what the final result will look like: - -![Kubernetes Single Node on Docker](/images/docs/k8s-docker.png) - -### Bootstrap Docker - -This guide also uses a pattern of running two instances of the Docker daemon - 1) A _bootstrap_ Docker instance which is used to start system daemons like `flanneld` and `etcd` - 2) A _main_ Docker instance which is used for the Kubernetes infrastructure and user's scheduled containers - -This pattern is necessary because the `flannel` daemon is responsible for setting up and managing the network that interconnects -all of the Docker containers created by Kubernetes. To achieve this, it must run outside of the _main_ Docker daemon. However, -it is still useful to use containers for deployment and management, so we create a simpler _bootstrap_ daemon to achieve this. - -You can specify the version on every node before install: - -```shell -export K8S_VERSION= -export ETCD_VERSION= -export FLANNEL_VERSION= -export FLANNEL_IFACE= -export FLANNEL_IPMASQ= -``` - -Otherwise, we'll use latest `hyperkube` image as default k8s version. - -## Master Node - -The first step in the process is to initialize the master node. - -The MASTER_IP step here is optional, it defaults to the first value of `hostname -I`. -Clone the Kubernetes repo, and run [master.sh](/docs/getting-started-guides/docker-multinode/master.sh) on the master machine _with root_: - -```shell -$ export MASTER_IP= -$ cd kubernetes/docs/getting-started-guides/docker-multinode/ -$ ./master.sh -``` - -`Master done!` - -See [here](/docs/getting-started-guides/docker-multinode/master) for detailed instructions explanation. - -## Adding a worker node - -Once your master is up and running you can add one or more workers on different machines. - -Clone the Kubernetes repo, and run [worker.sh](/docs/getting-started-guides/docker-multinode/worker.sh) on the worker machine _with root_: - -```shell -$ export MASTER_IP= -$ cd kubernetes/docs/getting-started-guides/docker-multinode/ -$ ./worker.sh -``` - -`Worker done!` - -See [here](/docs/getting-started-guides/docker-multinode/worker) for a detailed explanation. - -## Deploy a DNS - -See [here](/docs/getting-started-guides/docker-multinode/deployDNS) for instructions. - -## Testing your cluster - -Once your cluster has been created you can [test it out](/docs/getting-started-guides/docker-multinode/testing) - -For more complete applications, please look in the [examples directory](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/) - -## Support Level - - -IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level --------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ---------------------------- -Docker Multi Node | custom | N/A | flannel | [docs](/docs/getting-started-guides/docker-multinode) | | Project ([@brendandburns](https://github.com/brendandburns)) - - -For support level information on all solutions, see the [Table of solutions](/docs/getting-started-guides/#table-of-solutions) chart. - diff --git a/docs/getting-started-guides/docker-multinode/kube-system.yaml b/docs/getting-started-guides/docker-multinode/kube-system.yaml deleted file mode 100644 index 986f4b4822..0000000000 --- a/docs/getting-started-guides/docker-multinode/kube-system.yaml +++ /dev/null @@ -1,4 +0,0 @@ -apiVersion: v1 -kind: Namespace -metadata: - name: kube-system diff --git a/docs/getting-started-guides/docker-multinode/master.md b/docs/getting-started-guides/docker-multinode/master.md deleted file mode 100644 index 4b297458bf..0000000000 --- a/docs/getting-started-guides/docker-multinode/master.md +++ /dev/null @@ -1,244 +0,0 @@ ---- ---- - -We'll begin by setting up the master node. For the purposes of illustration, we'll assume that the IP of this machine -is `${MASTER_IP}`. We'll need to run several versioned Kubernetes components, so we'll assume that the version we want -to run is `${K8S_VERSION}`, which should hold a released version of Kubernetes >= "1.2.1" - -Environment variables used: - -```shell -export MASTER_IP= -export K8S_VERSION= -export ETCD_VERSION= -export FLANNEL_VERSION= -export FLANNEL_IFACE= -export FLANNEL_IPMASQ= -``` - -There are two main phases to installing the master: - - * [Setting up `flanneld` and `etcd`](#setting-up-flanneld-and-etcd) - * [Starting the Kubernetes master components](#starting-the-kubernetes-master) - - -## Setting up flanneld and etcd - -_Note_: -This guide expects **Docker 1.7.1 or higher**. - -### Setup Docker Bootstrap - -We're going to use `flannel` to set up networking between Docker daemons. Flannel itself (and etcd on which it relies) will run inside of -Docker containers themselves. To achieve this, we need a separate "bootstrap" instance of the Docker daemon. This daemon will be started with -`--iptables=false` so that it can only run containers with `--net=host`. That's sufficient to bootstrap our system. - -Run: - -```shell -sudo sh -c 'docker -d -H unix:///var/run/docker-bootstrap.sock -p /var/run/docker-bootstrap.pid --iptables=false --ip-masq=false --bridge=none --graph=/var/lib/docker-bootstrap 2> /var/log/docker-bootstrap.log 1> /dev/null &' -``` - -_If you have Docker 1.8.0 or higher run this instead_ - -```shell -sudo sh -c 'docker daemon -H unix:///var/run/docker-bootstrap.sock -p /var/run/docker-bootstrap.pid --iptables=false --ip-masq=false --bridge=none --graph=/var/lib/docker-bootstrap 2> /var/log/docker-bootstrap.log 1> /dev/null &' -``` - -_Important Note_: -If you are running this on a long running system, rather than experimenting, you should run the bootstrap Docker instance under something like SysV init, upstart or systemd so that it is restarted -across reboots and failures. - - -### Startup etcd for flannel and the API server to use - -Run: - -```shell -sudo docker -H unix:///var/run/docker-bootstrap.sock run -d \ - --net=host \ - gcr.io/google_containers/etcd-amd64:${ETCD_VERSION} \ - /usr/local/bin/etcd \ - --listen-client-urls=http://127.0.0.1:4001,http://${MASTER_IP}:4001 \ - --advertise-client-urls=http://${MASTER_IP}:4001 \ - --data-dir=/var/etcd/data -``` - -Next, you need to set a CIDR range for flannel. This CIDR should be chosen to be non-overlapping with any existing network you are using: - -```shell -sudo docker -H unix:///var/run/docker-bootstrap.sock run \ - --net=host \ - gcr.io/google_containers/etcd-amd64:${ETCD_VERSION} \ - etcdctl set /coreos.com/network/config '{ "Network": "10.1.0.0/16" }' -``` - - -### Set up Flannel on the master node - -Flannel is a network abstraction layer build by CoreOS, we will use it to provide simplified networking between our Pods of containers. - -Flannel re-configures the bridge that Docker uses for networking. As a result we need to stop Docker, reconfigure its networking, and then restart Docker. - -#### Bring down Docker - -To re-configure Docker to use flannel, we need to take docker down, run flannel and then restart Docker. - -Turning down Docker is system dependent, it may be: - -```shell -sudo /etc/init.d/docker stop -``` - -or - -```shell -sudo systemctl stop docker -``` - -or - -```shell -sudo service docker stop -``` - -or it may be something else. - -#### Run flannel - -Now run flanneld itself: - -```shell -sudo docker -H unix:///var/run/docker-bootstrap.sock run -d \ - --net=host \ - --privileged \ - -v /dev/net:/dev/net \ - quay.io/coreos/flannel:${FLANNEL_VERSION} \ - /opt/bin/flanneld \ - --ip-masq=${FLANNEL_IPMASQ} \ - --iface=${FLANNEL_IFACE} -``` - -The previous command should have printed a really long hash, the container id, copy this hash. - -Now get the subnet settings from flannel: - -```shell -sudo docker -H unix:///var/run/docker-bootstrap.sock exec cat /run/flannel/subnet.env -``` - -#### Edit the docker configuration - -You now need to edit the docker configuration to activate new flags. Again, this is system specific. - -This may be in `/etc/default/docker` or `/etc/systemd/service/docker.service` or it may be elsewhere. - -Regardless, you need to add the following to the docker command line: - -```shell ---bip=${FLANNEL_SUBNET} --mtu=${FLANNEL_MTU} -``` - -#### Remove the existing Docker bridge - -Docker creates a bridge named `docker0` by default. You need to remove this: - -```shell -sudo /sbin/ifconfig docker0 down -sudo brctl delbr docker0 -``` - -You may need to install the `bridge-utils` package for the `brctl` binary. - -#### Restart Docker - -Again this is system dependent, it may be: - -```shell -sudo /etc/init.d/docker start -``` - -it may be: - -```shell -systemctl start docker -``` - -## Starting the Kubernetes Master - -Ok, now that your networking is set up, you can startup Kubernetes, this is the same as the single-node case, we will use the "main" instance of the Docker daemon for the Kubernetes components. - -```shell -sudo docker run \ - --volume=/:/rootfs:ro \ - --volume=/sys:/sys:ro \ - --volume=/var/lib/docker/:/var/lib/docker:rw \ - --volume=/var/lib/kubelet/:/var/lib/kubelet:rw \ - --volume=/var/run:/var/run:rw \ - --net=host \ - --privileged=true \ - --pid=host \ - -d \ - gcr.io/google_containers/hyperkube-amd64:v${K8S_VERSION} \ - /hyperkube kubelet \ - --allow-privileged=true \ - --api-servers=http://localhost:8080 \ - --v=2 \ - --address=0.0.0.0 \ - --enable-server \ - --hostname-override=127.0.0.1 \ - --config=/etc/kubernetes/manifests-multi \ - --containerized \ - --cluster-dns=10.0.0.10 \ - --cluster-domain=cluster.local -``` - -> Note that `--cluster-dns` and `--cluster-domain` is used to deploy dns, feel free to discard them if dns is not needed. - -### Test it out - -At this point, you should have a functioning 1-node cluster. Let's test it out! - -Download the kubectl binary for `${K8S_VERSION}` ({{page.version}}) and make it available by editing your PATH environment variable. -([OS X/amd64](http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0-alpha.7/bin/darwin/amd64/kubectl)) -([OS X/386](http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0-alpha.7/bin/darwin/386/kubectl)) -([linux/amd64](http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0-alpha.7/bin/linux/amd64/kubectl)) -([linux/386](http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0-alpha.7/bin/linux/386/kubectl)) -([linux/arm](http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0-alpha.7/bin/linux/arm/kubectl)) - -For example, OS X: - -```shell -$ wget http://storage.googleapis.com/kubernetes-release/release/v${K8S_VERSION}/bin/darwin/amd64/kubectl -$ chmod 755 kubectl -$ PATH=$PATH:`pwd` -``` - -Linux: - -```shell -$ wget http://storage.googleapis.com/kubernetes-release/release/v${K8S_VERSION}/bin/linux/amd64/kubectl -$ chmod 755 kubectl -$ PATH=$PATH:`pwd` -``` - -Now you can list the nodes: - -```shell -kubectl get nodes -``` - -This should print something like: - -```shell -NAME LABELS STATUS -127.0.0.1 kubernetes.io/hostname=127.0.0.1 Ready -``` - -If the status of the node is `NotReady` or `Unknown` please check that all of the containers you created are successfully running. -If all else fails, ask questions on [Slack](/docs/troubleshooting/#slack). - - -### Next steps - -Move on to [adding one or more workers](/docs/getting-started-guides/docker-multinode/worker/) or [deploy a dns](/docs/getting-started-guides/docker-multinode/deployDNS/) diff --git a/docs/getting-started-guides/docker-multinode/master.sh b/docs/getting-started-guides/docker-multinode/master.sh deleted file mode 100755 index 0bc88c1075..0000000000 --- a/docs/getting-started-guides/docker-multinode/master.sh +++ /dev/null @@ -1,243 +0,0 @@ -#!/bin/bash - -# Copyright 2015 The Kubernetes Authors All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# A script to setup the k8s master in docker containers. -# Authors @wizard_cxy @resouer - -set -e - -# Make sure docker daemon is running -if ( ! ps -ef | grep "/usr/bin/docker" | grep -v 'grep' &> /dev/null ); then - echo "Docker is not running on this machine!" - exit 1 -fi - -# Make sure k8s version env is properly set -K8S_VERSION=${K8S_VERSION:-"1.2.2} -ETCD_VERSION=${ETCD_VERSION:-"2.3.1"} -FLANNEL_VERSION=${FLANNEL_VERSION:-"0.5.5"} -FLANNEL_IPMASQ=${FLANNEL_IPMASQ:-"true"} -FLANNEL_IFACE=${FLANNEL_IFACE:-"eth0"} -ARCH=${ARCH:-"amd64"} - -# Run as root -if [ "$(id -u)" != "0" ]; then - echo >&2 "Please run as root" - exit 1 -fi - -# Make sure master ip is properly set -if [ -z ${MASTER_IP} ]; then - MASTER_IP=$(hostname -I | awk '{print $1}') -fi - -echo "K8S_VERSION is set to: ${K8S_VERSION}" -echo "ETCD_VERSION is set to: ${ETCD_VERSION}" -echo "FLANNEL_VERSION is set to: ${FLANNEL_VERSION}" -echo "FLANNEL_IFACE is set to: ${FLANNEL_IFACE}" -echo "FLANNEL_IPMASQ is set to: ${FLANNEL_IPMASQ}" -echo "MASTER_IP is set to: ${MASTER_IP}" -echo "ARCH is set to: ${ARCH}" - -# Check if a command is valid -command_exists() { - command -v "$@" > /dev/null 2>&1 -} - -lsb_dist="" - -# Detect the OS distro, we support ubuntu, debian, mint, centos, fedora dist -detect_lsb() { - # TODO: remove this when ARM support is fully merged - case "$(uname -m)" in - *64) - ;; - *) - echo "Error: We currently only support 64-bit platforms." - exit 1 - ;; - esac - - if command_exists lsb_release; then - lsb_dist="$(lsb_release -si)" - fi - if [ -z ${lsb_dist} ] && [ -r /etc/lsb-release ]; then - lsb_dist="$(. /etc/lsb-release && echo "$DISTRIB_ID")" - fi - if [ -z ${lsb_dist} ] && [ -r /etc/debian_version ]; then - lsb_dist='debian' - fi - if [ -z ${lsb_dist} ] && [ -r /etc/fedora-release ]; then - lsb_dist='fedora' - fi - if [ -z ${lsb_dist} ] && [ -r /etc/os-release ]; then - lsb_dist="$(. /etc/os-release && echo "$ID")" - fi - - lsb_dist="$(echo ${lsb_dist} | tr '[:upper:]' '[:lower:]')" - - case "${lsb_dist}" in - amzn|centos|debian|ubuntu) - ;; - *) - echo "Error: We currently only support ubuntu|debian|amzn|centos." - exit 1 - ;; - esac -} - - -# Start the bootstrap daemon -# TODO: do not start docker-bootstrap if it's already running -bootstrap_daemon() { - # Detecting docker version so we could run proper docker_daemon command - [[ $(eval "docker --version") =~ ([0-9][.][0-9][.][0-9]*) ]] && version="${BASH_REMATCH[1]}" - local got=$(echo -e "${version}\n1.8.0" | sed '/^$/d' | sort -nr | head -1) - if [[ "${got}" = "${version}" ]]; then - docker_daemon="docker -d" - else - docker_daemon="docker daemon" - fi - ${docker_daemon} \ - -H unix:///var/run/docker-bootstrap.sock \ - -p /var/run/docker-bootstrap.pid \ - --iptables=false \ - --ip-masq=false \ - --bridge=none \ - --graph=/var/lib/docker-bootstrap \ - 2> /var/log/docker-bootstrap.log \ - 1> /dev/null & - - sleep 5 -} - -# Start k8s components in containers -DOCKER_CONF="" - -start_k8s(){ - # Start etcd - docker -H unix:///var/run/docker-bootstrap.sock run \ - --restart=on-failure \ - --net=host \ - -d \ - gcr.io/google_containers/etcd-${ARCH}:${ETCD_VERSION} \ - /usr/local/bin/etcd \ - --listen-client-urls=http://127.0.0.1:4001,http://${MASTER_IP}:4001 \ - --advertise-client-urls=http://${MASTER_IP}:4001 \ - --data-dir=/var/etcd/data - - sleep 5 - # Set flannel net config - docker -H unix:///var/run/docker-bootstrap.sock run \ - --net=host gcr.io/google_containers/etcd:${ETCD_VERSION} \ - etcdctl \ - set /coreos.com/network/config \ - '{ "Network": "10.1.0.0/16", "Backend": {"Type": "vxlan"}}' - - # iface may change to a private network interface, eth0 is for default - flannelCID=$(docker -H unix:///var/run/docker-bootstrap.sock run \ - --restart=on-failure \ - -d \ - --net=host \ - --privileged \ - -v /dev/net:/dev/net \ - quay.io/coreos/flannel:${FLANNEL_VERSION} \ - /opt/bin/flanneld \ - --ip-masq="${FLANNEL_IPMASQ}" \ - --iface="${FLANNEL_IFACE}") - - sleep 8 - - # Copy flannel env out and source it on the host - docker -H unix:///var/run/docker-bootstrap.sock \ - cp ${flannelCID}:/run/flannel/subnet.env . - source subnet.env - - # Configure docker net settings, then restart it - case "${lsb_dist}" in - amzn) - DOCKER_CONF="/etc/sysconfig/docker" - echo "OPTIONS=\"\$OPTIONS --mtu=${FLANNEL_MTU} --bip=${FLANNEL_SUBNET}\"" | tee -a ${DOCKER_CONF} - ifconfig docker0 down - yum -y -q install bridge-utils && brctl delbr docker0 && service docker restart - ;; - centos) - DOCKER_CONF="/etc/sysconfig/docker" - sed -i "/^OPTIONS=/ s|\( --mtu=.*\)\?'$| --mtu=${FLANNEL_MTU} --bip=${FLANNEL_SUBNET}'|" ${DOCKER_CONF} - if ! command_exists ifconfig; then - yum -y -q install net-tools - fi - ifconfig docker0 down - yum -y -q install bridge-utils && brctl delbr docker0 && systemctl restart docker - ;; - ubuntu|debian) - DOCKER_CONF="/etc/default/docker" - echo "DOCKER_OPTS=\"\$DOCKER_OPTS --mtu=${FLANNEL_MTU} --bip=${FLANNEL_SUBNET}\"" | tee -a ${DOCKER_CONF} - ifconfig docker0 down - apt-get install bridge-utils - brctl delbr docker0 - service docker stop - while [ `ps aux | grep /usr/bin/docker | grep -v grep | wc -l` -gt 0 ]; do - echo "Waiting for docker to terminate" - sleep 1 - done - service docker start - ;; - *) - echo "Unsupported operations system ${lsb_dist}" - exit 1 - ;; - esac - - # sleep a little bit - sleep 5 - - # Start kubelet and then start master components as pods - docker run \ - --net=host \ - --pid=host \ - --privileged \ - --restart=on-failure \ - -d \ - -v /sys:/sys:ro \ - -v /var/run:/var/run:rw \ - -v /:/rootfs:ro \ - -v /var/lib/docker/:/var/lib/docker:rw \ - -v /var/lib/kubelet/:/var/lib/kubelet:rw \ - gcr.io/google_containers/hyperkube-${ARCH}:v${K8S_VERSION} \ - /hyperkube kubelet \ - --address=0.0.0.0 \ - --allow-privileged=true \ - --enable-server \ - --api-servers=http://localhost:8080 \ - --config=/etc/kubernetes/manifests-multi \ - --cluster-dns=10.0.0.10 \ - --cluster-domain=cluster.local \ - --containerized \ - --v=2 - -} - -echo "Detecting your OS distro ..." -detect_lsb - -echo "Starting bootstrap docker ..." -bootstrap_daemon - -echo "Starting k8s ..." -start_k8s - -echo "Master done!" diff --git a/docs/getting-started-guides/docker-multinode/skydns.yaml.in b/docs/getting-started-guides/docker-multinode/skydns.yaml.in deleted file mode 100644 index 098b85ddf3..0000000000 --- a/docs/getting-started-guides/docker-multinode/skydns.yaml.in +++ /dev/null @@ -1,136 +0,0 @@ -apiVersion: v1 -kind: ReplicationController -metadata: - name: kube-dns-v10 - namespace: kube-system - labels: - k8s-app: kube-dns - version: v10 - kubernetes.io/cluster-service: "true" -spec: - replicas: {{ pillar['dns_replicas'] }} - selector: - k8s-app: kube-dns - version: v10 - template: - metadata: - labels: - k8s-app: kube-dns - version: v10 - kubernetes.io/cluster-service: "true" - spec: - containers: - - name: etcd - image: gcr.io/google_containers/etcd-amd64:2.2.1 - resources: - # keep request = limit to keep this container in guaranteed class - limits: - cpu: 100m - memory: 50Mi - requests: - cpu: 100m - memory: 50Mi - command: - - /usr/local/bin/etcd - - -data-dir - - /var/etcd/data - - -listen-client-urls - - http://127.0.0.1:2379,http://127.0.0.1:4001 - - -advertise-client-urls - - http://127.0.0.1:2379,http://127.0.0.1:4001 - - -initial-cluster-token - - skydns-etcd - volumeMounts: - - name: etcd-storage - mountPath: /var/etcd/data - - name: kube2sky - image: gcr.io/google_containers/kube2sky:1.12 - resources: - # keep request = limit to keep this container in guaranteed class - limits: - cpu: 100m - memory: 50Mi - requests: - cpu: 100m - memory: 50Mi - args: - # command = "/kube2sky" - - --domain={{ pillar['dns_domain'] }} - - name: skydns - image: gcr.io/google_containers/skydns:2015-10-13-8c72f8c - resources: - # keep request = limit to keep this container in guaranteed class - limits: - cpu: 100m - memory: 50Mi - requests: - cpu: 100m - memory: 50Mi - args: - # command = "/skydns" - - -machines=http://127.0.0.1:4001 - - -addr=0.0.0.0:53 - - -ns-rotate=false - - -domain={{ pillar['dns_domain'] }}. - ports: - - containerPort: 53 - name: dns - protocol: UDP - - containerPort: 53 - name: dns-tcp - protocol: TCP - livenessProbe: - httpGet: - path: /healthz - port: 8080 - scheme: HTTP - initialDelaySeconds: 30 - timeoutSeconds: 5 - readinessProbe: - httpGet: - path: /healthz - port: 8080 - scheme: HTTP - initialDelaySeconds: 1 - timeoutSeconds: 5 - - name: healthz - image: gcr.io/google_containers/exechealthz:1.0 - resources: - # keep request = limit to keep this container in guaranteed class - limits: - cpu: 10m - memory: 20Mi - requests: - cpu: 10m - memory: 20Mi - args: - - -cmd=nslookup kubernetes.default.svc.{{ pillar['dns_domain'] }} 127.0.0.1 >/dev/null - - -port=8080 - ports: - - containerPort: 8080 - protocol: TCP - volumes: - - name: etcd-storage - emptyDir: {} - dnsPolicy: Default # Don't use cluster DNS. ---- -apiVersion: v1 -kind: Service -metadata: - name: kube-dns - namespace: kube-system - labels: - k8s-app: kube-dns - kubernetes.io/cluster-service: "true" - kubernetes.io/name: "KubeDNS" -spec: - selector: - k8s-app: kube-dns - clusterIP: {{ pillar['dns_server'] }} - ports: - - name: dns - port: 53 - protocol: UDP - - name: dns-tcp - port: 53 - protocol: TCP diff --git a/docs/getting-started-guides/docker-multinode/testing.md b/docs/getting-started-guides/docker-multinode/testing.md deleted file mode 100644 index 196d15f19e..0000000000 --- a/docs/getting-started-guides/docker-multinode/testing.md +++ /dev/null @@ -1,68 +0,0 @@ ---- ---- - -To validate that your node(s) have been added, run: - -```shell -kubectl get nodes -``` - -That should show something like: - -```shell -NAME LABELS STATUS -10.240.99.26 kubernetes.io/hostname=10.240.99.26 Ready -127.0.0.1 kubernetes.io/hostname=127.0.0.1 Ready -``` - -If the status of any node is `Unknown` or `NotReady` your cluster is broken, double check that all containers are running properly, and if all else fails, contact us on [Slack](/docs/troubleshooting/#slack). - -### Run an application - -```shell -kubectl -s http://localhost:8080 run nginx --image=nginx --port=80 -``` - -now run `docker ps` you should see nginx running. You may need to wait a few minutes for the image to get pulled. - -### Expose it as a service - -```shell -kubectl expose rc nginx --port=80 -``` - -Run the following command to obtain the IP of this service we just created. There are two IPs, the first one is internal (CLUSTER_IP), and the second one is the external load-balanced IP. - -```shell -kubectl get svc nginx -``` - -Alternatively, you can obtain only the first IP (CLUSTER_IP) by running: - -```shell -{% raw %}kubectl get svc nginx --template={{.spec.clusterIP}}{% endraw %} -``` - -Hit the webserver with the first IP (CLUSTER_IP): - -```shell -curl -``` - -Note that you will need run this curl command on your boot2docker VM if you are running on OS X. - -### Scaling - -Now try to scale up the nginx you created before: - -```shell -kubectl scale rc nginx --replicas=3 -``` - -And list the pods - -```shell -kubectl get pods -``` - -You should see pods landing on the newly added machine. \ No newline at end of file diff --git a/docs/getting-started-guides/docker-multinode/worker.md b/docs/getting-started-guides/docker-multinode/worker.md deleted file mode 100644 index 799da471d4..0000000000 --- a/docs/getting-started-guides/docker-multinode/worker.md +++ /dev/null @@ -1,179 +0,0 @@ ---- ---- - -These instructions are very similar to the master set-up above, but they are duplicated for clarity. -You need to repeat these instructions for each node you want to join the cluster. -We will assume that you have the IP address of the master in `${MASTER_IP}` that you created in the [master instructions](/docs/getting-started-guides/docker-multinode/master/). We'll need to run several versioned Kubernetes components, so we'll assume that the version we want -to run is `${K8S_VERSION}`, which should hold a released version of Kubernetes >= "1.2.0-alpha.6" - -Enviroinment variables used: - -```shell -export MASTER_IP= -export K8S_VERSION= -export FLANNEL_VERSION= -export FLANNEL_IFACE= -export FLANNEL_IPMASQ= -``` - -For each worker node, there are three steps: - - * [Set up `flanneld` on the worker node](#set-up-flanneld-on-the-worker-node) - * [Start Kubernetes on the worker node](#start-kubernetes-on-the-worker-node) - * [Add the worker to the cluster](#add-the-node-to-the-cluster) - -### Set up Flanneld on the worker node - -As before, the Flannel daemon is going to provide network connectivity. - -_Note_: -This guide expects **Docker 1.7.1 or higher**. - - -#### Set up a bootstrap docker - -As previously, we need a second instance of the Docker daemon running to bootstrap the flannel networking. - -Run: - -```shell -sudo sh -c 'docker -d -H unix:///var/run/docker-bootstrap.sock -p /var/run/docker-bootstrap.pid --iptables=false --ip-masq=false --bridge=none --graph=/var/lib/docker-bootstrap 2> /var/log/docker-bootstrap.log 1> /dev/null &' -``` - -_If you have Docker 1.8.0 or higher run this instead_ - -```shell -sudo sh -c 'docker daemon -H unix:///var/run/docker-bootstrap.sock -p /var/run/docker-bootstrap.pid --iptables=false --ip-masq=false --bridge=none --graph=/var/lib/docker-bootstrap 2> /var/log/docker-bootstrap.log 1> /dev/null &' -``` - -_Important Note_: -If you are running this on a long running system, rather than experimenting, you should run the bootstrap Docker instance under something like SysV init, upstart or systemd so that it is restarted -across reboots and failures. - -#### Bring down Docker - -To re-configure Docker to use flannel, we need to take docker down, run flannel and then restart Docker. - -Turning down Docker is system dependent, it may be: - -```shell -sudo /etc/init.d/docker stop -``` - -or - -```shell -sudo systemctl stop docker -``` - -or it may be something else. - -#### Run flannel - -Now run flanneld itself, this call is slightly different from the above, since we point it at the etcd instance on the master. - -```shell -sudo docker -H unix:///var/run/docker-bootstrap.sock run -d \ - --net=host \ - --privileged \ - -v /dev/net:/dev/net \ - quay.io/coreos/flannel:${FLANNEL_VERSION} \ - /opt/bin/flanneld \ - --ip-masq=${FLANNEL_IPMASQ} \ - --etcd-endpoints=http://${MASTER_IP}:4001 \ - --iface=${FLANNEL_IFACE} -``` - -The previous command should have printed a really long hash, the container id, copy this hash. - -Now get the subnet settings from flannel: - -```shell -sudo docker -H unix:///var/run/docker-bootstrap.sock exec cat /run/flannel/subnet.env -``` - - -#### Edit the docker configuration - -You now need to edit the docker configuration to activate new flags. Again, this is system specific. - -This may be in `/etc/default/docker` or `/etc/systemd/service/docker.service` or it may be elsewhere. - -Regardless, you need to add the following to the docker command line: - -```shell ---bip=${FLANNEL_SUBNET} --mtu=${FLANNEL_MTU} -``` - -#### Remove the existing Docker bridge - -Docker creates a bridge named `docker0` by default. You need to remove this: - -```shell -sudo /sbin/ifconfig docker0 down -sudo brctl delbr docker0 -``` - -You may need to install the `bridge-utils` package for the `brctl` binary. - -#### Restart Docker - -Again this is system dependent, it may be: - -```shell -sudo /etc/init.d/docker start -``` - -or it may be: - -```shell -systemctl start docker -``` - -### Start Kubernetes on the worker node - -#### Run the kubelet - -Again this is similar to the above, but the `--api-servers` now points to the master we set up in the beginning. - -```shell -sudo docker run \ - --volume=/:/rootfs:ro \ - --volume=/sys:/sys:ro \ - --volume=/dev:/dev \ - --volume=/var/lib/docker/:/var/lib/docker:rw \ - --volume=/var/lib/kubelet/:/var/lib/kubelet:rw \ - --volume=/var/run:/var/run:rw \ - --net=host \ - --privileged=true \ - --pid=host \ - -d \ - gcr.io/google_containers/hyperkube-amd64:v${K8S_VERSION} \ - /hyperkube kubelet \ - --allow-privileged=true \ - --api-servers=http://${MASTER_IP}:8080 \ - --v=2 \ - --address=0.0.0.0 \ - --enable-server \ - --containerized \ - --cluster-dns=10.0.0.10 \ - --cluster-domain=cluster.local -``` - -#### Run the service proxy - -The service proxy provides load-balancing between groups of containers defined by Kubernetes `Services` - -```shell -sudo docker run -d \ - --net=host \ - --privileged \ - gcr.io/google_containers/hyperkube-amd64:v${K8S_VERSION} \ - /hyperkube proxy \ - --master=http://${MASTER_IP}:8080 \ - --v=2 -``` - -### Next steps - -Move on to [testing your cluster](/docs/getting-started-guides/docker-multinode/testing/) or [add another node](#adding-a-kubernetes-worker-node-via-docker) diff --git a/docs/getting-started-guides/docker-multinode/worker.sh b/docs/getting-started-guides/docker-multinode/worker.sh deleted file mode 100755 index 3989b5f09f..0000000000 --- a/docs/getting-started-guides/docker-multinode/worker.sh +++ /dev/null @@ -1,231 +0,0 @@ -#!/bin/bash - -# Copyright 2015 The Kubernetes Authors All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# A script to the k8s worker in docker containers. -# Authors @wizard_cxy @resouer - -set -e - -# Make sure docker daemon is running -if ( ! ps -ef | grep "/usr/bin/docker" | grep -v 'grep' &> /dev/null ); then - echo "Docker is not running on this machine!" - exit 1 -fi - -# Make sure k8s version env is properly set -K8S_VERSION=${K8S_VERSION:-"1.2.0-alpha.7"} -FLANNEL_VERSION=${FLANNEL_VERSION:-"0.5.5"} -FLANNEL_IFACE=${FLANNEL_IFACE:-"eth0"} -FLANNEL_IPMASQ=${FLANNEL_IPMASQ:-"true"} -ARCH=${ARCH:-"amd64"} - -# Run as root -if [ "$(id -u)" != "0" ]; then - echo >&2 "Please run as root" - exit 1 -fi - -# Make sure master ip is properly set -if [ -z ${MASTER_IP} ]; then - echo "Please export MASTER_IP in your env" - exit 1 -fi - -echo "K8S_VERSION is set to: ${K8S_VERSION}" -echo "FLANNEL_VERSION is set to: ${FLANNEL_VERSION}" -echo "FLANNEL_IFACE is set to: ${FLANNEL_IFACE}" -echo "FLANNEL_IPMASQ is set to: ${FLANNEL_IPMASQ}" -echo "MASTER_IP is set to: ${MASTER_IP}" -echo "ARCH is set to: ${ARCH}" - -# Check if a command is valid -command_exists() { - command -v "$@" > /dev/null 2>&1 -} - -lsb_dist="" - -# Detect the OS distro, we support ubuntu, debian, mint, centos, fedora dist -detect_lsb() { - case "$(uname -m)" in - *64) - ;; - *) - echo "Error: We currently only support 64-bit platforms." - exit 1 - ;; - esac - - if command_exists lsb_release; then - lsb_dist="$(lsb_release -si)" - fi - if [ -z ${lsb_dist} ] && [ -r /etc/lsb-release ]; then - lsb_dist="$(. /etc/lsb-release && echo "$DISTRIB_ID")" - fi - if [ -z ${lsb_dist} ] && [ -r /etc/debian_version ]; then - lsb_dist='debian' - fi - if [ -z ${lsb_dist} ] && [ -r /etc/fedora-release ]; then - lsb_dist='fedora' - fi - if [ -z ${lsb_dist} ] && [ -r /etc/os-release ]; then - lsb_dist="$(. /etc/os-release && echo "$ID")" - fi - - lsb_dist="$(echo ${lsb_dist} | tr '[:upper:]' '[:lower:]')" - - case "${lsb_dist}" in - amzn|centos|debian|ubuntu) - ;; - *) - echo "Error: We currently only support ubuntu|debian|amzn|centos." - exit 1 - ;; - esac -} - - -# Start the bootstrap daemon -bootstrap_daemon() { - # Detecting docker version so we could run proper docker_daemon command - [[ $(eval "docker --version") =~ ([0-9][.][0-9][.][0-9]*) ]] && version="${BASH_REMATCH[1]}" - local got=$(echo -e "${version}\n1.8.0" | sed '/^$/d' | sort -nr | head -1) - if [[ "${got}" = "${version}" ]]; then - docker_daemon="docker -d" - else - docker_daemon="docker daemon" - fi - ${docker_daemon} \ - -H unix:///var/run/docker-bootstrap.sock \ - -p /var/run/docker-bootstrap.pid \ - --iptables=false \ - --ip-masq=false \ - --bridge=none \ - --graph=/var/lib/docker-bootstrap \ - 2> /var/log/docker-bootstrap.log \ - 1> /dev/null & - - sleep 5 -} - -DOCKER_CONF="" - -# Start k8s components in containers -start_k8s() { - # Start flannel - flannelCID=$(docker -H unix:///var/run/docker-bootstrap.sock run \ - -d \ - --restart=on-failure \ - --net=host \ - --privileged \ - -v /dev/net:/dev/net \ - quay.io/coreos/flannel:${FLANNEL_VERSION} \ - /opt/bin/flanneld \ - --ip-masq="${FLANNEL_IPMASQ}" \ - --etcd-endpoints=http://${MASTER_IP}:4001 \ - --iface="${FLANNEL_IFACE}") - - sleep 10 - - # Copy flannel env out and source it on the host - docker -H unix:///var/run/docker-bootstrap.sock \ - cp ${flannelCID}:/run/flannel/subnet.env . - source subnet.env - - # Configure docker net settings, then restart it - case "${lsb_dist}" in - centos) - DOCKER_CONF="/etc/sysconfig/docker" - sed -i "/^OPTIONS=/ s|\( --mtu=.*\)\?'$| --mtu=${FLANNEL_MTU} --bip=${FLANNEL_SUBNET}'|" ${DOCKER_CONF} - if ! command_exists ifconfig; then - yum -y -q install net-tools - fi - ifconfig docker0 down - yum -y -q install bridge-utils && brctl delbr docker0 && systemctl restart docker - ;; - amzn) - DOCKER_CONF="/etc/sysconfig/docker" - echo "OPTIONS=\"\$OPTIONS --mtu=${FLANNEL_MTU} --bip=${FLANNEL_SUBNET}\"" | tee -a ${DOCKER_CONF} - ifconfig docker0 down - yum -y -q install bridge-utils && brctl delbr docker0 && service docker restart - ;; - ubuntu|debian) # TODO: today ubuntu uses systemd. Handle that too - DOCKER_CONF="/etc/default/docker" - echo "DOCKER_OPTS=\"\$DOCKER_OPTS --mtu=${FLANNEL_MTU} --bip=${FLANNEL_SUBNET}\"" | tee -a ${DOCKER_CONF} - ifconfig docker0 down - apt-get install bridge-utils - brctl delbr docker0 - service docker stop - while [ `ps aux | grep /usr/bin/docker | grep -v grep | wc -l` -gt 0 ]; do - echo "Waiting for docker to terminate" - sleep 1 - done - service docker start - ;; - *) - echo "Unsupported operations system ${lsb_dist}" - exit 1 - ;; - esac - - # sleep a little bit - sleep 5 - - # Start kubelet & proxy in container - # TODO: Use secure port for communication - docker run \ - --net=host \ - --pid=host \ - --privileged \ - --restart=on-failure \ - -d \ - -v /sys:/sys:ro \ - -v /var/run:/var/run:rw \ - -v /:/rootfs:ro \ - -v /var/lib/docker/:/var/lib/docker:rw \ - -v /var/lib/kubelet/:/var/lib/kubelet:rw \ - gcr.io/google_containers/hyperkube-${ARCH}:v${K8S_VERSION} \ - /hyperkube kubelet \ - --allow-privileged=true \ - --api-servers=http://${MASTER_IP}:8080 \ - --address=0.0.0.0 \ - --enable-server \ - --cluster-dns=10.0.0.10 \ - --cluster-domain=cluster.local \ - --containerized \ - --v=2 - - docker run \ - -d \ - --net=host \ - --privileged \ - --restart=on-failure \ - gcr.io/google_containers/hyperkube-${ARCH}:v${K8S_VERSION} \ - /hyperkube proxy \ - --master=http://${MASTER_IP}:8080 \ - --v=2 -} - -echo "Detecting your OS distro ..." -detect_lsb - -echo "Starting bootstrap docker ..." -bootstrap_daemon - -echo "Starting k8s ..." -start_k8s - -echo "Worker done!" diff --git a/docs/getting-started-guides/docker.md b/docs/getting-started-guides/docker.md deleted file mode 100644 index aa3bf9612a..0000000000 --- a/docs/getting-started-guides/docker.md +++ /dev/null @@ -1,227 +0,0 @@ ---- ---- - -The following instructions show you how to set up a simple, single node Kubernetes cluster using Docker. - -Here's a diagram of what the final result will look like: - -![Kubernetes Single Node on Docker](/images/docs/k8s-singlenode-docker.png) - -* TOC -{:toc} - -## Prerequisites - -1. You need to have docker installed on one machine. -2. Decide what Kubernetes version to use. Set the `${K8S_VERSION}` variable to - a released version of Kubernetes >= "v1.2.0". If you'd like to use the current stable version of Kubernetes, run the following: - -```sh -export K8S_VERSION=$(curl -sS https://storage.googleapis.com/kubernetes-release/release/stable.txt) -``` - -and for the latest available version (including unstable releases): - -```sh -export K8S_VERSION=$(curl -sS https://storage.googleapis.com/kubernetes-release/release/latest.txt) -``` - -### Run it - -```shell -export ARCH=amd64 -docker run -d \ - --volume=/:/rootfs:ro \ - --volume=/sys:/sys:rw \ - --volume=/var/lib/docker/:/var/lib/docker:rw \ - --volume=/var/lib/kubelet/:/var/lib/kubelet:rw \ - --volume=/var/run:/var/run:rw \ - --net=host \ - --pid=host \ - --privileged \ - gcr.io/google_containers/hyperkube-${ARCH}:${K8S_VERSION} \ - /hyperkube kubelet \ - --containerized \ - --hostname-override=127.0.0.1 \ - --api-servers=http://localhost:8080 \ - --config=/etc/kubernetes/manifests \ - --cluster-dns=10.0.0.10 \ - --cluster-domain=cluster.local \ - --allow-privileged --v=2 -``` - -> Note that `--cluster-dns` and `--cluster-domain` is used to deploy dns, feel free to discard them if dns is not needed. - -> If you would like to mount an external device as a volume, add `--volume=/dev:/dev` to the command above. It may however, cause some problems described in [#18230](https://github.com/kubernetes/kubernetes/issues/18230) - -> Architectures other than `amd64` are experimental and sometimes unstable, but feel free to try them out! Valid values: `arm`, `arm64` and `ppc64le`. ARM is available with Kubernetes version `v1.3.0-alpha.2` and higher. ARM 64-bit and PowerPC 64 little-endian are available with `v1.3.0-alpha.3` and higher. Track progress on multi-arch support [here](https://github.com/kubernetes/kubernetes/issues/17981) - -This actually runs the kubelet, which in turn runs a [pod](/docs/user-guide/pods/) that contains the other master components. - -** **SECURITY WARNING** ** services exposed via Kubernetes using Hyperkube are available on the host node's public network interface / IP address. Because of this, this guide is not suitable for any host node/server that is directly internet accessible. Refer to [#21735](https://github.com/kubernetes/kubernetes/issues/21735) for addtional info. - -### Download `kubectl` - -At this point you should have a running Kubernetes cluster. You can test it out -by downloading the kubectl binary for `${K8S_VERSION}` (in this example: `{{page.version}}.0`). - - -Downloads: - - - `linux/amd64`: http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/linux/amd64/kubectl - - `linux/386`: http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/linux/386/kubectl - - `linux/arm`: http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/linux/arm/kubectl - - `linux/arm64`: http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/linux/arm64/kubectl - - `linux/ppc64le`: http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/linux/ppc64le/kubectl - - `OS X/amd64`: http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/darwin/amd64/kubectl - - `OS X/386`: http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/darwin/386/kubectl - - `windows/amd64`: http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/windows/amd64/kubectl.exe - - `windows/386`: http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/windows/386/kubectl.exe - -The generic download path is: -``` -http://storage.googleapis.com/kubernetes-release/release/${K8S_VERSION}/bin/${GOOS}/${GOARCH}/${K8S_BINARY} -``` - -An example install with `linux/amd64`: - -``` -curl -sSL "http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/linux/amd64/kubectl" > /usr/bin/kubectl -chmod +x /usr/bin/kubectl -``` - -On OS X, to make the API server accessible locally, setup a ssh tunnel. - -```shell -docker-machine ssh `docker-machine active` -N -L 8080:localhost:8080 -``` - -Setting up a ssh tunnel is applicable to remote docker hosts as well. - -(Optional) Create kubernetes cluster configuration: - -```shell -kubectl config set-cluster test-doc --server=http://localhost:8080 -kubectl config set-context test-doc --cluster=test-doc -kubectl config use-context test-doc -``` - -### Test it out - -List the nodes in your cluster by running: - -```shell -kubectl get nodes -``` - -This should print: - -```shell -NAME STATUS AGE -127.0.0.1 Ready 1h -``` - -### Run an application - -```shell -kubectl run nginx --image=nginx --port=80 -``` - -Now run `docker ps` you should see nginx running. You may need to wait a few minutes for the image to get pulled. - -### Expose it as a service - -```shell -kubectl expose deployment nginx --port=80 -``` - -Run the following command to obtain the cluster local IP of this service we just created: - -```shell{% raw %} -ip=$(kubectl get svc nginx --template={{.spec.clusterIP}}) -echo $ip -{% endraw %}``` - -Hit the webserver with this IP: - -```shell{% raw %} -kubectl get svc nginx --template={{.spec.clusterIP}} -{% endraw %}``` - -On OS X, since docker is running inside a VM, run the following command instead: - -```shell -docker-machine ssh `docker-machine active` curl $ip -``` - -## Deploy a DNS - -See [here](/docs/getting-started-guides/docker-multinode/deployDNS/) for instructions. - -### Turning down your cluster - -1. Delete all the containers including the kubelet: - -Many of these containers run under the management of the `kubelet` binary, which attempts to keep containers running, even if they fail. -So, in order to turn down the cluster, you need to first kill the kubelet container, and then any other containers. - -You may use `docker rm -f $(docker ps -aq)`, note this removes _all_ containers running under Docker, so use with caution. - -2. Cleanup the filesystem: - -On OS X, first ssh into the docker VM: - -```shell -docker-machine ssh `docker-machine active` -``` - -```shell -sudo umount `cat /proc/mounts | grep /var/lib/kubelet | awk '{print $2}'` -sudo rm -rf /var/lib/kubelet -``` - -### Troubleshooting - -#### Node is in `NotReady` state - -If you see your node as `NotReady` it's possible that your OS does not have memcg enabled. - -1. Your kernel should support memory accounting. Ensure that the -following configs are turned on in your linux kernel: - -```shell -CONFIG_RESOURCE_COUNTERS=y -CONFIG_MEMCG=y -``` - -2. Enable the memory accounting in the kernel, at boot, as command line -parameters as follows: - -```shell -GRUB_CMDLINE_LINUX="cgroup_enable=memory=1" -``` - -NOTE: The above is specifically for GRUB2. -You can check the command line parameters passed to your kernel by looking at the -output of /proc/cmdline: - -```shell -$ cat /proc/cmdline -BOOT_IMAGE=/boot/vmlinuz-3.18.4-aufs root=/dev/sda5 ro cgroup_enable=memory=1 -``` -## Support Level - - -IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level --------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ---------------------------- -Docker Single Node | custom | N/A | local | [docs](/docs/getting-started-guides/docker) | | Project ([@brendandburns](https://github.com/brendandburns)) - - -For support level information on all solutions, see the [Table of solutions](/docs/getting-started-guides/#table-of-solutions) chart. - - -## Further reading - -Please see the [Kubernetes docs](/docs/) for more details on administering -and using a Kubernetes cluster. - diff --git a/docs/getting-started-guides/fedora/OWNERS b/docs/getting-started-guides/fedora/OWNERS new file mode 100644 index 0000000000..26456cebf2 --- /dev/null +++ b/docs/getting-started-guides/fedora/OWNERS @@ -0,0 +1,5 @@ +assignees: +- aveshagarwal +- eparis +- thockin + diff --git a/docs/getting-started-guides/fedora/fedora-calico.md b/docs/getting-started-guides/fedora/fedora-calico.md index a73b7e23bc..126db607f4 100644 --- a/docs/getting-started-guides/fedora/fedora-calico.md +++ b/docs/getting-started-guides/fedora/fedora-calico.md @@ -1,4 +1,7 @@ --- +assignees: +- caesarxuchao + --- This guide will walk you through the process of getting a Kubernetes Fedora cluster running on Digital Ocean with networking powered by Calico networking. diff --git a/docs/getting-started-guides/fedora/fedora_ansible_config.md b/docs/getting-started-guides/fedora/fedora_ansible_config.md index 57532a4fa5..aa439f07b0 100644 --- a/docs/getting-started-guides/fedora/fedora_ansible_config.md +++ b/docs/getting-started-guides/fedora/fedora_ansible_config.md @@ -1,4 +1,8 @@ --- +assignees: +- aveshagarwal +- erictune + --- Configuring Kubernetes on Fedora via Ansible offers a simple way to quickly create a clustered environment with little effort. diff --git a/docs/getting-started-guides/fedora/fedora_manual_config.md b/docs/getting-started-guides/fedora/fedora_manual_config.md index 81bf0b138c..238498d18c 100644 --- a/docs/getting-started-guides/fedora/fedora_manual_config.md +++ b/docs/getting-started-guides/fedora/fedora_manual_config.md @@ -1,4 +1,9 @@ --- +assignees: +- aveshagarwal +- eparis +- thockin + --- * TOC @@ -30,6 +35,7 @@ fed-node = 192.168.121.65 * Install Kubernetes on all hosts - fed-{master,node}. This will also pull in docker. Also install etcd on fed-master. This guide has been tested with kubernetes-0.18 and beyond. * The [--enablerepo=updates-testing](https://fedoraproject.org/wiki/QA:Updates_Testing) directive in the yum command below will ensure that the most recent Kubernetes version that is scheduled for pre-release will be installed. This should be a more recent version than the Fedora "stable" release for Kubernetes that you would get without adding the directive. * If you want the very latest Kubernetes release [you can download and yum install the RPM directly from Fedora Koji](http://koji.fedoraproject.org/koji/packageinfo?packageID=19202) instead of using the yum install command below. +* Running on AWS EC2 with RHEL 7.2, you need to enable "extras" repository for yum by editing `/etc/yum.repos.d/redhat-rhui.repo` and changing the changing the `enable=0` to `enable=1` for extras. ```shell yum -y install --enablerepo=updates-testing kubernetes diff --git a/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md b/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md index 8de2e9dc4e..4c89d85e90 100644 --- a/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md +++ b/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md @@ -1,4 +1,9 @@ --- +assignees: +- dchen1107 +- erictune +- thockin + --- * TOC {:toc} diff --git a/docs/getting-started-guides/fluentd-gcp.yaml b/docs/getting-started-guides/fluentd-gcp.yaml index 44cca43747..15226d5d6b 100644 --- a/docs/getting-started-guides/fluentd-gcp.yaml +++ b/docs/getting-started-guides/fluentd-gcp.yaml @@ -1,3 +1,5 @@ +# This config should be kept as similar as possible to the one at +# cluster/addons/gci/fluentd-gcp.yaml apiVersion: v1 kind: Pod metadata: @@ -9,11 +11,13 @@ spec: dnsPolicy: Default containers: - name: fluentd-cloud-logging - image: gcr.io/google_containers/fluentd-gcp:1.18 + image: gcr.io/google_containers/fluentd-gcp:1.21 resources: limits: memory: 200Mi requests: + # Any change here should be accompanied by a proportional change in CPU + # requests of other per-node add-ons (e.g. kube-proxy). cpu: 100m memory: 200Mi env: diff --git a/docs/getting-started-guides/gce.md b/docs/getting-started-guides/gce.md index e3bbb8f6e5..bc3d664909 100644 --- a/docs/getting-started-guides/gce.md +++ b/docs/getting-started-guides/gce.md @@ -1,4 +1,10 @@ --- +assignees: +- brendandburns +- jbeda +- mikedanese +- thockin + --- @@ -54,7 +60,7 @@ cluster/kube-up.sh If you want more than one cluster running in your project, want to use a different name, or want a different number of worker nodes, see the `/cluster/gce/config-default.sh` file for more fine-grained configuration before you start up your cluster. If you run into trouble, please see the section on [troubleshooting](/docs/getting-started-guides/gce/#troubleshooting), post to the -[google-containers group](https://groups.google.com/forum/#!forum/google-containers), or come ask questions on [Slack](/docs/troubleshooting/#slack). +[kubernetes-users group](https://groups.google.com/forum/#!forum/kubernetes-users), or come ask questions on [Slack](/docs/troubleshooting/#slack). The next few steps will show you: diff --git a/docs/getting-started-guides/index.md b/docs/getting-started-guides/index.md index 81216ac79b..250cca87ca 100644 --- a/docs/getting-started-guides/index.md +++ b/docs/getting-started-guides/index.md @@ -1,14 +1,16 @@ --- +assignees: +- brendandburns +- erictune +- mikedanese + --- Kubernetes can run on a range of platforms, from your laptop, to VMs on a cloud provider, to rack of bare metal servers. The effort required to set up a cluster varies from running a single command to crafting your own customized cluster. We'll guide you in picking a solution that fits for your needs. -If you just want to "kick the tires" on Kubernetes, we recommend the [local Docker-based](/docs/getting-started-guides/docker) solution. - -The local Docker-based solution is one of several [Local cluster](#local-machine-solutions) solutions -that are quick to set up, but are limited to running on one machine. +If you just want to "kick the tires" on Kubernetes, we recommend the [local Docker-based solution using MiniKube](#local-machine-solutions). When you are ready to scale up to more machines and higher availability, a [Hosted](#hosted-solutions) solution is the easiest to create and maintain. @@ -25,15 +27,9 @@ a Kubernetes cluster from scratch. ### Local-machine Solutions -Local-machine solutions create a single cluster with one or more Kubernetes nodes on a single -physical machine. Setup is completely automated and doesn't require a cloud provider account. -But their size and availability is limited to that of a single machine. +[Minikube](/docs/getting-started-guides/minikube/) is the recommended method for you to create a single node kubernetes cluster locally for purposes of development and testing. Setup is completely automated and doesn't require a cloud provider account. -The local-machine solutions are: - -- [Local Docker-based](/docs/getting-started-guides/docker) (recommended starting point) -- [No-VM local cluster](/docs/getting-started-guides/locally) (Linux only) -- [Vagrant](/docs/getting-started-guides/vagrant) +Use the [Minikube getting started guide](/docs/getting-started-guides/minikube/) to try it out. ### Hosted Solutions @@ -41,6 +37,8 @@ The local-machine solutions are: [Google Container Engine](https://cloud.google.com/container-engine) offers managed Kubernetes clusters. +[Stackpoint.io](https://stackpoint.io) provides Kubernetes infrastructure automation and management for multiple public clouds. + ### Turn-key Cloud Solutions These solutions allow you to create Kubernetes clusters on a range of Cloud IaaS providers with only a @@ -48,7 +46,8 @@ few commands, and have active community support. - [GCE](/docs/getting-started-guides/gce) - [AWS](/docs/getting-started-guides/aws) -- [Azure](/docs/getting-started-guides/coreos/azure/) +- [Azure](/docs/getting-started-guides/coreos/azure/) (Weave-based, contributed by WeaveWorks employees) +- [Azure](/docs/getting-started-guides/azure/) (Flannel-based, contributed by Microsoft employee) - [CenturyLink Cloud](/docs/getting-started-guides/clc) ### Custom Solutions @@ -78,7 +77,8 @@ These solutions are combinations of cloud provider and OS not covered by the abo - [Vagrant](/docs/getting-started-guides/coreos) (uses CoreOS and flannel) - [CloudStack](/docs/getting-started-guides/cloudstack) (uses Ansible, CoreOS and flannel) -- [Vmware](/docs/getting-started-guides/vsphere) (uses Debian) +- [Vmware vSphere](/docs/getting-started-guides/vsphere) (uses Debian) +- [Vmware Photon Controller](/docs/getting-started-guides/photon-controller) (uses Debian) - [juju.md](/docs/getting-started-guides/juju) (uses Juju, Ubuntu and flannel) - [Vmware](/docs/getting-started-guides/coreos) (uses CoreOS and flannel) - [libvirt-coreos.md](/docs/getting-started-guides/libvirt-coreos) (uses CoreOS) @@ -96,6 +96,7 @@ These solutions are combinations of cloud provider and OS not covered by the abo - [Centos](/docs/getting-started-guides/centos/centos_manual_config) - [Ubuntu](/docs/getting-started-guides/ubuntu) - [Docker Multi Node](/docs/getting-started-guides/docker-multinode) +- [CoreOS](/docs/getting-started-guides/coreos) #### Integrations @@ -114,8 +115,10 @@ Here are all the solutions mentioned above in table form. IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level -------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ---------------------------- GKE | | | GCE | [docs](https://cloud.google.com/container-engine) | ['œ“][3] | Commercial +Stackpoint.io | | multi-support | multi-support | [docs](http://www.stackpointcloud.com) | | Commercial GCE | Saltstack | Debian | GCE | [docs](/docs/getting-started-guides/gce) | ['œ“][1] | Project Azure | CoreOS | CoreOS | Weave | [docs](/docs/getting-started-guides/coreos/azure/) | | Community ([@errordeveloper](https://github.com/errordeveloper), [@squillace](https://github.com/squillace), [@chanezon](https://github.com/chanezon), [@crossorigin](https://github.com/crossorigin)) +Azure | CoreOS | CoreOS | flannel | [docs](/docs/getting-started-guides/azure) | | Community ([@colemickens](https://github.com/colemickens)) Docker Single Node | custom | N/A | local | [docs](/docs/getting-started-guides/docker) | | Project ([@brendandburns](https://github.com/brendandburns)) Docker Multi Node | custom | N/A | flannel | [docs](/docs/getting-started-guides/docker-multinode) | | Project ([@brendandburns](https://github.com/brendandburns)) Bare-metal | Ansible | Fedora | flannel | [docs](/docs/getting-started-guides/fedora/fedora_ansible_config) | | Project @@ -132,12 +135,14 @@ Vagrant | CoreOS | CoreOS | flannel | [docs](/docs/gettin Bare-metal (Offline) | CoreOS | CoreOS | flannel | [docs](/docs/getting-started-guides/coreos/bare_metal_offline) | | Community ([@jeffbean](https://github.com/jeffbean)) Bare-metal | CoreOS | CoreOS | Calico | [docs](/docs/getting-started-guides/coreos/bare_metal_calico) | | Community ([@caseydavenport](https://github.com/caseydavenport)) CloudStack | Ansible | CoreOS | flannel | [docs](/docs/getting-started-guides/cloudstack) | | Community ([@runseb](https://github.com/runseb)) -Vmware | | Debian | OVS | [docs](/docs/getting-started-guides/vsphere) | | Community ([@pietern](https://github.com/pietern)) +Vmware vSphere | Saltstack | Debian | OVS | [docs](/docs/getting-started-guides/vsphere) | | Community ([@imkin](https://github.com/imkin)) +Vmware Photon | Saltstack | Debian | OVS | [docs](/docs/getting-started-guides/photon-controller) | | Community ([@alainroy](https://github.com/alainroy)) Bare-metal | custom | CentOS | _none_ | [docs](/docs/getting-started-guides/centos/centos_manual_config) | | Community ([@coolsvap](https://github.com/coolsvap)) AWS | Juju | Ubuntu | flannel | [docs](/docs/getting-started-guides/juju) | | [Community](https://github.com/whitmo/bundle-kubernetes) ( [@whit](https://github.com/whitmo), [@matt](https://github.com/mbruzek), [@chuck](https://github.com/chuckbutler) ) OpenStack/HPCloud | Juju | Ubuntu | flannel | [docs](/docs/getting-started-guides/juju) | | [Community](https://github.com/whitmo/bundle-kubernetes) ( [@whit](https://github.com/whitmo), [@matt](https://github.com/mbruzek), [@chuck](https://github.com/chuckbutler) ) Joyent | Juju | Ubuntu | flannel | [docs](/docs/getting-started-guides/juju) | | [Community](https://github.com/whitmo/bundle-kubernetes) ( [@whit](https://github.com/whitmo), [@matt](https://github.com/mbruzek), [@chuck](https://github.com/chuckbutler) ) -AWS | Saltstack | Ubuntu | OVS | [docs](/docs/getting-started-guides/aws) | | Community ([@justinsb](https://github.com/justinsb)) +AWS | Saltstack | Debian | AWS | [docs](/docs/getting-started-guides/aws) | | Community ([@justinsb](https://github.com/justinsb)) +AWS | kops | Debian | AWS | [docs](https://github.com/kubernetes/kops) | | Community ([@justinsb](https://github.com/justinsb)) Bare-metal | custom | Ubuntu | Calico | [docs](/docs/getting-started-guides/ubuntu-calico) | | Community ([@djosborne](https://github.com/djosborne)) Bare-metal | custom | Ubuntu | flannel | [docs](/docs/getting-started-guides/ubuntu) | | Community ([@resouer](https://github.com/resouer), [@WIZARD-CXY](https://github.com/WIZARD-CXY)) libvirt/KVM | CoreOS | CoreOS | libvirt/KVM | [docs](/docs/getting-started-guides/libvirt-coreos) | | Community ([@lhuard1A](https://github.com/lhuard1A)) diff --git a/docs/getting-started-guides/juju.md b/docs/getting-started-guides/juju.md index 313f10176d..5982f152a2 100644 --- a/docs/getting-started-guides/juju.md +++ b/docs/getting-started-guides/juju.md @@ -1,14 +1,19 @@ --- +assignees: +- caesarxuchao +- erictune + --- -[Juju](https://jujucharms.com/docs/stable/about-juju) makes it easy to deploy -Kubernetes by provisioning, installing and configuring all the systems in -the cluster. Once deployed the cluster can easily scale up with one command -to increase the cluster size. +[Juju](https://jujucharms.com/docs/2.0/about-juju) encapsulates the +operational knowledge of provisioning, installing, and securing a Kubernetes +cluster into one step. Juju allows you to deploy a Kubernetes cluster on +different cloud providers with a consistent, repeatable user experience. +Once deployed the cluster can easily scale up with one command. -The Juju Kubernetes work is curated by a very small group of community members. -Let us know how we are doing. If you find any problems please open an -[issue at the kubernetes project](https://github.com/kubernetes/kubernetes/issues) +The Juju Kubernetes work is curated by a dedicated team of community members, +let us know how we are doing. If you find any problems please open an +[issue on the kubernetes project](https://github.com/kubernetes/kubernetes/issues) and tag the issue with "juju" so we can find them. @@ -23,7 +28,7 @@ and tag the issue with "juju" so we can find them. ### On Ubuntu -[Install the Juju client](https://jujucharms.com/get-started) +[Install the Juju client](https://jujucharms.com/docs/2.0/getting-started-general) > This documentation focuses on the Juju 2.0 release which will be > promoted to stable during the April 2016 release cycle. @@ -33,48 +38,55 @@ To paraphrase, on your local Ubuntu system: ```shell sudo add-apt-repository ppa:juju/devel sudo apt-get update -sudo apt-get install juju2 +sudo apt-get install juju ``` If you are using another distro/platform - please consult the -[getting started guide](https://jujucharms.com/get-started) to install the -Juju dependencies for your platform. +[getting started guide](https://jujucharms.com/docs/2.0/getting-started-general) +to install the Juju dependencies for your platform. ### With Docker -If you are not using Ubuntu or prefer the isolation of Docker, you may -run the following: +If you prefer the isolation of Docker, you can run the Juju client in a +container. Create a local directory to store the Juju configuration, then +volume mount the container: + +```shell +mkdir -p $HOME/.local/share/juju +docker run --rm -ti \ + -v $HOME/.local/share/juju:/home/ubuntu/.local/share/juju \ + jujusolutions/charmbox:devel +``` > While this is a common target, the charmbox flavors of images are > unofficial, and should be treated as experimental. If you encounter any issues > turning up the Kubernetes cluster with charmbox, please file a bug on the > [charmbox issue tracker](https://github.com/juju-solutions/charmbox/issues). -```shell -mkdir ~/.juju2 -sudo docker run -v ~/.juju2:/home/ubuntu/.local/share/juju -ti jujusolutions/charmbox:devel -``` - -### Configure Juju to point a cloud +### Configure Juju to your favorite cloud provider At this point you have access to the Juju client. Before you can deploy a -cluster you have to configure the credentials for the Juju cloud provider. +cluster you have to configure Juju with the +[cloud credentials](https://jujucharms.com/docs/2.0/credentials) for each +cloud provider you would like to use. -Juju [supports a wide variety of public clouds](#Cloud-compatibility) to set +Juju [supports a wide variety of public clouds](#cloud-compatibility) to set up the credentials for your chosen cloud see the -[cloud setup page](https://jujucharms.com/docs/devel/getting-started#2.-choose-a-cloud). +[cloud setup page](https://jujucharms.com/docs/devel/getting-started-general#2.-choose-a-cloud). After configuration is complete test your setup with a `juju bootstrap` -command: -`juju bootstrap $cloudname $cloudtype` you are ready to launch the -Kubernetes cluster. +command: `juju bootstrap $controllername $cloudtype` you are ready to launch +the Kubernetes cluster. ## Launch a Kubernetes cluster -You will need to export the `KUBERNETES_PROVIDER` environment variable before -bringing up the cluster. +You can deploy a Kubernetes cluster with Juju from the `kubernetes` directory of +the [kubernetes github project](https://github.com/kubernetes/kubernetes.git). +Clone the repository on your local system. Export the `KUBERNETES_PROVIDER` +environment variable before bringing up the cluster. ```shell +cd kubernetes export KUBERNETES_PROVIDER=juju cluster/kube-up.sh ``` @@ -82,47 +94,60 @@ cluster/kube-up.sh If this is your first time running the `kube-up.sh` script, it will attempt to install the required dependencies to get started with Juju. -Next it will deploy two nodes of Kubernetes, 1 unit of etcd, and network +The script will deploy two nodes of Kubernetes, 1 unit of etcd, and network the units so containers on different hosts can communicate with each other. ## Exploring the cluster -The `juju status` command provides information about each unit in the cluster: +The `juju status` command provides information about each unit in the cluster: ```shell $ juju status +MODEL CONTROLLER CLOUD/REGION VERSION +default windows azure/centralus 2.0-beta13 -... (omitted for brevity) +APP VERSION STATUS EXPOSED ORIGIN CHARM REV OS +etcd active false jujucharms etcd 3 ubuntu +kubernetes active true jujucharms kubernetes 5 ubuntu -[Units] -ID WORKLOAD-STATE AGENT-STATE VERSION MACHINE PORTS PUBLIC-ADDRESS MESSAGE -etcd/0 active idle 2.0-beta2 1 54.146.50.29 Etcd leader running -kubernetes/0 active idle 2.0-beta2 2 6443/tcp,8088/tcp 54.205.204.227 Kubernetes follower running -kubernetes/1 active idle 2.0-beta2 3 6443/tcp,8088/tcp 54.145.57.114 Kubernetes leader running +RELATION PROVIDES CONSUMES TYPE +cluster etcd etcd peer +etcd etcd kubernetes regular +certificates kubernetes kubernetes peer -... (omitted for brevity) +UNIT WORKLOAD AGENT MACHINE PORTS PUBLIC-ADDRESS MESSAGE +etcd/0 active idle 0 2379/tcp 13.67.217.11 (leader) cluster is healthy +kubernetes/0 active idle 1 8088/tcp 13.67.219.76 Kubernetes running. +kubernetes/1 active idle 2 6443/tcp 13.67.219.182 (master) Kubernetes running. + +MACHINE STATE DNS INS-ID SERIES AZ +0 started 13.67.217.11 machine-0 trusty +1 started 13.67.219.76 machine-1 trusty +2 started 13.67.219.182 machine-2 trusty ``` ## Run some containers! -The `kubectl` file, the TLS certificates along with the configuration are -all available on the Kubernetes leader unit. Fetch the kubectl package so you +The `kubectl` file, and the TLS certificates along with the configuration are +all available on the Kubernetes master unit. Fetch the kubectl package so you can run commands on the new Kuberntetes cluster. -Use the `juju status` command to figure out which Kubernetes unit is the leader -and copy the file from the leader: +Use the `juju status` command to figure out which unit is the master. In the +example above the "kubernetes/1" unit is the master. Use the `juju scp` +command to copy the file from the unit: ```shell juju scp kubernetes/1:kubectl_package.tar.gz . tar xvfz kubectl_package.tar.gz -kubectl --kubeconfig config get pods +./kubectl --kubeconfig kubeconfig get pods ``` If you are not on a Linux amd64 host system, you will need to find or build a kubectl binary package for your architecture. -Put the config file in the home directory so you don't have to specify it on -the command line each time. The default location is `${HOME}/.kube/config`. +Copy the `kubeconfig` file to the home directory so you don't have to specify +it on the command line each time. The default location is +`${HOME}/.kube/config`. No pods will be available before starting a container: @@ -202,6 +227,7 @@ Finally delete the pod: juju ssh kubernetes/0 kubectl delete pods hello ``` + ## Scale up cluster Want larger Kubernetes nodes? It is easy to request different sizes of cloud @@ -209,12 +235,12 @@ resources from Juju by using **constraints**. You can increase the amount of CPU or memory (RAM) in any of the systems requested by Juju. This allows you to fine tune th Kubernetes cluster to fit your workload. Use flags on the bootstrap command or as a separate `juju constraints` command. Look to the -[Juju documentation for machine constraints](https://jujucharms.com/docs/devel/charms-constraints) +[Juju documentation for machine](https://jujucharms.com/docs/2.0/charms-constraints) details. ## Scale out cluster -Need more clusters? Juju makes it easy to add units of a charm: +Need more workers? Juju makes it easy to add units of a charm: ```shell juju add-unit kubernetes @@ -226,21 +252,28 @@ Or multiple units at one time: juju add-unit -n3 kubernetes ``` +You can also scale the etcd charm for more fault tolerant key/value storage: + +```shell +juju add-unit -n2 etcd +``` + ## Tear down cluster -We recommend that you use the `kube-down.sh` command when you are done using +We recommend that you use the `kube-down.sh` script when you are done using the cluster, as it properly brings down the cloud and removes some of the build directories. ```shell -./kube-down.sh +./cluster/kube-down.sh ``` -Alternately if you want stop the servers you can destroy your current Juju -environment. Use the `juju env` command to get the current environment name: +Alternately if you want stop the servers you can destroy the Juju model or the +controller. Use the `juju switch` command to get the current controller name: ```shell -juju kill-controller `juju env` +juju switch +juju destroy-controller $controllername --destroy-all-models ``` ## More Info @@ -260,33 +293,33 @@ project on github.com: ### Cloud compatibility -Juju runs natively against a variety of public cloud providers. Juju currently -works with [Amazon Web Service](https://jujucharms.com/docs/stable/config-aws), -[Windows Azure](https://jujucharms.com/docs/stable/config-azure), -[DigitalOcean](https://jujucharms.com/docs/stable/config-digitalocean), -[Google Compute Engine](https://jujucharms.com/docs/stable/config-gce), -[HP Public Cloud](https://jujucharms.com/docs/stable/config-hpcloud), -[Joyent](https://jujucharms.com/docs/stable/config-joyent), -[LXC](https://jujucharms.com/docs/stable/config-LXC), any -[OpenStack](https://jujucharms.com/docs/stable/config-openstack) deployment, -[Vagrant](https://jujucharms.com/docs/stable/config-vagrant), and -[Vmware vSphere](https://jujucharms.com/docs/stable/config-vmware). +Juju is cloud agnostic and gives you a consistent experience across different +cloud providers. Juju supports a variety of public cloud providers: [Amazon Web Service](https://jujucharms.com/docs/2.0/help-aws), +[Microsoft Azure](https://jujucharms.com/docs/2.0/help-azure), +[Google Compute Engine](https://jujucharms.com/docs/2.0/help-google), +[Joyent](https://jujucharms.com/docs/2.0/help-joyent), +[Rackspace](https://jujucharms.com/docs/2.0/help-rackspace), any +[OpenStack cloud](https://jujucharms.com/docs/2.0/clouds#specifying-additional-clouds), +and +[Vmware vSphere](https://jujucharms.com/docs/2.0/config-vmware). If you do not see your favorite cloud provider listed many clouds with ssh access can be configured for -[manual provisioning](https://jujucharms.com/docs/stable/config-manual). +[manual provisioning](https://jujucharms.com/docs/2.0/clouds-manual). + +To change to a different cloud you can use the `juju switch` command and set +up the credentials for that cloud provider and continue to use the `kubeup.sh` +script. ## Support Level IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level -------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ---------------------------- -AWS | Juju | Ubuntu | flannel | [docs](/docs/getting-started-guides/juju) | | [Community](https://github.com/whitmo/bundle-kubernetes) ( [@whit](https://github.com/whitmo), [@matt](https://github.com/mbruzek), [@chuck](https://github.com/chuckbutler) ) -OpenStack/HPCloud | Juju | Ubuntu | flannel | [docs](/docs/getting-started-guides/juju) | | [Community](https://github.com/whitmo/bundle-kubernetes) ( [@whit](https://github.com/whitmo), [@matt](https://github.com/mbruzek), [@chuck](https://github.com/chuckbutler) ) -Joyent | Juju | Ubuntu | flannel | [docs](/docs/getting-started-guides/juju) | | [Community](https://github.com/whitmo/bundle-kubernetes) ( [@whit](https://github.com/whitmo), [@matt](https://github.com/mbruzek), [@chuck](https://github.com/chuckbutler) ) - +Amazon Web Services (AWS) | Juju | Ubuntu | flannel | [docs](/docs/getting-started-guides/juju) | | [Community](https://github.com/juju-solutions/bundle-kubernetes-core) ( [@mbruzek](https://github.com/mbruzek), [@chuckbutler](https://github.com/chuckbutler) ) +OpenStack | Juju | Ubuntu | flannel | [docs](/docs/getting-started-guides/juju) | | [Community](https://github.com/juju-solutions/bundle-kubernetes-core) ( [@mbruzek](https://github.com/mbruzek), [@chuckbutler](https://github.com/chuckbutler) ) +Microsoft Azure | Juju | Ubuntu | flannel | [docs](/docs/getting-started-guides/juju) | | [Community](https://github.com/juju-solutions/bundle-kubernetes-core) ( [@mbruzek](https://github.com/mbruzek), [@chuckbutler](https://github.com/chuckbutler) ) +Google Compute Engine (GCE) | Juju | Ubuntu | flannel | [docs](/docs/getting-started-guides/juju) | | [Community](https://github.com/juju-solutions/bundle-kubernetes-core) ( [@mbruzek](https://github.com/mbruzek), [@chuckbutler](https://github.com/chuckbutler) ) For support level information on all solutions, see the [Table of solutions](/docs/getting-started-guides/#table-of-solutions) chart. - - diff --git a/docs/getting-started-guides/libvirt-coreos.md b/docs/getting-started-guides/libvirt-coreos.md index 6c003490f5..f752a13aee 100644 --- a/docs/getting-started-guides/libvirt-coreos.md +++ b/docs/getting-started-guides/libvirt-coreos.md @@ -1,4 +1,8 @@ --- +assignees: +- erictune +- idvoretskyi + --- * TOC @@ -280,9 +284,11 @@ Start the libvirt daemon On Arch: ```shell -systemctl start libvirtd +systemctl start libvirtd virtlogd.socket ``` +The `virtlogd.socket` is not started with the libvirtd daemon. If you enable the `libvirtd.service` it is linked and started automatically on the next boot. + On Ubuntu 14.04: ```shell diff --git a/docs/getting-started-guides/locally.md b/docs/getting-started-guides/locally.md deleted file mode 100644 index cc2f9f1107..0000000000 --- a/docs/getting-started-guides/locally.md +++ /dev/null @@ -1,118 +0,0 @@ ---- ---- - -* TOC -{:toc} - -### Requirements - -#### Linux - -Not running Linux? Consider running Linux in a local virtual machine with [vagrant](https://www.vagrantup.com/), or on a cloud provider like [Google Compute Engine](/docs/getting-started-guides/gce) - -#### Docker - -At least [Docker](https://docs.docker.com/installation/#installation) -1.8.3+. Ensure the Docker daemon is running and can be contacted (try `docker -ps`). Some of the Kubernetes components need to run as root, which normally -works fine with docker. - -#### etcd - -You need an [etcd](https://github.com/coreos/etcd/releases) in your path, please make sure it is installed and in your ``$PATH``. - -#### go - -You need [go](https://golang.org/doc/install) at least 1.3+ in your path, please make sure it is installed and in your ``$PATH``. - -### Starting the cluster - -First, you need to [download Kubernetes](/docs/getting-started-guides/binary_release/). Then open a separate tab of your terminal -and run the following (since one needs sudo access to start/stop Kubernetes daemons, it is easier to run the entire script as root): - -```shell -cd kubernetes -hack/local-up-cluster.sh -``` - -This will build and start a lightweight local cluster, consisting of a master -and a single node. Type Control-C to shut it down. - -You can use the cluster/kubectl.sh script to interact with the local cluster. hack/local-up-cluster.sh will -print the commands to run to point kubectl at the local cluster. - - -### Running a container - -Your cluster is running, and you want to start running containers! - -You can now use any of the cluster/kubectl.sh commands to interact with your local setup. - -```shell -cluster/kubectl.sh get pods -cluster/kubectl.sh get services -cluster/kubectl.sh get deployments -cluster/kubectl.sh run my-nginx --image=nginx --replicas=2 --port=80 - -## begin wait for provision to complete, you can monitor the docker pull by opening a new terminal - sudo docker images - ## you should see it pulling the nginx image, once the above command returns it - sudo docker ps - ## you should see your container running! - exit -## end wait - -## introspect Kubernetes! -cluster/kubectl.sh get pods -cluster/kubectl.sh get services -cluster/kubectl.sh get deployments -``` - -### Running a user defined pod - -Note the difference between a [container](/docs/user-guide/containers) -and a [pod](/docs/user-guide/pods). Since you only asked for the former, Kubernetes will create a wrapper pod for you. -However you cannot view the nginx start page on localhost. To verify that nginx is running you need to run `curl` within the docker container (try `docker exec`). - -You can control the specifications of a pod via a user defined manifest, and reach nginx through your browser on the port specified therein: - -```shell -cluster/kubectl.sh create -f docs/user-guide/pod.yaml -``` - -Congratulations! - -### FAQs - -#### I cannot reach service IPs on the network. - -Some firewall software that uses iptables may not interact well with -kubernetes. If you have trouble around networking, try disabling any -firewall or other iptables-using systems, first. Also, you can check -if SELinux is blocking anything by running a command such as `journalctl --since yesterday | grep avc`. - -By default the IP range for service cluster IPs is 10.0.*.* - depending on your -docker installation, this may conflict with IPs for containers. If you find -containers running with IPs in this range, edit hack/local-cluster-up.sh and -change the service-cluster-ip-range flag to something else. - -#### I changed Kubernetes code, how do I run it? - -```shell -cd kubernetes -hack/build-go.sh -hack/local-up-cluster.sh -``` - -#### kubectl claims to start a container but `get pods` and `docker ps` don't show it. - -One or more of the Kubernetes daemons might've crashed. Tail the [logs](/docs/admin/cluster-troubleshooting/#looking-at-logs) of each in /tmp. - -```shell -$ ls /tmp/kube*.log -$ tail -f /tmp/kube-apiserver.log -``` - -#### The pods fail to connect to the services by host names - -The local-up-cluster.sh script doesn't start a DNS service. Similar situation can be found [here](http://issue.k8s.io/6667). You can start a manually. Related documents can be found [here](https://releases.k8s.io/{{page.githubbranch}}/cluster/addons/dns#how-do-i-configure-it) diff --git a/docs/getting-started-guides/logging-elasticsearch.md b/docs/getting-started-guides/logging-elasticsearch.md index 00202e964a..2141cfbc6d 100644 --- a/docs/getting-started-guides/logging-elasticsearch.md +++ b/docs/getting-started-guides/logging-elasticsearch.md @@ -1,12 +1,22 @@ --- +assignees: +- lavalamp +- satnam6502 + --- -On the Google Compute Engine (GCE) platform the default cluster level logging support targets -[Google Cloud Logging](https://cloud.google.com/logging/docs/) as described at the [Logging](/docs/getting-started-guides/logging) getting -started page. Here we describe how to set up a cluster to ingest logs into Elasticsearch and view them using Kibana as an -alternative to Google Cloud Logging. +On the Google Compute Engine (GCE) platform, the default logging support targets +[Google Cloud Logging](https://cloud.google.com/logging/) as described in the +[Logging](/docs/getting-started-guides/logging) getting-started guide. Here we +describe how to set up a cluster to ingest logs into +[Elasticsearch](https://github.com/elastic/elasticsearch) and view +them using [Kibana](https://github.com/elastic/kibana) as an alternative to +Google Cloud Logging when running on GCE (note that this will not work as +written for Google Container Engine). -To use Elasticsearch and Kibana for cluster logging you should set the following environment variable as shown below: +To use Elasticsearch and Kibana for cluster logging, you should set the +following environment variable as shown below when creating your cluster with +kube-up.sh: ```shell KUBE_LOGGING_DESTINATION=elasticsearch @@ -14,8 +24,8 @@ KUBE_LOGGING_DESTINATION=elasticsearch You should also ensure that `KUBE_ENABLE_NODE_LOGGING=true` (which is the default for the GCE platform). -Now when you create a cluster a message will indicate that the Fluentd node-level log collectors -will target Elasticsearch: +Now, when you create a cluster, a message will indicate that the Fluentd log +collection daemons that run on each node will target Elasticsearch: ```shell $ cluster/kube-up.sh @@ -37,8 +47,9 @@ Created [https://www.googleapis.com/compute/v1/projects/kubernetes-satnam/region +++ Logging using Fluentd to elasticsearch ``` -The node level Fluentd collector pods and the Elasticsearech pods used to ingest cluster logs and the pod for the Kibana -viewer should be running in the kube-system namespace soon after the cluster comes to life. +The per-node Fluentd pods, the Elasticsearch pods, and the Kibana pods should +all be running in the kube-system namespace soon after the cluster comes to +life. ```shell $ kubectl get pods --namespace=kube-system @@ -55,189 +66,38 @@ monitoring-heapster-v4-yl332 1/1 Running 1 2h monitoring-influx-grafana-v1-o79xf 2/2 Running 0 2h ``` -Here we see that for a four node cluster there is a `fluent-elasticsearch` pod running which gathers -the Docker container logs and sends them to Elasticsearch. The Fluentd collector communicates to -a Kubernetes service that maps requests to specific Elasticsearch pods. Similarly, Kibana can also be -accessed via a Kubernetes service definition. +The `fluentd-elasticsearch` pods gather logs from each node and send them to +the `elasticsearch-logging` pods, which are part of a +[service](/docs/user-guide/services/) named `elasticsearch-logging`. These +Elasticsearch pods store the logs and expose them via a REST API. +The `kibana-logging` pod provides a web UI for reading the logs stored in +Elasticsearch, and is part of a service named `kibana-logging`. +The Elasticsearch and Kibana services are both in the `kube-system` namespace +and are not directly exposed via a publicly reachable IP address. To reach them, +follow the instructions for [Accessing services running in a cluster](/docs/user-guide/accessing-the-cluster/#accessing-services-running-on-the-cluster). -```shell -$ kubectl get services --namespace=kube-system -NAME LABELS SELECTOR IP(S) PORT(S) -elasticsearch-logging k8s-app=elasticsearch-logging,kubernetes.io/cluster-service=true,kubernetes.io/name=Elasticsearch k8s-app=elasticsearch-logging 10.0.222.57 9200/TCP -kibana-logging k8s-app=kibana-logging,kubernetes.io/cluster-service=true,kubernetes.io/name=Kibana k8s-app=kibana-logging 10.0.193.226 5601/TCP -kube-dns k8s-app=kube-dns,kubernetes.io/cluster-service=true,kubernetes.io/name=KubeDNS k8s-app=kube-dns 10.0.0.10 53/UDP - 53/TCP -kubernetes component=apiserver,provider=kubernetes 10.0.0.1 443/TCP -monitoring-grafana kubernetes.io/cluster-service=true,kubernetes.io/name=Grafana k8s-app=influxGrafana 10.0.167.139 80/TCP -monitoring-heapster kubernetes.io/cluster-service=true,kubernetes.io/name=Heapster k8s-app=heapster 10.0.208.221 80/TCP -monitoring-influxdb kubernetes.io/cluster-service=true,kubernetes.io/name=InfluxDB k8s-app=influxGrafana 10.0.188.57 8083/TCP -``` - -By default two Elasticsearch replicas are created and one Kibana replica is created. - -```shell -$ kubectl get rc --namespace=kube-system -CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS -elasticsearch-logging-v1 elasticsearch-logging gcr.io/google_containers/elasticsearch:1.4 k8s-app=elasticsearch-logging,version=v1 2 -kibana-logging-v1 kibana-logging gcr.io/google_containers/kibana:1.3 k8s-app=kibana-logging,version=v1 1 -kube-dns-v3 etcd gcr.io/google_containers/etcd:2.0.9 k8s-app=kube-dns,version=v3 1 - kube2sky gcr.io/google_containers/kube2sky:1.9 - skydns gcr.io/google_containers/skydns:2015-03-11-001 -monitoring-heapster-v4 heapster gcr.io/google_containers/heapster:v0.14.3 k8s-app=heapster,version=v4 1 -monitoring-influx-grafana-v1 influxdb gcr.io/google_containers/heapster_influxdb:v0.3 k8s-app=influxGrafana,version=v1 1 - grafana gcr.io/google_containers/heapster_grafana:v0.7 -``` - -The Elasticsearch and Kibana services are not directly exposed via a publicly reachable IP address. Instead, -they can be accessed via the service proxy running at the master. The URLs for accessing Elasticsearch -and Kibana via the service proxy can be found using the `kubectl cluster-info` command. - -```shell -$ kubectl cluster-info -Kubernetes master is running at https://146.148.94.154 -Elasticsearch is running at https://146.148.94.154/api/v1/proxy/namespaces/kube-system/services/elasticsearch-logging -Kibana is running at https://146.148.94.154/api/v1/proxy/namespaces/kube-system/services/kibana-logging -KubeDNS is running at https://146.148.94.154/api/v1/proxy/namespaces/kube-system/services/kube-dns -KubeUI is running at https://146.148.94.154/api/v1/proxy/namespaces/kube-system/services/kube-ui -Grafana is running at https://146.148.94.154/api/v1/proxy/namespaces/kube-system/services/monitoring-grafana -Heapster is running at https://146.148.94.154/api/v1/proxy/namespaces/kube-system/services/monitoring-heapster -InfluxDB is running at https://146.148.94.154/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb -``` - -Before accessing the logs ingested into Elasticsearch using a browser and the service proxy URL we need to find out -the `admin` password for the cluster using `kubectl config view`. - -```shell -$ kubectl config view -... -- name: kubernetes-satnam_kubernetes-basic-auth - user: - password: 7GlspJ9Q43OnGIJO - username: admin -... -``` - -The first time you try to access the cluster from a browser a dialog box appears asking for the username and password. -Use the username `admin` and provide the basic auth password reported by `kubectl config view` for the -cluster you are trying to connect to. Connecting to the Elasticsearch URL should then give the -status page for Elasticsearch. +If you try accessing the `elasticsearch-logging` service in your browser, you'll +see a status page that looks something like this: ![Elasticsearch Status](/images/docs/es-browser.png) -You can now type Elasticsearch queries directly into the browser. Alternatively you can query Elasticsearch -from your local machine using `curl` but first you need to know what your bearer token is: +You can now type Elasticsearch queries directly into the browser, if you'd +like. See [Elasticsearch's documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html) +for more details on how to do so. -```shell -$ kubectl config view --minify -``` +Alternatively, you can view your cluster's logs using Kibana (again using the +[instructions for accessing a service running in the cluster](/docs/user-guide/accessing-the-cluster/#accessing-services-running-on-the-cluster)). +The first time you visit the Kibana URL you will be presented with a page that +asks you to configure your view of the ingested logs. Select the option for +timeseries values and select `@timestamp`. On the following page select the +`Discover` tab and then you should be able to see the ingested logs. +You can set the refresh interval to 5 seconds to have the logs +regulary refreshed. -```conf -apiVersion: v1 -clusters: -- cluster: - certificate-authority-data: REDACTED - server: https://146.148.94.154 - name: kubernetes-satnam_kubernetes -contexts: -- context: - cluster: kubernetes-satnam_kubernetes - user: kubernetes-satnam_kubernetes - name: kubernetes-satnam_kubernetes -current-context: kubernetes-satnam_kubernetes -kind: Config -preferences: {} -users: -- name: kubernetes-satnam_kubernetes - user: - client-certificate-data: REDACTED - client-key-data: REDACTED - token: JsUe2Z3cXqa17UQqQ8qWGGf4nOSLwSnp -``` - -Now you can issue requests to Elasticsearch: - -```shell -$ curl --header "Authorization: Bearer JsUe2Z3cXqa17UQqQ8qWGGf4nOSLwSnp" --insecure https://146.148.94.154/api/v1/proxy/namespaces/kube-system/services/elasticsearch-logging/ -``` - -```json -{ - "status" : 200, - "name" : "Vance Astrovik", - "cluster_name" : "kubernetes-logging", - "version" : { - "number" : "1.5.2", - "build_hash" : "62ff9868b4c8a0c45860bebb259e21980778ab1c", - "build_timestamp" : "2015-04-27T09:21:06Z", - "build_snapshot" : false, - "lucene_version" : "4.10.4" - }, - "tagline" : "You Know, for Search" -} -``` - -Note that you need the trailing slash at the end of the service proxy URL. Here is an example of a search: - -```shell -$ curl --header "Authorization: Bearer JsUe2Z3cXqa17UQqQ8qWGGf4nOSLwSnp" --insecure https://146.148.94.154/api/v1/proxy/namespaces/kube-system/services/elasticsearch-logging/_search?pretty=true -``` - -```json -{ - "took" : 7, - "timed_out" : false, - "_shards" : { - "total" : 6, - "successful" : 6, - "failed" : 0 - }, - "hits" : { - "total" : 123711, - "max_score" : 1.0, - "hits" : [ { - "_index" : ".kibana", - "_type" : "config", - "_id" : "4.0.2", - "_score" : 1.0, - "_source":{"buildNum":6004,"defaultIndex":"logstash-*"} - }, { -... - "_index" : "logstash-2015.06.22", - "_type" : "fluentd", - "_id" : "AU4c_GvFZL5p_gZ8dxtx", - "_score" : 1.0, - "_source":{"log":"synthetic-logger-10lps-pod: 31: 2015-06-22 20:35:33.597918073+00:00\n","stream":"stdout","tag":"kubernetes.synthetic-logger-10lps-pod_default_synth-lgr","@timestamp":"2015-06-22T20:35:33+00:00"} - }, { - "_index" : "logstash-2015.06.22", - "_type" : "fluentd", - "_id" : "AU4c_GvFZL5p_gZ8dxt2", - "_score" : 1.0, - "_source":{"log":"synthetic-logger-10lps-pod: 36: 2015-06-22 20:35:34.108780133+00:00\n","stream":"stdout","tag":"kubernetes.synthetic-logger-10lps-pod_default_synth-lgr","@timestamp":"2015-06-22T20:35:34+00:00"} - } ] - } -} -``` - -The Elasticsearch website contains information about [URI search queries](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-uri-request.html) which can be used to extract the required logs. - -Alternatively you can view the ingested logs using Kibana. The first time you visit the Kibana URL you will be -presented with a page that asks you to configure your view of the ingested logs. Select the option for -timeseries values and select `@timestamp`. On the following page select the `Discover` tab and then you -should be able to see the ingested logs. You can set the refresh interval to 5 seconds to have the logs -regulary refreshed. Here is a typical view of ingested logs from the Kibana viewer. +Here is a typical view of ingested logs from the Kibana viewer: ![Kibana logs](/images/docs/kibana-logs.png) -Another way to access Elasticsearch and Kibana in the cluster is to use `kubectl proxy` which will serve -a local proxy to the remote master: - -```shell -$ kubectl proxy -Starting to serve on localhost:8001 -``` - -Now you can visit the URL [http://localhost:8001/api/v1/proxy/namespaces/kube-system/services/elasticsearch-logging](http://localhost:8001/api/v1/proxy/namespaces/kube-system/services/elasticsearch-logging) to contact Elasticsearch and [http://localhost:8001/api/v1/proxy/namespaces/kube-system/services/kibana-logging](http://localhost:8001/api/v1/proxy/namespaces/kube-system/services/kibana-logging) to access the Kibana viewer. - - - +Kibana opens up all sorts of powerful options for exploring your logs! For some +ideas on how to dig into it, check out [Kibana's documentation](https://www.elastic.co/guide/en/kibana/current/discover.html). diff --git a/docs/getting-started-guides/logging.md b/docs/getting-started-guides/logging.md index 84801d45fa..8a5f7d9247 100644 --- a/docs/getting-started-guides/logging.md +++ b/docs/getting-started-guides/logging.md @@ -1,4 +1,8 @@ --- +assignees: +- lavalamp +- satnam6502 + --- A Kubernetes cluster will typically be humming along running many system and application pods. How does the system administrator collect, manage and query the logs of the system pods? How does a user query the logs of their application which is composed of many pods which may be restarted or automatically generated by the Kubernetes system? These questions are addressed by the Kubernetes **cluster level logging** services. @@ -19,7 +23,7 @@ monitoring-heapster-v1-20ej 0/1 Running 9 32 Here is the same information in a picture which shows how the pods might be placed on specific nodes. -![Cluster](https://raw.githubusercontent.com/kubernetes/kubernetes/{{page.githubbranch}}/examples/blog-logging/diagrams/cloud-logging.png) +![image](/images/blog-logging/diagrams/cloud-logging.png) This diagram shows four nodes created on a Google Compute Engine cluster with the name of each VM node on a purple background. The internal and public IPs of each node are shown on gray boxes and the pods running in each node are shown in green boxes. Each pod box shows the name of the pod and the namespace it runs in, the IP address of the pod and the images which are run as part of the pod's execution. Here we see that every node is running a fluentd-cloud-logging pod which is collecting the log output of the containers running on the same node and sending them to Google Cloud Logging. A pod which provides the [cluster DNS service](/docs/admin/dns) runs on one of the nodes and a pod which provides monitoring support runs on another node. @@ -48,7 +52,7 @@ This step may take a few minutes to download the ubuntu:14.04 image during which One of the nodes is now running the counter pod: -![Counter Pod](https://raw.githubusercontent.com/kubernetes/kubernetes/{{page.githubbranch}}/examples/blog-logging/diagrams/27gf-counter.png) +![image](/images/blog-logging/diagrams/27gf-counter.png) When the pod status changes to `Running` we can use the kubectl logs command to view the output of this counter pod. diff --git a/docs/getting-started-guides/meanstack.md b/docs/getting-started-guides/meanstack.md index d6620ed1a4..46fee21ca0 100644 --- a/docs/getting-started-guides/meanstack.md +++ b/docs/getting-started-guides/meanstack.md @@ -1,9 +1,10 @@ --- + --- **By: Sandeep Dinesh** - _July 29, 2015_ -![image](/images/docs/meanstack/image_0.png) +![image](/images/docs/meanstack/image_0.png) In [a recent post](http://blog.sandeepdinesh.com/2015/07/running-mean-web-application-in-docker.html), I talked about running a MEAN stack with [Docker Containers.](http://docker.com/) @@ -14,14 +15,14 @@ Thankfully, there is a system we can use to manage our containers in a cluster e * TOC {:toc} -## The Basics of Using Kubernetes +## The Basics of Using Kubernetes Before we jump in and start kube’ing it up, it’s important to understand some of the fundamentals of Kubernetes. * Containers: These are the Docker, rtk, AppC, or whatever Container you are running. You can think of these like subatomic particles; everything is made up of them, but you rarely (if ever) interact with them directly. * Pods: Pods are the basic component of Kubernetes. They are a group of Containers that are scheduled, live, and die together. Why would you want to have a group of containers instead of just a single container? Let’s say you had a log processor, a web server, and a database. If you couldn't use Pods, you would have to bundle the log processor in the web server and database containers, and each time you updated one you would have to update the other. With Pods, you can just reuse the same log processor for both the web server and database. -* Replication Controllers: This is the management component of Kubernetes, and it’s pretty cool. You give it a set of Pods, tell it "I want three copies of this," and it creates those copies on your cluster. It will do its best to keep those copies always running, so if one crashes it will start another. -* Services: This is the other side to Replication Controllers. A service is the single point of contact for a group of Pods. For example, let’s say you have a Replication Controller that creates four copies of a web server pod. A Service will split the traffic to each of the four copies. Services are "permanent" while the pods behind them can come and go, so it’s a good idea to use Services. +* Deployments: A Deployment provides declarative updates for Pods. You can define Deployments to create new Pods, or replace existing Pods. You only need to describe the desired state in a Deployment object, and the deployment controller will change the actual state to the desired state at a controlled rate for you. You can define Deployments to create new resources, or replace existing ones by new ones. +* Services: A service is the single point of contact for a group of Pods. For example, let’s say you have a Deployment that creates four copies of a web server pod. A Service will split the traffic to each of the four copies. Services are "permanent" while the pods behind them can come and go, so it’s a good idea to use Services. ## Step 1: Creating the Container @@ -34,7 +35,7 @@ Instead, you have to build a custom container that has the code already inside i To do this, you need to use more Docker. Make sure you have the latest version installed for the rest of this tutorial. -Getting the code: +Getting the code: Before starting, let’s get some code to run. You can follow along on your personal machine or a Linux VM in the cloud. I recommend using Linux or a Linux VM; running Docker on Mac and Windows is outside the scope of this tutorial. @@ -72,7 +73,7 @@ Then, it creates a folder to store the code, `cd`s into that directory, copies t Finally, it specifies the command Docker should run when the container starts, which is to start the app. -## Step 2: Building our Container +## Step 2: Building our Container Right now, the directory should look like this: @@ -177,8 +178,8 @@ After a few minutes, you should see this in the console. Three things need to be created: 1. Persistent Disk to store the data (pods are ephemeral, so we shouldn't save data locally) -2. Replication Controller running MongoDB -3. Service mapping to that Replication Controller +2. Deployment running MongoDB +3. Service mapping to that Deployment To create the disk, run this: @@ -192,46 +193,45 @@ $ gcloud compute disks create \ Pick the same zone as your cluster and an appropriate disk size for your application. -Now, we need to create a Replication Controller that will run the database. I’m using a Replication Controller and not a Pod, because if a standalone Pod dies, it won't restart automatically. +Now, we need to create a Deployment that will run the database. I’m using a Deployment and not a Pod, because if a standalone Pod dies, it won't restart automatically. -### `db-controller.yml` +### `db-deployment.yml` ```yaml -apiVersion: v1 -kind: ReplicationController +apiVersion: extensions/v1beta1 +kind: Deployment metadata: - labels: - name: mongo - name: mongo-controller + name: mongo-deployment spec: - replicas: 1 - template: - metadata: - labels: - name: mongo - spec: - containers: - - image: mongo - name: mongo - ports: - - name: mongo - containerPort: 27017 - hostPort: 27017 - volumeMounts: - - name: mongo-persistent-storage - mountPath: /data/db - volumes: - - name: mongo-persistent-storage - gcePersistentDisk: - pdName: mongo-disk - fsType: ext4 + replicas: 1 + template: + metadata: + labels: + name: mongo + spec: + containers: + - image: mongo + name: mongo + ports: + - name: mongo + containerPort: 27017 + hostPort: 27017 + volumeMounts: + - name: mongo-persistent-storage + mountPath: /data/db + volumes: + - name: mongo-persistent-storage + gcePersistentDisk: + pdName: mongo-disk + fsType: ext4 + ``` -We call the controller `mongo-controller`, specify one replica, and open the appropriate ports. The image is `mongo`, which is the off the shelf MongoDB image. +We call the deployment `mongo-deployment`, specify one replica, and open the appropriate ports. The image is `mongo`, which is the off the shelf MongoDB image. The `volumes` section creates the volume for Kubernetes to use. There is a Google Container Engine-specific `gcePersistentDisk` section that maps the disk we made into a Kubernetes volume, and we mount the volume into the `/data/db` directory (as described in the MongoDB Docker documentation) -Now we have the Controller, let’s create the Service: +Now we have the Deployment, let’s create the Service: ### `db-service.yml` @@ -250,7 +250,7 @@ spec: name: mongo ``` -Again, pretty simple stuff. We "select" the mongo Controller to be served, open up the ports, and call the service `mongo`. +Again, pretty simple stuff. We "select" the mongo Deployment to be served, open up the ports, and call the service `mongo`. This is just like the "link" command line option we used with Docker in my previous post. Instead of connecting to `localhost`, we connect to `mongo`, and Kubernetes redirects traffic to the mongo service! @@ -261,7 +261,7 @@ $ ls Dockerfile app -db-controller.yml +db-deployment.yml db-service.yml ``` @@ -273,10 +273,10 @@ First, let’s "log in" to the cluster $ gcloud container clusters get-credentials mean-cluster ``` -Now create the controller. +Now create the Deployment. ```shell -$ kubectl create -f db-controller.yml +$ kubectl create -f db-deployment.yml ``` And the Service. @@ -299,7 +299,7 @@ Once you see the mongo pod in running status, we are good to go! $ kubectl get pods NAME READY REASON RESTARTS AGE -mongo-controller-xxxx 1/1 Running 0 3m +mongo-deployment-xxxx 1/1 Running 0 3m ``` @@ -309,36 +309,35 @@ Now the database is running, let’s start the web server. We need two things: -1. Replication Controller to spin up and down web server pods +1. Deployment to spin up and down web server pods 2. Service to expose our website to the interwebs -Let’s look at the Replication Controller configuration: +Let’s look at the Deployment configuration: -### `web-controller.yml` +### `web-deployment.yml` ```yaml -apiVersion: v1 -kind: ReplicationController +apiVersion: extensions/v1beta1 +kind: Deployment metadata: - labels: - name: web - name: web-controller + name: web-deployment spec: - replicas: 2 - template: - metadata: - labels: - name: web - spec: - containers: - - image: gcr.io//myapp - name: web - ports: - - containerPort: 3000 - name: http-server + replicas: 2 + template: + metadata: + labels: + name: web + spec: + containers: + - image: gcr.io//myapp + name: web + ports: + - name: http-server + containerPort: 3000 + ``` -Here, we create a controller called `web-controller`, and we tell it to create two replicas. Replicas of what you ask? You may notice the `template` section looks just like a Pod configuration, and that's because it is. We are creating a Pod with our custom Node.js container and exposing port 3000. +Here, we create a deployment called `web-deployment`, and we tell it to create two replicas. Replicas of what you ask? You may notice the `template` section looks just like a Pod configuration, and that's because it is. We are creating a Pod with our custom Node.js container and exposing port 3000. Now for the Service @@ -372,16 +371,21 @@ At this point, the local directory looks like this ```shell $ ls -Dockerfile app db-pod.yml db-service.yml web-service.yml web-controller.yml +Dockerfile +app +db-deployment.yml +db-service.yml +web-service.yml +web-deployment.yml ``` ## Step 8: Running the Web Server -Create the Controller. +Create the Deployment. ```shell -$ kubectl create -f web-controller.yml +$ kubectl create -f web-deployment.yml ``` And the Service. @@ -402,19 +406,19 @@ Once you see the web pods in running status, we are good to go! $ kubectl get pods NAME READY REASON RESTARTS AGE -mongo-controller-xxxx 1/1 Running 0 4m -web-controller-xxxx 1/1 Running 0 1m -web-controller-xxxx 1/1 Running 0 1m +mongo-deployment-xxxx 1/1 Running 0 4m +web-deployment-xxxx 1/1 Running 0 1m +web-deployment-xxxx 1/1 Running 0 1m ``` ## Step 9: Accessing the App -At this point, everything is up and running. The architecture looks something like this: +At this point, everything is up and running. The architecture looks something like this: -![image](/images/docs/meanstack/MEANstack_architecture.svg){: style="max-width:25%"} +![image](/images/docs/meanstack/MEANstack_architecture.svg){: style="max-width:25%"} -By default, port 80 should be open on the load balancer. In order to find the IP address of our app, run this command: +By default, port 80 should be open on the load balancer. In order to find the IP address of our app, run this command: ```shell $ gcloud compute forwarding-rules list @@ -436,7 +440,7 @@ And the Database works! By using Container Engine and Kubernetes, we have a very robust, container based MEAN stack running in production. -[In anoter post](https://medium.com/google-cloud/mongodb-replica-sets-with-kubernetes-d96606bd9474#.e93x7kuq5), I cover how to setup a MongoDB replica set. This is very important for running in production. +[In another post](https://medium.com/google-cloud/mongodb-replica-sets-with-kubernetes-d96606bd9474#.e93x7kuq5), I cover how to setup a MongoDB replica set. This is very important for running in production. Hopefully I can do some more posts about advanced Kubernetes topics such as changing the cluster size and number of Node.js web server replicas, using different environments (dev, staging, prod) on the same cluster, and doing rolling updates. diff --git a/docs/getting-started-guides/mesos-docker.md b/docs/getting-started-guides/mesos-docker.md index 5067c0ba72..eb9ccbc0ad 100644 --- a/docs/getting-started-guides/mesos-docker.md +++ b/docs/getting-started-guides/mesos-docker.md @@ -1,4 +1,8 @@ --- +assignees: +- jdef +- karlkfi + --- diff --git a/docs/getting-started-guides/mesos/OWNERS b/docs/getting-started-guides/mesos/OWNERS index 7cdb4cdb49..65374ee426 100644 --- a/docs/getting-started-guides/mesos/OWNERS +++ b/docs/getting-started-guides/mesos/OWNERS @@ -1,3 +1,5 @@ assignees: - - jdef - - karlkfi +- jdef +- sttts +- thockin + diff --git a/docs/getting-started-guides/mesos/index.md b/docs/getting-started-guides/mesos/index.md index 059122c497..bec65b64fd 100644 --- a/docs/getting-started-guides/mesos/index.md +++ b/docs/getting-started-guides/mesos/index.md @@ -1,4 +1,7 @@ --- +assignees: +- jdef + --- * TOC diff --git a/docs/getting-started-guides/minikube.md b/docs/getting-started-guides/minikube.md new file mode 100644 index 0000000000..b2c9b8a776 --- /dev/null +++ b/docs/getting-started-guides/minikube.md @@ -0,0 +1,148 @@ +--- +assignees: +- dlorenc +- janetkuo +- jlowdermilk + +--- + +* TOC +{:toc} + +Minikube starts a single node kubernetes cluster locally for purposes of development and testing. +Minikube packages and configures a Linux VM, Docker and all Kubernetes components, optimized for local development. +Minikube supports Kubernetes features such as: + +* DNS +* NodePorts +* ConfigMaps and Secrets +* Dashboards + +Minikube does not yet support Cloud Provider specific features such as: + +* LoadBalancers +* PersistentVolumes +* Ingress + +### Requirements + +Minikube requires that VT-x/AMD-v virtualization is enabled in BIOS on all platforms. + +To check that this is enabled on Linux, run: + +```shell +cat /proc/cpuinfo | grep 'vmx\|svm' +``` + +This command should output something if the setting is enabled. + +To check that this is enabled on OSX (most newer Macs have this enabled by default), run: + +```shell +sysctl -a | grep machdep.cpu.features | grep VMX + +``` + +This command should output something if the setting is enabled. + +#### Linux + +Minikube requires the latest [Virtualbox](https://www.virtualbox.org/wiki/Downloads) to be installed on your system. + +#### OSX + +Minikube requires one of the following: + +* The latest [Virtualbox](https://www.virtualbox.org/wiki/Downloads). +* The latest version of [VMWare Fusion](https://www.vmware.com/products/fusion). + +### Install `minikube` + +See the [latest Minikube release](https://github.com/kubernetes/minikube/releases) for installation instructions. + +### Install `kubectl` + +You will need to download and install the kubectl client binary for `${K8S_VERSION}` (in this example: `{{page.version}}.0`) +to run commands against the cluster. + +```shell +# linux/amd64 +curl -Lo kubectl http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/linux/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/ +# linux/386 +curl -Lo kubectl http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/linux/386/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/ +# linux/arm +curl -Lo kubectl http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/linux/arm/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/ +# linux/arm64 +curl -Lo kubectl http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/linux/arm64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/ +#linux/ppc64le +curl -Lo kubectl http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/linux/ppc64le/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/ +# OS X/amd64 +curl -Lo kubectl http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/darwin/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/ +# OS X/386 +curl -Lo kubectl http://storage.googleapis.com/kubernetes-release/release/{{page.version}}.0/bin/darwin/386/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin/ +``` + +The generic download path is: +``` +https://storage.googleapis.com/kubernetes-release/release/${K8S_VERSION}/bin/${GOOS}/${GOARCH}/${K8S_BINARY} +``` + +### Starting the cluster + +To start a cluster, run the command: + +```shell +minikube start +Starting local Kubernetes cluster... +Kubernetes is available at https://192.168.99.100:443. +``` + +This will build and start a lightweight local cluster, consisting of a master, etcd, Docker and a single node. + +Minikube will also create a "minikube" context, and set it to default in kubectl. +To switch back to this context later, run this command: `kubectl config use-context minikube`. + +Type `minikube stop` to shut the cluster down. + +Minikube also includes the [Kubernetes dashboard](http://kubernetes.io/docs/user-guide/ui/). Run this command to see the included kube-system pods: + +```shell +$ kubectl get pods --all-namespaces +NAMESPACE NAME READY STATUS RESTARTS AGE +kube-system kube-addon-manager-127.0.0.1 1/1 Running 0 35s +kube-system kubernetes-dashboard-9brhv 1/1 Running 0 20s +``` + +Run this command to open the Kubernetes dashboard: + +```shell +minikube dashboard +``` + +### Test it out + +List the nodes in your cluster by running: + +```shell +kubectl get nodes +``` + +Minikube contains a built-in Docker daemon that for running containers. +If you use another Docker daemon for building your containers, you will have to publish them to a registry before minikube can pull them. +You can use minikube's built in Docker daemon to avoid this extra step of pushing your images. +Use the built-in Docker daemon with: + +```shell +eval $(minikube docker-env) +``` +This command sets up the Docker environment variables so a Docker client can communicate with the minikube Docker daemon. +Minikube currently supports only docker version 1.11.1 on the server, which is what is supported by Kubernetes 1.3. With a newer docker version you'll get this [issue](https://github.com/kubernetes/minikube/issues/338). + +```shell +docker ps +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +42c643fea98b gcr.io/google_containers/kubernetes-dashboard-amd64:v1.0.1 "/dashboard --port=90" 3 minutes ago Up 3 minutes k8s_kubernetes-dashboard.1d0d880_kubernetes-dashboard-9brhv_kube-system_5062dd0b-370b-11e6-84b6-5eab1f51187f_134cba4c +475db7659edf gcr.io/google_containers/pause-amd64:3.0 "/pause" 3 minutes ago Up 3 minutes k8s_POD.2225036b_kubernetes-dashboard-9brhv_kube-system_5062dd0b-370b-11e6-84b6-5eab1f51187f_e76d8136 +e9096501addf gcr.io/google-containers/kube-addon-manager-amd64:v2 "/opt/kube-addons.sh" 3 minutes ago Up 3 minutes k8s_kube-addon-manager.a1c58ca2_kube-addon-manager-127.0.0.1_kube-system_48abed82af93bb0b941173334110923f_82655b7d +64748893cf7c gcr.io/google_containers/pause-amd64:3.0 "/pause" 4 minutes ago Up 4 minutes k8s_POD.d8dbe16c_kube-addon-manager-127.0.0.1_kube-system_48abed82af93bb0b941173334110923f_c67701c3 +``` diff --git a/docs/getting-started-guides/openstack-heat.md b/docs/getting-started-guides/openstack-heat.md index 3da20528f7..3a151c6bf5 100644 --- a/docs/getting-started-guides/openstack-heat.md +++ b/docs/getting-started-guides/openstack-heat.md @@ -1,4 +1,8 @@ --- +assignees: +- idvoretskyi +- xsgordon + --- * TOC @@ -28,6 +32,7 @@ If you already have the required versions of the OpenStack CLI tools installed a ```sh sudo pip install -U --force 'python-openstackclient==2.4.0' +sudo pip install -U --force 'python-heatclient==1.1.0' sudo pip install -U --force 'python-swiftclient==3.0.0' sudo pip install -U --force 'python-glanceclient==2.0.0' sudo pip install -U --force 'python-novaclient==3.4.0' @@ -73,6 +78,7 @@ export IMAGE_FILE=CentOS-7-x86_64-GenericCloud-1510.qcow2 export SWIFT_SERVER_URL=http://192.168.123.100:8080 export ENABLE_PROXY=false ``` + #### Manually overriding configuration values If you do not have your environment variables set, or do not want them consumed, modify the variables in the following files under `cluster/openstack-heat`: @@ -86,12 +92,12 @@ Please see the contents of these files for documentation regarding each variable ## Starting a cluster -Once you've installed the OpenStack CLI tools and have set your OpenStack environment variables, issue this command: +Once Kubernetes version 1.3 is released, and you've installed the OpenStack CLI tools and have set your OpenStack environment variables, issue this command: ```sh export KUBERNETES_PROVIDER=openstack-heat; curl -sS https://get.k8s.io | bash ``` -Alternatively, you can download a [Kubernetes release](https://github.com/kubernetes/kubernetes/releases) and extract the archive. To start your cluster, open a shell and run: +Alternatively, you can download a [Kubernetes release](https://github.com/kubernetes/kubernetes/releases) of version 1.3 or higher and extract the archive. To start your cluster, open a shell and run: ```sh cd kubernetes # Or whichever path you have extracted the release to @@ -105,6 +111,7 @@ make clean make quick-release KUBERNETES_PROVIDER=openstack-heat ./cluster/kube-up.sh ``` + ## Inspect your cluster Once kube-up is finished, your cluster should be running: diff --git a/docs/getting-started-guides/ovirt.md b/docs/getting-started-guides/ovirt.md index e1ebe7e67a..d22b36fe0f 100644 --- a/docs/getting-started-guides/ovirt.md +++ b/docs/getting-started-guides/ovirt.md @@ -1,4 +1,8 @@ --- +assignees: +- caesarxuchao +- erictune + --- * TOC diff --git a/docs/getting-started-guides/photon-controller.md b/docs/getting-started-guides/photon-controller.md new file mode 100644 index 0000000000..c9c317ca07 --- /dev/null +++ b/docs/getting-started-guides/photon-controller.md @@ -0,0 +1,242 @@ +--- +assignees: +- bprashanth + +--- + +The example below creates a Kubernetes cluster using VMware's Photon +Controller. The cluster will have one Kubernetes master and three +Kubernetes nodes. + +* TOC +{:toc} + +### Prerequisites + +1. You need administrator access to a [VMware Photon +Controller](http://vmware.github.io/photon-controller/) +deployment. (Administrator access is only required for the initial +setup: the actual creation of the cluster can be done by anyone.) + +2. The [Photon Controller CLI](https://github.com/vmware/photon-controller-cli) +needs to be installed on the machine on which you'll be running kube-up. If you +have go installed, this can be easily installed with: + +```shell +go get github.com/vmware/photon-controller-cli/photon +``` + +3. `mkisofs` needs to be installed. The installation process creates a +CD-ROM ISO image to bootstrap the VMs with cloud-init. If you are on a +Mac, you can install this with [brew](http://brew.sh/): + +```shell +brew install cdrtools +``` + +4. Several common tools need to be installed: `ssh`, `scp`, `openssl` + +5. You should have an ssh public key installed. This will be used to +give you access to the VM's user account, `kube`. + +6. Get or build a [binary release](/docs/getting-started-guides/binary_release) + +### Download VM Image + +Download a prebuilt Debian 8.2 VMDK that we'll use as a base image: + +```shell +curl --remote-name-all https://s3.amazonaws.com/photon-platform/artifacts/OS/debian/debian-8.2.vmdk +``` + +This is a base Debian 8.2 image with the addition of: + +* openssh-server +* open-vm-tools +* cloud-init + +### Configure Photon Controller: + +In order to deploy Kubernetes, you need to configure Photon Controller +with: + +* A tenant, with associated resource ticket +* A project within that tenant +* VM and disk flavors, to describe the VM characteristics +* An image: we'll use the one above + +When you do this, you'll need to configure the +`cluster/photon-controller/config-common.sh` file with the names of +the tenant, project, flavors, and image. + +If you prefer, you can use the provided `cluster/photon-controller/setup-prereq.sh` +script to create these. Assuming the IP address of your Photon +Controller is 192.0.2.2 (change as appropriate) and the downloaded image is +kube.vmdk, you can run: + +```shell +photon target set https://192.0.2.2 +photon target login ...credentials... +cluster/photon-controller/setup-prereq.sh https://192.0.2.2 kube.vmdk +``` + +The `setup-prereq.sh` script will create the tenant, project, flavors, +and image based on the same configuration file used by kube-up: +`cluster/photon-controller/config-common.sh`. Note that it will create +a resource ticket which limits how many VMs a tenant can create. You +will want to change the resource ticket configuration in +`config-common.sh` based on your actual Photon Controller deployment. + +### Configure kube-up + +There are two files used to configure kube-up's interaction with +Photon Controller: + +1. `cluster/photon-controller/config-common.sh` has the most common +parameters, including the names of the tenant, project, and image. + +2. `cluster/photon-controller/config-default.sh` has more advanced +parameters including the IP subnets to use, the number of nodes to +create and which Kubernetes components to configure. + +Both files have documentation to explain the different parameters. + +### Creating your Kubernetes cluster + +To create your Kubernetes cluster we will run the standard `kube-up` +command. As described above, the parameters that control kube-up's +interaction with Photon Controller are specified in files, not on the +command-line. + +The time to deploy varies based on the number of nodes you create as +well as the specifications of your Photon Controller hosts and +network. Times vary from 10 - 30 minutes for a ten node cluster. + +```shell +KUBERNETES_PROVIDER=photon-controller cluster/kube-up.sh +``` + +Once you have successfully reached this point, your Kubernetes cluster +works just like any other. + +Note that kube-up created a Kubernetes configuration file for you in +`~/.kube/config`. This file will allow you to use the `kubectl` +command. It contains the IP address of the Kubernetes master as well +as the password for the `admin` user. If you wish to use the +Kubernetes web-based user interface you will need this password. In +the config file you'll see a section that look like the following: you +use the password there. (Note that the output has been trimmed: the +certificate data is much lengthier) + +```yaml +- name: photon-kubernetes + user: + client-certificate-data: Q2Vyd... + client-key-data: LS0tL... + password: PASSWORD-HERE + username: admin +``` + +### Removing your Kubernetes cluster + +The recommended way to remove your Kubernetes cluster is with the +`kube-down` command: + +```shell +KUBERNETES_PROVIDER=photon-controller cluster/kube-down.sh +``` + +Your Kubernetes cluster is just a set of VMs: you can manually remove +them if you need to. + +### Making services publicly accessible + +There are multiple ways to make services publicly accessible in Kubernetes. +Currently, the photon-controller support does not yet include built-in +support for the LoadBalancer option. + +#### Option 1: NodePort + +One option is to use the NodePort option with a manually deployed +balancer. Specifically: + +Configure your service with the NodePort option. For example, this +service uses the NodePort option. All Kubernetes nodes will listen on +a port and forward network traffic to any pods in the service. In this +case, Kubernets will choose a random port, but it will be the same +port on all nodes. + +```yaml +apiVersion: v1 +kind: Service +metadata: + name: nginx-demo-service + labels: + app: nginx-demo +spec: + type: NodePort + ports: + - port: 80 + protocol: TCP + name: http + selector: + app: nginx-demo +``` + +Next, create a new standalone VM (or VMs, for high availability) to act +as a load balancer. For example, if you use haproxy, you could make a +configuration similar to the one below. Note that this example assumes there +are three Kubernetes nodes: you would adjust the configuration to reflect the +actual nodes you have. Also note that port 30144 should be replaced +with whatever NodePort was assigned by Kubernetes. + +```yaml +frontend nginx-demo + bind *:30144 + mode http + default_backend nodes +backend nodes + mode http + balance roundrobin + option forwardfor + http-request set-header X-Forwarded-Port %[dst_port] + http-request add-header X-Forwarded-Proto https if { ssl_fc } + option httpchk HEAD / HTTP/1.1\r\nHost:localhost + server web0 192.0.2.2:30144 check + server web1 192.0.2.3:30144 check + server web2 192.0.2.4:30144 check +``` + +#### Option 2: Ingress Controller + +Using an [ingress controller](docs/user-guide/ingress) may also be an +appropriate solution. Note that it in a production environment it will +also require an external load balancer. However, it may be simpler to +manage because it will not require you to manually update the load +balancer configuration, as above. + +### Details + +#### Logging into VMs + +When the VMs are created, a `kube` user is created (using +cloud-init). The password for the kube user is the same as the +administrator password for your Kubernetes master and can be found in +your Kubernetes configuration file: see above to find it. The kube user +will also authorize your ssh public key to log in. This is used during +installation to avoid the need for passwords. + +The VMs do have a root user, but ssh to the root user is disabled. + +### Networking + +The Kubernetes cluster uses `kube-proxy` to configure the overlay +network with iptables. Currently we do not support other overlay +networks such as Weave or Calico. + +## Support Level + + +IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level +-------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ---------------------------- +Vmware Photon | Saltstack | Debian | OVS | [docs](/docs/getting-started-guides/photon-controller) | | Community ([@alainroy](https://github.com/alainroy)) diff --git a/docs/getting-started-guides/rackspace.md b/docs/getting-started-guides/rackspace.md index a91187275e..5ed73f495f 100644 --- a/docs/getting-started-guides/rackspace.md +++ b/docs/getting-started-guides/rackspace.md @@ -1,4 +1,7 @@ --- +assignees: +- erictune + --- * Supported Version: v0.18.1 diff --git a/docs/getting-started-guides/rkt/OWNERS b/docs/getting-started-guides/rkt/OWNERS new file mode 100644 index 0000000000..06ce8c444b --- /dev/null +++ b/docs/getting-started-guides/rkt/OWNERS @@ -0,0 +1,4 @@ +assignees: +- lavalamp +- yifan-gu + diff --git a/docs/getting-started-guides/rkt/index.md b/docs/getting-started-guides/rkt/index.md index e644b52462..e13ec90010 100644 --- a/docs/getting-started-guides/rkt/index.md +++ b/docs/getting-started-guides/rkt/index.md @@ -1,219 +1,226 @@ --- +assignees: +- lavalamp +- yifan-gu + --- -This document describes how to run Kubernetes using [rkt](https://github.com/coreos/rkt) as a container runtime. -We still have [a bunch of work](http://issue.k8s.io/8262) to do to make the experience with rkt wonderful, please stay tuned! +This document describes how to run Kubernetes using [rkt](https://github.com/coreos/rkt) as the container runtime. -### **Prerequisite** +* TOC +{:toc} -- [systemd](http://www.freedesktop.org/wiki/Software/systemd/) should be installed on the machine and should be enabled. The minimum version required at this moment (2015/09/01) is 219 - *(Note that systemd is not required by rkt itself, we are using it here to monitor and manage the pods launched by kubelet.)* +## Prerequisites -- Install the latest rkt release according to the instructions [here](https://github.com/coreos/rkt). - The minimum version required for now is [v0.8.0](https://github.com/coreos/rkt/releases/tag/v0.8.0). +* [Systemd](http://www.freedesktop.org/wiki/Software/systemd/) must be installed and enabled. The minimum systemd version required for Kubernetes v1.3 is `219`. Systemd is used to monitor and manage the pods on each node. -- Note that for rkt version later than v0.7.0, `metadata service` is not required for running pods in private networks. So now rkt pods will not register the metadata service be default. +* [Install the latest rkt release](https://coreos.com/rkt/docs/latest/trying-out-rkt.html). The minimum rkt version required is [v1.9.1](https://github.com/coreos/rkt/releases/tag/v1.9.1). The [CoreOS Linux alpha channel](https://coreos.com/releases/) ships with a recent rkt release, and you can easily [upgrade rkt on CoreOS](https://coreos.com/rkt/docs/latest/install-rkt-in-coreos.html), if necessary. -- Since release [v1.2.0-alpha.5](https://github.com/kubernetes/kubernetes/releases/tag/v1.2.0-alpha.5), -the [rkt API service](https://github.com/coreos/rkt/blob/master/api/v1alpha/README.md) -must be running on the node. +* The [rkt API service](https://coreos.com/rkt/docs/latest/subcommands/api-service.html) must be running on the node. -### Network Setup +## Pod networking in rktnetes -rkt uses the [Container Network Interface (CNI)](https://github.com/appc/cni) -to manage container networking. By default, all pods attempt to join a network -called `rkt.kubernetes.io`, which is currently defined [in -`rkt.go`](https://github.com/kubernetes/kubernetes/blob/v1.2.0-alpha.6/pkg/kubelet/rkt/rkt.go#L91). -In order for pods to get correct IP addresses, the CNI config file must be -edited to add this `rkt.kubernetes.io` network: +### Kubernetes CNI networking -#### Using flannel +You can configure Kubernetes pod networking with the usual Container Network Interface (CNI) [network plugins](/docs/admin/network-plugins/) by setting the kubelet's `--network-plugin` and `--network-plugin-dir` options appropriately. Configured in this fashion, the rkt container engine will be unaware of network details, and expects to connect pods to the provided subnet. -In addition to the basic prerequisites above, each node must be running -a [flannel](https://github.com/coreos/flannel) daemon. This implies -that a flannel-supporting etcd service must be available to the cluster -as well, apart from the Kubernetes etcd, which will not yet be -available at flannel configuration time. Once it's running, flannel can -be set up with a CNI config like: +#### kubenet: Google Compute Engine (GCE) network + +The `kubenet` plugin can be selected with the kubelet option `--network-plugin=kubenet`. This plugin is currently only supported on GCE. When using kubenet, Kubernetes CNI creates and manages the network, and rkt is provided with a subnet from a bridge device connected to the GCE network. + +### rkt contained network + +Rather than delegating pod networking to Kubernetes, rkt can configure connectivity directly with its own [*contained network*](https://coreos.com/rkt/docs/latest/networking/overview.html#contained-mode) on a subnet provided by a bridge device, the flannel SDN, or another CNI plugin. Configured this way, rkt looks in its [config directories](https://coreos.com/rkt/docs/latest/configuration.html#command-line-flags), usually `/etc/rkt/net.d`, to discover the CNI configuration and invoke the appropriate plugins to create the pod network. + +#### rkt contained network with bridge + +The *contained network* is rkt's default, so you can leave the kubelet's `--network-plugin` option empty to select this network. The contained network can be backed by any CNI plugin. With the *contained network*, rkt will attempt to join pods to a network named `rkt.kubernetes.io`, so this network name must be used for whatever desired CNI configuration. + +When using the contained network, create a network configuration file beneath the rkt network config directory that defines how to create this `rkt.kubernetes.io` network in your environment. This example sets up a bridge device with the `bridge` CNI plugin: ```shell -$ cat </etc/rkt/net.d/k8s_cluster.conf +$ cat </etc/rkt/net.d/k8s_network_example.conf { - "name": "rkt.kubernetes.io", - "type": "flannel" -} -EOF -``` - -While `k8s_cluster.conf` is a rather arbitrary name for the config file itself, -and can be adjusted to suit local conventions, the keys and values should be exactly -as shown above. `name` must be `rkt.kubernetes.io` and `type` should be `flannel`. -More details about the flannel CNI plugin can be found -[in the CNI documentation](https://github.com/appc/cni/blob/master/Documentation/flannel.md). - -#### On GCE - -Each VM on GCE has an additional 256 IP addresses routed to it, so -it is possible to forego flannel in smaller clusters. This makes the -necessary CNI config file a bit more verbose: - -```shell -$ cat </etc/rkt/net.d/k8s_cluster.conf -{ - "name": "rkt.kubernetes.io", - "type": "bridge", - "bridge": "cbr0", - "isGateway": true, - "ipam": { - "type": "host-local", - "subnet": "10.255.228.1/24", - "gateway": "10.255.228.1" - }, + "name": "rkt.kubernetes.io", + "type": "bridge", + "bridge": "mybridge", + "mtu": 1460, + "addIf": "true", + "isGateway": true, + "ipMasq": true, + "ipam": { + "type": "host-local", + "subnet": "10.22.0.0/16", + "gateway": "10.22.0.1", "routes": [ { "dst": "0.0.0.0/0" } ] + } } EOF ``` -This example creates a `bridge` plugin configuration for the CNI network, specifying -the bridge name `cbr0`. It also specifies the CIDR, in the `ipam` field. +#### rkt contained network with flannel -Creating these files for any moderately-sized cluster is at best inconvenient. -Work is in progress to -[enable Kubernetes to use the CNI by default] -(https://github.com/kubernetes/kubernetes/pull/18795/files). -As that work matures, such manual CNI config munging will become unnecessary -for primary use cases. For early adopters, an initial example shows one way to -[automatically generate these CNI configurations] -(https://gist.github.com/yifan-gu/fbb911db83d785915543) -for rkt. +While it is recommended to operate flannel through the Kubernetes CNI support, you can alternatively configure the flannel plugin directly to provide the subnet for rkt's contained network. An example CNI/flannel config file looks like this: -### Local cluster +```shell +$ cat </etc/rkt/net.d/k8s_flannel_example.conf +{ + "name": "rkt.kubernetes.io", + "type": "flannel", + "delegate": { + "isDefaultGateway": true + } +} +EOF +``` -To use rkt as the container runtime, we need to supply the following flags to kubelet: +For more information on flannel configuration, see the [CNI/flannel README](https://github.com/containernetworking/cni/blob/master/Documentation/flannel.md). -- `--container-runtime=rkt` chooses the container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'. -- `--rkt-path=$PATH_TO_RKT_BINARY` sets the path of rkt binary. Leave empty to use the first rkt in $PATH. -- `--rkt-stage1-image` sets the path of the stage1 image. Local paths and http/https URLs are supported. Leave empty to use the 'stage1.aci' that locates in the same directory as the rkt binary. +#### Contained network caveats: -If you are using the [hack/local-up-cluster.sh](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/hack/local-up-cluster.sh) script to launch the local cluster, then you can edit the environment variable `CONTAINER_RUNTIME`, `RKT_PATH` and `RKT_STAGE1_IMAGE` to -set these flags: +* You must create an appropriate CNI configuration file with a network name of `rkt.kubernetes.io`. +* The downwards API and environment variable substitution will not contain the pod IP address. +* The `/etc/hosts` file will not contain the pod's own hostname, although `/etc/hostname` is populated. + +## Running rktnetes + +### Spin up a local Kubernetes cluster with the rkt runtime + +To use rkt as the container runtime in a local Kubernetes cluster, supply the following flags to the kubelet: + +* `--container-runtime=rkt` Set the node's container runtime to rkt. +* `--rkt-api-endpoint=HOST:PORT` Set the endpoint of the rkt API service. Default: `localhost:15441`. +* `--rkt-path=PATH_TO_RKT_BINARY` Set the path of the rkt binary. Optional. If empty, look for `rkt` in `$PATH`. +* `--rkt-stage1-image=STAGE1` Set the name of the stage1 image, e.g. `coreos.com/rkt/stage1-coreos`. Optional. If not set, the default Linux kernel software isolation stage1 is used. + +If you are using the [hack/local-up-cluster.sh](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/hack/local-up-cluster.sh) script to launch the cluster, you can edit the environment variables `CONTAINER_RUNTIME`, `RKT_PATH`, and `RKT_STAGE1_IMAGE` to set these flags. `RKT_PATH` and `RKT_STAGE1_IMAGE` are optional if `rkt` is in your $PATH` with appropriate configuration. ```shell $ export CONTAINER_RUNTIME=rkt -$ export RKT_PATH=$PATH_TO_RKT_BINARY -$ export RKT_STAGE1_IMAGE=PATH=$PATH_TO_STAGE1_IMAGE +$ export RKT_PATH= +$ export RKT_STAGE1_IMAGE= ``` -Then we can launch the local cluster using the script: +Now you can launch the cluster using the `local-up-cluster.sh` script: ```shell $ hack/local-up-cluster.sh ``` -### CoreOS cluster on Google Compute Engine (GCE) +We are also working on getting rkt working as the container runtime in [minikube](https://github.com/kubernetes/minikube/issues/168). -To use rkt as the container runtime for your CoreOS cluster on GCE, you need to specify the OS distribution, project, image: +### Launch a rktnetes cluster on Google Compute Engine (GCE) + +This section outlines using the `kube-up` script to launch a CoreOS/rkt cluster on GCE. + +Specify the OS distribution, the GCE distributor's master project, and the instance images for the Kubernetes master and nodes. Set the `KUBE_CONTAINER_RUNTIME` to `rkt`: ```shell $ export KUBE_OS_DISTRIBUTION=coreos -$ export KUBE_GCE_NODE_IMAGE= +$ export KUBE_GCE_MASTER_PROJECT=coreos-cloud +$ export KUBE_GCE_MASTER_IMAGE= $ export KUBE_GCE_NODE_PROJECT=coreos-cloud +$ export KUBE_GCE_NODE_IMAGE= $ export KUBE_CONTAINER_RUNTIME=rkt ``` -You can optionally choose the version of rkt used by setting `KUBE_RKT_VERSION`: +Optionally, set the version of rkt by setting `KUBE_RKT_VERSION`: ```shell -$ export KUBE_RKT_VERSION=0.15.0 +$ export KUBE_RKT_VERSION=1.9.1 ``` -Then you can launch the cluster by: +Optionally, select an alternative [stage1 isolator](#modular-isolation-with-interchangeable-stage1-images) for the container runtime by setting `KUBE_RKT_STAGE1_IMAGE`: + +```shell +$ export KUBE_RKT_STAGE1_IMAGE= +``` + +Then you can launch the cluster with: ```shell $ cluster/kube-up.sh ``` -Note that we are still working on making all containerized the master components run smoothly in rkt. Before that we are not able to run the master node with rkt yet. +### Launch a rktnetes cluster on AWS -### CoreOS cluster on AWS +The `kube-up` script is not yet supported on AWS. Instead, we recommend following the [Kubernetes on AWS guide](https://coreos.com/kubernetes/docs/latest/kubernetes-on-aws.html) to launch a CoreOS Kubernetes cluster on AWS, then setting kubelet options as above. -To use rkt as the container runtime for your CoreOS cluster on AWS, you need to specify the provider and OS distribution: +### Deploy apps to the cluster -```shell -$ export KUBERNETES_PROVIDER=aws -$ export KUBE_OS_DISTRIBUTION=coreos -$ export KUBE_CONTAINER_RUNTIME=rkt +After creating the cluster, you can start deploying applications. For an introductory example, [deploy a simple nginx web server](/docs/user-guide/simple-nginx). Note that this example did not have to be modified for use with a "rktnetes" cluster. More examples can be found in the [Kubernetes examples directory](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/). + +## Modular isolation with interchangeable stage1 images + +rkt executes containers in an interchangeable isolation environment. This facility is called the [*stage1* image](https://coreos.com/rkt/docs/latest/devel/architecture.html#stage-1). There are currently three supported rkt stage1 images: + +* `systemd-nspawn` stage1, the default. Isolates running containers with Linux kernel namespaces and cgroups in a manner similar to the default container runtime. +* [`KVM` stage1](https://coreos.com/rkt/docs/latest/running-lkvm-stage1.html), runs containers inside a KVM hypervisor-managed virtual machine. Experimental in the Kubernetes v1.3 release. +* [`fly stage1`](https://coreos.com/rkt/docs/latest/running-fly-stage1.html), which isolates containers with only a `chroot`, giving host-level access to mount and network namespaces for specially-privileged utilities. + +In addition to the three provided stage1 images, you can [create your own](https://coreos.com/rkt/docs/latest/devel/stage1-implementors-guide.html) for specific isolation requirements. If no configuration is set, the [default stage1](https://coreos.com/rkt/docs/latest/build-configure.html#parameters-for-setting-up-default-stage1-image) is used. There are two ways to select a different stage1; either per-node, or per-pod: + +* Set the kubelet's `--rkt-stage1-image` flag, which tells the kubelet the stage1 image to use for every pod on the node. For example, `--rkt-stage1-image=coreos/rkt/stage1-coreos` selects the default systemd-nspawn stage1. +* Set the annotation `rkt.alpha.kubernetes.io/stage1-name-override` to override the stage1 used to execute a given pod. This allows for mixing different container isolation mechanisms on the same cluster or on the same node. For example, the following (shortened) pod manifest will run its pod with the `fly stage1` to give the application -- the `kubelet` in this case -- access to the host's namespace: + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: kubelet + namespace: kube-system + labels: + k8s-app: kubelet + annotations: + rkt.alpha.kubernetes.io/stage1-name-override: coreos.com/rkt/stage1-fly +spec: + containers: + - name: kubelet + image: quay.io/coreos/hyperkube:v1.3.0-beta.2_coreos.0 + command: + - kubelet + - --api-servers=127.0.0.1:8080 + - --config=/etc/kubernetes/manifests + - --allow-privileged + - --kubeconfig=/etc/kubernetes/kubeconfig + securityContext: + privileged: true +[...] ``` -You can optionally choose the version of rkt used by setting `KUBE_RKT_VERSION`: +### Notes on using different stage1 images + +Setting the stage1 annotation could potentially give the pod root privileges. Because of this, the `privileged` boolean in the pod's `securityContext` must be set to `true`. + +Use rkt's [*contained network*](#rkt-contained-network) with the KVM stage1, because the CNI plugin driver does not yet fully support the hypervisor-based runtime. + +## Known issues and differences between rkt and Docker + +rkt and the default node container engine have very different designs, as do rkt's native ACI and the Docker container image format. Users may experience different behaviors when switching from one container engine to the other. More information can be found [in the Kubernetes rkt notes](/docs/getting-started-guides/rkt/notes/). + +## Troubleshooting + +Here are a few tips for troubleshooting Kubernetes with the rkt container engine: + +### Check rkt pod status + +To check the status of running pods, use the rkt subcommands [`rkt list`](https://coreos.com/rkt/docs/latest/subcommands/list.html), [`rkt status`](https://coreos.com/rkt/docs/latest/subcommands/status.html), and [`rkt image list`](https://coreos.com/rkt/docs/latest/subcommands/image.html#rkt-image-list). See the [rkt commands documentation](https://coreos.com/rkt/docs/latest/commands.html) for more information about rkt subcommands. + +### Check journal logs + +Check a pod's log using `journalctl` on the node. Pods are managed and named as systemd units. The pod's unit name is formed by concatenating a `k8s_` prefix with the pod UUID, in a format like `k8s_${RKT_UUID}`. Find the pod's UUID with `rkt list` to assemble its service name, then ask journalctl for the logs: + ```shell -$ export KUBE_RKT_VERSION=0.8.0 +$ sudo journalctl -u k8s_ad623346 ``` -You can optionally choose the CoreOS channel by setting `COREOS_CHANNEL`: +#### Log verbosity -```shell -$ export COREOS_CHANNEL=stable -``` +By default, the log verbosity level is 2. In order to see more log messages related to rkt, set this level to 4 or above. For a local cluster, set the environment variable: `LOG_LEVEL=4`. -Then you can launch the cluster by: +### Check Kubernetes events and logs. -```shell -$ kube-up.sh -``` - -Note: CoreOS is not supported as the master using the automated launch -scripts. The master node is always Ubuntu. - -### Getting started with your cluster - -See [a simple nginx example](/docs/user-guide/simple-nginx) to try out your new cluster. - -For more complete applications, please look in the [examples directory](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/). - -### Different UX with rkt container runtime - -rkt and Docker have very different designs, as well as ACI and Docker image format. Users might experience some different experience when switching from one to the other. More information can be found [here](/docs/getting-started-guides/rkt/notes/). - -### Debugging - -Here are several tips for you when you run into any issues. - -##### Check logs - -By default, the log verbose level is 2. In order to see more logs related to rkt, we can set the verbose level to 4. -For local cluster, we can set the environment variable: `LOG_LEVEL=4`. -If the cluster is using salt, we can edit the [logging.sls](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/cluster/saltbase/pillar/logging.sls) in the saltbase. - -##### Check rkt pod status - -To check the pods' status, we can use rkt command, such as `rkt list`, `rkt status`, `rkt image list`, etc. -More information about rkt command line can be found [here](https://github.com/coreos/rkt/blob/master/Documentation/commands.md) - -##### Check journal logs - -As we use systemd to launch rkt pods(by creating service files which will run `rkt run-prepared`, we can check the pods' log -using `journalctl`: - -- Check the running state of the systemd service: - -```shell -$ sudo journalctl -u $SERVICE_FILE -``` - -where `$SERVICE_FILE` is the name of the service file created for the pod, you can find it in the kubelet logs. - -##### Check the log of the container in the pod: - -```shell -$ sudo journalctl -M rkt-$UUID -u $CONTAINER_NAME -``` - -where `$UUID` is the rkt pod's UUID, which you can find via `rkt list --full`, and `$CONTAINER_NAME` is the container's name. - -##### Check Kubernetes events, logs. - -Besides above tricks, Kubernetes also provides us handy tools for debugging the pods. More information can be found [here](/docs/user-guide/application-troubleshooting) +Kubernetes provides various tools for troubleshooting and examination. More information can be found [in the app troubleshooting guide](/docs/user-guide/application-troubleshooting). diff --git a/docs/getting-started-guides/rkt/notes.md b/docs/getting-started-guides/rkt/notes.md index 44eb57f90e..658d5de2a9 100644 --- a/docs/getting-started-guides/rkt/notes.md +++ b/docs/getting-started-guides/rkt/notes.md @@ -1,99 +1,102 @@ --- +assignees: +- dchen1107 +- yifan-gu + --- -# Notes on Different UX with rkt container runtime +The following features either are not supported or have large caveats when using the rkt container runtime. Increasing support for these items and others, including reasonable feature parity with the default container engine, is planned through future releases. -### Doesn't support ENTRYPOINT + CMD feature +## Non-existent host volume paths -To run a Docker image, rkt will convert it into [App Container Image (ACI) format](https://github.com/appc/spec/blob/master/SPEC.md) first. -However, during the conversion, the `ENTRYPOINT` and `CMD` are concatentated to construct ACI's `Exec` field. -This means after the conversion, we are not able to replace only `ENTRYPOINT` or `CMD` without touching the other part. -So for now, users are recommended to specify the **executable path** in `Command` and **arguments** in `Args`. -(This has the same effect if users specify the **executable path + arguments** in `Command` or `Args` alone). +When mounting a host volume path that does not exist, rkt will error out. Under the Docker runtime, an empty directory will be created at the referenced path. -For example: +An example of a pod which will error out: ```yaml apiVersion: v1 kind: Pod metadata: - name: nginx labels: - name: nginx + name: mount-dne + name: mount-dne spec: + volumes: + - name: does-not-exist + hostPath: + path: /does/not/exist containers: - - name: nginx - image: nginx - ports: - - containerPort: 80 + - name: exit + image: busybox + command: ["sh", "-c", "ls /test; sleep 60"] + volumeMounts: + - mountPath: /test + name: does-not-exist ``` -The above pod yaml file is valid as it's not specifying `Command` or `Args`, so the default `ENTRYPOINT` and `CMD` of the image will be used. +## Kubectl attach + +The `kubectl attach` command does not work under the rkt container runtime. +Because of this, some flags in `kubectl run` are not supported, including: + +* `--attach=true` +* `--leave-stdin-open=true` +* `--rm=true` + +## Port forwarding for kvm and fly stage1s + +`kubectl port-forward` is not supported for pods that are executed with `stage1-kvm` or `stage1-fly`. + +## Volume relabeling + +Currently rkt supports only *per-pod* volume relabeling. After relabeling, the mounted volume is shared by all containers in the pod. There is not yet a way to make the relabeled volume accessible to only one, or some subset, of containers in the pod. [Kubernetes issue # 28187](https://github.com/kubernetes/kubernetes/issues/28187) has the details. + +## kubectl get logs + +Under rktnetes, `kubectl get logs` currently cannot get logs from applications that write them to directly to `/dev/stdout`. Currently such log messages are printed on the node's console. + +## Init containers + +The alpha [init container](https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/container-init.md) feature is currently not supported. + +## Container restart back-off + +Exponential restart back-off for a failing container is currently not supported. + +## Experimental NVIDIA GPU support + +The `--experimental-nvidia-gpus` flag, and related [GPU features](https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/gpu-support.md) are not supported. + +## QoS Classes + +Under rkt, QoS classes do not adjust the `OOM Score` of containers as occurs under Docker. + +## HostPID and HostIPC namespaces + +Setting the hostPID or hostIPC flags on a pod is not supported. + +For example, the following pod will not run correctly: ```yaml apiVersion: v1 kind: Pod metadata: - name: busybox labels: - name: busybox + name: host-ipc-pid + name: host-ipc-pid spec: + hostIPC: true + hostPID: true containers: - - name: busybox - image: busybox - command: - - /bin/sleep - - 1000 + ... ``` -```yaml -apiVersion: v1 -kind: Pod -metadata: - name: busybox - labels: - name: busybox -spec: - containers: - - name: busybox - image: busybox - command: - - /bin/sleep - args: - - 1000 -``` +On the other hand, when running the pod with [stage1-fly](https://coreos.com/rkt/docs/latest/running-fly-stage1.html), the pod will be run in the host namespace. -```yaml -apiVersion: v1 -kind: Pod -metadata: - name: busybox - labels: - name: busybox -spec: - containers: - - name: busybox - image: busybox - args: - - /bin/sleep - - 1000 -``` +## Container image updates (patch) -All the three examples above are valid as they contain both the executable path and the arguments. +Patching a pod to change the image will result in the entire pod restarting, not just the container that was changed. -```yaml -apiVersion: v1 -kind: Pod -metadata: - name: busybox - labels: - name: busybox -spec: - containers: - - name: busybox - image: busybox - args: - - 1000 -``` +## Volume mounts specifying a subPath -The last example is invalid, as we cannot override just the `CMD` of the image alone. +The [subPath](https://github.com/kubernetes/kubernetes/pull/22575) feature does not work correctly under rkt. In addition, the issue of non-existent host volume paths being invalid, mentioned above, would cause many common use cases for subPaths to fail in the same way. In some cases, this issue can be worked around by creating and using subdirectories from within the container, rather than relying on Kubernetes to do so. diff --git a/docs/getting-started-guides/scratch.md b/docs/getting-started-guides/scratch.md index 5c9502ff9e..8d0e1d39ae 100644 --- a/docs/getting-started-guides/scratch.md +++ b/docs/getting-started-guides/scratch.md @@ -1,4 +1,9 @@ --- +assignees: +- erictune +- lavalamp +- thockin + --- This guide is for people who want to craft a custom Kubernetes cluster. If you @@ -106,6 +111,7 @@ be active at once. Note that you can grow the end of this range, but you cannot move it without disrupting the services and pods that already use it. Also, you need to pick a static IP for master node. + - Call this `MASTER_IP`. - Open any firewalls to allow access to the apiserver ports 80 and/or 443. - Enable ipv4 forwarding sysctl, `net.ipv4.ip_forward = 1` @@ -179,11 +185,11 @@ For etcd, you can: We recommend that you use the etcd version which is provided in the Kubernetes binary distribution. The Kubernetes binaries in the release were tested extensively with this version of etcd and not with any other version. -The recommended version number can also be found as the value of `ETCD_VERSION` in `kubernetes/cluster/images/etcd/Makefile`. +The recommended version number can also be found as the value of `TAG` in `kubernetes/cluster/images/etcd/Makefile`. The remainder of the document assumes that the image identifiers have been chosen and stored in corresponding env vars. Examples (replace with latest tags and appropriate registry): - - `HYPERKUBE_IMAGE==gcr.io/google_containers/hyperkube:$TAG` + - `HYPERKUBE_IMAGE=gcr.io/google_containers/hyperkube:$TAG` - `ETCD_IMAGE=gcr.io/google_containers/etcd:$ETCD_VERSION` ### Security Models @@ -208,11 +214,10 @@ You need to prepare several certs: - The kubelets optionally need certs to identify themselves as clients of the master, and when serving its own API over HTTPS. -Unless you plan to have a real CA generate your certs, you will need to generate a root cert and use that to sign the master, kubelet, and kubectl certs. - -- see function `create-certs` in `cluster/gce/util.sh` -- see also `cluster/saltbase/salt/generate-cert/make-ca-cert.sh` and - `cluster/saltbase/salt/generate-cert/make-cert.sh` +Unless you plan to have a real CA generate your certs, you will need +to generate a root cert and use that to sign the master, kubelet, and +kubectl certs. How to do this is described in the [authentication +documentation](/docs/admin/authentication/#creating-certificates). You will end up with the following files (we will use these variables later on) @@ -280,7 +285,7 @@ users: clusters: - name: local cluster: - certificate-authority-data: ${CA_CERT_BASE64_ENCODED} + certificate-authority: /srv/kubernetes/ca.crt contexts: - context: cluster: local @@ -320,8 +325,8 @@ as follows before proceeding to configure Docker for Kubernetes. ```shell iptables -t nat -F -ifconfig docker0 down -brctl delbr docker0 +ip link set docker0 down +ip link delete docker0 ``` The way you configure docker will depend in whether you have chosen the routable-vip or overlay-network approaches for your network. @@ -394,10 +399,10 @@ kubelet. Arguments to consider: - If following the HTTPS security approach: - - `--api-servers=https://$MASTER_IP` + - `--master=https://$MASTER_IP` - `--kubeconfig=/var/lib/kube-proxy/kubeconfig` - Otherwise, if taking the firewall-based security approach - - `--api-servers=http://$MASTER_IP` + - `--master=http://$MASTER_IP` ### Networking @@ -420,7 +425,7 @@ because of how this is used later. 1. Set `--configure-cbr0=false` on kubelet and restart. 1. Create a bridge - - `brctl addbr cbr0`. + - `ip link add name cbr0 type bridge`. 1. Set appropriate MTU. NOTE: the actual value of MTU will depend on your network environment - `ip link set dev cbr0 mtu 1460` 1. Add the node's network to the bridge (docker will go on other side of bridge). @@ -480,7 +485,7 @@ You will need to run one or more instances of etcd. by durable storage (RAID, GCE PD) - Alternative: run 3 or 5 etcd instances. - Log can be written to non-durable storage because storage is replicated. - - run a single apiserver which connects to one of the etc nodes. + - run a single apiserver which connects to one of the etcd nodes. See [cluster-troubleshooting](/docs/admin/cluster-troubleshooting) for more discussion on factors affecting cluster availability. @@ -553,8 +558,10 @@ For each of these components, the steps to start them running are similar: ], "livenessProbe": { "httpGet": { - "path": "/healthz", - "port": 8080 + "scheme": "HTTP", + "host": "127.0.0.1", + "port": 8080, + "path": "/healthz" }, "initialDelaySeconds": 15, "timeoutSeconds": 15 @@ -600,6 +607,7 @@ If you are following the firewall-only security approach, then use these argumen - `--advertise-address=$MASTER_IP` If you are using the HTTPS approach, then set: + - `--client-ca-file=/srv/kubernetes/ca.crt` - `--token-auth-file=/srv/kubernetes/known_tokens.csv` - `--basic-auth-file=/srv/kubernetes/basic_auth.csv` @@ -661,9 +669,10 @@ Complete this template for the scheduler pod: ], "livenessProbe": { "httpGet": { - "host" : "127.0.0.1", - "path": "/healthz", - "port": 10251 + "scheme": "HTTP", + "host": "127.0.0.1", + "port": 10251, + "path": "/healthz" }, "initialDelaySeconds": 15, "timeoutSeconds": 15 @@ -716,9 +725,10 @@ Template for controller manager pod: ], "livenessProbe": { "httpGet": { + "scheme": "HTTP", "host": "127.0.0.1", - "path": "/healthz", - "port": 10252 + "port": 10252, + "path": "/healthz" }, "initialDelaySeconds": 15, "timeoutSeconds": 15 @@ -836,7 +846,7 @@ pinging or SSH-ing from one node to another. ### Getting Help If you run into trouble, please see the section on [troubleshooting](/docs/getting-started-guides/gce#troubleshooting), post to the -[google-containers group](https://groups.google.com/forum/#!forum/google-containers), or come ask questions on [Slack](/docs/troubleshooting#slack). +[kubernetes-users group](https://groups.google.com/forum/#!forum/kubernetes-users), or come ask questions on [Slack](/docs/troubleshooting#slack). ## Support Level diff --git a/docs/getting-started-guides/ubuntu-calico.md b/docs/getting-started-guides/ubuntu-calico.md index d1adfa2c73..2eaf7a7aea 100644 --- a/docs/getting-started-guides/ubuntu-calico.md +++ b/docs/getting-started-guides/ubuntu-calico.md @@ -1,4 +1,5 @@ --- + --- This document describes how to deploy Kubernetes with Calico networking from scratch on _bare metal_ Ubuntu. For more information on Project Calico, visit [projectcalico.org](http://projectcalico.org) and the [calico-containers repository](https://github.com/projectcalico/calico-containers). @@ -70,42 +71,6 @@ The master requires the root CA public key, `ca.pem`; the apiserver certificate, sudo chown root:root /etc/kubernetes/ssl/apiserver-key.pem ``` -### Install Kubernetes on the Master - -We'll use the `kubelet` to bootstrap the Kubernetes master. - -1. Download and install the `kubelet` and `kubectl` binaries: - - ```shell - sudo wget -N -P /usr/bin http://storage.googleapis.com/kubernetes-release/release/v1.1.4/bin/linux/amd64/kubectl - sudo wget -N -P /usr/bin http://storage.googleapis.com/kubernetes-release/release/v1.1.4/bin/linux/amd64/kubelet - sudo chmod +x /usr/bin/kubelet /usr/bin/kubectl - ``` - -2. Install the `kubelet` systemd unit file and start the `kubelet`: - - ```shell - # Install the unit file - sudo wget -N -P /etc/systemd https://raw.githubusercontent.com/projectcalico/calico-cni/k8s-1.1-docs/samples/kubernetes/master/kubelet.service - - # Enable the unit file so that it runs on boot - sudo systemctl enable /etc/systemd/kubelet.service - - # Start the kubelet service - sudo systemctl start kubelet.service - ``` - -3. Download and install the master manifest file, which will start the Kubernetes master services automatically: - - ```shell - sudo mkdir -p /etc/kubernetes/manifests - sudo wget -N -P /etc/kubernetes/manifests https://raw.githubusercontent.com/projectcalico/calico-cni/k8s-1.1-docs/samples/kubernetes/master/kubernetes-master.manifest - ``` - -4. Check the progress by running `docker ps`. After a while, you should see the `etcd`, `apiserver`, `controller-manager`, `scheduler`, and `kube-proxy` containers running. - - > Note: it may take some time for all the containers to start. Don't worry if `docker ps` doesn't show any containers for a while or if some containers start before others. - ### Install Calico's etcd on the master Calico needs its own etcd cluster to store its state. In this guide we install a single-node cluster on the master server. @@ -120,7 +85,7 @@ Calico needs its own etcd cluster to store its state. In this guide we install 2. Replace all instances of `` in the `calico-etcd.manifest` file with your master's IP address. -3. Then, move the file to the `/etc/kubernetes/manifests` directory: +3. Then, move the file to the `/etc/kubernetes/manifests` directory. This will not have any effect until we later run the kubelet, but Calico seems to tolerate the lack of its etcd in the interim. ```shell sudo mv -f calico-etcd.manifest /etc/kubernetes/manifests @@ -168,6 +133,42 @@ We need to install Calico on the master. This allows the master to route packet sudo systemctl start calico-node.service ``` +### Install Kubernetes on the Master + +We'll use the `kubelet` to bootstrap the Kubernetes master. + +1. Download and install the `kubelet` and `kubectl` binaries: + + ```shell + sudo wget -N -P /usr/bin http://storage.googleapis.com/kubernetes-release/release/v1.1.4/bin/linux/amd64/kubectl + sudo wget -N -P /usr/bin http://storage.googleapis.com/kubernetes-release/release/v1.1.4/bin/linux/amd64/kubelet + sudo chmod +x /usr/bin/kubelet /usr/bin/kubectl + ``` + +2. Install the `kubelet` systemd unit file and start the `kubelet`: + + ```shell + # Install the unit file + sudo wget -N -P /etc/systemd https://raw.githubusercontent.com/projectcalico/calico-cni/k8s-1.1-docs/samples/kubernetes/master/kubelet.service + + # Enable the unit file so that it runs on boot + sudo systemctl enable /etc/systemd/kubelet.service + + # Start the kubelet service + sudo systemctl start kubelet.service + ``` + +3. Download and install the master manifest file, which will start the Kubernetes master services automatically: + + ```shell + sudo mkdir -p /etc/kubernetes/manifests + sudo wget -N -P /etc/kubernetes/manifests https://raw.githubusercontent.com/projectcalico/calico-cni/k8s-1.1-docs/samples/kubernetes/master/kubernetes-master.manifest + ``` + +4. Check the progress by running `docker ps`. After a while, you should see the `etcd`, `apiserver`, `controller-manager`, `scheduler`, and `kube-proxy` containers running. + + > Note: it may take some time for all the containers to start. Don't worry if `docker ps` doesn't show any containers for a while or if some containers start before others. + ## Set up the nodes The following steps should be run on each Kubernetes node. @@ -175,7 +176,7 @@ The following steps should be run on each Kubernetes node. ### Configure TLS Worker nodes require three keys: `ca.pem`, `worker.pem`, and `worker-key.pem`. We've already generated -`ca.pem` for use on the Master. The worker public/private keypair should be generated for each Kubernetes node. +`ca.pem` and `ca-key.pem` for use on the Master. The worker public/private keypair should be generated for each Kubernetes node. 1. Create the file `worker-openssl.cnf` with the following contents. @@ -192,7 +193,7 @@ Worker nodes require three keys: `ca.pem`, `worker.pem`, and `worker-key.pem`. IP.1 = $ENV::WORKER_IP ``` -2. Generate the necessary TLS assets for this worker. This relies on the worker's IP address, and the `ca.pem` file generated earlier in the guide. +2. Generate the necessary TLS assets for this worker. This relies on the worker's IP address, and the `ca.pem` and `ca-key.pem` files generated earlier in the guide. ```shell # Export this worker's IP address. @@ -304,7 +305,7 @@ On your compute nodes, it is important that you install Calico before Kubernetes mkdir -p /etc/cni/net.d # Make the network configuration file - cat >/etc/rkt/net.d/10-calico.conf </etc/cni/net.d/10-calico.conf <= 1.7.4 of [Vagrant](http://www.vagrantup.com/downloads.html) -2. Install one of: - 1. The latest version of [Virtual Box](https://www.virtualbox.org/wiki/Downloads) - 2. [VMWare Fusion](https://www.vmware.com/products/fusion/) version 5 or greater as well as the appropriate [Vagrant VMWare Fusion provider](https://www.vagrantup.com/vmware) - 3. [VMWare Workstation](https://www.vmware.com/products/workstation/) version 9 or greater as well as the [Vagrant VMWare Workstation provider](https://www.vagrantup.com/vmware) - 4. [Parallels Desktop](https://www.parallels.com/products/desktop/) version 9 or greater as well as the [Vagrant Parallels provider](https://parallels.github.io/vagrant-parallels/) - 5. libvirt with KVM and enable support of hardware virtualisation. [Vagrant-libvirt](https://github.com/pradels/vagrant-libvirt). For fedora provided official rpm, and possible to use `yum install vagrant-libvirt` - -### Setup - -Setting up a cluster is as simple as running: - -```sh -export KUBERNETES_PROVIDER=vagrant -curl -sS https://get.k8s.io | bash -``` - -Alternatively, you can download [Kubernetes release](https://github.com/kubernetes/kubernetes/releases) and extract the archive. To start your local cluster, open a shell and run: - -```sh -cd kubernetes - -export KUBERNETES_PROVIDER=vagrant -./cluster/kube-up.sh -``` - -The `KUBERNETES_PROVIDER` environment variable tells all of the various cluster management scripts which variant to use. If you forget to set this, the assumption is you are running on Google Compute Engine. - -By default, the Vagrant setup will create a single master VM (called kubernetes-master) and one node (called kubernetes-node-1). Each VM will take 1 GB, so make sure you have at least 2GB to 4GB of free memory (plus appropriate free disk space). - -Vagrant will provision each machine in the cluster with all the necessary components to run Kubernetes. The initial setup can take a few minutes to complete on each machine. - -If you installed more than one Vagrant provider, Kubernetes will usually pick the appropriate one. However, you can override which one Kubernetes will use by setting the [`VAGRANT_DEFAULT_PROVIDER`](https://docs.vagrantup.com/v2/providers/default.html) environment variable: - -```sh -export VAGRANT_DEFAULT_PROVIDER=parallels -export KUBERNETES_PROVIDER=vagrant -./cluster/kube-up.sh -``` - -By default, each VM in the cluster is running Fedora. - -To access the master or any node: - -```sh -vagrant ssh master -vagrant ssh node-1 -``` - -If you are running more than one node, you can access the others by: - -```sh -vagrant ssh node-2 -vagrant ssh node-3 -``` - -Each node in the cluster installs the docker daemon and the kubelet. - -The master node instantiates the Kubernetes master components as pods on the machine. - -To view the service status and/or logs on the kubernetes-master: - -```console -[vagrant@kubernetes-master ~] $ vagrant ssh master -[vagrant@kubernetes-master ~] $ sudo su - -[root@kubernetes-master ~] $ systemctl status kubelet -[root@kubernetes-master ~] $ journalctl -ru kubelet - -[root@kubernetes-master ~] $ systemctl status docker -[root@kubernetes-master ~] $ journalctl -ru docker - -[root@kubernetes-master ~] $ tail -f /var/log/kube-apiserver.log -[root@kubernetes-master ~] $ tail -f /var/log/kube-controller-manager.log -[root@kubernetes-master ~] $ tail -f /var/log/kube-scheduler.log -``` - -To view the services on any of the nodes: - -```console -[vagrant@kubernetes-master ~] $ vagrant ssh node-1 -[vagrant@kubernetes-master ~] $ sudo su - -[root@kubernetes-master ~] $ systemctl status kubelet -[root@kubernetes-master ~] $ journalctl -ru kubelet - -[root@kubernetes-master ~] $ systemctl status docker -[root@kubernetes-master ~] $ journalctl -ru docker -``` - -### Interacting with your Kubernetes cluster with Vagrant. - -With your Kubernetes cluster up, you can manage the nodes in your cluster with the regular Vagrant commands. - -To push updates to new Kubernetes code after making source changes: - -```sh -./cluster/kube-push.sh -``` - -To stop and then restart the cluster: - -```sh -vagrant halt -./cluster/kube-up.sh -``` - -To destroy the cluster: - -```sh -vagrant destroy -``` - -Once your Vagrant machines are up and provisioned, the first thing to do is to check that you can use the `kubectl.sh` script. - -You may need to build the binaries first, you can do this with `make` - -```console -$ ./cluster/kubectl.sh get nodes - -NAME LABELS -10.245.1.4 -10.245.1.5 -10.245.1.3 -``` - -### Authenticating with your master - -When using the vagrant provider in Kubernetes, the `cluster/kubectl.sh` script will cache your credentials in a `~/.kubernetes_vagrant_auth` file so you will not be prompted for them in the future. - -```sh -cat ~/.kubernetes_vagrant_auth -``` - -```json -{ "User": "vagrant", - "Password": "vagrant", - "CAFile": "/home/k8s_user/.kubernetes.vagrant.ca.crt", - "CertFile": "/home/k8s_user/.kubecfg.vagrant.crt", - "KeyFile": "/home/k8s_user/.kubecfg.vagrant.key" -} -``` - -You should now be set to use the `cluster/kubectl.sh` script. For example try to list the nodes that you have started with: - -```sh -./cluster/kubectl.sh get nodes -``` - -### Running containers - -Your cluster is running, you can list the nodes in your cluster: - -```sh -$ ./cluster/kubectl.sh get nodes - -NAME LABELS -10.245.2.4 -10.245.2.3 -10.245.2.2 -``` - -Now start running some containers! - -You can now use any of the `cluster/kube-*.sh` commands to interact with your VM machines. -Before starting a container there will be no pods, services and replication controllers. - -```sh -$ ./cluster/kubectl.sh get pods -NAME READY STATUS RESTARTS AGE - -$ ./cluster/kubectl.sh get services -NAME CLUSTER_IP EXTERNAL_IP PORT(S) SELECTOR AGE - -$ ./cluster/kubectl.sh get replicationcontrollers -CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS -``` - -Start a container running nginx with a replication controller and three replicas - -```sh -$ ./cluster/kubectl.sh run my-nginx --image=nginx --replicas=3 --port=80 -``` - -When listing the pods, you will see that three containers have been started and are in Waiting state: - -```sh -$ ./cluster/kubectl.sh get pods -NAME READY STATUS RESTARTS AGE -my-nginx-5kq0g 0/1 Pending 0 10s -my-nginx-gr3hh 0/1 Pending 0 10s -my-nginx-xql4j 0/1 Pending 0 10s -``` - -You need to wait for the provisioning to complete, you can monitor the nodes by doing: - -```sh -$ vagrant ssh node-1 -c 'sudo docker images' -kubernetes-node-1: - REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE - 96864a7d2df3 26 hours ago 204.4 MB - google/cadvisor latest e0575e677c50 13 days ago 12.64 MB - kubernetes/pause latest 6c4579af347b 8 weeks ago 239.8 kB -``` - -Once the docker image for nginx has been downloaded, the container will start and you can list it: - -```sh -$ vagrant ssh node-1 -c 'sudo docker ps' -kubernetes-node-1: - CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES - dbe79bf6e25b nginx:latest "nginx" 21 seconds ago Up 19 seconds k8s--mynginx.8c5b8a3a--7813c8bd_-_3ffe_-_11e4_-_9036_-_0800279696e1.etcd--7813c8bd_-_3ffe_-_11e4_-_9036_-_0800279696e1--fcfa837f - fa0e29c94501 kubernetes/pause:latest "/pause" 8 minutes ago Up 8 minutes 0.0.0.0:8080->80/tcp k8s--net.a90e7ce4--7813c8bd_-_3ffe_-_11e4_-_9036_-_0800279696e1.etcd--7813c8bd_-_3ffe_-_11e4_-_9036_-_0800279696e1--baf5b21b - aa2ee3ed844a google/cadvisor:latest "/usr/bin/cadvisor" 38 minutes ago Up 38 minutes k8s--cadvisor.9e90d182--cadvisor_-_agent.file--4626b3a2 - 65a3a926f357 kubernetes/pause:latest "/pause" 39 minutes ago Up 39 minutes 0.0.0.0:4194->8080/tcp k8s--net.c5ba7f0e--cadvisor_-_agent.file--342fd561 -``` - -Going back to listing the pods, services and replicationcontrollers, you now have: - -```sh -$ ./cluster/kubectl.sh get pods -NAME READY STATUS RESTARTS AGE -my-nginx-5kq0g 1/1 Running 0 1m -my-nginx-gr3hh 1/1 Running 0 1m -my-nginx-xql4j 1/1 Running 0 1m - -$ ./cluster/kubectl.sh get services -NAME CLUSTER_IP EXTERNAL_IP PORT(S) SELECTOR AGE - -$ ./cluster/kubectl.sh get replicationcontrollers -CONTROLLER CONTAINER(S) IMAGE(S) SELECTOR REPLICAS AGE -my-nginx my-nginx nginx run=my-nginx 3 1m -``` - -We did not start any services, hence there are none listed. But we see three replicas displayed properly. -Learn about [running your first containers](../user-guide/simple-nginx/) application to learn how to create a service. -You can already play with scaling the replicas with: - -```sh -$ ./cluster/kubectl.sh scale rc my-nginx --replicas=2 -$ ./cluster/kubectl.sh get pods -NAME READY STATUS RESTARTS AGE -my-nginx-5kq0g 1/1 Running 0 2m -my-nginx-gr3hh 1/1 Running 0 2m -``` - -Congratulations! - -## Troubleshooting - -#### I keep downloading the same (large) box all the time! - -By default the Vagrantfile will download the box from S3. You can change this (and cache the box locally) by providing a name and an alternate URL when calling `kube-up.sh` - -```sh -export KUBERNETES_BOX_NAME=choose_your_own_name_for_your_kuber_box -export KUBERNETES_BOX_URL=path_of_your_kuber_box -export KUBERNETES_PROVIDER=vagrant -./cluster/kube-up.sh -``` - -#### I am getting timeouts when trying to curl the master from my host! - -During provision of the cluster, you may see the following message: - -```sh -Validating node-1 -............. -Waiting for each node to be registered with cloud provider -error: couldn't read version from server: Get https://10.245.1.2/api: dial tcp 10.245.1.2:443: i/o timeout -``` - -Some users have reported VPNs may prevent traffic from being routed to the host machine into the virtual machine network. - -To debug, first verify that the master is binding to the proper IP address: - -```sh -$ vagrant ssh master -$ ifconfig | grep eth1 -C 2 -eth1: flags=4163 mtu 1500 inet 10.245.1.2 netmask - 255.255.255.0 broadcast 10.245.1.255 -``` - -Then verify that your host machine has a network connection to a bridge that can serve that address: - -```sh -$ ifconfig | grep 10.245.1 -C 2 - -vboxnet5: flags=4163 mtu 1500 - inet 10.245.1.1 netmask 255.255.255.0 broadcast 10.245.1.255 - inet6 fe80::800:27ff:fe00:5 prefixlen 64 scopeid 0x20 - ether 0a:00:27:00:00:05 txqueuelen 1000 (Ethernet) -``` - -If you do not see a response on your host machine, you will most likely need to connect your host to the virtual network created by the virtualization provider. - -If you do see a network, but are still unable to ping the machine, check if your VPN is blocking the request. - -#### I just created the cluster, but I am getting authorization errors! - -You probably have an incorrect ~/.kubernetes_vagrant_auth file for the cluster you are attempting to contact. - -```sh -rm ~/.kubernetes_vagrant_auth -``` - -After using kubectl.sh make sure that the correct credentials are set: - -```sh -cat ~/.kubernetes_vagrant_auth -``` - -```json -{ - "User": "vagrant", - "Password": "vagrant" -} -``` - -#### I just created the cluster, but I do not see my container running! - -If this is your first time creating the cluster, the kubelet on each node schedules a number of docker pull requests to fetch prerequisite images. This can take some time and as a result may delay your initial pod getting provisioned. - -#### I have brought Vagrant up but the nodes cannot validate! - -Log on to one of the nodes (`vagrant ssh node-1`) and inspect the salt minion log (`sudo cat /var/log/salt/minion`). - -#### I want to change the number of nodes! - -You can control the number of nodes that are instantiated via the environment variable `NUM_NODES` on your host machine. If you plan to work with replicas, we strongly encourage you to work with enough nodes to satisfy your largest intended replica size. If you do not plan to work with replicas, you can save some system resources by running with a single node. You do this, by setting `NUM_NODES` to 1 like so: - -```sh -export NUM_NODES=1 -``` - -#### I want my VMs to have more memory! - -You can control the memory allotted to virtual machines with the `KUBERNETES_MEMORY` environment variable. -Just set it to the number of megabytes you would like the machines to have. For example: - -```sh -export KUBERNETES_MEMORY=2048 -``` - -If you need more granular control, you can set the amount of memory for the master and nodes independently. For example: - -```sh -export KUBERNETES_MASTER_MEMORY=1536 -export KUBERNETES_NODE_MEMORY=2048 -``` - -#### I ran vagrant suspend and nothing works! - -`vagrant suspend` seems to mess up the network. This is not supported at this time. - -#### I want vagrant to sync folders via nfs! - -You can ensure that vagrant uses nfs to sync folders with virtual machines by setting the KUBERNETES_VAGRANT_USE_NFS environment variable to 'true'. nfs is faster than virtualbox or vmware's 'shared folders' and does not require guest additions. See the [vagrant docs](http://docs.vagrantup.com/v2/synced-folders/nfs.html) for details on configuring nfs on the host. This setting will have no effect on the libvirt provider, which uses nfs by default. For example: - -```sh -export KUBERNETES_VAGRANT_USE_NFS=true -``` diff --git a/docs/getting-started-guides/vsphere.md b/docs/getting-started-guides/vsphere.md index 3c68891b1f..adab2b9027 100644 --- a/docs/getting-started-guides/vsphere.md +++ b/docs/getting-started-guides/vsphere.md @@ -1,4 +1,8 @@ --- +assignees: +- erictune +- jbeda + --- The example below creates a Kubernetes cluster with 4 worker node Virtual @@ -11,7 +15,7 @@ convenient). ### Prerequisites -1. You need administrator credentials to an ESXi machine or vCenter instance. +1. You need administrator credentials to an ESXi machine or vCenter instance with write mode api access enabled (not available on the free ESXi license). 2. You must have Go (see [here](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/development.md#go-versions) for supported versions) installed: [www.golang.org](http://www.golang.org). 3. You must have your `GOPATH` set up and include `$GOPATH/bin` in your `PATH`. @@ -49,6 +53,7 @@ export GOVC_NETWORK='Network Name' # Name of the network the vms should join. Ma export GOVC_INSECURE=1 # If the host above uses a self-signed cert export GOVC_DATASTORE='target datastore' export GOVC_RESOURCE_POOL='resource pool or cluster with access to datastore' +export GOVC_GUEST_LOGIN='kube:kube' # Used for logging into kube.vmdk during deployment. govc import.vmdk kube.vmdk ./kube/ ``` @@ -58,9 +63,14 @@ Verify that the VMDK was correctly uploaded and expanded to ~3GiB: ```shell govc datastore.ls ./kube/ ``` +If you need to debug any part of the deployment, the guest login for +the image that you imported is `kube:kube`. It is normally specified +in the GOVC_GUEST_LOGIN parameter above. -Take a look at the file `cluster/vsphere/config-common.sh` fill in the required -parameters. The guest login for the image that you imported is `kube:kube`. +Also take a look at the file `cluster/vsphere/config-default.sh` and +make any needed changes. You can configure the number of nodes +as well as the IP subnets you have made available to Kubernetes, pods, +and services. ### Starting a cluster @@ -100,7 +110,7 @@ going on (find yourself authorized with your SSH key, or use the password IaaS Provider | Config. Mgmt | OS | Networking | Docs | Conforms | Support Level -------------------- | ------------ | ------ | ---------- | --------------------------------------------- | ---------| ---------------------------- -Vmware | | Debian | OVS | [docs](/docs/getting-started-guides/vsphere) | | Community ([@pietern](https://github.com/pietern)) +Vmware vSphere | Saltstack | Debian | OVS | [docs](/docs/getting-started-guides/vsphere) | | Community ([@imkin](https://github.com/imkin)) For support level information on all solutions, see the [Table of solutions](/docs/getting-started-guides/#table-of-solutions) chart. diff --git a/docs/hellonode.md b/docs/hellonode.md index 702601687e..2283599fb7 100755 --- a/docs/hellonode.md +++ b/docs/hellonode.md @@ -1,4 +1,8 @@ --- +assignees: +- dchen1107 +- pwittrock + --- * TOC @@ -22,13 +26,21 @@ If you don't already have a Google Account (Gmail or Google Apps), you must [cre ![image](/images/hellonode/image_3.png) -Remember the project ID; it will be referred to later in this codelab as `PROJECT_ID`. +Remember the project ID; it will be referred to later in this codelab as `$PROJECT_ID`. -Next, [enable billing](https://console.developers.google.com/billing) in the Developers Console in order to use Google Cloud resources and [enable the Container Engine API](https://console.developers.google.com/project/_/kubernetes/list). +Make sure you have a Linux terminal available, you will use it to control your cluster via command line. You can use [Google Cloud Shell](https://console.cloud.google.com?cloudshell=true), it has the software this codelab uses pre-installed so that you can skip most of the environment configuration steps below. -New users of Google Cloud Platform receive a [$300 free trial](https://console.developers.google.com/billing/freetrial?hl=en). Running through this codelab shouldn’t cost you more than a few dollars of that trial. Google Container Engine pricing is documented [here](https://cloud.google.com/container-engine/pricing). +It may be helpful to store your project ID into a variable as many commands below use it: -Next, make sure you [download Node.js](https://nodejs.org/en/download/). +```shell +export PROJECT_ID="your-project-id" +``` + +Next, [enable billing](https://console.cloud.google.com/billing) in the Cloud Console in order to use Google Cloud resources and [enable the Container Engine API](https://console.cloud.google.com/project/_/kubernetes/list). + +New users of Google Cloud Platform receive a [$300 free trial](https://console.cloud.google.com/billing/freetrial?hl=en). Running through this codelab shouldn’t cost you more than a few dollars of that trial. Google Container Engine pricing is documented [here](https://cloud.google.com/container-engine/pricing). + +Next, make sure you [download Node.js](https://nodejs.org/en/download/). You can skip this and the steps for installing Docker and Cloud SDK if you're using Cloud Shell. Then install [Docker](https://docs.docker.com/engine/installation/), and [Google Cloud SDK](https://cloud.google.com/sdk/). @@ -49,20 +61,21 @@ The first step is to write the application. Save this code in a folder called "` ```javascript var http = require('http'); var handleRequest = function(request, response) { + console.log('Received request for URL: ' + request.url); response.writeHead(200); - response.end("Hello World!"); -} + response.end('Hello World!'); +}; var www = http.createServer(handleRequest); www.listen(8080); ``` -Now run this simple command : +Now run this simple command: ```shell node server.js ``` -You should be able to see your "Hello World!" message at http://localhost:8080/ +You should be able to see your "Hello World!" message at http://localhost:8080/. If using Cloud Shell, use [Web Preview](https://cloud.google.com/shell/docs/using-web-preview) to view the URL. Stop the running node server by pressing Ctrl-C. @@ -83,94 +96,125 @@ CMD node server.js This "recipe" for the Docker image will start from the official Node.js LTS image found on the Docker registry, expose port 8080, copy our `server.js` file to the image and start the Node server. -Now build an image of your container by running `docker build`, tagging the image with the Google Container Registry repo for your `PROJECT_ID`: +Now build an image of your container by running `docker build`, tagging the image with the Google Container Registry repo for your `$PROJECT_ID`: ```shell -docker build -t gcr.io/PROJECT_ID/hello-node:v1 . +docker build -t gcr.io/$PROJECT_ID/hello-node:v1 . ``` Now there is a trusted source for getting an image of your containerized app. Let's try your image out with Docker: ```shell -$ docker run -d -p 8080:8080 gcr.io/PROJECT_ID/hello-node:v1 -325301e6b2bffd1d0049c621866831316d653c0b25a496d04ce0ec6854cb7998 +docker run -d -p 8080:8080 --name hello_tutorial gcr.io/$PROJECT_ID/hello-node:v1 ``` Visit your app in the browser, or use `curl` or `wget` if you’d like : ```shell -$ curl http://localhost:8080 -Hello World! +curl http://localhost:8080 ``` -Let’s now stop the container. In this example, our app was running as Docker process `2c66d0efcbd4`, which we looked up with `docker ps`: +You should see `Hello World!` + +**Note:** *If you recieve a `Connection refused` message from Docker for Mac, ensure you are using the latest version of Docker (1.12 or later). Alternatively, if you are using Docker Toolbox on OSX, make sure you are using the VM's IP and not localhost:* + +```shell +curl "http://$(docker-machine ip YOUR-VM-MACHINE-NAME):8080" +``` + +Let’s now stop the container. You can list the docker containers with: ```shell docker ps -CONTAINER ID IMAGE COMMAND -2c66d0efcbd4 gcr.io/PROJECT_ID/hello-node:v1 "/bin/sh -c 'node - -docker stop 2c66d0efcbd4 -2c66d0efcbd4 ``` -Now that the image works as intended and is all tagged with your `PROJECT_ID`, we can push it to the [Google Container Registry](https://cloud.google.com/tools/container-registry/), a private repository for your Docker images accessible from every Google Cloud project (but also from outside Google Cloud Platform) : +You should something like see: ```shell -gcloud docker push gcr.io/PROJECT_ID/hello-node:v1 +CONTAINER ID IMAGE COMMAND NAMES +c5b6d4b9f36d gcr.io/$PROJECT_ID/hello-node:v1 "/bin/sh -c 'node ser" hello_tutorial +``` + +Now stop the running container with + +``` +docker stop hello_tutorial +``` + +Now that the image works as intended and is all tagged with your `$PROJECT_ID`, we can push it to the [Google Container Registry](https://cloud.google.com/tools/container-registry/), a private repository for your Docker images accessible from every Google Cloud project (but also from outside Google Cloud Platform) : + +```shell +gcloud docker push gcr.io/$PROJECT_ID/hello-node:v1 ``` If all goes well, you should be able to see the container image listed in the console: *Compute > Container Engine > Container Registry*. We now have a project-wide Docker image available which Kubernetes can access and orchestrate. ![image](/images/hellonode/image_10.png) -## Create your cluster +## Create your Kubernetes Cluster -A cluster consists of a master API server and a set of worker VMs called nodes. +A cluster consists of a Master API server and a set of worker VMs called Nodes. -Create a cluster via the Console: *Compute > Container Engine > Container Clusters > New container cluster*. Set the name to 'hello-world', leaving all other options default. You should get a Kubernetes cluster with three nodes, ready to receive your container image. +First, choose a [Google Cloud Project zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) to run +your service. For this tutorial, we will be using **us-central1-a**. This is +configured on the command line via: + +``` +gcloud config set compute/zone us-central1-a +``` + +Now, create a cluster via the `gcloud` command line tool: + +```shell +gcloud container clusters create hello-world +``` + +Alternatively, you can create a cluster via the [Google Cloud Console](https://console.cloud.google.com): *Compute > Container Engine > Container Clusters > New container cluster*. Set the name to **hello-world**, leaving all other options default. + +You should get a Kubernetes cluster with three nodes, ready to receive your container image! (this may take a couple of minutes) ![image](/images/hellonode/image_11.png) -It’s now time to deploy your own containerized application to the Kubernetes cluster! Please ensure that you have [configured](https://cloud.google.com/container-engine/docs/clusters/operations#configuring_kubectl) `kubectl` to use the cluster you just created: +It’s now time to deploy your own containerized application to the Kubernetes cluster! ```shell -$ gcloud container clusters get-credentials hello-world +gcloud container clusters get-credentials hello-world ``` -**The rest of this document requires both the kubernetes client and server version to be 1.2. Run `kubectl version` to see your current versions.** For 1.1 see [this document](https://github.com/kubernetes/kubernetes.github.io/blob/release-1.1/docs/hellonode.md). +**The rest of this document requires both the Kubernetes client and server version to be 1.3. Run `kubectl version` to see your current versions.** For 1.2 see [this document](https://github.com/kubernetes/kubernetes.github.io/blob/release-1.2/docs/hellonode.md). ## Create your pod -A kubernetes **[pod](/docs/user-guide/pods/)** is a group of containers, tied together for the purposes of administration and networking. It can contain a single container or multiple. +A Kubernetes **[pod](/docs/user-guide/pods/)** is a group of containers, tied together for the purposes of administration and networking. It can contain a single container or multiple. -Create a pod with the `kubectl run` command: +Create a Pod with the `kubectl run` command: ```shell -$ kubectl run hello-node --image=gcr.io/PROJECT_ID/hello-node:v1 --port=8080 -deployment "hello-node" created +kubectl run hello-node --image=gcr.io/$PROJECT_ID/hello-node:v1 --port=8080 ``` -As shown in the output, the `kubectl run` created a **[deployment](/docs/user-guide/deployments/)** object. Deployments are the recommended way for managing creation and scaling of pods. In this example, a new deployment manages a single pod replica running the *hello-node:v1* image. +As shown in the output, the `kubectl run` created a **[Deployment](/docs/user-guide/deployments/)** object. Deployments are the recommended way for managing creation and scaling of pods. In this example, a new deployment manages a single pod replica running the *hello-node:v1* image. -To view the deployment we just created run: +To view the Deployment we just created run: ```shell -$ kubectl get deployments +kubectl get deployments + NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE hello-node 1 1 1 1 3m ``` -To view the pod created by the deployment run: +To view the Pod created by the deployment run: ```shell -$ kubectl get pods +kubectl get pods + NAME READY STATUS RESTARTS AGE hello-node-714049816-ztzrb 1/1 Running 0 6m ``` -To view the stdout / stderr from a pod (hello-node image has no output, so logs will be empty in this case) run: +To view the stdout / stderr from a Pod run (probably empty currently): ```shell kubectl logs @@ -200,15 +244,15 @@ At this point you should have our container running under the control of Kuberne ## Allow external traffic -By default, the pod is only accessible by its internal IP within the Kubernetes cluster. In order to make the `hello-node` container accessible from outside the kubernetes virtual network, you have to expose the pod as a kubernetes **[service](/docs/user-guide/services/)**. +By default, the pod is only accessible by its internal IP within the Kubernetes cluster. In order to make the `hello-node` container accessible from outside the Kubernetes virtual network, you have to expose the Pod as a Kubernetes **[Service](/docs/user-guide/services/)**. -From our development machine we can expose the pod to the public internet using the `kubectl expose` command combined with the `--type="LoadBalancer"` flag. The flag is needed for the creation of an externally accessible ip: +From our Development machine we can expose the pod to the public internet using the `kubectl expose` command combined with the `--type="LoadBalancer"` flag. The flag is needed for the creation of an externally accessible ip: ```shell kubectl expose deployment hello-node --type="LoadBalancer" ``` -**If this fails, make sure your client and server are both version 1.2. See the [Create your cluster](#create-your-cluster) section for details.** +**If this fails, make sure your client and server are both version 1.3. See the [Create your cluster](#create-your-cluster) section for details.** The flag used in this command specifies that we’ll be using the load-balancer provided by the underlying infrastructure (in this case the [Compute Engine load balancer](https://cloud.google.com/compute/docs/load-balancing/)). Note that we expose the deployment, and not the pod directly. This will cause the resulting service to load balance traffic across all pods managed by the deployment (in this case only 1 pod, but we will add more replicas later). @@ -217,25 +261,34 @@ The Kubernetes master creates the load balancer and related Compute Engine forwa To find the ip addresses associated with the service run: ```shell -$ kubectl get services hello-node -NAME CLUSTER_IP EXTERNAL_IP PORT(S) SELECTOR AGE -hello-node 10.3.246.12 8080/TCP run=hello-node 23s +kubectl get services hello-node + +NAME CLUSTER_IP EXTERNAL_IP PORT(S) AGE +hello-node 10.3.246.12 8080/TCP 23s ``` The `EXTERNAL_IP` may take several minutes to become available and visible. If the `EXTERNAL_IP` is missing, wait a few minutes and try again. ```shell -$ kubectl get services hello-node -NAME CLUSTER_IP EXTERNAL_IP PORT(S) SELECTOR AGE -hello-node 10.3.246.12 23.251.159.72 8080/TCP run=hello-node 2m +kubectl get services hello-node + +NAME CLUSTER_IP EXTERNAL_IP PORT(S) AGE +hello-node 10.3.246.12 23.251.159.72 8080/TCP 2m ``` Note there are 2 IP addresses listed, both serving port 8080. `CLUSTER_IP` is only visible inside your cloud virtual network. `EXTERNAL_IP` is externally accessible. In this example, the external IP address is 23.251.159.72. -You should now be able to reach the service by pointing your browser to this address: http://EXTERNAL_IP**:8080** or running `curl http://EXTERNAL_IP:8080` +You should now be able to reach the service by pointing your browser to this address: http://EXTERNAL_IP**:8080** or running `curl http://EXTERNAL_IP:8080`. ![image](/images/hellonode/image_12.png) +Assuming you've sent requests to your new webservice via the browser or curl, +you should now be able to see some logs by running: + +```shell +kubectl logs +``` + ## Scale up your website One of the powerful features offered by Kubernetes is how easy it is to scale your application. Suppose you suddenly need more capacity for your application; you can simply tell the deployment to manage a new number of replicas for your pod: @@ -247,13 +300,15 @@ kubectl scale deployment hello-node --replicas=4 You now have four replicas of your application, each running independently on the cluster with the load balancer you created earlier and serving traffic to all of them. ```shell -$ kubectl get deployment +kubectl get deployment + NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE hello-node 4 4 4 3 40m ``` ```shell -$ kubectl get pods +kubectl get pods + NAME READY STATUS RESTARTS AGE hello-node-714049816-g4azy 1/1 Running 0 1m hello-node-714049816-rk0u6 1/1 Running 0 1m @@ -274,90 +329,31 @@ As always, the application you deployed to production requires bug fixes or addi First, let’s modify the application. On the development machine, edit server.js and update the response message: ```javascript - response.end("Hello Kubernetes World!"); + response.end('Hello Kubernetes World!'); ``` - We can now build and publish a new container image to the registry with an incremented tag: ```shell -docker build -t gcr.io/PROJECT_ID/hello-node:v2 . -gcloud docker push gcr.io/PROJECT_ID/hello-node:v2 +docker build -t gcr.io/$PROJECT_ID/hello-node:v2 . +gcloud docker push gcr.io/$PROJECT_ID/hello-node:v2 ``` Building and pushing this updated image should be much quicker as we take full advantage of the Docker cache. -We’re now ready for kubernetes to smoothly update our deployment to the new version of the application. In order to change +We’re now ready for Kubernetes to smoothly update our deployment to the new version of the application. In order to change the image label for our running container, we will need to edit the existing *hello-node deployment* and change the image from -`gcr.io/PROJECT_ID/hello-node:v1` to `gcr.io/PROJECT_ID/hello-node:v2`. To do this, we will use the `kubectl edit` command. -This will open up a text editor displaying the full deployment yaml configuration. It isn't necessary to understand the full yaml config -right now, instead just understand that by updating the `spec.template.spec.containers.image` field in the config we are telling -the deployment to update the pods to use the new image. +`gcr.io/$PROJECT_ID/hello-node:v1` to `gcr.io/$PROJECT_ID/hello-node:v2`. To do this, we will use the `kubectl set image` command. ```shell -kubectl edit deployment hello-node -``` - -```yaml -# Please edit the object below. Lines beginning with a '#' will be ignored, -# and an empty file will abort the edit. If an error occurs while saving this file will be -# reopened with the relevant failures. -# -apiVersion: extensions/v1beta1 -kind: Deployment -metadata: - annotations: - deployment.kubernetes.io/revision: "1" - creationTimestamp: 2016-03-24T17:55:28Z - generation: 3 - labels: - run: hello-node - name: hello-node - namespace: default - resourceVersion: "151017" - selfLink: /apis/extensions/v1beta1/namespaces/default/deployments/hello-node - uid: 981fe302-f1e9-11e5-9a78-42010af00005 -spec: - replicas: 4 - selector: - matchLabels: - run: hello-node - strategy: - rollingUpdate: - maxSurge: 1 - maxUnavailable: 1 - type: RollingUpdate - template: - metadata: - creationTimestamp: null - labels: - run: hello-node - spec: - containers: - - image: gcr.io/PROJECT_ID/hello-node:v1 # Update this line - imagePullPolicy: IfNotPresent - name: hello-node - ports: - - containerPort: 8080 - protocol: TCP - resources: {} - terminationMessagePath: /dev/termination-log - dnsPolicy: ClusterFirst - restartPolicy: Always - securityContext: {} - terminationGracePeriodSeconds: 30 -``` - -After making the change save and close the file. - -``` -deployment "hello-node" edited +kubectl set image deployment/hello-node hello-node=gcr.io/$PROJECT_ID/hello-node:v2 ``` This updates the deployment with the new image, causing new pods to be created with the new image and old pods to be deleted. ``` -$ kubectl get deployments +kubectl get deployments + NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE hello-node 4 5 4 3 1h ``` @@ -368,16 +364,17 @@ Hopefully with these deployment, scaling and update features you’ll agree that ## Observe the Kubernetes Web UI (optional) -With Kubernetes 1.2, a graphical web user interface (dashboard) has been introduced. It is enabled by default for 1.2 clusters. +Kubernetes comes with a graphical web user interface that is enabled by default with your clusters. + This user interface allows you to get started quickly and enables some of the functionality found in the CLI as a more approachable and discoverable way of interacting with the system. Enjoy the Kubernetes graphical dashboard and use it for deploying containerized applications, as well as for monitoring and managing your clusters! -![image](/images/docs/ui-dashboard-cards-menu.png) +![image](/images/docs/ui-dashboard-workloadview.png) Learn more about the web interface by taking the [Dashboard tour](/docs/user-guide/ui/). -## That's it! Time to tear it down +## Cleaning it Up That's it for the demo! So you don't leave this all running and incur charges, let's learn how to tear things down. @@ -390,24 +387,43 @@ kubectl delete service,deployment hello-node Delete your cluster: ```shell -$ gcloud container clusters delete hello-world -Waiting for cluster deletion...done. -name: operation-xxxxxxxxxxxxxxxx -operationType: deleteCluster -status: done -target: /projects/kubernetes-codelab/zones/us-central1-f/clusters/hello-world -zone: us-central1-f +gcloud container clusters delete hello-world +``` + +You should see: + +``` +The following clusters will be deleted. + - [hello-world] in [us-central1-a] + +Do you want to continue (Y/n)? + +Deleting cluster hello-world...done. +Deleted [https://container.googleapis.com/v1/projects/<$PROJECT_ID>/zones/us-central1-a/clusters/hello-world]. ``` This deletes the Google Compute Engine instances that are running the cluster. -Finally delete the Docker registry storage bucket hosting your image(s) : +Finally delete the Docker registry storage bucket hosting your image(s) by using +`gsutil`, which should have been installed during the gcloud installation +process. For more information on gsutil, see [the gsutil documentation](https://cloud.google.com/storage/docs/gsutil) + +To list the images we created earlier in the tutorial: ```shell -$ gsutil ls -gs://artifacts..appspot.com/ -$ gsutil rm -r gs://artifacts..appspot.com/ -Removing gs://artifacts..appspot.com/... +gsutil ls ``` -Of course, you can also delete the entire project but note that you must first disable billing on the project. Additionally, deleting a project will only happen after the current billing cycle ends. +You should see: + +```shell +gs://artifacts.<$PROJECT_ID>.appspot.com/ +``` + +And then to remove the all the images under this path, run: + +```shell +gsutil rm -r gs://artifacts.<$PROJECT_ID>.appspot.com/ +``` + +You can also delete the entire Google Cloud project but note that you must first disable billing on the project. Additionally, deleting a project will only happen after the current billing cycle ends. diff --git a/docs/index.md b/docs/index.md index da6febb315..fb40b3fa5f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,8 @@ --- +assignees: +- bgrant0607 +- thockin + --- + +Click tags or use the drop downs to filter. Click table headers to sort or reverse sort. + +

    +Filter by Concept:
    +Filter by Object:
    +Filter by Command: +

    + +
    diff --git a/docs/templatedemos/OWNERS b/docs/templatedemos/OWNERS new file mode 100644 index 0000000000..d46d07a62e --- /dev/null +++ b/docs/templatedemos/OWNERS @@ -0,0 +1,3 @@ +assignees: +- pwittrock + diff --git a/docs/templatedemos/blankkubectl.md b/docs/templatedemos/blankkubectl.md new file mode 100644 index 0000000000..d88e330208 --- /dev/null +++ b/docs/templatedemos/blankkubectl.md @@ -0,0 +1,6 @@ +--- +assignees: +- bgrant0607 + +--- +{% include templates/kubectl.md %} \ No newline at end of file diff --git a/docs/templatedemos/blanktask.md b/docs/templatedemos/blanktask.md new file mode 100644 index 0000000000..026c1afc41 --- /dev/null +++ b/docs/templatedemos/blanktask.md @@ -0,0 +1,3 @@ +--- +--- +{% include templates/task.md %} \ No newline at end of file diff --git a/docs/templatedemos/filledout.md b/docs/templatedemos/filledout.md index 7eef09134e..ba56528a20 100644 --- a/docs/templatedemos/filledout.md +++ b/docs/templatedemos/filledout.md @@ -1,32 +1,80 @@ --- --- - -{% assign concept="Replication Controller" %} +{% assign concept="Pod" %} {% capture what_is %} -A Replication Controller does x and y and z...(etc, etc, text goes on) +A pod is the vehicle for running containers in Kubernetes. A pod consists of: + +- One or more containers +- An IP address that is unique within the cluster +- Optionally: Environment variables, storage volumes, and enterprise features (such as health checking) + +Resources are shared amongst containers in the pod. Containers within a pod also share an IP address and port space, and can find each other via localhost, or interprocess communications (such as semaphores). + +![Pod diagram](/images/docs/pod-overview.svg){: style="max-width: 25%" } +{% comment %}https://drive.google.com/open?id=1pQe4-s76fqyrzB8f3xoJo4MPLNVoBlsE1tT9MyLNINg{% endcomment %} + {% endcapture %} {% capture when_to_use %} -You should use Replication Controller when... +Pods are used any time you need a container to be run. However, they are rarely created by a user, and are instead automatically created by controllers such as jobs, replication controllers, deployments, daemon set. The following table describes the strategy each controller uses to create pods. + + +| Controller | Usage Strategy | +|------------|----------------| +| Deployment | For running pods as a continuous and healthy application | +| Replication Controller | Used for the same purpose as Deployments (superseded Replication Controllers) | +| Jobs | For running pods "to completion" (which are then shut down) | +| Daemon Set | Mainly for performing operations on any nodes that match given parameters | + {% endcapture %} {% capture when_not_to_use %} -You should not use Replication Controller if... +Do not use pods directly. Pods should always be managed by a controller. {% endcapture %} {% capture status %} -The current status of Replication Controllers is... +To retrieve the status of a pod, run the following command: + +```shell +kubectl get pod +``` + +| Return Value | Description | +|--------------|-------------| +| `READY` | Describes the number of containers that are ready to recieve traffic. | +| `STATUS` | A value from the `PodPhase` enum describing the current status of the pod. Can be `Running`, `Pending`, `Succeeded`, `Failed`, and `Unknown`. | + +TODO: Link to refpage for `kubectl get pod` + + +To get a full description of a pod, including past events, run the following command: + +```shell +kubectl describe pod +``` + +TODO: Link to refpage for `kubectl describe pod` + +#### Possible status results + +| Value | Description | +|------------|----------------| +| Deployment | For running pods as a continuous and healthy application | +| Replication Controller | Used for the same purpose as Deployments (superseded Replication Controllers) | +| Jobs | For running pods "to completion" (which are then shut down) | +| Daemon Set | Mainly for performing operations on any nodes that match given parameters | + {% endcapture %} -{% capture required_fields %} -* `kind`: Always `Pod`. -* `apiVersion`: Currently `v1`. -* `metadata`: An object containing: - * `name`: Required if `generateName` is not specified. The name of this pod. - It must be an - [RFC1035](https://www.ietf.org/rfc/rfc1035.txt) compatible value and be - unique within the namespace. +{% capture usage %} +Pods are defined when configuring the controller of your choice. In controller specifications, +the parts that define the contents of the pod are inside the `template:` section. + +```yaml +YAML EXAMPLE HERE +``` + {% endcapture %} {% include templates/concept-overview.md %} \ No newline at end of file diff --git a/docs/templatedemos/index.md b/docs/templatedemos/index.md index d199e6d074..ad58731bd7 100644 --- a/docs/templatedemos/index.md +++ b/docs/templatedemos/index.md @@ -1,19 +1,249 @@ --- +assignees: +- pwittrock + --- -# Template Demos +* TOC +{:toc} -This page demonstrates new doc templates being worked on. +## Before you Begin: Get the docs code checked out locally -Click the headings to see the source of the template in GitHub. +Check out the kubernetes/kubernetes.github.io repo and the docsv2 branch. -## [Concept Overviews](https://github.com/kubernetes/kubernetes.github.io/blob/master/_includes/templates/concept-overview.md) +### Step 1: Fork and Clone the repo -- [Blank page that is trying to use template](blank/) -- [Partially filled out page](partial/) -- [Completely filled out page](filledout/) +- Fork [kubernetes/kubernetes.github.io](https://github.com/kubernetes/kubernetes.github.io) +- [Setup your GitHub authentication using ssh](https://help.github.com/articles/generating-an-ssh-key/) +- Clone the repo under ~/go/src/k8s.io -## [Landing Pages](https://github.com/kubernetes/kubernetes.github.io/blob/master/_includes/templates/landing-page.md) +```shell +cd ~/go/src/k8s.io +git clone git@github.com:/kubernetes.github.io +cd kubernetes.github.io +git remote add upstream https://github.com/kubernetes/kubernetes.github.io.git +``` -- [Blank](blanklanding/) -- [Filled Out](landingpage/) \ No newline at end of file +### Step 2: Switch to the docsv2 branch + +Docs v2 development is being performed in the `docsv2` branch. This is the branch +you want to be working from. + +From ~/go/src/k8s.io/kubernetes.github.io: + +```shell +git checkout -b docsv2 +git fetch upstream +git reset --hard upstream/docsv2 +``` + +### Step 3: Make sure you can serve rendered docs + +One option is to simply rename your fork's repo on GitHub.com to `yourusername.github.io`, which will auto-stage your commits at that URL. + +Or, just use Docker! Run this from within your local `kubernetes.github.io` directory and you should be good: + +```shell +docker run -ti --rm -v "$PWD":/k8sdocs -p 4000:4000 johndmulhausen/k8sdocs +``` + +The site will then be viewable at [http://localhost:4000/](http://localhost:4000/). + +Or, you can [follow the instructions](/editdocs/) for running a from-scratch staging server, which is both the most performant option and the biggest pain to get set up. + +## Writing Docs Using Templates + +### Types of Templates + +- Concept Template + - Introduce K8s Api Objects e.g. Pod +- Task Template + - Step-by-step guide for "Doing X". + - Useful for breaking down various ways of configuring Concepts into sub-topics +- Landing Pages Template + - Collection of click-able cards on a grid + - Useful for directing users to actual content from a visual Table of Contents + +## Concept Overview Template Details + +A concept overview covers the most essential, important information about core +Kubernetes concepts and features. Examples of Concepts include `Pod`, +`Deployment`, `Service`, etc. + +### Reference Examples + +- [Link to Example Template: Source](https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/docsv2/docs/pod/index.md) +- [Link to Example Template: Rendered](http://k8sdocs.github.io/docs/pod/) + +### Usage + +### Creating the file + +To create a new concept overview page, create a new directory with the concept +name under the docs directory and an index.md file. +e.g. `docs/your-concept-name/index.md`. + +### Adding the page to navigation + +Once your page is saved, somewhere in the `/docs/` directory, add a reference to the `concepts.yml` file under `/_data/` so that it will appear in the left-hand navigation of the site. This is also where you add a title to the page. + +### Adding the Template sections + +- concept: the concept name e.g. Pod +- what_is: one sentence description the function / role of the concept. Diagrams are helpful. +- when_to_use: disambiguate when to use this vs alternatives +- when_not_to_use: highlight common anti-patterns +- status: how to get the status for this object using kubectl +- usage: example yaml +- template: include the template at the end + +### Tags structure + +- `glossary:` a brief (~140 character) definition of what this concept is. +- `object_rankings:` associates the page with API objects/functions. +- `concept_rankings:` associates the page with Kubernetes concepts. +- `command_rankings:` associates the page with CLI commands + +In each case, the association is ranked. If ranked "1," the topic will surface as a "Core Topic" (of high importance) on various associated pages. If ranked "2," the topic will be grouped under "Advanced Topics," which are deemed less essential. + +Only ranks 1 and 2 are supported. + +Tags are mandatory and should be thorough; they are the connective tissue of the site. To see them in action, [visit our sitemap](http://k8sdocs.github.io/docs/sitemap/). + + +```liquid{% raw %} +--- +glossary: A pod is the vehicle for running containers in Kubernetes. +object_rankings: +- object: pod + rank: 1 +concept_rankings: +- concept: pod + rank: 1 +command_rankings: +- command: kubect describe + rank: 1 +- command: kubectl get + rank: 1 +--- +{% capture concept %} concept-name-here {% endcapture %} +{% capture what_is %} description-of-concept-here {% endcapture %} +{% capture when_to_use %} when-to-use-here {% endcapture %} +{% capture when_not_to_use %} anti-patterns-here {% endcapture %} +{% capture status %} how-to-get-with-kubectl-here {% endcapture %} +{% capture usage %} yaml-config-usage-here {% endcapture %} +{% include templates/concept-overview.md %} +{% endraw %}``` + + +## Task Template Details + +A task page offers step-by-step instructions for completing a task with Kubernetes. **A task page should be narrowly focused on task completion and not delve into concepts or reference information.** + +### Example + +- [Link to Example Template: Source](https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/docsv2/docs/tasks/explicitly-scheduling-pod-node.md) +- [Link to Example Template: Rendered](http://k8sdocs.github.io/docs/tasks/explicitly-scheduling-pod-node/) + +### Usage + +### Creating the file + +To create a new task page, create a file under docs/tasks/task-name. +e.g. `docs/tasks/your-task-name`. + +Task filenames should match the title, chaining words with dashes in all lowercase, omitting articles and prepositions. For example, the topic "Explictly Scheduling a Pod on a Node" is stored in file `/docs/tasks/explicitly-scheduling-pod-node.md`. + +### Adding the page to navigation + +Add a reference to the `tasks.yml` file under `/_data/` so that it will appear in the left-hand navigation of the site. This is also where you add a title to the page. + +### Adding the Template sections + +- metadata: structured description of the doc content +- purpose: one sentence description of the task and motivation +- recommended_background: List of Concepts referenced or other Tasks, Tutorials that provide needed context +- set_by_step: Add multiple sections. 1 per step in the task. +- template: include the template at the end + +### Tags structure + +- `object_rankings:` associates the page with API objects/functions. +- `concept_rankings:` associates the page with Kubernetes concepts. +- `command_rankings:` associates the page with CLI commands + +In each case, the association is ranked. If ranked "1," the topic will surface as a "Core Topic" (of high importance) on various associated pages. If ranked "2," the topic will be grouped under "Advanced Topics," which are deemed less essential. + +Only ranks 1 and 2 are supported. + +Tags are mandatory and should be thorough; they are the connective tissue of the site. To see them in action, [visit our sitemap](http://k8sdocs.github.io/docs/sitemap/). + + +```liquid{% raw %} +--- +object_rankings: +- object: nodeAffinity + rank: 1 +- object: nodeSelector + rank: 2 +concept_rankings: +- concept: node + rank: 1 +- concept: pod + rank: 1 +command_rankings: +- command: kubectl label + rank: 1 +- command: kubectl get + rank: 2 +--- +{% capture purpose %} task-description-here {% endcapture %} +{% capture recommended_background %} prereq-reading-here {% endcapture %} +{% capture step_by_step %} single-step-here {% endcapture %} +{% include templates/task.md %} +{% endraw %}``` + + +## Landing Pages + +Landing pages are a set of clickable "cards" arranged in a grid. Each card has a heading and description, and optioninall, a thumbnail image. They are meant to be index pages that quickly forward users on to deeper content. + +### Demos + +- [Link to Example Landing Page](https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/master/docs/templatedemos/landingpage.md) +- [Link to Rendered Landing Page](landingpage/) + +### Usage + +To use this template, create a new file with these contents. Essentially, you declare the cards you want by inserting the following YAML structure in the front-matter YAML section at the top of the page, and the body of the page just has the include statement. + +```yaml +--- +cards: +- progression: no #"yes" = display cards as linearly progressing +- card: + title: Mean Stack + image: /images/docs/meanstack/image_0.png + description: Lorem ipsum dolor it verberum. +# repeat -card: items as necessary +--- +{% raw %}{% include templates/landing-page.md %}{% endraw %} +``` + +### Adding page to navigation + +Once your page is saved, somewhere in the `/docs/` directory, add a reference to the appropriate .yml file under `/_data/` so that it will appear in the left-hand navigation of the site. This is also where you add a title to the page. + + +## kubectl yaml + +You probably shouldn't be using this, but we also have templates which consume YAML files that are generated by the Kubernetes authors. These are turned into pages which display the reference information for the various CLI tools. + +### Demos + +- [Link to Example Template](https://raw.githubusercontent.com/kubernetes/kubernetes.github.io/docsv2/docs/kubectl/kubectl_api-versions.md) +- [Link to Rendered Template](http://k8sdocs.github.io/docs/kubectl/kubectl_api-versions/) + +### Adding page to navigation + +Once your page is saved, somewhere in the `/docs/` directory, add a reference to the `reference.yml` file under `/_data/` so that it will appear in the left-hand navigation of the site. This is also where you add a title to the page. \ No newline at end of file diff --git a/docs/templatedemos/kubectl.md b/docs/templatedemos/kubectl.md new file mode 100644 index 0000000000..29b5192000 --- /dev/null +++ b/docs/templatedemos/kubectl.md @@ -0,0 +1,7 @@ +--- +assignees: +- bgrant0607 + +--- +{% capture command %}kubectl_annotate{% endcapture %} +{% include templates/kubectl.md %} \ No newline at end of file diff --git a/docs/templatedemos/task.md b/docs/templatedemos/task.md new file mode 100644 index 0000000000..3803492f2b --- /dev/null +++ b/docs/templatedemos/task.md @@ -0,0 +1,62 @@ +--- +--- +# Doing a thing with a thing + +{% capture purpose %} +This document teaches you how to do a thing. +{% endcapture %} + +{% capture recommended_background %} +In order to do a thing, you must be familiar with the following: + +- [Thing 1](/foo/) +- [Thing 2](/bar/) + +{% endcapture %} + +{% capture step_by_step %} +Here's how to do a thing with a thing. + +#### 1. Prepare the thing + +Lorem ipsum dolor it verberum. + +#### 2. Run the thing command + +Lorem ipsum dolor it verberum. + +#### 3. Create the thing.yaml file + +Lorem ipsum dolor it verberum. + +```yaml +# Creates three nginx replicas +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: nginx-deployment +spec: + replicas: 3 + template: + metadata: + labels: + app: nginx + spec: + containers: + - name: nginx + image: nginx:1.7.9 + ports: + - containerPort: 80 +``` + +#### 4. ??? + +Lorem ipsum dolor it verberum. + +#### 5. Profit! + +Lorem ipsum dolor it verberum. + +{% endcapture %} + +{% include templates/task.md %} \ No newline at end of file diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index feb6d1cf69..25fefcf7a1 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -1,22 +1,30 @@ --- +assignees: +- brendandburns +- davidopp + --- ## Troubleshooting -Sometimes things go wrong. This guide is aimed at making them right. It has two sections: +Sometimes things go wrong. This guide is aimed at making them right. It has +two sections: * [Troubleshooting your application](/docs/user-guide/application-troubleshooting) - Useful for users who are deploying code into Kubernetes and wondering why it is not working. * [Troubleshooting your cluster](/docs/admin/cluster-troubleshooting) - Useful for cluster administrators and people whose Kubernetes cluster is unhappy. -You should also check the known issues for the [release](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG.md) you're using. +You should also check the known issues for the [release](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG.md) +you're using. ### Getting help -If your problem isn't answered by any of the guides above, there are variety of ways for you to get help from the Kubernetes team. +If your problem isn't answered by any of the guides above, there are variety of +ways for you to get help from the Kubernetes team. ### Questions -If you aren't familiar with it, many of your questions may be answered by the [user guide](/docs/user-guide/). +If you aren't familiar with it, many of your questions may be answered by the +[user guide](/docs/user-guide/). We also have a number of FAQ pages: @@ -33,26 +41,39 @@ You may also find the Stack Overflow topics relevant: ### Stack Overflow -Someone else from the community may have already asked a similar question or may be able to help with your problem. The Kubernetes team will also monitor [posts tagged kubernetes](http://stackoverflow.com/questions/tagged/kubernetes). If there aren't any existing questions that help, please [ask a new one](http://stackoverflow.com/questions/ask?tags=kubernetes)! +Someone else from the community may have already asked a similar question or may +be able to help with your problem. The Kubernetes team will also monitor +[posts tagged kubernetes](http://stackoverflow.com/questions/tagged/kubernetes). +If there aren't any existing questions that help, please [ask a new one](http://stackoverflow.com/questions/ask?tags=kubernetes)! ### Slack -The Kubernetes team hangs out on Slack in the `#kubernetes-users` channel. You can participate in the Kubernetes team [here](https://kubernetes.slack.com). Slack requires registration, but the Kubernetes team is open invitation to anyone to register [here](http://slack.kubernetes.io). Feel free to come and ask any and all questions. +The Kubernetes team hangs out on Slack in the `#kubernetes-users` channel. You +can participate in discussion with the Kubernetes team [here](https://kubernetes.slack.com). +Slack requires registration, but the Kubernetes team is open invitation to +anyone to register [here](http://slack.kubernetes.io). Feel free to come and ask +any and all questions. + +Once registered, browse the growing list of channels for various subjects of +interest. For example, people new to Kubernetes may also want to join the +`#kubernetes-novice` channel. As another example, developers should join the +`#kubernetes-dev` channel. ### Mailing List -The Google Container Engine mailing list is [google-containers@googlegroups.com](https://groups.google.com/forum/#!forum/google-containers) +The Kubernetes / Google Container Engine mailing list is [kubernetes-users@googlegroups.com](https://groups.google.com/forum/#!forum/kubernetes-users) ### Bugs and Feature requests -If you have what looks like a bug, or you would like to make a feature request, please use the [Github issue tracking system](https://github.com/kubernetes/kubernetes/issues). +If you have what looks like a bug, or you would like to make a feature request, +please use the [Github issue tracking system](https://github.com/kubernetes/kubernetes/issues). -Before you file an issue, please search existing issues to see if your issue is already covered. +Before you file an issue, please search existing issues to see if your issue is +already covered. -If filing a bug, please include detailed information about how to reproduce the problem, such as: +If filing a bug, please include detailed information about how to reproduce the +problem, such as: * Kubernetes version: `kubectl version` * Cloud provider, OS distro, network configuration, and Docker version * Steps to reproduce the problem - - diff --git a/docs/user-guide/OWNERS b/docs/user-guide/OWNERS new file mode 100644 index 0000000000..e9c564a252 --- /dev/null +++ b/docs/user-guide/OWNERS @@ -0,0 +1,5 @@ +assignees: +- erictune +- janetkuo +- satnam6502 + diff --git a/docs/user-guide/accessing-the-cluster.md b/docs/user-guide/accessing-the-cluster.md index 8a5cc1739f..cf15072373 100644 --- a/docs/user-guide/accessing-the-cluster.md +++ b/docs/user-guide/accessing-the-cluster.md @@ -1,7 +1,11 @@ ---- ---- +--- +assignees: +- lavalamp +- mikedanese -* TOC +--- + +* TOC {:toc} ## Accessing the cluster API @@ -18,10 +22,10 @@ or someone else setup the cluster and provided you with credentials and a locati Check the location and credentials that kubectl knows about with this command: -```shell +```shell $ kubectl config view -``` - +``` + Many of the [examples](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/) provide an introduction to using kubectl and complete documentation is found in the [kubectl manual](/docs/user-guide/kubectl/kubectl). @@ -29,7 +33,7 @@ kubectl and complete documentation is found in the [kubectl manual](/docs/user-g Kubectl handles locating and authenticating to the apiserver. If you want to directly access the REST API with an http client like -curl or wget, or a browser, there are several ways to locate and authenticate: +curl or wget, or a browser, there are several ways to locate and authenticate: - Run kubectl in proxy mode. - Recommended approach. @@ -48,29 +52,29 @@ The following command runs kubectl in a mode where it acts as a reverse proxy. locating the apiserver and authenticating. Run it like this: -```shell +```shell $ kubectl proxy --port=8080 & -``` - +``` + See [kubectl proxy](/docs/user-guide/kubectl/kubectl_proxy) for more details. Then you can explore the API with curl, wget, or a browser, like so: -```shell +```shell $ curl http://localhost:8080/api/ { "versions": [ "v1" ] } -``` - +``` + #### Without kubectl proxy It is also possible to avoid using kubectl proxy by passing an authentication token directly to the apiserver, like this: -```shell +```shell $ APISERVER=$(kubectl config view | grep server | cut -f 2- -d ":" | tr -d " ") $ TOKEN=$(kubectl config view | grep token | cut -f 2 -d ":" | tr -d " ") $ curl $APISERVER/api --header "Authorization: Bearer $TOKEN" --insecure @@ -79,8 +83,8 @@ $ curl $APISERVER/api --header "Authorization: Bearer $TOKEN" --insecure "v1" ] } -``` - +``` + The above example uses the `--insecure` flag. This leaves it subject to MITM attacks. When kubectl accesses the cluster it uses a stored root certificate and client certificates to access the server. (These are installed in the @@ -119,14 +123,14 @@ is associated with a service account, and a credential (token) for that service account is placed into the filesystem tree of each container in that pod, at `/var/run/secrets/kubernetes.io/serviceaccount/token`. -If available, a certificate bundle is placed into the filesystem tree of each -container at `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt`, and should be -used to verify the serving certificate of the apiserver. - -Finally, the default namespace to be used for namespaced API operations is placed in a file -at `/var/run/secrets/kubernetes.io/serviceaccount/namespace` in each container. - -From within a pod the recommended ways to connect to API are: +If available, a certificate bundle is placed into the filesystem tree of each +container at `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt`, and should be +used to verify the serving certificate of the apiserver. + +Finally, the default namespace to be used for namespaced API operations is placed in a file +at `/var/run/secrets/kubernetes.io/serviceaccount/namespace` in each container. + +From within a pod the recommended ways to connect to API are: - run a kubectl proxy as one of the containers in the pod, or as a background process within a container. This proxies the @@ -134,7 +138,7 @@ From within a pod the recommended ways to connect to API are: in any container of the pod can access it. See this [example of using kubectl proxy in a pod](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/kubectl-container/). - use the Go client library, and create a client using the `client.NewInCluster()` factory. - This handles locating and authenticating to the apiserver. + This handles locating and authenticating to the apiserver. In each case, the credentials of the pod are used to communicate securely with the apiserver. @@ -150,7 +154,7 @@ such as your desktop machine. ### Ways to connect -You have several options for connecting to nodes, pods and services from outside the cluster: +You have several options for connecting to nodes, pods and services from outside the cluster: - Access services through public IPs. - Use a service with type `NodePort` or `LoadBalancer` to make the service reachable outside @@ -182,7 +186,7 @@ You have several options for connecting to nodes, pods and services from outside Typically, there are several services which are started on a cluster by kube-system. Get a list of these with the `kubectl cluster-info` command: -```shell +```shell $ kubectl cluster-info Kubernetes master is running at https://104.197.5.247 @@ -191,8 +195,8 @@ $ kubectl cluster-info kube-dns is running at https://104.197.5.247/api/v1/proxy/namespaces/kube-system/services/kube-dns grafana is running at https://104.197.5.247/api/v1/proxy/namespaces/kube-system/services/monitoring-grafana heapster is running at https://104.197.5.247/api/v1/proxy/namespaces/kube-system/services/monitoring-heapster -``` - +``` + This shows the proxy-verb URL for accessing each service. For example, this cluster has cluster-level logging enabled (using Elasticsearch), which can be reached at `https://104.197.5.247/api/v1/proxy/namespaces/kube-system/services/elasticsearch-logging/` if suitable credentials are passed, or through a kubectl proxy at, for example: @@ -211,7 +215,7 @@ If you haven't specified a name for your port, you don't have to specify *port_n * To access the Elasticsearch service endpoint `_search?q=user:kimchy`, you would use: `http://104.197.5.247/api/v1/proxy/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy` * To access the Elasticsearch cluster health information `_cluster/health?pretty=true`, you would use: `https://104.197.5.247/api/v1/proxy/namespaces/kube-system/services/elasticsearch-logging/_cluster/health?pretty=true` -```json +```json { "cluster_name" : "kubernetes_logging", "status" : "yellow", @@ -224,11 +228,11 @@ If you haven't specified a name for your port, you don't have to specify *port_n "initializing_shards" : 0, "unassigned_shards" : 5 } -``` - +``` + #### Using web browsers to access services running on the cluster -You may be able to put an apiserver proxy url into the address bar of a browser. However: +You may be able to put an apiserver proxy url into the address bar of a browser. However: - Web browsers cannot usually pass tokens, so you may need to use basic (password) auth. Apiserver can be configured to accept basic auth, but your cluster may not be configured to accept basic auth. @@ -241,7 +245,7 @@ The redirect capabilities have been deprecated and removed. Please use a proxy ## So Many Proxies -There are several different proxies you may encounter when using Kubernetes: +There are several different proxies you may encounter when using Kubernetes: 1. The [kubectl proxy](#directly-accessing-the-rest-api): - runs on a user's desktop or in a pod @@ -275,4 +279,4 @@ There are several different proxies you may encounter when using Kubernetes: - implementation varies by cloud provider. Kubernetes users will typically not need to worry about anything other than the first two types. The cluster admin -will typically ensure that the latter types are setup correctly. +will typically ensure that the latter types are setup correctly. diff --git a/docs/user-guide/annotations.md b/docs/user-guide/annotations.md index 9a28452929..181a1faed0 100644 --- a/docs/user-guide/annotations.md +++ b/docs/user-guide/annotations.md @@ -1,4 +1,8 @@ --- +assignees: +- mikedanese +- thockin + --- We have [labels](/docs/user-guide/labels) for identifying metadata. diff --git a/docs/user-guide/application-troubleshooting.md b/docs/user-guide/application-troubleshooting.md index a82cf67b60..b88cc4483d 100644 --- a/docs/user-guide/application-troubleshooting.md +++ b/docs/user-guide/application-troubleshooting.md @@ -1,4 +1,8 @@ --- +assignees: +- mikedanese +- thockin + --- This guide is to help users debug applications that are deployed into Kubernetes and not behaving correctly. diff --git a/docs/user-guide/compute-resources.md b/docs/user-guide/compute-resources.md index 0d90e117e2..da6b299ea2 100644 --- a/docs/user-guide/compute-resources.md +++ b/docs/user-guide/compute-resources.md @@ -1,4 +1,8 @@ --- +assignees: +- mikedanese +- thockin + --- * TOC @@ -9,7 +13,7 @@ container needs. When containers have their resource requests specified, the sc able to make better decisions about which nodes to place pods on; and when containers have their limits specified, contention for resources on a node can be handled in a specified manner. For more details about the difference between requests and limits, please refer to -[Resource QoS](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/proposals/resource-qos.md). +[Resource QoS](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/resource-qos.md). *CPU* and *memory* are each a *resource type*. A resource type has a base unit. CPU is specified in units of cores. Memory is specified in units of bytes. @@ -40,8 +44,34 @@ about pod resource requests/limits. A *pod resource request/limit* for a partic type is the sum of the resource requests/limits of that type for each container in the pod, with unset values treated as zero (or equal to default values in some cluster configurations). +### Meaning of CPU +Limits and requests for `cpu` are measured in cpus. +One cpu, in Kubernetes, is equivalent to: + +- 1 AWS vCPU +- 1 GCP Core +- 1 Azure vCore +- 1 *Hyperthread* on a bare-metal Intel processor with Hyperthreading + +Fractional requests are allowed. A container with `spec.container[].resources.requests.cpu` of `0.5` will +be guaranteed half as much CPU as one that asks for `1`. The expression `0.1` is equivalent to the expression +`100m`, which can be read as "one hundred millicpu" (some may say "one hundred millicores", and this is understood +to mean the same thing when talking about Kubernetes). A request with a decimal point, like `0.1` is converted to +`100m` by the API, and precision finer than `1m` is not allowed. For this reason, the form `100m` may be preferred. + +CPU is always requested as an absolute quantity, never as a relative quantity; 0.1 is the same amount of cpu on a single +core, dual core, or 48 core machine. + +# Meaning of Memory + +Limits and requests for `memory` are measured in bytes. +Memory can be expressed a plain integer or as fixed-point integers with one of these SI suffixes (E, P, T, G, M, K) +or their power-of-two equivalents (Ei, Pi, Ti, Gi, Mi, Ki). For example, the following represent roughly the same value: +`128974848`, `129e6`, `129M` , `123Mi`. + +### Example The following pod has two containers. Each has a request of 0.25 core of cpu and 64MiB -(220 bytes) of memory and a limit of 0.5 core of cpu and 128MiB of memory. The pod can +(226 bytes) of memory and a limit of 0.5 core of cpu and 128MiB of memory. The pod can be said to have a request of 0.5 core and 128 MiB of memory and a limit of 1 core and 256MiB of memory. @@ -91,10 +121,16 @@ runner (Docker or rkt). When using Docker: -- The `spec.container[].resources.limits.cpu` is multiplied by 1024, converted to an integer, and - used as the value of the [`--cpu-shares`]( +- The `spec.container[].resources.requests.cpu` is converted to its core value (potentially fractional), + and multipled by 1024, and used as the value of the [`--cpu-shares`]( https://docs.docker.com/reference/run/#runtime-constraints-on-resources) flag to the `docker run` command. +- The `spec.container[].resources.limits.cpu` is converted to its millicore value, + multipled by 100000, and then divided by 1000, and used as the value of the [`--cpu-quota`]( + https://docs.docker.com/reference/run/#runtime-constraints-on-resources) flag to the `docker run` + command. The [`--cpu-period`] flag is set to 100000 which represents the default 100ms period + for measuring quota usage. The kubelet enforces cpu limits if it was started with the + [`--cpu-cfs-quota`] flag set to true. As of version 1.2, this flag will now default to true. - The `spec.container[].resources.limits.memory` is converted to an integer, and used as the value of the [`--memory`](https://docs.docker.com/reference/run/#runtime-constraints-on-resources) flag to the `docker run` command. diff --git a/docs/user-guide/config-best-practices.md b/docs/user-guide/config-best-practices.md index 3cb85344d2..911ebbb79c 100644 --- a/docs/user-guide/config-best-practices.md +++ b/docs/user-guide/config-best-practices.md @@ -1,4 +1,7 @@ --- +assignees: +- mikedanese + --- This document is meant to highlight and consolidate in one place configuration best practices that are introduced throughout the user-guide and getting-started documentation and examples. This is a living document so if you think of something that is not on this list but might be useful to others, please don't hesitate to file an issue or submit a PR. diff --git a/docs/user-guide/configmap/OWNERS b/docs/user-guide/configmap/OWNERS new file mode 100644 index 0000000000..cca2c1dfda --- /dev/null +++ b/docs/user-guide/configmap/OWNERS @@ -0,0 +1,4 @@ +assignees: +- dchen1107 +- pmorie + diff --git a/docs/user-guide/configmap/README.md b/docs/user-guide/configmap/README.md index e6bf6f52a5..2df57176dd 100644 --- a/docs/user-guide/configmap/README.md +++ b/docs/user-guide/configmap/README.md @@ -101,3 +101,6 @@ This pod runs a `cat` command to print the value of one of the keys in the volum $ kubectl logs config-volume-test-pod value-1 ``` + +Alternatively you can use [`mount-file-pod.yaml`](mount-file-pod.yaml) file to mount +only a file from ConfigMap, preserving original content of /etc directory. diff --git a/docs/user-guide/configmap/index.md b/docs/user-guide/configmap/index.md index 17cc9c154b..7b5cd452fc 100644 --- a/docs/user-guide/configmap/index.md +++ b/docs/user-guide/configmap/index.md @@ -1,4 +1,8 @@ --- +assignees: +- eparis +- pmorie + --- Many applications require configuration via some combination of config files, command line arguments, and environment variables. These configuration artifacts should be decoupled from image @@ -362,7 +366,7 @@ spec: containers: - name: test-container image: gcr.io/google_containers/busybox - command: [ "/bin/sh", "cat", "/etc/config/special.how" ] + command: [ "/bin/sh", "-c", "cat /etc/config/special.how" ] volumeMounts: - name: config-volume mountPath: /etc/config @@ -390,7 +394,7 @@ spec: containers: - name: test-container image: gcr.io/google_containers/busybox - command: [ "/bin/sh", "cat", "/etc/config/path/to/special-key" ] + command: [ "/bin/sh","-c","cat /etc/config/path/to/special-key" ] volumeMounts: - name: config-volume mountPath: /etc/config diff --git a/docs/user-guide/configmap/mount-file-pod.yaml b/docs/user-guide/configmap/mount-file-pod.yaml new file mode 100644 index 0000000000..7efd9b4003 --- /dev/null +++ b/docs/user-guide/configmap/mount-file-pod.yaml @@ -0,0 +1,21 @@ +apiVersion: v1 +kind: Pod +metadata: + name: config-single-file-volume-pod +spec: + containers: + - name: test-container + image: gcr.io/google_containers/busybox + command: [ "/bin/sh", "-c", "cat /etc/special-key" ] + volumeMounts: + - name: config-volume + mountPath: /etc/special-key + subPath: path/to/special-key + volumes: + - name: config-volume + configMap: + name: test-configmap + items: + - key: data-1 + path: path/to/special-key + restartPolicy: Never diff --git a/docs/user-guide/configuring-containers.md b/docs/user-guide/configuring-containers.md index afe942fdef..7a57d86ae8 100644 --- a/docs/user-guide/configuring-containers.md +++ b/docs/user-guide/configuring-containers.md @@ -1,4 +1,8 @@ --- +assignees: +- caesarxuchao +- thockin + --- * TOC @@ -24,7 +28,7 @@ spec: # specification of the pod's contents containers: - name: hello image: "ubuntu:14.04" - command: ["/bin/echo","hello'?,'?world"] + command: ["/bin/echo", "hello", "world"] ``` The value of `metadata.name`, `hello-world`, will be the name of the pod resource created, and must be unique within the cluster, whereas `containers[0].name` is just a nickname for the container within that pod. `image` is the name of the Docker image, which Kubernetes expects to be able to pull from a registry, the [Docker Hub](https://registry.hub.docker.com/) by default. @@ -83,7 +87,7 @@ spec: # specification of the pod’s contents args: ["/bin/echo \"${MESSAGE}\""] ``` -However, a shell isn't necessary just to expand environment variables. Kubernetes will do it for you if you use [`$(ENVVAR)` syntax](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/expansion): +However, a shell isn't necessary just to expand environment variables. Kubernetes will do it for you if you use [`$(ENVVAR)` syntax](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/expansion.md): ```yaml command: ["/bin/echo"] diff --git a/docs/user-guide/connecting-applications.md b/docs/user-guide/connecting-applications.md index 7cbe76ccbd..4f0b804a4e 100644 --- a/docs/user-guide/connecting-applications.md +++ b/docs/user-guide/connecting-applications.md @@ -1,4 +1,9 @@ --- +assignees: +- caesarxuchao +- lavalamp +- thockin + --- * TOC @@ -59,7 +64,7 @@ This is equivalent to `kubectl create -f` the following yaml: {% include code.html language="yaml" file="nginx-svc.yaml" ghlink="/docs/user-guide/nginx-svc.yaml" %} -This specification will create a Service which targets TCP port 80 on any Pod with the `app=nginx` label, and expose it on an abstracted Service port (`targetPort`: is the port the container accepts traffic on, `port`: is the abstracted Service port, which can be any port other pods use to access the Service). View [service API object](/docs/api-reference/v1/definitions/#_v1_service) to see the list of supported fields in service definition. +This specification will create a Service which targets TCP port 80 on any Pod with the `run: my-nginx` label, and expose it on an abstracted Service port (`targetPort`: is the port the container accepts traffic on, `port`: is the abstracted Service port, which can be any port other pods use to access the Service). View [service API object](/docs/api-reference/v1/definitions/#_v1_service) to see the list of supported fields in service definition. Check your Service: ```shell @@ -105,7 +110,7 @@ KUBERNETES_SERVICE_PORT=443 KUBERNETES_SERVICE_PORT_HTTPS=443 ``` -Note there's no mention of your Service. This is because you created the replicas before the Service. Another disadvantage of doing this is that the scheduler might put both pods on the same machine, which will take your entire Service down if it dies. We can do this the right way by killing the 2 pods and waiting for the Deployment to recreate them. This time around the Service exists *before* the replicas. This will given you scheduler level Service spreading of your pods (provided all your nodes have equal capacity), as well as the right environment variables: +Note there's no mention of your Service. This is because you created the replicas before the Service. Another disadvantage of doing this is that the scheduler might put both pods on the same machine, which will take your entire Service down if it dies. We can do this the right way by killing the 2 pods and waiting for the Deployment to recreate them. This time around the Service exists *before* the replicas. This will give you scheduler-level Service spreading of your pods (provided all your nodes have equal capacity), as well as the right environment variables: ```shell $ kubectl scale deployment my-nginx --replicas=0; kubectl scale deployment my-nginx --replicas=2; @@ -286,6 +291,13 @@ $ kubectl describe service my-nginx LoadBalancer Ingress: a320587ffd19711e5a37606cf4a74574-1142138393.us-east-1.elb.amazonaws.com ... ``` +## Further reading + +Kubernetes also supports Federated Services, which can span multiple +clusters and cloud providers, to provide increased availability, +bettern fault tolerance and greater scalability for your services. See +the [Federated Services User Guide](/docs/user-guide/federation/federated-services/) +for further information. ## What's next? diff --git a/docs/user-guide/connecting-to-applications-port-forward.md b/docs/user-guide/connecting-to-applications-port-forward.md index 9c331f5918..742730229f 100644 --- a/docs/user-guide/connecting-to-applications-port-forward.md +++ b/docs/user-guide/connecting-to-applications-port-forward.md @@ -1,4 +1,8 @@ --- +assignees: +- caesarxuchao +- mikedanese + --- kubectl port-forward forwards connections to a local port to a port on a pod. Its man page is available [here](/docs/user-guide/kubectl/kubectl_port-forward). Compared to [kubectl proxy](/docs/user-guide/accessing-the-cluster/#using-kubectl-proxy), `kubectl port-forward` is more generic as it can forward TCP traffic while `kubectl proxy` can only forward HTTP traffic. This guide demonstrates how to use `kubectl port-forward` to connect to a Redis database, which may be useful for database debugging. @@ -6,7 +10,7 @@ kubectl port-forward forwards connections to a local port to a port on a pod. It ## Creating a Redis master ```shell -$ kubectl create examples/redis/redis-master.yaml +$ kubectl create -f examples/redis/redis-master.yaml pods/redis-master ``` @@ -23,7 +27,7 @@ redis-master 2/2 Running 0 41s The Redis master is listening on port 6379, to verify this, ```shell{% raw %} -$ kubectl get pods redis-master -t='{{(index (index .spec.containers 0).ports 0).containerPort}}{{"\n"}}' +$ kubectl get pods redis-master --template='{{(index (index .spec.containers 0).ports 0).containerPort}}{{"\n"}}' 6379{% endraw %} ``` diff --git a/docs/user-guide/connecting-to-applications-proxy.md b/docs/user-guide/connecting-to-applications-proxy.md index 76ccf1a569..4e9867a339 100644 --- a/docs/user-guide/connecting-to-applications-proxy.md +++ b/docs/user-guide/connecting-to-applications-proxy.md @@ -1,5 +1,9 @@ ---- ---- +--- +assignees: +- caesarxuchao +- lavalamp + +--- You have seen the [basics](/docs/user-guide/accessing-the-cluster) about `kubectl proxy` and `apiserver proxy`. This guide shows how to use them together to access a service([kube-ui](/docs/user-guide/ui)) running on the Kubernetes cluster from your workstation. @@ -8,11 +12,11 @@ You have seen the [basics](/docs/user-guide/accessing-the-cluster) about `kubect kube-ui is deployed as a cluster add-on. To find its apiserver proxy URL, -```shell +```shell $ kubectl cluster-info | grep "KubeUI" KubeUI is running at https://173.255.119.104/api/v1/proxy/namespaces/kube-system/services/kube-ui -``` - +``` + if this command does not find the URL, try the steps [here](/docs/user-guide/ui/#accessing-the-ui). @@ -20,9 +24,9 @@ if this command does not find the URL, try the steps [here](/docs/user-guide/ui/ The above proxy URL is an access to the kube-ui service provided by the apiserver. To access it, you still need to authenticate to the apiserver. `kubectl proxy` can handle the authentication. -```shell +```shell $ kubectl proxy --port=8001 Starting to serve on localhost:8001 -``` - +``` + Now you can access the kube-ui service on your local workstation at [http://localhost:8001/api/v1/proxy/namespaces/kube-system/services/kube-ui](http://localhost:8001/api/v1/proxy/namespaces/kube-system/services/kube-ui) \ No newline at end of file diff --git a/docs/user-guide/container-environment.md b/docs/user-guide/container-environment.md index 72365ab0c0..165d135de2 100644 --- a/docs/user-guide/container-environment.md +++ b/docs/user-guide/container-environment.md @@ -1,4 +1,8 @@ --- +assignees: +- mikedanese +- thockin + --- This document describes the environment for Kubelet managed containers on a Kubernetes node (kNode).  In contrast to the Kubernetes cluster API, which provides an API for creating and managing containers, the Kubernetes container environment provides the container access to information about what else is going on in the cluster. diff --git a/docs/user-guide/containers.md b/docs/user-guide/containers.md index c38453af42..cf05278801 100644 --- a/docs/user-guide/containers.md +++ b/docs/user-guide/containers.md @@ -1,4 +1,7 @@ --- +assignees: +- mikedanese + --- * TOC @@ -48,7 +51,7 @@ Here are examples for these rules in table format ## Capabilities -By default, Docker containers are "unprivileged" and cannot, for example, run a Docker daemon inside a Docker container. We can have fine grain control over the capabilities using cap-add and cap-drop.More details [here](https://docs.docker.com/reference/run/#runtime-privilege-linux-capabilities-and-lxc-configuration). +By default, Docker containers are "unprivileged" and cannot, for example, run a Docker daemon inside a Docker container. We can have fine grain control over the capabilities using cap-add and cap-drop. More details [here](https://docs.docker.com/engine/reference/run/#/runtime-privilege-and-linux-capabilities). The relationship between Docker's capabilities and [Linux capabilities](http://man7.org/linux/man-pages/man7/capabilities.7.html) @@ -90,4 +93,4 @@ The relationship between Docker's capabilities and [Linux capabilities](http://m | LEASE | CAP_LEASE | | SETFCAP | CAP_SETFCAP | | WAKE_ALARM | CAP_WAKE_ALARM | -| BLOCK_SUSPEND | CAP_BLOCK_SUSPEND | \ No newline at end of file +| BLOCK_SUSPEND | CAP_BLOCK_SUSPEND | diff --git a/docs/user-guide/debugging-pods-and-replication-controllers.md b/docs/user-guide/debugging-pods-and-replication-controllers.md index 08517c6742..a02de467bd 100644 --- a/docs/user-guide/debugging-pods-and-replication-controllers.md +++ b/docs/user-guide/debugging-pods-and-replication-controllers.md @@ -1,4 +1,7 @@ --- +assignees: +- bprashanth + --- * TOC diff --git a/docs/user-guide/debugging-services.md b/docs/user-guide/debugging-services.md index b4f68e7e0c..d7e13889f4 100644 --- a/docs/user-guide/debugging-services.md +++ b/docs/user-guide/debugging-services.md @@ -1,4 +1,9 @@ --- +assignees: +- bprashanth +- janetkuo +- thockin + --- An issue that comes up rather frequently for new installations of Kubernetes is @@ -555,6 +560,63 @@ There are three things to check: Engine doesn't do port remapping, so if your application serves on 8080, the `containerPort` field needs to be 8080. +### A Pod cannot reach itself via Service IP + +This mostly happens when `kube-proxy` is running in `iptables` mode and Pods +are connected with bridge network. The `Kubelet` exposes a `hairpin-mode` +[flag](http://kubernetes.io/docs/admin/kubelet/) that allows endpoints of a Service to loadbalance back to themselves +if they try to access their own Service VIP. The `hairpin-mode` flag must either be +set to `haripin-veth` or `promiscuous-bridge`. + +The common steps to trouble shoot this are as follows: + +* Confirm `hairpin-mode` is set to `haripin-veth` or `promiscuous-bridge`. +You should see something like the below. `hairpin-mode` is set to +`promiscuous-bridge` in the following example. + +```shell +u@node$ ps auxw|grep kubelet +root 3392 1.1 0.8 186804 65208 ? Sl 00:51 11:11 /usr/local/bin/kubelet --enable-debugging-handlers=true --config=/etc/kubernetes/manifests --allow-privileged=True --v=4 --cluster-dns=10.0.0.10 --cluster-domain=cluster.local --configure-cbr0=true --cgroup-root=/ --system-cgroups=/system --hairpin-mode=promiscuous-bridge --runtime-cgroups=/docker-daemon --kubelet-cgroups=/kubelet --babysit-daemons=true --max-pods=110 --serialize-image-pulls=false --outofdisk-transition-frequency=0 + +``` + +* Confirm the effective `hairpin-mode`. To do this, you'll have to look at +kubelet log. Accessing the logs depends on your Node OS. On some OSes it +is a file, such as /var/log/kubelet.log, while other OSes use `journalctl` +to access logs. Please be noted that the effective hairpin mode may not +match `--hairpin-mode` flag due to compatibility. Check if there is any log +lines with key word `hairpin` in kubelet.log. There should be log lines +indicating the effective hairpin mode, like something below. + +```shell +I0629 00:51:43.648698 3252 kubelet.go:380] Hairpin mode set to "promiscuous-bridge" +``` + +* If the effective hairpin mode is `hairpin-veth`, ensure the `Kubelet` has +the permission to operate in `/sys` on node. If everything works properly, +you should see something like: + +```shell +u@node$ for intf in /sys/devices/virtual/net/cbr0/brif/*; do cat $intf/hairpin_mode; done +1 +1 +1 +1 +``` + +* If the effective hairpin mode is `promiscuous-bridge`, ensure `Kubelet` +has the permission to manipulate linux bridge on node. If cbr0` bridge is +used and configured properly, you should see: + +```shell +u@node$ ifconfig cbr0 |grep PROMISC +UP BROADCAST RUNNING PROMISC MULTICAST MTU:1460 Metric:1 + +``` + +* Seek help if none of above works out. + + ## Seek help If you get this far, something very strange is happening. Your `Service` is diff --git a/docs/user-guide/deploying-applications.md b/docs/user-guide/deploying-applications.md index 0dc337e4f8..455a3378d2 100644 --- a/docs/user-guide/deploying-applications.md +++ b/docs/user-guide/deploying-applications.md @@ -1,4 +1,9 @@ --- +assignees: +- bgrant0607 +- caesarxuchao +- thockin + --- diff --git a/docs/user-guide/deployments.md b/docs/user-guide/deployments.md index 1cd688e8c8..287317e060 100644 --- a/docs/user-guide/deployments.md +++ b/docs/user-guide/deployments.md @@ -1,4 +1,8 @@ --- +assignees: +- bgrant0607 +- janetkuo + --- * TOC @@ -74,49 +78,43 @@ nginx-deployment-2035384211-qqcnn 1/1 Running 0 18s app The created Replica Set will ensure that there are three nginx Pods at all times. +**Note:** You must specify appropriate selector and pod template labels of a Deployment (in this case, `app = nginx`), i.e. don't overlap with other controllers (including Deployments, Replica Sets, Replication Controllers, etc.) Kubernetes won't stop you from doing that, and if you end up with multiple controllers that have overlapping selectors, those controllers will fight with each others and won't behave correctly. + ## The Status of a Deployment -After creating or updating a Deployment, you would want to confirm whether it succeeded or not. The best way to do this is through checking its status. - -To verify if the above Deployment succeeded or not, first compare the `.metadata.generation` and `.status.observedGeneration` of the Deployment: +After creating or updating a Deployment, you would want to confirm whether it succeeded or not. The simplest way to do this is through `kubectl rollout status`. ```shell -$ kubectl get deployment/nginx-deployment -o yaml | grep [Gg]eneration - generation: 2 - observedGeneration: 2 +$ kubectl rollout status deployment/nginx-deployment +deployment nginx-deployment successfully rolled out ``` -When `observedGeneration` >= `generation`, the Deployment controller has observed current Deployment; if not, wait for a few more seconds. +This verifies the Deployment's `.status.observedGeneration` >= `.metadata.generation`, and its up-to-date replicas +(`.status.updatedReplicas`) matches the desired replicas (`.spec.replicas`) to determine if the rollout succeeded. +If the rollout is still in progress, it watches for Deployment status changes and prints related messages. -Once the above condition is met, check the Deployment's up-to-date replicas (`.status.updatedReplicas`) and see if it matches the desired replicas (`.spec.replicas`): - -```shell -$ kubectl get deployment/nginx-deployment -NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE -nginx-deployment 3 3 3 3 9m -``` +Note that it's impossible to know whether a Deployment will ever succeed, so if the above command doesn't return success, +you'll need to timeout and give up at some point. Additionally, if you set `.spec.minReadySeconds`, you would also want to check if the available replicas (`.status.availableReplicas`) matches the desired replicas too. -**Note:** It's impossible to know whether a Deployment will ever succeed, so one has to timeout and give up at some point. +```shell +$ kubectl get deployments +NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE +nginx-deployment 3 3 3 3 20s +``` ## Updating a Deployment -Suppose that we now want to update the nginx Pods to start using the `nginx:1.9.1` image -instead of the `nginx:1.7.9` image. - **Note:** a Deployment's rollout is triggered if and only if the Deployment's pod template (i.e. `.spec.template`) is changed, e.g. updating labels or container images of the template. Other updates, such as scaling the Deployment, will not trigger a rollout. -First, we update our Deployment configuration as follows: - -{% include code.html language="yaml" file="new-nginx-deployment.yaml" ghlink="/docs/user-guide/new-nginx-deployment.yaml" %} - -We can then `apply` the new Deployment: +Suppose that we now want to update the nginx Pods to start using the `nginx:1.9.1` image +instead of the `nginx:1.7.9` image. ```shell -$ kubectl apply -f docs/user-guide/new-nginx-deployment.yaml -deployment "nginx-deployment" configured +$ kubectl set image deployment/nginx-deployment nginx=nginx:1.9.1 +deployment "nginx-deployment" image updated ``` Alternatively, we can `edit` the Deployment and change `.spec.template.spec.containers[0].image` from `nginx:1.7.9` to `nginx:1.9.1`: @@ -126,17 +124,15 @@ $ kubectl edit deployment/nginx-deployment deployment "nginx-deployment" edited ``` -Running a `get` immediately will give: +To see its rollout status, simply run: ```shell -$ kubectl get deployments -NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE -nginx-deployment 3 3 0 3 20s +$ kubectl rollout status deployment/nginx-deployment +Waiting for rollout to finish: 2 out of 3 new replicas have been updated... +deployment nginx-deployment successfully rolled out ``` -The 0 number of up-to-date replicas indicates that the Deployment hasn't updated the replicas to the latest configuration. The current replicas indicates the total replicas (3 with old configuration and 0 with new configuration) this Deployment manages, and the available replicas indicates the number of current replicas that are available. - -The Deployment will update all the Pods in a few seconds. +After the rollout succeeds, you may want to `get` the Deployment: ```shell $ kubectl get deployments @@ -144,6 +140,10 @@ NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE nginx-deployment 3 3 3 3 36s ``` +The number of up-to-date replicas indicates that the Deployment has updated the replicas to the latest configuration. +The current replicas indicates the total replicas this Deployment manages, and the available replicas indicates the +number of current replicas that are available. + We can run `kubectl get rs` to see that the Deployment updated the Pods by creating a new Replica Set and scaling it up to 3 replicas, as well as scaling down the old Replica Set to 0 replicas. ```shell @@ -163,7 +163,7 @@ nginx-deployment-1564180365-nacti 1/1 Running 0 14s nginx-deployment-1564180365-z9gth 1/1 Running 0 14s ``` -Next time we want to update these Pods, we only need to update and re-apply the Deployment again. +Next time we want to update these Pods, we only need to update the Deployment's pod template again. Deployment can ensure that only a certain number of Pods may be down while they are being updated. By default, it ensures that at least 1 less than the desired number of Pods are @@ -237,14 +237,21 @@ auto-scaling. This implies that when you rollback to an earlier revision, only t Suppose that we made a typo while updating the Deployment, by putting the image name as `nginx:1.91` instead of `nginx:1.9.1`: -{% include code.html language="yaml" file="bad-nginx-deployment.yaml" ghlink="/docs/user-guide/bad-nginx-deployment.yaml" %} - ```shell -$ kubectl apply -f docs/user-guide/bad-nginx-deployment.yaml -deployment "nginx-deployment" configured +$ kubectl set image deployment/nginx-deployment nginx=nginx:1.91 +deployment "nginx-deployment" image updated ``` -You will see that both the number of old replicas (nginx-deployment-1564180365 and nginx-deployment-2035384211) and new replicas (nginx-deployment-3066724191) are 2. +The rollout will be stuck. + +``` +$ kubectl rollout status deployments nginx-deployment +Waiting for rollout to finish: 2 out of 3 new replicas have been updated... +``` + +Press Ctrl-C to stop the above rollout status watch. + +You will also see that both the number of old replicas (nginx-deployment-1564180365 and nginx-deployment-2035384211) and new replicas (nginx-deployment-3066724191) are 2. ```shell $ kubectl get rs @@ -305,8 +312,8 @@ $ kubectl rollout history deployment/nginx-deployment deployments "nginx-deployment": REVISION CHANGE-CAUSE 1 kubectl create -f docs/user-guide/nginx-deployment.yaml --record -2 kubectl apply -f docs/user-guide/new-nginx-deployment.yaml -3 kubectl apply -f docs/user-guide/bad-nginx-deployment.yaml +2 kubectl set image deployment/nginx-deployment nginx=nginx:1.9.1 +3 kubectl set image deployment/nginx-deployment nginx=nginx:1.91 ``` Because we recorded the command while creating this Deployment using `--record`, we can easily see the changes we made in each revision. @@ -316,10 +323,18 @@ To further see the details of each revision, run: ```shell $ kubectl rollout history deployment/nginx-deployment --revision=2 deployments "nginx-deployment" revision 2 -Labels: app=nginx,pod-template-hash=1564180365 -Annotations: kubernetes.io/change-cause=kubectl apply -f docs/user-guide/new-nginx-deployment.yaml -Image(s): nginx:1.9.1 -No volumes. + Labels: app=nginx + pod-template-hash=1159050644 + Annotations: kubernetes.io/change-cause=kubectl set image deployment/nginx-deployment nginx=nginx:1.9.1 + Containers: + nginx: + Image: nginx:1.9.1 + Port: 80/TCP + QoS Tier: + cpu: BestEffort + memory: BestEffort + Environment Variables: + No volumes. ``` ### Rolling Back to a Previous Revision @@ -346,6 +361,7 @@ The Deployment is now rolled back to a previous stable revision. As you can see, $ kubectl get deployment NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE nginx-deployment 3 3 3 3 30m + $ kubectl describe deployment Name: nginx-deployment Namespace: default @@ -374,6 +390,11 @@ Events: 29m 2m 2 {deployment-controller } Normal ScalingReplicaSet Scaled up replica set nginx-deployment-1564180365 to 3 ``` +### Clean up Policy + +You can set `.spec.revisionHistoryLimit` field to specify how much revision history of this deployment you want to keep. By default, +all revision history will be kept; explicitly setting this field to `0` disallows a deployment being rolled back. + ## Pausing and Resuming a Deployment You can also pause a Deployment mid-way and then resume it. A use case is to support canary deployment. @@ -381,8 +402,8 @@ You can also pause a Deployment mid-way and then resume it. A use case is to sup Update the Deployment again and then pause the Deployment with `kubectl rollout pause`: ```shell -$ kubectl apply -f docs/user-guide/new-nginx-deployment; kubectl rollout pause deployment/nginx-deployment -deployment "nginx-deployment" configured +$ kubectl set image deployment/nginx-deployment nginx=nginx:1.9.1; kubectl rollout pause deployment/nginx-deployment +deployment "nginx-deployment" image updated deployment "nginx-deployment" paused ``` @@ -398,6 +419,13 @@ nginx-deployment-2035384211 2 2 1h nginx-deployment-3066724191 0 0 1h ``` +In a separate terminal, watch for rollout status changes and you'll see the rollout won't continue: + +```shell +$ kubectl rollout status deployment/nginx-deployment +Waiting for rollout to finish: 2 out of 3 new replicas have been updated... +``` + To resume the Deployment, simply do `kubectl rollout resume`: ```shell @@ -407,6 +435,14 @@ deployment "nginx-deployment" resumed Then the Deployment will continue and finish the rollout: +```shell +$ kubectl rollout status deployment/nginx-deployment +Waiting for rollout to finish: 2 out of 3 new replicas have been updated... +Waiting for deployment spec update to be observed... +Waiting for rollout to finish: 2 out of 3 new replicas have been updated... +deployment nginx-deployment successfully rolled out +``` + ```shell $ kubectl get rs NAME DESIRED CURRENT AGE @@ -465,6 +501,10 @@ template is different than `.spec.template` or if the total number of such Pods exceeds `.spec.replicas`. It will bring up new Pods with `.spec.template` if number of Pods are less than the desired number. +Note that you should not create other pods whose labels match this selector, either directly, via another Deployment or via another controller such as Replica Sets or Replication Controllers. Otherwise, the Deployment will think that those pods were created by it. Kubernetes will not stop you from doing this. + +If you have multiple controllers that have overlapping selectors, the controllers will fight with each others and won't behave correctly. + ### Strategy `.spec.strategy` specifies the strategy used to replace old Pods by new ones. @@ -533,7 +573,12 @@ To learn more about when a Pod is considered ready, see [Container Probes](/docs ### Revision History Limit -`.spec.revisionHistoryLimit` is an optional field that specifies the number of old Replica Sets to retain to allow rollback. All old Replica Sets will be kept by default, if this field is not set. The configuration of each Deployment revision is stored in its Replica Sets; therefore, once an old Replica Set is deleted, you lose the ability to rollback to that revision of Deployment. +A deployment's revision history is stored in the replica sets it controls. + +`.spec.revisionHistoryLimit` is an optional field that specifies the number of old Replica Sets to retain to allow rollback. Its ideal value depends on the frequency and stability of new deployments. All old Replica Sets will be kept by default, consuming resources in `etcd` and crowding the output of `kubectl get rs`, if this field is not set. The configuration of each Deployment revision is stored in its Replica Sets; therefore, once an old Replica Set is deleted, you lose the ability to rollback to that revision of Deployment. + +More specifically, setting this field to zero means that all old replica sets with 0 replica will be cleaned up. +In this case, a new deployment rollout cannot be undone, since its revision history is cleaned up. ### Paused diff --git a/docs/user-guide/docker-cli-to-kubectl.md b/docs/user-guide/docker-cli-to-kubectl.md index 62c763c0e6..8438b2b356 100644 --- a/docs/user-guide/docker-cli-to-kubectl.md +++ b/docs/user-guide/docker-cli-to-kubectl.md @@ -1,4 +1,9 @@ --- +assignees: +- bgrant0607 +- brendandburns +- thockin + --- In this doc, we introduce the Kubernetes command line for interacting with the api to docker-cli users. The tool, kubectl, is designed to be familiar to docker-cli users but there are a few necessary differences. Each section of this doc highlights a docker subcommand explains the kubectl equivalent. diff --git a/docs/user-guide/downward-api/OWNERS b/docs/user-guide/downward-api/OWNERS new file mode 100644 index 0000000000..765ab1a957 --- /dev/null +++ b/docs/user-guide/downward-api/OWNERS @@ -0,0 +1,4 @@ +assignees: +- bgrant0607 +- mikedanese + diff --git a/docs/user-guide/downward-api/README.md b/docs/user-guide/downward-api/README.md index 93c5e6f5dc..00a27bdcb0 100644 --- a/docs/user-guide/downward-api/README.md +++ b/docs/user-guide/downward-api/README.md @@ -1,5 +1,5 @@ -Following this example, you will create a pod with a container that consumes the pod's name and -namespace using the [downward API](http://kubernetes.io/docs/user-guide/downward-api/). +Following these examples, you will create a pod with a container that consumes the pod's name, +namespace, and resource values using the [downward API](http://kubernetes.io/docs/user-guide/downward-api/). ## Step Zero: Prerequisites @@ -29,4 +29,25 @@ $ kubectl logs dapi-test-pod | grep POD_ 2015-04-30T20:22:18.568024817Z MY_POD_NAME=dapi-test-pod 2015-04-30T20:22:18.568087688Z MY_POD_NAMESPACE=default 2015-04-30T20:22:18.568092435Z MY_POD_IP=10.0.1.6 -``` \ No newline at end of file +``` + +## Example of environment variables with container resources + +Use the [`dapi-container-resources.yaml`](dapi-container-resources.yaml) file to create a Pod +with a container that consumes the downward API exposing the container's resources. + +```shell +$ kubectl create -f docs/user-guide/downward-api/dapi-container-resources.yaml +``` + +### Examine the logs + +Grep through the pod logs to see that the pod was injected with the correct values: + +```shell +$ kubectl logs dapi-test-pod | grep MY_ +MY_MEM_LIMIT=67108864 +MY_CPU_LIMIT=1 +MY_MEM_REQUEST=33554432 +MY_CPU_REQUEST=1 +``` diff --git a/docs/user-guide/downward-api/dapi-container-resources.yaml b/docs/user-guide/downward-api/dapi-container-resources.yaml new file mode 100644 index 0000000000..2a3abb0145 --- /dev/null +++ b/docs/user-guide/downward-api/dapi-container-resources.yaml @@ -0,0 +1,34 @@ +apiVersion: v1 +kind: Pod +metadata: + name: dapi-test-pod +spec: + containers: + - name: test-container + image: gcr.io/google_containers/busybox:1.24 + command: [ "/bin/sh", "-c", "env" ] + resources: + requests: + memory: "32Mi" + cpu: "125m" + limits: + memory: "64Mi" + cpu: "250m" + env: + - name: MY_CPU_REQUEST + valueFrom: + resourceFieldRef: + resource: requests.cpu + - name: MY_CPU_LIMIT + valueFrom: + resourceFieldRef: + resource: limits.cpu + - name: MY_MEM_REQUEST + valueFrom: + resourceFieldRef: + resource: requests.memory + - name: MY_MEM_LIMIT + valueFrom: + resourceFieldRef: + resource: limits.memory + restartPolicy: Never diff --git a/docs/user-guide/downward-api/index.md b/docs/user-guide/downward-api/index.md index bbc0bf58f0..85221fab84 100644 --- a/docs/user-guide/downward-api/index.md +++ b/docs/user-guide/downward-api/index.md @@ -1,4 +1,8 @@ --- +assignees: +- bgrant0607 +- mikedanese + --- It is sometimes useful for a container to have information about itself, but we @@ -21,6 +25,10 @@ The following information is available to a `Pod` through the downward API: * The pod's name * The pod's namespace * The pod's IP +* A container's cpu limit +* A container's cpu request +* A container's memory limit +* A container's memory request More information will be exposed through this same API over time. @@ -31,13 +39,15 @@ Containers consume information from the downward API using environment variables or using a volume plugin. -### Environment variables +## Environment variables Most environment variables in the Kubernetes API use the `value` field to carry simple values. However, the alternate `valueFrom` field allows you to specify -a `fieldRef` to select fields from the pod's definition. The `fieldRef` field -is a structure that has an `apiVersion` field and a `fieldPath` field. The -`fieldPath` field is an expression designating a field of the pod. The +a `fieldRef` to select fields from the pod's definition, and a `resourceFieldRef` +to select fields from one of its container's definition. + +The `fieldRef` field is a structure that has an `apiVersion` field and a `fieldPath` +field. The `fieldPath` field is an expression designating a field of the pod. The `apiVersion` field is the version of the API schema that the `fieldPath` is written in terms of. If the `apiVersion` field is not specified it is defaulted to the API version of the enclosing object. @@ -46,20 +56,39 @@ The `fieldRef` is evaluated and the resulting value is used as the value for the environment variable. This allows users to publish their pod's name in any environment variable they want. +The `resourceFieldRef` is a structure that has a `containerName` field, a `resource` +field, and a `divisor` field. The `containerName` is the name of a container, +whose resource (cpu or memory) information is to be exposed. The `containerName` is +optional for environment variables and defaults to the current container. The +`resource` field is an expression designating a resource in a container, and the `divisor` +field specifies an output format of the resource being exposed. If the `divisor` +is not specified, it defaults to "1" for cpu and memory. The table shows possible +values for cpu and memory resources for `resource` and `divisor` settings: -## Example + +| Setting | Cpu | Memory | +| ------------- |-------------| -----| +| resource | limits.cpu, requests.cpu| limits.memory, requests.memory| +| divisor | 1(cores), 1m(millicores) | 1(bytes), 1k(kilobytes), 1M(megabytes), 1G(gigabytes), 1T(terabytes), 1P(petabytes), 1E(exabytes), 1Ki(kibibyte), 1Mi(mebibyte), 1Gi(gibibyte), 1Ti(tebibyte), 1Pi(pebibyte), 1Ei(exbibyte)| + + +### Example This is an example of a pod that consumes its name and namespace via the downward API: {% include code.html language="yaml" file="dapi-pod.yaml" ghlink="/docs/user-guide/downward-api/dapi-pod.yaml" %} +This is an example of a pod that consumes its container's resources via the downward API: -### Downward API volume +{% include code.html language="yaml" file="dapi-container-resources.yaml" ghlink="/docs/user-guide/downward-api/dapi-container-resources.yaml" %} + +## Downward API volume Using a similar syntax it's possible to expose pod information to containers using plain text files. Downward API are dumped to a mounted volume. This is achieved using a `downwardAPI` volume type and the different items represent the files to be created. `fieldPath` references the field to be exposed. +For exposing a container's resources limits and requests, `containerName` must be specified with `resourceFieldRef`. Downward API volume permits to store more complex data like [`metadata.labels`](/docs/user-guide/labels) and [`metadata.annotations`](/docs/user-guide/annotations). Currently key/value pair set fields are saved using `key="value"` format: @@ -76,19 +105,31 @@ Downward API volumes can expose: * The pod's namespace * The pod's labels * The pod's annotations +* A container's cpu limit +* A container's cpu request +* A container's memory limit +* A container's memory request The downward API volume refreshes its data in step with the kubelet refresh loop. When labels will be modifiable on the fly without respawning the pod containers will be able to detect changes through mechanisms such as [inotify](https://en.wikipedia.org/wiki/Inotify). In future, it will be possible to specify a specific annotation or label. -## Example +### Example This is an example of a pod that consumes its labels and annotations via the downward API volume, labels and annotations are dumped in `/etc/labels` and in `/etc/annotations`, respectively: {% include code.html language="yaml" file="volume/dapi-volume.yaml" ghlink="/docs/user-guide/downward-api/volume/dapi-volume.yaml" %} +This is an example of a pod that consumes its container's resources via the downward API volume. + +{% include code.html language="yaml" file="volume/dapi-volume-resources.yaml" ghlink="/docs/user-guide/downward-api/volume/dapi-volume-resources.yaml" %} Some more thorough examples: + * [environment variables](/docs/user-guide/environment-guide/) * [downward API](/docs/user-guide/downward-api/) + +## Default values for container resource limits + +If cpu and memory limits are not specified for a container, the downward API will default to node's cpu and memory capacities. diff --git a/docs/user-guide/downward-api/volume/dapi-volume-resources.yaml b/docs/user-guide/downward-api/volume/dapi-volume-resources.yaml new file mode 100644 index 0000000000..f28bb99e3f --- /dev/null +++ b/docs/user-guide/downward-api/volume/dapi-volume-resources.yaml @@ -0,0 +1,40 @@ +apiVersion: v1 +kind: Pod +metadata: + name: kubernetes-downwardapi-volume-example +spec: + containers: + - name: client-container + image: gcr.io/google_containers/busybox:1.24 + command: ["sh", "-c", "while true; do echo; if [[ -e /etc/cpu_limit ]]; then cat /etc/cpu_limit; fi; if [[ -e /etc/cpu_request ]]; then cat /etc/cpu_request; fi; if [[ -e /etc/mem_limit ]]; then cat /etc/mem_limit; fi; if [[ -e /etc/mem_request ]]; then cat /etc/mem_request; fi; sleep 5; done"] + resources: + requests: + memory: "32Mi" + cpu: "125m" + limits: + memory: "64Mi" + cpu: "250m" + volumeMounts: + - name: podinfo + mountPath: /etc + readOnly: false + volumes: + - name: podinfo + downwardAPI: + items: + - path: "cpu_limit" + resourceFieldRef: + containerName: client-container + resource: limits.cpu + - path: "cpu_request" + resourceFieldRef: + containerName: client-container + resource: requests.cpu + - path: "mem_limit" + resourceFieldRef: + containerName: client-container + resource: limits.memory + - path: "mem_request" + resourceFieldRef: + containerName: client-container + resource: requests.memory diff --git a/docs/user-guide/downward-api/volume/index.md b/docs/user-guide/downward-api/volume/index.md index 446d8eb563..46f54d0776 100644 --- a/docs/user-guide/downward-api/volume/index.md +++ b/docs/user-guide/downward-api/volume/index.md @@ -2,7 +2,7 @@ --- Following this example, you will create a pod with a downward API volume. -A downward API volume is a k8s volume plugin with the ability to save some pod information in a plain text file. The pod information can be for example some [metadata](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#metadata). +A downward API volume is a k8s volume plugin with the ability to save some pod information in a plain text file. The pod information can be for example some [metadata](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#metadata) or a container's [resources](/docs/user-guide/compute-resources). Supported metadata fields: @@ -11,13 +11,20 @@ Supported metadata fields: 3. `metadata.name` 4. `metadata.labels` +Supported container's resources: + +1. `limits.cpu` +2. `limits.memory` +3. `requests.cpu` +4. `requests.memory` + ### Step Zero: Prerequisites This example assumes you have a Kubernetes cluster installed and running, and the `kubectl` command line tool somewhere in your path. Please see the [gettingstarted](/docs/getting-started-guides/) for installation instructions for your platform. ### Step One: Create the pod -Use the `docs/user-guide/downward-api/dapi-volume.yaml` file to create a Pod with a  downward API volume which stores pod labels and pod annotations to `/etc/labels` and  `/etc/annotations` respectively. +Use the [dapi-volume.yaml](/docs/user-guide/downward-api/volume/dapi-volume.yaml) file to create a Pod with a downward API volume which stores pod labels and pod annotations to `/etc/labels` and `/etc/annotations` respectively. ```shell $ kubectl create -f docs/user-guide/downward-api/volume/dapi-volume.yaml @@ -46,21 +53,66 @@ In pod's `/etc` directory one may find the file created by the plugin (system fi $ kubectl exec kubernetes-downwardapi-volume-example -i -t -- sh / # ls -laR /etc /etc: -total 32 -drwxrwxrwt 3 0 0 180 Aug 24 13:03 . -drwxr-xr-x 1 0 0 4096 Aug 24 13:05 .. -drwx------ 2 0 0 80 Aug 24 13:03 ..2015_08_24_13_03_44259413923 -lrwxrwxrwx 1 0 0 30 Aug 24 13:03 ..downwardapi -> ..2015_08_24_13_03_44259413923 -lrwxrwxrwx 1 0 0 25 Aug 24 13:03 annotations -> ..downwardapi/annotations -lrwxrwxrwx 1 0 0 20 Aug 24 13:03 labels -> ..downwardapi/labels +total 4 +drwxrwxrwt 3 0 0 120 Jun 1 19:55 . +drwxr-xr-x 17 0 0 4096 Jun 1 19:55 .. +drwxr-xr-x 2 0 0 80 Jun 1 19:55 ..6986_01_06_15_55_10.473583074 +lrwxrwxrwx 1 0 0 31 Jun 1 19:55 ..data -> ..6986_01_06_15_55_10.473583074 +lrwxrwxrwx 1 0 0 18 Jun 1 19:55 annotations -> ..data/annotations +lrwxrwxrwx 1 0 0 13 Jun 1 19:55 labels -> ..data/labels -/etc/..2015_08_24_13_03_44259413923: +/etc/..6986_01_06_15_55_10.473583074: total 8 -drwx------ 2 0 0 80 Aug 24 13:03 . -drwxrwxrwt 3 0 0 180 Aug 24 13:03 .. --rw-r--r-- 1 0 0 115 Aug 24 13:03 annotations --rw-r--r-- 1 0 0 53 Aug 24 13:03 labels +drwxr-xr-x 2 0 0 80 Jun 1 19:55 . +drwxrwxrwt 3 0 0 120 Jun 1 19:55 .. +-rw-r--r-- 1 0 0 129 Jun 1 19:55 annotations +-rw-r--r-- 1 0 0 59 Jun 1 19:55 labels / # ``` -The file `labels` is stored in a temporary directory (`..2015_08_24_13_03_44259413923` in the example above) which is symlinked to by `..downwardapi`. Symlinks for annotations and labels in `/etc` point to files containing the actual metadata through the `..downwardapi` indirection.  This structure allows for dynamic atomic refresh of the metadata: updates are written to a new temporary directory, and the `..downwardapi` symlink is updated atomically using `rename(2)`. \ No newline at end of file +The file `labels` is stored in a temporary directory (`..6986_01_06_15_55_10.473583074` in the example above) which is symlinked to by `..data`. Symlinks for annotations and labels in `/etc` point to files containing the actual metadata through the `..data` indirection.  This structure allows for dynamic atomic refresh of the metadata: updates are written to a new temporary directory, and the `..data` symlink is updated atomically using `rename(2)`. + +## Example of downward API volume with container resources + +Use the `docs/user-guide/downward-api/volume/dapi-volume-resources.yaml` file to create a Pod with a downward API volume which stores its container's limits and requests in /etc. + +```shell +$ kubectl create -f docs/user-guide/downward-api/volume/dapi-volume-resources.yaml +``` + +### Examine pod/container output + +In pod's `/etc` directory one may find the files created by the plugin: + +```shell +$ kubectl exec kubernetes-downwardapi-volume-example -i -t -- sh +/ # ls -alR /etc +/etc: +total 4 +drwxrwxrwt 3 0 0 160 Jun 1 19:47 . +drwxr-xr-x 17 0 0 4096 Jun 1 19:48 .. +drwxr-xr-x 2 0 0 120 Jun 1 19:47 ..6986_01_06_15_47_23.076909525 +lrwxrwxrwx 1 0 0 31 Jun 1 19:47 ..data -> ..6986_01_06_15_47_23.076909525 +lrwxrwxrwx 1 0 0 16 Jun 1 19:47 cpu_limit -> ..data/cpu_limit +lrwxrwxrwx 1 0 0 18 Jun 1 19:47 cpu_request -> ..data/cpu_request +lrwxrwxrwx 1 0 0 16 Jun 1 19:47 mem_limit -> ..data/mem_limit +lrwxrwxrwx 1 0 0 18 Jun 1 19:47 mem_request -> ..data/mem_request + +/etc/..6986_01_06_15_47_23.076909525: +total 16 +drwxr-xr-x 2 0 0 120 Jun 1 19:47 . +drwxrwxrwt 3 0 0 160 Jun 1 19:47 .. +-rw-r--r-- 1 0 0 1 Jun 1 19:47 cpu_limit +-rw-r--r-- 1 0 0 1 Jun 1 19:47 cpu_request +-rw-r--r-- 1 0 0 8 Jun 1 19:47 mem_limit +-rw-r--r-- 1 0 0 8 Jun 1 19:47 mem_request + +/ # cat /etc/cpu_limit +1 +/ # cat /etc/mem_limit +67108864 +/ # cat /etc/cpu_request +1 +/ # cat /etc/mem_request +33554432 +``` diff --git a/docs/user-guide/environment-guide/OWNERS b/docs/user-guide/environment-guide/OWNERS new file mode 100644 index 0000000000..9451be867c --- /dev/null +++ b/docs/user-guide/environment-guide/OWNERS @@ -0,0 +1,3 @@ +assignees: +- mikedanese + diff --git a/docs/user-guide/environment-guide/index.md b/docs/user-guide/environment-guide/index.md index 4b5ec7e309..09657be4fc 100644 --- a/docs/user-guide/environment-guide/index.md +++ b/docs/user-guide/environment-guide/index.md @@ -1,4 +1,7 @@ --- +assignees: +- mikedanese + --- This example demonstrates running pods, replication controllers, and diff --git a/docs/user-guide/federation/OWNERS b/docs/user-guide/federation/OWNERS new file mode 100644 index 0000000000..b80f6a32f5 --- /dev/null +++ b/docs/user-guide/federation/OWNERS @@ -0,0 +1,3 @@ +assignees: +- quinton-hoole + diff --git a/docs/user-guide/federation/federated-services.md b/docs/user-guide/federation/federated-services.md new file mode 100644 index 0000000000..29137faddb --- /dev/null +++ b/docs/user-guide/federation/federated-services.md @@ -0,0 +1,382 @@ +--- +assignees: +- bprashanth +- quinton-hoole + +--- + +This guide explains how to use Kubernetes Federated Services to deploy +a common Service across multiple Kubernetes clusters. This makes it +easy to achieve cross-cluster service discovery and availibility zone +fault tolerance for your Kubernetes applications. + + +* TOC +{:toc} + +## Prerequisites + +This guide assumes that you have a running Kubernetes Cluster +Federation installation. If not, then head over to the +[federation admin guide](/docs/admin/federation/) to learn how to +bring up a cluster federation (or have your cluster administrator do +this for you). Other tutorials, for example +[this one](https://github.com/kelseyhightower/kubernetes-cluster-federation) +by Kelsey Hightower, are also available to help you. + +You are also expected to have a basic +[working knowledge of Kubernetes](/docs/getting-started-guides/) in +general, and [Services](/docs/user-guide/services/) in particular. + +## Overview + +Federated Services are created in much that same way as traditional +[Kubernetes Services](/docs/user-guide/services/) by making an API +call which specifies the desired properties of your service. In the +case of Federated Services, this API call is directed to the +Federation API endpoint, rather than a Kubernetes cluster API +endpoint. The API for Federated Services is 100% compatible with the +API for traditional Kubernetes Services. + +Once created, the Federated Service automatically: + +1. creates matching Kubernetes Services in every cluster underlying your Cluster Federation, +2. monitors the health of those service "shards" (and the clusters in which they reside), and +3. manages a set of DNS records in a public DNS provder (like Google Cloud DNS, or AWS Route 53), thus ensuring that clients +of your federated service can seamlessly locate an appropriate healthy service endpoint at all times, even in the event of cluster, +availability zone or regional outages. + +Clients inside your federated Kubernetes clusters (i.e. Pods) will +automatically find the local shard of the Federated Service in their +cluster if it exists and is healthy, or the closest healthy shard in a +different cluster if it does not. + +## Hybrid cloud capabilities + +Federations of Kubernetes Clusters can include clusters running in +different cloud providers (e.g. Google Cloud, AWS), and on-premises +(e.g. on OpenStack). Simply create all of the clusters that you +require, in the appropriate cloud providers and/or locations, and +register each cluster's API endpoint and credentials with your +Federation API Server (See the +[federation admin guide](/docs/admin/federation/) for details). + +Thereafter, your applications and services can span different clusters +and cloud providers as described in more detail below. + +## Creating a federated service + +This is done in the usual way, for example: + +``` shell +kubectl --context=federation-cluster create -f services/nginx.yaml +``` + +The '--context=federation-cluster' flag tells kubectl to submit the +request to the Federation API endpoint, with the appropriate +credentials. If you have not yet configured such a context, visit the +[federation admin guide](/docs/admin/federation/) or one of the +[administration tutorials](https://github.com/kelseyhightower/kubernetes-cluster-federation) +to find out how to do so. + +As described above, the Federated Service will automatically create +and maintain matching Kubernetes services in all of the clusters +underlying your federation. + +You can verify this by checking in each of the underlying clusters, for example: + +``` shell +kubectl --context=gce-asia-east1a get services nginx +NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE +nginx 10.63.250.98 104.199.136.89 80/TCP 9m +``` + +The above assumes that you have a context named 'gce-asia-east1a' +configured in your client for your cluster in that zone. The name and +namespace of the underlying services will automatically match those of +the Federated Service that you created above (and if you happen to +have had services of the same name and namespace already existing in +any of those clusters, they will be automatically adopted by the +Federation and updated to conform with the specification of your +Federated Service - either way, the end result will be the same). + +The status of your Federated Service will automatically reflect the +real-time status of the underlying Kubernetes services, for example: + +``` shell +$kubectl --context=federation-cluster describe services nginx + +Name: nginx +Namespace: default +Labels: run=nginx +Selector: run=nginx +Type: LoadBalancer +IP: +LoadBalancer Ingress: 104.197.246.190, 130.211.57.243, 104.196.14.231, 104.199.136.89, ... +Port: http 80/TCP +Endpoints: +Session Affinity: None +No events. +``` + +Note the 'LoadBalancer Ingress' addresses of your Federated Service +correspond with the 'LoadBalancer Ingress' addresses of all of the +underlying Kubernetes services (once these have been allocated - this +may take a few seconds). For inter-cluster and inter-cloud-provider +networking between service shards to work correctly, your services +need to have an externally visible IP address. [Service Type: +Loadbalancer](/docs/user-guide/services/#type-loadbalancer) +is typically used for this, although other options +(e.g. [External IP's](/docs/user-guide/services/#external-ips)) exist. + +Note also that we have not yet provisioned any backend Pods to receive +the network traffic directed to these addresses (i.e. 'Service +Endpoints'), so the Federated Service does not yet consider these to +be healthy service shards, and has accordingly not yet added their +addresses to the DNS records for this Federated Service (more on this +aspect later). + +## Adding backend pods + +To render the underlying service shards healthy, we need to add +backend Pods behind them. This is currently done directly against the +API endpoints of the underlying clusters (although in future the +Federation server will be able to do all this for you with a single +command, to save you the trouble). For example, to create backend Pods +in 13 underlying clusters: + +``` shell +for CLUSTER in asia-east1-c asia-east1-a asia-east1-b \ + europe-west1-d europe-west1-c europe-west1-b \ + us-central1-f us-central1-a us-central1-b us-central1-c \ + us-east1-d us-east1-c us-east1-b +do + kubectl --context=$CLUSTER run nginx --image=nginx:1.11.1-alpine --port=80 +done +``` + +Note that `kubectl run` automatically adds the `run=nginx` labels required to associate the backend pods with their services. + +## Verifying public DNS records + +Once the above Pods have successfully started and have begun listening +for connections, Kubernetes will report them as healthy endpoints of +the service in that cluster (via automatic health checks). The Cluster +Federation will in turn consider each of these +service 'shards' to be healthy, and place them in serving by +automatically configuring corresponding public DNS records. You can +use your preferred interface to your configured DNS provider to verify +this. For example, if your Federation is configured to use Google +Cloud DNS, and a managed DNS domain 'example.com': + +``` shell +$ gcloud dns managed-zones describe example-dot-com +creationTime: '2016-06-26T18:18:39.229Z' +description: Example domain for Kubernetes Cluster Federation +dnsName: example.com. +id: '3229332181334243121' +kind: dns#managedZone +name: example-dot-com +nameServers: +- ns-cloud-a1.googledomains.com. +- ns-cloud-a2.googledomains.com. +- ns-cloud-a3.googledomains.com. +- ns-cloud-a4.googledomains.com. +``` + +``` shell +$ gcloud dns record-sets list --zone example-dot-com +NAME TYPE TTL DATA +example.com. NS 21600 ns-cloud-e1.googledomains.com., ns-cloud-e2.googledomains.com. +example.com. SOA 21600 ns-cloud-e1.googledomains.com. cloud-dns-hostmaster.google.com. 1 21600 3600 1209600 300 +nginx.mynamespace.myfederation.svc.example.com. A 180 104.197.246.190, 130.211.57.243, 104.196.14.231, 104.199.136.89,... +nginx.mynamespace.myfederation.svc.us-central1-a.example.com. A 180 104.197.247.191 +nginx.mynamespace.myfederation.svc.us-central1-b.example.com. A 180 104.197.244.180 +nginx.mynamespace.myfederation.svc.us-central1-c.example.com. A 180 104.197.245.170 +nginx.mynamespace.myfederation.svc.us-central1-f.example.com. CNAME 180 nginx.mynamespace.myfederation.svc.us-central1.example.com. +nginx.mynamespace.myfederation.svc.us-central1.example.com. A 180 104.197.247.191, 104.197.244.180, 104.197.245.170 +nginx.mynamespace.myfederation.svc.asia-east1-a.example.com. A 180 130.211.57.243 +nginx.mynamespace.myfederation.svc.asia-east1-b.example.com. CNAME 180 nginx.mynamespace.myfederation.svc.asia-east1.example.com. +nginx.mynamespace.myfederation.svc.asia-east1-c.example.com. A 180 130.211.56.221 +nginx.mynamespace.myfederation.svc.asia-east1.example.com. A 180 130.211.57.243, 130.211.56.221 +nginx.mynamespace.myfederation.svc.europe-west1.example.com. CNAME 180 nginx.mynamespace.myfederation.svc.example.com. +nginx.mynamespace.myfederation.svc.europe-west1-d.example.com. CNAME 180 nginx.mynamespace.myfederation.svc.europe-west1.example.com. +... etc. +``` + +Note: If your Federation is configured to use AWS Route53, you can use one of the equivalent AWS tools, for example: + +``` shell +$aws route53 list-hosted-zones +``` +and +``` shell +$aws route53 list-resource-record-sets --hosted-zone-id Z3ECL0L9QLOVBX +``` + +Whatever DNS provider you use, any DNS query tool (for example 'dig' +or 'nslookup') will of course also allow you to see the records +created by the Federation for you. Note that you should either point +these tools directly at your DNS provider (e.g. `dig +@ns-cloud-e1.googledomains.com...`) or expect delays in the order of +your configured TTL (180 seconds, by default) before seeing updates, +due to caching by intermediate DNS servers. + +### Some notes about the above example + +1. Notice that there is a normal ('A') record for each service shard that has at least one healthy backend endpoint. For example in us-central1-a, 104.197.247.191 is the external IP address of the service shard in that zone, and in asia-east1-a the address is 130.211.56.221. +2. Similarly, there are regional 'A' records which include all healthy shards in that region. For example, 'us-central1'. These regional records are useful for clients which do not have a particular zone preference, and as a building block for the automated locality and failover mechanism described below. +2. For zones where there are currently no healthy backend endpoints, a CNAME ('Canonical Name') record is used to alias (automatically redirect) those queries to the next closest healthy zone. In the example, the service shard in us-central1-f currently has no healthy backend endpoints (i.e. Pods), so a CNAME record has been created to automatically redirect queries to other shards in that region (us-central1 in this case). +3. Similarly, if no healthy shards exist in the enclosing region, the search progresses further afield. In the europe-west1-d availability zone, there are no healthy backends, so queries are redirected to the broader europe-west1 region (which also has no healthy backends), and onward to the global set of healthy addresses (' nginx.mynamespace.myfederation.svc.example.com.') + +The above set of DNS records is automatically kept in sync with the +current state of health of all service shards globally by the +Federated Service system. DNS resolver libraries (which are invoked by +all clients) automatically traverse the hiearchy of 'CNAME' and 'A' +records to return the correct set of healthy IP addresses. Clients can +then select any one of the returned addresses to initiate a network +connection (and fail over automatically to one of the other equivalent +addresses if required). + +## Discovering a federated service + +### From pods inside your federated clusters + +By default, Kubernetes clusters come pre-configured with a +cluster-local DNS server ('KubeDNS'), as well as an intelligently +constructed DNS search path which together ensure that DNS queries +like "myservice", "myservice.mynamespace", +"bobsservice.othernamespace" etc issued by your software running +inside Pods are automatically expanded and resolved correctly to the +appropriate service IP of services running in the local cluster. + +With the introduction of Federated Services and Cross-Cluster Service +Discovery, this concept is extended to cover Kubernetes services +running in any other cluster across your Cluster Federation, globally. +To take advantage of this extended range, you use a slightly different +DNS name (of the form "..", +e.g. myservice.mynamespace.myfederation) to resolve Federated +Services. Using a different DNS name also avoids having your existing +applications accidentally traversing cross-zone or cross-region +networks and you incurring perhaps unwanted network charges or +latency, without you explicitly opting in to this behavior. + +So, using our NGINX example service above, and the Federated Service +DNS name form just described, let's consider an example: A Pod in a +cluster in the `us-central1-f` availability zone needs to contact our +NGINX service. Rather than use the service's traditional cluster-local +DNS name (```"nginx.mynamespace"```, which is automatically expanded +to ```"nginx.mynamespace.svc.cluster.local"```) it can now use the +service's Federated DNS name, which is +```"nginx.mynamespace.myfederation"```. This will be automatically +expanded and resolved to the closest healthy shard of my NGINX +service, wherever in the world that may be. If a healthy shard exists +in the local cluster, that service's cluster-local (typically +10.x.y.z) IP address will be returned (by the cluster-local KubeDNS). +This is almost exactly equivalent to non-federated service resolution +(almost because KubeDNS actually returns both a CNAME and an A record +for local federated services, but applications will be oblivious +to this minor technical difference). + +But if the service does not exist in the local cluster (or it exists +but has no healthy backend pods), the DNS query is automatically +expanded to +```"nginx.mynamespace.myfederation.svc.us-central1-f.example.com"``` +(i.e. logically "find the external IP of one of the shards closest to +my availability zone"). This expansion is performed automatically by +KubeDNS, which returns the associated CNAME record. This results in +automatic traversal of the hierarchy of DNS records in the above +example, and ends up at one of the external IP's of the Federated +Service in the local us-central1 region (i.e. 104.197.247.191, +104.197.244.180 or 104.197.245.170). + +It is of course possible to explicitly target service shards in +availability zones and regions other than the ones local to a Pod by +specifying the appropriate DNS names explicitly, and not relying on +automatic DNS expansion. For example, +"nginx.mynamespace.myfederation.svc.europe-west1.example.com" will +resolve to all of the currently healthy service shards in Europe, even +if the Pod issuing the lookup is located in the U.S., and irrespective +of whether or not there are healthy shards of the service in the U.S. +This is useful for remote monitoring and other similar applications. + +### From other clients outside your federated clusters + +Much of the above discussion applies equally to external clients, +except that the automatic DNS expansion described is no longer +possible. So external clients need to specify one of the fully +qualified DNS names of the Federated Service, be that a zonal, +regional or global name. For convenience reasons, it is often a good +idea to manually configure additional static CNAME records in your +service, for example: + +``` shell +eu.nginx.acme.com CNAME nginx.mynamespace.myfederation.svc.europe-west1.example.com. +us.nginx.acme.com CNAME nginx.mynamespace.myfederation.svc.us-central1.example.com. +nginx.acme.com CNAME nginx.mynamespace.myfederation.svc.example.com. +``` +That way your clients can always use the short form on the left, and +always be automatcally routed to the closest healthy shard on their +home continent. All of the required failover is handled for you +automatically by Kubernetes Cluster Federation. Future releases will +improve upon this even further. + +## Handling failures of backend pods and whole clusters + +Standard Kubernetes service cluster-IP's already ensure that +non-responsive individual Pod endpoints are automatically taken out of +service with low latency (a few seconds). In addition, as alluded +above, the Kubernetes Cluster Federation system automatically monitors +the health of clusters and the endpoints behind all of the shards of +your Federated Service, taking shards in and out of service as +required (e.g. when all of the endpoints behind a service, or perhaps +the entire cluster or availability zone go down, or conversely recover +from an outage). Due to the latency inherent in DNS caching (the cache +timeout, or TTL for Federated Service DNS records is configured to 3 +minutes, by default, but can be adjusted), it may take up to that long +for all clients to completely fail over to an alternative cluster in +the case of catastrophic failure. However, given the number of +discrete IP addresses which can be returned for each regional service +endpoint (see e.g. us-central1 above, which has three alternatives) +many clients will fail over automatically to one of the alternative +IP's in less time than that given appropriate configuration. + +## Troubleshooting + +#### I cannot connect to my cluster federation API +Check that your + +1. Client (typically kubectl) is correctly configured (including API endpoints and login credentials), and +2. Cluster Federation API server is running and network-reachable. + +See the [federation admin guide](/docs/admin/federation/) to learn +how to bring up a cluster federation correctly (or have your cluster administrator do this for you), and how to correctly configure your client. + +#### I can create a federated service successfully against the cluster federation API, but no matching services are created in my underlying clusters +Check that: + +1. Your clusters are correctly registered in the Cluster Federation API (`kubectl describe clusters`) +2. Your clusters are all 'Active'. This means that the cluster Federation system was able to connect and authenticate against the clusters' endpoints. If not, consult the logs of the federation-controller-manager pod to ascertain what the failure might be. (`kubectl --namespace=federation logs $(kubectl get pods --namespace=federation -l module=federation-controller-manager -oname`) +3. That the login credentials provided to the Cluster Federation API for the clusters have the correct authorization and quota to create services in the relevant namespace in the clusters. Again you should see associated error messages providing more detail in the above log file if this is not the case. +4. Whether any other error is preventing the service creation operation from succeeding (look for `service-controller` errors in the output of `kubectl logs federation-controller-manager --namespace federation`). + +#### I can create a federated service successfully, but no matching DNS records are created in my DNS provider. +Check that: + +1. Your federation name, DNS provider, DNS domain name are configured correctly. Consult the [federation admin guide](/docs/admin/federation/) or [tutorial](https://github.com/kelseyhightower/kubernetes-cluster-federation) to learn +how to configure your Cluster Federation system's DNS provider (or have your cluster administrator do this for you). +2. Confirm that the Cluster Federation's service-controller is successfully connecting to and authenticating against your selected DNS provider (look for `service-controller` errors or successes in the output of `kubectl logs federation-controller-manager --namespace federation`) +3. Confirm that the Cluster Federation's service-controller is successfully creating DNS records in your DNS provider (or outputting errors in it's logs explaining in more detail what's failing). + +#### Matching DNS records are created in my DNS provider, but clients are unable to resolve against those names +Check that: + +1. The DNS registrar that manages your federation DNS domain has been correctly configured to point to your configured DNS provider's nameservers. See for example [Google Domains Documentation](https://support.google.com/domains/answer/3290309?hl=en&ref_topic=3251230) and [Google Cloud DNS Documentation](https://cloud.google.com/dns/update-name-servers), or equivalent guidance from your domain registrar and DNS provider. + +#### This troubleshooting guide did not help me solve my problem + +1. Please use one of our [support channels](http://kubernetes.io/docs/troubleshooting/) to seek assistance. + +## For more information + + * [Federation proposal](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/proposals/federation.md) details use cases that motivated this work. diff --git a/docs/user-guide/garbage-collector.md b/docs/user-guide/garbage-collector.md new file mode 100644 index 0000000000..e31855ac41 --- /dev/null +++ b/docs/user-guide/garbage-collector.md @@ -0,0 +1,30 @@ +--- +assignees: +- caesarxuchao +- mikedanese + +--- + +* TOC +{:toc} + +## WARNING: Garbage Collector is an alpha feature and is disabled by default. Use it at your own risk! + +### What is garbage collector for + +The garbage collector (GC) cascadingly deletes dependent API objects when the owner is deleted. One use case is if two objects have functional dependency, you can specify the dependency in their configuration file when creating them, and if one of them is deleted, the GC will delete the other one automatically. The other use case is if there is logical dependency among API objects, e.g., the pods created by a replicaset depending on the replicaset, Kubernetes will automatically set the dependency (this will be implemented in release 1.4) and the GC will delete the pods when the replicaset is deleted. + +### How does the garbage collector work + +In release 1.3, there is a new `ownerReferences` field in the `metadata` of every Kubernetes API objects. The GC monitors the cluster and checks the `metadata.ownerReferences` field of each object. If none of the owners present in `metadata.ownerReferences` exists in the cluster, the GC will request the API server to delete the object. + +Currently a user needs to manually set the `metadata.ownerReferences`. In release 1.4, controllers will automatically set the field for the objects it controls. For example, when the replicaset controller creates or adopts pods, it will automatically add the replicaset to the `metadata.ownerReferences` fields of the pods. + +### How to request the garbage collector to not delete dependents + +When deleting an object, you can prevent the GC from deleting that object's dependents by specifying `deleteOptions.orphanDependents=true` in the deletion request. It prevents garbage collection by removing the object from its dependents' metadata.ownerReferences field. + +### How to enable the garbage collector + +The garbage collector is an alpha feature so it is disabled by default. To enable it, you need to start the kube-apiserver and kube-controller-manager with flag `--enable-garbage-collector`. + diff --git a/docs/user-guide/getting-into-containers.md b/docs/user-guide/getting-into-containers.md index 94e25f580c..25f0f5a3e4 100644 --- a/docs/user-guide/getting-into-containers.md +++ b/docs/user-guide/getting-into-containers.md @@ -1,5 +1,9 @@ ---- ---- +--- +assignees: +- caesarxuchao +- mikedanese + +--- Developers can use `kubectl exec` to run commands in a container. This guide demonstrates two use cases. @@ -9,28 +13,28 @@ Kubernetes exposes [services](/docs/user-guide/services/#environment-variables) We first create a pod and a service, -```shell +```shell $ kubectl create -f examples/guestbook/redis-master-controller.yaml $ kubectl create -f examples/guestbook/redis-master-service.yaml -``` +``` wait until the pod is Running and Ready, -```shell +```shell $ kubectl get pod NAME READY REASON RESTARTS AGE redis-master-ft9ex 1/1 Running 0 12s -``` - +``` + then we can check the environment variables of the pod, -```shell +```shell $ kubectl exec redis-master-ft9ex env ... REDIS_MASTER_SERVICE_PORT=6379 REDIS_MASTER_SERVICE_HOST=10.0.0.219 ... -``` - +``` + We can use these environment variables in applications to find the service. @@ -39,32 +43,32 @@ We can use these environment variables in applications to find the service. It is convenient to use `kubectl exec` to check if the volumes are mounted as expected. We first create a Pod with a volume mounted at /data/redis, -```shell +```shell kubectl create -f docs/user-guide/walkthrough/pod-redis.yaml -``` - +``` + wait until the pod is Running and Ready, -```shell +```shell $ kubectl get pods NAME READY REASON RESTARTS AGE storage 1/1 Running 0 1m -``` - +``` + we then use `kubectl exec` to verify that the volume is mounted at /data/redis, -```shell +```shell $ kubectl exec storage ls /data redis -``` - +``` + ## Using kubectl exec to open a bash terminal in a pod After all, open a terminal in a pod is the most direct way to introspect the pod. Assuming the pod/storage is still running, run -```shell +```shell $ kubectl exec -ti storage -- bash root@storage:/data# -``` - +``` + This gets you a terminal. \ No newline at end of file diff --git a/docs/user-guide/horizontal-pod-autoscaling/OWNERS b/docs/user-guide/horizontal-pod-autoscaling/OWNERS new file mode 100644 index 0000000000..e15675e415 --- /dev/null +++ b/docs/user-guide/horizontal-pod-autoscaling/OWNERS @@ -0,0 +1,5 @@ +assignees: +- fgrzadkowski +- janetkuo +- jszczepkowski + diff --git a/docs/user-guide/horizontal-pod-autoscaling/index.md b/docs/user-guide/horizontal-pod-autoscaling/index.md index 8c98d9beb7..181c1ba5f7 100644 --- a/docs/user-guide/horizontal-pod-autoscaling/index.md +++ b/docs/user-guide/horizontal-pod-autoscaling/index.md @@ -1,20 +1,24 @@ --- +assignees: +- fgrzadkowski +- jszczepkowski + --- -This document describes the current state of Horizontal Pod Autoscaler in Kubernetes. +This document describes the current state of Horizontal Pod Autoscaling in Kubernetes. -## What is Horizontal Pod Autoscaler? +## What is Horizontal Pod Autoscaling? -Horizontal pod autoscaling allows to automatically scale the number of pods -in a replication controller, deployment or replica set based on observed CPU utilization. +With Horizontal Pod Autoscaling, Kubernetes automatically scales the number of pods +in a replication controller, deployment or replica set based on observed CPU utilization +(or, with alpha support, on some other, application-provided metrics). -The autoscaler is implemented as a Kubernetes API resource and a controller. -The resource describes behavior of the controller. +The Horizontal Pod Autoscaler is implemented as a Kubernetes API resource and a controller. +The resource determines the behavior of the controller. The controller periodically adjusts the number of replicas in a replication controller or deployment to match the observed average CPU utilization to the target specified by user. - -## How does Horizontal Pod Autoscaler work? +## How does the Horizontal Pod Autoscaler work? ![Horizontal Pod Autoscaler diagram](/images/docs/horizontal-pod-autoscaler.svg) @@ -29,34 +33,34 @@ Please note that if some of the pod's containers do not have CPU request set, CPU utilization for the pod will not be defined and the autoscaler will not take any action. Further details of the autoscaling algorithm are given [here](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/horizontal-pod-autoscaler.md#autoscaling-algorithm). -Autoscaler uses heapster to collect CPU utilization. +The autoscaler uses heapster to collect CPU utilization. Therefore, it is required to deploy heapster monitoring in your cluster for autoscaling to work. -Autoscaler accesses corresponding replication controller, deployment or replica set by scale sub-resource. +The autoscaler accesses corresponding replication controller, deployment or replica set by scale sub-resource. Scale is an interface which allows to dynamically set the number of replicas and to learn the current state of them. More details on scale sub-resource can be found [here](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/horizontal-pod-autoscaler.md#scale-subresource). ## API Object -Horizontal pod autoscaler is a top-level resource in the Kubernetes REST API. +Horizontal Pod Autoscaler is a top-level resource in the Kubernetes REST API. In Kubernetes 1.2 HPA was graduated from beta to stable (more details about [api versioning](/docs/api/#api-versioning)) with compatibility between versions. -The stable version is available in `autoscaling/v1` api group whereas the beta vesion is available in `extensions/v1beta1` api group as before. -The transition plan is to depracate beta version of HPA in Kubernetes 1.3 and get it rid off completely in Kubernetes 1.4. +The stable version is available in the `autoscaling/v1` api group whereas the beta vesion is available in the `extensions/v1beta1` api group as before. +The transition plan is to deprecate beta version of HPA in Kubernetes 1.3, and get it rid off completely in Kubernetes 1.4. -**Warning!** Please have in mind that all Kubernetes components still use HPA in version `extensions/v1beta1` in Kubernetes 1.2. +**Warning!** Please have in mind that all Kubernetes components still use HPA in `extensions/v1beta1` in Kubernetes 1.2. More details about the API object can be found at [HorizontalPodAutoscaler Object](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/horizontal-pod-autoscaler.md#horizontalpodautoscaler-object). -## Support for horizontal pod autoscaler in kubectl +## Support for Horizontal Pod Autoscaler in kubectl -Horizontal pod autoscaler, like every API resource, is supported in a standard way by `kubectl`. +Horizontal Pod Autoscaler, like every API resource, is supported in a standard way by `kubectl`. We can create a new autoscaler using `kubectl create` command. We can list autoscalers by `kubectl get hpa` and get detailed description by `kubectl describe hpa`. Finally, we can delete an autoscaler using `kubectl delete hpa`. -In addition, there is a special `kubectl autoscale` command that allows for easy creation of horizontal pod autoscaler. +In addition, there is a special `kubectl autoscale` command for easy creation of a Horizontal Pod Autoscaler. For instance, executing `kubectl autoscale rc foo --min=2 --max=5 --cpu-percent=80` will create an autoscaler for replication controller *foo*, with target CPU utilization set to `80%` and the number of replicas between 2 and 5. @@ -67,17 +71,65 @@ The detailed documentation of `kubectl autoscale` can be found [here](/docs/user Currently in Kubernetes, it is possible to perform a rolling update by managing replication controllers directly, or by using the deployment object, which manages the underlying replication controllers for you. -Horizontal pod autoscaler only supports the latter approach: the horizontal pod autoscaler is bound to the deployment object, +Horizontal Pod Autoscaler only supports the latter approach: the Horizontal Pod Autoscaler is bound to the deployment object, it sets the size for the deployment object, and the deployment is responsible for setting sizes of underlying replication controllers. -Horizontal pod autoscaler does not work with rolling update using direct manipulation of replication controllers, -i.e. you cannot bind a horizontal pod autoscaler to a replication controller and do rolling update (e.g. using `kubectl rolling-update`). +Horizontal Pod Autoscaler does not work with rolling update using direct manipulation of replication controllers, +i.e. you cannot bind a Horizontal Pod Autoscaler to a replication controller and do rolling update (e.g. using `kubectl rolling-update`). The reason this doesn't work is that when rolling update creates a new replication controller, -the horizontal pod autoscaler will not be bound to the new replication controller. +the Horizontal Pod Autoscaler will not be bound to the new replication controller. +## Support for custom metrics + +Kubernetes 1.2 adds alpha support for scaling based on application-specific metrics like QPS (queries per second) or average request latency. + +### Prerequisites + +The cluster has to be started with `ENABLE_CUSTOM_METRICS` environment variable set to `true`. + +### Pod configuration + +The pods to be scaled must have cAdvisor-specific custom (aka application) metrics endpoint configured. The configuration format is described [here](https://github.com/google/cadvisor/blob/master/docs/application_metrics.md). Kubernetes expects the configuration to + be placed in `definition.json` mounted via a [config map](/docs/user-guide/horizontal-pod-autoscaling/configmap/) in `/etc/custom-metrics`. A sample config map may look like this: + +```yaml +apiVersion: v1 +kind: ConfigMap +metadata: + name: cm-config +data: + definition.json: "{\"endpoint\" : \"http://localhost:8080/metrics\"}" +``` + +**Warning** +Due to the way cAdvisor currently works `localhost` refers to the node itself, not to the running pod. Thus the appropriate container in the pod must ask for a node port. Example: + +```yaml + ports: + - hostPort: 8080 + containerPort: 8080 +``` + +### Specifying target + +HPA for custom metrics is configured via an annotation. The value in the annotation is interpreted as a target metric value averaged over +all running pods. Example: + +```yaml + annotations: + alpha/target.custom-metrics.podautoscaler.kubernetes.io: '{"items":[{"name":"qps", "value": "10"}]}' +``` + +In this case if there are 4 pods running and each of them reports qps metric to be equal to 15 HPA will start 2 additional pods so there will be 6 pods in total. If there are multiple metrics passed in the annotation or CPU is configured as well then HPA will use the biggest +number of replicas that comes from the calculations. + +At this moment even if target CPU utilization is not specified a default of 80% will be used. +To calculate number of desired replicas based only on custom metrics CPU utilization +target should be set to a very large value (e.g. 100000%). Then CPU-related logic +will want only 1 replica, leaving the decision about higher replica count to cusom metrics (and min/max limits). ## Further reading * Design documentation: [Horizontal Pod Autoscaling](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/horizontal-pod-autoscaler.md). -* Manual of autoscale command in kubectl: [kubectl autoscale](/docs/user-guide/kubectl/kubectl_autoscale). -* Usage example of [Horizontal Pod Autoscaler](/docs/user-guide/horizontal-pod-autoscaling/). +* kubectl autoscale command: [kubectl autoscale](/docs/user-guide/kubectl/kubectl_autoscale). +* Usage example of [Horizontal Pod Autoscaler](/docs/user-guide/horizontal-pod-autoscaling/walkthrough/). diff --git a/docs/user-guide/horizontal-pod-autoscaling/walkthrough.md b/docs/user-guide/horizontal-pod-autoscaling/walkthrough.md index 7089c53aec..d445b854e4 100644 --- a/docs/user-guide/horizontal-pod-autoscaling/walkthrough.md +++ b/docs/user-guide/horizontal-pod-autoscaling/walkthrough.md @@ -1,25 +1,30 @@ --- +assignees: +- fgrzadkowski +- jszczepkowski +- justinsb + --- -Horizontal pod autoscaling allows to automatically scale the number of pods -in a replication controller, deployment or replica set based on observed CPU utilization. -In the future also other metrics will be supported. +Horizontal Pod Autoscaling automatically scales the number of pods +in a replication controller, deployment or replica set based on observed CPU utilization +(or, with alpha support, on some other, application-provided metrics). -In this document we explain how this feature works by walking you through an example of enabling horizontal pod autoscaling for the php-apache server. +In this document we explain how this feature works by walking you through an example of enabling Horizontal Pod Autoscaling for the php-apache server. ## Prerequisites -This example requires a running Kubernetes cluster and kubectl in the version at least 1.2. +This example requires a running Kubernetes cluster and kubectl, version 1.2 or later. [Heapster](https://github.com/kubernetes/heapster) monitoring needs to be deployed in the cluster -as horizontal pod autoscaler uses it to collect metrics +as Horizontal Pod Autoscaler uses it to collect metrics (if you followed [getting started on GCE guide](/docs/getting-started-guides/gce), heapster monitoring will be turned-on by default). ## Step One: Run & expose php-apache server -To demonstrate horizontal pod autoscaler we will use a custom docker image based on php-apache server. +To demonstrate Horizontal Pod Autoscaler we will use a custom docker image based on the php-apache image. The image can be found [here](/docs/user-guide/horizontal-pod-autoscaling/image). -It defines [index.php](/docs/user-guide/horizontal-pod-autoscaling/image/index.php) page which performs some CPU intensive computations. +It defines an [index.php](/docs/user-guide/horizontal-pod-autoscaling/image/index.php) page which performs some CPU intensive computations. First, we will start a deployment running the image and expose it as a service: @@ -29,15 +34,15 @@ service "php-apache" created deployment "php-apache" created ``` -## Step Two: Create horizontal pod autoscaler +## Step Two: Create Horizontal Pod Autoscaler Now that the server is running, we will create the autoscaler using [kubectl autoscale](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/user-guide/kubectl/kubectl_autoscale.md). -The following command will create a horizontal pod autoscaler that maintains between 1 and 10 replicas of the Pods +The following command will create a Horizontal Pod Autoscaler that maintains between 1 and 10 replicas of the Pods controlled by the php-apache deployment we created in the first step of these instructions. -Roughly speaking, the horizontal autoscaler will increase and decrease the number of replicas +Roughly speaking, HPA will increase and decrease the number of replicas (via the deployment) to maintain an average CPU utilization across all Pods of 50% -(since each pod requests 200 milli-cores by [kubectl run](#kubectl-run), this means average CPU usage of 100 milli-cores). +(since each pod requests 200 milli-cores by [kubectl run](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/user-guide/kubectl/kubectl_run.md), this means average CPU usage of 100 milli-cores). See [here](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/horizontal-pod-autoscaler.md#autoscaling-algorithm) for more details on the algorithm. ```shell @@ -59,8 +64,8 @@ Please note that the current CPU consumption is 0% as we are not sending any req ## Step Three: Increase load -Now, we will see how the autoscaler reacts on the increased load on the server. -We will start a container with `busybox` image and an infinite loop of queries to our server inside (please run it in a different terminal): +Now, we will see how the autoscaler reacts to increased load. +We will start a container, and send an infinite loop of queries to the php-apache service (please run it in a different terminal): ```shell $ kubectl run -i --tty load-generator --image=busybox /bin/sh @@ -70,7 +75,7 @@ Hit enter for command prompt $ while true; do wget -q -O- http://php-apache.default.svc.cluster.local; done ``` -We may examine, how CPU load was increased by executing (it usually takes 1 minute): +Within a minute or so, we should see the higher CPU load by executing: ```shell $ kubectl get hpa @@ -79,7 +84,7 @@ php-apache Deployment/php-apache/scale 50% 305% 1 10 ``` -In the case presented here, it bumped CPU consumption to 305% of the request. +Here, CPU consumption has increased to 305% of the request. As a result, the deployment was resized to 7 replicas: ```shell @@ -88,7 +93,7 @@ NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE php-apache 7 7 7 7 19m ``` -**Warning!** Sometimes it may take few steps to stabilize the number of replicas. +**Note** Sometimes it may take a few minutes to stabilize the number of replicas. Since the amount of load is not controlled in any way it may happen that the final number of replicas will differ from this example. @@ -96,11 +101,10 @@ differ from this example. We will finish our example by stopping the user load. -In the terminal where we created container with `busybox` image we will terminate -infinite ``while`` loop by sending `SIGINT` signal, -which can be done using ` + C` combination. +In the terminal where we created the container with `busybox` image, terminate +the load generation by typing ` + C`. -Then we will verify the result state: +Then we will verify the result state (after a minute or so): ```shell $ kubectl get hpa @@ -112,9 +116,9 @@ NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE php-apache 1 1 1 1 27m ``` -As we see, in the presented case CPU utilization dropped to 0, and the number of replicas dropped to 1. +Here CPU utilization dropped to 0, and so HPA autoscaled the number of replicas back down to 1. -**Warning!** Sometimes dropping number of replicas may take few steps. +**Note** autoscaling the replicas may take a few minutes. ## Appendix: Other possible scenarios diff --git a/docs/user-guide/identifiers.md b/docs/user-guide/identifiers.md index b5fd025e29..e28bac0e56 100644 --- a/docs/user-guide/identifiers.md +++ b/docs/user-guide/identifiers.md @@ -1,4 +1,8 @@ --- +assignees: +- mikedanese +- thockin + --- All objects in the Kubernetes REST API are unambiguously identified by a Name and a UID. @@ -7,8 +11,8 @@ For non-unique user-provided attributes, Kubernetes provides [labels](/docs/user ## Names -Names are generally client-provided. Only one object of a given kind can have a given name at a time (i.e., they are spatially unique). But if you delete an object, you can make a new object with the same name. Names are the used to refer to an object in a resource URL, such as `/api/v1/pods/some-name`. By convention, the names of Kubernetes resources should be up to maximum length of 253 characters and consist of lower case alphanumeric characters, `-`, and `.`, but certain resources have more specific restrictions. See the [identifiers design doc](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/identifiers.md) for the precise syntax rules for names. +Names are generally client-provided. Only one object of a given kind can have a given name at a time (i.e., they are spatially unique). But if you delete an object, you can make a new object with the same name. Names are used to refer to an object in a resource URL, such as `/api/v1/pods/some-name`. By convention, the names of Kubernetes resources should be up to maximum length of 253 characters and consist of lower case alphanumeric characters, `-`, and `.`, but certain resources have more specific restrictions. See the [identifiers design doc](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/identifiers.md) for the precise syntax rules for names. ## UIDs -UID are generated by Kubernetes. Every object created over the whole lifetime of a Kubernetes cluster has a distinct UID (i.e., they are spatially and temporally unique). \ No newline at end of file +UID are generated by Kubernetes. Every object created over the whole lifetime of a Kubernetes cluster has a distinct UID (i.e., they are spatially and temporally unique). diff --git a/docs/user-guide/images.md b/docs/user-guide/images.md index 4bf4748355..c4a7b7c00a 100644 --- a/docs/user-guide/images.md +++ b/docs/user-guide/images.md @@ -1,4 +1,8 @@ --- +assignees: +- erictune +- thockin + --- Each container in a pod has its own image. Currently, the only type of image supported is a [Docker Image](https://docs.docker.com/userguide/dockerimages/). @@ -32,6 +36,9 @@ Credentials can be provided in several ways: - Per-cluster - automatically configured on Google Compute Engine or Google Container Engine - all pods can read the project's private registry + - Using AWS EC2 Container Registry (ECR) + - use IAM roles and policies to control access to ECR repositories + - automatically refreshes ECR login credentials - Configuring Nodes to Authenticate to a Private Registry - all pods can read any configured private registries - requires node configuration by cluster administrator @@ -60,7 +67,7 @@ so it can pull from the project's GCR, but not push. ### Using AWS EC2 Container Registry Kubernetes has native support for the [AWS EC2 Container -Registry](https://aws.amazon.com/ecr/), when nodes are AWS instances. +Registry](https://aws.amazon.com/ecr/), when nodes are AWS EC2 instances. Simply use the full image name (e.g. `ACCOUNT.dkr.ecr.REGION.amazonaws.com/imagename:tag`) in the Pod definition. @@ -78,11 +85,29 @@ The kubelet will fetch and periodically refresh ECR credentials. It needs the f - `ecr:ListImages` - `ecr:BatchGetImage` +Requirements: + +- You must be using kubelet version `v1.2.0` or newer. (e.g. run `/usr/bin/kubelet --version=true`). +- Your nodes must be in the same region as the registry you are using +- ECR must be offered in your region + +Troubleshooting: + +- Verify all requirements above. +- Get $REGION (e.g. `us-west-2`) credentials on your workstation. SSH into the host and run Docker manually with those creds. Does it work? +- Verify kubelet is running with `--cloud-provider=aws`. +- Check kubelet logs (e.g. `journalctl -t kubelet`) for log lines like: + - `plugins.go:56] Registering credential provider: aws-ecr-key` + - `provider.go:91] Refreshing cache for provider: *aws_credentials.ecrProvider` + ### Configuring Nodes to Authenticate to a Private Repository **Note:** if you are running on Google Container Engine (GKE), there will already be a `.dockercfg` on each node with credentials for Google Container Registry. You cannot use this approach. +**Note:** if you are running on AWS EC2 and are using the EC2 Container Registry (ECR), the kubelet on each node will +manage and update the ECR login credentials. You cannot use this approach. + **Note:** this approach is suitable if you can control node configuration. It will not work reliably on GCE, and any other cloud provider that does automatic node replacement. diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md index 71fc5ff893..44dd71f41e 100644 --- a/docs/user-guide/index.md +++ b/docs/user-guide/index.md @@ -1,4 +1,7 @@ --- +assignees: +- davidopp + --- * TOC diff --git a/docs/user-guide/ingress.md b/docs/user-guide/ingress.md index c6d63ea1f8..d80efa9bb9 100644 --- a/docs/user-guide/ingress.md +++ b/docs/user-guide/ingress.md @@ -1,4 +1,7 @@ --- +assignees: +- bprashanth + --- * TOC @@ -44,20 +47,12 @@ Before you start using the Ingress resource, there are a few things you should u On GCE/GKE there should be a [L7 cluster addon](https://github.com/kubernetes/contrib/blob/master/ingress/controllers/gce/README.md), deployed into the `kube-system` namespace: ```shell -$ kubectl get pods --namespace=kube-system -l name=glbc +$ kubectl get pods --namespace=kube-system -l k8s-app=glbc NAME READY STATUS RESTARTS AGE l7-lb-controller-v0.6.0-chnan 2/2 Running 0 1d ``` -Make sure you review the [beta limitations](https://github.com/kubernetes/contrib/tree/master/ingress/controllers/gce/BETA_LIMITATIONS.md) of this controller. In particular, you need to create a single firewall-rule on your cloudprovider, to allow health checks. On GKE this would be: - -```shell -$ gcloud compute firewall-rules create allow-130-211-0-0-22 \ - --source-ranges 130.211.0.0/22 \ - --allow tcp:30000-32767 -``` - -In environments other than GCE/GKE, you need to [deploy a controller](https://github.com/kubernetes/contrib/tree/master/ingress/controllers) as a pod. +Make sure you review the [beta limitations](https://github.com/kubernetes/contrib/tree/master/ingress/controllers/gce/BETA_LIMITATIONS.md) of this controller. In environments other than GCE/GKE, you need to [deploy a controller](https://github.com/kubernetes/contrib/tree/master/ingress/controllers) as a pod. ## The Ingress Resource @@ -94,6 +89,10 @@ __Global Parameters__: For the sake of simplicity the example Ingress has no glo In order for the Ingress resource to work, the cluster must have an Ingress controller running. This is unlike other types of controllers, which typically run as part of the `kube-controller-manager` binary, and which are typically started automatically as part of cluster creation. You need to choose the ingress controller implementation that is the best fit for your cluster, or implement one. Examples and instructions can be found [here](https://github.com/kubernetes/contrib/tree/master/ingress/controllers). +## Before you begin + +The following document describes a set of cross platform features exposed through the Ingress resource. Ideally, all Ingress controllers should fulfill this specification, but we're not there yet. The docs for the GCE and nginx controllers are [here](https://github.com/kubernetes/contrib/blob/master/ingress/controllers/gce/README.md) and [here](https://github.com/kubernetes/contrib/blob/master/ingress/controllers/nginx/README.md) respectively. **Make sure you review controller specific docs so you understand the caveats of each one**. + ## Types of Ingress ### Single Service Ingress @@ -221,11 +220,13 @@ spec: servicePort: 80 ``` +Note that there is a gap between TLS features supported by various Ingress controllers. Please refer to documentation on [nginx](https://github.com/kubernetes/contrib/tree/master/ingress/controllers/nginx#https), [GCE](https://github.com/kubernetes/contrib/tree/master/ingress/controllers/gce#tls), or any other platform specific Ingress controller to understand how TLS works in your environment. + ### Loadbalancing An Ingress controller is bootstrapped with some loadbalancing policy settings that it applies to all Ingress, such as the loadbalancing algorithm, backend weight scheme etc. More advanced loadbalancing concepts (eg: persistent sessions, dynamic weights) are not yet exposed through the Ingress. You can still get these features through the [service loadbalancer](https://github.com/kubernetes/contrib/tree/master/service-loadbalancer). With time, we plan to distill loadbalancing patterns that are applicable cross platform into the Ingress resource. -It's also worth noting that even though health checks are not exposed directly through the Ingress, there exist parallel concepts in Kubernetes such as [readiness probes](https://github.com/kubernetes/kubernetes/blob/release-1.0/docs/user-guide/production-pods.md#liveness-and-readiness-probes-aka-health-checks) which allow you to achieve the same end result. +It's also worth noting that even though health checks are not exposed directly through the Ingress, there exist parallel concepts in Kubernetes such as [readiness probes](https://github.com/kubernetes/kubernetes/blob/release-1.0/docs/user-guide/production-pods.md#liveness-and-readiness-probes-aka-health-checks) which allow you to achieve the same end result. Please review the controller specific docs to see how they handle health checks ([nginx](https://github.com/kubernetes/contrib/blob/master/ingress/controllers/nginx/README.md), [GCE](https://github.com/kubernetes/contrib/blob/master/ingress/controllers/gce/README.md#health-checks)). ## Updating an Ingress diff --git a/docs/user-guide/introspection-and-debugging.md b/docs/user-guide/introspection-and-debugging.md index e185bb46d2..78b1a44862 100644 --- a/docs/user-guide/introspection-and-debugging.md +++ b/docs/user-guide/introspection-and-debugging.md @@ -1,4 +1,8 @@ --- +assignees: +- janetkuo +- thockin + --- Once your application is running, you'll inevitably need to debug problems with it. diff --git a/docs/user-guide/jobs.md b/docs/user-guide/jobs.md index 9acde65d0a..fb050a2dd8 100644 --- a/docs/user-guide/jobs.md +++ b/docs/user-guide/jobs.md @@ -1,4 +1,8 @@ --- +assignees: +- erictune +- soltysh + --- * TOC @@ -38,11 +42,11 @@ $ kubectl describe jobs/pi Name: pi Namespace: default Image(s): perl -Selector: app in (pi) +Selector: controller-uid=b1db589a-2c8d-11e6-b324-0209dc45a495 Parallelism: 1 Completions: 1 -Start Time: Mon, 11 Jan 2016 15:35:52 -0800 -Labels: app=pi +Start Time: Tue, 07 Jun 2016 10:56:16 +0200 +Labels: controller-uid=b1db589a-2c8d-11e6-b324-0209dc45a495,job-name=pi Pods Statuses: 0 Running / 1 Succeeded / 0 Failed No volumes. Events: @@ -56,7 +60,7 @@ To view completed pods of a job, use `kubectl get pods --show-all`. The `--show To list all the pods that belong to job in a machine readable form, you can use a command like this: ```shell -$ pods=$(kubectl get pods --selector=app=pi --output=jsonpath={.items..metadata.name}) +$ pods=$(kubectl get pods --selector=job-name=pi --output=jsonpath={.items..metadata.name}) echo $pods pi-aiw0a ``` @@ -190,7 +194,7 @@ The job object also remains after it is completed so that you can view its statu old jobs after noting their status. Delete the job with `kubectl` (e.g. `kubectl delete jobs/pi` or `kubectl delete -f ./job.yaml`). When you delete the job using `kubectl`, all the pods it created are deleted too. If a Job's pods are failing repeatedly, the Job will keep creating new pods forever, by default. -Retrying forever can be a useful pattern. If an external dependency of the Job's +Retrying forever can be a useful pattern. If an external dependency of the Job's pods is missing (for example an input file on a networked storage volume is not present), then the Job will keep trying Pods, and when you later resolve the external dependency (for example, creating the missing file) the Job will then complete without any further action. @@ -249,12 +253,12 @@ The tradeoffs are: The tradeoffs are summarized here, with columns 2 to 4 corresponding to the above tradeoffs. The pattern names are also links to examples and more detailed description. -| Pattern | Single Job object | Fewer pods than work items? | Use app unmodified? | Works in Kube 1.1? | -| -------------------------------------------------------------------------- |:-----------------:|:---------------------------:|:-------------------:|:-------------------:| -| [Job Template Expansion](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/job/expansions/README.md) | | | ✓ | ✓ | -| [Queue with Pod Per Work Item](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/job/work-queue-1/README.md) | ✓ | | sometimes | ✓ | -| [Queue with Variable Pod Count](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/job/work-queue-2/README.md) | ✓ | ✓ | | ✓ | -| Single Job with Static Work Assignment | ✓ | | ✓ | | +| Pattern | Single Job object | Fewer pods than work items? | Use app unmodified? | Works in Kube 1.1? | +| -------------------------------------------------------------------- |:-----------------:|:---------------------------:|:-------------------:|:-------------------:| +| [Job Template Expansion](/docs/user-guide/jobs/expansions) | | | ✓ | ✓ | +| [Queue with Pod Per Work Item](/docs/user-guide/jobs/work-queue-1/) | ✓ | | sometimes | ✓ | +| [Queue with Variable Pod Count](/docs/user-guide/jobs/work-queue-2/) | ✓ | ✓ | | ✓ | +| Single Job with Static Work Assignment | ✓ | | ✓ | | When you specify completions with `.spec.completions`, each Pod created by the Job controller has an identical [`spec`](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#spec-and-status). This means that @@ -265,12 +269,12 @@ are different ways to arrange for pods to work on different things. This table shows the required settings for `.spec.parallelism` and `.spec.completions` for each of the patterns. Here, `W` is the number of work items. -| Pattern | `.spec.completions` | `.spec.parallelism` | -| -------------------------------------------------------------------------- |:-------------------:|:--------------------:| -| [Job Template Expansion](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/job/expansions/README.md) | 1 | should be 1 | -| [Queue with Pod Per Work Item](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/job/work-queue-1/README.md) | W | any | -| [Queue with Variable Pod Count](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/job/work-queue-2/README.md) | 1 | any | -| Single Job with Static Work Assignment | W | any | +| Pattern | `.spec.completions` | `.spec.parallelism` | +| -------------------------------------------------------------------- |:-------------------:|:--------------------:| +| [Job Template Expansion](/docs/user-guide/jobs/expansions/) | 1 | should be 1 | +| [Queue with Pod Per Work Item](/docs/user-guide/jobs/work-queue-1/) | W | any | +| [Queue with Variable Pod Count](/docs/user-guide/jobs/work-queue-2/) | 1 | any | +| Single Job with Static Work Assignment | W | any | ## Advanced Usage @@ -372,4 +376,4 @@ object, but complete control over what pods are created and how work is assigned ## Future work -Support for creating Jobs at specified times/dates (i.e. cron) is expected in [1.3](https://github.com/kubernetes/kubernetes/pull/11980). +Support for creating Jobs at specified times/dates (i.e. cron) is expected in [1.4](https://github.com/kubernetes/kubernetes/pull/11980). diff --git a/docs/user-guide/jobs/OWNERS b/docs/user-guide/jobs/OWNERS new file mode 100644 index 0000000000..2095c1ab54 --- /dev/null +++ b/docs/user-guide/jobs/OWNERS @@ -0,0 +1,5 @@ +assignees: +- caesarxuchao +- erictune +- soltysh + diff --git a/docs/user-guide/jobs/expansions/index.md b/docs/user-guide/jobs/expansions/index.md new file mode 100644 index 0000000000..91e916844f --- /dev/null +++ b/docs/user-guide/jobs/expansions/index.md @@ -0,0 +1,193 @@ +--- +--- + +* TOC +{:toc} + +# Example: Multiple Job Objects from Template Expansion + +In this example, we will run multiple Kubernetes Jobs created from +a common template. You may want to be familiar with the basic, +non-parallel, use of [Jobs](/docs/user-guide/jobs) first. + +## Basic Template Expansion + +First, download the following template of a job to a file called `job.yaml.txt` + +{% include code.html language="yaml" file="job.yaml.txt" ghlink="/docs/user-guide/job/expansions/job.yaml.txt" %} + +Unlike a *pod template*, our *job template* is not a Kubernetes API type. It is just +a yaml representation of a Job object that has some placeholders that need to be filled +in before it can be used. The `$ITEM` syntax is not meaningful to Kubernetes. + +In this example, the only processing the container does is to `echo` a string and sleep for a bit. +In a real use case, the processing would be some substantial computation, such as rendering a frame +of a movie, or processing a range of rows in a database. The "$ITEM" parameter would specify for +example, the frame number or the row range. + +This Job and its Pod template have a label: `jobgroup=jobexample`. There is nothing special +to the system about this label. This label +makes it convenient to operate on all the jobs in this group at once. +We also put the same label on the pod template so that we can check on all Pods of these Jobs +with a single command. +After the job is created, the system will add more labels that distinguish one Job's pods +from another Job's pods. +Note that the label key `jobgroup` is not special to Kubernetes. you can pick your own label scheme. + +Next, expand the template into multiple files, one for each item to be processed. + +```shell +# Expand files into a temporary directory +mkdir ./jobs +for i in apple banana cherry +do + cat job.yaml.txt | sed "s/\$ITEM/$i/" > ./jobs/job-$i.yaml +done +``` + +Check if it worked: + +```shell +$ ls jobs/ +job-apple.yaml +job-banana.yaml +job-cherry.yaml +``` + +Here, we used `sed` to replace the string `$ITEM` with the the loop variable. +You could use any type of template language (jinja2, erb) or write a program +to generate the Job objects. + +Next, create all the jobs with one kubectl command: + +```shell +$ kubectl create -f ./jobs +job "process-item-apple" created +job "process-item-banana" created +job "process-item-cherry" created +``` + +Now, check on the jobs: + +```shell +$ kubectl get jobs -l app=jobexample +JOB CONTAINER(S) IMAGE(S) SELECTOR SUCCESSFUL +process-item-apple c busybox app in (jobexample),item in (apple) 1 +process-item-banana c busybox app in (jobexample),item in (banana) 1 +process-item-cherry c busybox app in (jobexample),item in (cherry) 1 +``` + +Here we use the `-l` option to select all jobs that are part of this +group of jobs. (There might be other unrelated jobs in the system that we +do not care to see.) + +We can check on the pods as well using the same label selector: + +```shell +$ kubectl get pods -l app=jobexample +NAME READY STATUS RESTARTS AGE +process-item-apple-kixwv 0/1 Completed 0 4m +process-item-banana-wrsf7 0/1 Completed 0 4m +process-item-cherry-dnfu9 0/1 Completed 0 4m +``` + +There is not a single command to check on the output of all jobs at once, +but looping over all the pods is pretty easy: + +```shell +$ for p in $(kubectl get pods -l app=jobexample -o name) +do + kubectl logs $p +done +Processing item apple +Processing item banana +Processing item cherry +``` + +## Multiple Template Parameters + +In the first example, each instance of the template had one parameter, and that parameter was also +used as a label. However label keys are limited in [what characters they can +contain](docs/user-guide/labels/#syntax-and-character-set). + +This slightly more complex example uses a the jinja2 template language to generate our objects. +We will use a one-line python script to convert the template to a file. + +First, copy and paste the following template of a Job object, into a file called `job.yaml.jinja2`: + + +```liquid{% raw %} +{%- set params = [{ "name": "apple", "url": "http://www.orangepippin.com/apples", }, + { "name": "banana", "url": "https://en.wikipedia.org/wiki/Banana", }, + { "name": "raspberry", "url": "https://www.raspberrypi.org/" }] +%} +{%- for p in params %} +{%- set name = p["name"] %} +{%- set url = p["url"] %} +apiVersion: batch/v1 +kind: Job +metadata: + name: jobexample-{{ {{ name }} }} + labels: + jobgroup: jobexample +spec: + template: + name: jobexample + labels: + jobgroup: jobexample + spec: + containers: + - name: c + image: busybox + command: ["sh", "-c", "echo Processing URL {{ url }} && sleep 5"] + restartPolicy: Never +--- +{%- endfor %} +{% endraw %} +``` + +The above template defines parameters for each job object using a list of +python dicts (lines 1-4). Then a for loop emits one job yaml object +for each set of parameters (remaining lines). +We take advantage of the fact that multiple yaml documents can be concatenated +with the `---` separator (second to last line). +.) We can pipe the output directly to kubectl to +create the objects. + +You will need the jinja2 package if you do not already have it: `pip install --user jinja2`. +Now, use this one-line python program to expand the template: + +```shell +alias render_template='python -c "from jinja2 import Template; import sys; print(Template(sys.stdin.read()).render());"' +``` + + + +The output can be saved to a file, like this: + +```shell +cat job.yaml.jinja2 | render_template > jobs.yaml +``` + +or sent directly to kubectl, like this: + +```shell +cat job.yaml.jinja2 | render_template | kubectl create -f - +``` + +## Alternatives + +If you have a large number of job objects, you may find that: +- even using labels, managing so many Job objects is cumbersome. +- You exceed resource quota when creating all the Jobs at once, + and do not want to wait to create them incrementally. +- You need a way to easily scale the number of pods running + concurrently. One reason would be to avoid using too many + compute resources. Another would be to limit the number of + concurrent requests to a shared resource, such as a database, + used by all the pods in the job. +- very large numbers of jobs created at once overload the + kubernetes apiserver, controller, or scheduler. + +In this case, you can consider one of the +other [job patterns](/docs/user-guide/jobs/#job-patterns). diff --git a/docs/user-guide/jobs/expansions/job.yaml.txt b/docs/user-guide/jobs/expansions/job.yaml.txt new file mode 100644 index 0000000000..790025b38b --- /dev/null +++ b/docs/user-guide/jobs/expansions/job.yaml.txt @@ -0,0 +1,18 @@ +apiVersion: batch/v1 +kind: Job +metadata: + name: process-item-$ITEM + labels: + jobgroup: jobexample +spec: + template: + metadata: + name: jobexample + labels: + jobgroup: jobexample + spec: + containers: + - name: c + image: busybox + command: ["sh", "-c", "echo Processing item $ITEM && sleep 5"] + restartPolicy: Never diff --git a/docs/user-guide/jobs/work-queue-1/Dockerfile b/docs/user-guide/jobs/work-queue-1/Dockerfile new file mode 100644 index 0000000000..cbd36bb620 --- /dev/null +++ b/docs/user-guide/jobs/work-queue-1/Dockerfile @@ -0,0 +1,10 @@ +# Specify BROKER_URL and QUEUE when running +FROM ubuntu:14.04 + +RUN apt-get update && \ + apt-get install -y curl ca-certificates amqp-tools python \ + --no-install-recommends \ + && rm -rf /var/lib/apt/lists/* +COPY ./worker.py /worker.py + +CMD /usr/bin/amqp-consume --url=$BROKER_URL -q $QUEUE -c 1 /worker.py diff --git a/docs/user-guide/jobs/work-queue-1/index.md b/docs/user-guide/jobs/work-queue-1/index.md new file mode 100644 index 0000000000..7f2ba0b6ac --- /dev/null +++ b/docs/user-guide/jobs/work-queue-1/index.md @@ -0,0 +1,284 @@ +--- +--- + +* TOC +{:toc} + +# Example: Job with Work Queue with Pod Per Work Item + +In this example, we will run a Kubernetes Job with multiple parallel +worker processes. You may want to be familiar with the basic, +non-parallel, use of [Job](/docs/user-guide/jobs) first. + +In this example, as each pod is created, it picks up one unit of work +from a task queue, completes it, deletes it from the queue, and exits. + + +Here is an overview of the steps in this example: + +1. **Start a message queue service.** In this example, we use RabbitMQ, but you could use another + one. In practice you would set up a message queue service once and reuse it for many jobs. +1. **Create a queue, and fill it with messages.** Each message represents one task to be done. In + this example, a message is just an integer that we will do a lengthy computation on. +1. **Start a Job that works on tasks from the queue**. The Job starts several pods. Each pod takes + one task from the message queue, processes it, and repeats until the end of the queue is reached. + +## Starting a message queue service + +This example uses RabbitMQ, but it should be easy to adapt to another AMQP-type message service. + +In practice you could set up a message queue service once in a +cluster and reuse it for many jobs, as well as for long-running services. + +Start RabbitMQ as follows: + +```shell +$ kubectl create -f examples/celery-rabbitmq/rabbitmq-service.yaml +service "rabbitmq-service" created +$ kubectl create -f examples/celery-rabbitmq/rabbitmq-controller.yaml +replicationController "rabbitmq-controller" created +``` + +We will only use the rabbitmq part from the celery-rabbitmq example. + +## Testing the message queue service + +Now, we can experiment with accessing the message queue. We will +create a temporary interactive pod, install some tools on it, +and experiment with queues. + +First create a temporary interactive Pod. + +```shell +# Create a temporary interactive container +$ kubectl run -i --tty temp --image ubuntu:14.04 +Waiting for pod default/temp-loe07 to be running, status is Pending, pod ready: false +... [ previous line repeats several times .. hit return when it stops ] ... +``` + +Note that your pod name and command prompt will be different. + +Next install the `amqp-tools` so we can work with message queues. + +```shell +# Install some tools +root@temp-loe07:/# apt-get update +.... [ lots of output ] .... +root@temp-loe07:/# apt-get install -y curl ca-certificates amqp-tools python dnsutils +.... [ lots of output ] .... +``` + +Later, we will make a docker image that includes these packages. + +Next, we will check that we can discover the rabbitmq service: + +``` +# Note the rabitmq-service has a DNS name, provided by Kubernetes: + +root@temp-loe07:/# nslookup rabbitmq-service +Server: 10.0.0.10 +Address: 10.0.0.10#53 + +Name: rabbitmq-service.default.svc.cluster.local +Address: 10.0.147.152 + +# Your address will vary. +``` + +If Kube-DNS is not setup correctly, the previous step may not work for you. +You can also find the service IP in an env var: + +``` +# env | grep RABBIT | grep HOST +RABBITMQ_SERVICE_SERVICE_HOST=10.0.147.152 +# Your address will vary. +``` + +Next we will verify we can create a queue, and publish and consume messages. + +```shell +# In the next line, rabbitmq-service is the hostname where the rabbitmq-service +# can be reached. 5672 is the standard port for rabbitmq. + +root@temp-loe07:/# BROKER_URL=amqp://guest:guest@rabbitmq-service:5672 +# If you could not resolve "rabbitmq-service" in the previous step, +# then use this command instead: +# root@temp-loe07:/# BROKER_URL=amqp://guest:guest@$RABBITMQ_SERVICE_SERVICE_HOST:5672 + +# Now create a queue: + +root@temp-loe07:/# /usr/bin/amqp-declare-queue --url=$BROKER_URL -q foo -d +foo + +# Publish one message to it: + +root@temp-loe07:/# /usr/bin/amqp-publish --url=$BROKER_URL -r foo -p -b Hello + +# And get it back. + +root@temp-loe07:/# /usr/bin/amqp-consume --url=$BROKER_URL -q foo -c 1 cat && echo +Hello +root@temp-loe07:/# +``` + +In the last command, the `amqp-consume` tool takes one message (`-c 1`) +from the queue, and passes that message to the standard input of an +an arbitrary command. In this case, the program `cat` is just printing +out what it gets on the standard input, and the echo is just to add a carriage +return so the example is readable. + +## Filling the Queue with tasks + +Now lets fill the queue with some "tasks". In our example, our tasks are just strings to be +printed. + +In a practice, the content of the messages might be: + +- names of files to that need to be processed +- extra flags to the program +- ranges of keys in a database table +- configuration parameters to a simulation +- frame numbers of a scene to be rendered + +In practice, if there is large data that is needed in a read-only mode by all pods +of the Job, you will typically put that in a shared file system like NFS and mount +that readonly on all the pods, or the program in the pod will natively read data from +a cluster file system like HDFS. + +For our example, we will create the queue and fill it using the amqp command line tools. +In practice, you might write a program to fill the queue using an amqp client library. + +```shell +$ /usr/bin/amqp-declare-queue --url=$BROKER_URL -q job1 -d +job1 +$ for f in apple banana cherry date fig grape lemon melon +do + /usr/bin/amqp-publish --url=$BROKER_URL -r job1 -p -b $f +done +``` + +So, we filled the queue with 8 messages. + +## Create an Image + +Now we are ready to create an image that we will run as a job. + +We will use the `amqp-consume` utility to read the message +from the queue and run our actual program. Here is a very simple +example program: + +{% include code.html language="python" file="worker.py" ghlink="/docs/user-guide/job/work-queue-1/worker.py" %} + +Now, build an an image. If you are working in the source +tree, then change directory to `examples/job/work-queue-1`. +Otherwise, make a temporary directory, change to it, +download the [Dockerfile](Dockerfile?raw=true), +and [worker.py](worker.py?raw=true). In either case, +build the image with this command: ` + +```shell +$ docker build -t job-wq-1 . +``` + +For the [Docker Hub](https://hub.docker.com/), tag your app image with +your username and push to the Hub with the below commands. Replace +`` with your Hub username. + +```shell +docker tag job-wq-1 /job-wq-1 +docker push /job-wq-1 +``` + +If you are using [Google Container +Registry](https://cloud.google.com/tools/container-registry/), tag +your app image with your project ID, and push to GCR. Replace +`` with your project ID. + +```shell +docker tag job-wq-1 gcr.io//job-wq-1 +gcloud docker push gcr.io//job-wq-1 +``` + +## Defining a Job + +Here is a job definition. You'll need to make a copy of the Job and edit the +image to match the name you used, and call it `./job.yaml`. + + +{% include code.html language="yaml" file="job.yaml" ghlink="/docs/user-guide/job/work-queue-1/job.yaml" %} + +In this example, each pod works on one item from the queue and then exits. +So, the completion count of the Job corresponds to the number of work items +done. So we set, `.spec.completions: 8` for the example, since we put 8 items in the queue. + +## Running the Job + +So, now run the Job: + +```shell +kubectl create -f ./job.yaml +``` + +Now wait a bit, then check on the job. + +```shell +$ kubectl describe jobs/job-wq-1 +Name: job-wq-1 +Namespace: default +Image(s): gcr.io/causal-jigsaw-637/job-wq-1 +Selector: app in (job-wq-1) +Parallelism: 4 +Completions: 8 +Labels: app=job-wq-1 +Pods Statuses: 0 Running / 8 Succeeded / 0 Failed +No volumes. +Events: + FirstSeen LastSeen Count From SubobjectPath Reason Message + ───────── ──────── ───── ──── ───────────── ────── ─────── + 27s 27s 1 {job } SuccessfulCreate Created pod: job-wq-1-hcobb + 27s 27s 1 {job } SuccessfulCreate Created pod: job-wq-1-weytj + 27s 27s 1 {job } SuccessfulCreate Created pod: job-wq-1-qaam5 + 27s 27s 1 {job } SuccessfulCreate Created pod: job-wq-1-b67sr + 26s 26s 1 {job } SuccessfulCreate Created pod: job-wq-1-xe5hj + 15s 15s 1 {job } SuccessfulCreate Created pod: job-wq-1-w2zqe + 14s 14s 1 {job } SuccessfulCreate Created pod: job-wq-1-d6ppa + 14s 14s 1 {job } SuccessfulCreate Created pod: job-wq-1-p17e0 +``` + +All our pods succeeded. Yay. + + +## Alternatives + +This approach has the advantage that you +do not need to modify your "worker" program to be aware that there is a work queue. + +It does require that you run a message queue service. +If running a queue service is inconvenient, you may +want to consider one of the other [job patterns](/docs/user-guide/jobs/#job-patterns). + +This approach creates a pod for every work item. If your work items only take a few seconds, +though, creating a Pod for every work item may add a lot of overhead. Consider another +[example](/docs/user-guide/job/work-queue-2), that executes multiple work items per Pod. + +In this example, we used use the `amqp-consume` utility to read the message +from the queue and run our actual program. This has the advantage that you +do not need to modify your program to be aware of the queue. +A [different example](/docs/user-guide/job/work-queue-2), shows how to +communicate with the work queue using a client library. + +## Caveats + +If the number of completions is set to less than the number of items in the queue, then +not all items will be processed. + +If the number of completions is set to more than the number of items in the queue, +then the Job will not appear to be completed, even though all items in the queue +have been processed. It will start additional pods which will block waiting +for a mesage. + +There is an unlikely race with this pattern. If the container is killed in between the time +that the message is acknowledged by the amqp-consume command and the time that the container +exits with success, or if the node crashes before the kubelet is able to post the success of the pod +back to the api-server, then the Job will not appear to be complete, even though all items +in the queue have been processed. diff --git a/docs/user-guide/jobs/work-queue-1/job.yaml b/docs/user-guide/jobs/work-queue-1/job.yaml new file mode 100644 index 0000000000..d2696ed022 --- /dev/null +++ b/docs/user-guide/jobs/work-queue-1/job.yaml @@ -0,0 +1,15 @@ +apiVersion: batch/v1 +kind: Job +metadata: + name: job-wq-1 +spec: + completions: 8 + parallelism: 2 + template: + metadata: + name: job-wq-1 + spec: + containers: + - name: c + image: gcr.io//job-wq-1 + restartPolicy: OnFailure diff --git a/docs/user-guide/jobs/work-queue-1/worker.py b/docs/user-guide/jobs/work-queue-1/worker.py new file mode 100755 index 0000000000..a20884515d --- /dev/null +++ b/docs/user-guide/jobs/work-queue-1/worker.py @@ -0,0 +1,7 @@ +#!/usr/bin/env python + +# Just prints standard out and sleeps for 10 seconds. +import sys +import time +print("Processing " + sys.stdin.lines()) +time.sleep(10) diff --git a/docs/user-guide/jobs/work-queue-2/Dockerfile b/docs/user-guide/jobs/work-queue-2/Dockerfile new file mode 100644 index 0000000000..2de23b3c98 --- /dev/null +++ b/docs/user-guide/jobs/work-queue-2/Dockerfile @@ -0,0 +1,6 @@ +FROM python +RUN pip install redis +COPY ./worker.py /worker.py +COPY ./rediswq.py /rediswq.py + +CMD python worker.py diff --git a/docs/user-guide/jobs/work-queue-2/index.md b/docs/user-guide/jobs/work-queue-2/index.md new file mode 100644 index 0000000000..434859093b --- /dev/null +++ b/docs/user-guide/jobs/work-queue-2/index.md @@ -0,0 +1,210 @@ +--- +--- + +* TOC +{:toc} + +# Example: Job with Work Queue with Pod Per Work Item + +In this example, we will run a Kubernetes Job with multiple parallel +worker processes. You may want to be familiar with the basic, +non-parallel, use of [Job](/docs/user-guide/jobs) first. + +In this example, as each pod is created, it picks up one unit of work +from a task queue, completes it, deletes it from the queue, and exits. + + +Here is an overview of the steps in this example: + +1. **Start a storage service to hold the work queue.** In this example, we use Redis to store + our work items. In the previous example, we used RabbitMQ. In this example, we use Redis and + a custom work-queue client library because AMQP does not provide a good way for clients to + detect when a finite-length work queue is empty. In practice you would set up a store such + as Redis once and reuse it for the work queues of many jobs, and other things. +1. **Create a queue, and fill it with messages.** Each message represents one task to be done. In + this example, a message is just an integer that we will do a lengthy computation on. +1. **Start a Job that works on tasks from the queue**. The Job starts several pods. Each pod takes + one task from the message queue, processes it, and repeats until the end of the queue is reached. + + +## Starting Redis + +For this example, for simplicitly, we will start a single instance of Redis. +See the [Redis Example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/redis/README.md) for an example +of deploying Redis scaleably and redundantly. + +Start a temporary Pod running Redis and a service so we can find it. + +```shell +$ kubectl create -f examples/job/work-queue-2/redis-pod.yaml +pod "redis-master" created +$ kubectl create -f examples/job/work-queue-2/redis-service.yaml +service "redis" created +``` + +## Filling the Queue with tasks + +Now lets fill the queue with some "tasks". In our example, our tasks are just strings to be +printed. + +Start a temporary interactive pod for running the Redis CLI + +```shell +$ kubectl run -i --tty temp --image redis --command "/bin/sh" +Waiting for pod default/redis2-c7h78 to be running, status is Pending, pod ready: false +Hit enter for command prompt +``` + +Now hit enter, start the redis CLI, and create a list with some work items in it. + +``` +# redis-cli -h redis +redis:6379> rpush job2 "apple" +(integer) 1 +redis:6379> rpush job2 "banana" +(integer) 2 +redis:6379> rpush job2 "cherry" +(integer) 3 +redis:6379> rpush job2 "date" +(integer) 4 +redis:6379> rpush job2 "fig" +(integer) 5 +redis:6379> rpush job2 "grape" +(integer) 6 +redis:6379> rpush job2 "lemon" +(integer) 7 +redis:6379> rpush job2 "melon" +(integer) 8 +redis:6379> rpush job2 "orange" +(integer) 9 +redis:6379> lrange job2 0 -1 +1) "apple" +2) "banana" +3) "cherry" +4) "date" +5) "fig" +6) "grape" +7) "lemon" +8) "melon" +9) "orange" +``` + +So, the list with key `job2` will be our work queue. + +Note: if you do not have Kube DNS setup correctly, you may need to change +the first step of the above block to `redis-cli -h $REDIS_SERVICE_HOST`. + + +## Create an Image + +Now we are ready to create an image that we will run. + +We will use a python worker program with a redis client to read +the messages from the message queue. + +A simple Redis work queue client library is provided, +called rediswq.py ([Download](rediswq.py?raw=true)). + +The "worker" program in each Pod of the Job uses the work queue +client library to get work. Here it is: + +{% include code.html language="python" file="worker.py" ghlink="/docs/user-guide/job/work-queue-2/worker.py" %} + +If you are working from the source tree, +change directory to the `examples/job/work-queue-2` directory. +Otherwise, download [`worker.py`](worker.py?raw=true), [`rediswq.py`](rediswq.py?raw=true), and [`Dockerfile`](Dockerfile?raw=true) +using above links. Then build the image: + +```shell +docker build -t job-wq-2 . +``` + +### Push the image + +For the [Docker Hub](https://hub.docker.com/), tag your app image with +your username and push to the Hub with the below commands. Replace +`` with your Hub username. + +```shell +docker tag job-wq-2 /job-wq-2 +docker push /job-wq-2 +``` + +You need to push to a public repository or [configure your cluster to be able to access +your private repository](/docs/user-guide/images). + +If you are using [Google Container +Registry](https://cloud.google.com/tools/container-registry/), tag +your app image with your project ID, and push to GCR. Replace +`` with your project ID. + +```shell +docker tag job-wq-2 gcr.io//job-wq-2 +gcloud docker push gcr.io//job-wq-2 +``` + +## Defining a Job + +Here is the job definition: + +{% include code.html language="yaml" file="job.yaml" ghlink="/docs/user-guide/job/work-queue-2/job.yaml" %} + +Be sure to edit the job template to +change `gcr.io/myproject` to your own path. + +In this example, each pod works on several items from the queue and then exits when there are no more items. +Since the workers themselves detect when the workqueue is empty, and the Job controller does not +know about the workqueue, it relies on the workers to signal when they are done working. +The workers signal that the queue is empty by exiting with success. So, as soon as any worker +exits with success, the controller knows the work is done, and the Pods will exit soon. +So, we set the completion count of the Job to 1. The job controller will wait for the other pods to complete +too. + + +## Running the Job + +So, now run the Job: + +```shell +kubectl create -f ./job.yaml +``` + +Now wait a bit, then check on the job. + +```shell +$ kubectl describe jobs/job-wq-2 +Name: job-wq-2 +Namespace: default +Image(s): gcr.io/exampleproject/job-wq-2 +Selector: app in (job-wq-2) +Parallelism: 2 +Completions: Unset +Start Time: Mon, 11 Jan 2016 17:07:59 -0800 +Labels: app=job-wq-2 +Pods Statuses: 1 Running / 0 Succeeded / 0 Failed +No volumes. +Events: + FirstSeen LastSeen Count From SubobjectPath Type Reason Message + --------- -------- ----- ---- ------------- -------- ------ ------- + 33s 33s 1 {job-controller } Normal SuccessfulCreate Created pod: job-wq-2-lglf8 + + +$ kubectl logs pods/job-wq-2-7r7b2 +Worker with sessionID: bbd72d0a-9e5c-4dd6-abf6-416cc267991f +Initial queue state: empty=False +Working on banana +Working on date +Working on lemon +``` + +As you can see, one of our pods worked on several work units. + +## Alternatives + +If running a queue service or modifying your containers to use a work queue is inconvenient, you may +want to consider one of the other [job patterns](/docs/user-guide/jobs/#job-patterns). + +If you have a continuous stream of background processing work to run, then +consider running your background workers with a `replicationController` instead, +and consider running a background processing library such as +https://github.com/resque/resque. diff --git a/docs/user-guide/jobs/work-queue-2/job.yaml b/docs/user-guide/jobs/work-queue-2/job.yaml new file mode 100644 index 0000000000..ee7a06c732 --- /dev/null +++ b/docs/user-guide/jobs/work-queue-2/job.yaml @@ -0,0 +1,14 @@ +apiVersion: batch/v1 +kind: Job +metadata: + name: job-wq-2 +spec: + parallelism: 2 + template: + metadata: + name: job-wq-2 + spec: + containers: + - name: c + image: gcr.io/myproject/job-wq-2 + restartPolicy: OnFailure diff --git a/docs/user-guide/jobs/work-queue-2/redis-pod.yaml b/docs/user-guide/jobs/work-queue-2/redis-pod.yaml new file mode 100644 index 0000000000..ae0c43a793 --- /dev/null +++ b/docs/user-guide/jobs/work-queue-2/redis-pod.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: redis-master + labels: + app: redis +spec: + containers: + - name: master + image: redis + env: + - name: MASTER + value: "true" + ports: + - containerPort: 6379 diff --git a/docs/user-guide/jobs/work-queue-2/redis-service.yaml b/docs/user-guide/jobs/work-queue-2/redis-service.yaml new file mode 100644 index 0000000000..85f2ca2271 --- /dev/null +++ b/docs/user-guide/jobs/work-queue-2/redis-service.yaml @@ -0,0 +1,10 @@ +apiVersion: v1 +kind: Service +metadata: + name: redis +spec: + ports: + - port: 6379 + targetPort: 6379 + selector: + app: redis diff --git a/docs/user-guide/jobs/work-queue-2/rediswq.py b/docs/user-guide/jobs/work-queue-2/rediswq.py new file mode 100644 index 0000000000..ebefa64311 --- /dev/null +++ b/docs/user-guide/jobs/work-queue-2/rediswq.py @@ -0,0 +1,130 @@ +#!/usr/bin/env python + +# Based on http://peter-hoffmann.com/2012/python-simple-queue-redis-queue.html +# and the suggestion in the redis documentation for RPOPLPUSH, at +# http://redis.io/commands/rpoplpush, which suggests how to implement a work-queue. + + +import redis +import uuid +import hashlib + +class RedisWQ(object): + """Simple Finite Work Queue with Redis Backend + + This work queue is finite: as long as no more work is added + after workers start, the workers can detect when the queue + is completely empty. + + The items in the work queue are assumed to have unique values. + + This object is not intended to be used by multiple threads + concurrently. + """ + def __init__(self, name, **redis_kwargs): + """The default connection parameters are: host='localhost', port=6379, db=0 + + The work queue is identified by "name". The library may create other + keys with "name" as a prefix. + """ + self._db = redis.StrictRedis(**redis_kwargs) + # The session ID will uniquely identify this "worker". + self._session = str(uuid.uuid4()) + # Work queue is implemented as two queues: main, and processing. + # Work is initially in main, and moved to processing when a client picks it up. + self._main_q_key = name + self._processing_q_key = name + ":processing" + self._lease_key_prefix = name + ":leased_by_session:" + + def sessionID(self): + """Return the ID for this session.""" + return self._session + + def _main_qsize(self): + """Return the size of the main queue.""" + return self._db.llen(self._main_q_key) + + def _processing_qsize(self): + """Return the size of the main queue.""" + return self._db.llen(self._processing_q_key) + + def empty(self): + """Return True if the queue is empty, including work being done, False otherwise. + + False does not necessarily mean that there is work available to work on right now, + """ + return self._main_qsize() == 0 and self._processing_qsize() == 0 + +# TODO: implement this +# def check_expired_leases(self): +# """Return to the work queueReturn True if the queue is empty, False otherwise.""" +# # Processing list should not be _too_ long since it is approximately as long +# # as the number of active and recently active workers. +# processing = self._db.lrange(self._processing_q_key, 0, -1) +# for item in processing: +# # If the lease key is not present for an item (it expired or was +# # never created because the client crashed before creating it) +# # then move the item back to the main queue so others can work on it. +# if not self._lease_exists(item): +# TODO: transactionally move the key from processing queue to +# to main queue, while detecting if a new lease is created +# or if either queue is modified. + + def _itemkey(self, item): + """Returns a string that uniquely identifies an item (bytes).""" + return hashlib.sha224(item).hexdigest() + + def _lease_exists(self, item): + """True if a lease on 'item' exists.""" + return self._db.exists(self._lease_key_prefix + self._itemkey(item)) + + def lease(self, lease_secs=60, block=True, timeout=None): + """Begin working on an item the work queue. + + Lease the item for lease_secs. After that time, other + workers may consider this client to have crashed or stalled + and pick up the item instead. + + If optional args block is true and timeout is None (the default), block + if necessary until an item is available.""" + if block: + item = self._db.brpoplpush(self._main_q_key, self._processing_q_key, timeout=timeout) + else: + item = self._db.rpoplpush(self._main_q_key, self._processing_q_key) + if item: + # Record that we (this session id) are working on a key. Expire that + # note after the lease timeout. + # Note: if we crash at this line of the program, then GC will see no lease + # for this item an later return it to the main queue. + itemkey = self._itemkey(item) + self._db.setex(self._lease_key_prefix + itemkey, lease_secs, self._session) + return item + + def complete(self, value): + """Complete working on the item with 'value'. + + If the lease expired, the item may not have completed, and some + other worker may have picked it up. There is no indication + of what happened. + """ + self._db.lrem(self._processing_q_key, 0, value) + # If we crash here, then the GC code will try to move the value, but it will + # not be here, which is fine. So this does not need to be a transaction. + itemkey = self._itemkey(value) + self._db.delete(self._lease_key_prefix + itemkey, self._session) + +# TODO: add functions to clean up all keys associated with "name" when +# processing is complete. + +# TODO: add a function to add an item to the queue. Atomically +# check if the queue is empty and if so fail to add the item +# since other workers might think work is done and be in the process +# of exiting. + +# TODO(etune): move to my own github for hosting, e.g. github.com/erictune/rediswq-py and +# make it so it can be pip installed by anyone (see +# http://stackoverflow.com/questions/8247605/configuring-so-that-pip-install-can-work-from-github) + +# TODO(etune): finish code to GC expired leases, and call periodically +# e.g. each time lease times out. + diff --git a/docs/user-guide/jobs/work-queue-2/worker.py b/docs/user-guide/jobs/work-queue-2/worker.py new file mode 100755 index 0000000000..49e5dae798 --- /dev/null +++ b/docs/user-guide/jobs/work-queue-2/worker.py @@ -0,0 +1,23 @@ +#!/usr/bin/env python + +import time +import rediswq + +host="redis" +# Uncomment next two lines if you do not have Kube-DNS working. +# import os +# host = os.getenv("REDIS_SERVICE_HOST") + +q = rediswq.RedisWQ(name="job2", host="redis") +print("Worker with sessionID: " + q.sessionID()) +print("Initial queue state: empty=" + str(q.empty())) +while not q.empty(): + item = q.lease(lease_secs=10, block=True, timeout=2) + if item is not None: + itemstr = item.decode("utf=8") + print("Working on " + itemstr) + time.sleep(10) # Put your actual work here instead of sleep. + q.complete(item) + else: + print("Waiting for work") +print("Queue empty, exiting") diff --git a/docs/user-guide/jsonpath.md b/docs/user-guide/jsonpath.md index dbcbbbac63..01a3e1d03c 100644 --- a/docs/user-guide/jsonpath.md +++ b/docs/user-guide/jsonpath.md @@ -1,4 +1,5 @@ --- + --- JSONPath template is composed of JSONPath expressions enclosed by {}. diff --git a/docs/user-guide/kubeconfig-file.md b/docs/user-guide/kubeconfig-file.md index 0bda9e8156..1271b49d50 100644 --- a/docs/user-guide/kubeconfig-file.md +++ b/docs/user-guide/kubeconfig-file.md @@ -1,5 +1,9 @@ ---- ---- +--- +assignees: +- mikedanese +- thockin + +--- Authentication in kubernetes can differ for different individuals. @@ -22,7 +26,7 @@ http://issue.k8s.io/1755 ### Example kubeconfig file -```yaml +```yaml current-context: federal-context apiVersion: v1 clusters: @@ -60,104 +64,104 @@ users: user: client-certificate: path/to/my/client/cert client-key: path/to/my/client/key -``` - -### Breakdown/explanation of components - -#### cluster - -```yaml -clusters: -- cluster: - certificate-authority: path/to/my/cafile - server: https://horse.org:4443 - name: horse-cluster -- cluster: - insecure-skip-tls-verify: true - server: https://pig.org:443 - name: pig-cluster -``` - -A `cluster` contains endpoint data for a kubernetes cluster. This includes the fully -qualified url for the kubernetes apiserver, as well as the cluster's certificate -authority or `insecure-skip-tls-verify: true`, if the cluster's serving -certificate is not signed by a system trusted certificate authority. -A `cluster` has a name (nickname) which acts as a dictionary key for the cluster -within this kubeconfig file. You can add or modify `cluster` entries using -[`kubectl config set-cluster`](/docs/user-guide/kubectl/kubectl_config_set-cluster/). - -#### user - -```yaml -users: -- name: blue-user - user: - token: blue-token -- name: green-user - user: - client-certificate: path/to/my/client/cert - client-key: path/to/my/client/key -``` - -A `user` defines client credentials for authenticating to a kubernetes cluster. A -`user` has a name (nickname) which acts as its key within the list of user entries -after kubeconfig is loaded/merged. Available credentials are `client-certificate`, -`client-key`, `token`, and `username/password`. `username/password` and `token` -are mutually exclusive, but client certs and keys can be combined with them. -You can add or modify `user` entries using -[`kubectl config set-credentials`](/docs/user-guide/kubectl/kubectl_config_set-credentials). - -#### context - -```yaml -contexts: -- context: - cluster: horse-cluster - namespace: chisel-ns - user: green-user - name: federal-context -``` - -A `context` defines a named [`cluster`](#cluster),[`user`](#user),[`namespace`](/docs/user-guide/namespaces) tuple -which is used to send requests to the specified cluster using the provided authentication info and -namespace. Each of the three is optional; it is valid to specify a context with only one of `cluster`, -`user`,`namespace`, or to specify none. Unspecified values, or named values that don't have corresponding -entries in the loaded kubeconfig (e.g. if the context specified a `pink-user` for the above kubeconfig file) -will be replaced with the default. See [Loading and merging rules](#loading-and-merging) below for override/merge behavior. -You can add or modify `context` entries with [`kubectl config set-context`](/docs/user-guide/kubectl/kubectl_config_set-context). - -#### current-context - -```yaml -current-context: federal-context -``` - -`current-context` is the nickname or 'key' for the cluster,user,namespace tuple that kubectl -will use by default when loading config from this file. You can override any of the values in kubectl -from the commandline, by passing `--context=CONTEXT`, `--cluster=CLUSTER`, `--user=USER`, and/or `--namespace=NAMESPACE` respectively. -You can change the `current-context` with [`kubectl config use-context`](/docs/user-guide/kubectl/kubectl_config_use-context). - -#### miscellaneous - -```yaml -apiVersion: v1 -kind: Config -preferences: - colors: true -``` - -`apiVersion` and `kind` identify the version and schema for the client parser and should not -be edited manually. - -`preferences` specify optional (and currently unused) kubectl preferences. - -## Viewing kubeconfig files - -`kubectl config view` will display the current kubeconfig settings. By default -it will show you all loaded kubeconfig settings; you can filter the view to just -the settings relevant to the `current-context` by passing `--minify`. See -[`kubectl config view`](/docs/user-guide/kubectl/kubectl_config_view) for other options. - +``` + +### Breakdown/explanation of components + +#### cluster + +```yaml +clusters: +- cluster: + certificate-authority: path/to/my/cafile + server: https://horse.org:4443 + name: horse-cluster +- cluster: + insecure-skip-tls-verify: true + server: https://pig.org:443 + name: pig-cluster +``` + +A `cluster` contains endpoint data for a kubernetes cluster. This includes the fully +qualified url for the kubernetes apiserver, as well as the cluster's certificate +authority or `insecure-skip-tls-verify: true`, if the cluster's serving +certificate is not signed by a system trusted certificate authority. +A `cluster` has a name (nickname) which acts as a dictionary key for the cluster +within this kubeconfig file. You can add or modify `cluster` entries using +[`kubectl config set-cluster`](/docs/user-guide/kubectl/kubectl_config_set-cluster/). + +#### user + +```yaml +users: +- name: blue-user + user: + token: blue-token +- name: green-user + user: + client-certificate: path/to/my/client/cert + client-key: path/to/my/client/key +``` + +A `user` defines client credentials for authenticating to a kubernetes cluster. A +`user` has a name (nickname) which acts as its key within the list of user entries +after kubeconfig is loaded/merged. Available credentials are `client-certificate`, +`client-key`, `token`, and `username/password`. `username/password` and `token` +are mutually exclusive, but client certs and keys can be combined with them. +You can add or modify `user` entries using +[`kubectl config set-credentials`](/docs/user-guide/kubectl/kubectl_config_set-credentials). + +#### context + +```yaml +contexts: +- context: + cluster: horse-cluster + namespace: chisel-ns + user: green-user + name: federal-context +``` + +A `context` defines a named [`cluster`](#cluster),[`user`](#user),[`namespace`](/docs/user-guide/namespaces) tuple +which is used to send requests to the specified cluster using the provided authentication info and +namespace. Each of the three is optional; it is valid to specify a context with only one of `cluster`, +`user`,`namespace`, or to specify none. Unspecified values, or named values that don't have corresponding +entries in the loaded kubeconfig (e.g. if the context specified a `pink-user` for the above kubeconfig file) +will be replaced with the default. See [Loading and merging rules](#loading-and-merging) below for override/merge behavior. +You can add or modify `context` entries with [`kubectl config set-context`](/docs/user-guide/kubectl/kubectl_config_set-context). + +#### current-context + +```yaml +current-context: federal-context +``` + +`current-context` is the nickname or 'key' for the cluster,user,namespace tuple that kubectl +will use by default when loading config from this file. You can override any of the values in kubectl +from the commandline, by passing `--context=CONTEXT`, `--cluster=CLUSTER`, `--user=USER`, and/or `--namespace=NAMESPACE` respectively. +You can change the `current-context` with [`kubectl config use-context`](/docs/user-guide/kubectl/kubectl_config_use-context). + +#### miscellaneous + +```yaml +apiVersion: v1 +kind: Config +preferences: + colors: true +``` + +`apiVersion` and `kind` identify the version and schema for the client parser and should not +be edited manually. + +`preferences` specify optional (and currently unused) kubectl preferences. + +## Viewing kubeconfig files + +`kubectl config view` will display the current kubeconfig settings. By default +it will show you all loaded kubeconfig settings; you can filter the view to just +the settings relevant to the `current-context` by passing `--minify`. See +[`kubectl config view`](/docs/user-guide/kubectl/kubectl_config_view) for other options. + ## Building your own kubeconfig file NOTE, that if you are deploying k8s via kube-up.sh, you do not need to create your own kubeconfig files, the script will do it for you. @@ -168,11 +172,11 @@ So, lets do a quick walk through the basics of the above file so you can easily The above file would likely correspond to an api-server which was launched using the `--token-auth-file=tokens.csv` option, where the tokens.csv file looked something like this: -```conf +```conf blue-user,blue-user,1 mister-red,mister-red,2 -``` - +``` + Also, since we have other users who validate using **other** mechanisms, the api-server would have probably been launched with other authentication options (there are many such options, make sure you understand which ones YOU care about before crafting a kubeconfig file, as nobody needs to implement all the different permutations of possible authentication schemes). - Since the user for the current context is "green-user", any client of the api-server using this kubeconfig file would naturally be able to log in successfully, because we are providing the green-user's client credentials. @@ -182,7 +186,7 @@ In the above scenario, green-user would have to log in by providing certificates ## Loading and merging rules -The rules for loading and merging the kubeconfig files are straightforward, but there are a lot of them. The final config is built in this order: +The rules for loading and merging the kubeconfig files are straightforward, but there are a lot of them. The final config is built in this order: 1. Get the kubeconfig from disk. This is done with the following hierarchy and merge rules: @@ -215,12 +219,12 @@ The rules for loading and merging the kubeconfig files are straightforward, but 1. The command line flags are: `client-certificate`, `client-key`, `username`, `password`, and `token`. 1. If there are two conflicting techniques, fail. 1. For any information still missing, use default values and potentially prompt for authentication information - 1. All file references inside of a kubeconfig file are resolved relative to the location of the kubeconfig file itself. When file references are presented on the command line - they are resolved relative to the current working directory. When paths are saved in the ~/.kube/config, relative paths are stored relatively while absolute paths are stored absolutely. + 1. All file references inside of a kubeconfig file are resolved relative to the location of the kubeconfig file itself. When file references are presented on the command line + they are resolved relative to the current working directory. When paths are saved in the ~/.kube/config, relative paths are stored relatively while absolute paths are stored absolutely. + +Any path in a kubeconfig file is resolved relative to the location of the kubeconfig file itself. + -Any path in a kubeconfig file is resolved relative to the location of the kubeconfig file itself. - - ## Manipulation of kubeconfig via `kubectl config ` In order to more easily manipulate kubeconfig files, there are a series of subcommands to `kubectl config` to help. @@ -228,18 +232,18 @@ See [kubectl/kubectl_config.md](/docs/user-guide/kubectl/kubectl_config) for hel ### Example -```shell +```shell $ kubectl config set-credentials myself --username=admin --password=secret $ kubectl config set-cluster local-server --server=http://localhost:8080 $ kubectl config set-context default-context --cluster=local-server --user=myself $ kubectl config use-context default-context $ kubectl config set contexts.default-context.namespace the-right-prefix $ kubectl config view -``` - +``` + produces this output -```yaml +```yaml apiVersion: v1 clusters: - cluster: @@ -259,11 +263,11 @@ users: user: password: secret username: admin -``` - +``` + and a kubeconfig file that looks like this -```yaml +```yaml apiVersion: v1 clusters: - cluster: @@ -283,11 +287,11 @@ users: user: password: secret username: admin -``` - +``` + #### Commands for the example file -```shell +```shell $ kubectl config set preferences.colors true $ kubectl config set-cluster cow-cluster --server=http://cow.org:8080 --api-version=v1 $ kubectl config set-cluster horse-cluster --server=https://horse.org:4443 --certificate-authority=path/to/my/cafile @@ -297,8 +301,8 @@ $ kubectl config set-credentials green-user --client-certificate=path/to/my/clie $ kubectl config set-context queen-anne-context --cluster=pig-cluster --user=black-user --namespace=saw-ns $ kubectl config set-context federal-context --cluster=horse-cluster --user=green-user --namespace=chisel-ns $ kubectl config use-context federal-context -``` - +``` + ### Final notes for tying it all together So, tying this all together, a quick start to creating your own kubeconfig file: diff --git a/docs/user-guide/kubectl-cheatsheet.md b/docs/user-guide/kubectl-cheatsheet.md index d7eda822d3..c14e7c5c03 100644 --- a/docs/user-guide/kubectl-cheatsheet.md +++ b/docs/user-guide/kubectl-cheatsheet.md @@ -1,4 +1,9 @@ --- +assignees: +- bgrant0607 +- erictune +- krousey + --- An assortment of compact kubectl examples @@ -86,7 +91,7 @@ $ kubectl get pods --sort-by=.status.containerStatuses[0].restartCount $ kubectl get pods --selector=app=cassandra rc -o 'jsonpath={.items[*].metadata.labels.version}' # Get ExternalIPs of all nodes -$ kubectl get nodes -o jsonpath='{.items[*].status.addresses[?(@.type=ExternalIP)].address}' +$ kubectl get nodes -o jsonpath='{.items[*].status.addresses[?(@.type=="ExternalIP")].address}' # List Names of Pods that belong to Particular RC # "jq" command useful for transformations that are too complex for jsonpath diff --git a/docs/user-guide/kubectl-conventions.md b/docs/user-guide/kubectl-conventions.md index 6273c750e7..f4398362da 100644 --- a/docs/user-guide/kubectl-conventions.md +++ b/docs/user-guide/kubectl-conventions.md @@ -1,4 +1,8 @@ --- +assignees: +- bgrant0607 +- janetkuo + --- * TOC diff --git a/docs/user-guide/kubectl-overview.md b/docs/user-guide/kubectl-overview.md index 5d75ad691b..4c0304f142 100644 --- a/docs/user-guide/kubectl-overview.md +++ b/docs/user-guide/kubectl-overview.md @@ -1,4 +1,8 @@ --- +assignees: +- bgrant0607 +- hw-qiaolei + --- Use this overview of the `kubectl` command line interface to help you start running commands against Kubernetes clusters. This overview quickly covers `kubectl` syntax, describes the command operations, and provides common examples. For details about each command, including all the supported flags and subcommands, see the [kubectl](/docs/user-guide/kubectl/kubectl) reference documentation. diff --git a/docs/user-guide/kubectl/kubectl.md b/docs/user-guide/kubectl/kubectl.md index e8e52452d9..bc9ba1a76f 100644 --- a/docs/user-guide/kubectl/kubectl.md +++ b/docs/user-guide/kubectl/kubectl.md @@ -20,6 +20,7 @@ kubectl ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -45,37 +46,47 @@ kubectl ### SEE ALSO -* [kubectl annotate](/docs/user-guide/kubectl/kubectl_annotate/) - Update the annotations on a resource -* [kubectl api-versions](/docs/user-guide/kubectl/kubectl_api-versions/) - Print the supported API versions on the server, in the form of "group/version". -* [kubectl apply](/docs/user-guide/kubectl/kubectl_apply/) - Apply a configuration to a resource by filename or stdin -* [kubectl attach](/docs/user-guide/kubectl/kubectl_attach/) - Attach to a running container. -* [kubectl autoscale](/docs/user-guide/kubectl/kubectl_autoscale/) - Auto-scale a deployment or replication controller -* [kubectl cluster-info](/docs/user-guide/kubectl/kubectl_cluster-info/) - Display cluster info -* [kubectl config](/docs/user-guide/kubectl/kubectl_config/) - config modifies kubeconfig files -* [kubectl convert](/docs/user-guide/kubectl/kubectl_convert/) - Convert config files between different API versions -* [kubectl cordon](/docs/user-guide/kubectl/kubectl_cordon/) - Mark node as unschedulable -* [kubectl create](/docs/user-guide/kubectl/kubectl_create/) - Create a resource by filename or stdin -* [kubectl delete](/docs/user-guide/kubectl/kubectl_delete/) - Delete resources by filenames, stdin, resources and names, or by resources and label selector. -* [kubectl describe](/docs/user-guide/kubectl/kubectl_describe/) - Show details of a specific resource or group of resources -* [kubectl drain](/docs/user-guide/kubectl/kubectl_drain/) - Drain node in preparation for maintenance -* [kubectl edit](/docs/user-guide/kubectl/kubectl_edit/) - Edit a resource on the server -* [kubectl exec](/docs/user-guide/kubectl/kubectl_exec/) - Execute a command in a container. -* [kubectl explain](/docs/user-guide/kubectl/kubectl_explain/) - Documentation of resources. -* [kubectl expose](/docs/user-guide/kubectl/kubectl_expose/) - Take a replication controller, service or pod and expose it as a new Kubernetes Service -* [kubectl get](/docs/user-guide/kubectl/kubectl_get/) - Display one or many resources -* [kubectl label](/docs/user-guide/kubectl/kubectl_label/) - Update the labels on a resource -* [kubectl logs](/docs/user-guide/kubectl/kubectl_logs/) - Print the logs for a container in a pod. -* [kubectl namespace](/docs/user-guide/kubectl/kubectl_namespace/) - SUPERSEDED: Set and view the current Kubernetes namespace -* [kubectl patch](/docs/user-guide/kubectl/kubectl_patch/) - Update field(s) of a resource using strategic merge patch. -* [kubectl port-forward](/docs/user-guide/kubectl/kubectl_port-forward/) - Forward one or more local ports to a pod. -* [kubectl proxy](/docs/user-guide/kubectl/kubectl_proxy/) - Run a proxy to the Kubernetes API server -* [kubectl replace](/docs/user-guide/kubectl/kubectl_replace/) - Replace a resource by filename or stdin. -* [kubectl rolling-update](/docs/user-guide/kubectl/kubectl_rolling-update/) - Perform a rolling update of the given ReplicationController. -* [kubectl rollout](/docs/user-guide/kubectl/kubectl_rollout/) - rollout manages a deployment -* [kubectl run](/docs/user-guide/kubectl/kubectl_run/) - Run a particular image on the cluster. -* [kubectl scale](/docs/user-guide/kubectl/kubectl_scale/) - Set a new size for a Replication Controller, Job, or Deployment. -* [kubectl uncordon](/docs/user-guide/kubectl/kubectl_uncordon/) - Mark node as schedulable -* [kubectl version](/docs/user-guide/kubectl/kubectl_version/) - Print the client and server version information. +* [kubectl annotate](../kubectl_annotate/) - Update the annotations on a resource +* [kubectl api-versions](../kubectl_api-versions/) - Print the supported API versions on the server, in the form of "group/version". +* [kubectl apply](../kubectl_apply/) - Apply a configuration to a resource by filename or stdin +* [kubectl attach](../kubectl_attach/) - Attach to a running container. +* [kubectl autoscale](../kubectl_autoscale/) - Auto-scale a Deployment, ReplicaSet, or ReplicationController +* [kubectl cluster-info](../kubectl_cluster-info/) - Display cluster info +* [kubectl completion](../kubectl_completion/) - Output shell completion code for the given shell (bash or zsh) +* [kubectl config](../kubectl_config/) - config modifies kubeconfig files +* [kubectl convert](../kubectl_convert/) - Convert config files between different API versions +* [kubectl cordon](../kubectl_cordon/) - Mark node as unschedulable +* [kubectl create](../kubectl_create/) - Create a resource by filename or stdin +* [kubectl delete](../kubectl_delete/) - Delete resources by filenames, stdin, resources and names, or by resources and label selector. +* [kubectl describe](../kubectl_describe/) - Show details of a specific resource or group of resources +* [kubectl drain](../kubectl_drain/) - Drain node in preparation for maintenance +* [kubectl edit](../kubectl_edit/) - Edit a resource on the server +* [kubectl exec](../kubectl_exec/) - Execute a command in a container. +* [kubectl explain](../kubectl_explain/) - Documentation of resources. +* [kubectl expose](../kubectl_expose/) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service +* [kubectl get](../kubectl_get/) - Display one or many resources +* [kubectl label](../kubectl_label/) - Update the labels on a resource +* [kubectl logs](../kubectl_logs/) - Print the logs for a container in a pod. +* [kubectl namespace](../kubectl_namespace/) - SUPERSEDED: Set and view the current Kubernetes namespace +* [kubectl patch](../kubectl_patch/) - Update field(s) of a resource using strategic merge patch. +* [kubectl port-forward](../kubectl_port-forward/) - Forward one or more local ports to a pod. +* [kubectl proxy](../kubectl_proxy/) - Run a proxy to the Kubernetes API server +* [kubectl replace](../kubectl_replace/) - Replace a resource by filename or stdin. +* [kubectl rolling-update](../kubectl_rolling-update/) - Perform a rolling update of the given ReplicationController. +* [kubectl rollout](../kubectl_rollout/) - rollout manages a deployment +* [kubectl run](../kubectl_run/) - Run a particular image on the cluster. +* [kubectl scale](../kubectl_scale/) - Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. +* [kubectl set](../kubectl_set/) - Set specific features on objects +* [kubectl taint](../kubectl_taint/) - Update the taints on one or more nodes +* [kubectl uncordon](../kubectl_uncordon/) - Mark node as schedulable +* [kubectl version](../kubectl_version/) - Print the client and server version information. -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_annotate.md b/docs/user-guide/kubectl/kubectl_annotate.md index b111ed11dc..2147a0c495 100644 --- a/docs/user-guide/kubectl/kubectl_annotate.md +++ b/docs/user-guide/kubectl/kubectl_annotate.md @@ -15,10 +15,12 @@ It is intended to store non-identifying auxiliary data, especially data manipula If --overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error. If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used. -Possible resources include (case insensitive): pods (po), services (svc), -replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), -limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), -horizontalpodautoscalers (hpa), resourcequotas (quota) or secrets. +Possible resources include (case insensitive): + pod (po), service (svc), replicationcontroller (rc), + node (no), event (ev), componentstatuse (cs), + limitrange (limits), persistentvolume (pv), persistentvolumeclaim (pvc), + horizontalpodautoscaler (hpa), resourcequota (quota), secret + ``` kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version] @@ -53,11 +55,13 @@ kubectl annotate pods foo description- ``` --all[=false]: select all resources in the namespace of the specified resource types -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update the annotation + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --overwrite[=false]: If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. --record[=false]: Record current kubectl command in the resource annotation. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --resource-version="": If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. -l, --selector="": Selector (label query) to filter on -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) @@ -70,6 +74,7 @@ kubectl annotate pods foo description- ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -95,6 +100,14 @@ kubectl annotate pods foo description- ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 11-Mar-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_annotate.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_api-versions.md b/docs/user-guide/kubectl/kubectl_api-versions.md index 2a0b46a2c6..0c64fbffa1 100644 --- a/docs/user-guide/kubectl/kubectl_api-versions.md +++ b/docs/user-guide/kubectl/kubectl_api-versions.md @@ -1,5 +1,6 @@ --- --- + ## kubectl api-versions Print the supported API versions on the server, in the form of "group/version". @@ -17,6 +18,7 @@ kubectl api-versions ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -42,6 +44,14 @@ kubectl api-versions ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_api-versions.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_apply.md b/docs/user-guide/kubectl/kubectl_apply.md index a1a229bb60..807a159297 100644 --- a/docs/user-guide/kubectl/kubectl_apply.md +++ b/docs/user-guide/kubectl/kubectl_apply.md @@ -10,6 +10,7 @@ Apply a configuration to a resource by filename or stdin Apply a configuration to a resource by filename or stdin. The resource will be created if it doesn't exist yet. +To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'. JSON and YAML formats are accepted. @@ -31,8 +32,10 @@ cat pod.json | kubectl apply -f - ``` -f, --filename=[]: Filename, directory, or URL to file that contains the configuration to apply + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). --record[=false]: Record current kubectl command in the resource annotation. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' --validate[=true]: If true, use a schema to validate the input before sending it ``` @@ -41,6 +44,7 @@ cat pod.json | kubectl apply -f - ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -66,6 +70,14 @@ cat pod.json | kubectl apply -f - ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_apply.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_attach.md b/docs/user-guide/kubectl/kubectl_attach.md index a9f12a54fe..459738508d 100644 --- a/docs/user-guide/kubectl/kubectl_attach.md +++ b/docs/user-guide/kubectl/kubectl_attach.md @@ -40,6 +40,7 @@ kubectl attach 123456-7890 -c ruby-container -i -t ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -65,6 +66,14 @@ kubectl attach 123456-7890 -c ruby-container -i -t ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_attach.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_autoscale.md b/docs/user-guide/kubectl/kubectl_autoscale.md index 4b7e00001c..9e9982df2f 100644 --- a/docs/user-guide/kubectl/kubectl_autoscale.md +++ b/docs/user-guide/kubectl/kubectl_autoscale.md @@ -1,15 +1,16 @@ --- --- + ## kubectl autoscale -Auto-scale a deployment or replication controller +Auto-scale a Deployment, ReplicaSet, or ReplicationController ### Synopsis Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster. -Looks up a deployment or replication controller by name and creates an autoscaler that uses this deployment or replication controller as a reference. +Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed. ``` @@ -19,7 +20,7 @@ kubectl autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MA ### Examples ``` -# Auto scale a deployment "foo", with the number of pods between 2 to 10, target CPU utilization at a default value that server applies: +# Auto scale a deployment "foo", with the number of pods between 2 to 10, no target CPU utilization specfied so a default autoscaling policy will be used: kubectl autoscale deployment foo --min=2 --max=10 # Auto scale a replication controller "foo", with the number of pods between 1 to 5, target CPU utilization at 80%: @@ -29,17 +30,19 @@ kubectl autoscale rc foo --max=5 --cpu-percent=80 ### Options ``` - --cpu-percent=-1: The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, the server will apply a default value. - --dry-run[=false]: If true, only print the object that would be sent, without creating it. + --cpu-percent=-1: The target average CPU utilization (represented as a percent of requested CPU) over all the pods. If it's not specified or negative, a default autoscaling policy will be used. + --dry-run[=false]: If true, only print the object that would be sent, without sending it. -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to autoscale. - --generator="horizontalpodautoscaler/v1beta1": The name of the API generator to use. Currently there is only 1 generator. + --generator="horizontalpodautoscaler/v1": The name of the API generator to use. Currently there is only 1 generator. + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] --max=-1: The upper limit for the number of pods that can be set by the autoscaler. Required. --min=-1: The lower limit for the number of pods that can be set by the autoscaler. If it's not specified or negative, the server will apply a default value. --name="": The name for the newly created object. If not specified, the name of the input resource will be used. --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --record[=false]: Record current kubectl command in the resource annotation. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) @@ -51,6 +54,7 @@ kubectl autoscale rc foo --max=5 --cpu-percent=80 ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -76,6 +80,14 @@ kubectl autoscale rc foo --max=5 --cpu-percent=80 ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 11-Mar-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_autoscale.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_cluster-info.md b/docs/user-guide/kubectl/kubectl_cluster-info.md index 61e0292ba0..1e59abc4a7 100644 --- a/docs/user-guide/kubectl/kubectl_cluster-info.md +++ b/docs/user-guide/kubectl/kubectl_cluster-info.md @@ -1,5 +1,6 @@ --- --- + ## kubectl cluster-info Display cluster info @@ -8,15 +9,23 @@ Display cluster info Display addresses of the master and services with label kubernetes.io/cluster-service=true +To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'. ``` kubectl cluster-info ``` +### Options + +``` + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] +``` + ### Options inherited from parent commands ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -42,6 +51,15 @@ kubectl cluster-info ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager +* [kubectl cluster-info dump](kubectl_cluster-info_dump.md) - Dump lots of relevant info for debugging and diagnosis. -###### Auto generated by spf13/cobra on 2-Mar-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_cluster-info.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_cluster-info_dump.md b/docs/user-guide/kubectl/kubectl_cluster-info_dump.md new file mode 100644 index 0000000000..c4fd5c4488 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_cluster-info_dump.md @@ -0,0 +1,89 @@ +--- +--- + +## kubectl cluster-info dump + +Dump lots of relevant info for debugging and diagnosis. + +### Synopsis + + + +Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to +stdout. You can optionally specify a directory with --output-directory. If you specify a directory, kubernetes will +build a set of files in that directory. By default only dumps things in the 'kube-system' namespace, but you can +switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces. + +The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories +based on namespace and pod name. + + +``` +kubectl cluster-info dump +``` + +### Examples + +``` +# Dump current cluster state to stdout +kubectl cluster-info dump + +# Dump current cluster state to /path/to/cluster-state +kubectl cluster-info dump --output-directory=/path/to/cluster-state + +# Dump all namespaces to stdout +kubectl cluster-info dump --all-namespaces + +# Dump a set of namespaces to /path/to/cluster-state +kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state +``` + +### Options + +``` + --all-namespaces[=false]: If true, dump all namespaces. If true, --namespaces is ignored. + --namespaces=[]: A comma separated list of namespaces to dump. + --output-directory="": Where to output the files. If empty or '-' uses stdout, otherwise creates a directory hierarchy in that directory +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl cluster-info](kubectl_cluster-info.md) - Display cluster info + +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_cluster-info_dump.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_completion.md b/docs/user-guide/kubectl/kubectl_completion.md new file mode 100644 index 0000000000..4bd17f0930 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_completion.md @@ -0,0 +1,80 @@ +--- +--- + +## kubectl completion + +Output shell completion code for the given shell (bash or zsh) + +### Synopsis + + +Output shell completion code for the given shell (bash or zsh). + +This command prints shell code which must be evaluation to provide interactive +completion of kubectl commands. + + +``` +kubectl completion SHELL +``` + +### Examples + +``` + +$ source <(kubectl completion bash) + +will load the kubectl completion code for bash. Note that this depends on the bash-completion +framework. It must be sourced before sourcing the kubectl completion, i.e. on the Mac: + +$ brew install bash-completion +$ source $(brew --prefix)/etc/bash_completion +$ source <(kubectl completion bash) + +If you use zsh, the following will load kubectl zsh completion: + +$ source <(kubectl completion zsh) + +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_completion.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config.md b/docs/user-guide/kubectl/kubectl_config.md index 7b14316043..5aed2a043c 100644 --- a/docs/user-guide/kubectl/kubectl_config.md +++ b/docs/user-guide/kubectl/kubectl_config.md @@ -30,6 +30,7 @@ kubectl config SUBCOMMAND ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -54,15 +55,22 @@ kubectl config SUBCOMMAND ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager -* [kubectl config current-context](/docs/user-guide/kubectl/kubectl_config_current-context/) - Displays the current-context -* [kubectl config set](/docs/user-guide/kubectl/kubectl_config_set/) - Sets an individual value in a kubeconfig file -* [kubectl config set-cluster](/docs/user-guide/kubectl/kubectl_config_set-cluster/) - Sets a cluster entry in kubeconfig -* [kubectl config set-context](/docs/user-guide/kubectl/kubectl_config_set-context/) - Sets a context entry in kubeconfig -* [kubectl config set-credentials](/docs/user-guide/kubectl/kubectl_config_set-credentials/) - Sets a user entry in kubeconfig -* [kubectl config unset](/docs/user-guide/kubectl/kubectl_config_unset/) - Unsets an individual value in a kubeconfig file -* [kubectl config use-context](/docs/user-guide/kubectl/kubectl_config_use-context/) - Sets the current-context in a kubeconfig file -* [kubectl config view](/docs/user-guide/kubectl/kubectl_config_view/) - - Displays merged kubeconfig settings or a specified kubeconfig file. +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager +* [kubectl config current-context](kubectl_config_current-context.md) - Displays the current-context +* [kubectl config set](kubectl_config_set.md) - Sets an individual value in a kubeconfig file +* [kubectl config set-cluster](kubectl_config_set-cluster.md) - Sets a cluster entry in kubeconfig +* [kubectl config set-context](kubectl_config_set-context.md) - Sets a context entry in kubeconfig +* [kubectl config set-credentials](kubectl_config_set-credentials.md) - Sets a user entry in kubeconfig +* [kubectl config unset](kubectl_config_unset.md) - Unsets an individual value in a kubeconfig file +* [kubectl config use-context](kubectl_config_use-context.md) - Sets the current-context in a kubeconfig file +* [kubectl config view](kubectl_config_view.md) - Displays merged kubeconfig settings or a specified kubeconfig file. -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config_current-context.md b/docs/user-guide/kubectl/kubectl_config_current-context.md index 9f1bdf1b7e..e256fd1e7d 100644 --- a/docs/user-guide/kubectl/kubectl_config_current-context.md +++ b/docs/user-guide/kubectl/kubectl_config_current-context.md @@ -25,6 +25,7 @@ kubectl config current-context ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -50,6 +51,14 @@ kubectl config current-context ### SEE ALSO -* [kubectl config](/docs/user-guide/kubectl/kubectl_config/) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra on 2-Mar-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_current-context.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config_set-cluster.md b/docs/user-guide/kubectl/kubectl_config_set-cluster.md index c6ac6a81d9..6751cb7fa8 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-cluster.md +++ b/docs/user-guide/kubectl/kubectl_config_set-cluster.md @@ -32,7 +32,7 @@ kubectl config set-cluster e2e --insecure-skip-tls-verify=true ``` --api-version="": api-version for the cluster entry in kubeconfig - --certificate-authority="": path to certificate-authority for the cluster entry in kubeconfig + --certificate-authority="": path to certificate-authority file for the cluster entry in kubeconfig --embed-certs[=false]: embed-certs for the cluster entry in kubeconfig --insecure-skip-tls-verify[=false]: insecure-skip-tls-verify for the cluster entry in kubeconfig --server="": server for the cluster entry in kubeconfig @@ -42,6 +42,7 @@ kubectl config set-cluster e2e --insecure-skip-tls-verify=true ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. --cluster="": The name of the kubeconfig cluster to use @@ -64,6 +65,14 @@ kubectl config set-cluster e2e --insecure-skip-tls-verify=true ### SEE ALSO -* [kubectl config](/docs/user-guide/kubectl/kubectl_config/) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-cluster.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config_set-context.md b/docs/user-guide/kubectl/kubectl_config_set-context.md index fc4c9067a9..2d608e3004 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-context.md +++ b/docs/user-guide/kubectl/kubectl_config_set-context.md @@ -34,6 +34,7 @@ kubectl config set-context gce --user=cluster-admin ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -56,6 +57,14 @@ kubectl config set-context gce --user=cluster-admin ### SEE ALSO -* [kubectl config](/docs/user-guide/kubectl/kubectl_config/) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra on 2-Mar-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-context.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config_set-credentials.md b/docs/user-guide/kubectl/kubectl_config_set-credentials.md index a54bd237bf..d6dbd53110 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-credentials.md +++ b/docs/user-guide/kubectl/kubectl_config_set-credentials.md @@ -44,8 +44,8 @@ kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin. ### Options ``` - --client-certificate="": path to client-certificate for the user entry in kubeconfig - --client-key="": path to client-key for the user entry in kubeconfig + --client-certificate="": path to client-certificate file for the user entry in kubeconfig + --client-key="": path to client-key file for the user entry in kubeconfig --embed-certs[=false]: embed client cert/key for the user entry in kubeconfig --password="": password for the user entry in kubeconfig --token="": token for the user entry in kubeconfig @@ -56,6 +56,7 @@ kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin. ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --cluster="": The name of the kubeconfig cluster to use --context="": The name of the kubeconfig context to use @@ -76,6 +77,14 @@ kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin. ### SEE ALSO -* [kubectl config](/docs/user-guide/kubectl/kubectl_config/) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set-credentials.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config_set.md b/docs/user-guide/kubectl/kubectl_config_set.md index ed367924b8..96aa933e04 100644 --- a/docs/user-guide/kubectl/kubectl_config_set.md +++ b/docs/user-guide/kubectl/kubectl_config_set.md @@ -10,16 +10,23 @@ Sets an individual value in a kubeconfig file Sets an individual value in a kubeconfig file PROPERTY_NAME is a dot delimited name where each token represents either a attribute name or a map key. Map keys may not contain dots. -PROPERTY_VALUE is the new value you wish to set. +PROPERTY_VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used. ``` kubectl config set PROPERTY_NAME PROPERTY_VALUE ``` +### Options + +``` + --set-raw-bytes[=false]: When writing a []byte PROPERTY_VALUE, write the given string directly without base64 decoding. +``` + ### Options inherited from parent commands ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -45,6 +52,14 @@ kubectl config set PROPERTY_NAME PROPERTY_VALUE ### SEE ALSO -* [kubectl config](/docs/user-guide/kubectl/kubectl_config/) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_set.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config_unset.md b/docs/user-guide/kubectl/kubectl_config_unset.md index 026bcb0ddc..c7d28e2d8d 100644 --- a/docs/user-guide/kubectl/kubectl_config_unset.md +++ b/docs/user-guide/kubectl/kubectl_config_unset.md @@ -19,6 +19,7 @@ kubectl config unset PROPERTY_NAME ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -44,6 +45,14 @@ kubectl config unset PROPERTY_NAME ### SEE ALSO -* [kubectl config](/docs/user-guide/kubectl/kubectl_config/) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_unset.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config_use-context.md b/docs/user-guide/kubectl/kubectl_config_use-context.md index 61c7ca3d62..eb0040b964 100644 --- a/docs/user-guide/kubectl/kubectl_config_use-context.md +++ b/docs/user-guide/kubectl/kubectl_config_use-context.md @@ -18,6 +18,7 @@ kubectl config use-context CONTEXT_NAME ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -43,6 +44,14 @@ kubectl config use-context CONTEXT_NAME ### SEE ALSO -* [kubectl config](/docs/user-guide/kubectl/kubectl_config/) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra on 2-Mar-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_use-context.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config_view.md b/docs/user-guide/kubectl/kubectl_config_view.md index 85e36c0437..38c862cb92 100644 --- a/docs/user-guide/kubectl/kubectl_config_view.md +++ b/docs/user-guide/kubectl/kubectl_config_view.md @@ -1,5 +1,6 @@ --- --- + ## kubectl config view Displays merged kubeconfig settings or a specified kubeconfig file. @@ -32,7 +33,7 @@ kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}' --merge[=true]: merge together the full hierarchy of kubeconfig files --minify[=false]: remove all information not used by current-context from the output --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --raw[=false]: display raw byte data -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) @@ -45,6 +46,7 @@ kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}' ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -70,7 +72,14 @@ kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}' ### SEE ALSO -* [kubectl config](/docs/user-guide/kubectl/kubectl_config/) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - config modifies kubeconfig files -###### Auto generated by spf13/cobra on 11-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_view.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_convert.md b/docs/user-guide/kubectl/kubectl_convert.md index 73094994b0..df2f8e427b 100644 --- a/docs/user-guide/kubectl/kubectl_convert.md +++ b/docs/user-guide/kubectl/kubectl_convert.md @@ -1,5 +1,6 @@ --- --- + ## kubectl convert Convert config files between different API versions @@ -41,10 +42,12 @@ kubectl convert -f . | kubectl create -f - ``` -f, --filename=[]: Filename, directory, or URL to file to need to get converted. + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] --local[=true]: If true, convert will NOT try to contact api-server but run locally. --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) @@ -57,6 +60,7 @@ kubectl convert -f . | kubectl create -f - ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -82,6 +86,14 @@ kubectl convert -f . | kubectl create -f - ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 11-Mar-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_convert.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_cordon.md b/docs/user-guide/kubectl/kubectl_cordon.md index 10622187e3..be15d2e13a 100644 --- a/docs/user-guide/kubectl/kubectl_cordon.md +++ b/docs/user-guide/kubectl/kubectl_cordon.md @@ -27,6 +27,7 @@ kubectl cordon foo ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -52,6 +53,14 @@ kubectl cordon foo ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_cordon.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create.md b/docs/user-guide/kubectl/kubectl_create.md index 73d57429d6..ee8ed497f4 100644 --- a/docs/user-guide/kubectl/kubectl_create.md +++ b/docs/user-guide/kubectl/kubectl_create.md @@ -30,8 +30,10 @@ cat pod.json | kubectl create -f - ``` -f, --filename=[]: Filename, directory, or URL to file to use to create the resource + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). --record[=false]: Record current kubectl command in the resource annotation. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' --validate[=true]: If true, use a schema to validate the input before sending it @@ -41,6 +43,7 @@ cat pod.json | kubectl create -f - ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -66,10 +69,18 @@ cat pod.json | kubectl create -f - ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager -* [kubectl create configmap](/docs/user-guide/kubectl/kubectl_create_configmap/) - Create a configMap from a local file, directory or literal value. -* [kubectl create namespace](/docs/user-guide/kubectl/kubectl_create_namespace/) - Create a namespace with the specified name. -* [kubectl create secret](/docs/user-guide/kubectl/kubectl_create_secret/) - Create a secret using specified subcommand. -* [kubectl create serviceaccount](/docs/user-guide/kubectl/kubectl_create_serviceaccount/) - Create a service account with the specified name. +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager +* [kubectl create configmap](kubectl_create_configmap.md) - Create a configMap from a local file, directory or literal value. +* [kubectl create namespace](kubectl_create_namespace.md) - Create a namespace with the specified name. +* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand. +* [kubectl create serviceaccount](kubectl_create_serviceaccount.md) - Create a service account with the specified name. -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_configmap.md b/docs/user-guide/kubectl/kubectl_create_configmap.md index e1b608ceda..ced4196333 100644 --- a/docs/user-guide/kubectl/kubectl_create_configmap.md +++ b/docs/user-guide/kubectl/kubectl_create_configmap.md @@ -21,7 +21,7 @@ symlinks, devices, pipes, etc). ``` -kubectl create configmap NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run] +kubectl create configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run] ``` ### Examples @@ -31,7 +31,7 @@ kubectl create configmap NAME [--type=string] [--from-file=[key=]source] [--from kubectl create configmap my-config --from-file=path/to/bar # Create a new configmap named my-config with specified keys instead of names on disk - kubectl create configmap my-config --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub + kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt # Create a new configMap named my-config with key1=config1 and key2=config2 kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2 @@ -45,7 +45,7 @@ kubectl create configmap NAME [--type=string] [--from-file=[key=]source] [--from --from-literal=[]: Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) --generator="configmap/v1": The name of the API generator to use. --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' @@ -60,6 +60,7 @@ kubectl create configmap NAME [--type=string] [--from-file=[key=]source] [--from ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -85,6 +86,14 @@ kubectl create configmap NAME [--type=string] [--from-file=[key=]source] [--from ### SEE ALSO -* [kubectl create](/docs/user-guide/kubectl/kubectl_create/) - Create a resource by filename or stdin +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin -###### Auto generated by spf13/cobra on 11-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_configmap.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_namespace.md b/docs/user-guide/kubectl/kubectl_create_namespace.md index 1cc5086948..a0e9198e09 100644 --- a/docs/user-guide/kubectl/kubectl_create_namespace.md +++ b/docs/user-guide/kubectl/kubectl_create_namespace.md @@ -1,5 +1,6 @@ --- --- + ## kubectl create namespace Create a namespace with the specified name. @@ -27,7 +28,7 @@ kubectl create namespace NAME [--dry-run] --dry-run[=false]: If true, only print the object that would be sent, without sending it. --generator="namespace/v1": The name of the API generator to use. --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' @@ -42,6 +43,7 @@ kubectl create namespace NAME [--dry-run] ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -67,6 +69,14 @@ kubectl create namespace NAME [--dry-run] ### SEE ALSO -* [kubectl create](/docs/user-guide/kubectl/kubectl_create/) - Create a resource by filename or stdin +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin -###### Auto generated by spf13/cobra on 11-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_namespace.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_secret.md b/docs/user-guide/kubectl/kubectl_create_secret.md index 17277fefec..6c4ef4a935 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret.md +++ b/docs/user-guide/kubectl/kubectl_create_secret.md @@ -18,6 +18,7 @@ kubectl create secret ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -43,8 +44,17 @@ kubectl create secret ### SEE ALSO -* [kubectl create](/docs/user-guide/kubectl/kubectl_create/) - Create a resource by filename or stdin -* [kubectl create secret docker-registry](/docs/user-guide/kubectl/kubectl_create_secret_docker-registry/) - Create a secret for use with a Docker registry. -* [kubectl create secret generic](/docs/user-guide/kubectl/kubectl_create_secret_generic/) - Create a secret from a local file, directory or literal value. +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin +* [kubectl create secret docker-registry](kubectl_create_secret_docker-registry.md) - Create a secret for use with a Docker registry. +* [kubectl create secret generic](kubectl_create_secret_generic.md) - Create a secret from a local file, directory or literal value. +* [kubectl create secret tls](kubectl_create_secret_tls.md) - Create a TLS secret. -###### Auto generated by spf13/cobra on 2-Mar-2016 \ No newline at end of file +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_secret.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md b/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md index e740d590ee..1d821f262f 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md @@ -1,5 +1,6 @@ --- --- + ## kubectl create secret docker-registry Create a secret for use with a Docker registry. @@ -29,7 +30,7 @@ kubectl create secret docker-registry NAME --docker-username=user --docker-passw ``` # If you don't already have a .dockercfg file, you can create a dockercfg secret directly by using: - $ kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL + kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL ``` ### Options @@ -41,8 +42,9 @@ kubectl create secret docker-registry NAME --docker-username=user --docker-passw --docker-username="": Username for Docker registry authentication --dry-run[=false]: If true, only print the object that would be sent, without sending it. --generator="secret-for-docker-registry/v1": The name of the API generator to use. + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' @@ -57,6 +59,7 @@ kubectl create secret docker-registry NAME --docker-username=user --docker-passw ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -82,6 +85,14 @@ kubectl create secret docker-registry NAME --docker-username=user --docker-passw ### SEE ALSO -* [kubectl create secret](/docs/user-guide/kubectl/kubectl_create_secret/) - Create a secret using specified subcommand. +* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand. -###### Auto generated by spf13/cobra on 11-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_secret_generic.md b/docs/user-guide/kubectl/kubectl_create_secret_generic.md index e443c00a5d..9d059b729c 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_generic.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_generic.md @@ -46,7 +46,7 @@ kubectl create secret generic NAME [--type=string] [--from-file=[key=]source] [- --from-literal=[]: Specify a key and literal value to insert in secret (i.e. mykey=somevalue) --generator="secret/v1": The name of the API generator to use. --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' @@ -62,6 +62,7 @@ kubectl create secret generic NAME [--type=string] [--from-file=[key=]source] [- ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -87,6 +88,14 @@ kubectl create secret generic NAME [--type=string] [--from-file=[key=]source] [- ### SEE ALSO -* [kubectl create secret](/docs/user-guide/kubectl/kubectl_create_secret/) - Create a secret using specified subcommand. +* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand. -###### Auto generated by spf13/cobra on 11-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_secret_generic.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_secret_tls.md b/docs/user-guide/kubectl/kubectl_create_secret_tls.md new file mode 100644 index 0000000000..e66c20c5a1 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_create_secret_tls.md @@ -0,0 +1,86 @@ +--- +--- + +## kubectl create secret tls + +Create a TLS secret. + +### Synopsis + + + +Create a TLS secret from the given public/private key pair. + +The public/private key pair must exist before hand. The public key certificate must be .PEM encoded and match the given private key. + +``` +kubectl create secret tls NAME --cert=path/to/cert/file --key=path/to/key/file [--dry-run] +``` + +### Examples + +``` + # Create a new TLS secret named tls-secret with the given key pair: + kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key +``` + +### Options + +``` + --cert="": Path to PEM encoded public key certificate. + --dry-run[=false]: If true, only print the object that would be sent, without sending it. + --generator="secret-for-tls/v1": The name of the API generator to use. + --key="": Path to private key associated with given certificate. + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. + --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand. + +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_secret_tls.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md index d6444333ef..ba1dd8d3e1 100644 --- a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md +++ b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md @@ -27,8 +27,9 @@ kubectl create serviceaccount NAME [--dry-run] ``` --dry-run[=false]: If true, only print the object that would be sent, without sending it. --generator="serviceaccount/v1": The name of the API generator to use. + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' @@ -43,6 +44,7 @@ kubectl create serviceaccount NAME [--dry-run] ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -68,6 +70,14 @@ kubectl create serviceaccount NAME [--dry-run] ### SEE ALSO -* [kubectl create](/docs/user-guide/kubectl/kubectl_create/) - Create a resource by filename or stdin +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin -###### Auto generated by spf13/cobra on 11-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_serviceaccount.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_delete.md b/docs/user-guide/kubectl/kubectl_delete.md index a2ac9ecc68..244580fa94 100644 --- a/docs/user-guide/kubectl/kubectl_delete.md +++ b/docs/user-guide/kubectl/kubectl_delete.md @@ -37,6 +37,9 @@ kubectl delete pod,service baz foo # Delete pods and services with label name=myLabel. kubectl delete pods,services -l name=myLabel +# Delete a pod immediately (no graceful shutdown) +kubectl delete pod foo --now + # Delete a pod with UID 1234-56-7890-234234-456456. kubectl delete pod 1234-56-7890-234234-456456 @@ -52,7 +55,10 @@ kubectl delete pods --all -f, --filename=[]: Filename, directory, or URL to a file containing the resource to delete. --grace-period=-1: Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. --ignore-not-found[=false]: Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified. + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] + --now[=false]: If true, resources are force terminated without graceful deletion (same as --grace-period=0). -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. -l, --selector="": Selector (label query) to filter on. --timeout=0: The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object ``` @@ -61,6 +67,7 @@ kubectl delete pods --all ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -86,7 +93,14 @@ kubectl delete pods --all ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_delete.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_describe.md b/docs/user-guide/kubectl/kubectl_describe.md index e6ba472f04..e4a717f571 100644 --- a/docs/user-guide/kubectl/kubectl_describe.md +++ b/docs/user-guide/kubectl/kubectl_describe.md @@ -18,11 +18,11 @@ $ kubectl describe TYPE NAME_PREFIX will first check for an exact match on TYPE and NAME_PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME_PREFIX -Possible resource types include (case insensitive): pods (po), services (svc), -replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), -persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), -namespaces (ns), serviceaccounts, horizontalpodautoscalers (hpa), -endpoints (ep) or secrets. +Possible resource types include (case insensitive): pods (po), services (svc), deployments, +replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), +persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), +serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, +componentstatuses (cs), endpoints (ep), and secrets. ``` kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME) @@ -55,13 +55,17 @@ kubectl describe pods frontend ``` -f, --filename=[]: Filename, directory, or URL to a file containing the resource to describe + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. -l, --selector="": Selector (label query) to filter on + --show-events[=true]: If true, display events related to the described object. ``` ### Options inherited from parent commands ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -87,6 +91,14 @@ kubectl describe pods frontend ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_describe.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_drain.md b/docs/user-guide/kubectl/kubectl_drain.md index b1b3b8f3cb..535b6e024d 100644 --- a/docs/user-guide/kubectl/kubectl_drain.md +++ b/docs/user-guide/kubectl/kubectl_drain.md @@ -17,7 +17,8 @@ without --ignore-daemonsets, and regardless it will not delete any DaemonSet-managed pods, because those pods would be immediately replaced by the DaemonSet controller, which ignores unschedulable markings. If there are any pods that are neither mirror pods nor managed--by ReplicationController, -DaemonSet or Job--, then drain will not delete any pods unless you use --force. +ReplicaSet, DaemonSet or Job--, then drain will not delete any pods unless you +use --force. When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again. @@ -30,10 +31,10 @@ kubectl drain NODE ### Examples ``` -# Drain node "foo", even if there are pods not managed by a ReplicationController, Job, or DaemonSet on it. +# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. $ kubectl drain foo --force -# As above, but abort if there are pods not managed by a ReplicationController, Job, or DaemonSet, and use a grace period of 15 minutes. +# As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes. $ kubectl drain foo --grace-period=900 ``` @@ -41,7 +42,8 @@ $ kubectl drain foo --grace-period=900 ### Options ``` - --force[=false]: Continue even if there are pods not managed by a ReplicationController, Job, or DaemonSet. + --delete-local-data[=false]: Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained). + --force[=false]: Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet. --grace-period=-1: Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. --ignore-daemonsets[=false]: Ignore DaemonSet-managed pods. ``` @@ -50,6 +52,7 @@ $ kubectl drain foo --grace-period=900 ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -75,7 +78,14 @@ $ kubectl drain foo --grace-period=900 ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_drain.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_edit.md b/docs/user-guide/kubectl/kubectl_edit.md index 69172ea722..3c0c1c779f 100644 --- a/docs/user-guide/kubectl/kubectl_edit.md +++ b/docs/user-guide/kubectl/kubectl_edit.md @@ -49,9 +49,11 @@ kubectl edit (RESOURCE/NAME | -f FILENAME) ``` -f, --filename=[]: Filename, directory, or URL to file to use to edit the resource + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] -o, --output="yaml": Output format. One of: yaml|json. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --record[=false]: Record current kubectl command in the resource annotation. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. --windows-line-endings[=false]: Use Windows line-endings (default Unix line-endings) ``` @@ -60,6 +62,7 @@ kubectl edit (RESOURCE/NAME | -f FILENAME) ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -85,6 +88,14 @@ kubectl edit (RESOURCE/NAME | -f FILENAME) ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_edit.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_exec.md b/docs/user-guide/kubectl/kubectl_exec.md index c6ae03632d..90ac608d88 100644 --- a/docs/user-guide/kubectl/kubectl_exec.md +++ b/docs/user-guide/kubectl/kubectl_exec.md @@ -41,6 +41,7 @@ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -66,6 +67,14 @@ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_exec.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_explain.md b/docs/user-guide/kubectl/kubectl_explain.md index 60c0a9e3de..8834c0bfe7 100644 --- a/docs/user-guide/kubectl/kubectl_explain.md +++ b/docs/user-guide/kubectl/kubectl_explain.md @@ -10,11 +10,11 @@ Documentation of resources. Documentation of resources. -Possible resource types include: pods (po), services (svc), -replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), -limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), -resourcequotas (quota), namespaces (ns), horizontalpodautoscalers (hpa) -or endpoints (ep). +Possible resource types include (case insensitive): pods (po), services (svc), deployments, +replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), +persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), +serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, +componentstatuses (cs), endpoints (ep), and secrets. ``` kubectl explain RESOURCE @@ -33,6 +33,7 @@ kubectl explain pods.spec.containers ### Options ``` + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] --recursive[=false]: Print the fields of fields (Currently only 1 level deep) ``` @@ -40,6 +41,7 @@ kubectl explain pods.spec.containers ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -65,7 +67,14 @@ kubectl explain pods.spec.containers ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_explain.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_expose.md b/docs/user-guide/kubectl/kubectl_expose.md index 917dfdedb7..8721819ff5 100644 --- a/docs/user-guide/kubectl/kubectl_expose.md +++ b/docs/user-guide/kubectl/kubectl_expose.md @@ -3,19 +3,24 @@ ## kubectl expose -Take a replication controller, service or pod and expose it as a new Kubernetes Service +Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service ### Synopsis -Take a replication controller, service, replica set or pod and expose it as a new Kubernetes service. +Expose a resource as a new Kubernetes service. + +Looks up a deployment, service, replica set, replication controller or pod by name and uses the selector +for that resource as the selector for a new service on the specified port. A deployment or replica set +will be exposed as a service only if its selector is convertible to a selector that service supports, +i.e. when the selector contains only the matchLabels component. Note that if no port is specified via +--port and the exposed resource has multiple ports, all will be re-used by the new service. Also if no +labels are specified, the new service will re-use the labels from the resource it exposes. + +Possible resources include (case insensitive): + pod (po), service (svc), replicationcontroller (rc), + deployment, replicaset (rs) -Looks up a replication controller, service, replica set or pod by name and uses the selector for that -resource as the selector for a new service on the specified port. A replica set will be exposed as a -service only if it's selector is convertible to a selector that service supports, i.e. when the -replica set selector contains only the matchLabels component. Note that if no port is specified -via --port and the exposed resource has multiple ports, all will be re-used by the new service. Also -if no labels are specified, the new service will re-use the labels from the resource it exposes. ``` kubectl expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [--external-ip=external-ip-of-service] [--type=type] @@ -41,13 +46,15 @@ kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream # Create a service for a replicated nginx using replica set, which serves on port 80 and connects to the containers on port 8000. kubectl expose rs nginx --port=80 --target-port=8000 + +# Create a service for an nginx deployment, which serves on port 80 and connects to the containers on port 8000. +kubectl expose deployment nginx --port=80 --target-port=8000 ``` ### Options ``` - --container-port="": Synonym for --target-port - --dry-run[=false]: If true, only print the object that would be sent, without creating it. + --dry-run[=false]: If true, only print the object that would be sent, without sending it. --external-ip="": Additional external IP address (not managed by Kubernetes) to accept for the service. If this IP is routed to a node, the service can be accessed by this IP in addition to its generated service IP. -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to expose a service --generator="service/v2": The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'. @@ -55,12 +62,13 @@ kubectl expose rs nginx --port=80 --target-port=8000 --load-balancer-ip="": IP to assign to to the Load Balancer. If empty, an ephemeral IP will be created and used (cloud-provider specific). --name="": The name for the newly created object. --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --overrides="": An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. --port="": The port that the service should serve on. Copied from the resource being exposed, if unspecified - --protocol="TCP": The network protocol for the service to be created. Default is 'tcp'. + --protocol="": The network protocol for the service to be created. Default is 'TCP'. --record[=false]: Record current kubectl command in the resource annotation. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. --selector="": A label selector to use for this service. Only equality-based selector requirements are supported. If empty (the default) infer the selector from the replication controller or replica set. --session-affinity="": If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP' @@ -76,6 +84,7 @@ kubectl expose rs nginx --port=80 --target-port=8000 ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -101,7 +110,14 @@ kubectl expose rs nginx --port=80 --target-port=8000 ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 11-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_expose.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_get.md b/docs/user-guide/kubectl/kubectl_get.md index 37f18f9cec..33a2200cce 100644 --- a/docs/user-guide/kubectl/kubectl_get.md +++ b/docs/user-guide/kubectl/kubectl_get.md @@ -10,11 +10,11 @@ Display one or many resources Display one or many resources. -Possible resource types include (case insensitive): pods (po), services (svc), -replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs), -limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc), -resourcequotas (quota), namespaces (ns), endpoints (ep), -horizontalpodautoscalers (hpa), serviceaccounts or secrets. +Possible resource types include (case insensitive): pods (po), services (svc), deployments, +replicasets (rs), replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits), +persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota), namespaces (ns), +serviceaccounts (sa), ingresses (ing), horizontalpodautoscalers (hpa), daemonsets (ds), configmaps, +componentstatuses (cs), endpoints (ep), and secrets. By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resource(s). @@ -42,7 +42,7 @@ kubectl get -o json pod web-pod-13je7 kubectl get -f pod.yaml -o json # Return only the phase value of the specified pod. -kubectl get -o template pod/web-pod-13je7 --template={% raw %}{{.status.phase}}{% endraw %} +kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}} # List all replication controllers and services together in ps output format. kubectl get rc,services @@ -57,10 +57,12 @@ kubectl get rc/web service/frontend pods/web-pod-13je7 --all-namespaces[=false]: If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. --export[=false]: If true, use 'export' for the resources. Exported resources are stripped of cluster-specific information. -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] -L, --label-columns=[]: Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag statements like -L label1 -L label2... --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. -l, --selector="": Selector (label query) to filter on -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) @@ -74,6 +76,7 @@ kubectl get rc/web service/frontend pods/web-pod-13je7 ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -99,6 +102,14 @@ kubectl get rc/web service/frontend pods/web-pod-13je7 ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 11-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_get.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_label.md b/docs/user-guide/kubectl/kubectl_label.md index 2c527025bb..7aa65a5c89 100644 --- a/docs/user-guide/kubectl/kubectl_label.md +++ b/docs/user-guide/kubectl/kubectl_label.md @@ -47,11 +47,13 @@ kubectl label pods foo bar- --all[=false]: select all resources in the namespace of the specified resource types --dry-run[=false]: If true, only print the object that would be sent, without sending it. -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update the labels + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --overwrite[=false]: If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. --record[=false]: Record current kubectl command in the resource annotation. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --resource-version="": If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource. -l, --selector="": Selector (label query) to filter on -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) @@ -64,6 +66,7 @@ kubectl label pods foo bar- ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -89,7 +92,14 @@ kubectl label pods foo bar- ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 11-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_label.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_logs.md b/docs/user-guide/kubectl/kubectl_logs.md index 588b3d5ba9..19e1d37fdc 100644 --- a/docs/user-guide/kubectl/kubectl_logs.md +++ b/docs/user-guide/kubectl/kubectl_logs.md @@ -38,6 +38,7 @@ kubectl logs --since=1h nginx ``` -c, --container="": Print the logs of this container -f, --follow[=false]: Specify if the logs should be streamed. + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] --limit-bytes=0: Maximum bytes of logs to return. Defaults to no limit. -p, --previous[=false]: If true, print the logs for the previous instance of the container in a pod if it exists. --since=0: Only return logs newer than a relative duration like 5s, 2m, or 3h. Defaults to all logs. Only one of since-time / since may be used. @@ -50,6 +51,7 @@ kubectl logs --since=1h nginx ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -75,7 +77,14 @@ kubectl logs --since=1h nginx ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_logs.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_namespace.md b/docs/user-guide/kubectl/kubectl_namespace.md index 5865607194..2c9a4b43d3 100644 --- a/docs/user-guide/kubectl/kubectl_namespace.md +++ b/docs/user-guide/kubectl/kubectl_namespace.md @@ -21,6 +21,7 @@ kubectl namespace [namespace] ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -46,6 +47,14 @@ kubectl namespace [namespace] ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_namespace.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_patch.md b/docs/user-guide/kubectl/kubectl_patch.md index 08daf58185..470c2a6bc9 100644 --- a/docs/user-guide/kubectl/kubectl_patch.md +++ b/docs/user-guide/kubectl/kubectl_patch.md @@ -12,7 +12,7 @@ Update field(s) of a resource using strategic merge patch JSON and YAML formats are accepted. -Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/api-reference/v1/definitions.html to find if a field is mutable. +Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/v1.3.0-beta.0/docs/api-reference/v1/definitions.html to find if a field is mutable. ``` kubectl patch (-f FILENAME | TYPE NAME) -p PATCH @@ -32,16 +32,18 @@ kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}' kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}' # Update a container's image using a json patch with positional arrays -kubectl patch pod valid-pod -type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]' +kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]' ``` ### Options ``` -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). -p, --patch="": The patch to be applied to the resource JSON file. --record[=false]: Record current kubectl command in the resource annotation. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --type="strategic": The type of patch being provided; one of [json merge strategic] ``` @@ -49,6 +51,7 @@ kubectl patch pod valid-pod -type='json' -p='[{"op": "replace", "path": "/spec/c ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -74,7 +77,14 @@ kubectl patch pod valid-pod -type='json' -p='[{"op": "replace", "path": "/spec/c ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_patch.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_port-forward.md b/docs/user-guide/kubectl/kubectl_port-forward.md index 980dc2779d..4fa519f51b 100644 --- a/docs/user-guide/kubectl/kubectl_port-forward.md +++ b/docs/user-guide/kubectl/kubectl_port-forward.md @@ -1,5 +1,6 @@ --- --- + ## kubectl port-forward Forward one or more local ports to a pod. @@ -40,6 +41,7 @@ kubectl port-forward mypod 0:5000 ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -65,7 +67,14 @@ kubectl port-forward mypod 0:5000 ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_port-forward.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_proxy.md b/docs/user-guide/kubectl/kubectl_proxy.md index e42ad7cff3..501ba3c5fa 100644 --- a/docs/user-guide/kubectl/kubectl_proxy.md +++ b/docs/user-guide/kubectl/kubectl_proxy.md @@ -64,6 +64,7 @@ kubectl proxy --api-prefix=/k8s-api ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -89,7 +90,14 @@ kubectl proxy --api-prefix=/k8s-api ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_proxy.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_replace.md b/docs/user-guide/kubectl/kubectl_replace.md index 667a78042c..f2edc3c9bc 100644 --- a/docs/user-guide/kubectl/kubectl_replace.md +++ b/docs/user-guide/kubectl/kubectl_replace.md @@ -14,7 +14,7 @@ JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by $ kubectl get TYPE NAME -o yaml -Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.2/docs/api-reference/v1/definitions.html to find if a field is mutable. +Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/v1.3.0-beta.0/docs/api-reference/v1/definitions.html to find if a field is mutable. ``` kubectl replace -f FILENAME @@ -43,8 +43,10 @@ kubectl replace --force -f ./pod.json -f, --filename=[]: Filename, directory, or URL to file to use to replace the resource. --force[=false]: Delete and re-create the specified resource --grace-period=-1: Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative. + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). --record[=false]: Record current kubectl command in the resource annotation. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' --timeout=0: Only relevant during a force replace. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object @@ -55,6 +57,7 @@ kubectl replace --force -f ./pod.json ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -80,7 +83,14 @@ kubectl replace --force -f ./pod.json ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_replace.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_rolling-update.md b/docs/user-guide/kubectl/kubectl_rolling-update.md index fddbb8069a..65e330ea9f 100644 --- a/docs/user-guide/kubectl/kubectl_rolling-update.md +++ b/docs/user-guide/kubectl/kubectl_rolling-update.md @@ -1,5 +1,6 @@ --- --- + ## kubectl rolling-update Perform a rolling update of the given ReplicationController. @@ -43,11 +44,13 @@ kubectl rolling-update frontend-v1 frontend-v2 --rollback ``` --container="": Container name which will have its image upgraded. Only relevant when --image is specified, ignored otherwise. Required when using --image on a multi-container pod --deployment-label-key="deployment": The key to use to differentiate between two different controllers, default 'deployment'. Only relevant when --image is specified, ignored otherwise - --dry-run[=false]: If true, print out the changes that would be made, but don't actually make them. + --dry-run[=false]: If true, only print the object that would be sent, without sending it. -f, --filename=[]: Filename or URL to file to use to create the new replication controller. --image="": Image to use for upgrading the replication controller. Must be distinct from the existing image (either new image or new image tag). Can not be used with --filename/-f + --image-pull-policy="": Explicit policy for when to pull container images. Required when --image is same as existing image, ignored otherwise. + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --poll-interval=3s: Time delay between polling for replication controller status after the update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". --rollback[=false]: If true, this is a request to abort an existing rollout that is partially rolled out. It effectively reverses current and next and runs a rollout @@ -65,6 +68,7 @@ kubectl rolling-update frontend-v1 frontend-v2 --rollback ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -90,7 +94,14 @@ kubectl rolling-update frontend-v1 frontend-v2 --rollback ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 11-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rolling-update.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_rollout.md b/docs/user-guide/kubectl/kubectl_rollout.md index b8ac2566a1..dc8a696359 100644 --- a/docs/user-guide/kubectl/kubectl_rollout.md +++ b/docs/user-guide/kubectl/kubectl_rollout.md @@ -8,7 +8,7 @@ rollout manages a deployment ### Synopsis -rollout manages a deployment using subcommands like "kubectl rollout undo deployment/abc" +Manages a deployment using subcommands like "kubectl rollout undo deployment/abc" ``` kubectl rollout SUBCOMMAND @@ -25,6 +25,7 @@ kubectl rollout undo deployment/abc ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -50,11 +51,19 @@ kubectl rollout undo deployment/abc ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager -* [kubectl rollout history](/docs/user-guide/kubectl/kubectl_rollout_history/) - view rollout history -* [kubectl rollout pause](/docs/user-guide/kubectl/kubectl_rollout_pause/) - Mark the provided resource as paused -* [kubectl rollout resume](/docs/user-guide/kubectl/kubectl_rollout_resume/) - Resume a paused resource -* [kubectl rollout undo](/docs/user-guide/kubectl/kubectl_rollout_undo/) - undoes a previous rollout +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager +* [kubectl rollout history](kubectl_rollout_history.md) - view rollout history +* [kubectl rollout pause](kubectl_rollout_pause.md) - Mark the provided resource as paused +* [kubectl rollout resume](kubectl_rollout_resume.md) - Resume a paused resource +* [kubectl rollout status](kubectl_rollout_status.md) - Watch rollout status until it's done +* [kubectl rollout undo](kubectl_rollout_undo.md) - undoes a previous rollout -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_rollout_history.md b/docs/user-guide/kubectl/kubectl_rollout_history.md index e0fda4c24d..b26cdb1b5a 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_history.md +++ b/docs/user-guide/kubectl/kubectl_rollout_history.md @@ -8,7 +8,7 @@ view rollout history ### Synopsis -view previous rollout revisions and configurations. +View previous rollout revisions and configurations. ``` kubectl rollout history (TYPE NAME | TYPE/NAME) [flags] @@ -19,12 +19,16 @@ kubectl rollout history (TYPE NAME | TYPE/NAME) [flags] ``` # View the rollout history of a deployment kubectl rollout history deployment/abc + +# View the details of deployment revision 3 +kubectl rollout history deployment/abc --revision=3 ``` ### Options ``` -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --revision=0: See the details, including podTemplate of the revision specified ``` @@ -32,6 +36,7 @@ kubectl rollout history deployment/abc ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -57,7 +62,14 @@ kubectl rollout history deployment/abc ### SEE ALSO -* [kubectl rollout](/docs/user-guide/kubectl/kubectl_rollout/) - rollout manages a deployment +* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_history.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_rollout_pause.md b/docs/user-guide/kubectl/kubectl_rollout_pause.md index 1746cb356c..8e73d917ae 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_pause.md +++ b/docs/user-guide/kubectl/kubectl_rollout_pause.md @@ -31,12 +31,14 @@ kubectl rollout pause deployment/nginx ``` -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. ``` ### Options inherited from parent commands ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -62,6 +64,14 @@ kubectl rollout pause deployment/nginx ### SEE ALSO -* [kubectl rollout](/docs/user-guide/kubectl/kubectl_rollout/) - rollout manages a deployment +* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_pause.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_rollout_resume.md b/docs/user-guide/kubectl/kubectl_rollout_resume.md index 4db2735a22..681cf6add6 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_resume.md +++ b/docs/user-guide/kubectl/kubectl_rollout_resume.md @@ -29,12 +29,14 @@ kubectl rollout resume deployment/nginx ``` -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. ``` ### Options inherited from parent commands ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -60,6 +62,14 @@ kubectl rollout resume deployment/nginx ### SEE ALSO -* [kubectl rollout](/docs/user-guide/kubectl/kubectl_rollout/) - rollout manages a deployment +* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_resume.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_rollout_status.md b/docs/user-guide/kubectl/kubectl_rollout_status.md new file mode 100644 index 0000000000..a5ac92c5b2 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_rollout_status.md @@ -0,0 +1,71 @@ +--- +--- + +## kubectl rollout status + +Watch rollout status until it's done + +### Synopsis + + +Watch the status of current rollout, until it's done. + +``` +kubectl rollout status (TYPE NAME | TYPE/NAME) [flags] +``` + +### Examples + +``` +# Watch the rollout status of a deployment +kubectl rollout status deployment/nginx +``` + +### Options + +``` + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment + +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_status.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_rollout_undo.md b/docs/user-guide/kubectl/kubectl_rollout_undo.md index 7fde2b92d9..890cd54b6a 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_undo.md +++ b/docs/user-guide/kubectl/kubectl_rollout_undo.md @@ -8,7 +8,7 @@ undoes a previous rollout ### Synopsis -undo rolls back to a previous rollout. +Rollback to a previous rollout. ``` kubectl rollout undo (TYPE NAME | TYPE/NAME) [flags] @@ -19,12 +19,16 @@ kubectl rollout undo (TYPE NAME | TYPE/NAME) [flags] ``` # Rollback to the previous deployment kubectl rollout undo deployment/abc + +# Rollback to deployment revision 3 +kubectl rollout undo deployment/abc --to-revision=3 ``` ### Options ``` -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --to-revision=0: The revision to rollback to. Default to 0 (last revision). ``` @@ -32,6 +36,7 @@ kubectl rollout undo deployment/abc ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -57,7 +62,14 @@ kubectl rollout undo deployment/abc ### SEE ALSO -* [kubectl rollout](/docs/user-guide/kubectl/kubectl_rollout/) - rollout manages a deployment +* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_rollout_undo.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_run.md b/docs/user-guide/kubectl/kubectl_run.md index 74543b781a..e534a24ac8 100644 --- a/docs/user-guide/kubectl/kubectl_run.md +++ b/docs/user-guide/kubectl/kubectl_run.md @@ -36,8 +36,8 @@ kubectl run nginx --image=nginx --dry-run # Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON. kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }' -# Start a single instance of busybox and keep it in the foreground, don't restart it if it exits. -kubectl run -i --tty busybox --image=busybox --restart=Never +# Start a pod of busybox and keep it in the foreground, don't restart it if it exits. +kubectl run -i -t busybox --image=busybox --restart=Never # Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command. kubectl run nginx --image=nginx -- ... @@ -52,26 +52,27 @@ kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print ### Options ``` - --attach[=false]: If true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called. Default false, unless '-i/--interactive' is set, in which case the default is true. + --attach[=false]: If true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called. Default false, unless '-i/--stdin' is set, in which case the default is true. --command[=false]: If true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default. --dry-run[=false]: If true, only print the object that would be sent, without sending it. --env=[]: Environment variables to set in the container --expose[=false]: If true, a public, external service is created for the container(s) which are run - --generator="": The name of the API generator to use. Default is 'deployment/v1beta1' if --restart=Always, otherwise the default is 'job/v1'. This will happen only for cluster version at least 1.2, for olders we will fallback to 'run/v1' for --restart=Always, 'run-pod/v1' for others. + --generator="": The name of the API generator to use. Default is 'deployment/v1beta1' if --restart=Always, 'job/v1' for OnFailure and 'run-pod/v1' for Never. This will happen only for cluster version at least 1.3, for 1.2 we will fallback to 'deployment/v1beta1' for --restart=Always, 'job/v1' for others, for olders we will fallback to 'run/v1' for --restart=Always, 'run-pod/v1' for others. --hostport=-1: The host port mapping for the container port. To demonstrate a single-machine container. --image="": The image for the container to run. + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] -l, --labels="": Labels to apply to the pod(s). --leave-stdin-open[=false]: If the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes. - --limits="": The resource requirement limits for this container. For example, 'cpu=200m,memory=512Mi' + --limits="": The resource requirement limits for this container. For example, 'cpu=200m,memory=512Mi'. Note that server side components may assign limits depending on the server configuration, such as limit ranges. --no-headers[=false]: When using the default output, don't print headers. - -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md]. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). --overrides="": An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. --port=-1: The port that this container exposes. If --expose is true, this is also the port used by the service that is created. --record[=false]: Record current kubectl command in the resource annotation. -r, --replicas=1: Number of replicas to create for this container. Default is 1. - --requests="": The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi' - --restart="Always": The restart policy for this Pod. Legal values [Always, OnFailure, Never]. If set to 'Always' a deployment is created for this pod, if set to OnFailure or Never, a job is created for this pod and --replicas must be 1. Default 'Always' + --requests="": The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges. + --restart="Always": The restart policy for this Pod. Legal values [Always, OnFailure, Never]. If set to 'Always' a deployment is created for this pod, if set to 'OnFailure', a job is created for this pod, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1. Default 'Always' --rm[=false]: If true, delete resources created in this command for attached containers. --save-config[=false]: If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. --service-generator="service/v2": The name of the generator to use for creating a service. Only used if --expose is true @@ -81,13 +82,14 @@ kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. -i, --stdin[=false]: Keep stdin open on the container(s) in the pod, even if nothing is attached. --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. - --tty[=false]: Allocated a TTY for each container in the pod. Because -t is currently shorthand for --template, -t is not supported for --tty. This shorthand is deprecated and we expect to adopt -t for --tty soon. + -t, --tty[=false]: Allocated a TTY for each container in the pod. ``` ### Options inherited from parent commands ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -113,7 +115,14 @@ kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 11-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_run.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_scale.md b/docs/user-guide/kubectl/kubectl_scale.md index f2ad13c4f9..415bcf4871 100644 --- a/docs/user-guide/kubectl/kubectl_scale.md +++ b/docs/user-guide/kubectl/kubectl_scale.md @@ -3,12 +3,12 @@ ## kubectl scale -Set a new size for a Replication Controller, Job, or Deployment. +Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. ### Synopsis -Set a new size for a Replication Controller, Job, or Deployment. +Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. Scale also allows users to specify one or more preconditions for the scale action. If --current-replicas or --resource-version is specified, it is validated before the @@ -22,8 +22,8 @@ kubectl scale [--resource-version=version] [--current-replicas=count] --replicas ### Examples ``` -# Scale replication controller named 'foo' to 3. -kubectl scale --replicas=3 rc/foo +# Scale a replicaset named 'foo' to 3. +kubectl scale --replicas=3 rs/foo # Scale a resource identified by type and name specified in "foo.yaml" to 3. kubectl scale --replicas=3 -f foo.yaml @@ -43,8 +43,10 @@ kubectl scale --replicas=3 job/cron ``` --current-replicas=-1: Precondition for current size. Requires that the current size of the resource match this value in order to scale. -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to set a new size + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] -o, --output="": Output mode. Use "-o name" for shorter output (resource/name). --record[=false]: Record current kubectl command in the resource annotation. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. --replicas=-1: The new desired number of replicas. Required. --resource-version="": Precondition for resource version. Requires that the current resource version match this value in order to scale. --timeout=0: The length of time to wait before giving up on a scale operation, zero means don't wait. @@ -54,6 +56,7 @@ kubectl scale --replicas=3 job/cron ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -79,7 +82,14 @@ kubectl scale --replicas=3 job/cron ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_scale.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_set.md b/docs/user-guide/kubectl/kubectl_set.md new file mode 100644 index 0000000000..13176582fc --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_set.md @@ -0,0 +1,60 @@ +--- +--- + +## kubectl set + +Set specific features on objects + +### Synopsis + + +Configure application resources + +These commands help you make changes to existing application resources. + +``` +kubectl set SUBCOMMAND +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager +* [kubectl set image](kubectl_set_image.md) - Update image of a pod template + +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_set.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_set_image.md b/docs/user-guide/kubectl/kubectl_set_image.md new file mode 100644 index 0000000000..e8e7a0fdb0 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_set_image.md @@ -0,0 +1,94 @@ +--- +--- + +## kubectl set image + +Update image of a pod template + +### Synopsis + + +Update existing container image(s) of resources. + +Possible resources include (case insensitive): + pod (po), replicationcontroller (rc), deployment, daemonset (ds), job, replicaset (rs) + +``` +kubectl set image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 ... CONTAINER_NAME_N=CONTAINER_IMAGE_N +``` + +### Examples + +``` +# Set a deployment's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'. +kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1 + +# Update all deployments' and rc's nginx container's image to 'nginx:1.9.1' +kubectl set image deployments,rc nginx=nginx:1.9.1 --all + +# Update image of all containers of daemonset abc to 'nginx:1.9.1' +kubectl set image daemonset abc *=nginx:1.9.1 + +# Print result (in yaml format) of updating nginx container image from local file, without hitting the server +kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml +``` + +### Options + +``` + --all[=false]: select all resources in the namespace of the specified resource types + -f, --filename=[]: Filename, directory, or URL to a file identifying the resource to get from a server. + --local[=false]: If true, set image will NOT contact api-server but run locally. + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --record[=false]: Record current kubectl command in the resource annotation. + -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + -l, --selector="": Selector (label query) to filter on + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl set](kubectl_set.md) - Set specific features on objects + +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_set_image.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_stop.md b/docs/user-guide/kubectl/kubectl_stop.md index 3d05a93a55..f01281ca18 100644 --- a/docs/user-guide/kubectl/kubectl_stop.md +++ b/docs/user-guide/kubectl/kubectl_stop.md @@ -78,6 +78,14 @@ $ kubectl stop -f path/to/resources ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager ###### Auto generated by spf13/cobra on 24-Nov-2015 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_stop.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_taint.md b/docs/user-guide/kubectl/kubectl_taint.md new file mode 100644 index 0000000000..c54e805c7c --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_taint.md @@ -0,0 +1,91 @@ +--- +--- + +## kubectl taint + +Update the taints on one or more nodes + +### Synopsis + + +Update the taints on one or more nodes. + +A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect. +The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. +The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters. +The effect must be NoSchedule or PreferNoSchedule. +Currently taint can only apply to node. + +``` +kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N +``` + +### Examples + +``` +# Update node 'foo' with a taint with key 'dedicated' and value 'special-user' and effect 'NoSchedule'. +# If a taint with that key already exists, its value and effect are replaced as specified. +kubectl taint nodes foo dedicated=special-user:NoSchedule +# Remove from node 'foo' the taint with key 'dedicated' if one exists. +kubectl taint nodes foo dedicated- +``` + +### Options + +``` + --all[=false]: select all nodes in the cluster + --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] + --no-headers[=false]: When using the default output, don't print headers. + -o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/release-1.3/docs/user-guide/jsonpath.md]. + --output-version="": Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --overwrite[=false]: If true, allow taints to be overwritten, otherwise reject taint updates that overwrite existing taints. + --schema-cache-dir="~/.kube/schema": If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + -l, --selector="": Selector (label query) to filter on + -a, --show-all[=false]: When printing, show all resources (default hide terminated pods.) + --show-labels[=false]: When printing, show all labels as the last column (default hide labels column) + --sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. + --template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. + --validate[=true]: If true, use a schema to validate the input before sending it +``` + +### Options inherited from parent commands + +``` + --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. + --certificate-authority="": Path to a cert. file for the certificate authority. + --client-certificate="": Path to a client certificate file for TLS. + --client-key="": Path to a client key file for TLS. + --cluster="": The name of the kubeconfig cluster to use + --context="": The name of the kubeconfig context to use + --insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. + --kubeconfig="": Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at=:0: when logging hits line file:N, emit a stack trace + --log-dir="": If non-empty, write log files in this directory + --log-flush-frequency=5s: Maximum number of seconds between log flushes + --logtostderr[=true]: log to standard error instead of files + --match-server-version[=false]: Require server version to match client version + --namespace="": If present, the namespace scope for this CLI request. + --password="": Password for basic authentication to the API server. + -s, --server="": The address and port of the Kubernetes API server + --stderrthreshold=2: logs at or above this threshold go to stderr + --token="": Bearer token for authentication to the API server. + --user="": The name of the kubeconfig user to use + --username="": Username for basic authentication to the API server. + --v=0: log level for V logs + --vmodule=: comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager + +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_taint.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_uncordon.md b/docs/user-guide/kubectl/kubectl_uncordon.md index 5cff571c24..9c6bc9df6e 100644 --- a/docs/user-guide/kubectl/kubectl_uncordon.md +++ b/docs/user-guide/kubectl/kubectl_uncordon.md @@ -1,5 +1,6 @@ --- --- + ## kubectl uncordon Mark node as schedulable @@ -26,6 +27,7 @@ $ kubectl uncordon foo ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -51,7 +53,14 @@ $ kubectl uncordon foo ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_uncordon.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_version.md b/docs/user-guide/kubectl/kubectl_version.md index 4694973aab..1392de872a 100644 --- a/docs/user-guide/kubectl/kubectl_version.md +++ b/docs/user-guide/kubectl/kubectl_version.md @@ -24,6 +24,7 @@ kubectl version ``` --alsologtostderr[=false]: log to standard error as well as files + --as="": Username to impersonate for the operation. --certificate-authority="": Path to a cert. file for the certificate authority. --client-certificate="": Path to a client certificate file for TLS. --client-key="": Path to a client key file for TLS. @@ -49,6 +50,14 @@ kubectl version ### SEE ALSO -* [kubectl](/docs/user-guide/kubectl/kubectl/) - kubectl controls the Kubernetes cluster manager +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -###### Auto generated by spf13/cobra on 2-Mar-2016 +###### Auto generated by spf13/cobra on 12-Aug-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_version.md?pixel)]() + diff --git a/docs/user-guide/labels.md b/docs/user-guide/labels.md index 4ffc415f05..20d34d2626 100644 --- a/docs/user-guide/labels.md +++ b/docs/user-guide/labels.md @@ -1,4 +1,7 @@ --- +assignees: +- mikedanese + --- _Labels_ are key/value pairs that are attached to objects, such as pods. diff --git a/docs/user-guide/liveness/OWNERS b/docs/user-guide/liveness/OWNERS new file mode 100644 index 0000000000..9451be867c --- /dev/null +++ b/docs/user-guide/liveness/OWNERS @@ -0,0 +1,3 @@ +assignees: +- mikedanese + diff --git a/docs/user-guide/liveness/http-liveness-named-port.yaml b/docs/user-guide/liveness/http-liveness-named-port.yaml new file mode 100644 index 0000000000..80b17e06db --- /dev/null +++ b/docs/user-guide/liveness/http-liveness-named-port.yaml @@ -0,0 +1,25 @@ +apiVersion: v1 +kind: Pod +metadata: + labels: + test: liveness + name: liveness-http +spec: + containers: + - args: + - /server + image: gcr.io/google_containers/liveness + ports: + - name: liveness-port + containerPort: 8080 + hostPort: 8080 + livenessProbe: + httpGet: + path: /healthz + port: liveness-port + httpHeaders: + - name: X-Custom-Header + value: Awesome + initialDelaySeconds: 15 + timeoutSeconds: 1 + name: liveness diff --git a/docs/user-guide/liveness/index.md b/docs/user-guide/liveness/index.md index 4ef1641764..44272f28ae 100644 --- a/docs/user-guide/liveness/index.md +++ b/docs/user-guide/liveness/index.md @@ -1,4 +1,8 @@ --- +assignees: +- mikedanese +- thockin + --- This example shows two types of pod [health checks](/docs/user-guide/production-pods/#liveness-and-readiness-probes-aka-health-checks): HTTP checks and container execution checks. @@ -24,6 +28,13 @@ The [http-liveness.yaml](/docs/user-guide/liveness/http-liveness.yaml) demonstra The Kubelet sends an HTTP request to the specified path and port to perform the health check. If you take a look at image/server.go, you will see the server starts to respond with an error code 500 after 10 seconds, so the check fails. The Kubelet sends probes to the container's IP address, unless overridden by the optional `host` field in httpGet. If the container listens on `127.0.0.1` and `hostNetwork` is `true` (i.e., it does not use the pod-specific network), then `host` should be specified as `127.0.0.1`. Be warned that, outside of less common cases like that, `host` does probably not result in what you would expect. If you set it to a non-existing hostname (or your competitor's!), probes will never reach the pod, defeating the whole point of health checks. If your pod relies on e.g. virtual hosts, which is probably the more common case, you should not use `host`, but rather set the `Host` header in `httpHeaders`. +### Using a named port for liveness probes + +You can also use a named `ContainerPort` for HTTP liveness checks. + +The [http-liveness-named-port.yaml](/docs/user-guide/liveness/http-liveness-named-port.yaml) demonstrates the named-port HTTP check. +{% include code.html language="yaml" file="http-liveness-named-port.yaml" ghlink="/docs/user-guide/liveness/http-liveness-named-port.yaml" %} + This [guide](/docs/user-guide/walkthrough/k8s201/#health-checking) has more information on health checks. ## Get your hands dirty diff --git a/docs/user-guide/load-balancer.md b/docs/user-guide/load-balancer.md index 82219101f6..c129190248 100644 --- a/docs/user-guide/load-balancer.md +++ b/docs/user-guide/load-balancer.md @@ -1,4 +1,5 @@ --- + --- * TOC @@ -7,19 +8,28 @@ ## Overview When creating a service, you have the option of automatically creating a -network load balancer. This provides an +cloud network load balancer. This provides an externally-accessible IP address that sends traffic to the correct port on your -cluster nodes. +cluster nodes _provided your cluster runs in a supported environment and is configured with the correct cloud load balancer provider package_. + +## External Load Balancer Providers + +It is important to note that the datapath for this functionality is provided by a load balancer external to the Kubernetes cluster. + +When the service type is set to `LoadBalancer`, Kubernetes provides functionality equivalent to type=`ClusterIP` to pods within the cluster and extends it by programming the (external to Kubernetes) load balancer with entries for the Kubernetes VMs. The Kubernetes service controller automates the creation of the external load balancer, health checks (if needed), firewall rules (if needed) and retrieves the external IP allocated by the cloud provider and populates it in the service object. ## Configuration file To create an external load balancer, add the following line to your [service configuration file](/docs/user-guide/services/operations/#service-configuration-file): +```json "type": "LoadBalancer" +``` Your configuration file might look like: +```json { "kind": "Service", "apiVersion": "v1", @@ -37,14 +47,17 @@ Your configuration file might look like: "type": "LoadBalancer" } } +``` ## Using kubectl You can alternatively create the service with the `kubectl expose` command and its `--type=LoadBalancer` flag: +```bash $ kubectl expose rc example --port=8765 --target-port=9376 \ --name=example-service --type=LoadBalancer +``` This command creates a new service using the same selectors as the referenced resource (in the case of the example above, a replication controller named @@ -58,6 +71,7 @@ For more information, including optional flags, refer to the You can find the IP address created for your service by getting the service information through `kubectl`: +```bash $ kubectl describe services example-service Name: example-service Selector: app=example @@ -69,5 +83,70 @@ information through `kubectl`: Endpoints: 10.64.0.4:80,10.64.1.5:80,10.64.2.4:80 Session Affinity: None No events. +``` The IP address is listed next to `LoadBalancer Ingress`. + +## Loss of client source IP for external traffic + +Due to the implementation of this feature, the source IP for sessions as seen in the target container will *not be the original source IP* of the client. This is the default behavior as of Kubernetes v1.4. However, starting in v1.4, an optional alpha feature has been added +that will preserve the client Source IP for GCE/GKE environments. This feature will be phased in for other cloud providers in subsequent releases. + +## Annotation to modify the LoadBalancer behavior for preservation of Source IP +In 1.4, an Alpha feature has been added that changes the behavior of the external LoadBalancer feature. + +This feature can be activated by adding the alpha annotation below to the metadata section of the Service Configuration file. + +```json + { + "kind": "Service", + "apiVersion": "v1", + "metadata": { + "name": "example-service", + "annotations": { + "service.alpha.kubernetes.io/external-traffic": "OnlyLocal" + } + }, + "spec": { + "ports": [{ + "port": 8765, + "targetPort": 9376 + }], + "selector": { + "app": "example" + }, + "type": "LoadBalancer" + } + } +``` + +### Alpha Feature Gate for the 'service.alpha.kubernetes.io/external-traffic' annotation + +Alpha features are not enabled by default, they must be enabled using the release gate command line flags +for kube-controller-manager and kube-proxy. +See [https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/runtimeconfig.md](Runtime feature flags proposal) for more details on feature gate flags. + +If this feature is not enabled in your cluster, this annotation in your service configuration will be rejected. + +### Implementation across different cloudproviders/environments + +Note that this feature is not currently implemented for all cloudproviders/environments. +This feature does not work for nodePorts yet, so environments/cloud providers with proxy-style load-balancers cannot use it yet. + +### Caveats and Limitations when preserving source IPs + +GCE/AWS load balancers do not provide weights for their target pools. This was not an issue with the old LB +kube-proxy rules which would correctly balance across all endpoints. + +With the new functionality, the external traffic will not be equally load balanced across pods, but rather +equally balanced at the node level (because GCE/AWS and other external LB implementations do not have the ability +for specifying the weight per node, they balance equally across all target nodes, disregarding the number of +pods on each node). + +We can, however, state that for NumServicePods << NumNodes or NumServicePods >> NumNodes, a fairly close-to-equal +distribution will be seen, even without weights. + +Once the external load balancers provide weights, this functionality can be added to the LB programming path. +*Future Work: No support for weights is provided for the 1.4 release, but may be added at a future date* + +Internal pod to pod traffic should behave similar to ClusterIP services, with equal probability across all pods. diff --git a/docs/user-guide/logging-demo/OWNERS b/docs/user-guide/logging-demo/OWNERS new file mode 100644 index 0000000000..9451be867c --- /dev/null +++ b/docs/user-guide/logging-demo/OWNERS @@ -0,0 +1,3 @@ +assignees: +- mikedanese + diff --git a/docs/user-guide/logging.md b/docs/user-guide/logging.md index cea9798e4a..54f9e77e61 100644 --- a/docs/user-guide/logging.md +++ b/docs/user-guide/logging.md @@ -1,5 +1,8 @@ ---- ---- +--- +assignees: +- mikedanese + +--- This page is designed to help you use logs to troubleshoot issues with your Kubernetes solution. @@ -11,20 +14,20 @@ Kubernetes components, such as kubelet and apiserver, use the [glog](https://god The logs of a running container may be fetched using the command `kubectl logs`. For example, given this pod specification [counter-pod.yaml](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/blog-logging/counter-pod.yaml), which has a container which writes out some text to standard -output every second. (You can find different pod specifications [here](https://github.com/kubernetes/kubernetes.github.io/tree/{{page.docsbranch}}/docs/user-guide/logging-demo/).) - +output every second. (You can find different pod specifications [here](https://github.com/kubernetes/kubernetes.github.io/tree/{{page.docsbranch}}/docs/user-guide/logging-demo/).) + {% include code.html language="yaml" file="counter-pod.yaml" k8slink="/examples/blog-logging/counter-pod.yaml" %} we can run the pod: -```shell +```shell $ kubectl create -f ./counter-pod.yaml pods/counter -``` - +``` + and then fetch the logs: -```shell +```shell $ kubectl logs counter 0: Tue Jun 2 21:37:31 UTC 2015 1: Tue Jun 2 21:37:32 UTC 2015 @@ -33,12 +36,12 @@ $ kubectl logs counter 4: Tue Jun 2 21:37:35 UTC 2015 5: Tue Jun 2 21:37:36 UTC 2015 ... -``` - +``` + If a pod has more than one container then you need to specify which container's log files should be fetched e.g. -```shell +```shell $ kubectl logs kube-dns-v3-7r1l9 etcd 2015/06/23 00:43:10 etcdserver: start to snapshot (applied: 30003, lastsnap: 20002) 2015/06/23 00:43:10 etcdserver: compacted log at index 30003 @@ -54,8 +57,8 @@ $ kubectl logs kube-dns-v3-7r1l9 etcd 2015/06/23 04:51:03 etcdserver: compacted log at index 60006 2015/06/23 04:51:03 etcdserver: saved snapshot at index 60006 ... -``` - +``` + ## Cluster level logging to Google Cloud Logging The getting started guide [Cluster Level Logging to Google Cloud Logging](/docs/getting-started-guides/logging) diff --git a/docs/user-guide/managing-deployments.md b/docs/user-guide/managing-deployments.md index 611d56ed86..a2e32c4b6c 100644 --- a/docs/user-guide/managing-deployments.md +++ b/docs/user-guide/managing-deployments.md @@ -1,4 +1,9 @@ --- +assignees: +- bgrant0607 +- janetkuo +- mikedanese + --- You've deployed your application and exposed it via a service. Now what? Kubernetes provides a number of tools to help you manage your application deployment, including scaling and updating. Among the features we'll discuss in more depth are [configuration files](/docs/user-guide/configuring-containers/#configuration-in-kubernetes) and [labels](/docs/user-guide/deploying-applications/#labels). @@ -82,6 +87,49 @@ my-nginx-svc 10.0.0.208 80/TCP 0s With the above commands, we first create resources under docs/user-guide/nginx/ and print the resources created with `-o name` output format (print each resource as resource/name). Then we `grep` only the "service", and then print it with `kubectl get`. +If you happen to organize your resources across several subdirectories within a particular directory, you can recursively perform the operations on the subdirectories also, by specifying `--recursive` or `-R` alongside the `--filename,-f` flag. + +For instance, assume there is a directory `project/k8s/development` that holds all of the manifests needed for the development environment, organized by resource type: + +``` +project/k8s/development +├── configmap +│   └── my-configmap.yaml +├── deployment +│   └── my-deployment.yaml +└── pvc + └── my-pvc.yaml +``` + +By default, performing a bulk operation on `project/k8s/development` will stop at the first level of the directory, not processing any subdirectories. If we tried to create the resources in this directory using the following command, we'd encounter an error: + +```shell +$ kubectl create -f project/k8s/development +error: you must provide one or more resources by argument or filename (.json|.yaml|.yml|stdin) +``` + +Instead, specify the `--recursive` or `-R` flag with the `--filename,-f` flag as such: + +```shell +$ kubectl create -f project/k8s/development --recursive +configmap "my-config" created +deployment "my-deployment" created +persistentvolumeclaim "my-pvc" created +``` + +The `--recursive` flag works with any operation that accepts the `--filename,-f` flag such as: `kubectl {create,get,delete,describe,rollout} etc.` + +The `--recursive` flag also works when multiple `-f` arguments are provided: + +```shell +$ kubectl create -f project/k8s/namespaces -f project/k8s/development --recursive +namespace "development" created +namespace "staging" created +configmap "my-config" created +deployment "my-deployment" created +persistentvolumeclaim "my-pvc" created +``` + If you're interested in learning more about `kubectl`, go ahead and read [kubectl Overview](/docs/user-guide/kubectl-overview). ## Using labels effectively diff --git a/docs/user-guide/monitoring.md b/docs/user-guide/monitoring.md index 92a2f50159..6125291421 100644 --- a/docs/user-guide/monitoring.md +++ b/docs/user-guide/monitoring.md @@ -1,4 +1,7 @@ --- +assignees: +- mikedanese + --- Understanding how an application behaves when deployed is crucial to scaling the application and providing a reliable service. In a Kubernetes cluster, application performance can be examined at many different levels: containers, [pods](/docs/user-guide/pods), [services](/docs/user-guide/services), and whole clusters. As part of Kubernetes we want to provide users with detailed resource usage information about their running applications at all these levels. This will give users deep insights into how their applications are performing and where possible application bottlenecks may be found. In comes [Heapster](https://github.com/kubernetes/heapster), a project meant to provide a base monitoring platform on Kubernetes. diff --git a/docs/user-guide/namespaces.md b/docs/user-guide/namespaces.md index f49748816d..0c4b86840d 100644 --- a/docs/user-guide/namespaces.md +++ b/docs/user-guide/namespaces.md @@ -1,4 +1,9 @@ --- +assignees: +- derekwaynecarr +- mikedanese +- thockin + --- Kubernetes supports multiple virtual clusters backed by the same physical cluster. @@ -62,7 +67,7 @@ context. First get your current context: ```shell -$ export CONTEXT=$(kubectl config view | grep current-context | awk '{print $2}') +$ export CONTEXT=$(kubectl config view | awk '/current-context/ {print $2}') ``` Then update the default namespace: diff --git a/docs/user-guide/networkpolicies.md b/docs/user-guide/networkpolicies.md new file mode 100644 index 0000000000..eb4bbe1b74 --- /dev/null +++ b/docs/user-guide/networkpolicies.md @@ -0,0 +1,83 @@ +--- +assignees: +- thockin + +--- + +* TOC +{:toc} + +A network policy is a specification of how selections of pods are allowed to communicate with each other and other network endpoints. + +`NetworkPolicy` resources use labels to select pods and define whitelist rules which allow traffic to the selected pods in addition to what is allowed by the isolation policy for a given namespace. + +## Prerequisites + +You must enable the `extensions/v1beta1/networkpolicies` runtime config in your apiserver to enable this resource. + +You must also be using a networking solution which supports `NetworkPolicy` - simply creating the +resource without a controller to implement it will have no effect. + +## Configuring Namespace Isolation Policy + +Isolation can be configured on a per-namespace basis. Once isolation is configured on a namespace it will be applied to all pods in that namespace. Currently, only isolation policy on inbound traffic (ingress) can be defined. + +The following ingress isolation types being supported: + +- `DefaultDeny`: Pods in the namespace will be inaccessible from any source except the pod's local node. + +Ingress isolation can be enabled using an annotation on the Namespace. + +```yaml +kind: Namespace +apiVersion: v1 +metadata: + annotations: + net.beta.kubernetes.io/network-policy: | + { + "ingress": { + "isolation": "DefaultDeny" + } + } +``` + +To configure the annotation via `kubectl`: + +```shell{% raw %} +kubectl annotate ns "net.beta.kubernetes.io/network-policy={\"ingress\": {\"isolation\": \"DefaultDeny\"}}" +{% endraw %}``` + +## The `NetworkPolicy` Resource + +See the [api-reference](/docs/api-reference/extensions/v1beta1/definitions/#_v1beta1_networkpolicy) for a full definition of the resource. + +A minimal `NetworkPolicy` might look like this: + +```yaml +apiVersion: extensions/v1beta1 +kind: NetworkPolicy +metadata: + name: test-network-policy +spec: + podSelector: + matchLabels: + role: db + ingress: + - from: + - podSelector: + matchLabels: + role: frontend + ports: + - protocol: tcp + port: 6379 +``` + +*POSTing this to the API server will have no effect unless your chosen networking solution supports network policy.* + +__Mandatory Fields__: As with all other Kubernetes config, a `NetworkPolicy` needs `apiVersion`, `kind`, and `metadata` fields. For general information about working with config files, see [here](/docs/user-guide/simple-yaml), [here](/docs/user-guide/configuring-containers), and [here](/docs/user-guide/working-with-resources). + +__spec__: `NetworkPolicy` [spec](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#spec-and-status) has all the information needed to define a network isolation policy in the deployed controller. + +__podSelector__: Each `NetworkPolicy` includes a `podSelector` which selects the grouping of pods to which the `ingress` rules in the policy apply. + +__ingress__: Each `NetworkPolicy` includes a list of whitelist `ingress` rules. Each rule allows traffic which matches both the `from` and `ports` sections. diff --git a/docs/user-guide/nginx-init-containers.yaml b/docs/user-guide/nginx-init-containers.yaml new file mode 100644 index 0000000000..34c20fa66a --- /dev/null +++ b/docs/user-guide/nginx-init-containers.yaml @@ -0,0 +1,31 @@ +apiVersion: v1 +kind: Pod +metadata: + name: nginx + annotations: + pod.alpha.kubernetes.io/init-containers: '[ + { + "name": "install", + "image": "busybox", + "command": ["wget", "-O", "/work-dir/index.html", "http://kubernetes.io/index.html"], + "volumeMounts": [ + { + "name": "workdir", + "mountPath": "/work-dir" + } + ] + } + ]' +spec: + containers: + - name: nginx + image: nginx + ports: + - containerPort: 80 + volumeMounts: + - name: workdir + mountPath: /usr/share/nginx/html + dnsPolicy: Default + volumes: + - name: workdir + emptyDir: {} diff --git a/docs/user-guide/nginx/OWNERS b/docs/user-guide/nginx/OWNERS new file mode 100644 index 0000000000..406cea7c20 --- /dev/null +++ b/docs/user-guide/nginx/OWNERS @@ -0,0 +1,3 @@ +assignees: +- janetkuo + diff --git a/docs/user-guide/node-selection/OWNERS b/docs/user-guide/node-selection/OWNERS new file mode 100644 index 0000000000..c0d1cb0d8c --- /dev/null +++ b/docs/user-guide/node-selection/OWNERS @@ -0,0 +1,4 @@ +assignees: +- dchen1107 +- mikedanese + diff --git a/docs/user-guide/node-selection/index.md b/docs/user-guide/node-selection/index.md index e4f707dbac..1ae9d9fdef 100644 --- a/docs/user-guide/node-selection/index.md +++ b/docs/user-guide/node-selection/index.md @@ -1,4 +1,9 @@ --- +assignees: +- dchen1107 +- eparis +- mikedanese + --- This example shows how to assign a [pod](/docs/user-guide/pods/) to a specific [node](/docs/admin/node/) or to one of a set of nodes using node labels and the nodeSelector field in a pod specification. Generally this is unnecessary, as the scheduler will take care of things for you, but you may want to do so in certain circumstances like to ensure that your pod ends up on a machine with an SSD attached to it. @@ -53,7 +58,7 @@ Like `nodeSelector`, affinity is based on labels. But it allows you to write muc Kubernetes v1.2 offers an alpha version of the first piece of the affinity mechanism, called [node affinity](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/nodeaffinity.md). There are currently two types of node affinity, called `requiredDuringSchedulingIgnoredDuringExecution` and -`preferresDuringSchedulingIgnoredDuringExecution`. You can think of them as "hard" and "soft" respectively, +`preferredDuringSchedulingIgnoredDuringExecution`. You can think of them as "hard" and "soft" respectively, in the sense that the former specifies rules that *must* be met for a pod to schedule onto a node (just like `nodeSelector` but using a more expressive syntax), while the latter specifies *preferences* that the scheduler will try to enforce but will not guarantee. The "IgnoredDuringExecution" part of the names means that, similar diff --git a/docs/user-guide/persistent-volumes/OWNERS b/docs/user-guide/persistent-volumes/OWNERS new file mode 100644 index 0000000000..e9307079ae --- /dev/null +++ b/docs/user-guide/persistent-volumes/OWNERS @@ -0,0 +1,6 @@ +assignees: +- jsafrane +- mikedanese +- saad-ali +- thockin + diff --git a/docs/user-guide/persistent-volumes/index.md b/docs/user-guide/persistent-volumes/index.md index ae465eea00..32ac8fbd00 100644 --- a/docs/user-guide/persistent-volumes/index.md +++ b/docs/user-guide/persistent-volumes/index.md @@ -1,4 +1,10 @@ --- +assignees: +- jsafrane +- mikedanese +- saad-ali +- thockin + --- This document describes the current state of `PersistentVolumes` in Kubernetes. Familiarity with [volumes](/docs/user-guide/volumes/) is suggested. @@ -14,7 +20,22 @@ A `PersistentVolume` (PV) is a piece of networked storage in the cluster that ha A `PersistentVolumeClaim` (PVC) is a request for storage by a user. It is similar to a pod. Pods consume node resources and PVCs consume PV resources. Pods can request specific levels of resources (CPU and Memory). Claims can request specific size and access modes (e.g, can be mounted once read/write or many times read-only). -Please see the [detailed walkthrough with working examples](/docs/user-guide/persistent-volumes/). +While `PersistentVolumeClaims` allow a user to consume abstract storage +resources, it is common that users need `PersistentVolumes` with varying +properties, such as performance, for different problems. Cluster administrators +need to be able to offer a variety of `PersistentVolumes` that differ in more +ways than just size and access modes, without exposing users to the details of +how those volumes are implemented. For these needs there is the `StorageClass` +resource. + +A `StorageClass` provides a way for administrators to describe the "classes" of +storage they offer. Different classes might map to quality-of-service levels, +or to backup policies, or to arbitrary policies determined by the cluster +administrators. Kubernetes itself is unopinionated about what classes +represent. This concept is sometimes called "profiles" in other storage +systems. + +Please see the [detailed walkthrough with working examples](/docs/user-guide/persistent-volumes/walkthrough/). ## Lifecycle of a volume and claim @@ -23,11 +44,17 @@ PVs are resources in the cluster. PVCs are requests for those resources and als ### Provisioning -A cluster administrator will create a number of PVs. They carry the details of the real storage which is available for use by cluster users. They exist in the Kubernetes API and are available for consumption. +There are two ways PVs may be provisioned: statically or dynamically. + +#### Static +A cluster administrator creates a number of PVs. They carry the details of the real storage which is available for use by cluster users. They exist in the Kubernetes API and are available for consumption. + +#### Dynamic +When none of the static PVs the administrator created matches a user's `PersistentVolumeClaim`, the cluster may try to dynamically provision a volume specially for the PVC. This provisioning is based on `StorageClasses`: the PVC must request a class and the administrator must have created and configured that class in order for dynamic provisioning to occur. Claims that request the class `""` effectively disable dynamic provisioning for themselves. ### Binding -A user creates a `PersistentVolumeClaim` with a specific amount of storage requested and with certain access modes. A control loop in the master watches for new PVCs, finds a matching PV (if possible), and binds them together. The user will always get at least what they asked for, but the volume may be in excess of what was requested. +A user creates, or has already created in the case of dynamic provisioning, a `PersistentVolumeClaim` with a specific amount of storage requested and with certain access modes. A control loop in the master watches for new PVCs, finds a matching PV (if possible), and binds them together. If a PV was dynamically provisioned for a new PVC, the loop will always bind that PV to the PVC. Otherwise, the user will always get at least what they asked for, but the volume may be in excess of what was requested. Once bound, `PersistentVolumeClaim` binds are exclusive, regardless of the mode used to bind them. Claims will remain unbound indefinitely if a matching volume does not exist. Claims will be bound as matching volumes become available. For example, a cluster provisioned with many 50Gi PVs would not match a PVC requesting 100Gi. The PVC can be bound when a 100Gi PV is added to the cluster. @@ -43,7 +70,7 @@ When a user is done with their volume, they can delete the PVC objects from the ### Reclaiming -The reclaim policy for a `PersistentVolume` tells the cluster what to do with the volume after it has been released of its claim. Currently, volumes can either be Retained, Recycled or Deleted. Retention allows for manual reclamation of the resource. For those volume plugins that support it, deletion removes both the `PersistentVolume` object from Kubernetes as well as deletes associated storage asset in external infrastructure such as AWS EBS, GCE PD or Cinder volume. If supported by appropriate volume plugin, recycling performs a basic scrub (`rm -rf /thevolume/*`) on the volume and makes it available again for a new claim. +The reclaim policy for a `PersistentVolume` tells the cluster what to do with the volume after it has been released of its claim. Currently, volumes can either be Retained, Recycled or Deleted. Retention allows for manual reclamation of the resource. For those volume plugins that support it, deletion removes both the `PersistentVolume` object from Kubernetes as well as deletes associated storage asset in external infrastructure such as AWS EBS, GCE PD or Cinder volume. Volumes that were dynamically provisioned are always deleted. If supported by appropriate volume plugin, recycling performs a basic scrub (`rm -rf /thevolume/*`) on the volume and makes it available again for a new claim. ## Types of Persistent Volumes @@ -51,10 +78,15 @@ The reclaim policy for a `PersistentVolume` tells the cluster what to do with th * GCEPersistentDisk * AWSElasticBlockStore +* AzureFile +* FC (Fibre Channel) * NFS * iSCSI * RBD (Ceph Block Device) +* CephFS +* Cinder (OpenStack block storage) * Glusterfs +* VsphereVolume * HostPath (single node testing only -- local storage is not supported in any way and WILL NOT WORK in a multi-node cluster) @@ -67,6 +99,8 @@ Each PV contains a spec and status, which is the specification and status of the kind: PersistentVolume metadata: name: pv0003 + annotations: + volume.beta.kubernetes.io/storage-class: "slow" spec: capacity: storage: 5Gi @@ -86,7 +120,7 @@ Currently, storage size is the only resource that can be set or requested. Futu ### Access Modes -A `PersistentVolume` can be mounted on a host in any way supported by the resource provider. Providers will have different capabilities and each PV's access modes are set to the specific modes supported by that particular volume. For example, NFS can support multiple read/write clients, but a specific NFS PV might be exported on the server as read-only. Each PV gets its own set of access modes describing that specific PV's capabilities. +A `PersistentVolume` can be mounted on a host in any way supported by the resource provider. As shown in the table below, providers will have different capabilities and each PV's access modes are set to the specific modes supported by that particular volume. For example, NFS can support multiple read/write clients, but a specific NFS PV might be exported on the server as read-only. Each PV gets its own set of access modes describing that specific PV's capabilities. The access modes are: @@ -103,6 +137,33 @@ In the CLI, the access modes are abbreviated to: > __Important!__ A volume can only be mounted using one access mode at a time, even if it supports many. For example, a GCEPersistentDisk can be mounted as ReadWriteOnce by a single node or ReadOnlyMany by many nodes, but not at the same time. +| Volume Plugin | ReadWriteOnce| ReadOnlyMany| ReadWriteMany| +| :--- | :---: | :---: | :---: | +| AWSElasticBlockStore | x | - | - | +| AzureFile | x | x | x | +| CephFS | x | x | x | +| Cinder | x | - | - | +| FC | x | x | - | +| FlexVolume | x | x | - | +| GCEPersistentDisk | x | x | - | +| Glusterfs | x | x | x | +| HostPath | x | - | - | +| iSCSI | x | x | - | +| NFS | x | x | x | +| RDB | x | x | - | +| VsphereVolume | x | - | - | + +### Class + +A PV can have a class, which is specified by setting the +`volume.beta.kubernetes.io/storage-class` annotation to the name of a +`StorageClass`. A PV of a particular class can only be bound to PVCs requesting +that class. A PV with no annotation or its class annotation set to `""` has no +class and can only be bound to PVCs that request no particular class. + +In the future after beta, the `volume.beta.kubernetes.io/storage-class` +annotation will become an attribute. + ### Recycling Policy Current recycling policies are: @@ -133,12 +194,19 @@ kind: PersistentVolumeClaim apiVersion: v1 metadata: name: myclaim + annotations: + volume.beta.kubernetes.io/storage-class: "slow" spec: accessModes: - ReadWriteOnce resources: requests: storage: 8Gi + selector: + matchLabels: + release: "stable" + matchExpressions: + - {key: environment, operator: In, values: [dev]} ``` ### Access Modes @@ -149,6 +217,50 @@ Claims use the same conventions as volumes when requesting storage with specific Claims, like pods, can request specific quantities of a resource. In this case, the request is for storage. The same [resource model](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/resources.md) applies to both volumes and claims. +### Selector + +Claims can specify a [label selector](/docs/user-guide/labels/#label-selectors) to further filter the set of volumes. Only the volumes whose labels match the selector can be bound to the claim. The selector can consist of two fields: + +* matchLabels - the volume must have a label with this value +* matchExpressions - a list of requirements made by specifying key, list of values, and operator that relates the key and values. Valid operators include In, NotIn, Exists, and DoesNotExist. + +All of the requirements, from both `matchLabels` and `matchExpressions` are ANDed together – they must all be satisfied in order to match. + +### Class + +A claim can request a particular class by specifying the name of a +`StorageClass`using the annotation `volume.beta.kubernetes.io/storage-class`. +Only PVs of the requested class, ones with the same annotation as the PVC, can +be bound to the PVC. + +PVCs don't necessarily have to request a class. A PVC with its annotation set +equal to `""` is always interpreted to be requesting a PV with no class, so it +can only be bound to PVs with no class (no annotation or one set equal to +`""`). A PVC with no annotation is not quite the same and is treated differently +by the cluster depending on whether the +[`DefaultStorageClass` admission plugin](docs/admin/admission-controllers/#defaultstorageclass) +is turned on. + +* If the admission plugin is turned on, the administrator may specify a +default `StorageClass`. All PVCs that have no annotation can be bound only to +PVs of that default. Specifying a default `StorageClass` is done by setting the +annotation `storageclass.beta.kubernetes.io/is-default-class` equal to "true" in +a `StorageClass` object. If the administrator does not specify a default, the +cluster responds to PVC creation as if the admission plugin were turned off. If +more than one default is specified, the admission plugin forbids the creation of +all PVCs. +* If the admission plugin is turned off, there is no notion of a default +`StorageClass`. All PVCs that have no annotation can be bound only to PVs that +have no class. In this case the PVCs that have no annotation are treated the +same way as PVCs that have their annotation set to `""`. + +When a PVC specifies a `selector` in addition to requesting a `StorageClass`, +the requirements are ANDed together: only a PV of the requested class and with +the requested labels may be bound to the PVC. + +In the future after beta, the `volume.beta.kubernetes.io/storage-class` +annotation will become an attribute. + ## Claims As Volumes Pods access storage by using the claim as a volume. Claims must exist in the same namespace as the pod using the claim. The cluster finds the claim in the pod's namespace and uses it to get the `PersistentVolume` backing the claim. The volume is then mounted to the host and into the pod. @@ -169,4 +281,121 @@ spec: - name: mypd persistentVolumeClaim: claimName: myclaim -``` \ No newline at end of file +``` + +### A Note on Namespaces + +`PersistentVolumes` binds are exclusive, and since `PersistentVolumeClaims` are namespaced objects, mounting claims with "Many" modes (`ROX`, `RWX`) is only possible within one namespace. + +## StorageClasses + +Each `StorageClass` contains the fields `provisioner` and `parameters`, which +are used when a `PersistentVolume` belonging to the class needs to be +dynamically provisioned. + +The name of a `StorageClass` object is significant, and is how users can +request a particular class. Administrators set the name and other parameters +of a class, all of which are opaque to users, when first creating +`StorageClass` objects, and the objects cannot be updated once they are +created. + +Administrators can specify a default `StorageClass` just for PVCs that don't +request any particular class to bind to: see the +[`PersistentVolumeClaim` section](docs/user-guide/persistent-volumes/#class-1) +for details. + +```yaml +kind: StorageClass +apiVersion: extensions/v1beta1 +metadata: + name: standard +provisioner: kubernetes.io/aws-ebs +parameters: + type: gp2 +``` + +### Provisioner +Storage classes have a provisioner that determines what volume plugin is used +for provisioning PVs. This field must be specified. During beta, the available +provisioner types are `kubernetes.io/aws-ebs` and `kubernetes.io/gce-pd`. + +### Parameters +Storage classes have parameters that describe volumes belonging to the storage +class. Different parameters may be accepted depending on the `provisioner`. For + example, the value `io1`, for the parameter `type`, and the parameter +`iopsPerGB` are specific to EBS. When a parameter is omitted, some default is +used. + +#### AWS + +```yaml +kind: StorageClass +apiVersion: extensions/v1beta1 +metadata: + name: slow +provisioner: kubernetes.io/aws-ebs +parameters: + type: io1 + zone: us-east-1d + iopsPerGB: "10" +``` + +* `type`: `io1`, `gp2`, `sc1`, `st1`. See [AWS docs](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) for details. Default: `gp2`. +* `zone`: AWS zone. If not specified, a random zone from those where Kubernetes cluster has a node is chosen. +* `iopsPerGB`: only for `io1` volumes. I/O operations per second per GiB. AWS volume plugin multiplies this with size of requested volume to compute IOPS of the volume and caps it at 20 000 IOPS (maximum supported by AWS, see [AWS docs](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html). A string is expected here, i.e. `"10"`, not `10`. +* `encrypted`: denotes whether the EBS volume should be encrypted or not. Valid values are `"true"` or `"false"`. A string is expected here, i.e. `"true"`, not `true`. +* `kmsKeyId`: optional. The full Amazon Resource Name of the key to use when encrypting the volume. If none is supplied but `encrypted` is true, a key is generated by AWS. See AWS docs for valid ARN value. + +#### GCE + +```yaml +kind: StorageClass +apiVersion: extensions/v1beta1 +metadata: + name: slow +provisioner: kubernetes.io/gce-pd +parameters: + type: pd-standard + zone: us-central1-a +``` + +* `type`: `pd-standard` or `pd-ssd`. Default: `pd-ssd` +* `zone`: GCE zone. If not specified, a random zone in the same region as controller-manager will be chosen. + +#### GLUSTERFS + +```yaml +apiVersion: extensions/v1beta1 +kind: StorageClass +metadata: + name: slow +provisioner: kubernetes.io/glusterfs +parameters: + endpoint: "glusterfs-cluster" + resturl: "http://127.0.0.1:8081" + restauthenabled: "true" + restuser: "admin" + restuserkey: "password" +``` + +* `endpoint`: `glusterfs-cluster` is the endpoint/service name which includes GlusterFS trusted pool IP addresses and this parameter is mandatory. +* `resturl` : Gluster REST service url which provision gluster volumes on demand. The format should be `IPaddress:Port` and this is a mandatory parameter for GlusterFS dynamic provisioner. +* `restauthenabled` : Gluster REST service authentication boolean is required if the authentication is enabled on the REST server. If this value is 'true', 'restuser' and 'restuserkey' have to be filled. +* `restuser` : Gluster REST service user who has access to create volumes in the Gluster Trusted Pool. +* `restuserkey` : Gluster REST service user's password which will be used for authentication to the REST server. + +#### OpenStack Cinder + +```yaml +kind: StorageClass +apiVersion: extensions/v1beta1 +metadata: + name: gold +provisioner: kubernetes.io/cinder +parameters: + type: fast + availability: nova +``` + +* `type`: [VolumeType](http://docs.openstack.org/admin-guide/dashboard-manage-volumes.html) created in Cinder. Default is empty. +* `availability`: Availability Zone. Default is empty. diff --git a/docs/user-guide/persistent-volumes/walkthrough.md b/docs/user-guide/persistent-volumes/walkthrough.md index 385cc15c52..30b24feac2 100644 --- a/docs/user-guide/persistent-volumes/walkthrough.md +++ b/docs/user-guide/persistent-volumes/walkthrough.md @@ -1,4 +1,8 @@ --- +assignees: +- jsafrane +- saad-ali + --- The purpose of this guide is to help you become familiar with [Kubernetes Persistent Volumes](/docs/user-guide/persistent-volumes/). By the end of the guide, we'll have @@ -36,6 +40,34 @@ NAME LABELS CAPACITY ACCESSMODES STATUS CLAIM REASON pv0001 type=local 10737418240 RWO Available ``` +### Access Control +Storage configured with GID will only allow writing by pods using the same GID. +Mismatched or missing GIDs will cause `permission denied` errors. Annotating a +`PersistentVolume` with a GID allows `Kubelet` to automatically add the GID to +the pod that requires it. No coordination between an admin and end user is +required. + +To annotate the volume's with a GID you use the `pv.beta.kubernetes.io/gid` +annotation as follows: + +```yaml +kind: PersistentVolume +apiVersion: v1 +metadata: + name: pv1 + annotations: + pv.beta.kubernetes.io/gid: "1234" +#... +``` + +When a pod consumes a PV with a GID annotation, the annotated GID is applied to +all containers in the pod in the same way GIDs specified in the pod's +[security context](/docs/user-guide/security-context/) are. Every GID, whether +it originates from a PV annotation or the pod's specification, is applied to +the first process run in each container, in addition to the container's primary +GID. Currently, the GIDs associated with PVs a pod consumes will not be present +on the pod resource itself, unlike GIDs specified in a pod's security context. + ## Requesting storage Users of Kubernetes request persistent storage for their pods. They don't know how the underlying cluster is provisioned. diff --git a/docs/user-guide/petset.md b/docs/user-guide/petset.md new file mode 100644 index 0000000000..47213c188d --- /dev/null +++ b/docs/user-guide/petset.md @@ -0,0 +1,342 @@ +--- +assignees: +- bprashanth +- foxish + +--- + +* TOC +{:toc} + +__Terminology__ + +Throughout this doc you will see a few terms that are sometimes used interchangeably elsewhere, that might cause confusion. This section attempts to clarify them. + +* Node: A single virtual or physical machine in a Kubernetes cluster. +* Cluster: A group of nodes in a single failure domain, unless mentioned otherwise. +* Persistent Volume Claim (PVC): A request for storage, typically a [persistent volume](/docs/user-guide/persistent-volumes/walkthrough/). +* Host name: The hostname attached to the UTS namespace of the pod, i.e the output of `hostname` in the pod. +* DNS/Domain name: A *cluster local* domain name resolvable using standard methods (eg: [gethostbyname](http://linux.die.net/man/3/gethostbyname)). +* Ordinality: the proprety of being "ordinal", or occupying a position in a sequence. +* Pet: a single member of a Pet Set; more generally, a stateful application. +* Peer: a process running a server, capable of communicating with other such processes. + +__Prerequisites__ + +This doc assumes familiarity with the following Kubernetes concepts: + +* [Pods](/docs/user-guide/pods/single-container/) +* [Cluster DNS](/docs/admin/dns/) +* [Headless Services](/docs/user-guide/services/#headless-services) +* [Persistent Volumes](/docs/user-guide/volumes/) +* [Dynamic volume provisioning](http://releases.k8s.io/{{page.githubbranch}}/examples/experimental/persistent-volume-provisioning/README.md) + +You need a working Kubernetes cluster at version >= 1.3, with a healthy DNS [cluster addon](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/README.md) at version >= 15. You cannot use Pet Set on a hosted Kubernetes provider that has disabled `alpha` resources. + +## What is a Pet Set? + +In Kubernetes, most pod management abstractions group them into disposable units of work that compose a micro service. Replication controllers for example, are designed with a weak guarantee - that there should be N replicas of a particular pod template. The pods are treated as stateless units, if one of them is unhealthy or superseded by a newer version, the system just disposes it. + +``` + foo.default.svc.cluster.local + |service| + / \ + | pod-asdf | | pod-zxcv | +``` + +A Pet Set, in contrast, is a group of stateful pods that require a stronger notion of identity. The document refers to these as "clustered applications". + +``` + *.foo.default.svc.cluster.local + | mysql-0 | <-> | mysql-1 | + [pv 0] [pv 1] +``` + +The co-ordinated deployment of clustered applications is notoriously hard. They require stronger notions of identity and membership, which they use in opaque internal protocols, and are especially prone to race conditions and deadlock. Traditionally administrators have deployed these applications by leveraging nodes as stable, long-lived entities with persistent storage and static ips. + +The goal of Pet Set is to decouple this dependency by assigning identities to individual instances of an application that are not anchored to the underlying physical infrastructure. For the rest of this document we will refer to these entities as "Pets". Our use of this term is predated by the "Pets vs Cattle" analogy. + +__Relationship between Pets and Pods__: PetSet requires there be {0..N-1} Pets. Each Pet has a deterministic name - PetSetName-Ordinal, and a unique identity. Each Pet has at most one pod, and each Pet Set has at most one Pet with a given identity. + +## When to use Pet Set? + +A Pet Set ensures that a specified number of "pets" with unique identities are running at any given time. The identity of a Pet is comprised of: + +* a stable hostname, available in DNS +* an ordinal index +* stable storage: linked to the ordinal & hostname + +These properties are useful in deploying stateful applications. However most stateful applications are also clustered, meaning they form groups with strict membership requirements that rely on stored state. Pet Set also helps with the 2 most common problems encountered managing such clustered applications: + +* discovery of peers for quorum +* startup/teardown ordering + +Only use Pet Set if your application requires some or all of these properties. Managing pods as stateless replicas is vastly easier. + +Example workloads for Pet Set: + +* Databases like MySQL or PostgreSQL that require a single instance attached to a NFS persistent volume at any time +* Clustered software like Zookeeper, Etcd, or Elasticsearch that require stable membership. + +## Alpha limitations + +Before you start deploying applications as Pet Sets, there are a few limitations you should understand. + +* Pet Set is an *alpha* resource, not available in any Kubernetes release prior to 1.3. +* As with all alpha/beta resources, it can be disabled through the `--runtime-config` option passed to the apiserver, and in fact most likely will be disabled on hosted offerings of Kubernetes. +* The only updatable field on a Pet Set is `replicas` +* The storage for a given pet must either be provisioned by a [dynamic storage provisioner](http://releases.k8s.io/{{page.githubbranch}}/examples/experimental/persistent-volume-provisioning/README.md) based on the requested `storage class`, or pre-provisioned by an admin. Note that dynamic volume provisioning is also currently in alpha. +* Deleting the Pet Set *will not* delete any pets. You will either have to manually scale it down to 0 pets first, or delete the pets yourself. +* Deleting and/or scaling a Pet Set down will *not* delete the volumes associated with the Pet Set. This is done to ensure safety first, your data is more valuable than an auto purge of all related Pet Set resources. **Deleting the Persistent Volume Claims will result in a deletion of the associated volumes**. +* All Pet Sets currently require a "governing service", or a Service responsible for the network identity of the pets. The user is responsible for this Service. +* Updating an existing Pet Set is currently a manual process, meaning you either need to deploy a new Pet Set with the new image version, or orphan Pets one by one, update their image, and join them back to the cluster. + +## Example Pet Set + +We'll create a basic Pet Set to demonstrate how Pets are assigned unique and "sticky" identities. + +{% include code.html language="yaml" file="petset.yaml" ghlink="/docs/user-guide/petset.yaml" %} + +Saving this config into `petset.yaml` and submitting it to a Kubernetes cluster should create the defined Pet Set and Pets it manages: + +```shell +$ kubectl create -f petset.yaml +service "nginx" created +petset "nginx" created +``` + +## Pet Identity + +The identity of a Pet sticks to it, regardless of which node it's (re) scheduled on. We can examine the identity of the pets we just created. + +### Ordinal index + +you should see 2 pods with predictable names formatted thus: `$(petset name)-$(ordinal index assigned by petset controller)` + +```shell +$ kubectl get po +NAME READY STATUS RESTARTS AGE +web-0 1/1 Running 0 10m +web-1 1/1 Running 0 10m +``` + +### Stable storage + +2 persistent volumes, one per pod. This is auto created by the Pet Set based on the `volumeTemplate` field + +```shell +$ kubectl get pv +NAME CAPACITY ACCESSMODES STATUS CLAIM REASON AGE +pvc-90234946-3717-11e6-a46e-42010af00002 1Gi RWO Bound default/www-web-0 11m +pvc-902733c2-3717-11e6-a46e-42010af00002 1Gi RWO Bound default/www-web-1 11m +``` + +### Network identity + +The network identity has 2 parts. First, we created a headless Service that controls the domain within which we create Pets. The domain managed by this Service takes the form: `$(service name).$(namespace).svc.cluster.local`, where "cluster.local" is the [cluster domain](http://releases.k8s.io/{{page.githubbranch}}/build/kube-dns/README.md#how-do-i-configure-it). As each pet is created, it gets a matching DNS subdomain, taking the form: `$(petname).$(governing service domain)`, where the governing service is defined by the `serviceName` field on the Pet Set. + +Here are some examples of choices for Cluster Domain, Service name, Pet Set name, and how that affects the DNS names for the Pets and the hostnames in the Pet's pods: + +Cluster Domain | Service (ns/name) | Pet Set (ns/name) | Pet Set Domain | Pet DNS | Pet Hostname | +-------------- | ----------------- | ----------------- | -------------- | ------- | ------------ | + cluster.local | default/nginx | default/web | nginx.default.svc.cluster.local | web-{0..N-1}.nginx.default.svc.cluster.local | web-{0..N-1} | + cluster.local | foo/nginx | foo/web | nginx.foo.svc.cluster.local | web-{0..N-1}.nginx.foo.svc.cluster.local | web-{0..N-1} | + kube.local | foo/nginx | foo/web | nginx.foo.svc.kube.local | web-{0..N-1}.nginx.foo.svc.kube.local | web-{0..N-1} | + +Note that Cluster Domain will be set to `cluster.local` unless [otherwise configured](http://releases.k8s.io/{{page.githubbranch}}/build/kube-dns/README.md#how-do-i-configure-it). + +Let's verify our assertion with a simple test. + +```shell +$ kubectl get svc +NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE +nginx None 80/TCP 12m +... +``` + +First, the PetSet provides a stable hostname: + +```shell +$ for i in 0 1; do kubectl exec web-$i -- sh -c 'hostname'; done +web-0 +web-1 +``` + +And the hostname is linked to the in-cluster DNS address: + +```shell +$ kubectl run -i --tty --image busybox dns-test --restart=Never /bin/sh +dns-test # nslookup web-0.nginx +Server: 10.0.0.10 +Address 1: 10.0.0.10 kube-dns.kube-system.svc.cluster.local + +Name: web-0.nginx +Address 1: 10.180.3.5 + +dns-test # nslookup web-1.nginx +Server: 10.0.0.10 +Address 1: 10.0.0.10 kube-dns.kube-system.svc.cluster.local + +Name: web-1.nginx +Address 1: 10.180.0.9 +``` + +The containers are running nginx webservers, which by default will look for an index.html file in `/usr/share/nginx/html/index.html`. That directory is backed by a `PersistentVolume` created by the Pet Set. So let's write our hostname there: + +```shell +$ for i in 0 1; do + kubectl exec web-$i -- sh -c 'echo $(hostname) > /usr/share/nginx/html/index.html'; +done +``` + +And verify each webserver serves its own hostname: + +```shell +$ for i in 0 1; do kubectl exec -it web-$i -- curl localhost; done +web-0 +web-1 +``` + +Now delete all pods in the petset: + +```shell +$ kubectl delete po -l app=nginx +pod "web-0" deleted +pod "web-1" deleted +``` + +Wait for them to come back up, and try to retrieve the previously written hostname through the DNS name of the peer. They match, because the storage, DNS name, and hostname stick to the Pet no matter where it gets scheduled: + +```shell +$ kubectl exec -it web-1 -- curl web-0.nginx +web-0 +$ kubectl exec -it web-0 -- curl web-1.nginx +web-1 +``` + +## Peer discovery + +A pet can piece together its own identity: + +1. Use the [downward api](/docs/user-guide/downward-api/) to find its pod name +2. Run `hostname` to find its DNS name +3. Run `mount` or `df` to find its volumes (usually this is unnecessary) + +It's not necessary to "discover" the governing Service of a Pet Set, since it's known at creation time you can simply pass it down through an [environment variable](/docs/user-guide/environment-guide). + +Usually pets also need to find their peers. In the previous nginx example, we just used `kubectl` to get the names of existing pods, and as humans, we could tell which ones belonged to a given Pet Set. Another way to find peers is by contacting the API server, just like `kubectl`, but that has several disadvantages (you end up implementing a Kubernetes specific init system that runs as pid 1 in your application container). + +Pet Set gives you a way to disover your peers using DNS records. To illustrate this we can use the previous example (note: one usually doesn't `apt-get` in a container). + +```shell +$ kubectl exec -it web-0 /bin/sh +web-0 # apt-get update && apt-get install -y dnsutils +... + +web-0 # nslookup -type=srv nginx.default +Server: 10.0.0.10 +Address: 10.0.0.10#53 + +nginx.default.svc.cluster.local service = 10 50 0 web-1.ub.default.svc.cluster.local. +nginx.default.svc.cluster.local service = 10 50 0 web-0.ub.default.svc.cluster.local. +``` + +## Updating a Pet Set + +You cannot update any field of the PetSet except `spec.replicas`. You can update the replicas field using standard kubectl update commands like [patch](/docs/user-guide/kubectl/kubectl_patch) and [edit](/docs/user-guide/kubectl/kubectl_edit). Pet Set currently *does not* support image upgrade as noted in the section on [limitations](#alpha-limitations). + +## Scaling a Pet Set + +You can scale a Pet Set by updating the "replicas" field. Note however that the controller will only: + +1. Create one pet at a time, in order from {0..N-1}, and wait till each one is in [Running and Ready](/docs/user-guide/pod-states) before creating the next +2. Delete one pet at a time, in reverse order from {N-1..0}, and wait till each one is completely shutdown (past its [terminationGracePeriodSeconds](/docs/user-guide/pods/index#termination-of-pods)) before deleting the next + +```shell +$ kubectl get po +NAME READY STATUS RESTARTS AGE +web-0 1/1 Running 0 30s +web-1 1/1 Running 0 36s + +$ kubectl patch petset web -p '{"spec":{"replicas":3}}' +"web" patched + +$ kubectl get po +NAME READY STATUS RESTARTS AGE +web-0 1/1 Running 0 40s +web-1 1/1 Running 0 46s +web-2 1/1 Running 0 8s +``` + +## Deleting a Pet Set + +Cleaning up a Pet Set is somewhat manual, as noted in the [limitations section](#alpha-limitations). You can delete a Pet Set using Kubectl, but this will *not* scale it down to 0: + +```shell +$ kubectl delete -f petset.yaml +petset "web" deleted + +$ kubectl get po -l app=nginx +NAME READY STATUS RESTARTS AGE +web-0 1/1 Running 0 21h +web-1 1/1 Running 0 21h + +$ kubectl delete po -l app=nginx +pod "web-0" deleted +pod "web-1" deleted +``` + +Deleting the pods will *not* delete the volumes. Until we finalize the recycle policy for these volumes they will have to get cleaned up by an admin. This is to ensure that you have the chance to copy data off the volume before deleting it. Simply deleting the PVC after the pods have left the [terminating state](/docs/user-guide/pods/index#termination-of-pods) should trigger deletion of the backing Persistent Volumes. + +**Note: you will lose all your data once the PVC is deleted, do this with caution.** + +```shell +$ kubectl get po -l app=nginx +$ kubectl get pvc -l app=nginx +NAME STATUS VOLUME CAPACITY ACCESSMODES AGE +www-web-0 Bound pvc-62d271cd-3822-11e6-b1b7-42010af00002 0 21h +www-web-1 Bound pvc-62d6750e-3822-11e6-b1b7-42010af00002 0 21h + +$ kubectl delete pvc -l app=nginx +$ kubectl get pv +``` + +If you simply want to clean everything: + +```shell{% raw %} +$ grace=$(kubectl get po web-0 --template '{{.spec.terminationGracePeriodSeconds}}') +$ kubectl delete petset,po -l app=nginx +$ sleep $grace +$ kubectl delete pvc -l app=nginx +{% endraw %}``` + +## Troubleshooting + +You might have noticed an `annotations` field in all the Pet Sets shown above. + +```yaml +annotations: + pod.alpha.kubernetes.io/initialized: "true" +``` + +This field is a debugging hook. It pauses any scale up/down operations on the entire Pet Set. If you'd like to pause a petset after each pet, set it to `false` in the template, wait for each pet to come up, verify it has initialized correctly, and then set it to `true` using `kubectl edit` on the pet (setting it to `false` on *any pet* is enough to pause the Pet Set). If you don't need it, create the Pet Set with it set to `true` as shown. This is surprisingly useful in debugging bootstrapping race conditions. + +## Future Work + +There are a LOT of planned improvements since Pet Set is still in alpha. + +* Data gravity and local storage +* Richer notification events +* Public network identities +* WAN cluster deployments (multi-AZ/region/cloud provider) +* Image and node upgrades + +This list goes on, if you have examples, ideas or thoughts, please contribute. + +## Alternatives + +Deploying one RC of size 1/Service per pod is a popular alternative, as is simply deploying a DaemonSet that utilizes the identity of a Node. + +## Next steps + +The deployment and maintenance of stateful applications is a vast topic. The next step is to explore cluster bootstrapping and initialization, [here](/docs/user-guide/petset/bootstrapping/). diff --git a/docs/user-guide/petset.yaml b/docs/user-guide/petset.yaml new file mode 100644 index 0000000000..5c29237c48 --- /dev/null +++ b/docs/user-guide/petset.yaml @@ -0,0 +1,51 @@ +# A headless service to create DNS records +apiVersion: v1 +kind: Service +metadata: + name: nginx + labels: + app: nginx +spec: + ports: + - port: 80 + name: web + # *.nginx.default.svc.cluster.local + clusterIP: None + selector: + app: nginx +--- +apiVersion: apps/v1alpha1 +kind: PetSet +metadata: + name: web +spec: + serviceName: "nginx" + replicas: 2 + template: + metadata: + labels: + app: nginx + annotations: + pod.alpha.kubernetes.io/initialized: "true" + spec: + terminationGracePeriodSeconds: 0 + containers: + - name: nginx + image: gcr.io/google_containers/nginx-slim:0.8 + ports: + - containerPort: 80 + name: web + volumeMounts: + - name: www + mountPath: /usr/share/nginx/html + volumeClaimTemplates: + - metadata: + name: www + annotations: + volume.alpha.kubernetes.io/storage-class: anything + spec: + accessModes: [ "ReadWriteOnce" ] + resources: + requests: + storage: 1Gi + diff --git a/docs/user-guide/petset/OWNERS b/docs/user-guide/petset/OWNERS new file mode 100644 index 0000000000..e0988eee55 --- /dev/null +++ b/docs/user-guide/petset/OWNERS @@ -0,0 +1,5 @@ +assignees: +- aledbf +- bprashanth +- foxish + diff --git a/docs/user-guide/petset/bootstrapping/index.md b/docs/user-guide/petset/bootstrapping/index.md new file mode 100644 index 0000000000..8a4924e303 --- /dev/null +++ b/docs/user-guide/petset/bootstrapping/index.md @@ -0,0 +1,243 @@ +--- +--- + +* TOC +{:toc} + +## Overview + +This purpose of this guide is to help you become familiar with the runtime initialization of [Pet Sets](/docs/user-guide/petset). This guide assumes the same prerequisites, and uses the same terminology as the [Pet Set user document](/docs/user-guide/petset). + +The most common way to initialize the runtime in a containerized environment, is through a custom [entrypoint](https://docs.docker.com/engine/reference/builder/#entrypoint). While this is not necessarily bad, making your application pid 1, and treating containers as processes in general is good for a few reasons outside the scope of this document. Doing so allows you to run docker images from third-party vendors without modification. We will not be writing custom entrypoints for this example, but using a feature called [init containers](http://releases.k8s.io/{{page.githubbranch}}/docs/proposals/container-init.md), to explain 2 common patterns that come up deploying Pet Sets. + +1. Transferring state across Pet restart, so that a future Pet is initialized with the computations of its past incarnation +2. Initializing the runtime environment of a Pet based on existing conditions, like a list of currently healthy peers + +## Example I: transferring state across Pet restart + +This example shows you how to "carry over" runtime state across Pet restart by simulating virtual machines with a Pet Set. + +### Background + +Applications that incrementally build state usually need strong guarantees that they will not restart for extended durations. This is tricky to achieve with containers, so instead, we will ensure that the results of previous computations are trasferred to future pets. Doing so is straight-forward using vanilla Persistent Volumes (which Pet Set already gives you), unless the volume mount point itself needs to be initialized for the Pet to start. This is exactly the case with "virtual machine" docker images, like those based on ubuntu or fedora. Such images embed the entier rootfs of the distro, including package managers like `apt-get` that assume a certain layout of the filesystem. Meaning: + +* If you mount an empty volume under `/usr`, you won't be able to `apt-get` +* If you mount an empty volume under `/lib`, all your `apt-gets` will fail because there are no system libraries +* If you clobber either of those, previous `apt-get` results will be dysfunctional + +### Simulating Virtual Machines + +Since Pet Set already gives each Pet a consistent identity, all we need is a way to initialize the user environment before allowing tools like `kubectl exec` to enter the application container. + +Download [this](petset_vm.yaml) petset into a file called petset_vm.yaml, and create it: + +```shell +$ kubectl create -f petset_vm.yaml +service "ub" created +petset "vm" created +``` + +This should give you 2 pods. + +```shell +$ kubectl get po +NAME READY STATUS RESTARTS AGE +vm-0 1/1 Running 0 37s +vm-1 1/1 Running 0 2m +``` + +We can exec into one and install nginx + +```shell +$ kubectl exec -it vm-0 /bin/sh +vm-0 # apt-get update +... +vm-0 # apt-get install nginx -y +``` + +On killing this pod we need it to come back with all the Pet Set properties, as well as the installed nginx packages. + +```shell +$ kubectl delete po vm-0 +pod "vm-0" deleted + +$ kubectl get po +NAME READY STATUS RESTARTS AGE +vm-0 1/1 Running 0 1m +vm-1 1/1 Running 0 4m +``` + +Now you can exec back into vm-0 and start nginx + +```shell +$ kubectl exec -it vm-0 /bin/sh +vm-0 # mkdir -p /var/log/nginx /var/lib/nginx; nginx -g 'daemon off;' + +``` + +And access it from anywhere in the cluster (and because this is an example that simulates vms, we're going to apt-get install netcat too) + +```shell +$ kubectl exec -it vm-1 /bin/sh +vm-1 # apt-get update +... +vm-1 # apt-get install netcat -y +vm-1 # printf "GET / HTTP/1.0\r\n\r\n" | netcat vm-0.ub 80 +``` + +It's worth exploring what just happened. Init containers run sequentially *before* the application container. In this example we used the init container to copy shared libraries from the rootfs, while preserving user installed packages across container restart. + +```yaml +pod.alpha.kubernetes.io/init-containers: '[ + { + "name": "rootfs", + "image": "ubuntu:15.10", + "command": [ + "/bin/sh", + "-c", + "for d in usr lib etc; do cp -vnpr /$d/* /${d}mnt; done;" + ], + "volumeMounts": [ + { + "name": "usr", + "mountPath": "/usrmnt" + }, + { + "name": "lib", + "mountPath": "/libmnt" + }, + { + "name": "etc", + "mountPath": "/etcmnt" + } + ] + } +]' +``` + +**It's important to note that the init container, when used this way, must be idempotent, or it'll end up clobbering data stored by a previous incarnation.** + + +## Example II: initializing state based on environment + +In this example we are going to setup a cluster of nginx servers, just like we did in the Pet Set [user guide](/docs/user-guide/petset), but make one of them a master. All the other nginx servers will simply proxy requests to the master. This is a common deployment pattern for databases like Mysql, but we're going to replace the database with a stateless webserver to simplify the problem. + +### Background + +Most clustered applications, such as mysql, require an admin to create a config file based on the current state of the world. The most common dynamic variable in such config files is a list of peers, or other Pets running similar database servers that are currently serving requests. The Pet Set user guide already [touched on this topic](/docs/user-guide/petset#peer-discovery), we'll explore it in greater depth in the context of writing a config file with a list of peers. + +Here's a tiny peer finder helper script that handles peer discovery, [available here](https://github.com/kubernetes/contrib/tree/master/pets/peer-finder). The peer finder takes 3 important arguments: + +* A DNS domain +* An `on-start` script to run with the initial constituency of the given domain as input +* An `on-change` script to run everytime the constituency of the given domain changes + +The role of the peer finder: + +* Poll DNS for SRV records of a given domain till the `hostname` of the pod it's running in shows up as a subdomain +* Pipe the sorted list of subdomains to the script specified by its `--on-start` argument +* Exit with the appropriate error code if no `--on-change` script is specified +* Loop invoking `--on-change` for every change + +You can invoke the peer finder inside the Pets we created in the last example: + +```shell +$ kubectl exec -it vm-0 /bin/sh +vm-0 # apt-get update +... +vm-0 # apt-get install curl -y +vm-0 # curl -sSL -o /peer-finder https://storage.googleapis.com/kubernetes-release/pets/peer-finder +vm-0 # chmod -c 755 peer-finder + +vm-0 # ./peer-finder +2016/06/23 21:25:46 Incomplete args, require -on-change and/or -on-start, -service and -ns or an env var for POD_NAMESPACE. + +vm-0 # ./peer-finder -on-start 'tee' -service ub -ns default + +2016/06/23 21:30:21 Peer list updated +was [] +now [vm-0.ub.default.svc.cluster.local vm-1.ub.default.svc.cluster.local] +2016/06/23 21:30:21 execing: tee with stdin: vm-0.ub.default.svc.cluster.local +vm-1.ub.default.svc.cluster.local +2016/06/23 21:30:21 vm-0.ub.default.svc.cluster.local +vm-1.ub.default.svc.cluster.local +2016/06/23 21:30:22 Peer finder exiting +``` + +### Nginx master/slave cluster + +Lets create a Pet Set that writes out its own config based on a list of peers at initalization time, as described above. + +Download and create [this](petset_peers.yaml) petset. It will setup 2 nginx webservers, but the second one will proxy all requests to the first: + +```shell +$ kubectl create -f petset_peers.yaml +service "nginx" created +petset "web" created + +$ kubectl get po --watch-only +NAME READY STATUS RESTARTS AGE +web-0 0/1 Pending 0 7s +web-0 0/1 Init:0/1 0 18s +web-0 0/1 PodInitializing 0 20s +web-0 1/1 Running 0 21s +web-1 0/1 Pending 0 0s +web-1 0/1 Init:0/1 0 0s +web-1 0/1 PodInitializing 0 20s +web-1 1/1 Running 0 21s + +$ kubectl get po +NAME READY STATUS RESTARTS AGE +web-0 1/1 Running 0 1m +web-1 1/1 Running 0 47s +``` + +web-1 will redirect all requests to it's "master": + +```shell +$ kubectl exec -it web-1 -- curl localhost +web-0 +``` + +If you scale the cluster, the new pods parent themselves to the same master. To test this you can `kubectl edit` the petset and change the `replicas` field to 5: + +```shell +$ kubectl edit petset web +... + +$ kubectl get po -l app=nginx +NAME READY STATUS RESTARTS AGE +web-0 1/1 Running 0 2h +web-1 1/1 Running 0 2h +web-2 1/1 Running 0 1h +web-3 1/1 Running 0 1h +web-4 1/1 Running 0 1h + +$ for i in $(seq 0 4); do kubectl exec -it web-$i -- curl localhost; done | sort | uniq +web-0 +``` + +Understanding how we generated the nginx config is important, we did so by passing an init script to the peer finder: + +```shell +echo ` +readarray PEERS; +if [ 1 = ${#PEERS[@]} ]; then + echo \"events{} http { server{ } }\"; +else + echo \"events{} http { server{ location / { proxy_pass http://${PEERS[0]}; } } }\"; +fi;` > /conf/nginx.conf +``` + +All that does is: + +* read in a list of peers from stdin +* if there's only 1, promote it to master +* if there's more than 1, proxy requests to the 0th member of the list +* write the config to a `hostPath` volume shared with the parent PetSet + +**It's important to note that in practice all Pets should query their peers for the current master, instead of making assumptions based on the index.** + +## Next Steps + +You can deploy some example Pet Sets found [here](https://github.com/kubernetes/kubernetes/tree/master/test/e2e/testing-manifests/petset), or write your own. diff --git a/docs/user-guide/petset/bootstrapping/petset_peers.yaml b/docs/user-guide/petset/bootstrapping/petset_peers.yaml new file mode 100644 index 0000000000..f8393b5c2c --- /dev/null +++ b/docs/user-guide/petset/bootstrapping/petset_peers.yaml @@ -0,0 +1,103 @@ +# A headless service to create DNS records +apiVersion: v1 +kind: Service +metadata: + annotations: + service.alpha.kubernetes.io/tolerate-unready-endpoints: "true" + name: nginx + labels: + app: nginx +spec: + ports: + - port: 80 + name: web + # *.nginx.default.svc.cluster.local + clusterIP: None + selector: + app: nginx +--- +apiVersion: apps/v1alpha1 +kind: PetSet +metadata: + name: web +spec: + serviceName: "nginx" + replicas: 2 + template: + metadata: + labels: + app: nginx + annotations: + pod.alpha.kubernetes.io/initialized: "true" + pod.alpha.kubernetes.io/init-containers: '[ + { + "name": "peerfinder", + "image": "gcr.io/google_containers/peer-finder:0.1", + "args": [ + "-on-start=\"\"echo ` + readarray PEERS; + echo $(hostname) > /usr/share/nginx/html/index.html; + if [ 1 = ${#PEERS[@]} ]; then + echo \"events{} http { server{ } }\"; + else + echo \"events{} http { server{ location / { proxy_pass http://${PEERS[0]}; } } }\"; + fi;` > /conf/nginx.conf\"\"", + "-service=nginx" + ], + "env": [ + { + "name": "POD_NAMESPACE", + "valueFrom": { + "fieldRef": { + "apiVersion": "v1", + "fieldPath": "metadata.namespace" + } + } + } + ], + "volumeMounts": [ + { + "name": "www", + "mountPath": "/usr/share/nginx/html" + }, + { + "name": "conf", + "mountPath": "/conf" + } + ] + } + ]' + spec: + terminationGracePeriodSeconds: 0 + containers: + - name: nginx + image: gcr.io/google_containers/nginx-slim:0.8 + ports: + - containerPort: 80 + name: web + command: + - nginx + args: + - -g + - "daemon off;" + - -c + - "/conf/nginx.conf" + volumeMounts: + - name: www + mountPath: /usr/share/nginx/html + - name: conf + mountPath: /conf + volumes: + - name: conf + emptyDir: {} + volumeClaimTemplates: + - metadata: + name: www + annotations: + volume.alpha.kubernetes.io/storage-class: anything + spec: + accessModes: [ "ReadWriteOnce" ] + resources: + requests: + storage: 1Gi + diff --git a/docs/user-guide/petset/bootstrapping/petset_vm.yaml b/docs/user-guide/petset/bootstrapping/petset_vm.yaml new file mode 100644 index 0000000000..c506a1bac6 --- /dev/null +++ b/docs/user-guide/petset/bootstrapping/petset_vm.yaml @@ -0,0 +1,102 @@ +# A headless service to create DNS records +apiVersion: v1 +kind: Service +metadata: + name: ub + labels: + app: ub +spec: + ports: + - port: 80 + name: web + # *.ub.default.svc.cluster.local + clusterIP: None + selector: + app: ub +--- +apiVersion: apps/v1alpha1 +kind: PetSet +metadata: + name: vm +spec: + serviceName: "ub" + replicas: 2 + template: + metadata: + labels: + app: ub + annotations: + pod.alpha.kubernetes.io/initialized: "true" + pod.alpha.kubernetes.io/init-containers: '[ + { + "name": "rootfs", + "image": "ubuntu:15.10", + "command": [ + "/bin/sh", + "-c", + "for d in usr lib etc; do cp -vnpr /$d/* /${d}mnt; done;" + ], + "volumeMounts": [ + { + "name": "usr", + "mountPath": "/usrmnt" + }, + { + "name": "lib", + "mountPath": "/libmnt" + }, + { + "name": "etc", + "mountPath": "/etcmnt" + } + ] + } + ]' + spec: + terminationGracePeriodSeconds: 0 + containers: + - name: ub + image: ubuntu:15.10 + ports: + - containerPort: 80 + name: web + command: + - /bin/sh + - -c + - 'while true; do sleep 10; done' + volumeMounts: + - name: usr + mountPath: /usr + - name: lib + mountPath: /lib + - name: etc + mountPath: /etc + volumeClaimTemplates: + - metadata: + name: usr + annotations: + volume.alpha.kubernetes.io/storage-class: anything + spec: + accessModes: [ "ReadWriteOnce" ] + resources: + requests: + storage: 300Mi + - metadata: + name: lib + annotations: + volume.alpha.kubernetes.io/storage-class: anything + spec: + accessModes: [ "ReadWriteOnce" ] + resources: + requests: + storage: 1Gi + - metadata: + name: etc + annotations: + volume.alpha.kubernetes.io/storage-class: anything + spec: + accessModes: [ "ReadWriteOnce" ] + resources: + requests: + storage: 150Mi + diff --git a/docs/user-guide/pod-states.md b/docs/user-guide/pod-states.md index 27839b7480..8806e3be7c 100644 --- a/docs/user-guide/pod-states.md +++ b/docs/user-guide/pod-states.md @@ -1,4 +1,7 @@ --- +assignees: +- mikedanese + --- Updated: 4/14/2015 diff --git a/docs/user-guide/pod-templates.md b/docs/user-guide/pod-templates.md index e37a114013..1b73b73694 100644 --- a/docs/user-guide/pod-templates.md +++ b/docs/user-guide/pod-templates.md @@ -1,4 +1,7 @@ --- +assignees: +- erictune + --- Pod templates are [pod](/docs/user-guide/pods/) specifications which are included in other objects, such as [Replication Controllers](/docs/user-guide/replication-controller/), [Jobs](/docs/user-guide/jobs/), and diff --git a/docs/user-guide/pods/OWNERS b/docs/user-guide/pods/OWNERS new file mode 100644 index 0000000000..a3b5c6ba21 --- /dev/null +++ b/docs/user-guide/pods/OWNERS @@ -0,0 +1,4 @@ +assignees: +- caesarxuchao +- mikedanese + diff --git a/docs/user-guide/pods/index.md b/docs/user-guide/pods/index.md index f9f8808985..4c16b66074 100644 --- a/docs/user-guide/pods/index.md +++ b/docs/user-guide/pods/index.md @@ -1,4 +1,6 @@ --- +assignees: + --- * TOC diff --git a/docs/user-guide/pods/multi-container.md b/docs/user-guide/pods/multi-container.md index fe050e4f62..6c166af20d 100644 --- a/docs/user-guide/pods/multi-container.md +++ b/docs/user-guide/pods/multi-container.md @@ -1,4 +1,7 @@ --- +assignees: +- janetkuo + --- * TOC diff --git a/docs/user-guide/pods/pod-sample.json b/docs/user-guide/pods/pod-sample.json index 25d0373204..7cab452b64 100644 --- a/docs/user-guide/pods/pod-sample.json +++ b/docs/user-guide/pods/pod-sample.json @@ -14,7 +14,7 @@ "image": "redis", "ports": [ { - "containerPort": 6379, + "containerPort": 6379 } ] }, @@ -23,7 +23,7 @@ "image": "django", "ports": [ { - "containerPort": 8000, + "containerPort": 8000 } ] } diff --git a/docs/user-guide/pods/single-container.md b/docs/user-guide/pods/single-container.md index 50e48de870..605534acda 100644 --- a/docs/user-guide/pods/single-container.md +++ b/docs/user-guide/pods/single-container.md @@ -1,4 +1,7 @@ --- +assignees: +- janetkuo + --- * TOC diff --git a/docs/user-guide/prereqs.md b/docs/user-guide/prereqs.md index 51359e182a..dfba1542af 100644 --- a/docs/user-guide/prereqs.md +++ b/docs/user-guide/prereqs.md @@ -1,4 +1,8 @@ --- +assignees: +- bgrant0607 +- mikedanese + --- To deploy and manage applications on Kubernetes, you’ll use the Kubernetes command-line tool, [kubectl](/docs/user-guide/kubectl/kubectl/). It lets you inspect your cluster resources, create, delete, and update components, and much more. You will use it to look at your new cluster and bring up example apps. diff --git a/docs/user-guide/production-pods.md b/docs/user-guide/production-pods.md index 13babe5b92..efd1c43e43 100644 --- a/docs/user-guide/production-pods.md +++ b/docs/user-guide/production-pods.md @@ -1,4 +1,9 @@ --- +assignees: +- bgrant0607 +- janetkuo +- thockin + --- You've seen [how to configure and deploy pods and containers](/docs/user-guide/configuring-containers), using some of the most common configuration parameters. This section dives into additional features that are especially useful for running applications in production. @@ -180,6 +185,26 @@ Other times, applications are only temporarily unable to serve, and will recover For more details (e.g., how to specify command-based probes), see the [example in the walkthrough](/docs/user-guide/walkthrough/k8s201/#health-checking), the [standalone example](/docs/user-guide/liveness/), and the [documentation](/docs/user-guide/pod-states/#container-probes). +## Handling initialization + +Applications often need a set of initialization steps prior to performing their day job. This may include: + +* Waiting for other components (like a database or web service) to be available +* Performing configuration templating from environment variables into a config file +* Registering the pod into a central database, or fetching remote configuration from that database +* Downloading application dependencies, seed data, or preconfiguring disk + +Kubernetes now includes an alpha feature known as **init containers**, which are one or more containers in a pod that get a chance to run and initialize shared volumes prior to the other application containers starting. An init container is exactly like a regular container, except that it always runs to completion and each init container must complete successfully before the next one is started. If the init container fails (exits with a non-zero exit code) on a `RestartNever` pod the pod will fail - otherwise it will be restarted until it succeeds or the user deletes the pod. + +Since init containers are an alpha feature, they are specified by setting the `pod.alpha.kubernetes.io/init-containers` annotation on a pod (or replica set, deployment, daemon set, pet set, or job). The value of the annotation must be a string containing a JSON array of container definitions: + +{% include code.html language="yaml" file="nginx-init-containers.yaml" ghlink="/docs/user-guide/nginx-init-containers.yaml" %} + +The status of the init containers is returned as another annotation - `pod.alpha.kubernetes.io/init-container-statuses` -- as an array of the container statuses (similar to the `status.containerStatuses` field). + +Init containers support all of the same features as normal containers, including resource limits, volumes, and security settings. The resource requests and limits for an init container are handled slightly different than normal containers since init containers are run one at a time instead of all at once - any limits or quotas will be applied based on the largest init container resource quantity, rather than as the sum of quantities. Init containers do not support readiness probes since they will run to completion before the pod can be ready. + + ## Lifecycle hooks and termination notice Of course, nodes and applications may fail at any time, but many applications benefit from clean shutdown, such as to complete in-flight requests, when the termination of the application is deliberate. To support such cases, Kubernetes supports two kinds of notifications: diff --git a/docs/user-guide/quick-start.md b/docs/user-guide/quick-start.md index 00dc999d53..9e9e59dbd8 100644 --- a/docs/user-guide/quick-start.md +++ b/docs/user-guide/quick-start.md @@ -1,4 +1,8 @@ --- +assignees: +- bgrant0607 +- janetkuo + --- This guide will help you get oriented to Kubernetes and running your first containers on the cluster. If you are already familiar with the docker-cli, you can also checkout the docker-cli to kubectl migration guide [here](/docs/user-guide/docker-cli-to-kubectl). @@ -11,14 +15,20 @@ This guide will help you get oriented to Kubernetes and running your first conta Once your application is packaged into a container and pushed to an image registry, you're ready to deploy it to Kubernetes. Through integration with some cloud providers (for example Google Compute Engine and AWS EC2), Kubernetes also enables you to request it to provision a public IP address for your application. -For example, [nginx](http://wiki.nginx.org/Main) is a popular HTTP server, with a [pre-built container on Docker hub](https://registry.hub.docker.com/_/nginx/). The [`kubectl run`](/docs/user-guide/kubectl/kubectl_run) command below will create two nginx replicas, listening on port 80, and a public IP address for your application. +For example, [nginx](http://wiki.nginx.org/Main) is a popular HTTP server, with a [pre-built container on Docker hub](https://registry.hub.docker.com/_/nginx/). The [`kubectl run`](/docs/user-guide/kubectl/kubectl_run) commands below will create two nginx replicas, listening on port 80, and a public IP address for your application. ```shell -$ kubectl run my-nginx --image=nginx --replicas=2 --port=80 --expose --service-overrides='{ "spec": { "type": "LoadBalancer" } }' -service "my-nginx" created +$ kubectl run my-nginx --image=nginx --replicas=2 --port=80 deployment "my-nginx" created ``` +To expose your service to the public internet, run: + +```shell +$ kubectl expose deployment my-nginx --target-port=80 --type=LoadBalancer +service "my-nginx" exposed +``` + You can see that they are running by: ```shell @@ -33,7 +43,7 @@ Kubernetes will ensure that your application keeps running, by automatically res To find the public IP address assigned to your application, execute: ```shell -$ kubectl get service/my-nginx +$ kubectl get service my-nginx NAME CLUSTER_IP EXTERNAL_IP PORT(S) AGE my-nginx 10.179.240.1 25.1.2.3 80/TCP 8s ``` diff --git a/docs/user-guide/replicasets.md b/docs/user-guide/replicasets.md index b2b9b02ee3..27e9e3da88 100644 --- a/docs/user-guide/replicasets.md +++ b/docs/user-guide/replicasets.md @@ -1,4 +1,9 @@ --- +assignees: +- Kashomon +- bprashanth +- madhusudancs + --- * TOC @@ -22,16 +27,16 @@ instead. Also, the imperative whereas Deployments are declarative, so we recommend using Deployments through the [`rollout`](/docs/user-guide/kubectl/kubectl_rollout/) command. -While replica sets can be used independently, today it's mainly used by +While Replica Sets can be used independently, today it's mainly used by [Deployments](/docs/user-guide/deployments/) as a mechanism to orchestrate pod creation, deletion and updates. When you use Deployments you don't have to worry -about managing the replica sets that they create. Deployments own and manage -their replica sets. +about managing the Replica Sets that they create. Deployments own and manage +their Replica Sets. ## When to use a Replica Set? A Replica Set ensures that a specified number of pod “replicas” are running at any given -time. However, a Deployment is a higher-level concept that manages replica sets and +time. However, a Deployment is a higher-level concept that manages Replica Sets and provides declarative updates to pods along with a lot of other useful features. Therefore, we recommend using Deployments instead of directly using Replica Sets, unless you require custom update orchestration or don't require updates at all. @@ -44,7 +49,7 @@ use directly a Deployment and define your application in the spec section. {% include code.html language="yaml" file="replicasets/frontend.yaml" ghlink="/docs/user-guide/replicasets/frontend.yaml" %} Saving this config into `frontend.yaml` and submitting it to a Kubernetes cluster should -create the defined replica set and the pods that it manages. +create the defined Replica Set and the pods that it manages. ```shell $ kubectl create -f frontend.yaml diff --git a/docs/user-guide/replicasets/OWNERS b/docs/user-guide/replicasets/OWNERS new file mode 100644 index 0000000000..09661bf943 --- /dev/null +++ b/docs/user-guide/replicasets/OWNERS @@ -0,0 +1,4 @@ +assignees: +- bprashanth +- madhusudancs + diff --git a/docs/user-guide/replication-controller/OWNERS b/docs/user-guide/replication-controller/OWNERS new file mode 100644 index 0000000000..0963160a82 --- /dev/null +++ b/docs/user-guide/replication-controller/OWNERS @@ -0,0 +1,7 @@ +assignees: +- bprashanth +- bprashanth +- caesarxuchao +- janetkuo +- mikedanese + diff --git a/docs/user-guide/replication-controller/index.md b/docs/user-guide/replication-controller/index.md index 9dbf4f3a93..d5f4cfe10b 100644 --- a/docs/user-guide/replication-controller/index.md +++ b/docs/user-guide/replication-controller/index.md @@ -1,4 +1,8 @@ --- +assignees: +- bprashanth +- janetkuo + --- * TOC @@ -15,7 +19,7 @@ replication controller are automatically replaced if they fail, get deleted, or For example, your pods get re-created on a node after disruptive maintenance such as a kernel upgrade. For this reason, we recommend that you use a replication controller even if your application requires only a single pod. You can think of a replication controller as something similar to a process supervisor, -but rather then individual processes on a single node, the replication controller supervises multiple pods +but rather than individual processes on a single node, the replication controller supervises multiple pods across multiple nodes. Replication Controller is often abbreviated to "rc" or "rcs" in discussion, and as a shortcut in diff --git a/docs/user-guide/replication-controller/operations.md b/docs/user-guide/replication-controller/operations.md index 78f10dbd3f..1d33f352c2 100644 --- a/docs/user-guide/replication-controller/operations.md +++ b/docs/user-guide/replication-controller/operations.md @@ -1,4 +1,7 @@ --- +assignees: +- bprashanth + --- * TOC {:toc} diff --git a/docs/user-guide/resizing-a-replication-controller.md b/docs/user-guide/resizing-a-replication-controller.md index ada87aade0..8c3c8dc288 100644 --- a/docs/user-guide/resizing-a-replication-controller.md +++ b/docs/user-guide/resizing-a-replication-controller.md @@ -1,4 +1,7 @@ --- +assignees: +- bprashanth + --- To increase or decrease the number of pods under a replication controller's diff --git a/docs/user-guide/rolling-updates.md b/docs/user-guide/rolling-updates.md index ce3444ebf9..63d3622c89 100644 --- a/docs/user-guide/rolling-updates.md +++ b/docs/user-guide/rolling-updates.md @@ -1,4 +1,7 @@ --- +assignees: +- janetkuo + --- * TOC @@ -8,8 +11,8 @@ To update a service without an outage, `kubectl` supports what is called ['rolling update'](/docs/user-guide/kubectl/kubectl_rolling-update), which updates one pod at a time, rather than taking down the entire service at the same time. See the [rolling update design document](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/simple-rolling-update.md) and the [example of rolling update](/docs/user-guide/update-demo/) for more information. -Note that `kubectl rolling-update` only supports Replication Controllers. However, if you deploy applications with Replication Controllers, -consider switching them to [Deployments](/docs/user-guide/deployments/). A Deployments is a higher-level controller that automates rolling updates +Note that `kubectl rolling-update` only supports Replication Controllers. However, if you deploy applications with Replication Controllers, +consider switching them to [Deployments](/docs/user-guide/deployments/). A Deployments is a higher-level controller that automates rolling updates of applications declaratively, and therefore is recommended. If you still want to keep your Replication Controllers and use `kubectl rolling-update`, keep reading: A rolling update applies changes to the configuration of pods being managed by @@ -73,7 +76,7 @@ The update will fail if `IMAGE:TAG` is identical to the current value. For this reason, we recommend the use of versioned tags as opposed to values such as `:latest`. Doing a rolling update from `image:latest` to a new `image:latest` will fail, even if the image at that tag has changed. -Moreover, the use of `:latest` is not recommended, see +Moreover, the use of `:latest` is not recommended, see [Best Practices for Configuration](/docs/user-guide/config-best-practices/#container-images) for more information. ### Examples @@ -215,7 +218,7 @@ spec: containers: - name: nginx image: nginx:1.9.2 - args: [“nginx”,”-T”] + args: ["nginx", "-T"] ports: - containerPort: 80 ``` diff --git a/docs/user-guide/secrets/OWNERS b/docs/user-guide/secrets/OWNERS new file mode 100644 index 0000000000..d46c3863b3 --- /dev/null +++ b/docs/user-guide/secrets/OWNERS @@ -0,0 +1,4 @@ +assignees: +- mikedanese +- pmorie + diff --git a/docs/user-guide/secrets/index.md b/docs/user-guide/secrets/index.md index 64bf51a1cb..6cf073d828 100644 --- a/docs/user-guide/secrets/index.md +++ b/docs/user-guide/secrets/index.md @@ -1,4 +1,7 @@ --- +assignees: +- mikedanese + --- Objects of type `secret` are intended to hold sensitive information, such as @@ -66,6 +69,7 @@ You can check that the secret was created like this: $ kubectl get secrets NAME TYPE DATA AGE db-user-pass Opaque 2 51s + $ kubectl describe secrets/db-user-pass Name: db-user-pass Namespace: default @@ -154,7 +158,7 @@ type: Opaque Decode the password field: ```shell -$ echo "MWYyZDFlMmU2N2Rm" | base64 -D +$ echo "MWYyZDFlMmU2N2Rm" | base64 -d 1f2d1e2e67df ``` @@ -212,9 +216,53 @@ own `volumeMounts` block, but only one `spec.volumes` is needed per secret. You can package many files into one secret, or use many secrets, whichever is convenient. -See another example of creating a secret and a pod that consumes that secret in a volume [here](/docs/user-guide/secrets/). +**Projection of secret keys to specific paths** -##### Consuming Secret Values from Volumes +We can also control the paths within the volume where Secret keys are projected. +You can use `spec.volumes[].secret.items` field to change target path of each key: + +```json +{ + "apiVersion": "v1", + "kind": "Pod", + "metadata": { + "name": "mypod", + "namespace": "myns" + }, + "spec": { + "containers": [{ + "name": "mypod", + "image": "redis", + "volumeMounts": [{ + "name": "foo", + "mountPath": "/etc/foo", + "readOnly": true + }] + }], + "volumes": [{ + "name": "foo", + "secret": { + "secretName": "mysecret", + "items": [{ + "key": "username", + "path": "my-group/my-username" + }] + } + }] + } +} +``` + +What will happen: + +* `username` secret is stored under `/etc/foo/my-group/my-username` file instead of `/etc/foo/username`. +* `password` secret is not projected + +If `spec.volumes[].secret.items` is used, only keys specified in `items` are projected. +To consume all keys from the secret, all of them must be listed in the `items` field. +All listed keys must exist in the corresponding secret. Otherwise, the volume is not created. + +**Consuming Secret Values from Volumes** Inside the container that mounts a secret volume, the secret keys appear as files and the secret values are base-64 decoded and stored inside these files. @@ -234,6 +282,11 @@ $ cat /etc/foo/password The program in a container is responsible for reading the secret(s) from the files. +**Mounted Secrets are updated automatically** + +When a secret being already consumed in a volume is updated, projected keys are eventually updated as well. +The update time depends on the kubelet syncing period. + #### Using Secrets as Environment Variables To use a secret in an environment variable in a pod: @@ -267,7 +320,7 @@ spec: restartPolicy: Never ``` -##### Consuming Secret Values from Environment Variables +**Consuming Secret Values from Environment Variables** Inside a container that consumes a secret in an environment variables, the secret keys appear as normal environment variables containing the base-64 decoded values of the secret data. @@ -285,7 +338,7 @@ $ echo $SECRET_PASSWORD An imagePullSecret is a way to pass a secret that contains a Docker (or other) image registry password to the Kubelet so it can pull a private image on behalf of your Pod. -##### Manually specifying an imagePullSecret +**Manually specifying an imagePullSecret** Use of imagePullSecrets is described in the [images documentation](/docs/user-guide/images/#specifying-imagepullsecrets-on-a-pod) @@ -338,23 +391,6 @@ reason it is not started yet. Once the secret is fetched, the kubelet will create and mount a volume containing it. None of the pod's containers will start until all the pod's volumes are mounted. -Once the kubelet has started a pod's containers, its secret volumes will not -change, even if the secret resource is modified. To change the secret used, -the original pod must be deleted, and a new pod (perhaps with an identical -`PodSpec`) must be created. Therefore, updating a secret follows the same -workflow as deploying a new container image. The `kubectl rolling-update` -command can be used ([man page](/docs/user-guide/kubectl/kubectl_rolling-update)). - -The [`resourceVersion`](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#concurrency-control-and-consistency) -of the secret is not specified when it is referenced. -Therefore, if a secret is updated at about the same time as pods are starting, -then it is not defined which version of the secret will be used for the pod. It -is not possible currently to check what resource version of a secret object was -used when a pod was created. It is planned that pods will report this -information, so that a replication controller restarts ones using an old -`resourceVersion`. In the interim, if this is a concern, it is recommended to not -update the data of existing secrets, but to create new ones with distinct names. - ## Use cases ### Use-Case: Pod with ssh keys @@ -425,10 +461,10 @@ credentials. Make the secrets: ```shell -$ kubectl create secret generic prod-db-password --from-literal=user=produser --from-literal=password=Y4nys7f11 -secret "prod-db-password" created -$ kubectl create secret generic test-db-password --from-literal=user=testuser --from-literal=password=iluvtests -secret "test-db-password" created +$ kubectl create secret generic prod-db-secret --from-literal=user=produser --from-literal=password=Y4nys7f11 +secret "prod-db-secret" created +$ kubectl create secret generic test-db-secret --from-literal=user=testuser --from-literal=password=iluvtests +secret "test-db-secret" created ``` Now make the pods: @@ -546,7 +582,7 @@ one called, say, `prod-user` with the `prod-db-secret`, and one called, say, ### Use-case: Dotfiles in secret volume In order to make piece of data 'hidden' (ie, in a file whose name begins with a dot character), simply -make that key begin with a dot. For example, when the following secret secret is mounted into a volume: +make that key begin with a dot. For example, when the following secret is mounted into a volume: ```json { diff --git a/docs/user-guide/secrets/walkthrough.md b/docs/user-guide/secrets/walkthrough.md index 1bb3d262eb..001be6add4 100644 --- a/docs/user-guide/secrets/walkthrough.md +++ b/docs/user-guide/secrets/walkthrough.md @@ -1,4 +1,6 @@ --- +assignees: + --- Following this example, you will create a secret and a [pod](/docs/user-guide/pods/) that consumes that secret in a [volume](/docs/user-guide/volumes/). See [Secrets design document](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/secrets.md) for more information. diff --git a/docs/user-guide/security-context.md b/docs/user-guide/security-context.md index df159de8e4..78c4ae46f2 100644 --- a/docs/user-guide/security-context.md +++ b/docs/user-guide/security-context.md @@ -1,4 +1,9 @@ --- +assignees: +- erictune +- mikedanese +- thockin + --- A security context defines the operating system security settings (uid, gid, capabilities, SELinux role, etc..) applied to a container. See [security context design](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/security_context.md) for more details. diff --git a/docs/user-guide/service-accounts.md b/docs/user-guide/service-accounts.md index f51dbd87bb..3fa9252034 100644 --- a/docs/user-guide/service-accounts.md +++ b/docs/user-guide/service-accounts.md @@ -1,4 +1,9 @@ --- +assignees: +- bprashanth +- liggitt +- thockin + --- A service account provides an identity for processes that run in a Pod. @@ -111,6 +116,8 @@ secrets/build-robot-secret Now you can confirm that the newly built secret is populated with an API token for the "build-robot" service account. +Any tokens for non-existent service accounts will be cleaned up by the token controller. + ```shell $ kubectl describe secrets/build-robot-secret Name: build-robot-secret diff --git a/docs/user-guide/services-firewalls.md b/docs/user-guide/services-firewalls.md index b7f48116cd..8755d222a5 100644 --- a/docs/user-guide/services-firewalls.md +++ b/docs/user-guide/services-firewalls.md @@ -1,4 +1,8 @@ --- +assignees: +- bprashanth +- davidopp + --- Many cloud providers (e.g. Google Compute Engine) define firewalls that help prevent inadvertent @@ -6,6 +10,50 @@ exposure to the internet. When exposing a service to the external world, you ma one or more ports in these firewalls to serve traffic. This document describes this process, as well as any provider specific details that may be necessary. +### Restrict Access For LoadBalancer Service + + When using a Service with `spec.type: LoadBalancer`, you can specify the IP ranges that are allowed to access the load balancer + by using `spec.loadBalancerSourceRanges`. This field takes a list of IP CIDR ranges, which Kubernetes will use to configure firewall exceptions. + This feature is currently supported on Google Compute Engine, Google Container Engine and AWS. This field will be ignored if the cloud provider does not support the feature. + + Assuming 10.0.0.0/8 is the internal subnet. In the following example, a load blancer will be created that is only accessible to cluster internal ips. + This will not allow clients from outside of your Kubernetes cluster to access the load blancer. + +```yaml +apiVersion: v1 +kind: Service +metadata: + name: myapp +spec: + ports: + - port: 8765 + targetPort: 9376 + selector: + app: example + type: LoadBalancer + loadBalancerSourceRanges: + - 10.0.0.0/8 +``` + + In the following example, a load blancer will be created that is only accessible to clients with IP addresses from 130.211.204.1 and 130.211.204.2. + +```yaml +apiVersion: v1 +kind: Service +metadata: + name: myapp +spec: + ports: + - port: 8765 + targetPort: 9376 + selector: + app: example + type: LoadBalancer + loadBalancerSourceRanges: + - 130.211.204.1/32 + - 130.211.204.2/32 +``` + ### Google Compute Engine When using a Service with `spec.type: LoadBalancer`, the firewall will be @@ -48,4 +96,4 @@ This will be fixed in an upcoming release of Kubernetes. ### Other cloud providers -Coming soon. \ No newline at end of file +Coming soon. diff --git a/docs/user-guide/services/OWNERS b/docs/user-guide/services/OWNERS new file mode 100644 index 0000000000..c8a8d4d7cc --- /dev/null +++ b/docs/user-guide/services/OWNERS @@ -0,0 +1,6 @@ +assignees: +- bprashanth +- janetkuo +- mikedanese +- thockin + diff --git a/docs/user-guide/services/index.md b/docs/user-guide/services/index.md index 334e53df8d..a79e77fff8 100644 --- a/docs/user-guide/services/index.md +++ b/docs/user-guide/services/index.md @@ -1,4 +1,7 @@ --- +assignees: +- bprashanth + --- Kubernetes [`Pods`](/docs/user-guide/pods) are mortal. They are born and they die, and they @@ -149,8 +152,8 @@ this example). Every node in a Kubernetes cluster runs a `kube-proxy`. This application is responsible for implementing a form of virtual IP for `Service`s. In Kubernetes v1.0 the proxy was purely in userspace. In Kubernetes v1.1 an -iptables proxy was added, but was not the default operating mode. In -Kubernetes v1.2 we expect the iptables proxy to be the default. +iptables proxy was added, but was not the default operating mode. Since +Kubernetes v1.2, the iptables proxy is the default. As of Kubernetes v1.0, `Services` are a "layer 3" (TCP/UDP over IP) construct. In Kubernetes v1.1 the `Ingress` API was added (beta) to represent "layer 7" @@ -193,7 +196,10 @@ default is `"None"`). As with the userspace proxy, the net result is that any traffic bound for the `Service`'s IP:Port is proxied to an appropriate backend without the clients knowing anything about Kubernetes or `Services` or `Pods`. This should be -faster and more reliable than the userspace proxy. +faster and more reliable than the userspace proxy. However, unlike the +userspace proxier, the iptables proxier cannot automatically retry another +`Pod` if the one it initially selects does not respond, so it depends on +having working [readiness probes](/docs/user-guide/production-pods/#liveness-and-readiness-probes-aka-health-checks). ![Services overview diagram for iptables proxy](/images/docs/services-iptables-overview.svg) @@ -317,18 +323,28 @@ Sometimes you don't need or want load-balancing and a single service IP. In this case, you can create "headless" services by specifying `"None"` for the cluster IP (`spec.clusterIP`). -For such `Services`, a cluster IP is not allocated. DNS is configured to return -multiple A records (addresses) for the `Service` name, which point directly to -the `Pods` backing the `Service`. Additionally, the kube proxy does not handle -these services and there is no load balancing or proxying done by the platform -for them. The endpoints controller will still create `Endpoints` records in -the API. - This option allows developers to reduce coupling to the Kubernetes system, if they desire, but leaves them freedom to do discovery in their own way. Applications can still use a self-registration pattern and adapters for other discovery systems could easily be built upon this API. +For such `Services` a cluster IP is not allocated, the kube proxy does not handle +these services, and there is no load balancing or proxying done by the platform +for them. How DNS is automatically configured depends on if the service has +selectors or not. + +### With selectors + +For headless services that define selectors, the endpoints controller creates +`Endpoints` records in the API, and modifies the DNS configuration to return A +records (addresses) which point directly to the `Pods` backing the `Service`. + +### Without selectors + +For headless services that do not define selectors, the endpoints controller does +not create `Endpoints` records. However, the DNS system looks for and configures +A records for any `Endpoints` that share a name with the service. + ## Publishing services - service types For some parts of your application (e.g. frontends) you may want to expose a @@ -423,6 +439,44 @@ with the user-specified `loadBalancerIP`. If the `loadBalancerIP` field is not s an ephemeral IP will be assigned to the loadBalancer. If the `loadBalancerIP` is specified, but the cloud provider does not support the feature, the field will be ignored. +#### SSL support on AWS +For partial SSL support on clusters running on AWS, starting with 1.3 two +annotations can be added to a `LoadBalancer` service: + +``` + "metadata": { + "name": "my-service", + "annotations": { + "service.beta.kubernetes.io/aws-load-balancer-ssl-cert": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" + } + }, +``` + +The first specifies which certificate to use. It can be either a +certificate from a third party issuer that was uploaded to IAM or one created +within AWS Certificate Manager. + +``` + "metadata": { + "name": "my-service", + "annotations": { + "service.beta.kubernetes.io/aws-load-balancer-backend-protocol=": "(https|http|ssl|tcp)" + } + }, +``` + +The second annotation specificies which protocol a pod speaks. For HTTPS and +SSL, the ELB will expect the pod to authenticate itself over the encrypted +connection. + +HTTP and HTTPS will select layer 7 proxying: the ELB will terminate +the connection with the user, parse headers and inject the `X-Forwarded-For` +header with the user's IP address (pods will only see the IP address of the +ELB at the other end of its connection) when forwarding requests. + +TCP and SSL will select layer 4 proxying: the ELB will forward traffic without +modifying the headers. + ### External IPs If there are external IPs that route to one or more cluster nodes, Kubernetes services can be exposed on those diff --git a/docs/user-guide/services/load-balancer-sample.json b/docs/user-guide/services/load-balancer-sample.json index 847f21dbb6..e12d1e5d24 100644 --- a/docs/user-guide/services/load-balancer-sample.json +++ b/docs/user-guide/services/load-balancer-sample.json @@ -12,6 +12,10 @@ "selector": { "app": "example" }, - "type": "LoadBalancer" + "type": "LoadBalancer", + "loadBalancerSourceRanges": [ + "10.180.0.0/16", + "10.245.0.0/24" + ] } } diff --git a/docs/user-guide/services/load-balancer-sample.yaml b/docs/user-guide/services/load-balancer-sample.yaml index b66c5ea231..28b1dd3014 100644 --- a/docs/user-guide/services/load-balancer-sample.yaml +++ b/docs/user-guide/services/load-balancer-sample.yaml @@ -4,9 +4,11 @@ metadata: name: myapp spec: ports: - - - port: 8765 + - port: 8765 targetPort: 9376 selector: app: example type: LoadBalancer + loadBalancerSourceRanges: + - 10.180.0.0/16 + - 10.245.0.0/24 diff --git a/docs/user-guide/services/operations.md b/docs/user-guide/services/operations.md index 64551d47a4..6fa6d61bdd 100644 --- a/docs/user-guide/services/operations.md +++ b/docs/user-guide/services/operations.md @@ -1,4 +1,8 @@ --- +assignees: +- bprashanth +- freehan + --- * TOC {:toc} @@ -51,7 +55,11 @@ YAML or as JSON, and supports the following fields: "selector": { string: string }, - "type": "LoadBalancer" + "type": "LoadBalancer", + "loadBalancerSourceRanges": [ + "10.180.0.0/16", + "10.245.0.0/24" + ] } } ``` @@ -71,6 +79,10 @@ Required fields are: * `type`: Optional. If the type is `LoadBalancer`, sets up a [network load balancer](/docs/user-guide/load-balancer/) for your service. This provides an externally-accessible IP address that sends traffic to the correct port on your cluster nodes. + * `loadBalancerSourceRanges:`: Optional. Must use with `LoadBalancer` type. + If specified and supported by the cloud provider, this will restrict traffic + such that the load balancer will be accessible only to clients from the specified IP ranges. + This field will be ignored if the cloud-provider does not support the feature. For the full `service` schema see the [Kubernetes api reference](/docs/api-reference/v1/definitions/#_v1_service). diff --git a/docs/user-guide/services/service-sample.yaml b/docs/user-guide/services/service-sample.yaml index b9c214226f..c819df7ac5 100644 --- a/docs/user-guide/services/service-sample.yaml +++ b/docs/user-guide/services/service-sample.yaml @@ -4,8 +4,7 @@ metadata: name: myapp spec: ports: - - - port: 8765 + - port: 8765 targetPort: 9376 selector: app: example diff --git a/docs/user-guide/sharing-clusters.md b/docs/user-guide/sharing-clusters.md index 9db2460ed2..34a53d670e 100644 --- a/docs/user-guide/sharing-clusters.md +++ b/docs/user-guide/sharing-clusters.md @@ -1,4 +1,8 @@ --- +assignees: +- mikedanese +- thockin + --- Client access to a running Kubernetes cluster can be shared by copying @@ -70,7 +74,10 @@ $ kubectl config set-credentials $USER_NICK \ --kubeconfig=/path/to/standalone/.kube/config # create context entry -$ kubectl config set-context $CONTEXT_NAME --cluster=$CLUSTER_NICKNAME --user=$USER_NICK +$ kubectl config set-context $CONTEXT_NAME \ + --cluster=$CLUSTER_NICK \ + --user=$USER_NICK \ + --kubeconfig=/path/to/standalone/.kube/config ``` Notes: @@ -116,4 +123,4 @@ $ scp host2:/path/to/home2/.kube/config /path/to/other/.kube/config $ export $KUBECONFIG=/path/to/other/.kube/config ``` -Detailed examples and explanation of `kubeconfig` loading/merging rules can be found in [kubeconfig-file](/docs/user-guide/kubeconfig-file). \ No newline at end of file +Detailed examples and explanation of `kubeconfig` loading/merging rules can be found in [kubeconfig-file](/docs/user-guide/kubeconfig-file). diff --git a/docs/user-guide/simple-nginx.md b/docs/user-guide/simple-nginx.md index d2e928d542..4a40d3df06 100644 --- a/docs/user-guide/simple-nginx.md +++ b/docs/user-guide/simple-nginx.md @@ -1,4 +1,7 @@ --- +assignees: +- mikedanese + --- Ok, you've run one of the [getting started guides](/docs/getting-started-guides/) and you have diff --git a/docs/user-guide/simple-yaml.md b/docs/user-guide/simple-yaml.md index c38f7f87ce..3f542657eb 100644 --- a/docs/user-guide/simple-yaml.md +++ b/docs/user-guide/simple-yaml.md @@ -1,3 +1,7 @@ --- +assignees: +- mikedanese +- thockin + --- ### This document has been subsumed by [deploying-applications.md](/docs/user-guide/deploying-applications/) diff --git a/docs/user-guide/ui-access.md b/docs/user-guide/ui-access.md deleted file mode 100644 index 04faeffd7a..0000000000 --- a/docs/user-guide/ui-access.md +++ /dev/null @@ -1,32 +0,0 @@ ---- ---- - -By default, the Kubernetes Dashboard is deployed as a cluster addon. For 1.2 clusters, it is enabled by default. - -If you want to manually install it, visit - -`https:///ui`, which redirects to -`https:///api/v1/proxy/namespaces/kube-system/services/kubernetes-dashboard`. - -If you find that you're not able to access the Dashboard, it may be because the -`kubernetes-dashboard` service has not been started on your cluster. In that case, -you can start it manually as follows: - -```shell -kubectl create -f cluster/addons/dashboard/dashboard-controller.yaml --namespace=kube-system -kubectl create -f cluster/addons/dashboard/dashboard-service.yaml --namespace=kube-system -``` - -Normally, this should be taken care of automatically by the -[`kube-addons.sh`](http://releases.k8s.io/{{page.githubbranch}}/cluster/saltbase/salt/kube-addons/kube-addons.sh) -script that runs on the master. Release notes and development versions of the Dashboard can be -found at https://github.com/kubernetes/dashboard/releases. - -## Walkthrough - -For information on how to use the Dashboard, take the [Dashboard tour](/docs/user-guide/ui/). - -## More Information - -For more information, see the -[Kubernetes Dashboard repository](https://github.com/kubernetes/dashboard). diff --git a/docs/user-guide/ui.md b/docs/user-guide/ui.md index f8a79057d2..0efdb3fd1f 100644 --- a/docs/user-guide/ui.md +++ b/docs/user-guide/ui.md @@ -1,49 +1,87 @@ --- +assignees: +- bryk +- mikedanese + --- -Kubernetes has a web-based user interface that allows you to deploy containerized -applications to a Kubernetes cluster, troubleshoot them, and manage the cluster itself. - -By default, the Kubernetes Dashboard is deployed as a cluster addon. It is enabled by default in Kubernetes 1.2 clusters. Click [here](/docs/user-guide/ui-access/) to learn more about the Dashboard access. +Dashboard (the web-based user interface of Kubernetes) allows you to deploy containerized applications to a Kubernetes cluster, troubleshoot them, and manage the cluster and its resources itself. You can use it for getting an overview of applications running on the cluster, as well as for creating or modifying individual Kubernetes resources and workloads, such as Daemon sets, Pet sets, Replica sets, Jobs, Replication controllers and corresponding Services, or Pods. -## Using the Dashboard +Dashboard also provides information on the state of Pods, Replication controllers, etc. and on any errors that might have occurred. You can inspect and manage the Kubernetes resources, as well as your deployed containerized applications. You can also change the number of replicated Pods, delete Pods, and deploy new applications using a deploy wizard. -The Dashboard can be used to get an overview of applications running on the cluster, and to provide information on any errors that have occurred. You can also inspect your replication controllers and corresponding services, change the number of replicated Pods, and deploy new applications using a deploy wizard. - -When accessing the Dashboard on an empty cluster for the first time, the Welcome page is displayed. This page contains a link to this document as well as a button to deploy your first application. In addition, you can view which system applications are running by default in the `kube-system` [namespace](/docs/admin/namespaces/) of your cluster, for example monitoring applications such as Heapster. +By default, Dashboard is installed as a cluster addon. It is enabled by default as of Kubernetes 1.2 clusters. + +* TOC +{:toc} + +## Dashboard access + +Navigate in your Browser to the following URL: +``` +https:///ui +``` +This redirects to the following URL: +``` +https:///api/v1/proxy/namespaces/kube-system/services/kubernetes-dashboard +``` +The Dashboard UI lives in the `kube-system` [namespace](/docs/admin/namespaces/), but shows all resources from all namespaces in your environment. + +If you find that you are not able to access Dashboard, you can install and open the latest stable release by running the following command: + +``` +kubectl create -f https://rawgit.com/kubernetes/dashboard/master/src/deploy/kubernetes-dashboard.yaml +``` + +Then, navigate to + +``` +https:///ui +``` + +In case you have to provide a password, use the following command to find it out: + +``` +kubectl config view +``` + +## Welcome page + +When accessing Dashboard on an empty cluster for the first time, the Welcome page is displayed. This page contains a link to this document as well as a button to deploy your first application. In addition, you can view which system applications are running by **default** in the `kube-system` [namespace](/docs/admin/namespaces/) of your cluster, for example monitoring applications such as Heapster. ![Kubernetes Dashboard welcome page](/images/docs/ui-dashboard-zerostate.png) -### Deploying applications +## Deploying containerized applications + +Dashboard lets you create and deploy a containerized application as a Replication Controller and corresponding Service with a simple wizard. You can either manually specify application details, or upload a YAML or JSON file containing the required information. + +To access the deploy wizard from the Welcome page, click the respective button. To access the wizard at a later point in time, click the **DEPLOY APP** or **UPLOAD YAML** link in the upper right corner of any page listing workloads. + +![Deploy wizard](/images/docs/ui-dashboard-deploy-simple.png) + +### Specifying application details + +The deploy wizard expects that you provide the following information: + +- **App name** (mandatory): Name for your application. A [label](/docs/user-guide/labels/) with the name will be added to the Replication Controller and Service, if any, that will be deployed. + + The application name must be unique within the selected Kubernetes [namespace](/docs/admin/namespaces/). It must start and end with a lowercase character, and contain only lowercase letters, numbers and dashes (-). It is limited to 24 characters. Leading and trailing spaces are ignored. + +- **Container image** (mandatory): The URL of a public Docker [container image](/docs/user-guide/images/) on any registry, or a private image (commonly hosted on the Google Container Registry or Docker Hub). The container image specification must end with a colon. -The Dashboard lets you create and deploy a containerized application as a Replication Controller with a simple wizard: - -![Kubernetes Dashboard deploy form](/images/docs/ui-dashboard-deploy-simple.png) - -#### Specifying application details - -The wizard expects that you provide the following information: - -- **App name** (mandatory): Name for your application. A [label](/docs/user-guide/labels/) with the name will be added to the Replication Controller and Service, if any, that will be deployed. - - The application name must be unique within the selected Kubernetes [namespace](/docs/admin/namespaces/). It must start with a lowercase character, and contain only lowercase letters, numbers and dashes (-). It is limited to 24 characters. - -- **Container image** (mandatory): The URL of a public Docker [container image](/docs/user-guide/images/) on any registry, or a private image (commonly hosted on the Google Container Registry or Docker Hub). - - **Number of pods** (mandatory): The target number of Pods you want your application to be deployed in. The value must be a positive integer. - + A [Replication Controller](/docs/user-guide/replication-controller/) will be created to maintain the desired number of Pods across your cluster. -- **Ports** (optional): If your container listens on a port, you can provide a port and target port. The wizard will create a corresponding Kubernetes [Service](http://kubernetes.io/v1.1/docs/user-guide/services.html) which will route to your deployed Pods. Supported protocols are TCP and UDP. In case you specify ports, the internal DNS name for this Service will be the value you specified as application name above. - - Be aware that if you specify ports, you need to provide both port and target port. - -- For some parts of your application (e.g. frontends), you can expose the Service onto an external, maybe public IP address by selecting the **Expose service externally** option. You may need to open up one or more ports to do so. Find more details [here](/docs/user-guide/services-firewalls/). +- **Service** (optional): For some parts of your application (e.g. frontends) you may want to expose a [Service](http://kubernetes.io/docs/user-guide/services/) onto an external, maybe public IP address outside of your cluster (external Service). For external Services, you may need to open up one or more ports to do so. Find more details [here](/docs/user-guide/services-firewalls/). + + Other Services that are only visible from inside the cluster are called internal Services. + + Irrespective of the Service type, if you choose to create a Service and your container listens on a port (incoming), you need to specify two ports. The Service will be created mapping the port (incoming) to the target port seen by the container. This Service will route to your deployed Pods. Supported protocols are TCP and UDP. The internal DNS name for this Service will be the value you specified as application name above. If needed, you can expand the **Advanced options** section where you can specify more settings: -![Kubernetes Dashboard deploy form advanced options](/images/docs/ui-dashboard-deploy-more.png) +![Deploy wizard advanced options](/images/docs/ui-dashboard-deploy-more.png) - **Description**: The text you enter here will be added as an [annotation](/docs/user-guide/annotations/) to the Replication Controller and displayed in the application's details. @@ -58,63 +96,111 @@ environment=pod track=stable ``` -- **Kubernetes namespace**: Kubernetes supports multiple virtual clusters backed by the same physical cluster. These virtual clusters are called [namespaces](/docs/admin/namespaces/). They let you partition resources into logically named groups. +- **Namespace**: Kubernetes supports multiple virtual clusters backed by the same physical cluster. These virtual clusters are called [namespaces](/docs/admin/namespaces/). They let you partition resources into logically named groups. - The Dashboard offers all available namespaces in a dropdown list and allows you to create a new namespace. The namespace name may contain alphanumeric characters and dashes (-). + Dashboard offers all available namespaces in a dropdown list, and allows you to create a new namespace. The namespace name may contain a maximum of 63 alphanumeric characters and dashes (-). -- **Image pull secrets**: In case the Docker container image is private, it may require [pull secret](/docs/user-guide/secrets/) credentials. + In case the creation of the namespace is successful, it is selected by default. If the creation fails, the first namespace is selected. - The Dashboard offers all available secrets in a dropdown list, and allows you to create a new secret. The secret name must follow the DNS domain name syntax, e.g. `new.image-pull.secret`. The content of a secret must be base24-encoded and specified in a [`.dockercfg`](/docs/user-guide/images/#specifying-imagepullsecrets-on-a-pod) file. +- **Image Pull Secret**: In case the specified Docker container image is private, it may require [pull secret](/docs/user-guide/secrets/) credentials. -- **CPU requirement** and **Memory requirement**: You can specify the minimum [resource limits](/docs/admin/limitrange/) for the container. By default, Pods run with unbounded CPU and memory limits. + Dashboard offers all available secrets in a dropdown list, and allows you to create a new secret. The secret name must follow the DNS domain name syntax, e.g. `new.image-pull.secret`. The content of a secret must be base64-encoded and specified in a [`.dockercfg`](/docs/user-guide/images/#specifying-imagepullsecrets-on-a-pod) file. The secret name may consist of a maximum of 253 characters. -- **Run command** and **Run command arguments**: By default, your containers run the selected Docker image's default [entrypoint command](/docs/user-guide/containers/#containers-and-commands). You can use the command options and arguments to override the default. + In case the creation of the image pull secret is successful, it is selected by default. If the creation fails, no secret is applied. + +- **CPU requirement (cores)** and **Memory requirement (MiB)**: You can specify the minimum [resource limits](/docs/admin/limitrange/) for the container. By default, Pods run with unbounded CPU and memory limits. + +- **Run command** and **Run command arguments**: By default, your containers run the specified Docker image's default [entrypoint command](/docs/user-guide/containers/#containers-and-commands). You can use the command options and arguments to override the default. - **Run as privileged**: This setting determines whether processes in [privileged containers](/docs/user-guide/pods/#privileged-mode-for-pod-containers) are equivalent to processes running as root on the host. Privileged containers can make use of capabilities like manipulating the network stack and accessing devices. -- **Environment variables**: Kubernetes exposes Services through [environment variables](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/design/expansion.md). You can compose environment variable or pass arguments to your commands using the values of environnment variables. They can be used in applications to find a Service. Environment variables are also useful for decreasing coupling and the use of workarounds. Values can reference other variables using the `$(VAR_NAME)` syntax. +- **Environment variables**: Kubernetes exposes Services through [environment variables](http://kubernetes.io/docs/user-guide/environment-guide/). You can compose environment variable or pass arguments to your commands using the values of environment variables. They can be used in applications to find a Service. Values can reference other variables using the `$(VAR_NAME)` syntax. -#### Uploading a YAML or JSON file +### Uploading a YAML or JSON file -Kubernetes supports declarative configuration. In this style, all configuration is stored in YAML or JSON configuration files using the Kubernetes' [API](http://kubernetes.io/v1.1/docs/api.html) resource schemas as the configuration schemas. +Kubernetes supports declarative configuration. In this style, all configuration is stored in YAML or JSON configuration files using the Kubernetes' [API](http://kubernetes.io/docs/api/) resource schemas as the configuration schemas. As an alternative to specifying application details in the deploy wizard, you can define your Replication Controllers and Services in YAML or JSON files, and upload the files to your Pods: -![Kubernetes Dashboard deploy from file upload](/images/docs/ui-dashboard-deploy-file.png) - -### Applications view +![Deploy wizard file upload](/images/docs/ui-dashboard-deploy-file.png) -As soon as applications are running on your cluster, the initial view of the Dashboard defaults to showing an overview of them, for example: - -![Kubernetes Dashboard applications view](/images/docs/ui-dashboard-rcs.png) - -Individual applications are shown as cards - where an application is defined as a Replication Controller and its corresponding Services. Each card shows the current number of running and desired replicas, along with errors reported by Kubernetes, if any. +## Managing resources -You can view application details (**View details**), make quick changes to the number of replicas (**Edit pod count**) or delete the application directly (**Delete**) from the menu in each card's corner: - -![Kubernetes Dashboard deploy form file upload](/images/docs/ui-dashboard-cards-menu.png) - -#### View details - -Selecting this option from the card menu will take you to the following page where you can view more information about the Pods that make up your application: - -![Kubernetes Dashboard application detail](/images/docs/ui-dashboard-rcs-detail.png) - -The **EVENTS** tab can be useful for debugging flapping applications. - -Clicking the plus sign in the right corner of the screen leads you back to the page for deploying a new application. +### List view -#### Edit pod count +As soon as applications are running on your cluster, Dashboard's initial view defaults to showing all resources available in all namespaces in a list view, for example: -If you choose to change the number of Pods, the respective Replication Controller will be updated to reflect the newly specified number. +![Workloads view](/images/docs/ui-dashboard-workloadview.png) -#### Delete +For every resource, the list view shows the following information: -Deleting a Replication Controller also deletes the Pods managed by it. It is currently not supported to leave the Pods running. +* Name of the resource +* All labels assigned to the resource +* Number of pods assigned to the resource +* Age, i.e. amount of time passed since the resource has been created +* Docker container image -You have the option to also delete Services related to the Replication Controller if the label selector targets only the Replication Controller to be deleted. +To filter the resources and only show those of a specific namespace, select it from the dropdown list in the right corner of the title bar: + +![Namespace selector](/images/docs/ui-dashboard-namespace.png) + +### Details view + +When clicking a resource, the details view is opened, for example: + +![Details view](/images/docs/ui-dashboard-detailsview.png) + +The **OVERVIEW** tab shows the actual resource details as well as the Pods the resource is running in. + +The **EVENTS** tab can be useful for debugging applications. + +To go back to the workloads overview, click the Kubernetes logo. + +### Workload categories + +Workloads are categorized as follows: + +* [Daemon Sets](http://kubernetes.io/docs/admin/daemons/) which ensure that all or some of the nodes in your cluster run a copy of a Pod. +* [Deployments](http://kubernetes.io/docs/user-guide/deployments/) which provide declarative updates for Pods and Replica Sets (the next-generation [Replication Controller](http://kubernetes.io/docs/user-guide/replication-controller/)) + The Details page for a Deployment lists resource details, as well as new and old Replica Sets. The resource details also include information on the [RollingUpdate](http://kubernetes.io/docs/user-guide/rolling-updates/) strategy, if any. +* [Pet Sets](http://kubernetes.io/docs/user-guide/load-balancer/) (nominal Services, also known as load-balanced Services) for legacy application support. +* [Replica Sets](http://kubernetes.io/docs/user-guide/replicasets/) for using label selectors. +* [Jobs](http://kubernetes.io/docs/user-guide/jobs/) for creating one or more Pods, ensuring that a specified number of them successfully terminate, and tracking the completions. +* [Replication Controllers](http://kubernetes.io/docs/user-guide/replication-controller/) +* [Pods](http://kubernetes.io/docs/user-guide/pods/) + +You can display the resources of a specific category in two ways: + +* Click the category name, e.g. **Deployments** +* Edit the Dashboard URL and add the name of a desired category. For example, to display the list of Replication Controllers, specify the following URL: + + ``` +http://:9090/#/replicationcontroller +``` + +### Actions + +Every list view offers an action menu to the right of the listed resources. The related details view provides the same actions as buttons in the upper right corner of the page. + +* **Edit** + + Opens a text editor so that you can instantly view or update the JSON or YAML file of the respective resource. + +* **Delete** + + After confirmation, deletes the respective resource. + + When deleting a Replication Controller, the Pods managed by it are also deleted. You have the option to also delete Services related to the Replication Controller. + +* **View details** + + For Replication Controllers only. Takes you to the details page where you can view more information about the Pods that make up your application. + +* **Scale** + + For Replication Controllers only. Changes the number of Pods your application runs in. The respective Replication Controller will be updated to reflect the newly specified number. Be aware that setting a high number of Pods may result in a decrease of performance of the cluster or Dashboard itself. + +## More information -## More Information - For more information, see the [Kubernetes Dashboard repository](https://github.com/kubernetes/dashboard). diff --git a/docs/user-guide/update-demo/OWNERS b/docs/user-guide/update-demo/OWNERS new file mode 100644 index 0000000000..93fff65a0e --- /dev/null +++ b/docs/user-guide/update-demo/OWNERS @@ -0,0 +1,4 @@ +assignees: +- janetkuo +- mikedanese + diff --git a/docs/user-guide/update-demo/index.md b/docs/user-guide/update-demo/index.md index 215a13a47a..63262e69d2 100644 --- a/docs/user-guide/update-demo/index.md +++ b/docs/user-guide/update-demo/index.md @@ -1,11 +1,15 @@ ---- ---- - - +--- +assignees: +- lavalamp +- mikedanese + +--- + + This example demonstrates the usage of Kubernetes to perform a [rolling update](/docs/user-guide/kubectl/kubectl_rolling-update/) on a running group of [pods](/docs/user-guide/pods/). See [here](/docs/user-guide/managing-deployments/#updating-your-application-without-a-service-outage) to understand why you need a rolling update. Also check [rolling update design document](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/design/simple-rolling-update.md) for more information. - -The files for this example are viewable in [our docs repo -here](https://github.com/kubernetes/kubernetes.github.io/tree/{{page.docsbranch}}/docs/user-guide/update-demo). + +The files for this example are viewable in [our docs repo +here](https://github.com/kubernetes/kubernetes.github.io/tree/{{page.docsbranch}}/docs/user-guide/update-demo). ### Step Zero: Prerequisites diff --git a/docs/user-guide/volumes.md b/docs/user-guide/volumes.md index 433deae10f..d118e4e950 100644 --- a/docs/user-guide/volumes.md +++ b/docs/user-guide/volumes.md @@ -1,4 +1,10 @@ --- +assignees: +- jsafrane +- mikedanese +- saad-ali +- thockin + --- On-disk files in a container are ephemeral, which presents some problems for @@ -64,12 +70,13 @@ Kubernetes supports several types of Volumes: * `flocker` * `glusterfs` * `rbd` + * `cephfs` * `gitRepo` * `secret` * `persistentVolumeClaim` * `downwardAPI` * `azureFileVolume` - * `vsphereVirtualDisk` + * `vsphereVolume` We welcome additional contributions. @@ -117,6 +124,50 @@ Watch out when using this type of volume, because: behave differently on different nodes due to different files on the nodes * when Kubernetes adds resource-aware scheduling, as is planned, it will not be able to account for resources used by a `hostPath` +* the directories created on the underlying hosts are only writable by root, you either need + to run your process as root in a priveleged container or modify the file permissions on + the host to be able to write to a `hostPath` volume + +#### Example pod + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: test-pd +spec: + containers: + - image: gcr.io/google_containers/test-webserver + name: test-container + volumeMounts: + - mountPath: /test-pd + name: test-volume + volumes: + - name: test-volume + hostPath: + # directory location on host + path: /data +``` + +#### Example pod + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: test-hostpath +spec: + containers: + - image: myimage + name: test-container + volumeMounts: + - mountPath: /test-hostpath + name: test-volume + volumes: + - name: test-volume + hostPath: + path: /path/to/my/dir +``` ### gcePersistentDisk @@ -236,7 +287,7 @@ writers simultaneously. __Important: You must have your own NFS server running with the share exported before you can use it__ -See the [NFS example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/nfs/) for more details. +See the [NFS example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/volumes/nfs) for more details. ### iscsi @@ -255,7 +306,7 @@ and then serve it in parallel from as many pods as you need. Unfortunately, iSCSI volumes can only be mounted by a single consumer in read-write mode - no simultaneous writers allowed. -See the [iSCSI example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/iscsi/) for more details. +See the [iSCSI example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/volumes/iscsi) for more details. ### flocker @@ -270,7 +321,7 @@ can be "handed off" between pods as required. __Important: You must have your own Flocker installation running before you can use it__ -See the [Flocker example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/flocker/) for more details. +See the [Flocker example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/volumes/flocker) for more details. ### glusterfs @@ -285,7 +336,7 @@ simultaneously. __Important: You must have your own GlusterFS installation running before you can use it__ -See the [GlusterFS example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/glusterfs/) for more details. +See the [GlusterFS example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/volumes/glusterfs) for more details. ### rbd @@ -305,7 +356,21 @@ and then serve it in parallel from as many pods as you need. Unfortunately, RBD volumes can only be mounted by a single consumer in read-write mode - no simultaneous writers allowed. -See the [RBD example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/rbd/) for more details. +See the [RBD example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/volumes/rbd) for more details. + +### cephfs + +A `cephfs` volume allows an existing CephFS volume to be +mounted into your pod. Unlike `emptyDir`, which is erased when a Pod is +removed, the contents of a `cephfs` volume are preserved and the volume is merely +unmounted. This means that a CephFS volume can be pre-populated with data, and +that data can be "handed off" between pods. CephFS can be mounted by multiple +writers simultaneously. + +__Important: You must have your own Ceph server running with the share exported +before you can use it__ + +See the [CephFS example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/cephfs/) for more details. ### gitRepo @@ -371,18 +436,18 @@ A `FlexVolume` enables users to mount vendor volumes into a pod. It expects vend drivers are installed in the volume plugin path on each kubelet node. This is an alpha feature and may change in future. -More details are in [here](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/flexvolume/README.md) +More details are in [here](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/volumes/flexvolume/README.md) ### AzureFileVolume A `AzureFileVolume` is used to mount a Microsoft Azure File Volume (SMB 2.1 and 3.0) into a Pod. -More details can be found [here](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/azure_file/README.md) +More details can be found [here](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/volumes/azure_file/README.md) -### vsphereVirtualDisk +### vsphereVolume -A `VSphereVirtualDisk` is used to mount a vSphere VMDK Volume into your Pod. The contents +A `vsphereVolume` is used to mount a vSphere VMDK Volume into your Pod. The contents of a volume are preserved when it is unmounted. __Important: You must create a VMDK volume using `vmware-vdiskmanager -c` or @@ -413,7 +478,7 @@ spec: volumes: - name: test-volume # This VMDK volume must already exist. - vsphereVirtualDisk: + vsphereVolume: volumePath: myDisk fsType: ext4 ``` @@ -429,4 +494,4 @@ pods. In the future, we expect that `emptyDir` and `hostPath` volumes will be able to request a certain amount of space using a [resource](/docs/user-guide/compute-resources) specification, and to select the type of media to use, for clusters that have -several media types. \ No newline at end of file +several media types. diff --git a/docs/user-guide/walkthrough/OWNERS b/docs/user-guide/walkthrough/OWNERS new file mode 100644 index 0000000000..7cb12a369c --- /dev/null +++ b/docs/user-guide/walkthrough/OWNERS @@ -0,0 +1,5 @@ +assignees: +- eparis +- janetkuo +- mikedanese + diff --git a/docs/user-guide/walkthrough/index.md b/docs/user-guide/walkthrough/index.md index 69f395b433..4cc23cb71e 100644 --- a/docs/user-guide/walkthrough/index.md +++ b/docs/user-guide/walkthrough/index.md @@ -1,4 +1,8 @@ --- +assignees: +- eparis +- mikedanese + --- ## Kubectl CLI and Pods @@ -56,7 +60,7 @@ On most providers, the pod IPs are not externally accessible. The easiest way to Provided the pod IP is accessible, you should be able to access its http endpoint with wget on port 80: ```shell{% raw %} -$ kubectl run busybox --image=busybox --restart=Never --tty -i --generator=run-pod/v1 --env "POD_IP=$(kubectl get pod nginx -o go-template={{.status.podIP}})" +$ kubectl run busybox --image=busybox --restart=Never --tty -i --generator=run-pod/v1 --env "POD_IP=$(kubectl get pod nginx -o go-template='{{.status.podIP}}')" u@busybox$ wget -qO- http://$POD_IP # Run in the busybox container u@busybox$ exit # Exit the busybox container $ kubectl delete pod busybox # Clean up the pod we created with "kubectl run" diff --git a/docs/user-guide/walkthrough/k8s201.md b/docs/user-guide/walkthrough/k8s201.md index 04cb3c5c37..2f1f62ad1f 100644 --- a/docs/user-guide/walkthrough/k8s201.md +++ b/docs/user-guide/walkthrough/k8s201.md @@ -1,4 +1,8 @@ --- +assignees: +- janetkuo +- mikedanese + --- ## Labels, Deployments, Services and Health Checking @@ -48,7 +52,7 @@ They are a core concept used by two additional Kubernetes building blocks: Deplo Now that you know how to make awesome, multi-container, labeled Pods and you want to use them to build an application, you might be tempted to just start building a whole bunch of individual Pods, but if you do that, a whole host of operational concerns pop up. For example: how will you scale the number of Pods up or down? How will you roll out a new release? -The answer to those questions and more is to use a [_Deployment_](/docs/user-guide/deployment/) to manage maintaining and updating your running _Pods_. +The answer to those questions and more is to use a [_Deployment_](/docs/user-guide/deployments/#what-is-a-deployment) to manage maintaining and updating your running _Pods_. A Deployment object defines a Pod creation template (a "cookie-cutter" if you will) and desired replica count. The Deployment uses a label selector to identify the Pods it manages, and will create or delete Pods as needed to meet the replica count. Deployments are also used to manage safely rolling out changes to your running Pods. @@ -102,7 +106,7 @@ Delete the Deployment by name: kubectl delete deployment nginx-deployment ``` -For more information, such as how to rollback Deployment changes to a previous version, see [_Deployments_](/docs/user-guide/deployment/). +For more information, such as how to rollback Deployment changes to a previous version, see [_Deployments_](/docs/user-guide/deployments/). ## Services diff --git a/docs/user-guide/working-with-resources.md b/docs/user-guide/working-with-resources.md index 7dc3025daf..5b300ee6bd 100644 --- a/docs/user-guide/working-with-resources.md +++ b/docs/user-guide/working-with-resources.md @@ -1,4 +1,8 @@ --- +assignees: +- mikedanese +- thockin + --- *This document is aimed at users who have worked through some of the examples, @@ -28,7 +32,7 @@ spec: EOF $ kubectl create -f /tmp/original.yaml pods/original -$ kubectl get pods/original -o yaml > /tmp/current.yaml +$ kubectl get pods/foo -o yaml > /tmp/current.yaml pods/original $ wc -l /tmp/original.yaml /tmp/current.yaml 51 /tmp/current.yaml diff --git a/docs/whatisk8s.md b/docs/whatisk8s.md index a740ab944a..ca398edf58 100644 --- a/docs/whatisk8s.md +++ b/docs/whatisk8s.md @@ -1,4 +1,8 @@ --- +assignees: +- bgrant0607 +- mikedanese + --- diff --git a/images/blog-logging/diagrams/27gf-counter.png b/images/blog-logging/diagrams/27gf-counter.png new file mode 100644 index 0000000000..7962ec044c Binary files /dev/null and b/images/blog-logging/diagrams/27gf-counter.png differ diff --git a/images/blog-logging/diagrams/cloud-logging.png b/images/blog-logging/diagrams/cloud-logging.png new file mode 100644 index 0000000000..9b16af14ee Binary files /dev/null and b/images/blog-logging/diagrams/cloud-logging.png differ diff --git a/images/community_logos/ibm_logo.png b/images/community_logos/ibm_logo.png new file mode 100644 index 0000000000..79ccf45253 Binary files /dev/null and b/images/community_logos/ibm_logo.png differ diff --git a/images/docs/admin/access-control-overview.svg b/images/docs/admin/access-control-overview.svg new file mode 100644 index 0000000000..684fd24f44 --- /dev/null +++ b/images/docs/admin/access-control-overview.svg @@ -0,0 +1,4 @@ + + + + diff --git a/images/docs/kubectl_drain.svg b/images/docs/kubectl_drain.svg new file mode 100644 index 0000000000..89c4b6682d --- /dev/null +++ b/images/docs/kubectl_drain.svg @@ -0,0 +1,2 @@ + +
    $ kubectl drain NODE [flags]
    [Not supported by viewer]
    APIServer
    [Not supported by viewer]
    Kubelet
    [Not supported by viewer]
    cordon NODE
    cordon NODE<br>
    RunCordonOrUncordon
    <b>RunCordonOrUncordon</b>
    get all pods of NODE
    get all pods of NODE<br>
    GetPodsForDeletion
    <b>GetPodsForDeletion</b>
    delete first pod
    delete first pod<br>
    deletePods
    <b>deletePods</b>
    make one call to
    API per pod
    make one call to <br>API per pod <br>
    delete first pod
    delete first pod<br>
    podList
    podList
    Kubernetes Cluster
    Kubernetes Cluster<br>
    filter mirror pods and 
     DaemonSet-managed 
    pods 
    [Not supported by viewer]
    .
    .
    .
    [Not supported by viewer]
    .
    .
    .
    [Not supported by viewer]
    delete pod N
    delete pod N<br>
    delete pod N
    delete pod N<br>
    Mark node as
    Unschedulable
    Mark node as <br>Unschedulable<br>     \ No newline at end of file diff --git a/images/docs/kubectl_rollingupdate.svg b/images/docs/kubectl_rollingupdate.svg new file mode 100644 index 0000000000..73c85d0ba7 --- /dev/null +++ b/images/docs/kubectl_rollingupdate.svg @@ -0,0 +1,2 @@ + +
    $ kubectl rolling-update foo [foo-new flags]
    [Not supported by viewer]
    Not found
    Not found<br>
    get old replication controller for foo
    [Not supported by viewer]
    foo-new  or
    --image option is specified
    [Not supported by viewer]
    Rename
    <b>Rename</b>
    list all RCs to find RC foo(check case when we're in the middle of a rename)
    [Not supported by viewer]
    Not Found
    Not Found
    EXIT
    [Not supported by viewer]
    --image
    option is
     specified
    [Not supported by viewer]
    Create  new RC based on current one and update oldRc  with pointers to the 'next' controller
    [Not supported by viewer]
    --dryrun
    option is
     specified
    [Not supported by viewer]
    Print oldRC and newRC
    Print oldRC and newRC<br>
    --rollback
    option is
     specified
    [Not supported by viewer]
    Swap the controllers and update  annotations
    [Not supported by viewer]
    True
    True
    True
    True
    True
    True
    True
    True
    True
    True
    return error
    return error<br>
    True
    True
    return error
    return error<br>
    Print error and EXIT
    <b>Print error and EXIT</b>
    return error
    return error<br>     \ No newline at end of file diff --git a/images/docs/pod-overview.svg b/images/docs/pod-overview.svg new file mode 100644 index 0000000000..3243c73d55 --- /dev/null +++ b/images/docs/pod-overview.svg @@ -0,0 +1,4 @@ + + + + diff --git a/images/docs/ui-dashboard-cards-menu.png b/images/docs/ui-dashboard-cards-menu.png deleted file mode 100755 index eedabf87c4..0000000000 Binary files a/images/docs/ui-dashboard-cards-menu.png and /dev/null differ diff --git a/images/docs/ui-dashboard-deploy-file.png b/images/docs/ui-dashboard-deploy-file.png old mode 100755 new mode 100644 index 459d7772b0..8f4ab5ae37 Binary files a/images/docs/ui-dashboard-deploy-file.png and b/images/docs/ui-dashboard-deploy-file.png differ diff --git a/images/docs/ui-dashboard-deploy-more.png b/images/docs/ui-dashboard-deploy-more.png old mode 100755 new mode 100644 index 9285682b6e..22cf7de320 Binary files a/images/docs/ui-dashboard-deploy-more.png and b/images/docs/ui-dashboard-deploy-more.png differ diff --git a/images/docs/ui-dashboard-deploy-simple.png b/images/docs/ui-dashboard-deploy-simple.png old mode 100755 new mode 100644 index f0df6f93af..c85356765b Binary files a/images/docs/ui-dashboard-deploy-simple.png and b/images/docs/ui-dashboard-deploy-simple.png differ diff --git a/images/docs/ui-dashboard-detailsview.png b/images/docs/ui-dashboard-detailsview.png new file mode 100644 index 0000000000..9182c1eeb7 Binary files /dev/null and b/images/docs/ui-dashboard-detailsview.png differ diff --git a/images/docs/ui-dashboard-namespace.png b/images/docs/ui-dashboard-namespace.png new file mode 100644 index 0000000000..4271c92b73 Binary files /dev/null and b/images/docs/ui-dashboard-namespace.png differ diff --git a/images/docs/ui-dashboard-rcs-detail.png b/images/docs/ui-dashboard-rcs-detail.png deleted file mode 100755 index 80974213e8..0000000000 Binary files a/images/docs/ui-dashboard-rcs-detail.png and /dev/null differ diff --git a/images/docs/ui-dashboard-rcs.png b/images/docs/ui-dashboard-rcs.png deleted file mode 100755 index 5825cfbb47..0000000000 Binary files a/images/docs/ui-dashboard-rcs.png and /dev/null differ diff --git a/images/docs/ui-dashboard-workloadview.png b/images/docs/ui-dashboard-workloadview.png new file mode 100644 index 0000000000..1099da765f Binary files /dev/null and b/images/docs/ui-dashboard-workloadview.png differ diff --git a/images/overview_uml.svg b/images/overview_uml.svg new file mode 100644 index 0000000000..4db4b553db --- /dev/null +++ b/images/overview_uml.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/index.html b/index.html index e494580285..101e351654 100644 --- a/index.html +++ b/index.html @@ -1,5 +1,5 @@ --- -title: Accelerate Your Delivery +title: Production-Grade Container Orchestration --- @@ -11,8 +11,8 @@ title: Accelerate Your Delivery
    -

    Accelerate Your Delivery

    -
    Manage an infrastructure cluster as a single system to simplify container operations.
    +

    Production-Grade Container Orchestration

    +
    Automated container deployment, scaling, and management
    Try Our Hello World
    @@ -30,9 +30,9 @@ title: Accelerate Your Delivery
    -

    Kubernetes is an open-source system for automating deployment, operations, and scaling of containerized applications.

    +

    Kubernetes is an open-source system for automating deployment, scaling, and management of containerized applications.

    It groups containers that make up an application into logical units for easy management and discovery. Kubernetes builds - upon a decade and a half of experience of running production workloads at Google, + upon 15 years of experience of running production workloads at Google, combined with best-of-breed ideas and practices from the community.

    @@ -75,12 +75,12 @@ title: Accelerate Your Delivery
    -

    Automatic binpacking

    +

    Automatic binpacking

    Automatically places containers based on their resource requirements and other constraints, while not sacrificing availability. Mix critical and best-effort workloads in order to drive up utilization and save even more resources.

    -

    Self-healing

    +

    Self-healing

    Restarts containers that fail, replaces and reschedules containers when nodes die, kills containers that don’t respond to your user-defined health check, and doesn’t advertise them to clients until they are ready to serve.

    @@ -88,11 +88,11 @@ title: Accelerate Your Delivery
    -

    Horizontal scaling

    +

    Horizontal scaling

    Scale your application up and down with a simple command, with a UI, or automatically based on CPU usage.

    -

    Service discovery and load balancing

    +

    Service discovery and load balancing

    No need to modify your application to use an unfamiliar service discovery mechanism. Kubernetes gives containers their own IP addresses and a single DNS name for a set of containers, and can load-balance across them.

    @@ -100,13 +100,13 @@ title: Accelerate Your Delivery
    -

    Automated rollouts and rollbacks

    +

    Automated rollouts and rollbacks

    Kubernetes progressively rolls out changes to your application or its configuration, while monitoring application health to ensure it doesn’t kill all your instances at the same time. If something goes wrong, Kubernetes will rollback the change for you. Take advantage of a growing ecosystem of deployment solutions.

    -

    Secret and configuration management

    +

    Secret and configuration management

    Deploy and update secrets and application configuration without rebuilding your image and without exposing secrets in your stack configuration.

    @@ -114,13 +114,13 @@ title: Accelerate Your Delivery
    -

    Storage orchestration

    +

    Storage orchestration

    Automatically mount the storage system of your choice, whether from local storage, a public cloud provider such as GCP or AWS, or a network storage system such as NFS, iSCSI, Gluster, Ceph, Cinder, or Flocker.

    -

    Batch execution

    +

    Batch execution

    In addition to services, Kubernetes can manage your batch and CI workloads, replacing containers that fail, if desired.

    diff --git a/labels.yaml b/labels.yaml new file mode 100644 index 0000000000..6f203a3740 --- /dev/null +++ b/labels.yaml @@ -0,0 +1,277 @@ +labels: + - name: 0 - Backlog + color: CCCCCC + - name: 0 - Triage + color: AAAAAA + - name: 1 - Ready + color: CCCCCC + - name: 2 - Working <= 5 + color: CCCCCC + - name: 3 - Review + color: CCCCCC + - name: 4 - Done + color: CCCCCC + - name: approved + color: 0ffa16 + - name: area/HA + color: bfd4f2 + - name: area/admin + color: "009800" + - name: area/api + color: e1ed21 + - name: area/app-config-deployment + color: fb6420 + - name: area/auth + color: 00cc00 + - name: area/autoscaling + color: "5319e7" + - name: area/batch + color: c7def8 + - name: area/build-release + color: bfe5bf + - name: area/cadvisor + color: fef2c0 + - name: area/cloudprovider + color: f1fd21 + - name: area/cluster-federation + color: fad8c7 + - name: area/cluster-lifecycle + color: d4c5f9 + - name: area/devexp + color: "5319e7" + - name: area/downward-api + color: 8fffcf + - name: area/example/cassandra + color: d4c5f9 + - name: area/extensibility + color: ffaa04 + - name: area/images-registry + color: eba420 + - name: area/introspection + color: bfe5bf + - name: area/isolation + color: aba420 + - name: area/kubelet-api + color: fbca04 + - name: area/logging + color: fef2c0 + - name: area/monitoring + color: fef2c0 + - name: area/networking + color: 006b75 + - name: area/os/coreos + color: d4c5f9 + - name: area/os/fedora + color: d4c5f9 + - name: area/os/gci + color: e99695 + - name: area/os/ubuntu + color: d4c5f9 + - name: area/performance + color: d4c5f9 + - name: area/platform/aws + color: d4c5f9 + - name: area/platform/azure + color: d4c5f9 + - name: area/platform/gce + color: d4c5f9 + - name: area/platform/gke + color: d4c5f9 + - name: area/platform/mesos + color: d4c5f9 + - name: area/platform/openstack + color: d4c5f9 + - name: area/platform/vagrant + color: d4c5f9 + - name: area/platform/vsphere + color: d4c5f9 + - name: area/reliability + color: a10d01 + - name: area/scheduling + color: ab6420 + - name: area/security + color: d4c5f9 + - name: area/stateful-apps + color: ff6060 + - name: area/storage + color: 006b75 + - name: area/swagger + color: d4c5f9 + - name: area/system-requirement + color: bfdadc + - name: area/test + color: fad8c7 + - name: area/upgrade + color: bfd4f2 + - name: area/upward-api + color: a0c280 + - name: area/usability + color: bfe5bf + - name: area/volumes + color: bfe5bf + - name: cherrypick-approved + color: fef2c0 + - name: cherrypick-candidate + color: fef2c0 + - name: 'cla: human-approved' + color: bfe5bf + - name: 'cla: no' + color: e11d21 + - name: 'cla: yes' + color: bfe5bf + - name: component/apiserver + color: 0052cc + - name: component/clientlib + color: 0052cc + - name: component/controller-manager + color: 0052cc + - name: component/daemonset + color: 0052cc + - name: component/deployment + color: 0052cc + - name: component/dns + color: 1d76db + - name: component/kube-proxy + color: 0052cc + - name: component/kubectl + color: 0052cc + - name: component/kubelet + color: 0052cc + - name: component/node-e2e + color: 0052cc + - name: component/nodecontroller + color: 0052cc + - name: component/ui + color: 0052cc + - name: dependency/docker + color: fbfa04 + - name: dependency/etcd + color: fbfa04 + - name: dependency/rkt + color: fbfa04 + - name: do-not-merge + color: e11d21 + - name: documentation/better-examples + color: f9d0c4 + - name: documentation/confusing + color: f9d0c4 + - name: documentation/content-gap + color: f9d0c4 + - name: documentation/out-of-date + color: f9d0c4 + - name: help-wanted + color: 006b75 + - name: keep-open + color: fbca04 + - name: kind/api-change + color: c7def8 + - name: kind/bug + color: e11d21 + - name: kind/cleanup + color: c7def8 + - name: kind/design + color: c7def8 + - name: kind/documentation + color: c7def8 + - name: kind/ecosystem-enablement + color: c7def8 + - name: kind/enhancement + color: c7def8 + - name: kind/example + color: c7def8 + - name: kind/feature + color: c7def8 + - name: kind/flake + color: f7c6c7 + - name: kind/friction + color: c7def8 + - name: kind/mesos-flake + color: f7c6c7 + - name: kind/new-api + color: c7def8 + - name: kind/postmortem + color: bfe5bf + - name: kind/support + color: eb6420 + - name: kind/technical-debt + color: c7def8 + - name: kind/velocity-improvement + color: c7def8 + - name: kind/workaround-removal + color: c7def8 + - name: lgtm + color: 15dd18 + - name: needs-ok-to-merge + color: ededed + - name: needs-rebase + color: BDBDBD + - name: ok-to-merge + color: fbca04 + - name: priority/P0 + color: e11d21 + - name: priority/P1 + color: eb6420 + - name: priority/P2 + color: fbca04 + - name: priority/P3 + color: fef2c0 + - name: release-note + color: c2e0c6 + - name: release-note-action-required + color: c2e0c6 + - name: release-note-experimental + color: c2e0c6 + - name: release-note-label-needed + color: db5a64 + - name: release-note-none + color: c2e0c6 + - name: retest-not-required + color: eb6420 + - name: retest-not-required-docs-only + color: fbca04 + - name: size/L + color: ee9900 + - name: size/M + color: eebb00 + - name: size/S + color: 77bb00 + - name: size/XL + color: ee5500 + - name: size/XS + color: "009900" + - name: size/XXL + color: ee0000 + - name: stale + color: "795548" + - name: team/CSI-API Machinery SIG + color: d2b48c + - name: team/api + color: d2b48c + - name: team/cluster + color: d2b48c + - name: team/control-plane + color: d2b48c + - name: team/gke + color: d2b48c + - name: team/huawei + color: d2b48c + - name: team/mesosphere + color: d2b48c + - name: team/node + color: d2b48c + - name: team/none + color: d2b48c + - name: team/redhat + color: d2b48c + - name: team/release-infra + color: d2b48c + - name: team/rktnetes + color: d2b48c + - name: team/sig-aws + color: d2b48c + - name: team/test-infra + color: d2b48c + - name: team/ux + color: d2b48c + - name: team/workloads + color: d2b48c diff --git a/test/examples.go b/test/examples.go new file mode 100644 index 0000000000..9a2cc2ecdc --- /dev/null +++ b/test/examples.go @@ -0,0 +1,17 @@ +/* +Copyright 2016 The Kubernetes Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package examples diff --git a/test/examples_test.go b/test/examples_test.go new file mode 100644 index 0000000000..a2485ac0c2 --- /dev/null +++ b/test/examples_test.go @@ -0,0 +1,411 @@ +/* +Copyright 2016 The Kubernetes Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package examples_test + +import ( + "fmt" + "io/ioutil" + "os" + "path/filepath" + "regexp" + "strings" + "testing" + + "k8s.io/kubernetes/pkg/api" + "k8s.io/kubernetes/pkg/api/testapi" + "k8s.io/kubernetes/pkg/api/validation" + "k8s.io/kubernetes/pkg/apis/batch" + "k8s.io/kubernetes/pkg/apis/extensions" + expvalidation "k8s.io/kubernetes/pkg/apis/extensions/validation" + "k8s.io/kubernetes/pkg/capabilities" + "k8s.io/kubernetes/pkg/registry/job" + "k8s.io/kubernetes/pkg/runtime" + "k8s.io/kubernetes/pkg/types" + "k8s.io/kubernetes/pkg/util/validation/field" + "k8s.io/kubernetes/pkg/util/yaml" + schedulerapilatest "k8s.io/kubernetes/plugin/pkg/scheduler/api/latest" +) + +func validateObject(obj runtime.Object) (errors field.ErrorList) { + switch t := obj.(type) { + case *api.ReplicationController: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = validation.ValidateReplicationController(t) + case *api.ReplicationControllerList: + for i := range t.Items { + errors = append(errors, validateObject(&t.Items[i])...) + } + case *api.Service: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = validation.ValidateService(t) + case *api.ServiceList: + for i := range t.Items { + errors = append(errors, validateObject(&t.Items[i])...) + } + case *api.Pod: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = validation.ValidatePod(t) + case *api.PodList: + for i := range t.Items { + errors = append(errors, validateObject(&t.Items[i])...) + } + case *api.PersistentVolume: + errors = validation.ValidatePersistentVolume(t) + case *api.PersistentVolumeClaim: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = validation.ValidatePersistentVolumeClaim(t) + case *api.PodTemplate: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = validation.ValidatePodTemplate(t) + case *api.Endpoints: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = validation.ValidateEndpoints(t) + case *api.Namespace: + errors = validation.ValidateNamespace(t) + case *api.Secret: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = validation.ValidateSecret(t) + case *api.LimitRange: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = validation.ValidateLimitRange(t) + case *api.ResourceQuota: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = validation.ValidateResourceQuota(t) + case *extensions.Deployment: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = expvalidation.ValidateDeployment(t) + case *batch.Job: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + // Job needs generateSelector called before validation, and job.Validate does this. + // See: https://github.com/kubernetes/kubernetes/issues/20951#issuecomment-187787040 + t.ObjectMeta.UID = types.UID("fakeuid") + errors = job.Strategy.Validate(nil, t) + case *extensions.Ingress: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = expvalidation.ValidateIngress(t) + case *extensions.DaemonSet: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = expvalidation.ValidateDaemonSet(t) + default: + errors = field.ErrorList{} + errors = append(errors, field.InternalError(field.NewPath(""), fmt.Errorf("no validation defined for %#v", obj))) + } + return errors +} + +// Walks inDir for any json/yaml files. Converts yaml to json, and calls fn for +// each file found with the contents in data. +func walkConfigFiles(inDir string, fn func(name, path string, data []byte)) error { + return filepath.Walk(inDir, func(path string, info os.FileInfo, err error) error { + if err != nil { + return err + } + + if info.IsDir() && path != inDir { + return filepath.SkipDir + } + + file := filepath.Base(path) + if ext := filepath.Ext(file); ext == ".json" || ext == ".yaml" { + //glog.Infof("Testing %s", path) + data, err := ioutil.ReadFile(path) + if err != nil { + return err + } + name := strings.TrimSuffix(file, ext) + + if ext == ".yaml" { + out, err := yaml.ToJSON(data) + if err != nil { + return fmt.Errorf("%s: %v", path, err) + } + data = out + } + + fn(name, path, data) + } + return nil + }) +} + +func TestExampleObjectSchemas(t *testing.T) { + cases := map[string]map[string]runtime.Object{ + "../docs/user-guide/walkthrough": { + "deployment": &extensions.Deployment{}, + "deployment-update": &extensions.Deployment{}, + "pod-nginx": &api.Pod{}, + "pod-nginx-with-label": &api.Pod{}, + "pod-redis": &api.Pod{}, + "pod-with-http-healthcheck": &api.Pod{}, + "podtemplate": &api.PodTemplate{}, + "service": &api.Service{}, + }, + "../docs/user-guide/update-demo": { + "kitten-rc": &api.ReplicationController{}, + "nautilus-rc": &api.ReplicationController{}, + }, + "../docs/user-guide/persistent-volumes/volumes": { + "local-01": &api.PersistentVolume{}, + "local-02": &api.PersistentVolume{}, + "gce": &api.PersistentVolume{}, + "nfs": &api.PersistentVolume{}, + }, + "../docs/user-guide/persistent-volumes/claims": { + "claim-01": &api.PersistentVolumeClaim{}, + "claim-02": &api.PersistentVolumeClaim{}, + "claim-03": &api.PersistentVolumeClaim{}, + }, + "../docs/user-guide/persistent-volumes/simpletest": { + "namespace": &api.Namespace{}, + "pod": &api.Pod{}, + "service": &api.Service{}, + }, + "../docs/user-guide/liveness": { + "exec-liveness": &api.Pod{}, + "http-liveness": &api.Pod{}, + "http-liveness-named-port": &api.Pod{}, + }, + "../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": { + "bad-nginx-deployment": &extensions.Deployment{}, + "counter-pod": &api.Pod{}, + "curlpod": &extensions.Deployment{}, + "deployment": &extensions.Deployment{}, + "ingress": &extensions.Ingress{}, + "job": &batch.Job{}, + "multi-pod": &api.Pod{}, + "new-nginx-deployment": &extensions.Deployment{}, + "nginx-app": &api.Service{}, + "nginx-deployment": &extensions.Deployment{}, + "nginx-init-containers": &api.Pod{}, + "nginx-lifecycle-deployment": &extensions.Deployment{}, + "nginx-probe-deployment": &extensions.Deployment{}, + "nginx-secure-app": &api.Service{}, + "nginx-svc": &api.Service{}, + "petset": &api.Service{}, + "pod": &api.Pod{}, + "pod-w-message": &api.Pod{}, + "redis-deployment": &extensions.Deployment{}, + "redis-resource-deployment": &extensions.Deployment{}, + "redis-secret-deployment": &extensions.Deployment{}, + "run-my-nginx": &extensions.Deployment{}, + }, + "../docs/admin": { + "daemon": &extensions.DaemonSet{}, + }, + "../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/admin/namespaces": { + "namespace-dev": &api.Namespace{}, + "namespace-prod": &api.Namespace{}, + }, + "../docs/admin/limitrange": { + "invalid-pod": &api.Pod{}, + "limits": &api.LimitRange{}, + "namespace": &api.Namespace{}, + "valid-pod": &api.Pod{}, + }, + "../docs/user-guide/logging-demo": { + "synthetic_0_25lps": &api.Pod{}, + "synthetic_10lps": &api.Pod{}, + }, + "../docs/user-guide/node-selection": { + "pod": &api.Pod{}, + "pod-with-node-affinity": &api.Pod{}, + }, + "../docs/admin/resourcequota": { + "best-effort": &api.ResourceQuota{}, + "compute-resources": &api.ResourceQuota{}, + "limits": &api.LimitRange{}, + "namespace": &api.Namespace{}, + "not-best-effort": &api.ResourceQuota{}, + "object-counts": &api.ResourceQuota{}, + }, + "../docs/user-guide/secrets": { + "secret-pod": &api.Pod{}, + "secret": &api.Secret{}, + "secret-env-pod": &api.Pod{}, + }, + } + + capabilities.SetForTests(capabilities.Capabilities{ + AllowPrivileged: true, + }) + + for path, expected := range cases { + tested := 0 + err := walkConfigFiles(path, func(name, path string, data []byte) { + expectedType, found := expected[name] + if !found { + t.Errorf("%s: %s does not have a test case defined", path, name) + return + } + tested++ + if expectedType == nil { + t.Logf("skipping : %s/%s\n", path, name) + return + } + if strings.Contains(name, "scheduler-policy-config") { + if err := runtime.DecodeInto(schedulerapilatest.Codec, data, expectedType); err != nil { + t.Errorf("%s did not decode correctly: %v\n%s", path, err, string(data)) + return + } + // TODO: Add validate method for + // &schedulerapi.Policy, and remove this + // special case + } else { + codec, err := testapi.GetCodecForObject(expectedType) + if err != nil { + t.Errorf("Could not get codec for %s: %s", expectedType, err) + } + if err := runtime.DecodeInto(codec, data, expectedType); err != nil { + t.Errorf("%s did not decode correctly: %v\n%s", path, err, string(data)) + return + } + if errors := validateObject(expectedType); len(errors) > 0 { + t.Errorf("%s did not validate correctly: %v", path, errors) + } + } + }) + if err != nil { + t.Errorf("Expected no error, Got %v on Path %v", err, path) + } + if tested != len(expected) { + t.Errorf("Directory %v: Expected %d examples, Got %d", path, len(expected), tested) + } + } +} + +// This regex is tricky, but it works. For future me, here is the decode: +// +// Flags: (?ms) = multiline match, allow . to match \n +// 1) Look for a line that starts with ``` (a markdown code block) +// 2) (?: ... ) = non-capturing group +// 3) (P) = capture group as "name" +// 4) Look for #1 followed by either: +// 4a) "yaml" followed by any word-characters followed by a newline (e.g. ```yamlfoo\n) +// 4b) "any word-characters followed by a newline (e.g. ```json\n) +// 5) Look for either: +// 5a) #4a followed by one or more characters (non-greedy) +// 5b) #4b followed by { followed by one or more characters (non-greedy) followed by } +// 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. +var sampleRegexp = regexp.MustCompile("(?ms)^```(?:(?Pyaml)\\w*\\n(?P.+?)|\\w*\\n(?P\\{.+?\\}))\\n^```") +var subsetRegexp = regexp.MustCompile("(?ms)\\.{3}") + +func TestReadme(t *testing.T) { + paths := []struct { + file string + expectedType []runtime.Object + }{ + {"../docs/user-guide/volumes.md", []runtime.Object{&api.Pod{}}}, + } + + for _, path := range paths { + data, err := ioutil.ReadFile(path.file) + if err != nil { + t.Errorf("Unable to read file %s: %v", path, err) + continue + } + + matches := sampleRegexp.FindAllStringSubmatch(string(data), -1) + if matches == nil { + continue + } + ix := 0 + for _, match := range matches { + var content, subtype string + for i, name := range sampleRegexp.SubexpNames() { + if name == "type" { + subtype = match[i] + } + if name == "content" && match[i] != "" { + content = match[i] + } + } + if subtype == "yaml" && subsetRegexp.FindString(content) != "" { + t.Logf("skipping (%s): \n%s", subtype, content) + continue + } + + var expectedType runtime.Object + if len(path.expectedType) == 1 { + expectedType = path.expectedType[0] + } else { + expectedType = path.expectedType[ix] + ix++ + } + json, err := yaml.ToJSON([]byte(content)) + if err != nil { + t.Errorf("%s could not be converted to JSON: %v\n%s", path, err, string(content)) + } + if err := runtime.DecodeInto(testapi.Default.Codec(), json, expectedType); err != nil { + t.Errorf("%s did not decode correctly: %v\n%s", path, err, string(content)) + continue + } + if errors := validateObject(expectedType); len(errors) > 0 { + t.Errorf("%s did not validate correctly: %v", path, errors) + } + _, err = runtime.Encode(testapi.Default.Codec(), expectedType) + if err != nil { + t.Errorf("Could not encode object: %v", err) + continue + } + } + } +} diff --git a/update-imported-docs.sh b/update-imported-docs.sh old mode 100644 new mode 100755 index f5ba962b7e..e560266646 --- a/update-imported-docs.sh +++ b/update-imported-docs.sh @@ -1,34 +1,38 @@ -git clone https://github.com/kubernetes/kubernetes.git k8s +#!/bin/bash + +# Uncomment this to see the commands as they are run +# set -x + +VERSION=1.3 + +git clone --depth=1 -b release-$VERSION https://github.com/kubernetes/kubernetes.git k8s cd k8s -git checkout release-1.2 +git remote add upstream https://github.com/kubernetes/kubernetes.git +git fetch upstream +hack/generate-docs.sh +hack/update-generated-swagger-docs.sh +build/versionize-docs.sh release-$VERSION cd .. -rm -rf _includes/v1.2 -mkdir _includes/v1.2 - -unalias cp +rm -rf _includes/v$VERSION +mkdir _includes/v$VERSION # batch fetches while read line || [[ -n ${line} ]]; do IFS=': ' read -a myarray <<< "${line}" - #echo "arraypos0: ${myarray[0]}" - #echo "arraypos1: ${myarray[1]}" - #echo "arraypos2: ${myarray[2]}" - #echo "arraypos3: ${myarray[3]}" - if [ "${myarray[1]}" = "path" ]; then + if [ "${myarray[1]}" = "path" ]; then TARGET="${myarray[2]}" CLEARPATH="${TARGET}" K8SSOURCE='k8s/'${TARGET} DESTINATION=${TARGET%/*} rm -rf "${CLEARPATH}" - mv -f "${K8SSOURCE}" "${DESTINATION}" - # find "${DESTINATION}" -name "*${DESTINATION}" -print0 | xargs -0 sed -i '' -e 's/.html)/)/g' - fi + yes | cp -rf "${K8SSOURCE}" "${DESTINATION}" + fi if [ "${myarray[1]}" = "changedpath" ]; then SRC="${myarray[2]}" DESTINATION="${myarray[3]}" echo "mv -f ${SRC} ${DESTINATION}" - mv -f "${SRC}" "${DESTINATION}" + yes | cp -rf "${SRC}" "${DESTINATION}" fi if [ "${myarray[1]}" = "copypath" ]; then K8SSOURCE="${myarray[2]}" @@ -39,12 +43,68 @@ while read line || [[ -n ${line} ]]; do done <_data/overrides.yml # refdoc munging -cd _includes/v1.2 -find . -name '*.html' -type f -exec sed -i '' '/