From df4a93598e138e5ee2740bd83f886b076035f853 Mon Sep 17 00:00:00 2001 From: Matthew Hooker Date: Fri, 20 May 2016 15:19:35 -0700 Subject: [PATCH 001/115] mark node phase as deprecated I'm not sure on what the best wording for this should be, but `Node Phase` is no longer populated, and so the docs should say so. @random-liu on slack/#sig-node told me that they believed node phase was unused. cc @dawnchen --- docs/admin/node.md | 14 +------------- 1 file changed, 1 insertion(+), 13 deletions(-) diff --git a/docs/admin/node.md b/docs/admin/node.md index 13332012b8..2cdc96366c 100644 --- a/docs/admin/node.md +++ b/docs/admin/node.md @@ -31,19 +31,7 @@ The usage of these fields varies depending on your cloud provider or bare metal ### Node Phase -Node Phase is the current lifecycle phase of node, one of `Pending`, -`Running` and `Terminated`. - -* Pending: New nodes are created in this state. A node stays in this state until it is configured. - -* Running: Node has been configured and the Kubernetes components are running - -* Terminated: Node has been removed from the cluster. It will not receive any scheduling requests, -and any running pods will be removed from the node. - -Node with `Running` phase is necessary but not sufficient requirement for -scheduling Pods. For a node to be considered a scheduling candidate, it -must have appropriate conditions, see below. +Deprecated: Node Phase is no longer used ### Node Condition From 33b68cd10295c78f4134e4f251033896859790cd Mon Sep 17 00:00:00 2001 From: "Madhusudan.C.S" Date: Mon, 1 Aug 2016 11:32:15 -0700 Subject: [PATCH 002/115] Update the references to federation control plane images/binaries in the federation admin guide. --- docs/admin/federation/index.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/admin/federation/index.md b/docs/admin/federation/index.md index fc077ec839..7bcf7cc612 100644 --- a/docs/admin/federation/index.md +++ b/docs/admin/federation/index.md @@ -17,8 +17,9 @@ This guide also assumes that we have the Kubernetes source code that can be ## 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. +consists of etcd, federation-apiserver (via hyperkube binary) and +federation-controller-manager (via hyperkube binary). We can run these +binaries as pods on an existing Kubernetes cluster. ### Getting images @@ -30,7 +31,9 @@ official release images or we can build from HEAD. 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`. +To use the hyperkube image which includes federation-apiserver and +federation-controller-manager from a specific release, we can set +`FEDERATION_IMAGE_TAG`. #### Building and pushing images from HEAD From b9ac8c314758032f537d9b06ac9fe3f01ed0c15e Mon Sep 17 00:00:00 2001 From: Jared Date: Tue, 2 Aug 2016 15:34:28 -0700 Subject: [PATCH 003/115] Add .travis.yml file to release branch Allow staging of 1.4 release files --- .travis.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000000..28808dcfd6 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,22 @@ +language: ruby +rvm: +- 2.1 +branches: + only: + - release-1.4 +script: +- cd $HOME +- git config --global user.email ${GIT_EMAIL} +- git config --global user.name "${GIT_NAME}" +- git clone https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes-v1-4/kubernetes-v1-4.github.io.git +- cd kubernetes-v1-4.github.io +- git remote add --fetch --track release-1.3 homebase "https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes/kubernetes.github.io.git" +- git merge -s recursive -X theirs homebase/release-1.4 -m "Sync from homebase" +- git push +env: + global: + - secure: Fd6wlE2mjPb1fAACxklQcJumpJWycYkaJQBfKRcjGCFlmw1XWVFGhpUC7Ni/MOyzTolqOvtb2rXnYpaujMlJP1UXqVFJ+zPbwur2lc8unQF8PcqPezl8DbPsr6HdceOjRdut/dN8zTw6+hZRDzw/mG4Rf8IVaozlYycAOnWZdAZsLXdbBpAvBp0WYHP9+8wn9xiet1L/QpSiawa/Q35Q9UM1tciPmfFBL4Fkq6Mm8/w6ECaxHyA2EX+eH5ea9EtykrzB5cMA/odJLptjnmfzsPeGS5F1MxuTqrH2Z09emZcqjfXW+fNNzioiZdD4BQe+rqOA1Ktpw645szJVJJenIMzM4P8dDiW+9cJyddGdTC9A7APgLlLVdG/tuoYcjiY1F068SWx8sUWW/xc7YenCzGj2nXIeHjUuWsjqjMorpBKe6Y1QSGfi7HsLq1DpJDR1xQZbPgM/FOaovVIPIozgAIBpS1ukdNNwadmrCw55tUKfr4s2SNv3SUmeprL37QEtIxtBpPDjL1z+qTLjc6JzRr7J57guPBdNbj6Ukg/uxW+z1CwDYb3uAIIa5e6eDxfxGQsUEj8NmkIHBLLGTnKb1WAyPXAIf9ZvZHUwQQzHvOWXGZRd32enRh00uvuwHEy3OuGEqTAOIs/31q5WAamZ1uqzW7KBTMU/nq4QA9W2yfM= + - secure: Lvj1MT/I2zaJp9mQi46us64O4JfeT9cz1m+nqKY/nuC828ULfqMYLlpw08jvrc25JhAaqHNawAwdtaxHTQqHztsmq1ixHFYA6G/1oll+YPhym29toFT9oIkXThf/L77FTJfM1gVFMyiHFbz11Ob8R15tRB1WF1+Uu1RBmtudJD7HSy0u6Uc6lPxpqtycWVRCyPdvZqF3e0KIZaTDRkRzJpcVMHa/5ZJDDcMtuJyjJYXZqS1WR3QHC1z44LlnqyB5ZM2PU4H3LyWnY8wHF2mutF0QtDDVdEuBqILBHiFuKHMxpLY92UgHm2n51RR63MxFjjEzE+iu5f9ComEm5JC0N/cc8sunIiol+d8SRC30/00Vs0tvmeAjRX9IMCExiP3mv7Tz6mqEVk6PyrVlg675hxRg0eVdaNNv92gWzCSIecZ5TuCaRG4JaWO0P8lQC4NreONt6gbnwMD350hMQZLpUUE0QoSEdafpudaD+agl4ZzTFVTOOcSOz2Sa/+RT96Msazq2YlddYXaEKZeyYzqHVkk60PiQzQcAuwCMFrAagqMe3bNI2aCFEWbc9CoR13K/wwRDwAeSzBq/UkylZ8AayJLnIpewr/iYBOQasrXLrorW969Rfr8d/nwhDN5VpRgItU0arDzngaJRoZEAtHx4zaCvZF/H/nvbORcD2gsFP9Q= + - secure: WGmgvSnT1OeHPYtsm/JzcRDnZYp+SeelgbSVNbtwOXGImkeqDo/sDIRH80HxVC3zkUu5wvRO/NkMA7N3LXN2BqENacWBFQ+j+Hf3lnDw9yETBaBpLQPO/MElKGd48GoSiukCipfaITUfwtjAQ3wx0W/z06dYC9BdUYvUM73OtsGtlrY1MEQnBfff/neDGZbzfvTdgDwg1n6d69WP+WSUJt5Aysz0ZoAbYO2rzBrKNwcL7KEhoI/ketXXQ4xEW0nnxU/qfxqhVfJbck1HpSz+HMsVGXF4tT3zdRXmU+P47KGbfYn0GmlviGrRSWCu9/elKTlX9fIqRnR1/UvdTkflwLsk4i3hWnEUflKpIT7soJrKjNQseyd06KI8qvVRXRcll92vCtsYDuOO1AlemxIqp2dIFduCf+5FWH06PbS8oHU8NBe5aVYaoBY8nK14EB3A98saJ8Un7ziB8moRaWZX9bMjfJWfxDF526NdHIusqLQrxvUthtBjf5aRULE2PeIyqYVY8/IKmBEfsy9IUENmlM5KItvgZZt4xdk8o//kceLrKabudHGVC1M1RLZo9ejkdLySz2i8nlJyJ03Hn30H9DfDjW/OMQTn/b1HU4CYSbd/yGR+6+5+tdPeKy/Z6gI6+EjHRYaaQrBLo0RXm2620cb7uDTBIsKVs2TetyhTq54= + - secure: lqboLQKFpfa6F+UkSCs9+NPv027EnSWZA4/cmAXj0hZvxc4W+qMFIlPKytcq+bbZrp7kx3cZgRd5NrgmOTqlJ9merVK1cgMsDegMv/YImHjhGVBH+3ATvqMDb7I7dLg4x/DjhKt/ogyZpoh8vsS77T9MQXaIJM8JMM3ISxYI6MMloCh0z/hbT2qv3IrPMFjpHohHdF1yorxKvSefNgPx6Y4wC+t1t+u8wS9RBhvrmOkVynlU2NgbSiMPyz3syJmnszHDTXXJlqciGT5Lc8lzpzt2OGOnZmAupEYVGok7Jx4aAxU9O8/bnoDwOcGGVrd/pGHTI5+rvT4TPy+WG1Aec55dgva4XZfrJQ88snHLvq0VrvdiI/fHJEPF18QnrBwKSni1Vd1jOzsuPIF6HL0Wwv8tklO8OX3D5wqVsXpeJd4Cj4HPPAtzxOVsV6Fz3On9vuLdV7StC/ZafQL40koaytqkNO0gX8zeUiaaVQtMCf/2MVTbX9x5m51gkGpwT0JBvqQpSMOlIM5S1fiN4X9DLBLqmsARYeZw1Jeiq7Zm39Sy1QeCgfUXS8+6t62BjWx70iftYGIkoljXtD7x/3pjKymdpwjcyUcS8KQ5W6vbMXFxmZe2phtgGTCxOIDuASPspD8zwm/ckIGArHj4qkrg94/mUpgDDIbVsaUpWXjYvSc= + - secure: bPZMNH79Lx0Wb2SCxTwyZek28w/keKxEAlfad8RDMwJrct6Bi2B0o4KjkrwFS5DyCUU7Ndk192145XnUKOWX2YVs6cQ8ge+5LvtgYhWLgX8g5Ycro+JyzOBskn+o1gQjvi8+3b42X31efcUmTEhfRdKVrrUpONEIcjG1NpLGk/mQJ6AM6hGWO2xdNfAezeWq5ISnpK0b6VUWZyTEDg3NivrTfCL2juWWCnjYm1BWSHUblXwRQ/Rl7Tcldl6cMMUVsalUQ1iG0h8YZDrxNz0cm3XTZZZJKuSHYeTCLd57RBeHD5/iMxjCmfzfq6ETNLONWLmtvA8yhWMQZ0DPFtLZzbqFIfOR6P1feBZFqP7/X5KZeFKBufN15JbcXIqHE8homLY9mS0LhyNffOs5G/P/x8ChE1DJaYiZIWCZ60umvpqibScZB3z5uFPTxLk9rJSOtT7hCWjcmg3EdJ+R4ExOiBDd62ZS5jH72WU4uysPXORRofUCL+zHycJoJxsFWQSW49GAGrohllrW45jnTgpalErxvjJFSKy8JW9w634eetz9ct2fObep7m8bfVMl8U2H3ITIoXHm+f8ooHUiNzHFLSl4wtcoAOtrCAvGtJPNfv8T2eTkznzj7Tk+XzTvFg03u+J99TmnC58Bs516Oc7E40NarmsZceOD2sN4BA3X9tE= From af688c1862ed44514394cc97061ddb3b31bc15e9 Mon Sep 17 00:00:00 2001 From: Jared Date: Tue, 2 Aug 2016 15:57:56 -0700 Subject: [PATCH 004/115] Update travis.yml --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 28808dcfd6..32a60e04ed 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,7 +10,7 @@ script: - git config --global user.name "${GIT_NAME}" - git clone https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes-v1-4/kubernetes-v1-4.github.io.git - cd kubernetes-v1-4.github.io -- git remote add --fetch --track release-1.3 homebase "https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes/kubernetes.github.io.git" +- git remote add --fetch --track release-1.4 homebase "https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes/kubernetes.github.io.git" - git merge -s recursive -X theirs homebase/release-1.4 -m "Sync from homebase" - git push env: From ba828377a7f2589c80a1155199af9b71d332eb83 Mon Sep 17 00:00:00 2001 From: Jared Date: Tue, 2 Aug 2016 21:20:39 -0700 Subject: [PATCH 005/115] Update .travis.yml --- .travis.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index 32a60e04ed..cb0cb9e528 100644 --- a/.travis.yml +++ b/.travis.yml @@ -15,8 +15,7 @@ script: - git push env: global: - - secure: Fd6wlE2mjPb1fAACxklQcJumpJWycYkaJQBfKRcjGCFlmw1XWVFGhpUC7Ni/MOyzTolqOvtb2rXnYpaujMlJP1UXqVFJ+zPbwur2lc8unQF8PcqPezl8DbPsr6HdceOjRdut/dN8zTw6+hZRDzw/mG4Rf8IVaozlYycAOnWZdAZsLXdbBpAvBp0WYHP9+8wn9xiet1L/QpSiawa/Q35Q9UM1tciPmfFBL4Fkq6Mm8/w6ECaxHyA2EX+eH5ea9EtykrzB5cMA/odJLptjnmfzsPeGS5F1MxuTqrH2Z09emZcqjfXW+fNNzioiZdD4BQe+rqOA1Ktpw645szJVJJenIMzM4P8dDiW+9cJyddGdTC9A7APgLlLVdG/tuoYcjiY1F068SWx8sUWW/xc7YenCzGj2nXIeHjUuWsjqjMorpBKe6Y1QSGfi7HsLq1DpJDR1xQZbPgM/FOaovVIPIozgAIBpS1ukdNNwadmrCw55tUKfr4s2SNv3SUmeprL37QEtIxtBpPDjL1z+qTLjc6JzRr7J57guPBdNbj6Ukg/uxW+z1CwDYb3uAIIa5e6eDxfxGQsUEj8NmkIHBLLGTnKb1WAyPXAIf9ZvZHUwQQzHvOWXGZRd32enRh00uvuwHEy3OuGEqTAOIs/31q5WAamZ1uqzW7KBTMU/nq4QA9W2yfM= - - secure: Lvj1MT/I2zaJp9mQi46us64O4JfeT9cz1m+nqKY/nuC828ULfqMYLlpw08jvrc25JhAaqHNawAwdtaxHTQqHztsmq1ixHFYA6G/1oll+YPhym29toFT9oIkXThf/L77FTJfM1gVFMyiHFbz11Ob8R15tRB1WF1+Uu1RBmtudJD7HSy0u6Uc6lPxpqtycWVRCyPdvZqF3e0KIZaTDRkRzJpcVMHa/5ZJDDcMtuJyjJYXZqS1WR3QHC1z44LlnqyB5ZM2PU4H3LyWnY8wHF2mutF0QtDDVdEuBqILBHiFuKHMxpLY92UgHm2n51RR63MxFjjEzE+iu5f9ComEm5JC0N/cc8sunIiol+d8SRC30/00Vs0tvmeAjRX9IMCExiP3mv7Tz6mqEVk6PyrVlg675hxRg0eVdaNNv92gWzCSIecZ5TuCaRG4JaWO0P8lQC4NreONt6gbnwMD350hMQZLpUUE0QoSEdafpudaD+agl4ZzTFVTOOcSOz2Sa/+RT96Msazq2YlddYXaEKZeyYzqHVkk60PiQzQcAuwCMFrAagqMe3bNI2aCFEWbc9CoR13K/wwRDwAeSzBq/UkylZ8AayJLnIpewr/iYBOQasrXLrorW969Rfr8d/nwhDN5VpRgItU0arDzngaJRoZEAtHx4zaCvZF/H/nvbORcD2gsFP9Q= - - secure: WGmgvSnT1OeHPYtsm/JzcRDnZYp+SeelgbSVNbtwOXGImkeqDo/sDIRH80HxVC3zkUu5wvRO/NkMA7N3LXN2BqENacWBFQ+j+Hf3lnDw9yETBaBpLQPO/MElKGd48GoSiukCipfaITUfwtjAQ3wx0W/z06dYC9BdUYvUM73OtsGtlrY1MEQnBfff/neDGZbzfvTdgDwg1n6d69WP+WSUJt5Aysz0ZoAbYO2rzBrKNwcL7KEhoI/ketXXQ4xEW0nnxU/qfxqhVfJbck1HpSz+HMsVGXF4tT3zdRXmU+P47KGbfYn0GmlviGrRSWCu9/elKTlX9fIqRnR1/UvdTkflwLsk4i3hWnEUflKpIT7soJrKjNQseyd06KI8qvVRXRcll92vCtsYDuOO1AlemxIqp2dIFduCf+5FWH06PbS8oHU8NBe5aVYaoBY8nK14EB3A98saJ8Un7ziB8moRaWZX9bMjfJWfxDF526NdHIusqLQrxvUthtBjf5aRULE2PeIyqYVY8/IKmBEfsy9IUENmlM5KItvgZZt4xdk8o//kceLrKabudHGVC1M1RLZo9ejkdLySz2i8nlJyJ03Hn30H9DfDjW/OMQTn/b1HU4CYSbd/yGR+6+5+tdPeKy/Z6gI6+EjHRYaaQrBLo0RXm2620cb7uDTBIsKVs2TetyhTq54= - - secure: lqboLQKFpfa6F+UkSCs9+NPv027EnSWZA4/cmAXj0hZvxc4W+qMFIlPKytcq+bbZrp7kx3cZgRd5NrgmOTqlJ9merVK1cgMsDegMv/YImHjhGVBH+3ATvqMDb7I7dLg4x/DjhKt/ogyZpoh8vsS77T9MQXaIJM8JMM3ISxYI6MMloCh0z/hbT2qv3IrPMFjpHohHdF1yorxKvSefNgPx6Y4wC+t1t+u8wS9RBhvrmOkVynlU2NgbSiMPyz3syJmnszHDTXXJlqciGT5Lc8lzpzt2OGOnZmAupEYVGok7Jx4aAxU9O8/bnoDwOcGGVrd/pGHTI5+rvT4TPy+WG1Aec55dgva4XZfrJQ88snHLvq0VrvdiI/fHJEPF18QnrBwKSni1Vd1jOzsuPIF6HL0Wwv8tklO8OX3D5wqVsXpeJd4Cj4HPPAtzxOVsV6Fz3On9vuLdV7StC/ZafQL40koaytqkNO0gX8zeUiaaVQtMCf/2MVTbX9x5m51gkGpwT0JBvqQpSMOlIM5S1fiN4X9DLBLqmsARYeZw1Jeiq7Zm39Sy1QeCgfUXS8+6t62BjWx70iftYGIkoljXtD7x/3pjKymdpwjcyUcS8KQ5W6vbMXFxmZe2phtgGTCxOIDuASPspD8zwm/ckIGArHj4qkrg94/mUpgDDIbVsaUpWXjYvSc= - - secure: bPZMNH79Lx0Wb2SCxTwyZek28w/keKxEAlfad8RDMwJrct6Bi2B0o4KjkrwFS5DyCUU7Ndk192145XnUKOWX2YVs6cQ8ge+5LvtgYhWLgX8g5Ycro+JyzOBskn+o1gQjvi8+3b42X31efcUmTEhfRdKVrrUpONEIcjG1NpLGk/mQJ6AM6hGWO2xdNfAezeWq5ISnpK0b6VUWZyTEDg3NivrTfCL2juWWCnjYm1BWSHUblXwRQ/Rl7Tcldl6cMMUVsalUQ1iG0h8YZDrxNz0cm3XTZZZJKuSHYeTCLd57RBeHD5/iMxjCmfzfq6ETNLONWLmtvA8yhWMQZ0DPFtLZzbqFIfOR6P1feBZFqP7/X5KZeFKBufN15JbcXIqHE8homLY9mS0LhyNffOs5G/P/x8ChE1DJaYiZIWCZ60umvpqibScZB3z5uFPTxLk9rJSOtT7hCWjcmg3EdJ+R4ExOiBDd62ZS5jH72WU4uysPXORRofUCL+zHycJoJxsFWQSW49GAGrohllrW45jnTgpalErxvjJFSKy8JW9w634eetz9ct2fObep7m8bfVMl8U2H3ITIoXHm+f8ooHUiNzHFLSl4wtcoAOtrCAvGtJPNfv8T2eTkznzj7Tk+XzTvFg03u+J99TmnC58Bs516Oc7E40NarmsZceOD2sN4BA3X9tE= + - secure: VBSiwZ2b2ViA0cu7JXmUuqh4gcFnJY7l3uGUDbVWUV1HOMGSfp0na+ywJmL0Jc80/U7JSV+6ZiR2HlYtLv4DoHW9hdXYyIaTlSQBLAdxvuCgnRLCs459ulBseYzIxCsVqf3hw27ghCcmwB7UOZrxZSStCZMTv2u0tt3Qj95BfKqadU8p9JmtIsLPwAN8+gfhBlTva7HJkaRIijE0hV86fz4AB3PFaZDW2hPMnUW1JkWQTDa9pXTYsUsGAiljLLLupdoCZnaHG8geqmLrfFEuIq9aT2xF9EvZXHyV6ZEihtcF8zOb+hsUTxBo/J3tz+jld/S0cIF/+MzoPsxv+MklZbdAGdGOydbRsNV2Tm9yLRYD0FlpqYeNJh2zolvo5cSe6goroy1fPJhGTlJ6Dc4Ux1fFKITb3w1/LloyaiyaXzlJ/1EKuFrVNyf+juA8wIMqlGfmWG3p2gJADZAM1dPyKu1MCkXG6WqxRKIVqWkqlCM+NLWuJaN5UaJa3L32NR52y0g5wT1ZUTIlC6gpldr9+jQmpb6TBCYlEMnRYrmRKKoWCN0gR0MRkPvX8gUZr/McC1FpKZTlORtck1XVR2RUudRt3gn/Je8yl11ED0xKAW1DRnU3mjKsIsqbAOXorBkGctJsjfYsRx7aLxE/Tl0S/zciIGA4F4/BF5IrVQ4TX7M= + - secure: HbQgpkuS16xxEUiJ42ft629xD51tiLZjAoJVlm9F/9cZnhtWNNmRuM9QU6x2Eq81/5D+pUT+utg7fVrIZ+nQi0iksFK+i/38/h9MKrJ28uslmnGReqOlG8H+HWrxTGcWbuxvh2eJRnkMGO1E/YYKBmo86ExYIymR5vRj/DsY2FY2QLny6l5GbnCaexQmx2DJ0dyTLHlsV8VX329xAqKb2qFeWxUlNLVD8CKuufE2PtUTL9cUb9cBXWf6nmQr8LjUpTFZLRlj3JdvyNW/Ea/xTCBR4ZGMoxzXauyKfj3Qtvb5C2sTWaGQlrkKipIDmS/54ZQJns8hpK0Zq6cgRrfSyO/QXuCPqYYAary1evUVxOXA+ANglRqUVymfOIeMvwE/rCgj/7hgSgtwZmEIuSFuHvd/N0pIYAKdEAVeCizmSywI8WZ8er687oU7Q8Kmrj5HkzINY3JHa/LVjXRXSBtztj09uEb63JwbTbPiTUwl+9lVhTAOj9zG9Sjkk2Ldz7PD20Sec2xS20FuWMKb/RTw48wVxiFhF9jY3OazFTamgs8I1KIvmPIq5sNGTYzWppTunHL2CWW2j7bI++4UAwe1d0Y//IovBEDU6lkTHu0CCHN5H9i7TSklybCA9hYGLlLT4gUwichl/uJeVdfJi3UtlUMZEYmtm2zPpu0JTjsgFQ0= + - secure: ETD97vLiJKubS/Fblo/Nm/hJFjdEtjpO+zaRKzLTl3zsl/eebhp7TYC8zJo+v//f3iApGjKx+6aQYCVhdSOo4cdEQjnnGdTAHIpBfzN9ov74x5rVvuyWmvFLcDyJswHwUAhDoSE0d2/VIK70p+KjPofBN8vo9uluqA651MnDS8C4lwFP8DCgwCkHbp38yzUgrnWWcxpheQJOb/KyY6R8fO5mxPcnkp8vFfB4SgW1DW068xGI+Au14xh7H4o+xnPLVnPzRAyywJEYViVfuENOI2ld6PfCaG/KawsffXX25kWGM0VRlOaVRHYWRm+b/862rhd2a8hiP0D2adTm20ZSnqrTLnCTshcg85GzycXIzV89uMxuhICmgCw0HM0lf8DVqEzHlvKoZTVI4y6+GOEkc+8VTwgFN9v/lXT7dPE/KBRGmb1lxBgjAKX4D7GSvjZ3GXDdDt++fsV+v9pDFCpwN75Gt209xxeBwWrfViqLTpglWStd5rfPOh/Sq87PSr9djLzkGkSAl9iw9i/KVysDft42xz+sEf6qH4HfwYM2e5wj/YVHdMsfEFzEtbrdhRPpWGFFwB9siC48/CskXPmQoA7X0Agz/pbP7IKGvW1//sp2aG+019pwBu/vRN7vYc+xfBPEdyiWNRiRu+vqx86HmfJigddoxfzo79E2S5QprWM= + - secure: ZvfQrro2RV7b0kWkl1aRU6s+AW7lKvXj0JuA9xkhWBRYZvRMuK2VOb0oQXiFG7MLM6Wai2BJ1KN/IUi8lnYPtIVtKu6oZEsR5pOD3ZbZeY2/UeKqXu/kzZDcuD62ift/6cf+qO16JgQhf//1Kox3HFrgB9jtHPCVWIIFN9PCv0Y/RgUzxExSIlSndfPJbqgno7QOBuXTkRyr3vIUYHo04Vf7U8d1pPK/OoDiZCBwzLjO541a4DAvB1Mqo6p+S0A8S4U+/TR38zP9nUj+Ew748RlD1Y564DNAmtcSgpFkDb4LaT9rdFL9KxcppzVowKphx8cGW/WxNHl0ea97P/xpnRwuRmgaYyXcGhU7O2dJ99S7mJgVz0HpoWQwp0d3h8lru0J/78i774187Yr3dI76l0wYcfL8VQmiwrQd5dsxDTrBBPiZndVq7DgLO4vwRvc8D3mMoxTxqDxN2uWojg5o8yBP4p1x9YBL0K2w+TYadOmVmLhfKjuoIRMlVC/3wJqj8KtnCOUxPfMV6RLTgvPQ0RHT8h3nZ5GNs6llVehIOSDztlbVBxvTyKy2PxauGDiRBDLlML+XA4wkYRH28IUdsiZUraZf2At9JPJrc5B50xRJjHKEkSgOJZKwk/G71aDwHmj8J8+ii3RHq2SqUGDvKzTZ61LQWjgLoZigVKHd9Dc= From 2c117915f9a78aadd3a420115f1290d63f66e73b Mon Sep 17 00:00:00 2001 From: Jared Date: Tue, 2 Aug 2016 22:19:36 -0700 Subject: [PATCH 006/115] Update .travis.yml --- .travis.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.travis.yml b/.travis.yml index cb0cb9e528..9095fdadc1 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,9 +13,3 @@ script: - git remote add --fetch --track release-1.4 homebase "https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes/kubernetes.github.io.git" - git merge -s recursive -X theirs homebase/release-1.4 -m "Sync from homebase" - git push -env: - global: - - secure: VBSiwZ2b2ViA0cu7JXmUuqh4gcFnJY7l3uGUDbVWUV1HOMGSfp0na+ywJmL0Jc80/U7JSV+6ZiR2HlYtLv4DoHW9hdXYyIaTlSQBLAdxvuCgnRLCs459ulBseYzIxCsVqf3hw27ghCcmwB7UOZrxZSStCZMTv2u0tt3Qj95BfKqadU8p9JmtIsLPwAN8+gfhBlTva7HJkaRIijE0hV86fz4AB3PFaZDW2hPMnUW1JkWQTDa9pXTYsUsGAiljLLLupdoCZnaHG8geqmLrfFEuIq9aT2xF9EvZXHyV6ZEihtcF8zOb+hsUTxBo/J3tz+jld/S0cIF/+MzoPsxv+MklZbdAGdGOydbRsNV2Tm9yLRYD0FlpqYeNJh2zolvo5cSe6goroy1fPJhGTlJ6Dc4Ux1fFKITb3w1/LloyaiyaXzlJ/1EKuFrVNyf+juA8wIMqlGfmWG3p2gJADZAM1dPyKu1MCkXG6WqxRKIVqWkqlCM+NLWuJaN5UaJa3L32NR52y0g5wT1ZUTIlC6gpldr9+jQmpb6TBCYlEMnRYrmRKKoWCN0gR0MRkPvX8gUZr/McC1FpKZTlORtck1XVR2RUudRt3gn/Je8yl11ED0xKAW1DRnU3mjKsIsqbAOXorBkGctJsjfYsRx7aLxE/Tl0S/zciIGA4F4/BF5IrVQ4TX7M= - - secure: HbQgpkuS16xxEUiJ42ft629xD51tiLZjAoJVlm9F/9cZnhtWNNmRuM9QU6x2Eq81/5D+pUT+utg7fVrIZ+nQi0iksFK+i/38/h9MKrJ28uslmnGReqOlG8H+HWrxTGcWbuxvh2eJRnkMGO1E/YYKBmo86ExYIymR5vRj/DsY2FY2QLny6l5GbnCaexQmx2DJ0dyTLHlsV8VX329xAqKb2qFeWxUlNLVD8CKuufE2PtUTL9cUb9cBXWf6nmQr8LjUpTFZLRlj3JdvyNW/Ea/xTCBR4ZGMoxzXauyKfj3Qtvb5C2sTWaGQlrkKipIDmS/54ZQJns8hpK0Zq6cgRrfSyO/QXuCPqYYAary1evUVxOXA+ANglRqUVymfOIeMvwE/rCgj/7hgSgtwZmEIuSFuHvd/N0pIYAKdEAVeCizmSywI8WZ8er687oU7Q8Kmrj5HkzINY3JHa/LVjXRXSBtztj09uEb63JwbTbPiTUwl+9lVhTAOj9zG9Sjkk2Ldz7PD20Sec2xS20FuWMKb/RTw48wVxiFhF9jY3OazFTamgs8I1KIvmPIq5sNGTYzWppTunHL2CWW2j7bI++4UAwe1d0Y//IovBEDU6lkTHu0CCHN5H9i7TSklybCA9hYGLlLT4gUwichl/uJeVdfJi3UtlUMZEYmtm2zPpu0JTjsgFQ0= - - secure: ETD97vLiJKubS/Fblo/Nm/hJFjdEtjpO+zaRKzLTl3zsl/eebhp7TYC8zJo+v//f3iApGjKx+6aQYCVhdSOo4cdEQjnnGdTAHIpBfzN9ov74x5rVvuyWmvFLcDyJswHwUAhDoSE0d2/VIK70p+KjPofBN8vo9uluqA651MnDS8C4lwFP8DCgwCkHbp38yzUgrnWWcxpheQJOb/KyY6R8fO5mxPcnkp8vFfB4SgW1DW068xGI+Au14xh7H4o+xnPLVnPzRAyywJEYViVfuENOI2ld6PfCaG/KawsffXX25kWGM0VRlOaVRHYWRm+b/862rhd2a8hiP0D2adTm20ZSnqrTLnCTshcg85GzycXIzV89uMxuhICmgCw0HM0lf8DVqEzHlvKoZTVI4y6+GOEkc+8VTwgFN9v/lXT7dPE/KBRGmb1lxBgjAKX4D7GSvjZ3GXDdDt++fsV+v9pDFCpwN75Gt209xxeBwWrfViqLTpglWStd5rfPOh/Sq87PSr9djLzkGkSAl9iw9i/KVysDft42xz+sEf6qH4HfwYM2e5wj/YVHdMsfEFzEtbrdhRPpWGFFwB9siC48/CskXPmQoA7X0Agz/pbP7IKGvW1//sp2aG+019pwBu/vRN7vYc+xfBPEdyiWNRiRu+vqx86HmfJigddoxfzo79E2S5QprWM= - - secure: ZvfQrro2RV7b0kWkl1aRU6s+AW7lKvXj0JuA9xkhWBRYZvRMuK2VOb0oQXiFG7MLM6Wai2BJ1KN/IUi8lnYPtIVtKu6oZEsR5pOD3ZbZeY2/UeKqXu/kzZDcuD62ift/6cf+qO16JgQhf//1Kox3HFrgB9jtHPCVWIIFN9PCv0Y/RgUzxExSIlSndfPJbqgno7QOBuXTkRyr3vIUYHo04Vf7U8d1pPK/OoDiZCBwzLjO541a4DAvB1Mqo6p+S0A8S4U+/TR38zP9nUj+Ew748RlD1Y564DNAmtcSgpFkDb4LaT9rdFL9KxcppzVowKphx8cGW/WxNHl0ea97P/xpnRwuRmgaYyXcGhU7O2dJ99S7mJgVz0HpoWQwp0d3h8lru0J/78i774187Yr3dI76l0wYcfL8VQmiwrQd5dsxDTrBBPiZndVq7DgLO4vwRvc8D3mMoxTxqDxN2uWojg5o8yBP4p1x9YBL0K2w+TYadOmVmLhfKjuoIRMlVC/3wJqj8KtnCOUxPfMV6RLTgvPQ0RHT8h3nZ5GNs6llVehIOSDztlbVBxvTyKy2PxauGDiRBDLlML+XA4wkYRH28IUdsiZUraZf2At9JPJrc5B50xRJjHKEkSgOJZKwk/G71aDwHmj8J8+ii3RHq2SqUGDvKzTZ61LQWjgLoZigVKHd9Dc= From fa73317bd433f9002aa102e92b13c943048b3147 Mon Sep 17 00:00:00 2001 From: Jared Date: Tue, 2 Aug 2016 22:26:48 -0700 Subject: [PATCH 007/115] Update .travis.yml --- .travis.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.travis.yml b/.travis.yml index 9095fdadc1..adfed89e47 100644 --- a/.travis.yml +++ b/.travis.yml @@ -13,3 +13,9 @@ script: - git remote add --fetch --track release-1.4 homebase "https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes/kubernetes.github.io.git" - git merge -s recursive -X theirs homebase/release-1.4 -m "Sync from homebase" - git push +env: + global: + - secure: VBSiwZ2b2ViA0cu7JXmUuqh4gcFnJY7l3uGUDbVWUV1HOMGSfp0na+ywJmL0Jc80/U7JSV+6ZiR2HlYtLv4DoHW9hdXYyIaTlSQBLAdxvuCgnRLCs459ulBseYzIxCsVqf3hw27ghCcmwB7UOZrxZSStCZMTv2u0tt3Qj95BfKqadU8p9JmtIsLPwAN8+gfhBlTva7HJkaRIijE0hV86fz4AB3PFaZDW2hPMnUW1JkWQTDa9pXTYsUsGAiljLLLupdoCZnaHG8geqmLrfFEuIq9aT2xF9EvZXHyV6ZEihtcF8zOb+hsUTxBo/J3tz+jld/S0cIF/+MzoPsxv+MklZbdAGdGOydbRsNV2Tm9yLRYD0FlpqYeNJh2zolvo5cSe6goroy1fPJhGTlJ6Dc4Ux1fFKITb3w1/LloyaiyaXzlJ/1EKuFrVNyf+juA8wIMqlGfmWG3p2gJADZAM1dPyKu1MCkXG6WqxRKIVqWkqlCM+NLWuJaN5UaJa3L32NR52y0g5wT1ZUTIlC6gpldr9+jQmpb6TBCYlEMnRYrmRKKoWCN0gR0MRkPvX8gUZr/McC1FpKZTlORtck1XVR2RUudRt3gn/Je8yl11ED0xKAW1DRnU3mjKsIsqbAOXorBkGctJsjfYsRx7aLxE/Tl0S/zciIGA4F4/BF5IrVQ4TX7M= + - secure: HbQgpkuS16xxEUiJ42ft629xD51tiLZjAoJVlm9F/9cZnhtWNNmRuM9QU6x2Eq81/5D+pUT+utg7fVrIZ+nQi0iksFK+i/38/h9MKrJ28uslmnGReqOlG8H+HWrxTGcWbuxvh2eJRnkMGO1E/YYKBmo86ExYIymR5vRj/DsY2FY2QLny6l5GbnCaexQmx2DJ0dyTLHlsV8VX329xAqKb2qFeWxUlNLVD8CKuufE2PtUTL9cUb9cBXWf6nmQr8LjUpTFZLRlj3JdvyNW/Ea/xTCBR4ZGMoxzXauyKfj3Qtvb5C2sTWaGQlrkKipIDmS/54ZQJns8hpK0Zq6cgRrfSyO/QXuCPqYYAary1evUVxOXA+ANglRqUVymfOIeMvwE/rCgj/7hgSgtwZmEIuSFuHvd/N0pIYAKdEAVeCizmSywI8WZ8er687oU7Q8Kmrj5HkzINY3JHa/LVjXRXSBtztj09uEb63JwbTbPiTUwl+9lVhTAOj9zG9Sjkk2Ldz7PD20Sec2xS20FuWMKb/RTw48wVxiFhF9jY3OazFTamgs8I1KIvmPIq5sNGTYzWppTunHL2CWW2j7bI++4UAwe1d0Y//IovBEDU6lkTHu0CCHN5H9i7TSklybCA9hYGLlLT4gUwichl/uJeVdfJi3UtlUMZEYmtm2zPpu0JTjsgFQ0= + - secure: rDlG50qtNoMjntzebP5ogoieoiQrIxYj/ZYBYjxPITmVKn48LuFc2G7z4HTC3XokdMWOMoYoVLecW3V8tTk55TvsoQ8hhOVHRsL8qtu0iUvxZQJ6w6uLWBprvjeyiR77A0n+zAyM4l7vnMOLZeeui2YDkbPmZe2+0I4uRb/o7jbt5KazgvT+s13HUSJWXJXAnqbig29zNRMd8hfzKi2HE/oM861CML7yegMby9aB5KzJ4pyfZHEH1gRkGmlrSxgBKFVyu0CQ0DDZD0by4/c2Rcjk3Balj2UsphEUF++TW99+5qKrK6WavIi7dG1G9bVW4f5caCf8ebi88esAHZSdbFDtf0jdvoJ/EztMqRt0vhNKJHToauQSw1GAz2M/GnY5rYhYipRhe/ii7D/AFlA9ZYQwF2yHIz9nPNNnvd78Ud2bYyBpSAJDk9LFOZdxckmJZ0V2zonOD7zxPVxWtvKxwD/W28P2BidaKJjN2TVC8s7J7Qeuh8XBWyifavGcxR1faavtUAEVXxppg9BVNTAujb4Qkp8Y8tWU7Ez5aXpP8JXiKYCL0zkXK3MXJanECq6rE065i3TMqe+/qc2fHhWf3iZHU+iqFc39YbzWuZ/ecFUMxr9FJN2YdBAppTXLjj1KBTA6YM0a6XeXBPqjhcFNj9eDGalBxtuiZ6AbTJ+TncQ= + - secure: ZvfQrro2RV7b0kWkl1aRU6s+AW7lKvXj0JuA9xkhWBRYZvRMuK2VOb0oQXiFG7MLM6Wai2BJ1KN/IUi8lnYPtIVtKu6oZEsR5pOD3ZbZeY2/UeKqXu/kzZDcuD62ift/6cf+qO16JgQhf//1Kox3HFrgB9jtHPCVWIIFN9PCv0Y/RgUzxExSIlSndfPJbqgno7QOBuXTkRyr3vIUYHo04Vf7U8d1pPK/OoDiZCBwzLjO541a4DAvB1Mqo6p+S0A8S4U+/TR38zP9nUj+Ew748RlD1Y564DNAmtcSgpFkDb4LaT9rdFL9KxcppzVowKphx8cGW/WxNHl0ea97P/xpnRwuRmgaYyXcGhU7O2dJ99S7mJgVz0HpoWQwp0d3h8lru0J/78i774187Yr3dI76l0wYcfL8VQmiwrQd5dsxDTrBBPiZndVq7DgLO4vwRvc8D3mMoxTxqDxN2uWojg5o8yBP4p1x9YBL0K2w+TYadOmVmLhfKjuoIRMlVC/3wJqj8KtnCOUxPfMV6RLTgvPQ0RHT8h3nZ5GNs6llVehIOSDztlbVBxvTyKy2PxauGDiRBDLlML+XA4wkYRH28IUdsiZUraZf2At9JPJrc5B50xRJjHKEkSgOJZKwk/G71aDwHmj8J8+ii3RHq2SqUGDvKzTZ61LQWjgLoZigVKHd9Dc= From da37ff69a5384f80e6cce8cf0b27743f8fc3fc7e Mon Sep 17 00:00:00 2001 From: Jared Date: Tue, 2 Aug 2016 22:59:09 -0700 Subject: [PATCH 008/115] Update .travis.yml --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index adfed89e47..cb0cb9e528 100644 --- a/.travis.yml +++ b/.travis.yml @@ -17,5 +17,5 @@ env: global: - secure: VBSiwZ2b2ViA0cu7JXmUuqh4gcFnJY7l3uGUDbVWUV1HOMGSfp0na+ywJmL0Jc80/U7JSV+6ZiR2HlYtLv4DoHW9hdXYyIaTlSQBLAdxvuCgnRLCs459ulBseYzIxCsVqf3hw27ghCcmwB7UOZrxZSStCZMTv2u0tt3Qj95BfKqadU8p9JmtIsLPwAN8+gfhBlTva7HJkaRIijE0hV86fz4AB3PFaZDW2hPMnUW1JkWQTDa9pXTYsUsGAiljLLLupdoCZnaHG8geqmLrfFEuIq9aT2xF9EvZXHyV6ZEihtcF8zOb+hsUTxBo/J3tz+jld/S0cIF/+MzoPsxv+MklZbdAGdGOydbRsNV2Tm9yLRYD0FlpqYeNJh2zolvo5cSe6goroy1fPJhGTlJ6Dc4Ux1fFKITb3w1/LloyaiyaXzlJ/1EKuFrVNyf+juA8wIMqlGfmWG3p2gJADZAM1dPyKu1MCkXG6WqxRKIVqWkqlCM+NLWuJaN5UaJa3L32NR52y0g5wT1ZUTIlC6gpldr9+jQmpb6TBCYlEMnRYrmRKKoWCN0gR0MRkPvX8gUZr/McC1FpKZTlORtck1XVR2RUudRt3gn/Je8yl11ED0xKAW1DRnU3mjKsIsqbAOXorBkGctJsjfYsRx7aLxE/Tl0S/zciIGA4F4/BF5IrVQ4TX7M= - secure: HbQgpkuS16xxEUiJ42ft629xD51tiLZjAoJVlm9F/9cZnhtWNNmRuM9QU6x2Eq81/5D+pUT+utg7fVrIZ+nQi0iksFK+i/38/h9MKrJ28uslmnGReqOlG8H+HWrxTGcWbuxvh2eJRnkMGO1E/YYKBmo86ExYIymR5vRj/DsY2FY2QLny6l5GbnCaexQmx2DJ0dyTLHlsV8VX329xAqKb2qFeWxUlNLVD8CKuufE2PtUTL9cUb9cBXWf6nmQr8LjUpTFZLRlj3JdvyNW/Ea/xTCBR4ZGMoxzXauyKfj3Qtvb5C2sTWaGQlrkKipIDmS/54ZQJns8hpK0Zq6cgRrfSyO/QXuCPqYYAary1evUVxOXA+ANglRqUVymfOIeMvwE/rCgj/7hgSgtwZmEIuSFuHvd/N0pIYAKdEAVeCizmSywI8WZ8er687oU7Q8Kmrj5HkzINY3JHa/LVjXRXSBtztj09uEb63JwbTbPiTUwl+9lVhTAOj9zG9Sjkk2Ldz7PD20Sec2xS20FuWMKb/RTw48wVxiFhF9jY3OazFTamgs8I1KIvmPIq5sNGTYzWppTunHL2CWW2j7bI++4UAwe1d0Y//IovBEDU6lkTHu0CCHN5H9i7TSklybCA9hYGLlLT4gUwichl/uJeVdfJi3UtlUMZEYmtm2zPpu0JTjsgFQ0= - - secure: rDlG50qtNoMjntzebP5ogoieoiQrIxYj/ZYBYjxPITmVKn48LuFc2G7z4HTC3XokdMWOMoYoVLecW3V8tTk55TvsoQ8hhOVHRsL8qtu0iUvxZQJ6w6uLWBprvjeyiR77A0n+zAyM4l7vnMOLZeeui2YDkbPmZe2+0I4uRb/o7jbt5KazgvT+s13HUSJWXJXAnqbig29zNRMd8hfzKi2HE/oM861CML7yegMby9aB5KzJ4pyfZHEH1gRkGmlrSxgBKFVyu0CQ0DDZD0by4/c2Rcjk3Balj2UsphEUF++TW99+5qKrK6WavIi7dG1G9bVW4f5caCf8ebi88esAHZSdbFDtf0jdvoJ/EztMqRt0vhNKJHToauQSw1GAz2M/GnY5rYhYipRhe/ii7D/AFlA9ZYQwF2yHIz9nPNNnvd78Ud2bYyBpSAJDk9LFOZdxckmJZ0V2zonOD7zxPVxWtvKxwD/W28P2BidaKJjN2TVC8s7J7Qeuh8XBWyifavGcxR1faavtUAEVXxppg9BVNTAujb4Qkp8Y8tWU7Ez5aXpP8JXiKYCL0zkXK3MXJanECq6rE065i3TMqe+/qc2fHhWf3iZHU+iqFc39YbzWuZ/ecFUMxr9FJN2YdBAppTXLjj1KBTA6YM0a6XeXBPqjhcFNj9eDGalBxtuiZ6AbTJ+TncQ= + - secure: ETD97vLiJKubS/Fblo/Nm/hJFjdEtjpO+zaRKzLTl3zsl/eebhp7TYC8zJo+v//f3iApGjKx+6aQYCVhdSOo4cdEQjnnGdTAHIpBfzN9ov74x5rVvuyWmvFLcDyJswHwUAhDoSE0d2/VIK70p+KjPofBN8vo9uluqA651MnDS8C4lwFP8DCgwCkHbp38yzUgrnWWcxpheQJOb/KyY6R8fO5mxPcnkp8vFfB4SgW1DW068xGI+Au14xh7H4o+xnPLVnPzRAyywJEYViVfuENOI2ld6PfCaG/KawsffXX25kWGM0VRlOaVRHYWRm+b/862rhd2a8hiP0D2adTm20ZSnqrTLnCTshcg85GzycXIzV89uMxuhICmgCw0HM0lf8DVqEzHlvKoZTVI4y6+GOEkc+8VTwgFN9v/lXT7dPE/KBRGmb1lxBgjAKX4D7GSvjZ3GXDdDt++fsV+v9pDFCpwN75Gt209xxeBwWrfViqLTpglWStd5rfPOh/Sq87PSr9djLzkGkSAl9iw9i/KVysDft42xz+sEf6qH4HfwYM2e5wj/YVHdMsfEFzEtbrdhRPpWGFFwB9siC48/CskXPmQoA7X0Agz/pbP7IKGvW1//sp2aG+019pwBu/vRN7vYc+xfBPEdyiWNRiRu+vqx86HmfJigddoxfzo79E2S5QprWM= - secure: ZvfQrro2RV7b0kWkl1aRU6s+AW7lKvXj0JuA9xkhWBRYZvRMuK2VOb0oQXiFG7MLM6Wai2BJ1KN/IUi8lnYPtIVtKu6oZEsR5pOD3ZbZeY2/UeKqXu/kzZDcuD62ift/6cf+qO16JgQhf//1Kox3HFrgB9jtHPCVWIIFN9PCv0Y/RgUzxExSIlSndfPJbqgno7QOBuXTkRyr3vIUYHo04Vf7U8d1pPK/OoDiZCBwzLjO541a4DAvB1Mqo6p+S0A8S4U+/TR38zP9nUj+Ew748RlD1Y564DNAmtcSgpFkDb4LaT9rdFL9KxcppzVowKphx8cGW/WxNHl0ea97P/xpnRwuRmgaYyXcGhU7O2dJ99S7mJgVz0HpoWQwp0d3h8lru0J/78i774187Yr3dI76l0wYcfL8VQmiwrQd5dsxDTrBBPiZndVq7DgLO4vwRvc8D3mMoxTxqDxN2uWojg5o8yBP4p1x9YBL0K2w+TYadOmVmLhfKjuoIRMlVC/3wJqj8KtnCOUxPfMV6RLTgvPQ0RHT8h3nZ5GNs6llVehIOSDztlbVBxvTyKy2PxauGDiRBDLlML+XA4wkYRH28IUdsiZUraZf2At9JPJrc5B50xRJjHKEkSgOJZKwk/G71aDwHmj8J8+ii3RHq2SqUGDvKzTZ61LQWjgLoZigVKHd9Dc= From 19ac992525f229809f21e06ef83ff18641e31ecf Mon Sep 17 00:00:00 2001 From: John Torres Date: Thu, 11 Aug 2016 10:41:58 -0400 Subject: [PATCH 009/115] updated access to cluster/api w/o proxy post kube v1.3.2 --- docs/user-guide/accessing-the-cluster.md | 26 ++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/accessing-the-cluster.md b/docs/user-guide/accessing-the-cluster.md index cf15072373..7cfacf0176 100644 --- a/docs/user-guide/accessing-the-cluster.md +++ b/docs/user-guide/accessing-the-cluster.md @@ -69,7 +69,7 @@ $ curl http://localhost:8080/api/ } ``` -#### Without kubectl proxy +#### Without kubectl proxy (before v1.3.x) It is also possible to avoid using kubectl proxy by passing an authentication token directly to the apiserver, like this: @@ -85,7 +85,29 @@ $ curl $APISERVER/api --header "Authorization: Bearer $TOKEN" --insecure } ``` -The above example uses the `--insecure` flag. This leaves it subject to MITM +#### Without kubectl proxy (post v1.3.x) + +In recent versions of Kubernetes, `kubectl config view` no longer displays the token. Use `kubectl describe secret...` to get the token for the default service account, like this: + +``` shell +$ APISERVER=$(kubectl config view | grep server | cut -f 2- -d ":" | tr -d " ") +$ TOKEN=$(kubectl describe secret $(kubectl get secrets | grep default | cut -f1 -d ' ') | grep -E '^token' | cut -f2 -d':' | tr -d '\t') +$ curl $APISERVER/api --header "Authorization: Bearer $TOKEN" --insecure +{ + "kind": "APIVersions", + "versions": [ + "v1" + ], + "serverAddressByClientCIDRs": [ + { + "clientCIDR": "0.0.0.0/0", + "serverAddress": "10.0.1.149:443" + } + ] +} +``` + +The above examples use 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 `~/.kube` directory). Since cluster certificates are typically self-signed, it From c135fa4b4ff6746412de05af4d689e9dd971b7c1 Mon Sep 17 00:00:00 2001 From: Justin Santa Barbara Date: Sat, 20 Aug 2016 11:19:51 -0400 Subject: [PATCH 010/115] Document `network-plugin-mtu` option --- docs/admin/network-plugins.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/admin/network-plugins.md b/docs/admin/network-plugins.md index ee85126961..c0397016da 100644 --- a/docs/admin/network-plugins.md +++ b/docs/admin/network-plugins.md @@ -49,8 +49,23 @@ The plugin requires a few things: * 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. +### Customizing the MTU (with kubenet) + +The MTU should always be configured correctly to get the best networking performance. Network plugins will usually try +to infer a sensible MTU, but sometimes the logic will not result in an optimal MTU. For example, if the +Docker bridge or another interface has a small MTU, kubenet will currently select that MTU. Or if you are +using IPSEC encapsulation, the MTU must be reduced, and this calculation is out-of-scope for +most network plugins. + +Where needed, you can specify the MTU explicitly with the `network-plugin-mtu` kubelet option. For example, +on AWS the `eth0` MTU is typically 9001, so you might specify `--network-plugin-mtu=9001`. If you're using IPSEC you +might reduce it to allow for encapsulation overhead e.g. `--network-plugin-mtu=8873`. + +This option is provided to the network-plugin; currently **only kubenet supports `network-plugin-mtu`**. + ## 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 +* `--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`. +* `--network-plugin-mtu=9001` specifies the MTU to use, currently only used by the `kubenet` network plugin. \ No newline at end of file From ea6d115f4ae8989a37c4f2094fe17987cd4d6d84 Mon Sep 17 00:00:00 2001 From: devin-donnelly Date: Tue, 30 Aug 2016 16:39:55 -0700 Subject: [PATCH 011/115] Update .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 9905f71795..de345e5f59 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ _site/** .sass-cache/** CNAME +.travis.yml From 1b150a5dd046bb9be973cb9163e2721b1d2c932c Mon Sep 17 00:00:00 2001 From: Janet Kuo Date: Tue, 30 Aug 2016 16:47:58 -0700 Subject: [PATCH 012/115] Update .travis.yml --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index cb0cb9e528..0687a2cb1b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,7 +6,7 @@ branches: - release-1.4 script: - cd $HOME -- git config --global user.email ${GIT_EMAIL} +- git config --global user.email "${GIT_EMAIL}" - git config --global user.name "${GIT_NAME}" - git clone https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes-v1-4/kubernetes-v1-4.github.io.git - cd kubernetes-v1-4.github.io From 072bec3b7810bf8d3b164b694cf20e7985e76196 Mon Sep 17 00:00:00 2001 From: Janet Kuo Date: Tue, 30 Aug 2016 17:00:01 -0700 Subject: [PATCH 013/115] Update .travis.yml --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 0687a2cb1b..c6b73a3c52 100644 --- a/.travis.yml +++ b/.travis.yml @@ -8,6 +8,7 @@ script: - cd $HOME - git config --global user.email "${GIT_EMAIL}" - git config --global user.name "${GIT_NAME}" +- git config --global push.default matching - git clone https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes-v1-4/kubernetes-v1-4.github.io.git - cd kubernetes-v1-4.github.io - git remote add --fetch --track release-1.4 homebase "https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes/kubernetes.github.io.git" From 18303ef58b3b095a0a2f19a8039c33a19c69308b Mon Sep 17 00:00:00 2001 From: Janet Kuo Date: Tue, 30 Aug 2016 19:30:52 -0700 Subject: [PATCH 014/115] Remove .travis.yml --- .travis.yml | 22 ---------------------- 1 file changed, 22 deletions(-) delete mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index c6b73a3c52..0000000000 --- a/.travis.yml +++ /dev/null @@ -1,22 +0,0 @@ -language: ruby -rvm: -- 2.1 -branches: - only: - - release-1.4 -script: -- cd $HOME -- git config --global user.email "${GIT_EMAIL}" -- git config --global user.name "${GIT_NAME}" -- git config --global push.default matching -- git clone https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes-v1-4/kubernetes-v1-4.github.io.git -- cd kubernetes-v1-4.github.io -- git remote add --fetch --track release-1.4 homebase "https://${GIT_USERNAME}:${GH_TOKEN}@github.com/kubernetes/kubernetes.github.io.git" -- git merge -s recursive -X theirs homebase/release-1.4 -m "Sync from homebase" -- git push -env: - global: - - secure: VBSiwZ2b2ViA0cu7JXmUuqh4gcFnJY7l3uGUDbVWUV1HOMGSfp0na+ywJmL0Jc80/U7JSV+6ZiR2HlYtLv4DoHW9hdXYyIaTlSQBLAdxvuCgnRLCs459ulBseYzIxCsVqf3hw27ghCcmwB7UOZrxZSStCZMTv2u0tt3Qj95BfKqadU8p9JmtIsLPwAN8+gfhBlTva7HJkaRIijE0hV86fz4AB3PFaZDW2hPMnUW1JkWQTDa9pXTYsUsGAiljLLLupdoCZnaHG8geqmLrfFEuIq9aT2xF9EvZXHyV6ZEihtcF8zOb+hsUTxBo/J3tz+jld/S0cIF/+MzoPsxv+MklZbdAGdGOydbRsNV2Tm9yLRYD0FlpqYeNJh2zolvo5cSe6goroy1fPJhGTlJ6Dc4Ux1fFKITb3w1/LloyaiyaXzlJ/1EKuFrVNyf+juA8wIMqlGfmWG3p2gJADZAM1dPyKu1MCkXG6WqxRKIVqWkqlCM+NLWuJaN5UaJa3L32NR52y0g5wT1ZUTIlC6gpldr9+jQmpb6TBCYlEMnRYrmRKKoWCN0gR0MRkPvX8gUZr/McC1FpKZTlORtck1XVR2RUudRt3gn/Je8yl11ED0xKAW1DRnU3mjKsIsqbAOXorBkGctJsjfYsRx7aLxE/Tl0S/zciIGA4F4/BF5IrVQ4TX7M= - - secure: HbQgpkuS16xxEUiJ42ft629xD51tiLZjAoJVlm9F/9cZnhtWNNmRuM9QU6x2Eq81/5D+pUT+utg7fVrIZ+nQi0iksFK+i/38/h9MKrJ28uslmnGReqOlG8H+HWrxTGcWbuxvh2eJRnkMGO1E/YYKBmo86ExYIymR5vRj/DsY2FY2QLny6l5GbnCaexQmx2DJ0dyTLHlsV8VX329xAqKb2qFeWxUlNLVD8CKuufE2PtUTL9cUb9cBXWf6nmQr8LjUpTFZLRlj3JdvyNW/Ea/xTCBR4ZGMoxzXauyKfj3Qtvb5C2sTWaGQlrkKipIDmS/54ZQJns8hpK0Zq6cgRrfSyO/QXuCPqYYAary1evUVxOXA+ANglRqUVymfOIeMvwE/rCgj/7hgSgtwZmEIuSFuHvd/N0pIYAKdEAVeCizmSywI8WZ8er687oU7Q8Kmrj5HkzINY3JHa/LVjXRXSBtztj09uEb63JwbTbPiTUwl+9lVhTAOj9zG9Sjkk2Ldz7PD20Sec2xS20FuWMKb/RTw48wVxiFhF9jY3OazFTamgs8I1KIvmPIq5sNGTYzWppTunHL2CWW2j7bI++4UAwe1d0Y//IovBEDU6lkTHu0CCHN5H9i7TSklybCA9hYGLlLT4gUwichl/uJeVdfJi3UtlUMZEYmtm2zPpu0JTjsgFQ0= - - secure: ETD97vLiJKubS/Fblo/Nm/hJFjdEtjpO+zaRKzLTl3zsl/eebhp7TYC8zJo+v//f3iApGjKx+6aQYCVhdSOo4cdEQjnnGdTAHIpBfzN9ov74x5rVvuyWmvFLcDyJswHwUAhDoSE0d2/VIK70p+KjPofBN8vo9uluqA651MnDS8C4lwFP8DCgwCkHbp38yzUgrnWWcxpheQJOb/KyY6R8fO5mxPcnkp8vFfB4SgW1DW068xGI+Au14xh7H4o+xnPLVnPzRAyywJEYViVfuENOI2ld6PfCaG/KawsffXX25kWGM0VRlOaVRHYWRm+b/862rhd2a8hiP0D2adTm20ZSnqrTLnCTshcg85GzycXIzV89uMxuhICmgCw0HM0lf8DVqEzHlvKoZTVI4y6+GOEkc+8VTwgFN9v/lXT7dPE/KBRGmb1lxBgjAKX4D7GSvjZ3GXDdDt++fsV+v9pDFCpwN75Gt209xxeBwWrfViqLTpglWStd5rfPOh/Sq87PSr9djLzkGkSAl9iw9i/KVysDft42xz+sEf6qH4HfwYM2e5wj/YVHdMsfEFzEtbrdhRPpWGFFwB9siC48/CskXPmQoA7X0Agz/pbP7IKGvW1//sp2aG+019pwBu/vRN7vYc+xfBPEdyiWNRiRu+vqx86HmfJigddoxfzo79E2S5QprWM= - - secure: ZvfQrro2RV7b0kWkl1aRU6s+AW7lKvXj0JuA9xkhWBRYZvRMuK2VOb0oQXiFG7MLM6Wai2BJ1KN/IUi8lnYPtIVtKu6oZEsR5pOD3ZbZeY2/UeKqXu/kzZDcuD62ift/6cf+qO16JgQhf//1Kox3HFrgB9jtHPCVWIIFN9PCv0Y/RgUzxExSIlSndfPJbqgno7QOBuXTkRyr3vIUYHo04Vf7U8d1pPK/OoDiZCBwzLjO541a4DAvB1Mqo6p+S0A8S4U+/TR38zP9nUj+Ew748RlD1Y564DNAmtcSgpFkDb4LaT9rdFL9KxcppzVowKphx8cGW/WxNHl0ea97P/xpnRwuRmgaYyXcGhU7O2dJ99S7mJgVz0HpoWQwp0d3h8lru0J/78i774187Yr3dI76l0wYcfL8VQmiwrQd5dsxDTrBBPiZndVq7DgLO4vwRvc8D3mMoxTxqDxN2uWojg5o8yBP4p1x9YBL0K2w+TYadOmVmLhfKjuoIRMlVC/3wJqj8KtnCOUxPfMV6RLTgvPQ0RHT8h3nZ5GNs6llVehIOSDztlbVBxvTyKy2PxauGDiRBDLlML+XA4wkYRH28IUdsiZUraZf2At9JPJrc5B50xRJjHKEkSgOJZKwk/G71aDwHmj8J8+ii3RHq2SqUGDvKzTZ61LQWjgLoZigVKHd9Dc= From 4cc1d9041e7b0b2e9bb819fef18f12d3b87b5d29 Mon Sep 17 00:00:00 2001 From: Cole Mickens Date: Wed, 31 Aug 2016 02:32:40 +0000 Subject: [PATCH 015/115] azure: switch to kubernetes-anywhere --- docs/getting-started-guides/azure.md | 170 +-------------------------- 1 file changed, 4 insertions(+), 166 deletions(-) diff --git a/docs/getting-started-guides/azure.md b/docs/getting-started-guides/azure.md index 47050db1c9..a9bcb608ca 100644 --- a/docs/getting-started-guides/azure.md +++ b/docs/getting-started-guides/azure.md @@ -5,170 +5,8 @@ {:toc} -## Prerequisites +## Overview -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. +The recommended approach for deploying a Kubernetes 1.4 cluster on Azure is the +[`kubernetes-anywhere`](https://github.com/kubernetes/kubernetes-anywhere) project. You will want to take a look at the +[Azure Getting Started Guide](https://github.com/kubernetes/kubernetes-anywhere/blob/master/phase1/azure/README.md). From 7debbe4438862d8a181441b9f0e0aff4f4f607c6 Mon Sep 17 00:00:00 2001 From: Janet Kuo Date: Fri, 26 Aug 2016 16:23:16 -0700 Subject: [PATCH 016/115] Create a ref doc for scheduled jobs --- _data/reference.yml | 2 + docs/user-guide/scheduled-jobs.md | 180 ++++++++++++++++++++++++++++++ docs/user-guide/sj.yaml | 18 +++ 3 files changed, 200 insertions(+) create mode 100644 docs/user-guide/scheduled-jobs.md create mode 100644 docs/user-guide/sj.yaml diff --git a/_data/reference.yml b/_data/reference.yml index 939081a971..4c4aa5adcf 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -220,6 +220,8 @@ toc: path: /docs/user-guide/horizontal-pod-autoscaling/ - title: Jobs path: /docs/user-guide/jobs/ + - title: Scheduled Jobs + path: /docs/user-guide/scheduled-jobs/ - title: Resource Quotas path: /docs/admin/resource-quota/ - title: Replica Sets diff --git a/docs/user-guide/scheduled-jobs.md b/docs/user-guide/scheduled-jobs.md new file mode 100644 index 0000000000..b96014a6d1 --- /dev/null +++ b/docs/user-guide/scheduled-jobs.md @@ -0,0 +1,180 @@ +--- +assignees: +- erictune +- soltysh +- janetkuo + +--- + +* TOC +{:toc} + +## What is a _Scheduled Job_? + +A _Scheduled Job_ manages time based [Jobs](/docs/user-guide/jobs/), namely: + +* Once at a specified point in time +* Repeatedly at a specified point in time + +One ScheduledJob object is like one line of a _crontab_ (cron table) file. It runs a job periodically +on a given schedule, written in [Cron](https://en.wikipedia.org/wiki/Cron) format. + +A typical use case is: + +* Schedule a job execution at a given point in time. +* Create a periodic job, e.g. database backup, sending emails. + +### Prerequisites + +You need a working Kubernetes cluster at version >= 1.4, with batch/v2alpha1 API turned on by passing +`--runtime-config=batch/v2alpha1` while bringing up the API server (see [Turn on or off an API version +for your cluster](/docs/admin/cluster-management/#turn-on-or-off-an-api-version-for-your-cluster) for +more). You cannot use Scheduled Jobs on a hosted Kubernetes provider that has disabled alpha resources. + +## Creating a Scheduled Job + +Here is an example Scheduled Job. Every minute, it runs a simple job to print current time and then say +hello. + +{% include code.html language="yaml" file="sj.yaml" ghlink="/docs/user-guide/sj.yaml" %} + +Run the example scheduled job by downloading the example file and then running this command: + +```shell +$ kubectl create -f ./sj.yaml +scheduledjob "hello" created +``` + +Alternatively, use `kubectl run` to create a scheduled job without writing full config: + +```shell +$ kubectl run hello --schedule="0/1 * * * ?" --restart=OnFailure --image=busybox -- /bin/sh -c "date; echo Hello from the Kubernetes cluster" +scheduledjob "hello" created +``` + +After creating the scheduled job, get its status using this command: + +```shell +$ kubectl get scheduledjob hello +NAME SCHEDULE SUSPEND ACTIVE LAST-SCHEDULE +hello 0/1 * * * ? False 0 +``` + +As you can see above, there's no active job yet, and no job has been scheduled, either. + +Watch for the job to be created in around one minute: + +```shell +$ kubectl get jobs --watch +NAME DESIRED SUCCESSFUL AGE +hello-4111706356 1 1 2s +``` + +Now you've seen one running job scheduled by "hello". We can stop watching it and get the scheduled job again: + +```shell +$ kubectl get scheduledjob hello +NAME SCHEDULE SUSPEND ACTIVE LAST-SCHEDULE +hello 0/1 * * * ? False 0 Mon, 29 Aug 2016 14:34:00 -0700 +``` + +You should see that "hello" successfully scheduled a job at the time specified in `LAST-SCHEDULE`. There are +currently 0 active jobs, meaning that the job that's scheduled is completed or failed. + +Now, find the pods created by the job last scheduled and view the standard output of one of the pods. Note that +your job name and pod name would be different. + +```shell +# Replace "hello-4111706356" with the job name in your system +$ pods=$(kubectl get pods --selector=job-name=hello-4111706356 --output=jsonpath={.items..metadata.name}) + +$ echo $pods +hello-4111706356-o9qcm + +$ kubectl logs $pods +Mon Aug 29 21:34:09 UTC 2016 +Hello from the Kubernetes cluster +``` + +## Deleting a Scheduled Job + +Once you don't need a scheduled job anymore, simply delete it with `kubectl`: + +```shell +$ kubectl delete scheduledjob hello +scheduledjob "hello" deleted +``` + +This stops new jobs from being created. However, running jobs won't be stopped, and no jobs or their pods will +be deleted. To clean up those jobs and pods, you need to list all jobs created by the scheduled job, and delete them all: + +```shell +$ kubectl get jobs +NAME DESIRED SUCCESSFUL AGE +hello-1201907962 1 1 11m +hello-1202039034 1 1 8m +... + +$ kubectl delete jobs hello-1201907962 hello-1202039034 ... +job "hello-1201907962" deleted +job "hello-1202039034" deleted +... +``` + +Once the jobs are deleted, the pods created by them are deleted as well. Note that all jobs created by scheduled +job "hello" will be prefixed "hello-". You can delete them at once with `kubectl delete jobs --all`, if you want to +delete all jobs in the current namespace (not just the ones created by "hello".) + +## Scheduled Job Limitations + +A scheduled job creates a job object _about_ once per execution time of its schedule. We say "about" because there +are certain circumstances where two jobs might be created, or no job might be created. We attempt to make these rare, +but do not completely prevent them. Therefore, jobs should be _idempotent_. + +The job is responsible for retrying pods, parallelism among pods it creates, and determining the success or failure +of the set of pods. A scheduled job does not examine pods at all. + +## Writing a Scheduled Job Spec + +As with all other Kubernetes configs, a scheduled job needs `apiVersion`, `kind`, and `metadata` fields. For general +information about working with config files, see [deploying applications](/docs/user-guide/deploying-applications), +[configuring containers](/docs/user-guide/configuring-containers), and +[using kubectl to manage resources](/docs/user-guide/working-with-resources) documents. + +A scheduled job also needs a [`.spec` section](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/docs/devel/api-conventions.md#spec-and-status). + +**Note:** All modifications to a scheduled job, especially its `.spec`, will be applied only to the next run. + +### Schedule + +The `.spec.schedule` is a required field of the `.spec`. It takes a [Cron](https://en.wikipedia.org/wiki/Cron) format +string, e.g. `0 * * * *` or `@hourly`, as schedule time of its jobs to be created and executed. + +### Job Template + +The `.spec.jobTemplate` is another required field of the `.spec`. It is a job template. It has exactly the same schema +as a [Job](/docs/user-guide/jobs), except it is nested and does not have an `apiVersion` or `kind`, see +[Writing a Job Spec](/docs/user-guide/jobs/#writing-a-job-spec). + +### Starting Deadline Seconds + +The `.spec.startingDeadlineSeconds` field is optional. It stands for the deadline (in seconds) for starting the job +if it misses its scheduled time for any reason. Missed jobs executions will be counted as failed ones. If not specified, +there's no deadline. + +### Concurrency Policy + +The `.spec.concurrencyPolicy` field is also optional. It specifies how to treat concurrent executions of a job +created by this scheduled job. Only one of the following concurrent policies may be specified: + +* `Allow` (default): allows concurrently running jobs +* `Forbid`: forbids concurrent runs, skipping next run if previous hasn't finished yet +* `Replace`: cancels currently running job and replaces it with a new one + +Note that concurrency policy only applies to the jobs created by the same scheduled job. If there are multiple +scheduled jobs, their respective jobs are always allowed to run concurrently. + +### Suspend + +The `.spec.suspend` field is also optional. If set to `true`, all subsequent executions will be suspended. It does not +apply to already started executions. Defaults to false. diff --git a/docs/user-guide/sj.yaml b/docs/user-guide/sj.yaml new file mode 100644 index 0000000000..1b22b7f340 --- /dev/null +++ b/docs/user-guide/sj.yaml @@ -0,0 +1,18 @@ +apiVersion: batch/v2alpha1 +kind: ScheduledJob +metadata: + name: hello +spec: + schedule: 0/1 * * * ? + jobTemplate: + spec: + template: + spec: + containers: + - name: hello + image: busybox + args: + - /bin/sh + - -c + - date; echo Hello from the Kubernetes cluster + restartPolicy: OnFailure From 2cbb01681055ba24533581e4967340caa394f5a0 Mon Sep 17 00:00:00 2001 From: nikhiljindal Date: Wed, 31 Aug 2016 17:15:52 -0700 Subject: [PATCH 017/115] Updating update-imported-docs.sh --- _data/overrides.yml | 9 +++++---- update-imported-docs.sh | 3 +-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/_data/overrides.yml b/_data/overrides.yml index ef820044e9..2506ba82f7 100644 --- a/_data/overrides.yml +++ b/_data/overrides.yml @@ -8,10 +8,11 @@ overrides: - 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.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 +- path: federation/docs/api-reference +- changedpath: docs/api-reference/extensions/v1beta1/definitions.html _includes/v1.4/extensions-v1beta1-definitions.html +- changedpath: docs/api-reference/extensions/v1beta1/operations.html _includes/v1.4/extensions-v1beta1-operations.html +- changedpath: docs/api-reference/v1/definitions.html _includes/v1.4/v1-definitions.html +- changedpath: docs/api-reference/v1/operations.html _includes/v1.4/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/update-imported-docs.sh b/update-imported-docs.sh index e560266646..0a3bfa4f39 100755 --- a/update-imported-docs.sh +++ b/update-imported-docs.sh @@ -3,14 +3,13 @@ # Uncomment this to see the commands as they are run # set -x -VERSION=1.3 +VERSION=1.4 git clone --depth=1 -b release-$VERSION https://github.com/kubernetes/kubernetes.git k8s cd k8s 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 .. From caa3d8c8e38b506b48d97475a19707c9eb123e28 Mon Sep 17 00:00:00 2001 From: nikhiljindal Date: Fri, 2 Sep 2016 16:09:21 -0700 Subject: [PATCH 018/115] Updating docs by running update-imported-docs.sh --- .../v1.4/extensions-v1beta1-definitions.html | 6335 +++ .../v1.4/extensions-v1beta1-operations.html | 16848 ++++++++ _includes/v1.4/v1-definitions.html | 8087 ++++ _includes/v1.4/v1-operations.html | 32451 ++++++++++++++++ docs/admin/federation-apiserver.md | 123 +- docs/admin/federation-controller-manager.md | 40 +- docs/admin/kube-apiserver.md | 156 +- docs/admin/kube-controller-manager.md | 133 +- docs/admin/kube-proxy.md | 55 +- docs/admin/kube-scheduler.md | 45 +- docs/admin/kubelet.md | 213 +- docs/api-reference/README.md | 8 +- .../autoscaling/v1/definitions.html | 75 +- .../autoscaling/v1/operations.html | 44 +- docs/api-reference/batch/v1/definitions.html | 422 +- docs/api-reference/batch/v1/operations.html | 44 +- .../certificates/v1alpha1/definitions.html | 966 + .../certificates/v1alpha1/operations.html | 1527 + .../extensions/v1beta1/definitions.html | 689 +- .../extensions/v1beta1/definitions.md | 2 +- .../extensions/v1beta1/operations.html | 1921 +- .../extensions/v1beta1/operations.md | 2 +- docs/api-reference/v1/definitions.html | 875 +- docs/api-reference/v1/definitions.md | 2 +- docs/api-reference/v1/operations.html | 14178 +++---- docs/api-reference/v1/operations.md | 2 +- docs/getting-started-guides/fluentd-gcp.yaml | 2 +- docs/user-guide/kubectl/kubectl.md | 117 +- docs/user-guide/kubectl/kubectl_annotate.md | 80 +- .../kubectl/kubectl_api-versions.md | 51 +- docs/user-guide/kubectl/kubectl_apply.md | 66 +- docs/user-guide/kubectl/kubectl_attach.md | 56 +- docs/user-guide/kubectl/kubectl_autoscale.md | 89 +- .../kubectl/kubectl_cluster-info.md | 51 +- .../kubectl/kubectl_cluster-info_dump.md | 61 +- docs/user-guide/kubectl/kubectl_completion.md | 55 +- docs/user-guide/kubectl/kubectl_config.md | 59 +- .../kubectl/kubectl_config_current-context.md | 51 +- .../kubectl/kubectl_config_delete-cluster.md | 56 + .../kubectl/kubectl_config_delete-context.md | 56 + .../kubectl/kubectl_config_get-clusters.md | 56 + .../kubectl/kubectl_config_get-contexts.md | 73 + .../kubectl/kubectl_config_set-cluster.md | 57 +- .../kubectl/kubectl_config_set-context.md | 51 +- .../kubectl/kubectl_config_set-credentials.md | 66 +- docs/user-guide/kubectl/kubectl_config_set.md | 54 +- .../kubectl/kubectl_config_unset.md | 52 +- .../kubectl/kubectl_config_use-context.md | 49 +- .../user-guide/kubectl/kubectl_config_view.md | 77 +- docs/user-guide/kubectl/kubectl_convert.md | 75 +- docs/user-guide/kubectl/kubectl_cordon.md | 49 +- docs/user-guide/kubectl/kubectl_create.md | 76 +- .../kubectl/kubectl_create_configmap.md | 91 +- .../kubectl/kubectl_create_deployment.md | 83 + .../kubectl/kubectl_create_namespace.md | 78 +- .../kubectl/kubectl_create_quota.md | 86 + .../kubectl/kubectl_create_secret.md | 55 +- .../kubectl_create_secret_docker-registry.md | 90 +- .../kubectl/kubectl_create_secret_generic.md | 94 +- .../kubectl/kubectl_create_secret_tls.md | 84 +- .../kubectl/kubectl_create_service.md | 59 + .../kubectl_create_service_clusterip.md | 87 + .../kubectl_create_service_loadbalancer.md | 83 + .../kubectl_create_service_nodeport.md | 83 + .../kubectl/kubectl_create_serviceaccount.md | 80 +- docs/user-guide/kubectl/kubectl_delete.md | 73 +- docs/user-guide/kubectl/kubectl_describe.md | 94 +- docs/user-guide/kubectl/kubectl_drain.md | 59 +- docs/user-guide/kubectl/kubectl_edit.md | 79 +- docs/user-guide/kubectl/kubectl_exec.md | 60 +- docs/user-guide/kubectl/kubectl_explain.md | 86 +- docs/user-guide/kubectl/kubectl_expose.md | 102 +- docs/user-guide/kubectl/kubectl_get.md | 119 +- docs/user-guide/kubectl/kubectl_label.md | 81 +- docs/user-guide/kubectl/kubectl_logs.md | 68 +- docs/user-guide/kubectl/kubectl_namespace.md | 54 +- docs/user-guide/kubectl/kubectl_options.md | 56 + docs/user-guide/kubectl/kubectl_patch.md | 74 +- .../kubectl/kubectl_port-forward.md | 51 +- docs/user-guide/kubectl/kubectl_proxy.md | 71 +- docs/user-guide/kubectl/kubectl_replace.md | 77 +- .../kubectl/kubectl_rolling-update.md | 91 +- docs/user-guide/kubectl/kubectl_rollout.md | 57 +- .../kubectl/kubectl_rollout_history.md | 59 +- .../kubectl/kubectl_rollout_pause.md | 55 +- .../kubectl/kubectl_rollout_resume.md | 55 +- .../kubectl/kubectl_rollout_status.md | 55 +- .../kubectl/kubectl_rollout_undo.md | 59 +- docs/user-guide/kubectl/kubectl_run.md | 119 +- docs/user-guide/kubectl/kubectl_scale.md | 69 +- docs/user-guide/kubectl/kubectl_set.md | 48 +- docs/user-guide/kubectl/kubectl_set_image.md | 75 +- docs/user-guide/kubectl/kubectl_taint.md | 83 +- docs/user-guide/kubectl/kubectl_top-node.md | 14 + docs/user-guide/kubectl/kubectl_top-pod.md | 14 + docs/user-guide/kubectl/kubectl_top.md | 61 + docs/user-guide/kubectl/kubectl_top_node.md | 76 + docs/user-guide/kubectl/kubectl_top_pod.md | 87 + docs/user-guide/kubectl/kubectl_uncordon.md | 49 +- docs/user-guide/kubectl/kubectl_version.md | 53 +- .../extensions/v1beta1/definitions.html | 4820 +++ .../extensions/v1beta1/operations.html | 4687 +++ .../federation/v1beta1/definitions.html | 1409 + .../federation/v1beta1/operations.html | 1760 + .../docs/api-reference/v1/definitions.html | 2054 + .../docs/api-reference/v1/operations.html | 7019 ++++ 106 files changed, 101651 insertions(+), 10362 deletions(-) create mode 100755 _includes/v1.4/extensions-v1beta1-definitions.html create mode 100755 _includes/v1.4/extensions-v1beta1-operations.html create mode 100755 _includes/v1.4/v1-definitions.html create mode 100755 _includes/v1.4/v1-operations.html create mode 100755 docs/api-reference/certificates/v1alpha1/definitions.html create mode 100755 docs/api-reference/certificates/v1alpha1/operations.html create mode 100644 docs/user-guide/kubectl/kubectl_config_delete-cluster.md create mode 100644 docs/user-guide/kubectl/kubectl_config_delete-context.md create mode 100644 docs/user-guide/kubectl/kubectl_config_get-clusters.md create mode 100644 docs/user-guide/kubectl/kubectl_config_get-contexts.md create mode 100644 docs/user-guide/kubectl/kubectl_create_deployment.md create mode 100644 docs/user-guide/kubectl/kubectl_create_quota.md create mode 100644 docs/user-guide/kubectl/kubectl_create_service.md create mode 100644 docs/user-guide/kubectl/kubectl_create_service_clusterip.md create mode 100644 docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md create mode 100644 docs/user-guide/kubectl/kubectl_create_service_nodeport.md create mode 100644 docs/user-guide/kubectl/kubectl_options.md create mode 100644 docs/user-guide/kubectl/kubectl_top-node.md create mode 100644 docs/user-guide/kubectl/kubectl_top-pod.md create mode 100644 docs/user-guide/kubectl/kubectl_top.md create mode 100644 docs/user-guide/kubectl/kubectl_top_node.md create mode 100644 docs/user-guide/kubectl/kubectl_top_pod.md create mode 100755 federation/docs/api-reference/extensions/v1beta1/definitions.html create mode 100755 federation/docs/api-reference/extensions/v1beta1/operations.html create mode 100755 federation/docs/api-reference/federation/v1beta1/definitions.html create mode 100755 federation/docs/api-reference/federation/v1beta1/operations.html create mode 100755 federation/docs/api-reference/v1/definitions.html create mode 100755 federation/docs/api-reference/v1/operations.html diff --git a/_includes/v1.4/extensions-v1beta1-definitions.html b/_includes/v1.4/extensions-v1beta1-definitions.html new file mode 100755 index 0000000000..59be34cd40 --- /dev/null +++ b/_includes/v1.4/extensions-v1beta1-definitions.html @@ -0,0 +1,6335 @@ + + + + + + +Top Level API Objects + + + +
+ +
+

Definitions

+
+
+

v1beta1.DeploymentStatus

+
+

DeploymentStatus is the most recently observed status of the Deployment.

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

observedGeneration

The generation observed by the deployment controller.

false

integer (int64)

replicas

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

false

integer (int32)

updatedReplicas

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

false

integer (int32)

availableReplicas

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

false

integer (int32)

unavailableReplicas

Total number of unavailable pods targeted by this deployment.

false

integer (int32)

+ +
+
+

v1beta1.DaemonSetStatus

+
+

DaemonSetStatus represents the current status of a daemon set.

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

currentNumberScheduled

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

true

integer (int32)

numberMisscheduled

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

true

integer (int32)

desiredNumberScheduled

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

true

integer (int32)

+ +
+
+

v1beta1.Job

+
+

Job represents the configuration of a single job.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1beta1.JobSpec

status

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

false

v1beta1.JobStatus

+ +
+
+

v1.Preconditions

+
+

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

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

uid

Specifies the target UID.

false

types.UID

+ +
+
+

v1.ObjectFieldSelector

+
+

ObjectFieldSelector selects an APIVersioned field of an object.

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

apiVersion

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

false

string

fieldPath

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

true

string

+ +
+
+

v1.SELinuxOptions

+
+

SELinuxOptions are the labels to be applied to the container

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

user

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

false

string

role

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

false

string

type

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

false

string

level

Level is SELinux level label that applies to the container.

false

string

+ +
+
+

v1.VolumeMount

+
+

VolumeMount describes a mounting of a Volume within a container.

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

name

This must match the Name of a Volume.

true

string

readOnly

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

false

boolean

false

mountPath

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

true

string

subPath

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

false

string

+ +
+
+

v1beta1.IngressSpec

+
+

IngressSpec describes the Ingress the user wishes to exist.

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

backend

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

false

v1beta1.IngressBackend

tls

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

false

v1beta1.IngressTLS array

rules

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

false

v1beta1.IngressRule array

+ +
+
+

v1beta1.IngressBackend

+
+

IngressBackend describes all endpoints for a given service and port.

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

serviceName

Specifies the name of the referenced service.

true

string

servicePort

Specifies the port of the referenced service.

true

string

+ +
+
+

v1beta1.ReplicaSetList

+
+

ReplicaSetList is a collection of ReplicaSets.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

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

true

v1beta1.ReplicaSet array

+ +
+
+

v1.CephFSVolumeSource

+
+

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

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

monitors

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

true

string array

path

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

false

string

user

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

false

string

secretFile

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

+ +
+
+

v1beta1.IngressStatus

+
+

IngressStatus describe the current state of the Ingress.

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

loadBalancer

LoadBalancer contains the current status of the load-balancer.

false

v1.LoadBalancerStatus

+ +
+
+

v1.DownwardAPIVolumeSource

+
+

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

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

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

+ +
+
+

unversioned.StatusCause

+
+

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

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

reason

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

false

string

message

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

false

string

field

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

false

string

+ +
+
+

v1beta1.NetworkPolicyList

+
+

Network Policy List is a list of NetworkPolicy objects.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

Items is a list of schema objects.

true

v1beta1.NetworkPolicy array

+ +
+
+

v1.GCEPersistentDiskVolumeSource

+
+

Represents a Persistent Disk resource in Google Compute Engine.

+
+
+

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

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

pdName

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

true

string

fsType

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

false

string

partition

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

false

integer (int32)

readOnly

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

false

boolean

false

+ +
+
+

v1beta1.RollingUpdateDeployment

+
+

Spec to control the desired behavior of rolling update.

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

maxUnavailable

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

false

string

maxSurge

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

false

string

+ +
+
+

v1beta1.HTTPIngressRuleValue

+
+

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

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

paths

A collection of paths that map requests to backends.

true

v1beta1.HTTPIngressPath array

+ +
+
+

v1.ConfigMapVolumeSource

+
+

Adapts a ConfigMap into a volume.

+
+
+

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

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

name

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

false

string

items

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

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

+ +
+
+

v1.GitRepoVolumeSource

+
+

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

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

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

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

false

string

+ +
+
+

*versioned.Event

+ +
+
+

v1beta1.JobStatus

+
+

JobStatus represents the current state of a Job.

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

conditions

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

false

v1beta1.JobCondition array

startTime

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

false

string (date-time)

completionTime

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

false

string (date-time)

active

Active is the number of actively running pods.

false

integer (int32)

succeeded

Succeeded is the number of pods which reached Phase Succeeded.

false

integer (int32)

failed

Failed is the number of pods which reached Phase Failed.

false

integer (int32)

+ +
+
+

v1.Capabilities

+
+

Adds and removes POSIX capabilities from running containers.

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

add

Added capabilities

false

v1.Capability array

drop

Removed capabilities

false

v1.Capability array

+ +
+
+

v1.LocalObjectReference

+
+

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

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

name

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

false

string

+ +
+
+

v1beta1.StorageClass

+
+

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

+
+
+

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

provisioner

Provisioner indicates the type of the provisioner.

true

string

parameters

Parameters holds the parameters for the provisioner that should create volumes of this storage class.

false

object

+ +
+
+

v1.ExecAction

+
+

ExecAction describes a "run in container" action.

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

command

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

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

false

string array

+ +
+
+

v1.ObjectMeta

+
+

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

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

name

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

false

string

generateName

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

false

string

namespace

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

false

string

selfLink

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

false

string

uid

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

false

string

resourceVersion

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

false

string

generation

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

false

integer (int64)

creationTimestamp

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

false

string (date-time)

deletionTimestamp

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

false

string (date-time)

deletionGracePeriodSeconds

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

false

integer (int64)

labels

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

false

object

annotations

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

false

object

ownerReferences

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

false

v1.OwnerReference array

finalizers

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

false

string array

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

false

string

+ +
+
+

v1beta1.ReplicaSetSpec

+
+

ReplicaSetSpec is the specification of a ReplicaSet.

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

replicas

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

false

integer (int32)

selector

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

false

v1beta1.LabelSelector

template

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

false

v1.PodTemplateSpec

+ +
+
+

v1beta1.DaemonSetSpec

+
+

DaemonSetSpec is the specification of a daemon set.

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

selector

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

false

v1beta1.LabelSelector

template

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

true

v1.PodTemplateSpec

+ +
+
+

v1beta1.Deployment

+
+

Deployment enables declarative updates for Pods and ReplicaSets.

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

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object metadata.

false

v1.ObjectMeta

spec

Specification of the desired behavior of the Deployment.

false

v1beta1.DeploymentSpec

status

Most recently observed status of the Deployment.

false

v1beta1.DeploymentStatus

+ +
+
+

v1.AzureFileVolumeSource

+
+

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

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

secretName

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

true

string

shareName

Share Name

true

string

readOnly

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

false

boolean

false

+ +
+
+

types.UID

+ +
+
+

v1.ISCSIVolumeSource

+
+

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

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

targetPortal

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

true

string

iqn

Target iSCSI Qualified Name.

true

string

lun

iSCSI target lun number.

true

integer (int32)

iscsiInterface

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

false

string

fsType

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

false

string

readOnly

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

false

boolean

false

+ +
+
+

v1.EmptyDirVolumeSource

+
+

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

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

medium

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

false

string

+ +
+
+

v1beta1.IngressList

+
+

IngressList is a collection of Ingress.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

Items is the list of Ingress.

true

v1beta1.Ingress array

+ +
+
+

v1beta1.ScaleSpec

+
+

describes the attributes of a scale subresource

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

replicas

desired number of instances for the scaled object.

false

integer (int32)

+ +
+
+

unversioned.Patch

+
+

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

+
+
+
+

v1beta1.StorageClassList

+
+

StorageClassList is a collection of storage classes.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

Items is the list of StorageClasses

true

v1beta1.StorageClass array

+ +
+
+

v1.FlockerVolumeSource

+
+

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

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

datasetName

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

true

string

+ +
+
+

v1.PersistentVolumeClaimVolumeSource

+
+

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

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

claimName

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

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

+ +
+
+

unversioned.ListMeta

+
+

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

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

selfLink

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

false

string

resourceVersion

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

false

string

+ +
+
+

v1beta1.HorizontalPodAutoscaler

+
+

configuration of a horizontal pod autoscaler.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1beta1.HorizontalPodAutoscalerSpec

status

current information about the autoscaler.

false

v1beta1.HorizontalPodAutoscalerStatus

+ +
+
+

v1beta1.RollbackConfig

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

revision

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

false

integer (int64)

+ +
+
+

v1.SecretVolumeSource

+
+

Adapts a Secret into a volume.

+
+
+

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

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

secretName

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

false

string

items

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

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

+ +
+
+

v1.EnvVarSource

+
+

EnvVarSource represents a source for the value of an EnvVar.

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

fieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

false

v1.ObjectFieldSelector

resourceFieldRef

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

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

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

false

v1.SecretKeySelector

+ +
+
+

v1.FlexVolumeSource

+
+

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

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

driver

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

true

string

fsType

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

options

Optional: Extra command options if any.

false

object

+ +
+
+

v1beta1.JobCondition

+
+

JobCondition describes current state of a job.

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

type

Type of job condition, Complete or Failed.

true

string

status

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

true

string

lastProbeTime

Last time the condition was checked.

false

string (date-time)

lastTransitionTime

Last time the condition transit from one status to another.

false

string (date-time)

reason

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

false

string

message

Human readable message indicating details about last transition.

false

string

+ +
+
+

v1.LoadBalancerIngress

+
+

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

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

ip

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

false

string

hostname

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

false

string

+ +
+
+

v1beta1.APIVersion

+
+

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

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

name

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

false

string

+ +
+
+

v1.AzureDiskVolumeSource

+
+

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

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

diskName

The Name of the data disk in the blob storage

true

string

diskURI

The URI the data disk in the blob storage

true

string

cachingMode

Host Caching mode: None, Read Only, Read Write.

false

v1.AzureDataDiskCachingMode

fsType

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

false

string

readOnly

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

false

boolean

false

+ +
+
+

v1.KeyToPath

+
+

Maps a string key to a path within a volume.

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

key

The key to project.

true

string

path

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

true

string

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

+ +
+
+

v1.VsphereVirtualDiskVolumeSource

+
+

Represents a vSphere volume resource.

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

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

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

false

string

+ +
+
+

v1.DeleteOptions

+
+

DeleteOptions may be provided when deleting an API object

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

kind

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

false

string

apiVersion

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

false

string

gracePeriodSeconds

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

false

integer (int64)

preconditions

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

false

v1.Preconditions

orphanDependents

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

false

boolean

false

+ +
+
+

v1.Volume

+
+

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

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

name

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

true

string

hostPath

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

false

v1.HostPathVolumeSource

emptyDir

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

false

v1.EmptyDirVolumeSource

gcePersistentDisk

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

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

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

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

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

false

v1.SecretVolumeSource

nfs

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

false

v1.NFSVolumeSource

iscsi

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

false

v1.ISCSIVolumeSource

glusterfs

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

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

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

false

v1.PersistentVolumeClaimVolumeSource

rbd

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

false

v1.RBDVolumeSource

flexVolume

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

false

v1.FlexVolumeSource

cinder

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

false

v1.CinderVolumeSource

cephfs

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

false

v1.CephFSVolumeSource

flocker

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

false

v1.FlockerVolumeSource

downwardAPI

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

false

v1.DownwardAPIVolumeSource

fc

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

false

v1.FCVolumeSource

azureFile

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

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

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

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

+ +
+
+

v1beta1.DaemonSetList

+
+

DaemonSetList is a collection of daemon sets.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

Items is a list of daemon sets.

true

v1beta1.DaemonSet array

+ +
+
+

v1.ResourceFieldSelector

+
+

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

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

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

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

false

string

+ +
+
+

v1.Probe

+
+

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

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

exec

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

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

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

false

v1.TCPSocketAction

initialDelaySeconds

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

false

integer (int32)

timeoutSeconds

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

false

integer (int32)

periodSeconds

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

false

integer (int32)

successThreshold

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

false

integer (int32)

failureThreshold

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

false

integer (int32)

+ +
+
+

v1beta1.DeploymentSpec

+
+

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

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

replicas

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

false

integer (int32)

selector

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

false

v1beta1.LabelSelector

template

Template describes the pods that will be created.

true

v1.PodTemplateSpec

strategy

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

false

v1beta1.DeploymentStrategy

minReadySeconds

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

false

integer (int32)

revisionHistoryLimit

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

false

integer (int32)

paused

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

false

boolean

false

rollbackTo

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

false

v1beta1.RollbackConfig

+ +
+
+

unversioned.APIResourceList

+
+

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

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

kind

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

false

string

apiVersion

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

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

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

true

unversioned.APIResource array

+ +
+
+

v1.SecretKeySelector

+
+

SecretKeySelector selects a key of a Secret.

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

name

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

false

string

key

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

true

string

+ +
+
+

v1.Capability

+ +
+
+

unversioned.APIResource

+
+

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

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

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

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

true

string

+ +
+
+

v1.DownwardAPIVolumeFile

+
+

DownwardAPIVolumeFile represents information to create the file containing the pod field

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

path

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

true

string

fieldRef

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

false

v1.ObjectFieldSelector

resourceFieldRef

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

false

v1.ResourceFieldSelector

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

+ +
+
+

v1.ContainerPort

+
+

ContainerPort represents a network port in a single container.

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

name

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

false

string

hostPort

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

false

integer (int32)

containerPort

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

true

integer (int32)

protocol

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

false

string

hostIP

What host IP to bind the external port to.

false

string

+ +
+
+

v1.PodSpec

+
+

PodSpec is a description of a pod.

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

volumes

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

false

v1.Volume array

containers

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

true

v1.Container array

restartPolicy

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

false

string

terminationGracePeriodSeconds

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

false

integer (int64)

activeDeadlineSeconds

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

false

integer (int64)

dnsPolicy

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

false

string

nodeSelector

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

false

object

serviceAccountName

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

false

string

serviceAccount

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

false

string

nodeName

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

false

string

hostNetwork

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

false

boolean

false

hostPID

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

false

boolean

false

hostIPC

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

false

boolean

false

securityContext

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

false

v1.PodSecurityContext

imagePullSecrets

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

false

v1.LocalObjectReference array

hostname

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

false

string

subdomain

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

false

string

+ +
+
+

v1.Lifecycle

+
+

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

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

postStart

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

false

v1.Handler

preStop

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

false

v1.Handler

+ +
+
+

v1.GlusterfsVolumeSource

+
+

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

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

endpoints

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

true

string

path

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

true

string

readOnly

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

false

boolean

false

+ +
+
+

v1.Handler

+
+

Handler defines a specific action that should be taken

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

exec

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

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

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

false

v1.TCPSocketAction

+ +
+
+

v1beta1.IngressTLS

+
+

IngressTLS describes the transport layer security associated with an Ingress.

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

hosts

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

false

string array

secretName

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

false

string

+ +
+
+

v1beta1.SubresourceReference

+
+

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

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

kind

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

false

string

name

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

false

string

apiVersion

API version of the referent

false

string

subresource

Subresource name of the referent

false

string

+ +
+
+

v1beta1.Scale

+
+

represents a scaling request for a resource.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1beta1.ScaleSpec

status

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

false

v1beta1.ScaleStatus

+ +
+
+

v1.RBDVolumeSource

+
+

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

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

monitors

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

true

string array

image

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

true

string

fsType

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

false

string

pool

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

false

string

user

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

false

string

keyring

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

+ +
+
+

v1beta1.NetworkPolicy

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

Specification of the desired behavior for this NetworkPolicy.

false

v1beta1.NetworkPolicySpec

+ +
+
+

v1beta1.ScaleStatus

+
+

represents the current status of a scale subresource.

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

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

selector

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

false

object

targetSelector

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

false

string

+ +
+
+

v1beta1.NetworkPolicySpec

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

podSelector

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

true

v1beta1.LabelSelector

ingress

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

false

v1beta1.NetworkPolicyIngressRule array

+ +
+
+

v1.NFSVolumeSource

+
+

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

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

server

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

true

string

path

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

true

string

readOnly

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

false

boolean

false

+ +
+
+

v1beta1.DeploymentList

+
+

DeploymentList is a list of Deployments.

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

kind

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

false

string

apiVersion

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

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

Items is the list of Deployments.

true

v1beta1.Deployment array

+ +
+
+

v1beta1.DeploymentRollback

+
+

DeploymentRollback stores the information required to rollback a deployment.

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

kind

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

false

string

apiVersion

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

false

string

name

Required: This must match the Name of a deployment.

true

string

updatedAnnotations

The annotations to be updated to a deployment

false

object

rollbackTo

The config of this deployment rollback.

true

v1beta1.RollbackConfig

+ +
+
+

v1.HTTPHeader

+
+

HTTPHeader describes a custom header to be used in HTTP probes

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

name

The header field name

true

string

value

The header field value

true

string

+ +
+
+

v1beta1.HorizontalPodAutoscalerStatus

+
+

current status of a horizontal pod autoscaler

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

observedGeneration

most recent generation observed by this autoscaler.

false

integer (int64)

lastScaleTime

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

false

string (date-time)

currentReplicas

current number of replicas of pods managed by this autoscaler.

true

integer (int32)

desiredReplicas

desired number of replicas of pods managed by this autoscaler.

true

integer (int32)

currentCPUUtilizationPercentage

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

false

integer (int32)

+ +
+
+

v1.FCVolumeSource

+
+

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

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

targetWWNs

Required: FC target worldwide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

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

false

string

readOnly

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

false

boolean

false

+ +
+
+

v1beta1.ThirdPartyResource

+
+

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

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

kind

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

false

string

apiVersion

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

false

string

metadata

Standard object metadata

false

v1.ObjectMeta

description

Description is the description of this object.

false

string

versions

Versions are versions for this third party object

false

v1beta1.APIVersion array

+ +
+
+

v1.TCPSocketAction

+
+

TCPSocketAction describes an action based on opening a socket

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

port

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

true

string

+ +
+
+

v1beta1.DeploymentStrategy

+
+

DeploymentStrategy describes how to replace existing pods with new ones.

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

type

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

false

string

rollingUpdate

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

false

v1beta1.RollingUpdateDeployment

+ +
+
+

v1beta1.IngressRule

+
+

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

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

host

Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the
+ IP in the Spec of the parent Ingress.
+2. The : delimiter is not respected because ports are not allowed.
+ Currently the port of an Ingress is implicitly :80 for http and
+ :443 for https.
+Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.

false

string

http

false

v1beta1.HTTPIngressRuleValue

+ +
+
+

v1beta1.JobList

+
+

JobList is a collection of jobs.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

Items is the list of Job.

true

v1beta1.Job array

+ +
+
+

v1beta1.NetworkPolicyPeer

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

podSelector

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

false

v1beta1.LabelSelector

namespaceSelector

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

false

v1beta1.LabelSelector

+ +
+
+

unversioned.StatusDetails

+
+

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

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

name

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

false

string

group

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

false

string

kind

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

false

string

causes

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

false

unversioned.StatusCause array

retryAfterSeconds

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

false

integer (int32)

+ +
+
+

v1.HTTPGetAction

+
+

HTTPGetAction describes an action based on HTTP Get requests.

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

path

Path to access on the HTTP server.

false

string

port

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

true

string

host

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

false

string

scheme

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

false

string

httpHeaders

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

false

v1.HTTPHeader array

+ +
+
+

v1beta1.CPUTargetUtilization

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

targetPercentage

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

true

integer (int32)

+ +
+
+

v1.LoadBalancerStatus

+
+

LoadBalancerStatus represents the status of a load-balancer.

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

ingress

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

false

v1.LoadBalancerIngress array

+ +
+
+

v1.Container

+
+

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

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

name

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

true

string

image

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

false

string

command

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

false

string array

args

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

false

string array

workingDir

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

false

string

ports

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

false

v1.ContainerPort array

env

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

false

v1.EnvVar array

resources

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

false

v1.ResourceRequirements

volumeMounts

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

false

v1.VolumeMount array

livenessProbe

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

false

v1.Probe

readinessProbe

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

false

v1.Probe

lifecycle

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

false

v1.Lifecycle

terminationMessagePath

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

false

string

imagePullPolicy

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

false

string

securityContext

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

false

v1.SecurityContext

stdin

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

false

boolean

false

stdinOnce

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

false

boolean

false

tty

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

false

boolean

false

+ +
+
+

v1.PodSecurityContext

+
+

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

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

seLinuxOptions

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

false

v1.SELinuxOptions

runAsUser

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

false

integer (int64)

runAsNonRoot

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

false

boolean

false

supplementalGroups

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

false

integer (int32) array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
+
+1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw

false

integer (int64)

+ +
+
+

v1beta1.NetworkPolicyIngressRule

+
+

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

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

ports

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

false

v1beta1.NetworkPolicyPort array

from

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

false

v1beta1.NetworkPolicyPeer array

+ +
+
+

v1.OwnerReference

+
+

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

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

apiVersion

API version of the referent.

true

string

kind

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

true

string

name

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

true

string

uid

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

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

+ +
+
+

v1beta1.ReplicaSetStatus

+
+

ReplicaSetStatus represents the current status of a ReplicaSet.

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

replicas

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

true

integer (int32)

fullyLabeledReplicas

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

false

integer (int32)

readyReplicas

The number of ready replicas for this replica set.

false

integer (int32)

observedGeneration

ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

false

integer (int64)

+ +
+
+

v1beta1.LabelSelector

+
+

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

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

matchLabels

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

false

object

matchExpressions

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

false

v1beta1.LabelSelectorRequirement array

+ +
+
+

v1beta1.ReplicaSet

+
+

ReplicaSet represents the configuration of a ReplicaSet.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1beta1.ReplicaSetSpec

status

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

false

v1beta1.ReplicaSetStatus

+ +
+
+

v1.HostPathVolumeSource

+
+

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

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

path

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

true

string

+ +
+
+

v1beta1.DaemonSet

+
+

DaemonSet represents the configuration of a daemon set.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1beta1.DaemonSetSpec

status

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

false

v1beta1.DaemonSetStatus

+ +
+
+

v1.CinderVolumeSource

+
+

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

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

volumeID

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

true

string

fsType

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

false

string

readOnly

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

false

boolean

false

+ +
+
+

v1.SecurityContext

+
+

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

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

capabilities

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

false

v1.Capabilities

privileged

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

false

boolean

false

seLinuxOptions

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

false

v1.SELinuxOptions

runAsUser

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

false

integer (int64)

runAsNonRoot

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

false

boolean

false

readOnlyRootFilesystem

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

false

boolean

false

+ +
+
+

v1.Protocol

+ +
+
+

v1.AWSElasticBlockStoreVolumeSource

+
+

Represents a Persistent Disk resource in AWS.

+
+
+

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

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

volumeID

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

true

string

fsType

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

false

string

partition

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

false

integer (int32)

readOnly

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

false

boolean

false

+ +
+
+

v1beta1.HorizontalPodAutoscalerSpec

+
+

specification of a horizontal pod autoscaler.

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

scaleRef

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

true

v1beta1.SubresourceReference

minReplicas

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

false

integer (int32)

maxReplicas

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

true

integer (int32)

cpuUtilization

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

false

v1beta1.CPUTargetUtilization

+ +
+
+

v1.QuobyteVolumeSource

+
+

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

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

registry

Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

true

string

volume

Volume is a string that references an already created Quobyte volume by name.

true

string

readOnly

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

false

boolean

false

user

User to map volume access to Defaults to serivceaccount user

false

string

group

Group to map volume access to Default is no group

false

string

+ +
+
+

v1beta1.LabelSelectorRequirement

+
+

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

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

key

key is the label key that the selector applies to.

true

string

operator

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

true

string

values

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

false

string array

+ +
+
+

v1.EnvVar

+
+

EnvVar represents an environment variable present in a Container.

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

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

value

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

false

string

valueFrom

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

false

v1.EnvVarSource

+ +
+
+

v1.ResourceRequirements

+
+

ResourceRequirements describes the compute resource requirements.

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

limits

Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

+ +
+
+

v1.PodTemplateSpec

+
+

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

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

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.PodSpec

+ +
+
+

v1beta1.NetworkPolicyPort

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

protocol

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

false

v1.Protocol

port

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

false

string

+ +
+
+

v1beta1.JobSpec

+
+

JobSpec describes how the job execution will look like.

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

parallelism

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

false

integer (int32)

completions

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

false

integer (int32)

activeDeadlineSeconds

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

false

integer (int64)

selector

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

false

v1beta1.LabelSelector

autoSelector

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

false

boolean

false

template

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

true

v1.PodTemplateSpec

+ +
+
+

unversioned.Status

+
+

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

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

status

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

false

string

message

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

false

string

reason

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

false

string

details

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

false

unversioned.StatusDetails

code

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

false

integer (int32)

+ +
+
+

v1beta1.HorizontalPodAutoscalerList

+
+

list of horizontal pod autoscaler objects.

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

kind

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

false

string

apiVersion

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

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

list of horizontal pod autoscaler objects.

true

v1beta1.HorizontalPodAutoscaler array

+ +
+
+

v1.ConfigMapKeySelector

+
+

Selects a key from a ConfigMap.

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

name

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

false

string

key

The key to select.

true

string

+ +
+
+

v1beta1.HTTPIngressPath

+
+

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

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

path

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

false

string

backend

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

true

v1beta1.IngressBackend

+ +
+
+

v1beta1.Ingress

+
+

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

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1beta1.IngressSpec

status

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

false

v1beta1.IngressStatus

+ +
+
+

v1beta1.ThirdPartyResourceList

+
+

ThirdPartyResourceList is a list of ThirdPartyResources.

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

kind

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

false

string

apiVersion

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

false

string

metadata

Standard list metadata.

false

unversioned.ListMeta

items

Items is the list of ThirdPartyResources.

true

v1beta1.ThirdPartyResource array

+ +
+
+

v1.AzureDataDiskCachingMode

+ +
+
+

any

+
+

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

+
+
+
+
+
+ + + \ No newline at end of file diff --git a/_includes/v1.4/extensions-v1beta1-operations.html b/_includes/v1.4/extensions-v1beta1-operations.html new file mode 100755 index 0000000000..8ac8f8e6f3 --- /dev/null +++ b/_includes/v1.4/extensions-v1beta1-operations.html @@ -0,0 +1,16848 @@ + + + + + + +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 StorageClass

+
+
+
GET /apis/extensions/v1beta1/storageclasses
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

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

false

string

QueryParameter

fieldSelector

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

false

string

QueryParameter

watch

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

false

boolean

QueryParameter

resourceVersion

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

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apisextensionsv1beta1

    +
  • +
+
+
+
+
+

delete collection of StorageClass

+
+
+
DELETE /apis/extensions/v1beta1/storageclasses
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

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

false

string

QueryParameter

fieldSelector

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

false

string

QueryParameter

watch

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

false

boolean

QueryParameter

resourceVersion

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

+
+
+
POST /apis/extensions/v1beta1/storageclasses
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.StorageClass

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1beta1.StorageClass

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apisextensionsv1beta1

    +
  • +
+
+
+
+
+

read the specified StorageClass

+
+
+
GET /apis/extensions/v1beta1/storageclasses/{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 StorageClass

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1beta1.StorageClass

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apisextensionsv1beta1

    +
  • +
+
+
+
+
+

replace the specified StorageClass

+
+
+
PUT /apis/extensions/v1beta1/storageclasses/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1beta1.StorageClass

PathParameter

name

name of the StorageClass

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1beta1.StorageClass

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apisextensionsv1beta1

    +
  • +
+
+
+
+
+

delete a StorageClass

+
+
+
DELETE /apis/extensions/v1beta1/storageclasses/{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 StorageClass

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 StorageClass

+
+
+
PATCH /apis/extensions/v1beta1/storageclasses/{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 StorageClass

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1beta1.StorageClass

+ +
+
+

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 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 StorageClass

+
+
+
GET /apis/extensions/v1beta1/watch/storageclasses
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

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

false

string

QueryParameter

fieldSelector

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

false

string

QueryParameter

watch

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

false

boolean

QueryParameter

resourceVersion

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

+
+
+
GET /apis/extensions/v1beta1/watch/storageclasses/{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 StorageClass

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 ThirdPartyResource

+
+
+
GET /apis/extensions/v1beta1/watch/thirdpartyresources
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

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

false

string

QueryParameter

fieldSelector

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

false

string

QueryParameter

watch

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

false

boolean

QueryParameter

resourceVersion

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

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apisextensionsv1beta1

    +
  • +
+
+
+
+
+

watch changes to an object of kind ThirdPartyResource

+
+
+
GET /apis/extensions/v1beta1/watch/thirdpartyresources/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

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

false

string

QueryParameter

fieldSelector

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

false

string

QueryParameter

watch

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

false

boolean

QueryParameter

resourceVersion

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

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the ThirdPartyResource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apisextensionsv1beta1

    +
  • +
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/_includes/v1.4/v1-definitions.html b/_includes/v1.4/v1-definitions.html new file mode 100755 index 0000000000..1c1afc4106 --- /dev/null +++ b/_includes/v1.4/v1-definitions.html @@ -0,0 +1,8087 @@ + + + + + + +Top Level API Objects + + + +
+ +
+

Definitions

+
+
+

v1.Node

+
+

Node is a worker node in Kubernetes, formerly known as minion. Each node will have a unique identifier in the cache (i.e. in etcd).

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

Spec defines the behavior of a node. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.NodeSpec

status

Most recently observed status of the node. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.NodeStatus

+ +
+
+

v1.PersistentVolumeClaimList

+
+

PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

A list of persistent volume claims. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

true

v1.PersistentVolumeClaim array

+ +
+
+

v1.Preconditions

+
+

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

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

uid

Specifies the target UID.

false

types.UID

+ +
+
+

v1.SELinuxOptions

+
+

SELinuxOptions are the labels to be applied to the container

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

user

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

false

string

role

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

false

string

type

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

false

string

level

Level is SELinux level label that applies to the container.

false

string

+ +
+
+

v1.ObjectFieldSelector

+
+

ObjectFieldSelector selects an APIVersioned field of an object.

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

apiVersion

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

false

string

fieldPath

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

true

string

+ +
+
+

v1.ContainerStateRunning

+
+

ContainerStateRunning is a running state of a container.

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

startedAt

Time at which the container was last (re-)started

false

string (date-time)

+ +
+
+

v1.VolumeMount

+
+

VolumeMount describes a mounting of a Volume within a container.

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

name

This must match the Name of a Volume.

true

string

readOnly

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

false

boolean

false

mountPath

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

true

string

subPath

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

false

string

+ +
+
+

v1.PersistentVolumeClaimSpec

+
+

PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

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

accessModes

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

false

v1.PersistentVolumeAccessMode array

selector

A label query over volumes to consider for binding.

false

unversioned.LabelSelector

resources

Resources represents the minimum resources the volume should have. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#resources

false

v1.ResourceRequirements

volumeName

VolumeName is the binding reference to the PersistentVolume backing this claim.

false

string

+ +
+
+

v1.CephFSVolumeSource

+
+

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

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

monitors

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

true

string array

path

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

false

string

user

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

false

string

secretFile

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

+ +
+
+

v1.DownwardAPIVolumeSource

+
+

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

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

items

Items is a list of downward API volume file

false

v1.DownwardAPIVolumeFile array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

+ +
+
+

unversioned.StatusCause

+
+

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

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

reason

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

false

string

message

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

false

string

field

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

false

string

+ +
+
+

v1.GCEPersistentDiskVolumeSource

+
+

Represents a Persistent Disk resource in Google Compute Engine.

+
+
+

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

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

pdName

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

true

string

fsType

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

false

string

partition

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

false

integer (int32)

readOnly

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

false

boolean

false

+ +
+
+

v1.ResourceQuotaSpec

+
+

ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

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

hard

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

false

object

scopes

A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.

false

v1.ResourceQuotaScope array

+ +
+
+

v1.NamespaceStatus

+
+

NamespaceStatus is information about the current status of a Namespace.

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

phase

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

false

string

+ +
+
+

v1.NamespaceSpec

+
+

NamespaceSpec describes the attributes on a Namespace.

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

finalizers

Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: http://releases.k8s.io/release-1.4/docs/design/namespaces.md#finalizers

false

v1.FinalizerName array

+ +
+
+

v1.PersistentVolume

+
+

PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistent-volumes

false

v1.PersistentVolumeSpec

status

Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistent-volumes

false

v1.PersistentVolumeStatus

+ +
+
+

v1.ConfigMapList

+
+

ConfigMapList is a resource containing a list of ConfigMap objects.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

Items is the list of ConfigMaps.

true

v1.ConfigMap array

+ +
+
+

v1.PersistentVolumeStatus

+
+

PersistentVolumeStatus is the current status of a persistent volume.

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

phase

Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#phase

false

string

message

A human-readable message indicating details about why the volume is in this state.

false

string

reason

Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

false

string

+ +
+
+

v1.ConfigMapVolumeSource

+
+

Adapts a ConfigMap into a volume.

+
+
+

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

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

name

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

false

string

items

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

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

+ +
+
+

*versioned.Event

+ +
+
+

v1.EndpointsList

+
+

EndpointsList is a list of endpoints.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

List of endpoints.

true

v1.Endpoints array

+ +
+
+

v1.GitRepoVolumeSource

+
+

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

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

repository

Repository URL

true

string

revision

Commit hash for the specified revision.

false

string

directory

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

false

string

+ +
+
+

v1.ScaleStatus

+
+

ScaleStatus represents the current status of a scale subresource.

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

replicas

actual number of observed instances of the scaled object.

true

integer (int32)

selector

label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors

false

string

+ +
+
+

v1.Capabilities

+
+

Adds and removes POSIX capabilities from running containers.

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

add

Added capabilities

false

v1.Capability array

drop

Removed capabilities

false

v1.Capability array

+ +
+
+

v1.ConfigMap

+
+

ConfigMap holds configuration data for pods to consume.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

data

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

false

object

+ +
+
+

v1.PodTemplateList

+
+

PodTemplateList is a list of PodTemplates.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

List of pod templates

true

v1.PodTemplate array

+ +
+
+

v1.NodeCondition

+
+

NodeCondition contains condition information for a node.

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

type

Type of node condition.

true

string

status

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

true

string

lastHeartbeatTime

Last time we got an update on a given condition.

false

string (date-time)

lastTransitionTime

Last time the condition transit from one status to another.

false

string (date-time)

reason

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

false

string

message

Human readable message indicating details about last transition.

false

string

+ +
+
+

v1.LocalObjectReference

+
+

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

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

name

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

false

string

+ +
+
+

v1.ResourceQuotaStatus

+
+

ResourceQuotaStatus defines the enforced hard limits and observed use.

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

hard

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

false

object

used

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

false

object

+ +
+
+

v1.ExecAction

+
+

ExecAction describes a "run in container" action.

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

command

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

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

false

string array

+ +
+
+

v1.ObjectMeta

+
+

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

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

name

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

false

string

generateName

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

false

string

namespace

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

false

string

selfLink

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

false

string

uid

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

false

string

resourceVersion

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

false

string

generation

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

false

integer (int64)

creationTimestamp

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

false

string (date-time)

deletionTimestamp

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

false

string (date-time)

deletionGracePeriodSeconds

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

false

integer (int64)

labels

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

false

object

annotations

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

false

object

ownerReferences

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

false

v1.OwnerReference array

finalizers

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

false

string array

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

false

string

+ +
+
+

v1.LimitRangeSpec

+
+

LimitRangeSpec defines a min/max usage limit for resources that match on kind.

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

limits

Limits is the list of LimitRangeItem objects that are enforced.

true

v1.LimitRangeItem array

+ +
+
+

types.UID

+ +
+
+

v1.AzureFileVolumeSource

+
+

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

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

secretName

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

true

string

shareName

Share Name

true

string

readOnly

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

false

boolean

false

+ +
+
+

v1.ISCSIVolumeSource

+
+

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

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

targetPortal

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

true

string

iqn

Target iSCSI Qualified Name.

true

string

lun

iSCSI target lun number.

true

integer (int32)

iscsiInterface

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

false

string

fsType

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

false

string

readOnly

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

false

boolean

false

+ +
+
+

v1.EmptyDirVolumeSource

+
+

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

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

medium

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

false

string

+ +
+
+

v1.NodeList

+
+

NodeList is the whole list of all Nodes which have been registered with master.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

List of nodes

true

v1.Node array

+ +
+
+

unversioned.Patch

+
+

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

+
+
+
+

v1.NamespaceList

+
+

NamespaceList is a list of Namespaces.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

Items is the list of Namespace objects in the list. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

true

v1.Namespace array

+ +
+
+

v1.PersistentVolumeClaim

+
+

PersistentVolumeClaim is a user’s request for and claim to a persistent volume

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

Spec defines the desired characteristics of a volume requested by a pod author. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false

v1.PersistentVolumeClaimSpec

status

Status represents the current information/status of a persistent volume claim. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false

v1.PersistentVolumeClaimStatus

+ +
+
+

v1.ServiceAccount

+
+

ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

secrets

Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: http://releases.k8s.io/release-1.4/docs/user-guide/secrets.md

false

v1.ObjectReference array

imagePullSecrets

ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: http://releases.k8s.io/release-1.4/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret

false

v1.LocalObjectReference array

+ +
+
+

v1.NodeAddress

+
+

NodeAddress contains information for the node’s address.

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

type

Node address type, one of Hostname, ExternalIP or InternalIP.

true

string

address

The node address.

true

string

+ +
+
+

v1.Namespace

+
+

Namespace provides a scope for Names. Use of multiple namespaces is optional.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.NamespaceSpec

status

Status describes the current status of a Namespace. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.NamespaceStatus

+ +
+
+

v1.FlockerVolumeSource

+
+

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

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

datasetName

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

true

string

+ +
+
+

v1.PersistentVolumeClaimVolumeSource

+
+

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

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

claimName

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

true

string

readOnly

Will force the ReadOnly setting in VolumeMounts. Default false.

false

boolean

false

+ +
+
+

unversioned.ListMeta

+
+

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

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

selfLink

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

false

string

resourceVersion

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

false

string

+ +
+
+

v1.ResourceQuotaList

+
+

ResourceQuotaList is a list of ResourceQuota items.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

Items is a list of ResourceQuota objects. More info: http://releases.k8s.io/release-1.4/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

true

v1.ResourceQuota array

+ +
+
+

v1.PersistentVolumeClaimStatus

+
+

PersistentVolumeClaimStatus is the current status of a persistent volume claim.

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

phase

Phase represents the current phase of PersistentVolumeClaim.

false

string

accessModes

AccessModes contains the actual access modes the volume backing the PVC has. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#access-modes-1

false

v1.PersistentVolumeAccessMode array

capacity

Represents the actual resources of the underlying volume.

false

object

+ +
+
+

v1.UniqueVolumeName

+ +
+
+

unversioned.LabelSelector

+
+

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

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

matchLabels

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

false

object

matchExpressions

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

false

unversioned.LabelSelectorRequirement array

+ +
+
+

v1.EndpointSubset

+
+

EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given:
+ {
+ Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
+ Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
+ }
+The resulting set of endpoints can be viewed as:
+ a: [ 10.10.1.1:8675, 10.10.2.2:8675 ],
+ b: [ 10.10.1.1:309, 10.10.2.2:309 ]

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

addresses

IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.

false

v1.EndpointAddress array

notReadyAddresses

IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check.

false

v1.EndpointAddress array

ports

Port numbers available on the related IP addresses.

false

v1.EndpointPort array

+ +
+
+

v1.SecretVolumeSource

+
+

Adapts a Secret into a volume.

+
+
+

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

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

secretName

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

false

string

items

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

false

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

+ +
+
+

v1.FlexVolumeSource

+
+

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

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

driver

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

true

string

fsType

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

false

string

secretRef

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

false

v1.LocalObjectReference

readOnly

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

false

boolean

false

options

Optional: Extra command options if any.

false

object

+ +
+
+

v1.EnvVarSource

+
+

EnvVarSource represents a source for the value of an EnvVar.

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

fieldRef

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

false

v1.ObjectFieldSelector

resourceFieldRef

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

false

v1.ResourceFieldSelector

configMapKeyRef

Selects a key of a ConfigMap.

false

v1.ConfigMapKeySelector

secretKeyRef

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

false

v1.SecretKeySelector

+ +
+
+

v1.Scale

+
+

Scale represents a scaling request for a resource.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.ScaleSpec

status

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

false

v1.ScaleStatus

+ +
+
+

v1.LoadBalancerIngress

+
+

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

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

ip

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

false

string

hostname

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

false

string

+ +
+
+

v1.AzureDiskVolumeSource

+
+

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

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

diskName

The Name of the data disk in the blob storage

true

string

diskURI

The URI the data disk in the blob storage

true

string

cachingMode

Host Caching mode: None, Read Only, Read Write.

false

v1.AzureDataDiskCachingMode

fsType

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

false

string

readOnly

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

false

boolean

false

+ +
+
+

v1.KeyToPath

+
+

Maps a string key to a path within a volume.

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

key

The key to project.

true

string

path

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

true

string

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

+ +
+
+

v1.Service

+
+

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

Spec defines the behavior of a service. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.ServiceSpec

status

Most recently observed status of the service. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.ServiceStatus

+ +
+
+

v1.VsphereVirtualDiskVolumeSource

+
+

Represents a vSphere volume resource.

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

volumePath

Path that identifies vSphere volume vmdk

true

string

fsType

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

false

string

+ +
+
+

v1.ServiceAccountList

+
+

ServiceAccountList is a list of ServiceAccount objects

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

List of ServiceAccounts. More info: http://releases.k8s.io/release-1.4/docs/design/service_accounts.md#service-accounts

true

v1.ServiceAccount array

+ +
+
+

v1.LimitRangeList

+
+

LimitRangeList is a list of LimitRange items.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

unversioned.ListMeta

items

Items is a list of LimitRange objects. More info: http://releases.k8s.io/release-1.4/docs/design/admission_control_limit_range.md

true

v1.LimitRange array

+ +
+
+

v1.Endpoints

+
+

Endpoints is a collection of endpoints that implement the actual service. Example:
+ Name: "mysvc",
+ Subsets: [
+ {
+ Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}],
+ Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}]
+ },
+ {
+ Addresses: [{"ip": "10.10.3.3"}],
+ Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}]
+ },
+ ]

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

subsets

The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service.

true

v1.EndpointSubset array

+ +
+
+

v1.DeleteOptions

+
+

DeleteOptions may be provided when deleting an API object

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

kind

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

false

string

apiVersion

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

false

string

gracePeriodSeconds

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

false

integer (int64)

preconditions

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

false

v1.Preconditions

orphanDependents

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

false

boolean

false

+ +
+
+

v1.Volume

+
+

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

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

name

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

true

string

hostPath

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

false

v1.HostPathVolumeSource

emptyDir

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

false

v1.EmptyDirVolumeSource

gcePersistentDisk

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

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

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

false

v1.AWSElasticBlockStoreVolumeSource

gitRepo

GitRepo represents a git repository at a particular revision.

false

v1.GitRepoVolumeSource

secret

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

false

v1.SecretVolumeSource

nfs

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

false

v1.NFSVolumeSource

iscsi

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

false

v1.ISCSIVolumeSource

glusterfs

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

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

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

false

v1.PersistentVolumeClaimVolumeSource

rbd

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

false

v1.RBDVolumeSource

flexVolume

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

false

v1.FlexVolumeSource

cinder

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

false

v1.CinderVolumeSource

cephfs

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

false

v1.CephFSVolumeSource

flocker

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

false

v1.FlockerVolumeSource

downwardAPI

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

false

v1.DownwardAPIVolumeSource

fc

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

false

v1.FCVolumeSource

azureFile

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

false

v1.AzureFileVolumeSource

configMap

ConfigMap represents a configMap that should populate this volume

false

v1.ConfigMapVolumeSource

vsphereVolume

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

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

+ +
+
+

v1.ResourceFieldSelector

+
+

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

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

containerName

Container name: required for volumes, optional for env vars

false

string

resource

Required: resource to select

true

string

divisor

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

false

string

+ +
+
+

v1.Probe

+
+

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

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

exec

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

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

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

false

v1.TCPSocketAction

initialDelaySeconds

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

false

integer (int32)

timeoutSeconds

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

false

integer (int32)

periodSeconds

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

false

integer (int32)

successThreshold

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

false

integer (int32)

failureThreshold

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

false

integer (int32)

+ +
+
+

unversioned.APIResourceList

+
+

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

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

kind

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

false

string

apiVersion

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

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

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

true

unversioned.APIResource array

+ +
+
+

v1.SecretKeySelector

+
+

SecretKeySelector selects a key of a Secret.

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

name

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

false

string

key

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

true

string

+ +
+
+

v1.ReplicationController

+
+

ReplicationController represents the configuration of a replication controller.

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

kind

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

false

string

apiVersion

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

false

string

metadata

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

false

v1.ObjectMeta

spec

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

false

v1.ReplicationControllerSpec

status

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

false

v1.ReplicationControllerStatus

+ +
+
+

v1.Capability

+ +
+
+

unversioned.APIResource

+
+

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

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

name

name is the name of the resource.

true

string

namespaced

namespaced indicates if a resource is namespaced or not.

true

boolean

false

kind

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

true

string

+ +
+
+

v1.PodStatus

+
+

PodStatus represents information about the status of a pod. Status may trail the actual state of a system.

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

phase

Current condition of the pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#pod-phase

false

string

conditions

Current service state of pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#pod-conditions

false

v1.PodCondition array

message

A human readable message indicating details about why the pod is in this condition.

false

string

reason

A brief CamelCase message indicating details about why the pod is in this state. e.g. OutOfDisk

false

string

hostIP

IP address of the host to which the pod is assigned. Empty if not yet scheduled.

false

string

podIP

IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.

false

string

startTime

RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.

false

string (date-time)

containerStatuses

The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-statuses

false

v1.ContainerStatus array

+ +
+
+

v1.LimitRange

+
+

LimitRange sets resource usage limits for each kind of resource in a Namespace.

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

kind

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

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the limits enforced. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.LimitRangeSpec

+ +
+
+

v1.DownwardAPIVolumeFile

+
+

DownwardAPIVolumeFile represents information to create the file containing the pod field

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

path

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the .. path. Must be utf-8 encoded. The first item of the relative path must not start with ..

true

string

fieldRef

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

false

v1.ObjectFieldSelector

resourceFieldRef

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

false

v1.ResourceFieldSelector

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

+ +
+
+

v1.PodSpec

+
+

PodSpec is a description of a pod.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

volumes

List of volumes that can be mounted by containers belonging to the pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md

false

v1.Volume array

containers

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md

true

v1.Container array

restartPolicy

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#restartpolicy

false

string

terminationGracePeriodSeconds

Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds.

false

integer (int64)

activeDeadlineSeconds

Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.

false

integer (int64)

dnsPolicy

Set DNS policy for containers within the pod. One of ClusterFirst or Default. Defaults to "ClusterFirst".

false

string

nodeSelector

NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: http://releases.k8s.io/release-1.4/docs/user-guide/node-selection/README.md

false

object

serviceAccountName

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/release-1.4/docs/design/service_accounts.md

false

string

serviceAccount

DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

false

string

nodeName

NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

false

string

hostNetwork

Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

false

boolean

false

hostPID

Use the host’s pid namespace. Optional: Default to false.

false

boolean

false

hostIPC

Use the host’s ipc namespace. Optional: Default to false.

false

boolean

false

securityContext

SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

false

v1.PodSecurityContext

imagePullSecrets

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

hostname

Specifies the hostname of the Pod If not specified, the pod’s hostname will be set to a system-defined value.

false

string

subdomain

If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all.

false

string

+ +
+
+

v1.ContainerPort

+
+

ContainerPort represents a network port in a single container.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

false

string

hostPort

Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

false

integer (int32)

containerPort

Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

true

integer (int32)

protocol

Protocol for port. Must be UDP or TCP. Defaults to "TCP".

false

string

hostIP

What host IP to bind the external port to.

false

string

+ +
+
+

v1.ResourceQuota

+
+

ResourceQuota sets aggregate quota restrictions enforced per namespace

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec defines the desired quota. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.ResourceQuotaSpec

status

Status defines the actual enforced quota and its current usage. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.ResourceQuotaStatus

+ +
+
+

v1.EventList

+
+

EventList is a list of events.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of events

true

v1.Event array

+ +
+
+

v1.Lifecycle

+
+

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

postStart

PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

preStop

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

+ +
+
+

v1.ReplicationControllerSpec

+
+

ReplicationControllerSpec is the specification of a replication controller.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md#what-is-a-replication-controller

false

integer (int32)

selector

Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md#label-selectors

false

object

template

Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md#pod-template

false

v1.PodTemplateSpec

+ +
+
+

v1.Handler

+
+

Handler defines a specific action that should be taken

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

exec

One and only one of the following should be specified. Exec specifies the action to take.

false

v1.ExecAction

httpGet

HTTPGet specifies the http request to perform.

false

v1.HTTPGetAction

tcpSocket

TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

false

v1.TCPSocketAction

+ +
+
+

v1.NodeStatus

+
+

NodeStatus is information about the current status of a node.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

capacity

Capacity represents the total resources of a node. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#capacity for more details.

false

object

allocatable

Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.

false

object

phase

NodePhase is the recently observed lifecycle phase of the node. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-phase The field is never populated, and now is deprecated.

false

string

conditions

Conditions is an array of current observed node conditions. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-condition

false

v1.NodeCondition array

addresses

List of addresses reachable to the node. Queried from cloud provider, if available. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-addresses

false

v1.NodeAddress array

daemonEndpoints

Endpoints of daemons running on the Node.

false

v1.NodeDaemonEndpoints

nodeInfo

Set of ids/uuids to uniquely identify the node. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-info

false

v1.NodeSystemInfo

images

List of container images on this node

false

v1.ContainerImage array

volumesInUse

List of attachable volumes in use (mounted) by the node.

false

v1.UniqueVolumeName array

volumesAttached

List of volumes that are attached to the node.

false

v1.AttachedVolume array

+ +
+
+

v1.GlusterfsVolumeSource

+
+

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

endpoints

EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

true

string

path

Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

true

string

readOnly

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

false

boolean

false

+ +
+
+

v1.AttachedVolume

+
+

AttachedVolume describes a volume attached to a node

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

Name of the attached volume

true

string

devicePath

DevicePath represents the device path where the volume should be avilable

true

string

+ +
+
+

v1.EventSource

+
+

EventSource contains information for an event.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

component

Component from which the event is generated.

false

string

host

Host name on which the event is generated.

false

string

+ +
+
+

v1.PodCondition

+
+

PodCondition contains details for the current condition of this pod.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

type

Type is the type of the condition. Currently only Ready. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#pod-conditions

true

string

status

Status is the status of the condition. Can be True, False, Unknown. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#pod-conditions

true

string

lastProbeTime

Last time we probed the condition.

false

string (date-time)

lastTransitionTime

Last time the condition transitioned from one status to another.

false

string (date-time)

reason

Unique, one-word, CamelCase reason for the condition’s last transition.

false

string

message

Human-readable message indicating details about last transition.

false

string

+ +
+
+

v1.RBDVolumeSource

+
+

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

monitors

A collection of Ceph monitors. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

true

string array

image

The rados image name. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#rbd

false

string

pool

The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it.

false

string

user

The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

false

string

keyring

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

false

string

secretRef

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

false

boolean

false

+ +
+
+

v1.PodTemplate

+
+

PodTemplate describes a template for creating copies of a predefined pod.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

template

Template defines the pods that will be created from this pod template. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.PodTemplateSpec

+ +
+
+

v1.ServiceStatus

+
+

ServiceStatus represents the current status of a service.

+
+ +++++++ + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

loadBalancer

LoadBalancer contains the current status of the load-balancer, if one is present.

false

v1.LoadBalancerStatus

+ +
+
+

v1.NFSVolumeSource

+
+

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

server

Server is the hostname or IP address of the NFS server. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

true

string

path

Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

true

string

readOnly

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

false

boolean

false

+ +
+
+

v1.HTTPHeader

+
+

HTTPHeader describes a custom header to be used in HTTP probes

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

The header field name

true

string

value

The header field value

true

string

+ +
+
+

v1.FCVolumeSource

+
+

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

targetWWNs

Required: FC target worldwide names (WWNs)

true

string array

lun

Required: FC target lun number

true

integer (int32)

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

+ +
+
+

v1.EndpointPort

+
+

EndpointPort is a tuple that describes a single port.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

The name of this port (corresponds to ServicePort.Name). Must be a DNS_LABEL. Optional only if one port is defined.

false

string

port

The port number of the endpoint.

true

integer (int32)

protocol

The IP protocol for this port. Must be UDP or TCP. Default is TCP.

false

string

+ +
+
+

v1.TCPSocketAction

+
+

TCPSocketAction describes an action based on opening a socket

+
+ +++++++ + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

port

Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

+ +
+
+

unversioned.StatusDetails

+
+

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

false

string

group

The group attribute of the resource associated with the status StatusReason.

false

string

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

causes

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

false

unversioned.StatusCause array

retryAfterSeconds

If specified, the time in seconds before the operation should be retried.

false

integer (int32)

+ +
+
+

v1.HTTPGetAction

+
+

HTTPGetAction describes an action based on HTTP Get requests.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

path

Path to access on the HTTP server.

false

string

port

Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

true

string

host

Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

false

string

scheme

Scheme to use for connecting to the host. Defaults to HTTP.

false

string

httpHeaders

Custom headers to set in the request. HTTP allows repeated headers.

false

v1.HTTPHeader array

+ +
+
+

v1.LoadBalancerStatus

+
+

LoadBalancerStatus represents the status of a load-balancer.

+
+ +++++++ + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

ingress

Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

false

v1.LoadBalancerIngress array

+ +
+
+

v1.SecretList

+
+

SecretList is a list of Secret.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

Items is a list of secret objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/secrets.md

true

v1.Secret array

+ +
+
+

v1.Container

+
+

A single application container that you want to run within a pod.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.

true

string

image

Docker image name. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md

false

string

command

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands

false

string array

args

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/containers.md#containers-and-commands

false

string array

workingDir

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.

false

string

ports

List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.

false

v1.ContainerPort array

env

List of environment variables to set in the container. Cannot be updated.

false

v1.EnvVar array

resources

Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#resources

false

v1.ResourceRequirements

volumeMounts

Pod volumes to mount into the container’s filesystem. Cannot be updated.

false

v1.VolumeMount array

livenessProbe

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

false

v1.Probe

readinessProbe

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

false

v1.Probe

lifecycle

Actions that the management system should take in response to container lifecycle events. Cannot be updated.

false

v1.Lifecycle

terminationMessagePath

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.

false

string

imagePullPolicy

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md#updating-images

false

string

securityContext

Security options the pod should run with. More info: http://releases.k8s.io/release-1.4/docs/design/security_context.md

false

v1.SecurityContext

stdin

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

false

boolean

false

stdinOnce

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

false

boolean

false

tty

Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.

false

boolean

false

+ +
+
+

v1.PodSecurityContext

+
+

PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

seLinuxOptions

The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

supplementalGroups

A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

false

integer (int32) array

fsGroup

A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
+
+1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw

false

integer (int64)

+ +
+
+

v1.PersistentVolumeSpec

+
+

PersistentVolumeSpec is the specification of a persistent volume.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

capacity

A description of the persistent volume’s resources and capacity. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#capacity

false

object

gcePersistentDisk

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

hostPath

HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

false

v1.HostPathVolumeSource

glusterfs

Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md

false

v1.GlusterfsVolumeSource

nfs

NFS represents an NFS mount on the host. Provisioned by an admin. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

false

v1.NFSVolumeSource

rbd

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md

false

v1.RBDVolumeSource

iscsi

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin.

false

v1.ISCSIVolumeSource

cinder

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

cephfs

CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

false

v1.CephFSVolumeSource

fc

FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

false

v1.FCVolumeSource

flocker

Flocker represents a Flocker volume attached to a kubelet’s host machine and exposed to the pod for its usage. This depends on the Flocker control service being running

false

v1.FlockerVolumeSource

flexVolume

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

false

v1.FlexVolumeSource

azureFile

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

false

v1.AzureFileVolumeSource

vsphereVolume

VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

false

v1.VsphereVirtualDiskVolumeSource

quobyte

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

false

v1.QuobyteVolumeSource

azureDisk

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

false

v1.AzureDiskVolumeSource

accessModes

AccessModes contains all ways the volume can be mounted. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#access-modes

false

v1.PersistentVolumeAccessMode array

claimRef

ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#binding

false

v1.ObjectReference

persistentVolumeReclaimPolicy

What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recycling must be supported by the volume plugin underlying this persistent volume. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#recycling-policy

false

string

+ +
+
+

v1.ReplicationControllerStatus

+
+

ReplicationControllerStatus represents the current status of a replication controller.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

replicas

Replicas is the most recently oberved number of replicas. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md#what-is-a-replication-controller

true

integer (int32)

fullyLabeledReplicas

The number of pods that have labels matching the labels of the pod template of the replication controller.

false

integer (int32)

readyReplicas

The number of ready replicas for this replication controller.

false

integer (int32)

observedGeneration

ObservedGeneration reflects the generation of the most recently observed replication controller.

false

integer (int64)

+ +
+
+

v1.FinalizerName

+ +
+
+

v1.ServicePort

+
+

ServicePort contains information on service’s port.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the Name field in EndpointPort objects. Optional if only one ServicePort is defined on this service.

false

string

protocol

The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP.

false

string

port

The port that will be exposed by this service.

true

integer (int32)

targetPort

Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod’s container ports. If this is not specified, the value of the port field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the port field. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#defining-a-service

false

string

nodePort

The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#type—nodeport

false

integer (int32)

+ +
+
+

v1.ComponentCondition

+
+

Information about the condition of a component.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

type

Type of condition for a component. Valid value: "Healthy"

true

string

status

Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".

true

string

message

Message about the condition for a component. For example, information about a health check.

false

string

error

Condition error code for a component. For example, a health check error code.

false

string

+ +
+
+

v1.OwnerReference

+
+

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

true

string

name

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

true

string

uid

UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

+ +
+
+

v1.ScaleSpec

+
+

ScaleSpec describes the attributes of a scale subresource.

+
+ +++++++ + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

replicas

desired number of instances for the scaled object.

false

integer (int32)

+ +
+
+

v1.ComponentStatusList

+
+

Status of all the conditions for the component as a list of ComponentStatus objects.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of ComponentStatus objects.

true

v1.ComponentStatus array

+ +
+
+

v1.HostPathVolumeSource

+
+

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

+
+ +++++++ + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

path

Path of the directory on the host. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

true

string

+ +
+
+

v1.ContainerStateTerminated

+
+

ContainerStateTerminated is a terminated state of a container.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

exitCode

Exit status from the last termination of the container

true

integer (int32)

signal

Signal from the last termination of the container

false

integer (int32)

reason

(brief) reason from the last termination of the container

false

string

message

Message regarding the last termination of the container

false

string

startedAt

Time at which previous execution of the container started

false

string (date-time)

finishedAt

Time at which the container last terminated

false

string (date-time)

containerID

Container’s ID in the format docker://<container_id>

false

string

+ +
+
+

v1.Binding

+
+

Binding ties one object to another. For example, a pod is bound to a node by a scheduler.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

target

The target object that you want to bind to the standard object.

true

v1.ObjectReference

+ +
+
+

v1.CinderVolumeSource

+
+

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

volumeID

volume id used to identify the volume in cinder More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

true

string

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

false

string

readOnly

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

false

boolean

false

+ +
+
+

v1.ContainerState

+
+

ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

waiting

Details about a waiting container

false

v1.ContainerStateWaiting

running

Details about a running container

false

v1.ContainerStateRunning

terminated

Details about a terminated container

false

v1.ContainerStateTerminated

+ +
+
+

v1.SecurityContext

+
+

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

capabilities

The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

false

v1.Capabilities

privileged

Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

false

boolean

false

seLinuxOptions

The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

v1.SELinuxOptions

runAsUser

The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

integer (int64)

runAsNonRoot

Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

false

boolean

false

readOnlyRootFilesystem

Whether this container has a read-only root filesystem. Default is false.

false

boolean

false

+ +
+
+

v1alpha1.Eviction

+
+

Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …/pods/foo/evictions.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

ObjectMeta describes the pod that is being evicted.

false

v1.ObjectMeta

deleteOptions

DeleteOptions may be provided

false

v1.DeleteOptions

+ +
+
+

v1.AWSElasticBlockStoreVolumeSource

+
+

Represents a Persistent Disk resource in AWS.

+
+
+

An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

volumeID

Unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

true

string

fsType

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

false

string

partition

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

false

integer (int32)

readOnly

Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". If omitted, the default is "false". More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#awselasticblockstore

false

boolean

false

+ +
+
+

v1.ContainerStatus

+
+

ContainerStatus contains details for the current status of this container.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.

true

string

state

Details about the container’s current condition.

false

v1.ContainerState

lastState

Details about the container’s last termination condition.

false

v1.ContainerState

ready

Specifies whether the container has passed its readiness probe.

true

boolean

false

restartCount

The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.

true

integer (int32)

image

The image the container is running. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md

true

string

imageID

ImageID of the container’s image.

true

string

containerID

Container’s ID in the format docker://<container_id>. More info: http://releases.k8s.io/release-1.4/docs/user-guide/container-environment.md#container-information

false

string

+ +
+
+

v1.QuobyteVolumeSource

+
+

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

registry

Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

true

string

volume

Volume is a string that references an already created Quobyte volume by name.

true

string

readOnly

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

false

boolean

false

user

User to map volume access to Defaults to serivceaccount user

false

string

group

Group to map volume access to Default is no group

false

string

+ +
+
+

v1.ContainerImage

+
+

Describe a container image

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

names

Names by which this image is known. e.g. ["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.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of replication controllers. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md

true

v1.ReplicationController array

+ +
+
+

v1.NodeDaemonEndpoints

+
+

NodeDaemonEndpoints lists ports opened by daemons running on the Node.

+
+ +++++++ + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kubeletEndpoint

Endpoint on which Kubelet is listening.

false

v1.DaemonEndpoint

+ +
+
+

v1.Secret

+
+

Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

data

Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

false

object

stringData

stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.

false

object

type

Used to facilitate programmatic handling of secret data.

false

string

+ +
+
+

v1.Event

+
+

Event is a report of an event somewhere in the cluster.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

true

v1.ObjectMeta

involvedObject

The object that this event is about.

true

v1.ObjectReference

reason

This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.

false

string

message

A human-readable description of the status of this operation.

false

string

source

The component reporting this event. Should be a short machine understandable string.

false

v1.EventSource

firstTimestamp

The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)

false

string (date-time)

lastTimestamp

The time at which the most recent occurrence of this event was recorded.

false

string (date-time)

count

The number of times this event has occurred.

false

integer (int32)

type

Type of this event (Normal, Warning), new types could be added in the future

false

string

+ +
+
+

v1.EnvVar

+
+

EnvVar represents an environment variable present in a Container.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

Name of the environment variable. Must be a C_IDENTIFIER.

true

string

value

Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "".

false

string

valueFrom

Source for the environment variable’s value. Cannot be used if value is not empty.

false

v1.EnvVarSource

+ +
+
+

v1.PersistentVolumeAccessMode

+ +
+
+

v1.ResourceRequirements

+
+

ResourceRequirements describes the compute resource requirements.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

limits

Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

+ +
+
+

v1.ComponentStatus

+
+

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

conditions

List of component conditions observed

false

v1.ComponentCondition array

+ +
+
+

v1.LimitRangeItem

+
+

LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

type

Type of resource that this limit applies to.

false

string

max

Max usage constraints on this kind by resource name.

false

object

min

Min usage constraints on this kind by resource name.

false

object

default

Default resource requirement limit value by resource name if resource limit is omitted.

false

object

defaultRequest

DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.

false

object

maxLimitRequestRatio

MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource.

false

object

+ +
+
+

v1.PodTemplateSpec

+
+

PodTemplateSpec describes the data a pod should have when created from a template

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

+ +
+
+

v1.PodList

+
+

PodList is a list of Pods.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of pods. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pods.md

true

v1.Pod array

+ +
+
+

v1.ServiceList

+
+

ServiceList holds a list of services.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of services

true

v1.Service array

+ +
+
+

v1.PersistentVolumeList

+
+

PersistentVolumeList is a list of PersistentVolume items.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

items

List of persistent volumes. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md

true

v1.PersistentVolume array

+ +
+
+

v1.ObjectReference

+
+

ObjectReference contains enough information to let you inspect or modify the referred object.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

namespace

Namespace of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

false

string

name

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

uid

UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

false

string

apiVersion

API version of the referent.

false

string

resourceVersion

Specific resourceVersion to which this reference is made, if any. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

fieldPath

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

false

string

+ +
+
+

unversioned.LabelSelectorRequirement

+
+

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

key

key is the label key that the selector applies to.

true

string

operator

operator represents a key’s relationship to a set of values. Valid operators ard In, NotIn, Exists and DoesNotExist.

true

string

values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

false

string array

+ +
+
+

v1.ContainerStateWaiting

+
+

ContainerStateWaiting is a waiting state of a container.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

reason

(brief) reason the container is not yet running.

false

string

message

Message regarding why the container is not yet running.

false

string

+ +
+
+

unversioned.Status

+
+

Status is a return value for calls that don’t return other objects.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

string

message

A human-readable description of the status of this operation.

false

string

reason

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

false

string

details

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

false

unversioned.StatusDetails

code

Suggested HTTP return code for this status, 0 if not set.

false

integer (int32)

+ +
+
+

v1.ConfigMapKeySelector

+
+

Selects a key from a ConfigMap.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

key

The key to select.

true

string

+ +
+
+

v1.NodeSystemInfo

+
+

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

machineID

Machine ID reported by the node.

true

string

systemUUID

System UUID reported by the node.

true

string

bootID

Boot ID reported by the node.

true

string

kernelVersion

Kernel Version reported by the node from uname -r (e.g. 3.16.0-0.bpo.4-amd64).

true

string

osImage

OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

true

string

containerRuntimeVersion

ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0).

true

string

kubeletVersion

Kubelet Version reported by the node.

true

string

kubeProxyVersion

KubeProxy Version reported by the node.

true

string

operatingSystem

The Operating System reported by the node

true

string

architecture

The Architecture reported by the node

true

string

+ +
+
+

v1.ServiceSpec

+
+

ServiceSpec describes the attributes that a user creates on a service.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

ports

The list of ports that are exposed by this service. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#virtual-ips-and-service-proxies

true

v1.ServicePort array

selector

Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#overview

false

object

clusterIP

clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#virtual-ips-and-service-proxies

false

string

type

type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#overview

false

string

externalIPs

externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field.

false

string array

deprecatedPublicIPs

deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used.

false

string array

sessionAffinity

Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#virtual-ips-and-service-proxies

false

string

loadBalancerIP

Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.

false

string

loadBalancerSourceRanges

If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: http://releases.k8s.io/release-1.4/docs/user-guide/services-firewalls.md

false

string array

externalName

externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName.

false

string

+ +
+
+

v1.Pod

+
+

Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

status

Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.PodStatus

+ +
+
+

v1.NodeSpec

+
+

NodeSpec describes the attributes that a node is created with.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

podCIDR

PodCIDR represents the pod IP range assigned to the node.

false

string

externalID

External ID of the node assigned by some machine database (e.g. a cloud provider). Deprecated.

false

string

providerID

ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID>

false

string

unschedulable

Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#manual-node-administration"`

false

boolean

false

+ +
+
+

v1.EndpointAddress

+
+

EndpointAddress is a tuple that describes single IP address.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

ip

The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24). IPv6 is also accepted but not fully supported on all platforms. Also, certain kubernetes components, like kube-proxy, are not IPv6 ready.

true

string

hostname

The Hostname of this endpoint

false

string

nodeName

Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.

false

string

targetRef

Reference to object providing the endpoint.

false

v1.ObjectReference

+ +
+
+

v1.DaemonEndpoint

+
+

DaemonEndpoint contains information about a single Daemon endpoint.

+
+ +++++++ + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

Port

Port number of the given endpoint.

true

integer (int32)

+ +
+
+

v1.AzureDataDiskCachingMode

+ +
+
+

any

+
+

Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

+
+
+
+
+
+ + + \ No newline at end of file diff --git a/_includes/v1.4/v1-operations.html b/_includes/v1.4/v1-operations.html new file mode 100755 index 0000000000..875b464420 --- /dev/null +++ b/_includes/v1.4/v1-operations.html @@ -0,0 +1,32451 @@ + + + + + + +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

    +
  • +
+
+
+
+
+

create eviction of a Eviction

+
+
+
POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1alpha1.Eviction

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Eviction

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1alpha1.Eviction

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect GET requests to exec of Pod

+
+
+
GET /api/v1/namespaces/{namespace}/pods/{name}/exec
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Redirect the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Redirect the standard output stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

stderr

Redirect the standard error stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

false

boolean

QueryParameter

container

Container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

QueryParameter

command

Command is the remote command to execute. argv array. Not executed within a shell.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect POST requests to exec of Pod

+
+
+
POST /api/v1/namespaces/{namespace}/pods/{name}/exec
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

stdin

Redirect the standard input stream of the pod for this call. Defaults to false.

false

boolean

QueryParameter

stdout

Redirect the standard output stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

stderr

Redirect the standard error stream of the pod for this call. Defaults to true.

false

boolean

QueryParameter

tty

TTY if true indicates that a tty will be allocated for the exec call. Defaults to false.

false

boolean

QueryParameter

container

Container in which to execute the command. Defaults to only container if there is only one container in the pod.

false

string

QueryParameter

command

Command is the remote command to execute. argv array. Not executed within a shell.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read log of the specified Pod

+
+
+
GET /api/v1/namespaces/{namespace}/pods/{name}/log
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

container

The container for which to stream logs. Defaults to only container if there is one container in the pod.

false

string

QueryParameter

follow

Follow the log stream of the pod. Defaults to false.

false

boolean

QueryParameter

previous

Return previous terminated container logs. Defaults to false.

false

boolean

QueryParameter

sinceSeconds

A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.

false

integer (int32)

QueryParameter

sinceTime

An RFC3339 timestamp from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified.

false

string

QueryParameter

timestamps

If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false.

false

boolean

QueryParameter

tailLines

If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime

false

integer (int32)

QueryParameter

limitBytes

If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Pod

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    text/plain

    +
  • +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect GET requests to portforward of Pod

+
+
+
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect POST requests to portforward of Pod

+
+
+
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect GET requests to proxy of Pod

+
+
+
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect PUT requests to proxy of Pod

+
+
+
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect DELETE requests to proxy of Pod

+
+
+
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect POST requests to proxy of Pod

+
+
+
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect GET requests to proxy of Pod

+
+
+
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect PUT requests to proxy of Pod

+
+
+
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect DELETE requests to proxy of Pod

+
+
+
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect POST requests to proxy of Pod

+
+
+
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to pod.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read status of the specified Pod

+
+
+
GET /api/v1/namespaces/{namespace}/pods/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Pod

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace status of the specified Pod

+
+
+
PUT /api/v1/namespaces/{namespace}/pods/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Pod

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Pod

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update status of the specified Pod

+
+
+
PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Pod

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind PodTemplate

+
+
+
GET /api/v1/namespaces/{namespace}/podtemplates
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PodTemplateList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete collection of PodTemplate

+
+
+
DELETE /api/v1/namespaces/{namespace}/podtemplates
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

create a PodTemplate

+
+
+
POST /api/v1/namespaces/{namespace}/podtemplates
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PodTemplate

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read the specified PodTemplate

+
+
+
GET /api/v1/namespaces/{namespace}/podtemplates/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace the specified PodTemplate

+
+
+
PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PodTemplate

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete a PodTemplate

+
+
+
DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update the specified PodTemplate

+
+
+
PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PodTemplate

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind ReplicationController

+
+
+
GET /api/v1/namespaces/{namespace}/replicationcontrollers
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ReplicationControllerList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete collection of ReplicationController

+
+
+
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

create a ReplicationController

+
+
+
POST /api/v1/namespaces/{namespace}/replicationcontrollers
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read the specified ReplicationController

+
+
+
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace the specified ReplicationController

+
+
+
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete a ReplicationController

+
+
+
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update the specified ReplicationController

+
+
+
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read scale of the specified Scale

+
+
+
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Scale

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace scale of the specified Scale

+
+
+
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Scale

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Scale

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update scale of the specified Scale

+
+
+
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Scale

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Scale

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read status of the specified ReplicationController

+
+
+
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace status of the specified ReplicationController

+
+
+
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ReplicationController

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update status of the specified ReplicationController

+
+
+
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ReplicationController

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind ResourceQuota

+
+
+
GET /api/v1/namespaces/{namespace}/resourcequotas
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuotaList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete collection of ResourceQuota

+
+
+
DELETE /api/v1/namespaces/{namespace}/resourcequotas
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

create a ResourceQuota

+
+
+
POST /api/v1/namespaces/{namespace}/resourcequotas
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read the specified ResourceQuota

+
+
+
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace the specified ResourceQuota

+
+
+
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete a ResourceQuota

+
+
+
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update the specified ResourceQuota

+
+
+
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read status of the specified ResourceQuota

+
+
+
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace status of the specified ResourceQuota

+
+
+
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ResourceQuota

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update status of the specified ResourceQuota

+
+
+
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuota

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind Secret

+
+
+
GET /api/v1/namespaces/{namespace}/secrets
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.SecretList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete collection of Secret

+
+
+
DELETE /api/v1/namespaces/{namespace}/secrets
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

create a Secret

+
+
+
POST /api/v1/namespaces/{namespace}/secrets
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Secret

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Secret

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read the specified Secret

+
+
+
GET /api/v1/namespaces/{namespace}/secrets/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Secret

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace the specified Secret

+
+
+
PUT /api/v1/namespaces/{namespace}/secrets/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Secret

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Secret

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete a Secret

+
+
+
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update the specified Secret

+
+
+
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Secret

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind ServiceAccount

+
+
+
GET /api/v1/namespaces/{namespace}/serviceaccounts
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccountList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete collection of ServiceAccount

+
+
+
DELETE /api/v1/namespaces/{namespace}/serviceaccounts
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

create a ServiceAccount

+
+
+
POST /api/v1/namespaces/{namespace}/serviceaccounts
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ServiceAccount

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read the specified ServiceAccount

+
+
+
GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace the specified ServiceAccount

+
+
+
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.ServiceAccount

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete a ServiceAccount

+
+
+
DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update the specified ServiceAccount

+
+
+
PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccount

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind Service

+
+
+
GET /api/v1/namespaces/{namespace}/services
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ServiceList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

create a Service

+
+
+
POST /api/v1/namespaces/{namespace}/services
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Service

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read the specified Service

+
+
+
GET /api/v1/namespaces/{namespace}/services/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Service

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace the specified Service

+
+
+
PUT /api/v1/namespaces/{namespace}/services/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Service

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete a Service

+
+
+
DELETE /api/v1/namespaces/{namespace}/services/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update the specified Service

+
+
+
PATCH /api/v1/namespaces/{namespace}/services/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Service

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect GET requests to proxy of Service

+
+
+
GET /api/v1/namespaces/{namespace}/services/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect PUT requests to proxy of Service

+
+
+
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect DELETE requests to proxy of Service

+
+
+
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect POST requests to proxy of Service

+
+
+
POST /api/v1/namespaces/{namespace}/services/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect GET requests to proxy of Service

+
+
+
GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect PUT requests to proxy of Service

+
+
+
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect DELETE requests to proxy of Service

+
+
+
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect POST requests to proxy of Service

+
+
+
POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read status of the specified Service

+
+
+
GET /api/v1/namespaces/{namespace}/services/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Service

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace status of the specified Service

+
+
+
PUT /api/v1/namespaces/{namespace}/services/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Service

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Service

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update status of the specified Service

+
+
+
PATCH /api/v1/namespaces/{namespace}/services/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Service

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read the specified Namespace

+
+
+
GET /api/v1/namespaces/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the Namespace

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Namespace

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace the specified Namespace

+
+
+
PUT /api/v1/namespaces/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Namespace

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete a Namespace

+
+
+
DELETE /api/v1/namespaces/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the Namespace

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update the specified Namespace

+
+
+
PATCH /api/v1/namespaces/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Namespace

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Namespace

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace finalize of the specified Namespace

+
+
+
PUT /api/v1/namespaces/{name}/finalize
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Namespace

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read status of the specified Namespace

+
+
+
GET /api/v1/namespaces/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the Namespace

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Namespace

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace status of the specified Namespace

+
+
+
PUT /api/v1/namespaces/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Namespace

PathParameter

name

name of the Namespace

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Namespace

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update status of the specified Namespace

+
+
+
PATCH /api/v1/namespaces/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Namespace

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Namespace

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind Node

+
+
+
GET /api/v1/nodes
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.NodeList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete collection of Node

+
+
+
DELETE /api/v1/nodes
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

create a Node

+
+
+
POST /api/v1/nodes
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Node

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read the specified Node

+
+
+
GET /api/v1/nodes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Node

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace the specified Node

+
+
+
PUT /api/v1/nodes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Node

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete a Node

+
+
+
DELETE /api/v1/nodes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update the specified Node

+
+
+
PATCH /api/v1/nodes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Node

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect GET requests to proxy of Node

+
+
+
GET /api/v1/nodes/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect PUT requests to proxy of Node

+
+
+
PUT /api/v1/nodes/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect DELETE requests to proxy of Node

+
+
+
DELETE /api/v1/nodes/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect POST requests to proxy of Node

+
+
+
POST /api/v1/nodes/{name}/proxy
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect GET requests to proxy of Node

+
+
+
GET /api/v1/nodes/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect PUT requests to proxy of Node

+
+
+
PUT /api/v1/nodes/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect DELETE requests to proxy of Node

+
+
+
DELETE /api/v1/nodes/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

connect POST requests to proxy of Node

+
+
+
POST /api/v1/nodes/{name}/proxy/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

path

Path is the URL path to use for the current proxy request to node.

false

string

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read status of the specified Node

+
+
+
GET /api/v1/nodes/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Node

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace status of the specified Node

+
+
+
PUT /api/v1/nodes/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.Node

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Node

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update status of the specified Node

+
+
+
PATCH /api/v1/nodes/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.Node

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind PersistentVolumeClaim

+
+
+
GET /api/v1/persistentvolumeclaims
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeClaimList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind PersistentVolume

+
+
+
GET /api/v1/persistentvolumes
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolumeList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete collection of PersistentVolume

+
+
+
DELETE /api/v1/persistentvolumes
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

create a PersistentVolume

+
+
+
POST /api/v1/persistentvolumes
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read the specified PersistentVolume

+
+
+
GET /api/v1/persistentvolumes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

export

Should this value be exported. Export strips fields that a user can not specify.

false

boolean

QueryParameter

exact

Should the export be exact. Exact export maintains cluster-specific fields like Namespace

false

boolean

PathParameter

name

name of the PersistentVolume

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace the specified PersistentVolume

+
+
+
PUT /api/v1/persistentvolumes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

PathParameter

name

name of the PersistentVolume

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

delete a PersistentVolume

+
+
+
DELETE /api/v1/persistentvolumes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.DeleteOptions

PathParameter

name

name of the PersistentVolume

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update the specified PersistentVolume

+
+
+
PATCH /api/v1/persistentvolumes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the PersistentVolume

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

read status of the specified PersistentVolume

+
+
+
GET /api/v1/persistentvolumes/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

PathParameter

name

name of the PersistentVolume

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

replace status of the specified PersistentVolume

+
+
+
PUT /api/v1/persistentvolumes/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1.PersistentVolume

PathParameter

name

name of the PersistentVolume

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

partially update status of the specified PersistentVolume

+
+
+
PATCH /api/v1/persistentvolumes/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

unversioned.Patch

PathParameter

name

name of the PersistentVolume

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PersistentVolume

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind Pod

+
+
+
GET /api/v1/pods
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PodList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind PodTemplate

+
+
+
GET /api/v1/podtemplates
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.PodTemplateList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy GET requests to Pod

+
+
+
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy PUT requests to Pod

+
+
+
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy DELETE requests to Pod

+
+
+
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy POST requests to Pod

+
+
+
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy GET requests to Pod

+
+
+
GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy PUT requests to Pod

+
+
+
PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy DELETE requests to Pod

+
+
+
DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy POST requests to Pod

+
+
+
POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy GET requests to Service

+
+
+
GET /api/v1/proxy/namespaces/{namespace}/services/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy PUT requests to Service

+
+
+
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy DELETE requests to Service

+
+
+
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy POST requests to Service

+
+
+
POST /api/v1/proxy/namespaces/{namespace}/services/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy GET requests to Service

+
+
+
GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy PUT requests to Service

+
+
+
PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy DELETE requests to Service

+
+
+
DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy POST requests to Service

+
+
+
POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy GET requests to Node

+
+
+
GET /api/v1/proxy/nodes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy PUT requests to Node

+
+
+
PUT /api/v1/proxy/nodes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy DELETE requests to Node

+
+
+
DELETE /api/v1/proxy/nodes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy POST requests to Node

+
+
+
POST /api/v1/proxy/nodes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy GET requests to Node

+
+
+
GET /api/v1/proxy/nodes/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy PUT requests to Node

+
+
+
PUT /api/v1/proxy/nodes/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy DELETE requests to Node

+
+
+
DELETE /api/v1/proxy/nodes/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

proxy POST requests to Node

+
+
+
POST /api/v1/proxy/nodes/{name}/{path}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

PathParameter

name

name of the Node

true

string

PathParameter

path

path to the resource

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

default

success

string

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind ReplicationController

+
+
+
GET /api/v1/replicationcontrollers
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ReplicationControllerList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind ResourceQuota

+
+
+
GET /api/v1/resourcequotas
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ResourceQuotaList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind Secret

+
+
+
GET /api/v1/secrets
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.SecretList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind ServiceAccount

+
+
+
GET /api/v1/serviceaccounts
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ServiceAccountList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

list or watch objects of kind Service

+
+
+
GET /api/v1/services
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1.ServiceList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of ConfigMap

+
+
+
GET /api/v1/watch/configmaps
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Endpoints

+
+
+
GET /api/v1/watch/endpoints
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Event

+
+
+
GET /api/v1/watch/events
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of LimitRange

+
+
+
GET /api/v1/watch/limitranges
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Namespace

+
+
+
GET /api/v1/watch/namespaces
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of ConfigMap

+
+
+
GET /api/v1/watch/namespaces/{namespace}/configmaps
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind ConfigMap

+
+
+
GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ConfigMap

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Endpoints

+
+
+
GET /api/v1/watch/namespaces/{namespace}/endpoints
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind Endpoints

+
+
+
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Endpoints

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Event

+
+
+
GET /api/v1/watch/namespaces/{namespace}/events
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind Event

+
+
+
GET /api/v1/watch/namespaces/{namespace}/events/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Event

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of LimitRange

+
+
+
GET /api/v1/watch/namespaces/{namespace}/limitranges
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind LimitRange

+
+
+
GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the LimitRange

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of PersistentVolumeClaim

+
+
+
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind PersistentVolumeClaim

+
+
+
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PersistentVolumeClaim

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Pod

+
+
+
GET /api/v1/watch/namespaces/{namespace}/pods
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind Pod

+
+
+
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Pod

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of PodTemplate

+
+
+
GET /api/v1/watch/namespaces/{namespace}/podtemplates
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind PodTemplate

+
+
+
GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the PodTemplate

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of ReplicationController

+
+
+
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind ReplicationController

+
+
+
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ReplicationController

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of ResourceQuota

+
+
+
GET /api/v1/watch/namespaces/{namespace}/resourcequotas
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind ResourceQuota

+
+
+
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ResourceQuota

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Secret

+
+
+
GET /api/v1/watch/namespaces/{namespace}/secrets
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind Secret

+
+
+
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Secret

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of ServiceAccount

+
+
+
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind ServiceAccount

+
+
+
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the ServiceAccount

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Service

+
+
+
GET /api/v1/watch/namespaces/{namespace}/services
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind Service

+
+
+
GET /api/v1/watch/namespaces/{namespace}/services/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

namespace

object name and auth scope, such as for teams and projects

true

string

PathParameter

name

name of the Service

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind Namespace

+
+
+
GET /api/v1/watch/namespaces/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the Namespace

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Node

+
+
+
GET /api/v1/watch/nodes
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind Node

+
+
+
GET /api/v1/watch/nodes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the Node

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of PersistentVolumeClaim

+
+
+
GET /api/v1/watch/persistentvolumeclaims
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of PersistentVolume

+
+
+
GET /api/v1/watch/persistentvolumes
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch changes to an object of kind PersistentVolume

+
+
+
GET /api/v1/watch/persistentvolumes/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

PathParameter

name

name of the PersistentVolume

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Pod

+
+
+
GET /api/v1/watch/pods
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of PodTemplate

+
+
+
GET /api/v1/watch/podtemplates
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of ReplicationController

+
+
+
GET /api/v1/watch/replicationcontrollers
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of ResourceQuota

+
+
+
GET /api/v1/watch/resourcequotas
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Secret

+
+
+
GET /api/v1/watch/secrets
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of ServiceAccount

+
+
+
GET /api/v1/watch/serviceaccounts
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+

watch individual changes to a list of Service

+
+
+
GET /api/v1/watch/services
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

false

string

QueryParameter

timeoutSeconds

Timeout for the list/watch call.

false

integer (int32)

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

*versioned.Event

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/json;stream=watch

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
  • +

    application/vnd.kubernetes.protobuf;stream=watch

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiv1

    +
  • +
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/docs/admin/federation-apiserver.md b/docs/admin/federation-apiserver.md index 4e3cc81bf8..7e2e15c3b1 100644 --- a/docs/admin/federation-apiserver.md +++ b/docs/admin/federation-apiserver.md @@ -20,64 +20,75 @@ 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. + --admission-control string Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysAdmit, AlwaysDeny, NamespaceLifecycle. (default "AlwaysAdmit") + --admission-control-config-file string File with admission control configuration. + --advertise-address value 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 int The number of apiservers running in the cluster. (default 1) + --audit-log-maxage int The maximum number of days to retain old audit log files based on the timestamp encoded in their filename. + --audit-log-maxbackup int The maximum number of old audit log files to retain. + --audit-log-maxsize int The maximum size in megabytes of the audit log file before it gets rotated. Defaults to 100MB. + --audit-log-path string If set, all requests coming to the apiserver will be logged to this file. + --authorization-mode string Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC. (default "AlwaysAllow") + --authorization-policy-file string File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port. + --authorization-rbac-super-user string 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 duration The duration to cache 'authorized' responses from the webhook authorizer. Default is 5m. (default 5m0s) + --authorization-webhook-cache-unauthorized-ttl duration The duration to cache 'unauthorized' responses from the webhook authorizer. Default is 30s. (default 30s) + --authorization-webhook-config-file string File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port. + --basic-auth-file string If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication. + --bind-address value 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). (default 0.0.0.0) + --cert-dir string 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. (default "/var/run/kubernetes") + --client-ca-file string If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate. + --cloud-config string The path to the cloud provider configuration file. Empty string for no configuration file. + --cloud-provider string The provider for cloud services. Empty string for no provider. + --cors-allowed-origins value List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled. (default []) + --delete-collection-workers int Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. (default 1) + --deserialization-cache-size int Number of deserialized json objects to cache in memory. (default 50000) + --enable-swagger-ui Enables swagger ui on the apiserver at /swagger-ui + --etcd-cafile string SSL Certificate Authority file used to secure etcd communication. + --etcd-certfile string SSL certification file used to secure etcd communication. + --etcd-keyfile string SSL key file used to secure etcd communication. + --etcd-prefix string The prefix for all resource paths in etcd. (default "/registry") + --etcd-quorum-read If true, enable quorum read. + --etcd-servers value List of etcd servers to connect with (http://ip:port), comma separated. (default []) + --etcd-servers-overrides value Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated. (default []) + --event-ttl duration Amount of time to retain events. Default is 1h. (default 1h0m0s) + --experimental-keystone-url string If passed, activates the keystone authentication plugin. + --external-hostname string The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs). + --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: +AllAlpha=true|false (ALPHA - default=false) +AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false) +AppArmor=true|false (BETA - default=true) +DynamicKubeletConfig=true|false (ALPHA - default=false) +DynamicVolumeProvisioning=true|false (ALPHA - default=true) + --insecure-bind-address value The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost. (default 127.0.0.1) + --insecure-port int 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. (default 8080) + --kubernetes-service-node-port int If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP. + --long-running-request-regexp string A regular expression matching long running requests which should be excluded from maximum inflight request handling. (default "(/|^)((watch|proxy)(/|$)|(logs?|portforward|exec|attach)/?$)") + --master-service-namespace string The namespace from which the kubernetes master services should be injected into pods. (default "default") + --max-requests-inflight int The maximum number of requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit. (default 400) + --min-request-timeout int 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. (default 1800) + --oidc-ca-file string If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used. + --oidc-client-id string The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set. + --oidc-groups-claim string If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be an array of strings. This flag is experimental, please see the authentication documentation for further details. + --oidc-issuer-url string The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT). + --oidc-username-claim string 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. (default "sub") + --profiling Enable profiling via web interface host:port/debug/pprof/ (default true) + --runtime-config value 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 int The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. (default 6443) + --service-cluster-ip-range value 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 value A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. (default 30000-32767) + --storage-backend string The storage backend for persistence. Options: 'etcd2' (default), 'etcd3'. + --storage-media-type string 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. (default "application/json") + --storage-versions string 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. (default "apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,certificates/v1alpha1,componentconfig/v1alpha1,extensions/v1beta1,federation/v1beta1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,v1") + --target-ram-mb int Memory limit for apiserver in MB (used to configure sizes of caches, etc.) + --tls-cert-file string 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 string File containing x509 private key matching --tls-cert-file. + --token-auth-file string If set, the file that will be used to secure the secure port of the API server via token authentication. + --watch-cache Enable watch caching in the apiserver (default true) + --watch-cache-sizes value 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. (default []) ``` -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/admin/federation-controller-manager.md b/docs/admin/federation-controller-manager.md index 2402aa2c30..8fb25088e7 100644 --- a/docs/admin/federation-controller-manager.md +++ b/docs/admin/federation-controller-manager.md @@ -23,28 +23,28 @@ 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. + --address value The IP address to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0) + --cluster-monitor-period duration The period for syncing ClusterStatus in ClusterController. (default 40s) + --concurrent-replicaset-syncs int The number of ReplicaSets syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load (default 10) + --concurrent-service-syncs int The number of service syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load (default 10) + --dns-provider string DNS provider. Valid values are: ["aws-route53" "google-clouddns"] + --dns-provider-config string Path to config file for configuring DNS provider. + --federated-api-burst int Burst to use while talking with federation apiserver (default 30) + --federated-api-qps value QPS to use while talking with federation apiserver (default 20) + --federation-name string Federation name. + --kube-api-content-type string ContentType of requests sent to apiserver. Passing application/vnd.kubernetes.protobuf is an experimental feature now. + --kubeconfig string Path to kubeconfig file with authorization and master location information. + --leader-elect Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. + --leader-elect-lease-duration duration 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. (default 15s) + --leader-elect-renew-deadline duration 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. (default 10s) + --leader-elect-retry-period duration The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. (default 2s) + --master string The address of the federation API server (overrides any value in kubeconfig) + --port int The port that the controller-manager's http service runs on (default 10253) + --profiling Enable profiling via web interface host:port/debug/pprof/ (default true) + --zone-name string Zone name, like example.com. ``` -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/admin/kube-apiserver.md b/docs/admin/kube-apiserver.md index 97b6bc5520..8eb04089a4 100644 --- a/docs/admin/kube-apiserver.md +++ b/docs/admin/kube-apiserver.md @@ -20,81 +20,91 @@ 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, 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 - --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). - --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-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 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 - --external-hostname="": The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs.) - --google-json-key="": The Google Cloud Platform Service Account JSON Key to use for authentication. - --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. - --kubelet-certificate-authority="": Path to a cert. file for the certificate authority. - --kubelet-client-certificate="": Path to a client cert file for TLS. - --kubelet-client-key="": Path to a client key file for TLS. - --kubelet-https[=true]: Use https for kubelet connections - --kubelet-timeout=5s: Timeout for kubelet operations - --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-connection-bytes-per-sec=0: If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests - --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/ - --repair-malformed-updates[=true]: If true, server will do its best to fix the update request to pass the validation, e.g., setting empty UID in update request to its existing value. This flag can be turned off after we fix all the clients that send malformed updates. - --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-account-key-file="": File containing PEM-encoded x509 RSA private or public key, used to verify ServiceAccount tokens. If unspecified, --tls-private-key-file is used. - --service-account-lookup[=false]: If true, validate ServiceAccount tokens exist in etcd as part of authentication. - --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. - --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-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. - --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. + --admission-control string Ordered list of plug-ins to do admission control of resources into cluster. Comma-delimited list of: AlwaysAdmit, AlwaysDeny, AlwaysPullImages, DefaultStorageClass, DenyEscalatingExec, DenyExecOnPrivileged, ImagePolicyWebhook, InitialResources, LimitPodHardAntiAffinityTopology, LimitRanger, NamespaceAutoProvision, NamespaceExists, NamespaceLifecycle, PersistentVolumeLabel, PodSecurityPolicy, ResourceQuota, SecurityContextDeny, ServiceAccount. (default "AlwaysAdmit") + --admission-control-config-file string File with admission control configuration. + --advertise-address value The IP address on which to advertise the apiserver to members of the cluster. This address must be reachable by the rest of the cluster. If blank, the --bind-address will be used. If --bind-address is unspecified, the host's default interface will be used. + --allow-privileged If true, allow privileged containers. + --apiserver-count int The number of apiservers running in the cluster. (default 1) + --audit-log-maxage int The maximum number of days to retain old audit log files based on the timestamp encoded in their filename. + --audit-log-maxbackup int The maximum number of old audit log files to retain. + --audit-log-maxsize int The maximum size in megabytes of the audit log file before it gets rotated. Defaults to 100MB. + --audit-log-path string If set, all requests coming to the apiserver will be logged to this file. + --authentication-token-webhook-cache-ttl duration The duration to cache responses from the webhook token authenticator. Default is 2m. (default 2m0s) + --authentication-token-webhook-config-file string File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens. + --authorization-mode string Ordered list of plug-ins to do authorization on secure port. Comma-delimited list of: AlwaysAllow,AlwaysDeny,ABAC,Webhook,RBAC. (default "AlwaysAllow") + --authorization-policy-file string File with authorization policy in csv format, used with --authorization-mode=ABAC, on the secure port. + --authorization-rbac-super-user string 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 duration The duration to cache 'authorized' responses from the webhook authorizer. Default is 5m. (default 5m0s) + --authorization-webhook-cache-unauthorized-ttl duration The duration to cache 'unauthorized' responses from the webhook authorizer. Default is 30s. (default 30s) + --authorization-webhook-config-file string File with webhook configuration in kubeconfig format, used with --authorization-mode=Webhook. The API server will query the remote service to determine access on the API server's secure port. + --basic-auth-file string If set, the file that will be used to admit requests to the secure port of the API server via http basic authentication. + --bind-address value 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). (default 0.0.0.0) + --cert-dir string 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. (default "/var/run/kubernetes") + --client-ca-file string If set, any request presenting a client certificate signed by one of the authorities in the client-ca-file is authenticated with an identity corresponding to the CommonName of the client certificate. + --cloud-config string The path to the cloud provider configuration file. Empty string for no configuration file. + --cloud-provider string The provider for cloud services. Empty string for no provider. + --cors-allowed-origins value List of allowed origins for CORS, comma separated. An allowed origin can be a regular expression to support subdomain matching. If this list is empty CORS will not be enabled. (default []) + --delete-collection-workers int Number of workers spawned for DeleteCollection call. These are used to speed up namespace cleanup. (default 1) + --deserialization-cache-size int Number of deserialized json objects to cache in memory. (default 50000) + --enable-garbage-collector Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-controller-manager. (default true) + --enable-swagger-ui Enables swagger ui on the apiserver at /swagger-ui + --etcd-cafile string SSL Certificate Authority file used to secure etcd communication. + --etcd-certfile string SSL certification file used to secure etcd communication. + --etcd-keyfile string SSL key file used to secure etcd communication. + --etcd-prefix string The prefix for all resource paths in etcd. (default "/registry") + --etcd-quorum-read If true, enable quorum read. + --etcd-servers value List of etcd servers to connect with (http://ip:port), comma separated. (default []) + --etcd-servers-overrides value Per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated. (default []) + --event-ttl duration Amount of time to retain events. Default is 1h. (default 1h0m0s) + --experimental-keystone-url string If passed, activates the keystone authentication plugin. + --external-hostname string The hostname to use when generating externalized URLs for this master (e.g. Swagger API Docs). + --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: +AllAlpha=true|false (ALPHA - default=false) +AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false) +AppArmor=true|false (BETA - default=true) +DynamicKubeletConfig=true|false (ALPHA - default=false) +DynamicVolumeProvisioning=true|false (ALPHA - default=true) + --google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication. + --insecure-bind-address value The IP address on which to serve the --insecure-port (set to 0.0.0.0 for all interfaces). Defaults to localhost. (default 127.0.0.1) + --insecure-port int 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. (default 8080) + --kubelet-certificate-authority string Path to a cert file for the certificate authority. + --kubelet-client-certificate string Path to a client cert file for TLS. + --kubelet-client-key string Path to a client key file for TLS. + --kubelet-https Use https for kubelet connections. (default true) + --kubelet-timeout duration Timeout for kubelet operations. (default 5s) + --kubernetes-service-node-port int If non-zero, the Kubernetes master service (which apiserver creates/maintains) will be of type NodePort, using this as the value of the port. If zero, the Kubernetes master service will be of type ClusterIP. + --long-running-request-regexp string A regular expression matching long running requests which should be excluded from maximum inflight request handling. (default "(/|^)((watch|proxy)(/|$)|(logs?|portforward|exec|attach)/?$)") + --master-service-namespace string The namespace from which the kubernetes master services should be injected into pods. (default "default") + --max-connection-bytes-per-sec int If non-zero, throttle each user connection to this number of bytes/sec. Currently only applies to long-running requests. + --max-requests-inflight int The maximum number of requests in flight at a given time. When the server exceeds this, it rejects requests. Zero for no limit. (default 400) + --min-request-timeout int 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. (default 1800) + --oidc-ca-file string If set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file, otherwise the host's root CA set will be used. + --oidc-client-id string The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set. + --oidc-groups-claim string If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be an array of strings. This flag is experimental, please see the authentication documentation for further details. + --oidc-issuer-url string The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT). + --oidc-username-claim string 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. (default "sub") + --profiling Enable profiling via web interface host:port/debug/pprof/ (default true) + --repair-malformed-updates If true, server will do its best to fix the update request to pass the validation, e.g., setting empty UID in update request to its existing value. This flag can be turned off after we fix all the clients that send malformed updates. (default true) + --runtime-config value 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 int The port on which to serve HTTPS with authentication and authorization. If 0, don't serve HTTPS at all. (default 6443) + --service-account-key-file string File containing PEM-encoded x509 RSA private or public key, used to verify ServiceAccount tokens. If unspecified, --tls-private-key-file is used. + --service-account-lookup If true, validate ServiceAccount tokens exist in etcd as part of authentication. + --service-cluster-ip-range value 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 value A port range to reserve for services with NodePort visibility. Example: '30000-32767'. Inclusive at both ends of the range. (default 30000-32767) + --ssh-keyfile string If non-empty, use secure SSH proxy to the nodes, using this user keyfile + --ssh-user string If non-empty, use secure SSH proxy to the nodes, using this user name + --storage-backend string The storage backend for persistence. Options: 'etcd2' (default), 'etcd3'. + --storage-media-type string 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. (default "application/json") + --storage-versions string 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. (default "apps/v1alpha1,authentication.k8s.io/v1beta1,authorization.k8s.io/v1beta1,autoscaling/v1,batch/v1,certificates/v1alpha1,componentconfig/v1alpha1,extensions/v1beta1,imagepolicy.k8s.io/v1alpha1,policy/v1alpha1,rbac.authorization.k8s.io/v1alpha1,v1") + --target-ram-mb int Memory limit for apiserver in MB (used to configure sizes of caches, etc.) + --tls-cert-file string 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 string File containing x509 private key matching --tls-cert-file. + --token-auth-file string If set, the file that will be used to secure the secure port of the API server via token authentication. + --watch-cache Enable watch caching in the apiserver (default true) + --watch-cache-sizes value 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. (default []) ``` -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/admin/kube-controller-manager.md b/docs/admin/kube-controller-manager.md index 1c63d998c4..2af4899176 100644 --- a/docs/admin/kube-controller-manager.md +++ b/docs/admin/kube-controller-manager.md @@ -24,68 +24,81 @@ kube-controller-manager ### Options ``` - --address=0.0.0.0: The IP address to serve on (set to 0.0.0.0 for all interfaces) - --allocate-node-cidrs[=false]: Should CIDRs for Pods be allocated and set on the cloud provider. - --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-cidr="": CIDR Range for Pods in cluster. - --cluster-name="kubernetes": The instance prefix for the cluster - --concurrent-deployment-syncs=5: The number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) load - --concurrent-endpoint-syncs=5: The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load - --concurrent-namespace-syncs=2: The number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) load - --concurrent-replicaset-syncs=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=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. - --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 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. - --node-sync-period=10s: The period for syncing nodes from cloudprovider. Longer periods will result in fewer calls to cloud provider, but may delay addition of new nodes to cluster. - --pod-eviction-timeout=5m0s: The grace period for deleting pods on failed nodes. - --port=10252: The port that the controller-manager's http service runs on - --profiling[=true]: Enable profiling via web interface host:port/debug/pprof/ - --pv-recycler-increment-timeout-nfs=30: the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod - --pv-recycler-minimum-timeout-hostpath=60: The minimum ActiveDeadlineSeconds to use for a HostPath Recycler pod. This is for development and testing only and will not work in a multi-node cluster. - --pv-recycler-minimum-timeout-nfs=300: The minimum ActiveDeadlineSeconds to use for an NFS Recycler pod - --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=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. + --address value The IP address to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0) + --allocate-node-cidrs Should CIDRs for Pods be allocated and set on the cloud provider. + --cloud-config string The path to the cloud provider configuration file. Empty string for no configuration file. + --cloud-provider string The provider for cloud services. Empty string for no provider. + --cluster-cidr string CIDR Range for Pods in cluster. + --cluster-name string The instance prefix for the cluster (default "kubernetes") + --cluster-signing-cert-file string Filename containing a PEM-encoded X509 CA certificate used to issue cluster-scoped certificates (default "/etc/kubernetes/ca/ca.pem") + --cluster-signing-key-file string Filename containing a PEM-encoded RSA or ECDSA private key used to sign cluster-scoped certificates (default "/etc/kubernetes/ca/ca.key") + --concurrent-deployment-syncs value The number of deployment objects that are allowed to sync concurrently. Larger number = more responsive deployments, but more CPU (and network) load (default 5) + --concurrent-endpoint-syncs value The number of endpoint syncing operations that will be done concurrently. Larger number = faster endpoint updating, but more CPU (and network) load (default 5) + --concurrent-gc-syncs value The number of garbage collector workers that are allowed to sync concurrently. (default 20) + --concurrent-namespace-syncs value The number of namespace objects that are allowed to sync concurrently. Larger number = more responsive namespace termination, but more CPU (and network) load (default 2) + --concurrent-replicaset-syncs value The number of replica sets that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load (default 5) + --concurrent-resource-quota-syncs value The number of resource quotas that are allowed to sync concurrently. Larger number = more responsive quota management, but more CPU (and network) load (default 5) + --concurrent-service-syncs value The number of services that are allowed to sync concurrently. Larger number = more responsive service management, but more CPU (and network) load (default 1) + --concurrent-serviceaccount-token-syncs value The number of service account token objects that are allowed to sync concurrently. Larger number = more responsive token generation, but more CPU (and network) load (default 5) + --concurrent_rc_syncs value The number of replication controllers that are allowed to sync concurrently. Larger number = more responsive replica management, but more CPU (and network) load (default 5) + --configure-cloud-routes Should CIDRs allocated by allocate-node-cidrs be configured on the cloud provider. (default true) + --controller-start-interval duration Interval between starting controller managers. + --daemonset-lookup-cache-size value The the size of lookup cache for daemonsets. Larger number = more responsive daemonsets, but more MEM load. (default 1024) + --deployment-controller-sync-period duration Period for syncing the deployments. (default 30s) + --enable-dynamic-provisioning Enable dynamic provisioning for environments that support it. (default true) + --enable-garbage-collector Enables the generic garbage collector. MUST be synced with the corresponding flag of the kube-apiserver. (default true) + --enable-hostpath-provisioner Enable HostPath PV provisioning when running without a cloud provider. This allows testing and development of provisioning features. HostPath provisioning is not supported in any way, won't work in a multi-node cluster, and should not be used for anything other than testing or development. + --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: +AllAlpha=true|false (ALPHA - default=false) +AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false) +AppArmor=true|false (BETA - default=true) +DynamicKubeletConfig=true|false (ALPHA - default=false) +DynamicVolumeProvisioning=true|false (ALPHA - default=true) + --flex-volume-plugin-dir string Full path of the directory in which the flex volume plugin should search for additional third party volume plugins. (default "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/") + --google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication. + --horizontal-pod-autoscaler-sync-period duration The period for syncing the number of pods in horizontal pod autoscaler. (default 30s) + --insecure-experimental-approve-all-kubelet-csrs-for-group string The group for which the controller-manager will auto approve all CSRs for kubelet client certificates. + --kube-api-burst value Burst to use while talking with kubernetes apiserver (default 30) + --kube-api-content-type string Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf") + --kube-api-qps value QPS to use while talking with kubernetes apiserver (default 20) + --kubeconfig string Path to kubeconfig file with authorization and master location information. + --large-cluster-size-threshold value Number of nodes from which NodeController treats the cluster as large for the eviction logic purposes. --secondary-node-eviction-rate is implicitly overridden to 0 for clusters this size or smaller. (default 50) + --leader-elect Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. (default true) + --leader-elect-lease-duration duration 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. (default 15s) + --leader-elect-renew-deadline duration 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. (default 10s) + --leader-elect-retry-period duration The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. (default 2s) + --master string The address of the Kubernetes API server (overrides any value in kubeconfig) + --min-resync-period duration The resync period in reflectors will be random between MinResyncPeriod and 2*MinResyncPeriod (default 12h0m0s) + --namespace-sync-period duration The period for syncing namespace life-cycle updates (default 5m0s) + --node-cidr-mask-size value Mask size for node cidr in cluster. (default 24) + --node-eviction-rate value Number of nodes per second on which pods are deleted in case of node failure when a zone is healthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. (default 0.1) + --node-monitor-grace-period duration Amount of time which we allow running Node to be unresponsive before marking it unhealthy. Must be N times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status. (default 40s) + --node-monitor-period duration The period for syncing NodeStatus in NodeController. (default 5s) + --node-startup-grace-period duration Amount of time which we allow starting Node to be unresponsive before marking it unhealthy. (default 1m0s) + --node-sync-period duration The period for syncing nodes from cloudprovider. Longer periods will result in fewer calls to cloud provider, but may delay addition of new nodes to cluster. (default 10s) + --pod-eviction-timeout duration The grace period for deleting pods on failed nodes. (default 5m0s) + --port value The port that the controller-manager's http service runs on (default 10252) + --profiling Enable profiling via web interface host:port/debug/pprof/ (default true) + --pv-recycler-increment-timeout-nfs value the increment of time added per Gi to ActiveDeadlineSeconds for an NFS scrubber pod (default 30) + --pv-recycler-minimum-timeout-hostpath value The minimum ActiveDeadlineSeconds to use for a HostPath Recycler pod. This is for development and testing only and will not work in a multi-node cluster. (default 60) + --pv-recycler-minimum-timeout-nfs value The minimum ActiveDeadlineSeconds to use for an NFS Recycler pod (default 300) + --pv-recycler-pod-template-filepath-hostpath string The file path to a pod definition used as a template for HostPath persistent volume recycling. This is for development and testing only and will not work in a multi-node cluster. + --pv-recycler-pod-template-filepath-nfs string The file path to a pod definition used as a template for NFS persistent volume recycling + --pv-recycler-timeout-increment-hostpath value 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. (default 30) + --pvclaimbinder-sync-period duration The period for syncing persistent volumes and persistent volume claims (default 15s) + --replicaset-lookup-cache-size value The the size of lookup cache for replicatsets. Larger number = more responsive replica management, but more MEM load. (default 4096) + --replication-controller-lookup-cache-size value The the size of lookup cache for replication controllers. Larger number = more responsive replica management, but more MEM load. (default 4096) + --resource-quota-sync-period duration The period for syncing quota usage status in the system (default 5m0s) + --root-ca-file string If set, this root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle. + --secondary-node-eviction-rate value Number of nodes per second on which pods are deleted in case of node failure when a zone is unhealthy (see --unhealthy-zone-threshold for definition of healthy/unhealthy). Zone refers to entire cluster in non-multizone clusters. This value is implicitly overridden to 0 if the cluster size is smaller than --large-cluster-size-threshold. (default 0.01) + --service-account-private-key-file string Filename containing a PEM-encoded private RSA key used to sign service account tokens. + --service-cluster-ip-range string CIDR Range for Services in cluster. + --service-sync-period duration The period for syncing services with their external load balancers (default 5m0s) + --terminated-pod-gc-threshold value 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. (default 12500) + --unhealthy-zone-threshold value Fraction of Nodes in a zone which needs to be not Ready (minimum 3) for zone to be treated as unhealthy. (default 0.55) ``` -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/admin/kube-proxy.md b/docs/admin/kube-proxy.md index 3b8fe94209..bee1964392 100644 --- a/docs/admin/kube-proxy.md +++ b/docs/admin/kube-proxy.md @@ -23,33 +23,38 @@ kube-proxy ### Options ``` - --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=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) - --healthz-port=10249: The port to bind the health check server. Use 0 to disable. - --hostname-override="": If non-empty, will use this string as identification instead of the actual hostname. - --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 - --masquerade-all[=false]: If using the pure iptables proxy, SNAT everything - --master="": The address of the Kubernetes API server (overrides any value in kubeconfig) - --oom-score-adj=-999: The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000] - --proxy-mode=: Which proxy mode to use: 'userspace' (older) or 'iptables' (faster). If blank, look at the Node object on the Kubernetes API and respect the 'net.experimental.kubernetes.io/proxy-mode' annotation if provided. Otherwise use the best-available proxy (currently iptables). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy. - --proxy-port-range=: Range of host ports (beginPort-endPort, inclusive) that may be consumed in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen. - --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 + --bind-address value The IP address for the proxy server to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0) + --cleanup-iptables If true cleanup iptables rules and exit. + --cluster-cidr string 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 duration How often configuration from the apiserver is refreshed. Must be greater than 0. (default 15m0s) + --conntrack-max value Maximum number of NAT connections to track (0 to leave as-is). + --conntrack-max-per-core value Maximum number of NAT connections to track per CPU core (0 to leave as-is). This is only considered if conntrack-max is 0. (default 32768) + --conntrack-tcp-timeout-established duration Idle timeout for established TCP connections (0 to leave as-is) (default 24h0m0s) + --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: +AllAlpha=true|false (ALPHA - default=false) +AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false) +AppArmor=true|false (BETA - default=true) +DynamicKubeletConfig=true|false (ALPHA - default=false) +DynamicVolumeProvisioning=true|false (ALPHA - default=true) + --google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication. + --healthz-bind-address value 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) (default 127.0.0.1) + --healthz-port value The port to bind the health check server. Use 0 to disable. (default 10249) + --hostname-override string If non-empty, will use this string as identification instead of the actual hostname. + --iptables-masquerade-bit value 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]. (default 14) + --iptables-sync-period duration How often iptables rules are refreshed (e.g. '5s', '1m', '2h22m'). Must be greater than 0. (default 30s) + --kube-api-burst value Burst to use while talking with kubernetes apiserver (default 10) + --kube-api-content-type string Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf") + --kube-api-qps value QPS to use while talking with kubernetes apiserver (default 5) + --kubeconfig string Path to kubeconfig file with authorization information (the master location is set by the master flag). + --masquerade-all If using the pure iptables proxy, SNAT everything + --master string The address of the Kubernetes API server (overrides any value in kubeconfig) + --oom-score-adj value The oom-score-adj value for kube-proxy process. Values must be within the range [-1000, 1000] (default -999) + --proxy-mode value Which proxy mode to use: 'userspace' (older) or 'iptables' (faster). If blank, look at the Node object on the Kubernetes API and respect the 'net.experimental.kubernetes.io/proxy-mode' annotation if provided. Otherwise use the best-available proxy (currently iptables). If the iptables proxy is selected, regardless of how, but the system's kernel or iptables versions are insufficient, this always falls back to the userspace proxy. + --proxy-port-range value Range of host ports (beginPort-endPort, inclusive) that may be consumed in order to proxy service traffic. If unspecified (0-0) then ports will be randomly chosen. + --udp-timeout duration 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 (default 250ms) ``` -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/admin/kube-scheduler.md b/docs/admin/kube-scheduler.md index 285a314d87..c1f1c24911 100644 --- a/docs/admin/kube-scheduler.md +++ b/docs/admin/kube-scheduler.md @@ -23,28 +23,33 @@ kube-scheduler ### Options ``` - --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. - --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 Kubernetes API server (overrides any value in kubeconfig) - --policy-config-file="": File with scheduler policy configuration - --port=10251: The port that the scheduler's http service runs on - --profiling[=true]: Enable profiling via web interface host:port/debug/pprof/ - --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' + --address string The IP address to serve on (set to 0.0.0.0 for all interfaces) (default "0.0.0.0") + --algorithm-provider string The scheduling algorithm provider to use, one of: DefaultProvider | ClusterAutoscalerProvider (default "DefaultProvider") + --failure-domains string Indicate the "all topologies" set for an empty topologyKey when it's used for PreferredDuringScheduling pod anti-affinity. (default "kubernetes.io/hostname,failure-domain.beta.kubernetes.io/zone,failure-domain.beta.kubernetes.io/region") + --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: +DynamicKubeletConfig=true|false (ALPHA - default=false) +DynamicVolumeProvisioning=true|false (ALPHA - default=true) +AllAlpha=true|false (ALPHA - default=false) +AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false) +AppArmor=true|false (BETA - default=true) + --google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication. + --hard-pod-affinity-symmetric-weight int 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. (default 1) + --kube-api-burst value Burst to use while talking with kubernetes apiserver (default 100) + --kube-api-content-type string Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf") + --kube-api-qps value QPS to use while talking with kubernetes apiserver (default 50) + --kubeconfig string Path to kubeconfig file with authorization and master location information. + --leader-elect Start a leader election client and gain leadership before executing the main loop. Enable this when running replicated components for high availability. (default true) + --leader-elect-lease-duration duration 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. (default 15s) + --leader-elect-renew-deadline duration 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. (default 10s) + --leader-elect-retry-period duration The duration the clients should wait between attempting acquisition and renewal of a leadership. This is only applicable if leader election is enabled. (default 2s) + --master string The address of the Kubernetes API server (overrides any value in kubeconfig) + --policy-config-file string File with scheduler policy configuration + --port value The port that the scheduler's http service runs on (default 10251) + --profiling Enable profiling via web interface host:port/debug/pprof/ (default true) + --scheduler-name string 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' (default "default-scheduler") ``` -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/admin/kubelet.md b/docs/admin/kubelet.md index d3123f6d6c..ce5855289f 100644 --- a/docs/admin/kubelet.md +++ b/docs/admin/kubelet.md @@ -12,7 +12,8 @@ The kubelet is the primary "node agent" that runs on each node. The kubelet works in terms of a PodSpec. A PodSpec is a YAML or JSON object that describes a pod. The kubelet takes a set of PodSpecs that are provided through various mechanisms (primarily through the apiserver) and ensures that the containers -described in those PodSpecs are running and healthy. +described in those PodSpecs are running and healthy. The kubelet doesn't manage +containers which were not created by Kubernetes. Other than from an PodSpec from the apiserver, there are three ways that a container manifest can be provided to the Kubelet. @@ -33,107 +34,119 @@ kubelet ### Options ``` - --address=0.0.0.0: The IP address for the Kubelet to serve on (set to 0.0.0.0 for all interfaces) - --allow-privileged[=false]: If true, allow containers to request privileged mode. [default=false] - --api-servers=[]: List of Kubernetes API servers for publishing events, and reading pods and services. (ip:port), comma separated. - --cadvisor-port=4194: The port of the localhost cAdvisor endpoint - --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. - --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="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. - --container-runtime="docker": The container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'. - --containerized[=false]: Experimental support for running kubelet in a container. Intended for testing. [default=false] - --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". - --healthz-bind-address=127.0.0.1: The IP address for the healthz server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces) - --healthz-port=10248: The port of the localhost healthz endpoint - --host-ipc-sources="*": Comma-separated list of sources from which the Kubelet allows pods to use the host ipc namespace. [default="*"] - --host-network-sources="*": Comma-separated list of sources from which the Kubelet allows pods to use of host network. [default="*"] - --host-pid-sources="*": Comma-separated list of sources from which the Kubelet allows pods to use the host pid namespace. [default="*"] - --hostname-override="": If non-empty, will use this string as identification instead of the actual hostname. - --http-check-frequency=20s: Duration between checking http for new data - --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/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. - --log-flush-frequency=5s: Maximum number of seconds between log flushes - --low-diskspace-threshold-mb=256: The absolute free disk space, in MB, to maintain. When disk space falls below this threshold, new pods would be rejected. Default: 256 - --manifest-url="": URL for accessing the container manifest - --manifest-url-header="": HTTP header to use when accessing the manifest URL, with the key separated from the value with a ':', as in 'key:value' - --master-service-namespace="default": The namespace from which the kubernetes master services should be injected into pods - --max-open-files=1000000: Number of files that can be opened by Kubelet process. [default=1000000] - --max-pods=110: Number of Pods that can run on this Kubelet. - --maximum-dead-containers=240: Maximum number of old instances of containers to retain globally. Each container takes up some disk space. Default: 100. - --maximum-dead-containers-per-container=2: Maximum number of old instances to retain per container. Each container takes up some disk space. Default: 2. - --minimum-container-ttl-duration=1m0s: Minimum age for a finished container before it is garbage collected. Examples: '300ms', '10s' or '2h45m' - --minimum-image-ttl-duration=2m0s: Minimum age for a unused image before it is garbage collected. Examples: '300ms', '10s' or '2h45m'. Default: '2m' - --network-plugin="": The name of the network plugin to be invoked for various events in kubelet/pod lifecycle - --network-plugin-dir="/usr/libexec/kubernetes/kubelet-plugins/net/exec/": The full path of the directory in which to search for network plugins - --node-ip="": IP address of the node. If set, kubelet will use this IP address for the node - --node-labels=: Labels to add when registering the node in the cluster. Labels must be key=value pairs separated by ','. - --node-status-update-frequency=10s: Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller. Default: 10s - --non-masquerade-cidr="10.0.0.0/8": Traffic to IPs outside this range will use IP masquerade. - --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-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. - --reconcile-cidr[=true]: Reconcile node CIDR with the CIDR specified by the API server. No-op if register-node or configure-cbr0 is false. [default=true] - --register-node[=true]: Register the node with the apiserver (defaults to true if --api-servers is set) - --register-schedulable[=true]: Register the node as schedulable. No-op if register-node is false. [default=true] - --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-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/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' + --address value The IP address for the Kubelet to serve on (set to 0.0.0.0 for all interfaces) (default 0.0.0.0) + --allow-privileged If true, allow containers to request privileged mode. [default=false] + --cadvisor-port value The port of the localhost cAdvisor endpoint (default 4194) + --cert-dir string 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. (default "/var/run/kubernetes") + --cgroup-root string Optional root cgroup to use for pods. This is handled by the container runtime on a best effort basis. Default: '', which means use the container runtime default. + --chaos-chance float If > 0.0, introduce random client errors and latency. Intended for testing. [default=0.0] + --cloud-config string The path to the cloud provider configuration file. Empty string for no configuration file. + --cloud-provider string The provider for cloud services. By default, kubelet will attempt to auto-detect the cloud provider. Specify empty string for running with no cloud provider. [default=auto-detect] (default "auto-detect") + --cluster-dns string IP address for a cluster DNS server. This value is used for containers' DNS server in case of Pods with "dnsPolicy=ClusterFirst" + --cluster-domain string Domain for this cluster. If set, kubelet will configure all containers to search this domain in addition to the host's search domains + --configure-cbr0 If true, kubelet will configure cbr0 based on Node.Spec.PodCIDR. + --container-runtime string The container runtime to use. Possible values: 'docker', 'rkt'. Default: 'docker'. (default "docker") + --container-runtime-endpoint string The unix socket endpoint of remote runtime service. If not empty, this option will override --container-runtime. This is an experimental feature. Intended for testing only. + --containerized Experimental support for running kubelet in a container. Intended for testing. [default=false] + --cpu-cfs-quota Enable CPU CFS quota enforcement for containers that specify CPU limits (default true) + --docker-endpoint string Use this for the docker endpoint to communicate with (default "unix:///var/run/docker.sock") + --docker-exec-handler string Handler to use when executing a command in a container. Valid values are 'native' and 'nsenter'. Defaults to 'native'. (default "native") + --enable-controller-attach-detach Enables the Attach/Detach controller to manage attachment/detachment of volumes scheduled to this node, and disables kubelet from executing any attach/detach operations (default true) + --enable-custom-metrics Support for gathering custom metrics. + --enable-debugging-handlers Enables server endpoints for log collection and local running of containers and commands (default true) + --enable-server Enable the Kubelet's server (default true) + --event-burst value 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 (default 10) + --event-qps value If > 0, limit event creations per second to this value. If 0, unlimited. (default 5) + --eviction-hard string A set of eviction thresholds (e.g. memory.available<1Gi) that if met would trigger a pod eviction. (default "memory.available<100Mi") + --eviction-max-pod-grace-period value Maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. If negative, defer to pod specified value. + --eviction-minimum-reclaim string A set of minimum reclaims (e.g. imagefs.available=2Gi) that describes the minimum amount of resource the kubelet will reclaim when performing a pod eviction if that resource is under pressure. + --eviction-pressure-transition-period duration Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition. (default 5m0s) + --eviction-soft string 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 string A set of eviction grace periods (e.g. memory.available=1m30s) that correspond to how long a soft eviction threshold must hold before triggering a pod eviction. + --exit-on-lock-contention Whether kubelet should exit upon lock-file contention. + --experimental-allowed-unsafe-sysctls value Comma-separated whitelist of unsafe sysctls or unsafe sysctl patterns (ending in *). Use these at your own risk. (default []) + --experimental-bootstrap-kubeconfig string Path to a kubeconfig file that will be used to get client certificate for kubelet. If the file specified by --kubeconfig does not exist, the bootstrap kubeconfig is used to request a client certificate from the API server. On success, a kubeconfig file referencing the generated key and obtained certificate is written to the path specified by --kubeconfig. The certificate and key file will be stored in the directory pointed by --cert-dir. + --experimental-flannel-overlay 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 value Number of NVIDIA GPU devices on this node. Only 0 (default) and 1 are currently supported. + --feature-gates value A set of key=value pairs that describe feature gates for alpha/experimental features. Options are: +AllAlpha=true|false (ALPHA - default=false) +AllowExtTrafficLocalEndpoints=true|false (ALPHA - default=false) +AppArmor=true|false (BETA - default=true) +DynamicKubeletConfig=true|false (ALPHA - default=false) +DynamicVolumeProvisioning=true|false (ALPHA - default=true) + --file-check-frequency duration Duration between checking config files for new data (default 20s) + --google-json-key string The Google Cloud Platform Service Account JSON Key to use for authentication. + --hairpin-mode string 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". (default "promiscuous-bridge") + --healthz-bind-address value The IP address for the healthz server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces) (default 127.0.0.1) + --healthz-port value The port of the localhost healthz endpoint (default 10248) + --host-ipc-sources value Comma-separated list of sources from which the Kubelet allows pods to use the host ipc namespace. [default="*"] (default [*]) + --host-network-sources value Comma-separated list of sources from which the Kubelet allows pods to use of host network. [default="*"] (default [*]) + --host-pid-sources value Comma-separated list of sources from which the Kubelet allows pods to use the host pid namespace. [default="*"] (default [*]) + --hostname-override string If non-empty, will use this string as identification instead of the actual hostname. + --http-check-frequency duration Duration between checking http for new data (default 20s) + --image-gc-high-threshold value The percent of disk usage after which image garbage collection is always run. Default: 90% (default 90) + --image-gc-low-threshold value The percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. Default: 80% (default 80) + --image-service-endpoint string The unix socket endpoint of remote image service. If not specified, it will be the same with container-runtime-endpoint by default. This is an experimental feature. Intended for testing only. + --iptables-drop-bit value The bit of the fwmark space to mark packets for dropping. Must be within the range [0, 31]. (default 15) + --iptables-masquerade-bit value The bit of the fwmark space to mark packets for SNAT. Must be within the range [0, 31]. Please match this parameter with corresponding parameter in kube-proxy. (default 14) + --kube-api-burst value Burst to use while talking with kubernetes apiserver (default 10) + --kube-api-content-type string Content type of requests sent to apiserver. (default "application/vnd.kubernetes.protobuf") + --kube-api-qps value QPS to use while talking with kubernetes apiserver (default 5) + --kube-reserved value 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.4/docs/user-guide/compute-resources.md for more detail. [default=none] + --kubeconfig value Path to a kubeconfig file, specifying how to connect to the API server. --api-servers will be used for the location unless --require-kubeconfig is set. (default "/var/lib/kubelet/kubeconfig") + --kubelet-cgroups string Optional absolute name of cgroups to create and run the Kubelet in. + --lock-file string The path to file for kubelet to use as a lock file. + --low-diskspace-threshold-mb value The absolute free disk space, in MB, to maintain. When disk space falls below this threshold, new pods would be rejected. Default: 256 (default 256) + --make-iptables-util-chains If true, kubelet will ensure iptables utility rules are present on host. (default true) + --manifest-url string URL for accessing the container manifest + --manifest-url-header string HTTP header to use when accessing the manifest URL, with the key separated from the value with a ':', as in 'key:value' + --master-service-namespace string The namespace from which the kubernetes master services should be injected into pods (default "default") + --max-open-files int Number of files that can be opened by Kubelet process. [default=1000000] (default 1000000) + --max-pods value Number of Pods that can run on this Kubelet. (default 110) + --minimum-image-ttl-duration duration Minimum age for an unused image before it is garbage collected. Examples: '300ms', '10s' or '2h45m'. Default: '2m' (default 2m0s) + --network-plugin string The name of the network plugin to be invoked for various events in kubelet/pod lifecycle + --network-plugin-dir string The full path of the directory in which to search for network plugins (default "/usr/libexec/kubernetes/kubelet-plugins/net/exec/") + --network-plugin-mtu value The MTU to be passed to the network plugin, to override the default. Set to 0 to use the default 1460 MTU. + --node-ip string IP address of the node. If set, kubelet will use this IP address for the node + --node-labels value Labels to add when registering the node in the cluster. Labels must be key=value pairs separated by ','. + --node-status-update-frequency duration Specifies how often kubelet posts node status to master. Note: be cautious when changing the constant, it must work with nodeMonitorGracePeriod in nodecontroller. Default: 10s (default 10s) + --non-masquerade-cidr string Traffic to IPs outside this range will use IP masquerade. (default "10.0.0.0/8") + --oom-score-adj value The oom-score-adj value for kubelet process. Values must be within the range [-1000, 1000] (default -999) + --outofdisk-transition-frequency duration Duration for which the kubelet has to wait before transitioning out of out-of-disk node condition status. Default: 5m0s (default 5m0s) + --pod-cidr string The CIDR to use for pod IP addresses, only used in standalone mode. In cluster mode, this is obtained from the master. + --pod-infra-container-image string The image whose network/ipc namespaces containers in each pod will use. (default "gcr.io/google_containers/pause-amd64:3.0") + --pod-manifest-path string Path to to the directory containing pod manifest files to run, or the path to a single pod manifest file. + --pods-per-core value 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 value The port for the Kubelet to serve on. (default 10250) + --protect-kernel-defaults Default kubelet behaviour for kernel tuning. If set, kubelet errors if any of kernel tunables is different than kubelet defaults. + --read-only-port value The read-only port for the Kubelet to serve on with no authentication/authorization (set to 0 to disable) (default 10255) + --really-crash-for-testing If true, when panics occur crash. Intended for testing. + --reconcile-cidr Reconcile node CIDR with the CIDR specified by the API server. No-op if register-node or configure-cbr0 is false. [default=true] (default true) + --register-node Register the node with the apiserver (defaults to true if --api-servers is set) (default true) + --register-schedulable Register the node as schedulable. No-op if register-node is false. [default=true] (default true) + --registry-burst value 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 (default 10) + --registry-qps value If > 0, limit registry pull QPS to this value. If 0, unlimited. [default=5.0] (default 5) + --require-kubeconfig If true the Kubelet will exit if there are configuration errors, and will ignore the value of --api-servers in favor of the server defined in the kubeconfig file. + --resolv-conf string Resolver configuration file used as the basis for the container DNS resolution configuration. (default "/etc/resolv.conf") + --rkt-api-endpoint string The endpoint of the rkt API service to communicate with. Only used if --container-runtime='rkt'. (default "localhost:15441") + --rkt-path string Path of rkt binary. Leave empty to use the first rkt in $PATH. Only used if --container-runtime='rkt'. + --root-dir string Directory path for managing kubelet files (volume mounts,etc). (default "/var/lib/kubelet") + --runonce If true, exit after spawning pods from local manifests or remote urls. Exclusive with --api-servers, and --enable-server + --runtime-cgroups string Optional absolute name of cgroups to create and run the runtime in. + --runtime-request-timeout duration 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 (default 2m0s) + --seccomp-profile-root string Directory path for seccomp profiles. + --serialize-image-pulls 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] (default true) + --streaming-connection-idle-timeout duration Maximum time a streaming connection can be idle before the connection is automatically closed. 0 indicates no timeout. Example: '5m' (default 4h0m0s) + --sync-frequency duration Max period between synchronizing running containers and config (default 1m0s) + --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 value 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.4/docs/user-guide/compute-resources.md for more detail. [default=none] + --tls-cert-file string 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 string File containing x509 private key matching --tls-cert-file. + --volume-plugin-dir string The full path of the directory in which to search for additional third party volume plugins (default "/usr/libexec/kubernetes/kubelet-plugins/volume/exec/") + --volume-stats-agg-period duration 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' (default 1m0s) ``` -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/api-reference/README.md b/docs/api-reference/README.md index c16807023b..3e47db14f5 100644 --- a/docs/api-reference/README.md +++ b/docs/api-reference/README.md @@ -5,10 +5,10 @@ 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) +* v1: [operations](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/api-reference/v1/operations.html), [model definitions](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/api-reference/v1/definitions.html) +* extensions/v1beta1: [operations](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/api-reference/extensions/v1beta1/operations.html), [model definitions](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/api-reference/extensions/v1beta1/definitions.html) +* batch/v1: [operations](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/api-reference/batch/v1/operations.html), [model definitions](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/api-reference/batch/v1/definitions.html) +* autoscaling/v1: [operations](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/api-reference/autoscaling/v1/operations.html), [model definitions](https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/api-reference/autoscaling/v1/definitions.html) diff --git a/docs/api-reference/autoscaling/v1/definitions.html b/docs/api-reference/autoscaling/v1/definitions.html index 232ba081fa..6c46cb9ff8 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.3/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.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

-

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

false

string

@@ -123,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.3/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.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

-

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

false

string

@@ -192,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.3/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.4/docs/devel/api-conventions.md#types-kinds

false

string

@@ -251,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.3/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.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

@@ -319,14 +319,14 @@

kind

-

Kind of the referent; More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds"

+

Kind of the referent; More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds"

true

string

name

-

Name of the referent; More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

+

Name of the referent; More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

true

string

@@ -367,14 +367,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.3/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.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

-

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

false

string

@@ -422,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.3/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.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

-

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

+

Standard object metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

-

behaviour of autoscaler. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status.

+

behaviour of autoscaler. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status.

false

v1.HorizontalPodAutoscalerSpec

@@ -484,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.3/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.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

-

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

+

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

status

-

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

false

string

@@ -624,7 +624,7 @@

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

+

string (date-time)

@@ -732,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.3/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.4/docs/user-guide/identifiers.md#names

false

string

@@ -743,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.3/docs/devel/api-conventions.md#idempotency

+Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

false

string

@@ -752,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.3/docs/user-guide/namespaces.md

+Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

false

string

@@ -768,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.3/docs/user-guide/identifiers.md#uids

+Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

false

string

@@ -777,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.3/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.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

@@ -793,18 +793,18 @@ 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.3/docs/devel/api-conventions.md#metadata

+Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

-

string

+

string (date-time)

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.

-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#metadata

false

-

string

+

string (date-time)

@@ -816,14 +816,14 @@ 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.3/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.4/docs/user-guide/labels.md

false

object

annotations

-

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/annotations.md

false

object

@@ -842,6 +842,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

string array

+ +

clusterName

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

false

+

string

+ + @@ -878,21 +885,21 @@ 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.3/docs/devel/api-conventions.md#types-kinds

+

Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

true

string

name

-

Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

+

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

true

string

uid

-

UID of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

+

UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

true

string

@@ -975,7 +982,7 @@ Examples:
diff --git a/docs/api-reference/autoscaling/v1/operations.html b/docs/api-reference/autoscaling/v1/operations.html index 2ad7f66bdc..5670745dd6 100755 --- a/docs/api-reference/autoscaling/v1/operations.html +++ b/docs/api-reference/autoscaling/v1/operations.html @@ -41,7 +41,7 @@

default

success

-

unversioned.APIResourceList

+

unversioned.APIResourceList

@@ -190,7 +190,7 @@

200

success

-

v1.HorizontalPodAutoscalerList

+

v1.HorizontalPodAutoscalerList

@@ -341,7 +341,7 @@

200

success

-

v1.HorizontalPodAutoscalerList

+

v1.HorizontalPodAutoscalerList

@@ -492,7 +492,7 @@

200

success

-

unversioned.Status

+

unversioned.Status

@@ -577,7 +577,7 @@

body

true

-

v1.HorizontalPodAutoscaler

+

v1.HorizontalPodAutoscaler

@@ -611,7 +611,7 @@

200

success

-

v1.HorizontalPodAutoscaler

+

v1.HorizontalPodAutoscaler

@@ -746,7 +746,7 @@

200

success

-

v1.HorizontalPodAutoscaler

+

v1.HorizontalPodAutoscaler

@@ -831,7 +831,7 @@

body

true

-

v1.HorizontalPodAutoscaler

+

v1.HorizontalPodAutoscaler

@@ -873,7 +873,7 @@

200

success

-

v1.HorizontalPodAutoscaler

+

v1.HorizontalPodAutoscaler

@@ -958,7 +958,7 @@

body

true

-

v1.DeleteOptions

+

v1.DeleteOptions

@@ -1000,7 +1000,7 @@

200

success

-

unversioned.Status

+

unversioned.Status

@@ -1085,7 +1085,7 @@

body

true

-

unversioned.Patch

+

unversioned.Patch

@@ -1127,7 +1127,7 @@

200

success

-

v1.HorizontalPodAutoscaler

+

v1.HorizontalPodAutoscaler

@@ -1252,7 +1252,7 @@

200

success

-

v1.HorizontalPodAutoscaler

+

v1.HorizontalPodAutoscaler

@@ -1337,7 +1337,7 @@

body

true

-

v1.HorizontalPodAutoscaler

+

v1.HorizontalPodAutoscaler

@@ -1379,7 +1379,7 @@

200

success

-

v1.HorizontalPodAutoscaler

+

v1.HorizontalPodAutoscaler

@@ -1464,7 +1464,7 @@

body

true

-

unversioned.Patch

+

unversioned.Patch

@@ -1506,7 +1506,7 @@

200

success

-

v1.HorizontalPodAutoscaler

+

v1.HorizontalPodAutoscaler

@@ -1655,7 +1655,7 @@

200

success

-

*versioned.Event

+

*versioned.Event

@@ -1809,7 +1809,7 @@

200

success

-

*versioned.Event

+

*versioned.Event

@@ -1971,7 +1971,7 @@

200

success

-

*versioned.Event

+

*versioned.Event

@@ -2022,7 +2022,7 @@ diff --git a/docs/api-reference/batch/v1/definitions.html b/docs/api-reference/batch/v1/definitions.html index c1b65d1513..004ad0241f 100755 --- a/docs/api-reference/batch/v1/definitions.html +++ b/docs/api-reference/batch/v1/definitions.html @@ -240,21 +240,21 @@

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

+

Server is the hostname or IP address of the NFS server. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

true

string

path

-

Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#nfs

+

Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

true

string

readOnly

-

ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#nfs

false

boolean

false

@@ -329,7 +329,7 @@

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

+

Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/release-1.4/examples/volumes/cephfs/README.md#how-to-use-it

true

string array

@@ -343,28 +343,28 @@

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

+

Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/release-1.4/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretFile

-

Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/cephfs/README.md#how-to-use-it

false

string

secretRef

-

Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/cephfs/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

-

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/cephfs/README.md#how-to-use-it

false

boolean

false

@@ -439,7 +439,7 @@

targetWWNs

-

Required: FC target world wide names (WWNs)

+

Required: FC target worldwide names (WWNs)

true

string array

@@ -499,6 +499,13 @@

v1.DownwardAPIVolumeFile array

+ +

defaultMode

+

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

false

+

integer (int32)

+ + @@ -583,28 +590,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.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

true

string

fsType

-

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

false

string

partition

-

The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

false

integer (int32)

readOnly

-

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

false

boolean

false

@@ -675,7 +682,7 @@ Examples:

name

-

Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

+

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

@@ -687,6 +694,13 @@ Examples:

v1.KeyToPath array

+ +

defaultMode

+

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

false

+

integer (int32)

+ + @@ -734,7 +748,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.3/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.4/docs/devel/api-conventions.md#types-kinds

false

string

@@ -933,7 +947,7 @@ Examples:

name

-

Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

+

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

@@ -974,21 +988,21 @@ Examples:

image

-

Docker image name. More info: http://releases.k8s.io/release-1.3/docs/user-guide/images.md

+

Docker image name. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md

false

string

command

-

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/containers.md#containers-and-commands

false

string array

args

-

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/containers.md#containers-and-commands

false

string array

@@ -1016,7 +1030,7 @@ Examples:

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

+

Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#resources

false

v1.ResourceRequirements

@@ -1030,14 +1044,14 @@ Examples:

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

+

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

false

v1.Probe

readinessProbe

-

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/pod-states.md#container-probes

false

v1.Probe

@@ -1058,14 +1072,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.3/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.4/docs/user-guide/images.md#updating-images

false

string

securityContext

-

Security options the pod should run with. More info: http://releases.k8s.io/release-1.3/docs/design/security_context.md

+

Security options the pod should run with. More info: http://releases.k8s.io/release-1.4/docs/design/security_context.md

false

v1.SecurityContext

@@ -1218,7 +1232,7 @@ Examples:

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

+

Conditions represent the latest available observations of an object’s current state. More info: http://releases.k8s.io/release-1.4/docs/user-guide/jobs.md

false

v1.JobCondition array

@@ -1227,14 +1241,14 @@ Examples:

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

+

string (date-time)

completionTime

CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

false

-

string

+

string (date-time)

@@ -1287,7 +1301,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.3/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.4/docs/user-guide/identifiers.md#names

false

string

@@ -1298,7 +1312,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.3/docs/devel/api-conventions.md#idempotency

+Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

false

string

@@ -1307,7 +1321,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.3/docs/user-guide/namespaces.md

+Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

false

string

@@ -1323,7 +1337,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.3/docs/user-guide/identifiers.md#uids

+Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

false

string

@@ -1332,7 +1346,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.3/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.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

@@ -1348,18 +1362,18 @@ 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.3/docs/devel/api-conventions.md#metadata

+Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

-

string

+

string (date-time)

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.

-Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#metadata

false

-

string

+

string (date-time)

@@ -1371,14 +1385,14 @@ 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.3/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.4/docs/user-guide/labels.md

false

object

annotations

-

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/annotations.md

false

object

@@ -1397,6 +1411,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

string array

+ +

clusterName

+

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

+

false

+

string

+ + @@ -1433,21 +1454,21 @@ 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.3/docs/devel/api-conventions.md#types-kinds

+

Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

true

string

name

-

Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

+

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

true

string

uid

-

UID of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

+

UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

true

string

@@ -1492,7 +1513,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.3/docs/user-guide/volumes.md#hostpath

+

Path of the directory on the host. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

true

string

@@ -1602,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.3/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.4/docs/user-guide/volumes.md#iscsi

false

string

@@ -1643,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.3/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.4/docs/user-guide/volumes.md#emptydir

false

string

@@ -1683,21 +1704,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.3/examples/mysql-cinder-pd/README.md

+

volume id used to identify the volume in cinder More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

true

string

fsType

-

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/examples/mysql-cinder-pd/README.md

false

string

readOnly

-

Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.3/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.4/examples/mysql-cinder-pd/README.md

false

boolean

false

@@ -1800,7 +1821,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.3/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.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

true

string

@@ -1844,14 +1865,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.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

true

string

fsType

-

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

false

string

@@ -1865,7 +1886,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.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

false

boolean

false

@@ -1940,7 +1961,69 @@ 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.3/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.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

+

false

+

string

+ + + + + + +
+

v1.QuobyteVolumeSource

+
+

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1974,35 +2057,35 @@ Populated by the system when a graceful deletion is requested. Read-only. More i - + - + - + - + - + @@ -2052,14 +2135,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i - + - + @@ -2105,21 +2188,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i - + - + - + @@ -2163,7 +2246,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i - + @@ -2175,6 +2258,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i + + + + + + +
NameDescriptionRequiredSchemaDefault

registry

Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

true

string

volume

Volume is a string that references an already created Quobyte volume by name.

true

string

readOnly

ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

false

boolean

false

user

User to map volume access to Defaults to serivceaccount user

false

string

group

Group to map volume access to Default is no group

false

string

kind

Kind is a string value representing the REST resource this object represents. Servers 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

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/release-1.3/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.4/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.3/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.4/docs/devel/api-conventions.md#spec-and-status

false

v1.JobStatus

lastProbeTime

Last time the condition was checked.

false

string

string (date-time)

lastTransitionTime

Last time the condition transit from one status to another.

false

string

string (date-time)

kind

Kind is a string value representing the REST resource this object represents. Servers 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

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

Standard list metadata More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

unversioned.ListMeta

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

Name of the secret in the pod’s namespace to use. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#secrets

false

string

v1.KeyToPath array

defaultMode

Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

@@ -2300,14 +2390,14 @@ 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.3/docs/design/resources.md#resource-specifications

+

Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

false

object

requests

-

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://releases.k8s.io/release-1.3/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://kubernetes.io/docs/user-guide/compute-resources/

false

object

@@ -2319,7 +2409,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

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.

+

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

@@ -2403,7 +2493,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i - + @@ -2458,14 +2548,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i - + - + @@ -2511,6 +2601,75 @@ Populated by the system when a graceful deletion is requested. Read-only. More i + + + + + + + + +

fieldRef

Selects a field of the pod; only name and namespace are supported.

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

false

v1.ObjectFieldSelector

metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

v1.ObjectMeta

spec

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

v1.PodSpec

string

mode

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

false

integer (int32)

+ +
+
+

v1.AzureDiskVolumeSource

+
+

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

diskName

The Name of the data disk in the blob storage

true

string

diskURI

The URI the data disk in the blob storage

true

string

cachingMode

Host Caching mode: None, Read Only, Read Write.

false

v1.AzureDataDiskCachingMode

fsType

Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

false

string

readOnly

Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

false

boolean

false

@@ -2581,14 +2740,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.3/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.4/docs/user-guide/jobs.md

false

integer (int32)

completions

-

Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/jobs.md

false

integer (int32)

@@ -2602,21 +2761,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.3/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.4/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.3/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.4/docs/design/selector-generation.md

false

boolean

false

template

-

Template is the object that describes the pod that will be created when executing a job. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/jobs.md

true

v1.PodTemplateSpec

@@ -2650,14 +2809,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.3/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.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

-

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

false

string

@@ -2712,35 +2871,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.3/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.4/docs/user-guide/identifiers.md#names

true

string

hostPath

-

HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#hostpath

false

v1.HostPathVolumeSource

emptyDir

-

EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#emptydir

false

v1.EmptyDirVolumeSource

gcePersistentDisk

-

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

false

v1.GCEPersistentDiskVolumeSource

awsElasticBlockStore

-

AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

false

v1.AWSElasticBlockStoreVolumeSource

@@ -2754,56 +2913,56 @@ 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.3/docs/user-guide/volumes.md#secrets

+

Secret represents a secret that should populate this volume. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#secrets

false

v1.SecretVolumeSource

nfs

-

NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#nfs

false

v1.NFSVolumeSource

iscsi

-

ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/iscsi/README.md

false

v1.ISCSIVolumeSource

glusterfs

-

Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/glusterfs/README.md

false

v1.GlusterfsVolumeSource

persistentVolumeClaim

-

PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

false

v1.PersistentVolumeClaimVolumeSource

rbd

-

RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/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.

+

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

false

v1.FlexVolumeSource

cinder

-

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/release-1.3/examples/mysql-cinder-pd/README.md

+

Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

false

v1.CinderVolumeSource

@@ -2857,6 +3016,20 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

v1.VsphereVirtualDiskVolumeSource

+ +

quobyte

+

Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

+

false

+

v1.QuobyteVolumeSource

+ + + +

azureDisk

+

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

+

false

+

v1.AzureDiskVolumeSource

+ + @@ -2955,14 +3128,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.3/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.4/docs/user-guide/pod-states.md#container-probes

false

integer (int32)

timeoutSeconds

-

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/pod-states.md#container-probes

false

integer (int32)

@@ -3017,14 +3190,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.3/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.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

-

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

false

string

@@ -3072,7 +3245,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.3/docs/user-guide/identifiers.md#names

+

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

@@ -3113,28 +3286,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.3/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.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

-

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

+

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

status

-

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

false

string

@@ -3267,6 +3440,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

v1.ResourceFieldSelector

+ +

mode

+

Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

+

false

+

integer (int32)

+ + @@ -3296,21 +3476,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.3/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.4/docs/user-guide/volumes.md

false

v1.Volume array

containers

-

List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/containers.md

true

v1.Container array

restartPolicy

-

Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/pod-states.md#restartpolicy

false

string

@@ -3338,14 +3518,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.3/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.4/docs/user-guide/node-selection/README.md

false

object

serviceAccountName

-

ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/release-1.3/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.4/docs/design/service_accounts.md

false

string

@@ -3394,7 +3574,7 @@ 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.3/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.4/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

false

v1.LocalObjectReference array

@@ -3504,14 +3684,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.3/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.4/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

preStop

-

PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/container-environment.md#hook-details

false

v1.Handler

@@ -3545,7 +3725,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.3/docs/user-guide/identifiers.md#names

+

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

@@ -3634,21 +3814,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

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

+

EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

true

string

path

-

Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.3/examples/glusterfs/README.md#create-a-pod

+

Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

true

string

readOnly

-

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.3/examples/glusterfs/README.md#create-a-pod

+

ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

false

boolean

false

@@ -3656,6 +3836,10 @@ Populated by the system when a graceful deletion is requested. Read-only. More i +
+
+

v1.AzureDataDiskCachingMode

+

v1.RBDVolumeSource

@@ -3682,56 +3866,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.3/examples/rbd/README.md#how-to-use-it

+

A collection of Ceph monitors. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

true

string array

image

-

The rados image name. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

+

The rados image name. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

true

string

fsType

-

Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#rbd

false

string

pool

-

The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it.

+

The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it.

false

string

user

-

The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

+

The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

false

string

keyring

-

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

+

Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

false

string

secretRef

-

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

+

SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

false

v1.LocalObjectReference

readOnly

-

ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/rbd/README.md#how-to-use-it

false

boolean

false

@@ -3751,7 +3935,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 ce3327b500..3883aca7d9 100755 --- a/docs/api-reference/batch/v1/operations.html +++ b/docs/api-reference/batch/v1/operations.html @@ -41,7 +41,7 @@

default

success

-

unversioned.APIResourceList

+

unversioned.APIResourceList

@@ -190,7 +190,7 @@

200

success

-

v1.JobList

+

v1.JobList

@@ -341,7 +341,7 @@

200

success

-

v1.JobList

+

v1.JobList

@@ -492,7 +492,7 @@

200

success

-

unversioned.Status

+

unversioned.Status

@@ -577,7 +577,7 @@

body

true

-

v1.Job

+

v1.Job

@@ -611,7 +611,7 @@

200

success

-

v1.Job

+

v1.Job

@@ -746,7 +746,7 @@

200

success

-

v1.Job

+

v1.Job

@@ -831,7 +831,7 @@

body

true

-

v1.Job

+

v1.Job

@@ -873,7 +873,7 @@

200

success

-

v1.Job

+

v1.Job

@@ -958,7 +958,7 @@

body

true

-

v1.DeleteOptions

+

v1.DeleteOptions

@@ -1000,7 +1000,7 @@

200

success

-

unversioned.Status

+

unversioned.Status

@@ -1085,7 +1085,7 @@

body

true

-

unversioned.Patch

+

unversioned.Patch

@@ -1127,7 +1127,7 @@

200

success

-

v1.Job

+

v1.Job

@@ -1252,7 +1252,7 @@

200

success

-

v1.Job

+

v1.Job

@@ -1337,7 +1337,7 @@

body

true

-

v1.Job

+

v1.Job

@@ -1379,7 +1379,7 @@

200

success

-

v1.Job

+

v1.Job

@@ -1464,7 +1464,7 @@

body

true

-

unversioned.Patch

+

unversioned.Patch

@@ -1506,7 +1506,7 @@

200

success

-

v1.Job

+

v1.Job

@@ -1655,7 +1655,7 @@

200

success

-

*versioned.Event

+

*versioned.Event

@@ -1809,7 +1809,7 @@

200

success

-

*versioned.Event

+

*versioned.Event

@@ -1971,7 +1971,7 @@

200

success

-

*versioned.Event

+

*versioned.Event

@@ -2022,7 +2022,7 @@
diff --git a/docs/api-reference/certificates/v1alpha1/definitions.html b/docs/api-reference/certificates/v1alpha1/definitions.html new file mode 100755 index 0000000000..0d1984dc50 --- /dev/null +++ b/docs/api-reference/certificates/v1alpha1/definitions.html @@ -0,0 +1,966 @@ +--- +--- + + + + + + +Top Level API Objects + + + +
+
+

Top Level API Objects

+ +
+
+

Definitions

+
+
+

unversioned.Patch

+
+

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

+
+
+
+

v1alpha1.CertificateSigningRequestList

+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

false

unversioned.ListMeta

items

true

v1alpha1.CertificateSigningRequest array

+ +
+
+

v1.DeleteOptions

+
+

DeleteOptions may be provided when deleting an API object

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

gracePeriodSeconds

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

false

integer (int64)

preconditions

Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

false

v1.Preconditions

orphanDependents

Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

false

boolean

false

+ +
+
+

v1alpha1.CertificateSigningRequestSpec

+
+

This information is immutable after the request is created. Only the Request and ExtraInfo fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

request

Base64-encoded PKCS#10 CSR data

true

string

username

Information about the requesting user (if relevant) See user.Info interface for details

false

string

uid

false

string

groups

false

string array

+ +
+
+

unversioned.StatusDetails

+
+

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

false

string

group

The group attribute of the resource associated with the status StatusReason.

false

string

kind

The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

causes

The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

false

unversioned.StatusCause array

retryAfterSeconds

If specified, the time in seconds before the operation should be retried.

false

integer (int32)

+ +
+
+

*versioned.Event

+ +
+
+

unversioned.ListMeta

+
+

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

resourceVersion

String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

+ +
+
+

v1alpha1.CertificateSigningRequestStatus

+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

conditions

Conditions applied to the request, such as approval or denial.

false

v1alpha1.CertificateSigningRequestCondition array

certificate

If request was approved, the controller will place the issued certificate here.

false

string

+ +
+
+

v1alpha1.CertificateSigningRequestCondition

+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

type

request approval state, currently Approved or Denied.

true

string

reason

brief reason for the request state

false

string

message

human readable message with details about the request state

false

string

lastUpdateTime

timestamp for the last update to this condition

false

string (date-time)

+ +
+
+

v1.Preconditions

+
+

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

+
+ +++++++ + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

uid

Specifies the target UID.

false

types.UID

+ +
+
+

v1alpha1.CertificateSigningRequest

+
+

Describes a certificate signing request

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

false

v1.ObjectMeta

spec

The certificate request itself and any additional information.

false

v1alpha1.CertificateSigningRequestSpec

status

Derived information about the request.

false

v1alpha1.CertificateSigningRequestStatus

+ +
+
+

unversioned.APIResourceList

+
+

APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

groupVersion

groupVersion is the group and version this APIResourceList is for.

true

string

resources

resources contains the name of the resources and if they are namespaced.

true

unversioned.APIResource array

+ +
+
+

unversioned.Status

+
+

Status is a return value for calls that don’t return other objects.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

kind

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

string

apiVersion

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

false

string

metadata

Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

false

unversioned.ListMeta

status

Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

false

string

message

A human-readable description of the status of this operation.

false

string

reason

A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

false

string

details

Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

false

unversioned.StatusDetails

code

Suggested HTTP return code for this status, 0 if not set.

false

integer (int32)

+ +
+
+

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.ObjectMeta

+
+

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

name

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

false

string

generateName

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
+
+If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
+
+Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

false

string

namespace

Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
+
+Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

false

string

selfLink

SelfLink is a URL representing this object. Populated by the system. Read-only.

false

string

uid

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
+
+Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

false

string

resourceVersion

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
+
+Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

false

string

generation

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

false

integer (int64)

creationTimestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
+
+Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionTimestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.
+
+Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

false

string (date-time)

deletionGracePeriodSeconds

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

false

integer (int64)

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md

false

object

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/annotations.md

false

object

ownerReferences

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

false

v1.OwnerReference array

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

false

string array

clusterName

The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

false

string

+ +
+
+

v1.OwnerReference

+
+

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

+
+ +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionRequiredSchemaDefault

apiVersion

API version of the referent.

true

string

kind

Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

true

string

name

Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

true

string

uid

UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

true

string

controller

If true, this reference points to the managing controller.

false

boolean

false

+ +
+
+

types.UID

+ +
+
+

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

+ +
+
+

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/certificates/v1alpha1/operations.html b/docs/api-reference/certificates/v1alpha1/operations.html new file mode 100755 index 0000000000..08ed0012d0 --- /dev/null +++ b/docs/api-reference/certificates/v1alpha1/operations.html @@ -0,0 +1,1527 @@ +--- +--- + + + + + + +Operations + + + +
+
+

Operations

+
+
+

get available resources

+
+
+
GET /apis/certificates/v1alpha1
+
+
+
+

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

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+

list or watch objects of kind CertificateSigningRequest

+
+
+
GET /apis/certificates/v1alpha1/certificatesigningrequests
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version 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

v1alpha1.CertificateSigningRequestList

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+

delete collection of CertificateSigningRequest

+
+
+
DELETE /apis/certificates/v1alpha1/certificatesigningrequests
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version 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

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+

create a CertificateSigningRequest

+
+
+
POST /apis/certificates/v1alpha1/certificatesigningrequests
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1alpha1.CertificateSigningRequest

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1alpha1.CertificateSigningRequest

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+

read the specified CertificateSigningRequest

+
+
+
GET /apis/certificates/v1alpha1/certificatesigningrequests/{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 CertificateSigningRequest

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1alpha1.CertificateSigningRequest

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+

replace the specified CertificateSigningRequest

+
+
+
PUT /apis/certificates/v1alpha1/certificatesigningrequests/{name}
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1alpha1.CertificateSigningRequest

PathParameter

name

name of the CertificateSigningRequest

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1alpha1.CertificateSigningRequest

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+

delete a CertificateSigningRequest

+
+
+
DELETE /apis/certificates/v1alpha1/certificatesigningrequests/{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 CertificateSigningRequest

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

unversioned.Status

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+

partially update the specified CertificateSigningRequest

+
+
+
PATCH /apis/certificates/v1alpha1/certificatesigningrequests/{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 CertificateSigningRequest

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1alpha1.CertificateSigningRequest

+ +
+
+

Consumes

+
+
    +
  • +

    application/json-patch+json

    +
  • +
  • +

    application/merge-patch+json

    +
  • +
  • +

    application/strategic-merge-patch+json

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+

replace approval of the specified CertificateSigningRequest

+
+
+
PUT /apis/certificates/v1alpha1/certificatesigningrequests/{name}/approval
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1alpha1.CertificateSigningRequest

PathParameter

name

name of the CertificateSigningRequest

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1alpha1.CertificateSigningRequest

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+

replace status of the specified CertificateSigningRequest

+
+
+
PUT /apis/certificates/v1alpha1/certificatesigningrequests/{name}/status
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

BodyParameter

body

true

v1alpha1.CertificateSigningRequest

PathParameter

name

name of the CertificateSigningRequest

true

string

+ +
+
+

Responses

+ +++++ + + + + + + + + + + + + + + +
HTTP CodeDescriptionSchema

200

success

v1alpha1.CertificateSigningRequest

+ +
+
+

Consumes

+
+
    +
  • +

    /

    +
  • +
+
+
+
+

Produces

+
+
    +
  • +

    application/json

    +
  • +
  • +

    application/yaml

    +
  • +
  • +

    application/vnd.kubernetes.protobuf

    +
  • +
+
+
+
+

Tags

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+

watch individual changes to a list of CertificateSigningRequest

+
+
+
GET /apis/certificates/v1alpha1/watch/certificatesigningrequests
+
+
+
+

Parameters

+ ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescriptionRequiredSchemaDefault

QueryParameter

pretty

If true, then the output is pretty printed.

false

string

QueryParameter

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

false

string

QueryParameter

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

false

string

QueryParameter

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

false

boolean

QueryParameter

resourceVersion

When specified with a watch call, shows changes that occur after that particular version 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

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+

watch changes to an object of kind CertificateSigningRequest

+
+
+
GET /apis/certificates/v1alpha1/watch/certificatesigningrequests/{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 CertificateSigningRequest

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

+
+
    +
  • +

    apiscertificatesv1alpha1

    +
  • +
+
+
+
+
+
+
+ + + \ No newline at end of file diff --git a/docs/api-reference/extensions/v1beta1/definitions.html b/docs/api-reference/extensions/v1beta1/definitions.html index 663419ea60..dcbce6cfc9 100755 --- a/docs/api-reference/extensions/v1beta1/definitions.html +++ b/docs/api-reference/extensions/v1beta1/definitions.html @@ -71,6 +71,12 @@
  • v1beta1.NetworkPolicyList

  • +
  • +

    v1beta1.StorageClass

    +
  • +
  • +

    v1beta1.StorageClassList

    +
  • @@ -165,21 +171,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.3/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.4/docs/admin/daemons.md

    true

    integer (int32)

    numberMisscheduled

    -

    NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/release-1.3/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.4/docs/admin/daemons.md

    true

    integer (int32)

    desiredNumberScheduled

    -

    DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/release-1.3/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.4/docs/admin/daemons.md

    true

    integer (int32)

    @@ -213,35 +219,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Spec is a structure defining the expected behavior of a job. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.JobSpec

    status

    -

    Status is a structure describing current status of a job. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.JobStatus

    @@ -549,28 +555,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    -

    List of ReplicaSets. More info: http://releases.k8s.io/release-1.3/docs/user-guide/replication-controller.md

    +

    List of ReplicaSets. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md

    true

    v1beta1.ReplicaSet array

    @@ -604,7 +610,7 @@

    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

    +

    Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/release-1.4/examples/volumes/cephfs/README.md#how-to-use-it

    true

    string array

    @@ -618,28 +624,28 @@

    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

    +

    Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/release-1.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    string

    secretFile

    -

    Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    string

    secretRef

    -

    Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    v1.LocalObjectReference

    readOnly

    -

    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    boolean

    false

    @@ -712,6 +718,13 @@

    v1.DownwardAPIVolumeFile array

    + +

    defaultMode

    +

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    +

    false

    +

    integer (int32)

    + + @@ -793,21 +806,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    unversioned.ListMeta

    @@ -851,28 +864,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.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

    true

    string

    fsType

    -

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    string

    partition

    -

    The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    integer (int32)

    readOnly

    -

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    boolean

    false

    @@ -984,7 +997,7 @@ Examples:

    name

    -

    Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

    +

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    @@ -996,6 +1009,13 @@ Examples:

    v1.KeyToPath array

    + +

    defaultMode

    +

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    +

    false

    +

    integer (int32)

    + + @@ -1077,7 +1097,7 @@ Examples:

    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

    +

    Conditions represent the latest available observations of an object’s current state. More info: http://releases.k8s.io/release-1.4/docs/user-guide/jobs.md

    false

    v1beta1.JobCondition array

    @@ -1086,14 +1106,14 @@ Examples:

    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

    +

    string (date-time)

    completionTime

    CompletionTime represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC.

    false

    -

    string

    +

    string (date-time)

    @@ -1187,7 +1207,7 @@ Examples:

    name

    -

    Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

    +

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    @@ -1195,6 +1215,71 @@ Examples:
    + +
    +

    v1beta1.StorageClass

    +
    +

    StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

    +
    +
    +

    StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    provisioner

    Provisioner indicates the type of the provisioner.

    true

    string

    parameters

    Parameters holds the parameters for the provisioner that should create volumes of this storage class.

    false

    object

    +

    v1.ExecAction

    @@ -1255,7 +1340,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.3/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.4/docs/user-guide/identifiers.md#names

    false

    string

    @@ -1266,7 +1351,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.3/docs/devel/api-conventions.md#idempotency

    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

    false

    string

    @@ -1275,7 +1360,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.3/docs/user-guide/namespaces.md

    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

    false

    string

    @@ -1291,7 +1376,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.3/docs/user-guide/identifiers.md#uids

    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    false

    string

    @@ -1300,7 +1385,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.3/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.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    @@ -1316,18 +1401,18 @@ 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.3/docs/devel/api-conventions.md#metadata

    +Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    -

    string

    +

    string (date-time)

    deletionTimestamp

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.

    -Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#metadata

    false

    -

    string

    +

    string (date-time)

    @@ -1339,14 +1424,14 @@ 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.3/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.4/docs/user-guide/labels.md

    false

    object

    annotations

    -

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/annotations.md

    false

    object

    @@ -1365,6 +1450,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    string array

    + +

    clusterName

    +

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    +

    false

    +

    string

    + + @@ -1394,21 +1486,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.3/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.4/docs/user-guide/replication-controller.md#what-is-a-replication-controller

    false

    integer (int32)

    selector

    -

    Selector is a label query over pods that should match the replica count. If the selector is empty, it is defaulted to the labels present on the pod template. Label keys and values that must match in order to be controlled by this replica set. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/labels.md#label-selectors

    false

    v1beta1.LabelSelector

    template

    -

    Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/replication-controller.md#pod-template

    false

    v1.PodTemplateSpec

    @@ -1442,14 +1534,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.3/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.4/docs/user-guide/labels.md#label-selectors

    false

    v1beta1.LabelSelector

    template

    -

    Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template’s node selector (or on every node if no node selector is specified). More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/replication-controller.md#pod-template

    true

    v1.PodTemplateSpec

    @@ -1483,14 +1575,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    @@ -1625,7 +1717,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.3/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.4/docs/user-guide/volumes.md#iscsi

    false

    string

    @@ -1666,7 +1758,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.3/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.4/docs/user-guide/volumes.md#emptydir

    false

    string

    @@ -1700,21 +1792,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    unversioned.ListMeta

    @@ -1769,6 +1861,61 @@ 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.

    +
    +
    +

    v1beta1.StorageClassList

    +
    +

    StorageClassList is a collection of storage classes.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    unversioned.ListMeta

    items

    Items is the list of StorageClasses

    true

    v1beta1.StorageClass array

    +

    v1.FlockerVolumeSource

    @@ -1829,7 +1976,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.3/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.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    true

    string

    @@ -1877,7 +2024,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.3/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.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    @@ -1911,28 +2058,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    behaviour of autoscaler. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status.

    +

    behaviour of autoscaler. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status.

    false

    v1beta1.HorizontalPodAutoscalerSpec

    @@ -2007,7 +2154,7 @@ 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.3/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.4/docs/user-guide/volumes.md#secrets

    false

    string

    @@ -2019,6 +2166,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    v1.KeyToPath array

    + +

    defaultMode

    +

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    +

    false

    +

    integer (int32)

    + + @@ -2048,7 +2202,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    fieldRef

    -

    Selects a field of the pod; only name and namespace are supported.

    +

    Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

    false

    v1.ObjectFieldSelector

    @@ -2081,7 +2235,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    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.

    +

    FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

    @@ -2181,14 +2335,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i - + - + @@ -2283,6 +2437,68 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    lastProbeTime

    Last time the condition was checked.

    false

    string

    string (date-time)

    lastTransitionTime

    Last time the condition transit from one status to another.

    false

    string

    string (date-time)

    +
    +
    +

    v1.AzureDiskVolumeSource

    +
    +

    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    diskName

    The Name of the data disk in the blob storage

    true

    string

    diskURI

    The URI the data disk in the blob storage

    true

    string

    cachingMode

    Host Caching mode: None, Read Only, Read Write.

    false

    v1.AzureDataDiskCachingMode

    fsType

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    false

    string

    readOnly

    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    false

    boolean

    false

    +

    v1.KeyToPath

    @@ -2321,6 +2537,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    string

    + +

    mode

    +

    Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    +

    false

    +

    integer (int32)

    + + @@ -2391,14 +2614,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    @@ -2453,35 +2676,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.3/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.4/docs/user-guide/identifiers.md#names

    true

    string

    hostPath

    -

    HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#hostpath

    false

    v1.HostPathVolumeSource

    emptyDir

    -

    EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#emptydir

    false

    v1.EmptyDirVolumeSource

    gcePersistentDisk

    -

    GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    v1.GCEPersistentDiskVolumeSource

    awsElasticBlockStore

    -

    AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

    false

    v1.AWSElasticBlockStoreVolumeSource

    @@ -2495,56 +2718,56 @@ 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.3/docs/user-guide/volumes.md#secrets

    +

    Secret represents a secret that should populate this volume. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#secrets

    false

    v1.SecretVolumeSource

    nfs

    -

    NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#nfs

    false

    v1.NFSVolumeSource

    iscsi

    -

    ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/iscsi/README.md

    false

    v1.ISCSIVolumeSource

    glusterfs

    -

    Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/glusterfs/README.md

    false

    v1.GlusterfsVolumeSource

    persistentVolumeClaim

    -

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    false

    v1.PersistentVolumeClaimVolumeSource

    rbd

    -

    RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/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.

    +

    FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

    false

    v1.FlexVolumeSource

    cinder

    -

    Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/release-1.3/examples/mysql-cinder-pd/README.md

    +

    Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

    false

    v1.CinderVolumeSource

    @@ -2598,6 +2821,20 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    v1.VsphereVirtualDiskVolumeSource

    + +

    quobyte

    +

    Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

    +

    false

    +

    v1.QuobyteVolumeSource

    + + + +

    azureDisk

    +

    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

    +

    false

    +

    v1.AzureDiskVolumeSource

    + + @@ -2627,21 +2864,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    unversioned.ListMeta

    @@ -2751,14 +2988,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.3/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.4/docs/user-guide/pod-states.md#container-probes

    false

    integer (int32)

    timeoutSeconds

    -

    Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/pod-states.md#container-probes

    false

    integer (int32)

    @@ -2896,14 +3133,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    @@ -2951,7 +3188,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.3/docs/user-guide/identifiers.md#names

    +

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    @@ -3063,6 +3300,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    v1.ResourceFieldSelector

    + +

    mode

    +

    Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    +

    false

    +

    integer (int32)

    + + @@ -3154,21 +3398,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.3/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.4/docs/user-guide/volumes.md

    false

    v1.Volume array

    containers

    -

    List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/containers.md

    true

    v1.Container array

    restartPolicy

    -

    Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/pod-states.md#restartpolicy

    false

    string

    @@ -3196,14 +3440,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.3/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.4/docs/user-guide/node-selection/README.md

    false

    object

    serviceAccountName

    -

    ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/release-1.3/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.4/docs/design/service_accounts.md

    false

    string

    @@ -3252,7 +3496,7 @@ 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.3/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.4/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

    false

    v1.LocalObjectReference array

    @@ -3300,14 +3544,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.3/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.4/docs/user-guide/container-environment.md#hook-details

    false

    v1.Handler

    preStop

    -

    PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/container-environment.md#hook-details

    false

    v1.Handler

    @@ -3341,21 +3585,21 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    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

    +

    EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

    true

    string

    path

    -

    Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.3/examples/glusterfs/README.md#create-a-pod

    +

    Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

    true

    string

    readOnly

    -

    ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.3/examples/glusterfs/README.md#create-a-pod

    +

    ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

    false

    boolean

    false

    @@ -3478,14 +3722,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.3/docs/devel/api-conventions.md#types-kinds

    +

    Kind of the referent; More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    name

    -

    Name of the referent; More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

    +

    Name of the referent; More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    @@ -3533,35 +3777,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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.

    +

    Standard object metadata; More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata.

    false

    v1.ObjectMeta

    spec

    -

    defines the behavior of the scale. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status.

    +

    defines the behavior of the scale. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status.

    false

    v1beta1.ScaleSpec

    status

    -

    current status of the scale. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status. Read-only.

    +

    current status of the scale. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status. Read-only.

    false

    v1beta1.ScaleStatus

    @@ -3595,56 +3839,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.3/examples/rbd/README.md#how-to-use-it

    +

    A collection of Ceph monitors. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    true

    string array

    image

    -

    The rados image name. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

    +

    The rados image name. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    true

    string

    fsType

    -

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#rbd

    false

    string

    pool

    -

    The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it.

    +

    The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it.

    false

    string

    user

    -

    The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

    +

    The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    string

    keyring

    -

    Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

    +

    Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    string

    secretRef

    -

    SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

    +

    SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    v1.LocalObjectReference

    readOnly

    -

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    boolean

    false

    @@ -3675,21 +3919,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    @@ -3737,14 +3981,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.3/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.4/docs/user-guide/labels.md#label-selectors

    false

    object

    targetSelector

    -

    label selector for pods that should match the replicas count. This is a serializated version of both map-based and more expressive set-based selectors. This is done to avoid introspection in the clients. The string will be in the same format as the query-param syntax. If the target type only supports map-based selectors, both this field and map-based selector field are populated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/labels.md#label-selectors

    false

    string

    @@ -3816,21 +4060,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.3/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.4/docs/user-guide/volumes.md#nfs

    true

    string

    path

    -

    Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#nfs

    +

    Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

    true

    string

    readOnly

    -

    ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#nfs

    false

    boolean

    false

    @@ -3864,14 +4108,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    @@ -3919,14 +4163,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    @@ -4031,7 +4275,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    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

    +

    string (date-time)

    @@ -4084,7 +4328,7 @@ Populated by the system when a graceful deletion is requested. Read-only. More i

    targetWWNs

    -

    Required: FC target world wide names (WWNs)

    +

    Required: FC target worldwide names (WWNs)

    true

    string array

    @@ -4139,14 +4383,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    @@ -4322,21 +4566,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    unversioned.ListMeta

    @@ -4429,7 +4673,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    @@ -4611,21 +4855,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.3/docs/user-guide/images.md

    +

    Docker image name. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md

    false

    string

    command

    -

    Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/containers.md#containers-and-commands

    false

    string array

    args

    -

    Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/containers.md#containers-and-commands

    false

    string array

    @@ -4653,7 +4897,7 @@ 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.3/docs/user-guide/persistent-volumes.md#resources

    +

    Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#resources

    false

    v1.ResourceRequirements

    @@ -4667,14 +4911,14 @@ Both these may change in the future. Incoming requests are matched against the h

    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

    +

    Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

    false

    v1.Probe

    readinessProbe

    -

    Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/pod-states.md#container-probes

    false

    v1.Probe

    @@ -4695,14 +4939,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.3/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.4/docs/user-guide/images.md#updating-images

    false

    string

    securityContext

    -

    Security options the pod should run with. More info: http://releases.k8s.io/release-1.3/docs/design/security_context.md

    +

    Security options the pod should run with. More info: http://releases.k8s.io/release-1.4/docs/design/security_context.md

    false

    v1.SecurityContext

    @@ -4869,21 +5113,21 @@ Both these may change in the future. Incoming requests are matched against the h

    kind

    -

    Kind of the referent. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

    +

    Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    true

    string

    name

    -

    Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

    +

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    true

    string

    uid

    -

    UID of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

    +

    UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    true

    string

    @@ -4924,7 +5168,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.3/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.4/docs/user-guide/replication-controller.md#what-is-a-replication-controller

    true

    integer (int32)

    @@ -4937,6 +5181,13 @@ Both these may change in the future. Incoming requests are matched against the h +

    readyReplicas

    +

    The number of ready replicas for this replica set.

    +

    false

    +

    integer (int32)

    + + +

    observedGeneration

    ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

    false

    @@ -5013,35 +5264,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    -

    If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Spec defines the specification of the desired behavior of the ReplicaSet. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.ReplicaSetSpec

    status

    -

    Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.ReplicaSetStatus

    @@ -5075,7 +5326,7 @@ Both these may change in the future. Incoming requests are matched against the h

    path

    -

    Path of the directory on the host. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#hostpath

    +

    Path of the directory on the host. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

    true

    string

    @@ -5109,35 +5360,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.DaemonSetSpec

    status

    -

    Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.DaemonSetStatus

    @@ -5171,21 +5422,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.3/examples/mysql-cinder-pd/README.md

    +

    volume id used to identify the volume in cinder More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

    true

    string

    fsType

    -

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/examples/mysql-cinder-pd/README.md

    false

    string

    readOnly

    -

    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.3/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.4/examples/mysql-cinder-pd/README.md

    false

    boolean

    false

    @@ -5295,14 +5546,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.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

    true

    string

    fsType

    -

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

    false

    string

    @@ -5316,7 +5567,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.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

    false

    boolean

    false

    @@ -5379,6 +5630,68 @@ Both these may change in the future. Incoming requests are matched against the h +
    +
    +

    v1.QuobyteVolumeSource

    +
    +

    Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    registry

    Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

    true

    string

    volume

    Volume is a string that references an already created Quobyte volume by name.

    true

    string

    readOnly

    ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

    false

    boolean

    false

    user

    User to map volume access to Defaults to serivceaccount user

    false

    string

    group

    Group to map volume access to Default is no group

    false

    string

    +

    v1beta1.LabelSelectorRequirement

    @@ -5501,14 +5814,14 @@ 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.3/docs/design/resources.md#resource-specifications

    +

    Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

    false

    object

    requests

    -

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://releases.k8s.io/release-1.3/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://kubernetes.io/docs/user-guide/compute-resources/

    false

    object

    @@ -5542,14 +5855,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.3/docs/devel/api-conventions.md#metadata

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    +

    Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.PodSpec

    @@ -5621,14 +5934,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.3/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.4/docs/user-guide/jobs.md

    false

    integer (int32)

    completions

    -

    Completions specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/jobs.md

    false

    integer (int32)

    @@ -5642,21 +5955,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.3/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.4/docs/user-guide/labels.md#label-selectors

    false

    v1beta1.LabelSelector

    autoSelector

    -

    AutoSelector controls generation of pod labels and pod selectors. It was not present in the original extensions/v1beta1 Job definition, but exists to allow conversion from batch/v1 Jobs, where it corresponds to, but has the opposite meaning as, ManualSelector. More info: http://releases.k8s.io/release-1.3/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.4/docs/design/selector-generation.md

    false

    boolean

    false

    template

    -

    Template is the object that describes the pod that will be created when executing a job. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/jobs.md

    true

    v1.PodTemplateSpec

    @@ -5690,28 +6003,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    status

    -

    Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    string

    @@ -5773,14 +6086,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    @@ -5828,7 +6141,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.3/docs/user-guide/identifiers.md#names

    +

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    @@ -5869,7 +6182,7 @@ Both these may change in the future. Incoming requests are matched against the h

    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.

    +

    Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a /. If unspecified, the path defaults to a catch all sending traffic to the backend.

    false

    string

    @@ -5910,35 +6223,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Spec is the desired state of the Ingress. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    +

    Spec is the desired state of the Ingress. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.IngressSpec

    status

    -

    Status is the current state of the Ingress. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    +

    Status is the current state of the Ingress. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.IngressStatus

    @@ -5972,14 +6285,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    @@ -6001,6 +6314,10 @@ Both these may change in the future. Incoming requests are matched against the h +
    +
    +

    v1.AzureDataDiskCachingMode

    +

    any

    @@ -6013,7 +6330,7 @@ Both these may change in the future. Incoming requests are matched against the h
    diff --git a/docs/api-reference/extensions/v1beta1/definitions.md b/docs/api-reference/extensions/v1beta1/definitions.md index e124eab376..c7cdbb0908 100644 --- a/docs/api-reference/extensions/v1beta1/definitions.md +++ b/docs/api-reference/extensions/v1beta1/definitions.md @@ -1,7 +1,7 @@ --- --- -{% include v1.3/extensions-v1beta1-definitions.html %} +{% include v1.4/extensions-v1beta1-definitions.html %} diff --git a/docs/api-reference/extensions/v1beta1/operations.html b/docs/api-reference/extensions/v1beta1/operations.html index b0e56bf69c..1b11d2bd9e 100755 --- a/docs/api-reference/extensions/v1beta1/operations.html +++ b/docs/api-reference/extensions/v1beta1/operations.html @@ -41,7 +41,7 @@

    default

    success

    -

    unversioned.APIResourceList

    +

    unversioned.APIResourceList

    @@ -190,7 +190,7 @@

    200

    success

    -

    v1beta1.DaemonSetList

    +

    v1beta1.DaemonSetList

    @@ -333,7 +333,7 @@

    200

    success

    -

    v1beta1.DeploymentList

    +

    v1beta1.DeploymentList

    @@ -476,7 +476,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscalerList

    +

    v1beta1.HorizontalPodAutoscalerList

    @@ -619,7 +619,7 @@

    200

    success

    -

    v1beta1.IngressList

    +

    v1beta1.IngressList

    @@ -762,7 +762,7 @@

    200

    success

    -

    v1beta1.JobList

    +

    v1beta1.JobList

    @@ -913,7 +913,7 @@

    200

    success

    -

    v1beta1.DaemonSetList

    +

    v1beta1.DaemonSetList

    @@ -1064,7 +1064,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -1149,7 +1149,7 @@

    body

    true

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1183,7 +1183,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1318,7 +1318,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1403,7 +1403,7 @@

    body

    true

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1445,7 +1445,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1530,7 +1530,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -1572,7 +1572,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -1657,7 +1657,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -1699,7 +1699,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1824,7 +1824,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1909,7 +1909,7 @@

    body

    true

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -1951,7 +1951,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -2036,7 +2036,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -2078,7 +2078,7 @@

    200

    success

    -

    v1beta1.DaemonSet

    +

    v1beta1.DaemonSet

    @@ -2235,7 +2235,7 @@

    200

    success

    -

    v1beta1.DeploymentList

    +

    v1beta1.DeploymentList

    @@ -2386,7 +2386,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -2471,7 +2471,7 @@

    body

    true

    -

    v1beta1.Deployment

    +

    v1beta1.Deployment

    @@ -2505,7 +2505,7 @@

    200

    success

    -

    v1beta1.Deployment

    +

    v1beta1.Deployment

    @@ -2640,7 +2640,7 @@

    200

    success

    -

    v1beta1.Deployment

    +

    v1beta1.Deployment

    @@ -2725,7 +2725,7 @@

    body

    true

    -

    v1beta1.Deployment

    +

    v1beta1.Deployment

    @@ -2767,7 +2767,7 @@

    200

    success

    -

    v1beta1.Deployment

    +

    v1beta1.Deployment

    @@ -2852,7 +2852,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -2894,7 +2894,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -2979,7 +2979,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -3021,7 +3021,7 @@

    200

    success

    -

    v1beta1.Deployment

    +

    v1beta1.Deployment

    @@ -3112,7 +3112,7 @@

    body

    true

    -

    v1beta1.DeploymentRollback

    +

    v1beta1.DeploymentRollback

    @@ -3154,7 +3154,7 @@

    200

    success

    -

    v1beta1.DeploymentRollback

    +

    v1beta1.DeploymentRollback

    @@ -3273,7 +3273,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -3358,7 +3358,7 @@

    body

    true

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -3400,7 +3400,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -3485,7 +3485,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -3527,7 +3527,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -3652,7 +3652,7 @@

    200

    success

    -

    v1beta1.Deployment

    +

    v1beta1.Deployment

    @@ -3737,7 +3737,7 @@

    body

    true

    -

    v1beta1.Deployment

    +

    v1beta1.Deployment

    @@ -3779,7 +3779,7 @@

    200

    success

    -

    v1beta1.Deployment

    +

    v1beta1.Deployment

    @@ -3864,7 +3864,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -3906,7 +3906,7 @@

    200

    success

    -

    v1beta1.Deployment

    +

    v1beta1.Deployment

    @@ -4063,7 +4063,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscalerList

    +

    v1beta1.HorizontalPodAutoscalerList

    @@ -4214,7 +4214,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -4299,7 +4299,7 @@

    body

    true

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -4333,7 +4333,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -4468,7 +4468,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -4553,7 +4553,7 @@

    body

    true

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -4595,7 +4595,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -4680,7 +4680,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -4722,7 +4722,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -4807,7 +4807,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -4849,7 +4849,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -4974,7 +4974,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -5059,7 +5059,7 @@

    body

    true

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -5101,7 +5101,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -5186,7 +5186,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -5228,7 +5228,7 @@

    200

    success

    -

    v1beta1.HorizontalPodAutoscaler

    +

    v1beta1.HorizontalPodAutoscaler

    @@ -5385,7 +5385,7 @@

    200

    success

    -

    v1beta1.IngressList

    +

    v1beta1.IngressList

    @@ -5536,7 +5536,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -5621,7 +5621,7 @@

    body

    true

    -

    v1beta1.Ingress

    +

    v1beta1.Ingress

    @@ -5655,7 +5655,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    v1beta1.Ingress

    @@ -5790,7 +5790,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    v1beta1.Ingress

    @@ -5875,7 +5875,7 @@

    body

    true

    -

    v1beta1.Ingress

    +

    v1beta1.Ingress

    @@ -5917,7 +5917,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    v1beta1.Ingress

    @@ -6002,7 +6002,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -6044,7 +6044,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -6129,7 +6129,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -6171,7 +6171,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    v1beta1.Ingress

    @@ -6296,7 +6296,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    v1beta1.Ingress

    @@ -6381,7 +6381,7 @@

    body

    true

    -

    v1beta1.Ingress

    +

    v1beta1.Ingress

    @@ -6423,7 +6423,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    v1beta1.Ingress

    @@ -6508,7 +6508,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -6550,7 +6550,7 @@

    200

    success

    -

    v1beta1.Ingress

    +

    v1beta1.Ingress

    @@ -6707,7 +6707,7 @@

    200

    success

    -

    v1beta1.JobList

    +

    v1beta1.JobList

    @@ -6858,7 +6858,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -6943,7 +6943,7 @@

    body

    true

    -

    v1beta1.Job

    +

    v1beta1.Job

    @@ -6977,7 +6977,7 @@

    200

    success

    -

    v1beta1.Job

    +

    v1beta1.Job

    @@ -7112,7 +7112,7 @@

    200

    success

    -

    v1beta1.Job

    +

    v1beta1.Job

    @@ -7197,7 +7197,7 @@

    body

    true

    -

    v1beta1.Job

    +

    v1beta1.Job

    @@ -7239,7 +7239,7 @@

    200

    success

    -

    v1beta1.Job

    +

    v1beta1.Job

    @@ -7324,7 +7324,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -7366,7 +7366,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -7451,7 +7451,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -7493,7 +7493,7 @@

    200

    success

    -

    v1beta1.Job

    +

    v1beta1.Job

    @@ -7618,7 +7618,7 @@

    200

    success

    -

    v1beta1.Job

    +

    v1beta1.Job

    @@ -7703,7 +7703,7 @@

    body

    true

    -

    v1beta1.Job

    +

    v1beta1.Job

    @@ -7745,7 +7745,7 @@

    200

    success

    -

    v1beta1.Job

    +

    v1beta1.Job

    @@ -7830,7 +7830,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -7872,7 +7872,7 @@

    200

    success

    -

    v1beta1.Job

    +

    v1beta1.Job

    @@ -8029,7 +8029,7 @@

    200

    success

    -

    v1beta1.NetworkPolicyList

    +

    v1beta1.NetworkPolicyList

    @@ -8180,7 +8180,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -8265,7 +8265,7 @@

    body

    true

    -

    v1beta1.NetworkPolicy

    +

    v1beta1.NetworkPolicy

    @@ -8299,7 +8299,7 @@

    200

    success

    -

    v1beta1.NetworkPolicy

    +

    v1beta1.NetworkPolicy

    @@ -8434,7 +8434,7 @@

    200

    success

    -

    v1beta1.NetworkPolicy

    +

    v1beta1.NetworkPolicy

    @@ -8519,7 +8519,7 @@

    body

    true

    -

    v1beta1.NetworkPolicy

    +

    v1beta1.NetworkPolicy

    @@ -8561,7 +8561,7 @@

    200

    success

    -

    v1beta1.NetworkPolicy

    +

    v1beta1.NetworkPolicy

    @@ -8646,7 +8646,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -8688,7 +8688,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -8773,7 +8773,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -8815,7 +8815,7 @@

    200

    success

    -

    v1beta1.NetworkPolicy

    +

    v1beta1.NetworkPolicy

    @@ -8972,7 +8972,7 @@

    200

    success

    -

    v1beta1.ReplicaSetList

    +

    v1beta1.ReplicaSetList

    @@ -9123,7 +9123,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -9208,7 +9208,7 @@

    body

    true

    -

    v1beta1.ReplicaSet

    +

    v1beta1.ReplicaSet

    @@ -9242,7 +9242,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.ReplicaSet

    @@ -9377,7 +9377,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.ReplicaSet

    @@ -9462,7 +9462,7 @@

    body

    true

    -

    v1beta1.ReplicaSet

    +

    v1beta1.ReplicaSet

    @@ -9504,7 +9504,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.ReplicaSet

    @@ -9589,7 +9589,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -9631,7 +9631,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -9716,7 +9716,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -9758,7 +9758,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.ReplicaSet

    @@ -9883,7 +9883,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -9968,7 +9968,7 @@

    body

    true

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -10010,7 +10010,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -10095,7 +10095,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -10137,7 +10137,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -10262,7 +10262,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.ReplicaSet

    @@ -10347,7 +10347,7 @@

    body

    true

    -

    v1beta1.ReplicaSet

    +

    v1beta1.ReplicaSet

    @@ -10389,7 +10389,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.ReplicaSet

    @@ -10474,7 +10474,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -10516,7 +10516,7 @@

    200

    success

    -

    v1beta1.ReplicaSet

    +

    v1beta1.ReplicaSet

    @@ -10641,7 +10641,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -10726,7 +10726,7 @@

    body

    true

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -10768,7 +10768,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -10853,7 +10853,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -10895,7 +10895,7 @@

    200

    success

    -

    v1beta1.Scale

    +

    v1beta1.Scale

    @@ -11044,7 +11044,7 @@

    200

    success

    -

    v1beta1.NetworkPolicyList

    +

    v1beta1.NetworkPolicyList

    @@ -11187,7 +11187,7 @@

    200

    success

    -

    v1beta1.ReplicaSetList

    +

    v1beta1.ReplicaSetList

    @@ -11231,10 +11231,10 @@
    -

    list or watch objects of kind ThirdPartyResource

    +

    list or watch objects of kind StorageClass

    -
    GET /apis/extensions/v1beta1/thirdpartyresources
    +
    GET /apis/extensions/v1beta1/storageclasses
    @@ -11330,7 +11330,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResourceList

    +

    v1beta1.StorageClassList

    @@ -11374,10 +11374,10 @@
    -

    delete collection of ThirdPartyResource

    +

    delete collection of StorageClass

    -
    DELETE /apis/extensions/v1beta1/thirdpartyresources
    +
    DELETE /apis/extensions/v1beta1/storageclasses
    @@ -11473,7 +11473,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -11517,10 +11517,10 @@
    -

    create a ThirdPartyResource

    +

    create a StorageClass

    -
    POST /apis/extensions/v1beta1/thirdpartyresources
    +
    POST /apis/extensions/v1beta1/storageclasses
    @@ -11558,7 +11558,7 @@

    body

    true

    -

    v1beta1.ThirdPartyResource

    +

    v1beta1.StorageClass

    @@ -11584,7 +11584,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResource

    +

    v1beta1.StorageClass

    @@ -11628,10 +11628,10 @@
    -

    read the specified ThirdPartyResource

    +

    read the specified StorageClass

    -
    GET /apis/extensions/v1beta1/thirdpartyresources/{name}
    +
    GET /apis/extensions/v1beta1/storageclasses/{name}
    @@ -11683,7 +11683,7 @@

    PathParameter

    name

    -

    name of the ThirdPartyResource

    +

    name of the StorageClass

    true

    string

    @@ -11711,7 +11711,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResource

    +

    v1beta1.StorageClass

    @@ -11755,10 +11755,10 @@
    -

    replace the specified ThirdPartyResource

    +

    replace the specified StorageClass

    -
    PUT /apis/extensions/v1beta1/thirdpartyresources/{name}
    +
    PUT /apis/extensions/v1beta1/storageclasses/{name}
    @@ -11796,13 +11796,13 @@

    body

    true

    -

    v1beta1.ThirdPartyResource

    +

    v1beta1.StorageClass

    PathParameter

    name

    -

    name of the ThirdPartyResource

    +

    name of the StorageClass

    true

    string

    @@ -11830,7 +11830,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResource

    +

    v1beta1.StorageClass

    @@ -11874,10 +11874,10 @@
    -

    delete a ThirdPartyResource

    +

    delete a StorageClass

    -
    DELETE /apis/extensions/v1beta1/thirdpartyresources/{name}
    +
    DELETE /apis/extensions/v1beta1/storageclasses/{name}
    @@ -11915,13 +11915,13 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    PathParameter

    name

    -

    name of the ThirdPartyResource

    +

    name of the StorageClass

    true

    string

    @@ -11949,7 +11949,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -11993,10 +11993,10 @@
    -

    partially update the specified ThirdPartyResource

    +

    partially update the specified StorageClass

    -
    PATCH /apis/extensions/v1beta1/thirdpartyresources/{name}
    +
    PATCH /apis/extensions/v1beta1/storageclasses/{name}
    @@ -12034,13 +12034,13 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    PathParameter

    name

    -

    name of the ThirdPartyResource

    +

    name of the StorageClass

    true

    string

    @@ -12068,7 +12068,7 @@

    200

    success

    -

    v1beta1.ThirdPartyResource

    +

    v1beta1.StorageClass

    @@ -12118,10 +12118,10 @@
    -

    watch individual changes to a list of DaemonSet

    +

    list or watch objects of kind ThirdPartyResource

    -
    GET /apis/extensions/v1beta1/watch/daemonsets
    +
    GET /apis/extensions/v1beta1/thirdpartyresources
    @@ -12217,7 +12217,7 @@

    200

    success

    -

    *versioned.Event

    +

    v1beta1.ThirdPartyResourceList

    @@ -12241,14 +12241,11 @@

    application/json

  • -

    application/json;stream=watch

    +

    application/yaml

  • application/vnd.kubernetes.protobuf

  • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
  • @@ -12264,10 +12261,10 @@
    -

    watch individual changes to a list of Deployment

    +

    delete collection of ThirdPartyResource

    -
    GET /apis/extensions/v1beta1/watch/deployments
    +
    DELETE /apis/extensions/v1beta1/thirdpartyresources
    @@ -12363,7 +12360,7 @@

    200

    success

    -

    *versioned.Event

    +

    unversioned.Status

    @@ -12387,14 +12384,11 @@

    application/json

  • -

    application/json;stream=watch

    +

    application/yaml

  • application/vnd.kubernetes.protobuf

  • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
  • @@ -12410,10 +12404,10 @@
    -

    watch individual changes to a list of HorizontalPodAutoscaler

    +

    create a ThirdPartyResource

    -
    GET /apis/extensions/v1beta1/watch/horizontalpodautoscalers
    +
    POST /apis/extensions/v1beta1/thirdpartyresources
    @@ -12447,43 +12441,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.ThirdPartyResource

    @@ -12509,7 +12471,7 @@

    200

    success

    -

    *versioned.Event

    +

    v1beta1.ThirdPartyResource

    @@ -12533,14 +12495,11 @@

    application/json

  • -

    application/json;stream=watch

    +

    application/yaml

  • application/vnd.kubernetes.protobuf

  • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
  • @@ -12556,10 +12515,10 @@
    -

    watch individual changes to a list of Ingress

    +

    read the specified ThirdPartyResource

    -
    GET /apis/extensions/v1beta1/watch/ingresses
    +
    GET /apis/extensions/v1beta1/thirdpartyresources/{name}
    @@ -12594,42 +12553,26 @@

    QueryParameter

    -

    labelSelector

    -

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    -

    false

    -

    string

    - - - -

    QueryParameter

    -

    fieldSelector

    -

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    -

    false

    -

    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

    +

    boolean

    -

    QueryParameter

    -

    timeoutSeconds

    -

    Timeout for the list/watch call.

    -

    false

    -

    integer (int32)

    +

    PathParameter

    +

    name

    +

    name of the ThirdPartyResource

    +

    true

    +

    string

    @@ -12655,7 +12598,7 @@

    200

    success

    -

    *versioned.Event

    +

    v1beta1.ThirdPartyResource

    @@ -12679,14 +12622,11 @@

    application/json

  • -

    application/json;stream=watch

    +

    application/yaml

  • application/vnd.kubernetes.protobuf

  • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
  • @@ -12702,10 +12642,10 @@
    -

    watch individual changes to a list of Job

    +

    replace the specified ThirdPartyResource

    -
    GET /apis/extensions/v1beta1/watch/jobs
    +
    PUT /apis/extensions/v1beta1/thirdpartyresources/{name}
    @@ -12739,6 +12679,369 @@ +

    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

    + ++++++++ + + + + + + + + + + + + + + + + + + + + @@ -12783,7 +13086,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.

    @@ -12801,14 +13104,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -12818,7 +13121,7 @@
    -

    Produces

    +

    Produces

    • @@ -12837,7 +13140,591 @@
    -

    Tags

    +

    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

    • @@ -12855,7 +13742,7 @@
    -

    Parameters

    +

    Parameters

    @@ -12937,7 +13824,7 @@
    -

    Responses

    +

    Responses

    @@ -12955,14 +13842,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -12972,7 +13859,7 @@
    -

    Produces

    +

    Produces

    • @@ -12991,7 +13878,7 @@
    -

    Tags

    +

    Tags

    • @@ -13009,7 +13896,7 @@
    -

    Parameters

    +

    Parameters

    @@ -13099,7 +13986,7 @@
    -

    Responses

    +

    Responses

    @@ -13117,14 +14004,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -13134,7 +14021,7 @@
    -

    Produces

    +

    Produces

    • @@ -13153,7 +14040,7 @@
    -

    Tags

    +

    Tags

    • @@ -13171,7 +14058,7 @@
    -

    Parameters

    +

    Parameters

    @@ -13253,7 +14140,7 @@
    -

    Responses

    +

    Responses

    @@ -13271,14 +14158,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -13288,7 +14175,7 @@
    -

    Produces

    +

    Produces

    • @@ -13307,7 +14194,7 @@
    -

    Tags

    +

    Tags

    • @@ -13325,7 +14212,7 @@
    -

    Parameters

    +

    Parameters

    @@ -13415,7 +14302,7 @@
    -

    Responses

    +

    Responses

    @@ -13433,14 +14320,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -13450,7 +14337,7 @@
    -

    Produces

    +

    Produces

    • @@ -13469,7 +14356,7 @@
    -

    Tags

    +

    Tags

    • @@ -13487,7 +14374,7 @@
    -

    Parameters

    +

    Parameters

    @@ -13569,7 +14456,7 @@
    -

    Responses

    +

    Responses

    @@ -13587,14 +14474,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -13604,7 +14491,7 @@
    -

    Produces

    +

    Produces

    • @@ -13623,7 +14510,7 @@
    -

    Tags

    +

    Tags

    • @@ -13641,7 +14528,7 @@
    -

    Parameters

    +

    Parameters

    @@ -13731,7 +14618,7 @@
    -

    Responses

    +

    Responses

    @@ -13749,14 +14636,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -13766,7 +14653,7 @@
    -

    Produces

    +

    Produces

    • @@ -13785,7 +14672,7 @@
    -

    Tags

    +

    Tags

    • @@ -13803,7 +14690,7 @@
    -

    Parameters

    +

    Parameters

    @@ -13885,7 +14772,7 @@
    -

    Responses

    +

    Responses

    @@ -13903,14 +14790,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -13920,7 +14807,7 @@
    -

    Produces

    +

    Produces

    • @@ -13939,7 +14826,7 @@
    -

    Tags

    +

    Tags

    • @@ -13957,7 +14844,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14047,7 +14934,7 @@
    -

    Responses

    +

    Responses

    @@ -14065,14 +14952,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -14082,7 +14969,7 @@
    -

    Produces

    +

    Produces

    • @@ -14101,7 +14988,7 @@
    -

    Tags

    +

    Tags

    • @@ -14119,7 +15006,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14201,7 +15088,7 @@
    -

    Responses

    +

    Responses

    @@ -14219,14 +15106,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -14236,7 +15123,7 @@
    -

    Produces

    +

    Produces

    • @@ -14255,7 +15142,7 @@
    -

    Tags

    +

    Tags

    • @@ -14273,7 +15160,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14363,7 +15250,7 @@
    -

    Responses

    +

    Responses

    @@ -14381,14 +15268,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -14398,7 +15285,7 @@
    -

    Produces

    +

    Produces

    • @@ -14417,7 +15304,7 @@
    -

    Tags

    +

    Tags

    • @@ -14435,7 +15322,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14517,7 +15404,7 @@
    -

    Responses

    +

    Responses

    @@ -14535,14 +15422,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -14552,7 +15439,7 @@
    -

    Produces

    +

    Produces

    • @@ -14571,7 +15458,7 @@
    -

    Tags

    +

    Tags

    • @@ -14589,7 +15476,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14679,7 +15566,7 @@
    -

    Responses

    +

    Responses

    @@ -14697,14 +15584,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -14714,7 +15601,7 @@
    -

    Produces

    +

    Produces

    • @@ -14733,7 +15620,7 @@
    -

    Tags

    +

    Tags

    • @@ -14751,7 +15638,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14833,7 +15720,7 @@
    -

    Responses

    +

    Responses

    @@ -14851,14 +15738,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -14868,7 +15755,7 @@
    -

    Produces

    +

    Produces

    • @@ -14887,7 +15774,7 @@
    -

    Tags

    +

    Tags

    • @@ -14905,7 +15792,7 @@
    -

    Parameters

    +

    Parameters

    @@ -14995,7 +15882,7 @@
    -

    Responses

    +

    Responses

    @@ -15013,14 +15900,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -15030,7 +15917,7 @@
    -

    Produces

    +

    Produces

    • @@ -15049,7 +15936,7 @@
    -

    Tags

    +

    Tags

    • @@ -15067,7 +15954,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15141,7 +16028,7 @@
    -

    Responses

    +

    Responses

    @@ -15159,14 +16046,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -15176,7 +16063,7 @@
    -

    Produces

    +

    Produces

    • @@ -15195,7 +16082,7 @@
    -

    Tags

    +

    Tags

    • @@ -15213,7 +16100,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15287,7 +16174,7 @@
    -

    Responses

    +

    Responses

    @@ -15305,14 +16192,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -15322,7 +16209,7 @@
    -

    Produces

    +

    Produces

    • @@ -15341,7 +16228,307 @@
    -

    Tags

    +

    Tags

    +
    +
      +
    • +

      apisextensionsv1beta1

      +
    • +
    +
    +
    +
    +
    +

    watch individual changes to a list of StorageClass

    +
    +
    +
    GET /apis/extensions/v1beta1/watch/storageclasses
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version 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 StorageClass

    +
    +
    +
    GET /apis/extensions/v1beta1/watch/storageclasses/{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 StorageClass

    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

    • @@ -15359,7 +16546,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15433,7 +16620,7 @@
    -

    Responses

    +

    Responses

    @@ -15451,14 +16638,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -15468,7 +16655,7 @@
    -

    Produces

    +

    Produces

    • @@ -15487,7 +16674,7 @@
    -

    Tags

    +

    Tags

    • @@ -15505,7 +16692,7 @@
    -

    Parameters

    +

    Parameters

    @@ -15587,7 +16774,7 @@
    -

    Responses

    +

    Responses

    @@ -15605,14 +16792,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -15622,7 +16809,7 @@
    -

    Produces

    +

    Produces

    • @@ -15641,7 +16828,7 @@
    -

    Tags

    +

    Tags

    • @@ -15656,7 +16843,7 @@
    diff --git a/docs/api-reference/extensions/v1beta1/operations.md b/docs/api-reference/extensions/v1beta1/operations.md index 8d32dd5e9d..3aedba68c8 100644 --- a/docs/api-reference/extensions/v1beta1/operations.md +++ b/docs/api-reference/extensions/v1beta1/operations.md @@ -1,7 +1,7 @@ --- --- -{% include v1.3/extensions-v1beta1-operations.html %} +{% include v1.4/extensions-v1beta1-operations.html %} diff --git a/docs/api-reference/v1/definitions.html b/docs/api-reference/v1/definitions.html index 9e0ec44846..fd4f478503 100755 --- a/docs/api-reference/v1/definitions.html +++ b/docs/api-reference/v1/definitions.html @@ -151,35 +151,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Spec defines the behavior of a node. http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    +

    Spec defines the behavior of a node. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.NodeSpec

    status

    -

    Most recently observed status of the node. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.NodeStatus

    @@ -213,28 +213,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    -

    A list of persistent volume claims. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    +

    A list of persistent volume claims. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    true

    v1.PersistentVolumeClaim array

    @@ -400,7 +400,7 @@

    startedAt

    Time at which the container was last (re-)started

    false

    -

    string

    +

    string (date-time)

    @@ -487,7 +487,7 @@

    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

    +

    AccessModes contains the desired access modes the volume should have. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#access-modes-1

    false

    v1.PersistentVolumeAccessMode array

    @@ -501,7 +501,7 @@

    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

    +

    Resources represents the minimum resources the volume should have. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#resources

    false

    v1.ResourceRequirements

    @@ -542,7 +542,7 @@

    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

    +

    Required: Monitors is a collection of Ceph monitors More info: http://releases.k8s.io/release-1.4/examples/volumes/cephfs/README.md#how-to-use-it

    true

    string array

    @@ -556,28 +556,28 @@

    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

    +

    Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/release-1.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    string

    secretFile

    -

    Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    string

    secretRef

    -

    Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    v1.LocalObjectReference

    readOnly

    -

    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/cephfs/README.md#how-to-use-it

    false

    boolean

    false

    @@ -616,6 +616,13 @@

    v1.DownwardAPIVolumeFile array

    + +

    defaultMode

    +

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    +

    false

    +

    integer (int32)

    + + @@ -700,28 +707,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.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

    true

    string

    fsType

    -

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    string

    partition

    -

    The partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    integer (int32)

    readOnly

    -

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    boolean

    false

    @@ -755,7 +762,7 @@ Examples:

    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

    +

    Hard is the set of desired hard limits for each named resource. More info: http://releases.k8s.io/release-1.4/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

    false

    object

    @@ -796,7 +803,7 @@ Examples:

    phase

    -

    Phase is the current lifecycle phase of the namespace. More info: http://releases.k8s.io/release-1.3/docs/design/namespaces.md#phases

    +

    Phase is the current lifecycle phase of the namespace. More info: http://releases.k8s.io/release-1.4/docs/design/namespaces.md#phases

    false

    string

    @@ -830,7 +837,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.3/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.4/docs/design/namespaces.md#finalizers

    false

    v1.FinalizerName array

    @@ -842,7 +849,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.3/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.4/docs/user-guide/persistent-volumes.md

    @@ -864,35 +871,35 @@ Examples:
    - + - + - + - + - + @@ -926,21 +933,21 @@ Examples:
    - + - + - + @@ -981,7 +988,7 @@ Examples:
    - + @@ -1032,7 +1039,7 @@ Examples:
    - + @@ -1044,6 +1051,13 @@ 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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/persistent-volumes.md#persistent-volumes

    false

    v1.PersistentVolumeSpec

    status

    Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/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.4/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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

    More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    unversioned.ListMeta

    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

    Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#phase

    false

    string

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    v1.KeyToPath array

    defaultMode

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    false

    integer (int32)

    @@ -1077,21 +1091,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    @@ -1187,7 +1201,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.3/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.4/docs/user-guide/labels.md#label-selectors

    false

    string

    @@ -1262,21 +1276,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    @@ -1317,21 +1331,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    @@ -1350,7 +1364,7 @@ Examples:

    v1.NodeCondition

    -

    NodeCondition contains condition infromation for a node.

    +

    NodeCondition contains condition information for a node.

    @@ -1388,14 +1402,14 @@ Examples:
    - + - + @@ -1441,7 +1455,7 @@ Examples:
    - + @@ -1475,7 +1489,7 @@ Examples:
    - + @@ -1550,7 +1564,7 @@ Examples:
    - + @@ -1561,7 +1575,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.3/docs/devel/api-conventions.md#idempotency

    +Applied only if Name is not specified. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#idempotency

    @@ -1570,7 +1584,7 @@ Applied only if Name is not specified. More info:

    namespace

    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

    @@ -1586,7 +1600,7 @@ Must be a DNS_LABEL. Cannot be updated. More info:

    uid

    +Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    @@ -1595,7 +1609,7 @@ Populated by the system. Read-only. More info:

    resourceVersion

    +Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    @@ -1611,18 +1625,18 @@ Populated by the system. Read-only. Value must be treated as opaque by clients a +Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/release-1.4/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.4/docs/devel/api-conventions.md#metadata

    - + @@ -1634,14 +1648,14 @@ Populated by the system when a graceful deletion is requested. Read-only. More i - + - + @@ -1660,6 +1674,13 @@ Populated by the system when a graceful deletion is requested. Read-only. More i + + + + + + +

    lastHeartbeatTime

    Last time we got an update on a given condition.

    false

    string

    string (date-time)

    lastTransitionTime

    Last time the condition transit from one status to another.

    false

    string

    string (date-time)

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    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

    Hard is the set of enforced hard limits for each named resource. More info: http://releases.k8s.io/release-1.4/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

    false

    object

    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

    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    false

    string

    Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

    -Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

    false

    string

    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

    -Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

    false

    string

    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

    -Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    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

    string (date-time)

    deletionTimestamp

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource will be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. Once the resource is deleted in the API, the Kubelet will send a hard termination signal to the container. If not set, graceful deletion of the object has not been requested.

    -Populated by the system when a graceful deletion is requested. Read-only. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

    false

    string

    string (date-time)

    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

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/release-1.4/docs/user-guide/labels.md

    false

    object

    annotations

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/annotations.md

    false

    object

    string array

    clusterName

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    false

    string

    @@ -1803,7 +1824,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.3/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.4/docs/user-guide/volumes.md#iscsi

    false

    string

    @@ -1844,7 +1865,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.3/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.4/docs/user-guide/volumes.md#emptydir

    false

    string

    @@ -1878,21 +1899,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    @@ -1939,28 +1960,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    -

    Items is the list of Namespace objects in the list. More info: http://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

    +

    Items is the list of Namespace objects in the list. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

    true

    v1.Namespace array

    @@ -1994,35 +2015,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Spec defines the desired characteristics of a volume requested by a pod author. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    +

    Spec defines the desired characteristics of a volume requested by a pod author. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    false

    v1.PersistentVolumeClaimSpec

    status

    -

    Status represents the current information/status of a persistent volume claim. Read-only. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    +

    Status represents the current information/status of a persistent volume claim. Read-only. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    false

    v1.PersistentVolumeClaimStatus

    @@ -2056,35 +2077,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    secrets

    -

    Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/secrets.md

    false

    v1.ObjectReference array

    imagePullSecrets

    -

    ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/secrets.md#manually-specifying-an-imagepullsecret

    false

    v1.LocalObjectReference array

    @@ -2159,35 +2180,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Spec defines the behavior of the Namespace. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    +

    Spec defines the behavior of the Namespace. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.NamespaceSpec

    status

    -

    Status describes the current status of a Namespace. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    +

    Status describes the current status of a Namespace. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.NamespaceStatus

    @@ -2255,7 +2276,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.3/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.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    true

    string

    @@ -2303,7 +2324,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.3/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.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    @@ -2337,28 +2358,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    -

    Items is a list of ResourceQuota objects. More info: http://releases.k8s.io/release-1.3/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.4/docs/design/admission_control_resource_quota.md#admissioncontrol-plugin-resourcequota

    true

    v1.ResourceQuota array

    @@ -2399,7 +2420,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.3/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.4/docs/user-guide/persistent-volumes.md#access-modes-1

    false

    v1.PersistentVolumeAccessMode array

    @@ -2543,7 +2564,7 @@ The resulting set of endpoints can be viewed as:

    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

    +

    Name of the secret in the pod’s namespace to use. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#secrets

    false

    string

    @@ -2555,6 +2576,13 @@ The resulting set of endpoints can be viewed as:

    v1.KeyToPath array

    + +

    defaultMode

    +

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    +

    false

    +

    integer (int32)

    + + @@ -2562,7 +2590,7 @@ The resulting set of endpoints can be viewed as:

    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.

    +

    FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

    @@ -2646,7 +2674,7 @@ The resulting set of endpoints can be viewed as:
    - + @@ -2701,35 +2729,35 @@ The resulting set of endpoints can be viewed as:
    - + - + - + - + - + @@ -2778,6 +2806,68 @@ The resulting set of endpoints can be viewed as:

    fieldRef

    Selects a field of the pod; only name and namespace are supported.

    Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

    false

    v1.ObjectFieldSelector

    kind

    Kind is a string value representing the REST resource this object represents. Servers 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

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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.

    Standard object metadata; More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata.

    false

    v1.ObjectMeta

    spec

    defines the behavior of the scale. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status.

    defines the behavior of the scale. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status.

    false

    v1.ScaleSpec

    status

    current status of the scale. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status. Read-only.

    current status of the scale. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status. Read-only.

    false

    v1.ScaleStatus

    +
    +
    +

    v1.AzureDiskVolumeSource

    +
    +

    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    diskName

    The Name of the data disk in the blob storage

    true

    string

    diskURI

    The URI the data disk in the blob storage

    true

    string

    cachingMode

    Host Caching mode: None, Read Only, Read Write.

    false

    v1.AzureDataDiskCachingMode

    fsType

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    false

    string

    readOnly

    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    false

    boolean

    false

    +

    v1.KeyToPath

    @@ -2816,6 +2906,13 @@ The resulting set of endpoints can be viewed as:

    string

    + +

    mode

    +

    Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    +

    false

    +

    integer (int32)

    + + @@ -2845,35 +2942,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Spec defines the behavior of a service. http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    +

    Spec defines the behavior of a service. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.ServiceSpec

    status

    -

    Most recently observed status of the service. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.ServiceStatus

    @@ -2948,28 +3045,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    -

    List of ServiceAccounts. More info: http://releases.k8s.io/release-1.3/docs/design/service_accounts.md#service-accounts

    +

    List of ServiceAccounts. More info: http://releases.k8s.io/release-1.4/docs/design/service_accounts.md#service-accounts

    true

    v1.ServiceAccount array

    @@ -3003,28 +3100,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    -

    Items is a list of LimitRange objects. More info: http://releases.k8s.io/release-1.3/docs/design/admission_control_limit_range.md

    +

    Items is a list of LimitRange objects. More info: http://releases.k8s.io/release-1.4/docs/design/admission_control_limit_range.md

    true

    v1.LimitRange array

    @@ -3069,21 +3166,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    @@ -3124,14 +3221,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    @@ -3186,35 +3283,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.3/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.4/docs/user-guide/identifiers.md#names

    true

    string

    hostPath

    -

    HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#hostpath

    false

    v1.HostPathVolumeSource

    emptyDir

    -

    EmptyDir represents a temporary directory that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#emptydir

    false

    v1.EmptyDirVolumeSource

    gcePersistentDisk

    -

    GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    v1.GCEPersistentDiskVolumeSource

    awsElasticBlockStore

    -

    AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

    false

    v1.AWSElasticBlockStoreVolumeSource

    @@ -3228,56 +3325,56 @@ 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.3/docs/user-guide/volumes.md#secrets

    +

    Secret represents a secret that should populate this volume. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#secrets

    false

    v1.SecretVolumeSource

    nfs

    -

    NFS represents an NFS mount on the host that shares a pod’s lifetime More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#nfs

    false

    v1.NFSVolumeSource

    iscsi

    -

    ISCSI represents an ISCSI Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/iscsi/README.md

    false

    v1.ISCSIVolumeSource

    glusterfs

    -

    Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/glusterfs/README.md

    false

    v1.GlusterfsVolumeSource

    persistentVolumeClaim

    -

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    false

    v1.PersistentVolumeClaimVolumeSource

    rbd

    -

    RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/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.

    +

    FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

    false

    v1.FlexVolumeSource

    cinder

    -

    Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/release-1.3/examples/mysql-cinder-pd/README.md

    +

    Cinder represents a cinder volume attached and mounted on kubelets host machine More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

    false

    v1.CinderVolumeSource

    @@ -3331,6 +3428,20 @@ The resulting set of endpoints can be viewed as:

    v1.VsphereVirtualDiskVolumeSource

    + +

    quobyte

    +

    Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

    +

    false

    +

    v1.QuobyteVolumeSource

    + + + +

    azureDisk

    +

    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

    +

    false

    +

    v1.AzureDiskVolumeSource

    + + @@ -3429,14 +3540,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.3/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.4/docs/user-guide/pod-states.md#container-probes

    false

    integer (int32)

    timeoutSeconds

    -

    Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/pod-states.md#container-probes

    false

    integer (int32)

    @@ -3491,14 +3602,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    @@ -3546,7 +3657,7 @@ The resulting set of endpoints can be viewed as:

    name

    -

    Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

    +

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    @@ -3587,35 +3698,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    -

    If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object’s metadata. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Spec defines the specification of the desired behavior of the replication controller. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.ReplicationControllerSpec

    status

    -

    Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.ReplicationControllerStatus

    @@ -3701,14 +3812,14 @@ The resulting set of endpoints can be viewed as:

    phase

    -

    Current condition of the pod. More info: http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#pod-phase

    +

    Current condition of the pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#pod-phase

    false

    string

    conditions

    -

    Current service state of pod. More info: http://releases.k8s.io/release-1.3/docs/user-guide/pod-states.md#pod-conditions

    +

    Current service state of pod. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#pod-conditions

    false

    v1.PodCondition array

    @@ -3745,12 +3856,12 @@ The resulting set of endpoints can be viewed as:

    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

    +

    string (date-time)

    containerStatuses

    -

    The list has one entry per container in the manifest. Each entry is currently the output of docker inspect. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/pod-states.md#container-statuses

    false

    v1.ContainerStatus array

    @@ -3784,28 +3895,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Spec defines the limits enforced. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    +

    Spec defines the limits enforced. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.LimitRangeSpec

    @@ -3858,6 +3969,13 @@ The resulting set of endpoints can be viewed as:

    v1.ResourceFieldSelector

    + +

    mode

    +

    Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    +

    false

    +

    integer (int32)

    + + @@ -3887,21 +4005,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.3/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.4/docs/user-guide/volumes.md

    false

    v1.Volume array

    containers

    -

    List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/containers.md

    true

    v1.Container array

    restartPolicy

    -

    Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/pod-states.md#restartpolicy

    false

    string

    @@ -3929,14 +4047,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.3/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.4/docs/user-guide/node-selection/README.md

    false

    object

    serviceAccountName

    -

    ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: http://releases.k8s.io/release-1.3/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.4/docs/design/service_accounts.md

    false

    string

    @@ -3985,7 +4103,7 @@ 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.3/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.4/docs/user-guide/images.md#specifying-imagepullsecrets-on-a-pod

    false

    v1.LocalObjectReference array

    @@ -4095,35 +4213,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Spec defines the desired quota. http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    +

    Spec defines the desired quota. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.ResourceQuotaSpec

    status

    -

    Status defines the actual enforced quota and its current usage. http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    +

    Status defines the actual enforced quota and its current usage. http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.ResourceQuotaStatus

    @@ -4157,21 +4275,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    @@ -4212,14 +4330,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.3/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.4/docs/user-guide/container-environment.md#hook-details

    false

    v1.Handler

    preStop

    -

    PreStop is called immediately before a container is terminated. The container is terminated after the handler completes. The reason for termination is passed to the handler. Regardless of the outcome of the handler, the container is eventually terminated. Other management of the container blocks until the hook completes. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/container-environment.md#hook-details

    false

    v1.Handler

    @@ -4253,21 +4371,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.3/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.4/docs/user-guide/replication-controller.md#what-is-a-replication-controller

    false

    integer (int32)

    selector

    -

    Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/labels.md#label-selectors

    false

    object

    template

    -

    Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/replication-controller.md#pod-template

    false

    v1.PodTemplateSpec

    @@ -4349,7 +4467,7 @@ The resulting set of endpoints can be viewed as:

    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.

    +

    Capacity represents the total resources of a node. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#capacity for more details.

    false

    object

    @@ -4363,21 +4481,21 @@ The resulting set of endpoints can be viewed as:

    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

    +

    NodePhase is the recently observed lifecycle phase of the node. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-phase The field is never populated, and now is deprecated.

    false

    string

    conditions

    -

    Conditions is an array of current observed node conditions. More info: http://releases.k8s.io/release-1.3/docs/admin/node.md#node-condition

    +

    Conditions is an array of current observed node conditions. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-condition

    false

    v1.NodeCondition array

    addresses

    -

    List of addresses reachable to the node. Queried from cloud provider, if available. More info: http://releases.k8s.io/release-1.3/docs/admin/node.md#node-addresses

    +

    List of addresses reachable to the node. Queried from cloud provider, if available. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-addresses

    false

    v1.NodeAddress array

    @@ -4391,7 +4509,7 @@ The resulting set of endpoints can be viewed as:

    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

    +

    Set of ids/uuids to uniquely identify the node. More info: http://releases.k8s.io/release-1.4/docs/admin/node.md#node-info

    false

    v1.NodeSystemInfo

    @@ -4446,21 +4564,21 @@ The resulting set of endpoints can be viewed as:

    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

    +

    EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

    true

    string

    path

    -

    Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.3/examples/glusterfs/README.md#create-a-pod

    +

    Path is the Glusterfs volume path. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

    true

    string

    readOnly

    -

    ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.3/examples/glusterfs/README.md#create-a-pod

    +

    ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.4/examples/volumes/glusterfs/README.md#create-a-pod

    false

    boolean

    false

    @@ -4576,14 +4694,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.3/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.4/docs/user-guide/pod-states.md#pod-conditions

    true

    string

    status

    -

    Status is the status of the condition. Can be True, False, Unknown. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/pod-states.md#pod-conditions

    true

    string

    @@ -4592,14 +4710,14 @@ The resulting set of endpoints can be viewed as:

    lastProbeTime

    Last time we probed the condition.

    false

    -

    string

    +

    string (date-time)

    lastTransitionTime

    Last time the condition transitioned from one status to another.

    false

    -

    string

    +

    string (date-time)

    @@ -4645,56 +4763,56 @@ The resulting set of endpoints can be viewed as:

    monitors

    -

    A collection of Ceph monitors. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

    +

    A collection of Ceph monitors. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    true

    string array

    image

    -

    The rados image name. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

    +

    The rados image name. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    true

    string

    fsType

    -

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#rbd

    false

    string

    pool

    -

    The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it.

    +

    The rados pool name. Default is rbd. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it.

    false

    string

    user

    -

    The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

    +

    The rados user name. Default is admin. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    string

    keyring

    -

    Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

    +

    Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    string

    secretRef

    -

    SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/release-1.3/examples/rbd/README.md#how-to-use-it

    +

    SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/release-1.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    v1.LocalObjectReference

    readOnly

    -

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/rbd/README.md#how-to-use-it

    false

    boolean

    false

    @@ -4728,28 +4846,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    template

    -

    Template defines the pods that will be created from this pod template. http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.PodTemplateSpec

    @@ -4817,21 +4935,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.3/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.4/docs/user-guide/volumes.md#nfs

    true

    string

    path

    -

    Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.3/docs/user-guide/volumes.md#nfs

    +

    Path that is exported by the NFS server. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#nfs

    true

    string

    readOnly

    -

    ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#nfs

    false

    boolean

    false

    @@ -4906,7 +5024,7 @@ The resulting set of endpoints can be viewed as:

    targetWWNs

    -

    Required: FC target world wide names (WWNs)

    +

    Required: FC target worldwide names (WWNs)

    true

    string array

    @@ -5057,7 +5175,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    @@ -5201,28 +5319,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    -

    Items is a list of secret objects. More info: http://releases.k8s.io/release-1.3/docs/user-guide/secrets.md

    +

    Items is a list of secret objects. More info: http://releases.k8s.io/release-1.4/docs/user-guide/secrets.md

    true

    v1.Secret array

    @@ -5263,21 +5381,21 @@ The resulting set of endpoints can be viewed as:

    image

    -

    Docker image name. More info: http://releases.k8s.io/release-1.3/docs/user-guide/images.md

    +

    Docker image name. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md

    false

    string

    command

    -

    Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/containers.md#containers-and-commands

    false

    string array

    args

    -

    Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/containers.md#containers-and-commands

    false

    string array

    @@ -5305,7 +5423,7 @@ 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.3/docs/user-guide/persistent-volumes.md#resources

    +

    Compute Resources required by this container. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#resources

    false

    v1.ResourceRequirements

    @@ -5319,14 +5437,14 @@ The resulting set of endpoints can be viewed as:

    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

    +

    Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pod-states.md#container-probes

    false

    v1.Probe

    readinessProbe

    -

    Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/pod-states.md#container-probes

    false

    v1.Probe

    @@ -5347,14 +5465,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.3/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.4/docs/user-guide/images.md#updating-images

    false

    string

    securityContext

    -

    Security options the pod should run with. More info: http://releases.k8s.io/release-1.3/docs/design/security_context.md

    +

    Security options the pod should run with. More info: http://releases.k8s.io/release-1.4/docs/design/security_context.md

    false

    v1.SecurityContext

    @@ -5473,49 +5591,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.3/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.4/docs/user-guide/persistent-volumes.md#capacity

    false

    object

    gcePersistentDisk

    -

    GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. Provisioned by an admin. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#gcepersistentdisk

    false

    v1.GCEPersistentDiskVolumeSource

    awsElasticBlockStore

    -

    AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

    false

    v1.AWSElasticBlockStoreVolumeSource

    hostPath

    -

    HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#hostpath

    false

    v1.HostPathVolumeSource

    glusterfs

    -

    Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/glusterfs/README.md

    false

    v1.GlusterfsVolumeSource

    nfs

    -

    NFS represents an NFS mount on the host. Provisioned by an admin. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#nfs

    false

    v1.NFSVolumeSource

    rbd

    -

    RBD represents a Rados Block Device mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/release-1.3/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.4/examples/volumes/rbd/README.md

    false

    v1.RBDVolumeSource

    @@ -5529,7 +5647,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.3/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.4/examples/mysql-cinder-pd/README.md

    false

    v1.CinderVolumeSource

    @@ -5557,7 +5675,7 @@ The resulting set of endpoints can be viewed as:

    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.

    +

    FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. This is an alpha feature and may change in future.

    false

    v1.FlexVolumeSource

    @@ -5577,22 +5695,36 @@ The resulting set of endpoints can be viewed as:
    +

    quobyte

    +

    Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

    +

    false

    +

    v1.QuobyteVolumeSource

    + + + +

    azureDisk

    +

    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

    +

    false

    +

    v1.AzureDiskVolumeSource

    + + +

    accessModes

    -

    AccessModes contains all ways the volume can be mounted. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/persistent-volumes.md#access-modes

    false

    v1.PersistentVolumeAccessMode array

    claimRef

    -

    ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/persistent-volumes.md#binding

    false

    v1.ObjectReference

    persistentVolumeReclaimPolicy

    -

    What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. 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

    +

    What happens to a persistent volume when released from its claim. Valid options are Retain (default) and Recycle. Recycling must be supported by the volume plugin underlying this persistent volume. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md#recycling-policy

    false

    string

    @@ -5626,7 +5758,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.3/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.4/docs/user-guide/replication-controller.md#what-is-a-replication-controller

    true

    integer (int32)

    @@ -5639,6 +5771,13 @@ The resulting set of endpoints can be viewed as:
    +

    readyReplicas

    +

    The number of ready replicas for this replication controller.

    +

    false

    +

    integer (int32)

    + + +

    observedGeneration

    ObservedGeneration reflects the generation of the most recently observed replication controller.

    false

    @@ -5699,14 +5838,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.3/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.4/docs/user-guide/services.md#defining-a-service

    false

    string

    nodePort

    -

    The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/services.md#type—nodeport

    false

    integer (int32)

    @@ -5802,21 +5941,21 @@ The resulting set of endpoints can be viewed as:

    kind

    -

    Kind of the referent. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

    +

    Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    true

    string

    name

    -

    Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

    +

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    true

    string

    uid

    -

    UID of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

    +

    UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    true

    string

    @@ -5891,21 +6030,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    @@ -5946,7 +6085,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.3/docs/user-guide/volumes.md#hostpath

    +

    Path of the directory on the host. More info: http://releases.k8s.io/release-1.4/docs/user-guide/volumes.md#hostpath

    true

    string

    @@ -6010,14 +6149,14 @@ The resulting set of endpoints can be viewed as:

    startedAt

    Time at which previous execution of the container started

    false

    -

    string

    +

    string (date-time)

    finishedAt

    Time at which the container last terminated

    false

    -

    string

    +

    string (date-time)

    @@ -6056,21 +6195,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    @@ -6111,21 +6250,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.3/examples/mysql-cinder-pd/README.md

    +

    volume id used to identify the volume in cinder More info: http://releases.k8s.io/release-1.4/examples/mysql-cinder-pd/README.md

    true

    string

    fsType

    -

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/examples/mysql-cinder-pd/README.md

    false

    string

    readOnly

    -

    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/release-1.3/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.4/examples/mysql-cinder-pd/README.md

    false

    boolean

    false

    @@ -6250,6 +6389,61 @@ The resulting set of endpoints can be viewed as:
    +
    +
    +

    v1alpha1.Eviction

    +
    +

    Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to …/pods/foo/evictions.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    ObjectMeta describes the pod that is being evicted.

    false

    v1.ObjectMeta

    deleteOptions

    DeleteOptions may be provided

    false

    v1.DeleteOptions

    +

    v1.AWSElasticBlockStoreVolumeSource

    @@ -6279,14 +6473,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.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

    true

    string

    fsType

    -

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/release-1.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

    false

    string

    @@ -6300,7 +6494,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.3/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.4/docs/user-guide/volumes.md#awselasticblockstore

    false

    boolean

    false

    @@ -6369,7 +6563,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.3/docs/user-guide/images.md

    +

    The image the container is running. More info: http://releases.k8s.io/release-1.4/docs/user-guide/images.md

    true

    string

    @@ -6383,7 +6577,69 @@ 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.3/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.4/docs/user-guide/container-environment.md#container-information

    +

    false

    +

    string

    + + + + + +
    +
    +

    v1.QuobyteVolumeSource

    +
    +

    Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -6462,28 +6718,28 @@ The resulting set of endpoints can be viewed as:
    - + - + - + - + @@ -6551,21 +6807,21 @@ The resulting set of endpoints can be viewed as:
    - + - + - + @@ -6578,6 +6834,13 @@ The resulting set of endpoints can be viewed as:
    + + + + + + + @@ -6613,21 +6876,21 @@ The resulting set of endpoints can be viewed as:
    - + - + - + @@ -6664,14 +6927,14 @@ The resulting set of endpoints can be viewed as:
    - + - + @@ -6769,14 +7032,14 @@ The resulting set of endpoints can be viewed as:
    - + - + @@ -6810,21 +7073,21 @@ The resulting set of endpoints can be viewed as:
    - + - + - + @@ -6934,14 +7197,14 @@ The resulting set of endpoints can be viewed as:
    - + - + @@ -6975,28 +7238,28 @@ The resulting set of endpoints can be viewed as:
    - + - + - + - + @@ -7030,21 +7293,21 @@ The resulting set of endpoints can be viewed as:
    - + - + - + @@ -7085,28 +7348,28 @@ The resulting set of endpoints can be viewed as:
    - + - + - + - + @@ -7140,28 +7403,28 @@ The resulting set of endpoints can be viewed as:
    - + - + - + - + @@ -7175,7 +7438,7 @@ The resulting set of endpoints can be viewed as:
    - + @@ -7305,28 +7568,28 @@ The resulting set of endpoints can be viewed as:
    - + - + - + - + @@ -7388,7 +7651,7 @@ The resulting set of endpoints can be viewed as:
    - + @@ -7526,28 +7789,28 @@ The resulting set of endpoints can be viewed as:
    - + - + - + - + @@ -7568,7 +7831,7 @@ The resulting set of endpoints can be viewed as:
    - + @@ -7582,11 +7845,18 @@ The resulting set of endpoints can be viewed as:
    - + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    registry

    Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

    true

    string

    volume

    Volume is a string that references an already created Quobyte volume by name.

    true

    string

    readOnly

    ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

    false

    boolean

    false

    user

    User to map volume access to Defaults to serivceaccount user

    false

    string

    group

    Group to map volume access to Default is no group

    false

    string

    kind

    Kind is a string value representing the REST resource this object represents. Servers 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

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    List of replication controllers. More info: http://releases.k8s.io/release-1.3/docs/user-guide/replication-controller.md

    List of replication controllers. More info: http://releases.k8s.io/release-1.4/docs/user-guide/replication-controller.md

    true

    v1.ReplicationController array

    kind

    Kind is a string value representing the REST resource this object represents. Servers 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

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    stringData

    stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.

    false

    object

    type

    Used to facilitate programmatic handling of secret data.

    false

    kind

    Kind is a string value representing the REST resource this object represents. Servers 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

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    true

    v1.ObjectMeta

    firstTimestamp

    The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)

    false

    string

    string (date-time)

    lastTimestamp

    The time at which the most recent occurrence of this event was recorded.

    false

    string

    string (date-time)

    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

    Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

    false

    object

    requests

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://releases.k8s.io/release-1.3/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://kubernetes.io/docs/user-guide/compute-resources/

    false

    object

    kind

    Kind is a string value representing the REST resource this object represents. Servers 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

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#metadata

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.PodSpec

    kind

    Kind is a string value representing the REST resource this object represents. Servers 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

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    List of pods. More info: http://releases.k8s.io/release-1.3/docs/user-guide/pods.md

    List of pods. More info: http://releases.k8s.io/release-1.4/docs/user-guide/pods.md

    true

    v1.Pod array

    kind

    Kind is a string value representing the REST resource this object represents. Servers 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

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    kind

    Kind is a string value representing the REST resource this object represents. Servers 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

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    List of persistent volumes. More info: http://releases.k8s.io/release-1.3/docs/user-guide/persistent-volumes.md

    List of persistent volumes. More info: http://releases.k8s.io/release-1.4/docs/user-guide/persistent-volumes.md

    true

    v1.PersistentVolume array

    kind

    Kind of the referent. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#types-kinds

    Kind of the referent. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    namespace

    Namespace of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/namespaces.md

    Namespace of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/namespaces.md

    false

    string

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#uids

    UID of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#uids

    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

    Specific resourceVersion to which this reference is made, if any. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    kind

    Kind is a string value representing the REST resource this object represents. Servers 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

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    Standard list metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    status

    Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    string

    name

    Name of the referent. More info: http://releases.k8s.io/release-1.3/docs/user-guide/identifiers.md#names

    Name of the referent. More info: http://releases.k8s.io/release-1.4/docs/user-guide/identifiers.md#names

    false

    string

    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

    The list of ports that are exposed by this service. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#virtual-ips-and-service-proxies

    true

    v1.ServicePort array

    selector

    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

    Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#overview

    false

    object

    clusterIP

    ClusterIP is 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

    clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#virtual-ips-and-service-proxies

    false

    string

    type

    Type 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

    type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#overview

    false

    string

    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

    Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: http://releases.k8s.io/release-1.4/docs/user-guide/services.md#virtual-ips-and-service-proxies

    false

    string

    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

    If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: http://releases.k8s.io/release-1.4/docs/user-guide/services-firewalls.md

    false

    string array

    externalName

    externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName.

    false

    string

    @@ -7616,35 +7886,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.3/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.4/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    -

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/release-1.3/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.4/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

    +

    Standard object’s metadata. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    -

    Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.3/docs/devel/api-conventions.md#spec-and-status

    +

    Specification of the desired behavior of the pod. More info: http://releases.k8s.io/release-1.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.PodSpec

    status

    -

    Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: http://releases.k8s.io/release-1.3/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.4/docs/devel/api-conventions.md#spec-and-status

    false

    v1.PodStatus

    @@ -7699,7 +7969,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.3/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.4/docs/admin/node.md#manual-node-administration"`

    false

    boolean

    false

    @@ -7746,6 +8016,13 @@ The resulting set of endpoints can be viewed as:
    +

    nodeName

    +

    Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.

    +

    false

    +

    string

    + + +

    targetRef

    Reference to object providing the endpoint.

    false

    @@ -7789,6 +8066,10 @@ The resulting set of endpoints can be viewed as:
    +
    +
    +

    v1.AzureDataDiskCachingMode

    +

    any

    @@ -7801,7 +8082,7 @@ The resulting set of endpoints can be viewed as:
    diff --git a/docs/api-reference/v1/definitions.md b/docs/api-reference/v1/definitions.md index 2e1b53938a..6e0097d365 100644 --- a/docs/api-reference/v1/definitions.md +++ b/docs/api-reference/v1/definitions.md @@ -1,7 +1,7 @@ --- --- -{% include v1.3/v1-definitions.html %} +{% include v1.4/v1-definitions.html %} diff --git a/docs/api-reference/v1/operations.html b/docs/api-reference/v1/operations.html index 4f8d8286af..7e23b5c822 100755 --- a/docs/api-reference/v1/operations.html +++ b/docs/api-reference/v1/operations.html @@ -41,7 +41,7 @@

    default

    success

    -

    unversioned.APIResourceList

    +

    unversioned.APIResourceList

    @@ -190,7 +190,7 @@

    200

    success

    -

    v1.ComponentStatusList

    +

    v1.ComponentStatusList

    @@ -301,7 +301,7 @@

    200

    success

    -

    v1.ComponentStatus

    +

    v1.ComponentStatus

    @@ -444,7 +444,7 @@

    200

    success

    -

    v1.ConfigMapList

    +

    v1.ConfigMapList

    @@ -587,7 +587,7 @@

    200

    success

    -

    v1.EndpointsList

    +

    v1.EndpointsList

    @@ -730,7 +730,7 @@

    200

    success

    -

    v1.EventList

    +

    v1.EventList

    @@ -873,7 +873,7 @@

    200

    success

    -

    v1.LimitRangeList

    +

    v1.LimitRangeList

    @@ -1016,7 +1016,7 @@

    200

    success

    -

    v1.NamespaceList

    +

    v1.NamespaceList

    @@ -1159,7 +1159,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -1244,7 +1244,7 @@

    body

    true

    -

    v1.Namespace

    +

    v1.Namespace

    @@ -1270,7 +1270,7 @@

    200

    success

    -

    v1.Namespace

    +

    v1.Namespace

    @@ -1355,7 +1355,7 @@

    body

    true

    -

    v1.Binding

    +

    v1.Binding

    @@ -1389,7 +1389,7 @@

    200

    success

    -

    v1.Binding

    +

    v1.Binding

    @@ -1540,7 +1540,7 @@

    200

    success

    -

    v1.ConfigMapList

    +

    v1.ConfigMapList

    @@ -1691,7 +1691,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -1776,7 +1776,7 @@

    body

    true

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -1810,7 +1810,7 @@

    200

    success

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -1945,7 +1945,7 @@

    200

    success

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -2030,7 +2030,7 @@

    body

    true

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -2072,7 +2072,7 @@

    200

    success

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -2157,7 +2157,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -2199,7 +2199,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -2284,7 +2284,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -2326,7 +2326,7 @@

    200

    success

    -

    v1.ConfigMap

    +

    v1.ConfigMap

    @@ -2483,7 +2483,7 @@

    200

    success

    -

    v1.EndpointsList

    +

    v1.EndpointsList

    @@ -2634,7 +2634,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -2719,7 +2719,7 @@

    body

    true

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -2753,7 +2753,7 @@

    200

    success

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -2888,7 +2888,7 @@

    200

    success

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -2973,7 +2973,7 @@

    body

    true

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -3015,7 +3015,7 @@

    200

    success

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -3100,7 +3100,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -3142,7 +3142,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -3227,7 +3227,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -3269,7 +3269,7 @@

    200

    success

    -

    v1.Endpoints

    +

    v1.Endpoints

    @@ -3426,7 +3426,7 @@

    200

    success

    -

    v1.EventList

    +

    v1.EventList

    @@ -3577,7 +3577,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -3662,7 +3662,7 @@

    body

    true

    -

    v1.Event

    +

    v1.Event

    @@ -3696,7 +3696,7 @@

    200

    success

    -

    v1.Event

    +

    v1.Event

    @@ -3831,7 +3831,7 @@

    200

    success

    -

    v1.Event

    +

    v1.Event

    @@ -3916,7 +3916,7 @@

    body

    true

    -

    v1.Event

    +

    v1.Event

    @@ -3958,7 +3958,7 @@

    200

    success

    -

    v1.Event

    +

    v1.Event

    @@ -4043,7 +4043,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -4085,7 +4085,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -4170,7 +4170,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -4212,7 +4212,7 @@

    200

    success

    -

    v1.Event

    +

    v1.Event

    @@ -4369,7 +4369,7 @@

    200

    success

    -

    v1.LimitRangeList

    +

    v1.LimitRangeList

    @@ -4520,7 +4520,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -4605,7 +4605,7 @@

    body

    true

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -4639,7 +4639,7 @@

    200

    success

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -4774,7 +4774,7 @@

    200

    success

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -4859,7 +4859,7 @@

    body

    true

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -4901,7 +4901,7 @@

    200

    success

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -4986,7 +4986,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -5028,7 +5028,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -5113,7 +5113,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -5155,7 +5155,7 @@

    200

    success

    -

    v1.LimitRange

    +

    v1.LimitRange

    @@ -5312,7 +5312,7 @@

    200

    success

    -

    v1.PersistentVolumeClaimList

    +

    v1.PersistentVolumeClaimList

    @@ -5463,7 +5463,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -5548,7 +5548,7 @@

    body

    true

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -5582,7 +5582,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -5717,7 +5717,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -5802,7 +5802,7 @@

    body

    true

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -5844,7 +5844,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -5929,7 +5929,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -5971,7 +5971,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -6056,7 +6056,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -6098,7 +6098,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -6223,7 +6223,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -6308,7 +6308,7 @@

    body

    true

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -6350,7 +6350,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -6435,7 +6435,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -6477,7 +6477,7 @@

    200

    success

    -

    v1.PersistentVolumeClaim

    +

    v1.PersistentVolumeClaim

    @@ -6634,7 +6634,7 @@

    200

    success

    -

    v1.PodList

    +

    v1.PodList

    @@ -6785,7 +6785,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -6870,7 +6870,7 @@

    body

    true

    -

    v1.Pod

    +

    v1.Pod

    @@ -6904,7 +6904,7 @@

    200

    success

    -

    v1.Pod

    +

    v1.Pod

    @@ -7039,7 +7039,7 @@

    200

    success

    -

    v1.Pod

    +

    v1.Pod

    @@ -7124,7 +7124,7 @@

    body

    true

    -

    v1.Pod

    +

    v1.Pod

    @@ -7166,7 +7166,7 @@

    200

    success

    -

    v1.Pod

    +

    v1.Pod

    @@ -7251,7 +7251,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.DeleteOptions

    @@ -7293,7 +7293,7 @@

    200

    success

    -

    unversioned.Status

    +

    unversioned.Status

    @@ -7378,7 +7378,7 @@

    body

    true

    -

    unversioned.Patch

    +

    unversioned.Patch

    @@ -7420,7 +7420,7 @@

    200

    success

    -

    v1.Pod

    +

    v1.Pod

    @@ -7801,7 +7801,7 @@

    body

    true

    -

    v1.Binding

    +

    v1.Binding

    @@ -7843,7 +7843,7 @@

    200

    success

    -

    v1.Binding

    +

    v1.Binding

    @@ -7887,10 +7887,10 @@
    -

    connect GET requests to exec of Pod

    +

    create eviction of a Eviction

    -
    GET /api/v1/namespaces/{namespace}/pods/{name}/exec
    +
    POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
    @@ -7917,50 +7917,18 @@

    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.

    +

    pretty

    +

    If true, then the output is pretty printed.

    false

    string

    -

    QueryParameter

    -

    command

    -

    Command is the remote command to execute. argv array. Not executed within a shell.

    -

    false

    -

    string

    +

    BodyParameter

    +

    body

    + +

    true

    +

    v1alpha1.Eviction

    @@ -7974,7 +7942,7 @@

    PathParameter

    name

    -

    name of the Pod

    +

    name of the Eviction

    true

    string

    @@ -8000,9 +7968,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1alpha1.Eviction

    @@ -8023,7 +7991,13 @@
    • -

      /

      +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -8040,10 +8014,10 @@
    -

    connect POST requests to exec of Pod

    +

    connect GET requests to exec of Pod

    -
    POST /api/v1/namespaces/{namespace}/pods/{name}/exec
    +
    GET /api/v1/namespaces/{namespace}/pods/{name}/exec
    @@ -8193,6 +8167,159 @@
    +

    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

    @@ -8200,7 +8327,7 @@
    -

    Parameters

    +

    Parameters

    @@ -8314,7 +8441,7 @@
    -

    Responses

    +

    Responses

    @@ -8332,118 +8459,7 @@ - - - -

    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

    v1.Pod

    @@ -8464,7 +8480,16 @@
    • -

      /

      +

      text/plain

      +
    • +
    • +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -8481,10 +8506,10 @@
    -

    connect POST requests to portforward of Pod

    +

    connect GET requests to portforward of Pod

    -
    POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
    +
    GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
    @@ -8586,10 +8611,10 @@
    -

    connect GET requests to proxy of Pod

    +

    connect POST requests to portforward of Pod

    -
    GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
    +
    POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
    @@ -8615,14 +8640,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

    @@ -8699,10 +8716,10 @@
    -

    connect PUT requests to proxy of Pod

    +

    connect GET requests to proxy of Pod

    -
    PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
    +
    GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
    @@ -8812,10 +8829,10 @@
    -

    connect DELETE requests to proxy of Pod

    +

    connect PUT requests to proxy of Pod

    -
    DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
    +
    PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
    @@ -8925,10 +8942,10 @@
    -

    connect POST requests to proxy of Pod

    +

    connect DELETE requests to proxy of Pod

    -
    POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
    +
    DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
    @@ -9038,10 +9055,10 @@
    -

    connect GET requests to proxy of Pod

    +

    connect POST requests to proxy of Pod

    -
    GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    +
    POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
    @@ -9090,14 +9107,6 @@

    string

    - -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    -

    string

    - - @@ -9159,10 +9168,10 @@
    -

    connect PUT requests to proxy of Pod

    +

    connect GET requests to proxy of Pod

    -
    PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    +
    GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    @@ -9280,10 +9289,10 @@
    -

    connect DELETE requests to proxy of Pod

    +

    connect PUT requests to proxy of Pod

    -
    DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    +
    PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    @@ -9401,10 +9410,10 @@
    -

    connect POST requests to proxy of Pod

    +

    connect DELETE requests to proxy of Pod

    -
    POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    +
    DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    @@ -9522,10 +9531,10 @@
    -

    read status of the specified Pod

    +

    connect POST requests to proxy of Pod

    -
    GET /api/v1/namespaces/{namespace}/pods/{name}/status
    +
    POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
    @@ -9552,8 +9561,8 @@

    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

    @@ -9574,6 +9583,14 @@

    string

    + +

    PathParameter

    +

    path

    +

    path to the resource

    +

    true

    +

    string

    + + @@ -9595,9 +9612,9 @@ -

    200

    +

    default

    success

    -

    v1.Pod

    +

    string

    @@ -9618,13 +9635,7 @@
    • -

      application/json

      -
    • -
    • -

      application/yaml

      -
    • -
    • -

      application/vnd.kubernetes.protobuf

      +

      /

    @@ -9641,10 +9652,10 @@
    -

    replace status of the specified Pod

    +

    read status of the specified Pod

    -
    PUT /api/v1/namespaces/{namespace}/pods/{name}/status
    +
    GET /api/v1/namespaces/{namespace}/pods/{name}/status
    @@ -9678,14 +9689,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1.Pod

    - - -

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    @@ -9724,7 +9727,7 @@

    200

    success

    -

    v1.Pod

    +

    v1.Pod

    @@ -9768,10 +9771,10 @@
    -

    partially update status of the specified Pod

    +

    replace status of the specified Pod

    -
    PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
    +
    PUT /api/v1/namespaces/{namespace}/pods/{name}/status
    @@ -9809,7 +9812,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1.Pod

    @@ -9851,7 +9854,7 @@

    200

    success

    -

    v1.Pod

    +

    v1.Pod

    @@ -9862,13 +9865,7 @@
    • -

      application/json-patch+json

      -
    • -
    • -

      application/merge-patch+json

      -
    • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -9901,10 +9898,10 @@
    -

    list or watch objects of kind PodTemplate

    +

    partially update status of the specified Pod

    -
    GET /api/v1/namespaces/{namespace}/podtemplates
    +
    PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
    @@ -9938,43 +9935,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

    @@ -9985,6 +9950,14 @@

    string

    + +

    PathParameter

    +

    name

    +

    name of the Pod

    +

    true

    +

    string

    + + @@ -10008,7 +9981,7 @@

    200

    success

    -

    v1.PodTemplateList

    +

    v1.Pod

    @@ -10019,7 +9992,13 @@
    • -

      /

      +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

    @@ -10052,10 +10031,10 @@
    -

    delete collection of PodTemplate

    +

    list or watch objects of kind PodTemplate

    -
    DELETE /api/v1/namespaces/{namespace}/podtemplates
    +
    GET /api/v1/namespaces/{namespace}/podtemplates
    @@ -10159,7 +10138,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.PodTemplateList

    @@ -10203,10 +10182,10 @@
    -

    create a PodTemplate

    +

    delete collection of PodTemplate

    -
    POST /api/v1/namespaces/{namespace}/podtemplates
    +
    DELETE /api/v1/namespaces/{namespace}/podtemplates
    @@ -10240,647 +10219,6 @@ -

    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

    - -------- - - - - - - - - - - - - - - - - - - - - @@ -10931,6 +10269,641 @@
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +
    +
    +

    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

    @@ -10951,7 +10924,7 @@

    200

    success

    -

    v1.ReplicationControllerList

    +

    v1.PodTemplate

    @@ -10962,7 +10935,13 @@
    • -

      /

      +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

    @@ -10995,10 +10974,10 @@
    -

    delete collection of ReplicationController

    +

    list or watch objects of kind ReplicationController

    -
    DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
    +
    GET /api/v1/namespaces/{namespace}/replicationcontrollers
    @@ -11102,7 +11081,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.ReplicationControllerList

    @@ -11146,10 +11125,10 @@
    -

    create a ReplicationController

    +

    delete collection of ReplicationController

    -
    POST /api/v1/namespaces/{namespace}/replicationcontrollers
    +
    DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
    @@ -11183,1405 +11162,6 @@ -

    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

    - -------- - - - - - - - - - - - - - - - - - - - - @@ -12632,6 +11212,1399 @@
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +
    +
    +

    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

    @@ -12652,7 +12625,7 @@

    200

    success

    -

    v1.ResourceQuotaList

    +

    v1.ReplicationController

    @@ -12663,7 +12636,13 @@
    • -

      /

      +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

    @@ -12696,10 +12675,10 @@
    -

    delete collection of ResourceQuota

    +

    list or watch objects of kind ResourceQuota

    -
    DELETE /api/v1/namespaces/{namespace}/resourcequotas
    +
    GET /api/v1/namespaces/{namespace}/resourcequotas
    @@ -12803,7 +12782,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.ResourceQuotaList

    @@ -12847,10 +12826,10 @@
    -

    create a ResourceQuota

    +

    delete collection of ResourceQuota

    -
    POST /api/v1/namespaces/{namespace}/resourcequotas
    +
    DELETE /api/v1/namespaces/{namespace}/resourcequotas
    @@ -12884,1026 +12863,6 @@ -

    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

    - -------- - - - - - - - - - - - - - - - - - - - - @@ -13954,6 +12913,1020 @@
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +
    +
    +

    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

    @@ -13974,7 +13947,7 @@

    200

    success

    -

    v1.SecretList

    +

    v1.ResourceQuota

    @@ -13985,7 +13958,13 @@
    • -

      /

      +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

    @@ -14018,10 +13997,10 @@
    -

    delete collection of Secret

    +

    list or watch objects of kind Secret

    -
    DELETE /api/v1/namespaces/{namespace}/secrets
    +
    GET /api/v1/namespaces/{namespace}/secrets
    @@ -14125,7 +14104,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.SecretList

    @@ -14169,10 +14148,10 @@
    -

    create a Secret

    +

    delete collection of Secret

    -
    POST /api/v1/namespaces/{namespace}/secrets
    +
    DELETE /api/v1/namespaces/{namespace}/secrets
    @@ -14206,647 +14185,6 @@ -

    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

    - -------- - - - - - - - - - - - - - - - - - - - - @@ -14897,6 +14235,641 @@
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +
    +
    +

    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

    @@ -14917,7 +14890,7 @@

    200

    success

    -

    v1.ServiceAccountList

    +

    v1.Secret

    @@ -14928,7 +14901,13 @@
    • -

      /

      +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

    @@ -14961,10 +14940,10 @@
    -

    delete collection of ServiceAccount

    +

    list or watch objects of kind ServiceAccount

    -
    DELETE /api/v1/namespaces/{namespace}/serviceaccounts
    +
    GET /api/v1/namespaces/{namespace}/serviceaccounts
    @@ -15068,7 +15047,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.ServiceAccountList

    @@ -15112,10 +15091,10 @@
    -

    create a ServiceAccount

    +

    delete collection of ServiceAccount

    -
    POST /api/v1/namespaces/{namespace}/serviceaccounts
    +
    DELETE /api/v1/namespaces/{namespace}/serviceaccounts
    @@ -15149,647 +15128,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

      -
    • -
    • -

      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

    - -------- - - - - - - - - - - - - - - - - - - - - @@ -15842,7 +15180,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.

    @@ -15860,14 +15198,14 @@ - +

    200

    success

    v1.ServiceList

    unversioned.Status

    -

    Consumes

    +

    Consumes

    • @@ -15877,7 +15215,7 @@
    -

    Produces

    +

    Produces

    • @@ -15893,7 +15231,7 @@
    -

    Tags

    +

    Tags

    • @@ -15904,14 +15242,14 @@
    -

    create a Service

    +

    create a ServiceAccount

    -
    POST /api/v1/namespaces/{namespace}/services
    +
    POST /api/v1/namespaces/{namespace}/serviceaccounts
    -

    Parameters

    +

    Parameters

    @@ -15945,7 +15283,680 @@ - + + + + + + + + + + + + +

    body

    true

    v1.Service

    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

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -15979,7 +15990,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.ServiceList

    @@ -16023,6 +16034,125 @@
    +

    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

    @@ -16030,7 +16160,7 @@
    -

    Parameters

    +

    Parameters

    @@ -16094,133 +16224,6 @@
    -
    -
    -

    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

    @@ -16241,7 +16244,7 @@

    200

    success

    -

    v1.Service

    +

    v1.Service

    @@ -16285,10 +16288,10 @@
    -

    delete a Service

    +

    replace the specified Service

    -
    DELETE /api/v1/namespaces/{namespace}/services/{name}
    +
    PUT /api/v1/namespaces/{namespace}/services/{name}
    @@ -16322,6 +16325,14 @@ +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.Service

    + + +

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    @@ -16360,7 +16371,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.Service

    @@ -16404,10 +16415,10 @@
    -

    partially update the specified Service

    +

    delete a Service

    -
    PATCH /api/v1/namespaces/{namespace}/services/{name}
    +
    DELETE /api/v1/namespaces/{namespace}/services/{name}
    @@ -16441,14 +16452,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    unversioned.Patch

    - - -

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    @@ -16487,7 +16490,7 @@

    200

    success

    -

    v1.Service

    +

    unversioned.Status

    @@ -16498,13 +16501,7 @@
    • -

      application/json-patch+json

      -
    • -
    • -

      application/merge-patch+json

      -
    • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -16537,10 +16534,10 @@
    -

    connect GET requests to proxy of Service

    +

    partially update the specified Service

    -
    GET /api/v1/namespaces/{namespace}/services/{name}/proxy
    +
    PATCH /api/v1/namespaces/{namespace}/services/{name}
    @@ -16567,13 +16564,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

    +

    unversioned.Patch

    + + +

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    @@ -16610,9 +16615,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.Service

    @@ -16623,7 +16628,13 @@
    • -

      /

      +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

    @@ -16633,7 +16644,13 @@
    • -

      /

      +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -16650,10 +16667,10 @@
    -

    connect PUT requests to proxy of Service

    +

    connect GET requests to proxy of Service

    -
    PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
    +
    GET /api/v1/namespaces/{namespace}/services/{name}/proxy
    @@ -16763,10 +16780,10 @@
    -

    connect DELETE requests to proxy of Service

    +

    connect PUT requests to proxy of Service

    -
    DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
    +
    PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
    @@ -16876,10 +16893,10 @@
    -

    connect POST requests to proxy of Service

    +

    connect DELETE requests to proxy of Service

    -
    POST /api/v1/namespaces/{namespace}/services/{name}/proxy
    +
    DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
    @@ -16989,10 +17006,10 @@
    -

    connect GET requests to proxy of Service

    +

    connect POST requests to proxy of Service

    -
    GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    +
    POST /api/v1/namespaces/{namespace}/services/{name}/proxy
    @@ -17041,14 +17058,6 @@

    string

    - -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    -

    string

    - - @@ -17110,10 +17119,10 @@
    -

    connect PUT requests to proxy of Service

    +

    connect GET requests to proxy of Service

    -
    PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    +
    GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    @@ -17231,10 +17240,10 @@
    -

    connect DELETE requests to proxy of Service

    +

    connect PUT requests to proxy of Service

    -
    DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    +
    PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    @@ -17352,10 +17361,10 @@
    -

    connect POST requests to proxy of Service

    +

    connect DELETE requests to proxy of Service

    -
    POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    +
    DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    @@ -17473,10 +17482,10 @@
    -

    read status of the specified Service

    +

    connect POST requests to proxy of Service

    -
    GET /api/v1/namespaces/{namespace}/services/{name}/status
    +
    POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
    @@ -17503,8 +17512,8 @@

    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

    @@ -17525,6 +17534,14 @@

    string

    + +

    PathParameter

    +

    path

    +

    path to the resource

    +

    true

    +

    string

    + + @@ -17546,9 +17563,9 @@ -

    200

    +

    default

    success

    -

    v1.Service

    +

    string

    @@ -17569,13 +17586,7 @@
    • -

      application/json

      -
    • -
    • -

      application/yaml

      -
    • -
    • -

      application/vnd.kubernetes.protobuf

      +

      /

    @@ -17592,10 +17603,10 @@
    -

    replace status of the specified Service

    +

    read status of the specified Service

    -
    PUT /api/v1/namespaces/{namespace}/services/{name}/status
    +
    GET /api/v1/namespaces/{namespace}/services/{name}/status
    @@ -17629,14 +17640,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1.Service

    - - -

    PathParameter

    namespace

    object name and auth scope, such as for teams and projects

    @@ -17675,7 +17678,7 @@

    200

    success

    -

    v1.Service

    +

    v1.Service

    @@ -17719,10 +17722,10 @@
    -

    partially update status of the specified Service

    +

    replace status of the specified Service

    -
    PATCH /api/v1/namespaces/{namespace}/services/{name}/status
    +
    PUT /api/v1/namespaces/{namespace}/services/{name}/status
    @@ -17760,7 +17763,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1.Service

    @@ -17802,7 +17805,7 @@

    200

    success

    -

    v1.Service

    +

    v1.Service

    @@ -17813,13 +17816,7 @@
    • -

      application/json-patch+json

      -
    • -
    • -

      application/merge-patch+json

      -
    • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -17852,6 +17849,139 @@
    +

    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

    @@ -17859,7 +17989,7 @@
    -

    Parameters

    +

    Parameters

    @@ -17915,125 +18045,6 @@
    -
    -
    -

    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

    @@ -18054,7 +18065,7 @@

    200

    success

    -

    v1.Namespace

    +

    v1.Namespace

    @@ -18098,10 +18109,10 @@
    -

    delete a Namespace

    +

    replace the specified Namespace

    -
    DELETE /api/v1/namespaces/{name}
    +
    PUT /api/v1/namespaces/{name}
    @@ -18139,7 +18150,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.Namespace

    @@ -18173,7 +18184,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.Namespace

    @@ -18217,10 +18228,10 @@
    -

    partially update the specified Namespace

    +

    delete a Namespace

    -
    PATCH /api/v1/namespaces/{name}
    +
    DELETE /api/v1/namespaces/{name}
    @@ -18258,7 +18269,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1.DeleteOptions

    @@ -18292,7 +18303,7 @@

    200

    success

    -

    v1.Namespace

    +

    unversioned.Status

    @@ -18303,13 +18314,7 @@
    • -

      application/json-patch+json

      -
    • -
    • -

      application/merge-patch+json

      -
    • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -18342,10 +18347,10 @@
    -

    replace finalize of the specified Namespace

    +

    partially update the specified Namespace

    -
    PUT /api/v1/namespaces/{name}/finalize
    +
    PATCH /api/v1/namespaces/{name}
    @@ -18383,7 +18388,7 @@

    body

    true

    -

    v1.Namespace

    +

    unversioned.Patch

    @@ -18417,7 +18422,7 @@

    200

    success

    -

    v1.Namespace

    +

    v1.Namespace

    @@ -18428,7 +18433,13 @@
    • -

      /

      +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

    @@ -18461,10 +18472,10 @@
    -

    read status of the specified Namespace

    +

    replace finalize of the specified Namespace

    -
    GET /api/v1/namespaces/{name}/status
    +
    PUT /api/v1/namespaces/{name}/finalize
    @@ -18498,6 +18509,14 @@ +

    BodyParameter

    +

    body

    + +

    true

    +

    v1.Namespace

    + + +

    PathParameter

    name

    name of the Namespace

    @@ -18528,7 +18547,7 @@

    200

    success

    -

    v1.Namespace

    +

    v1.Namespace

    @@ -18572,10 +18591,10 @@
    -

    replace status of the specified Namespace

    +

    read status of the specified Namespace

    -
    PUT /api/v1/namespaces/{name}/status
    +
    GET /api/v1/namespaces/{name}/status
    @@ -18609,14 +18628,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1.Namespace

    - - -

    PathParameter

    name

    name of the Namespace

    @@ -18647,7 +18658,7 @@

    200

    success

    -

    v1.Namespace

    +

    v1.Namespace

    @@ -18691,10 +18702,10 @@
    -

    partially update status of the specified Namespace

    +

    replace status of the specified Namespace

    -
    PATCH /api/v1/namespaces/{name}/status
    +
    PUT /api/v1/namespaces/{name}/status
    @@ -18732,7 +18743,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1.Namespace

    @@ -18766,7 +18777,7 @@

    200

    success

    -

    v1.Namespace

    +

    v1.Namespace

    @@ -18777,13 +18788,7 @@
    • -

      application/json-patch+json

      -
    • -
    • -

      application/merge-patch+json

      -
    • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -18816,10 +18821,10 @@
    -

    list or watch objects of kind Node

    +

    partially update status of the specified Namespace

    -
    GET /api/v1/nodes
    +
    PATCH /api/v1/namespaces/{name}/status
    @@ -18853,45 +18858,21 @@ -

    QueryParameter

    -

    labelSelector

    -

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    -

    false

    +

    BodyParameter

    +

    body

    + +

    true

    +

    unversioned.Patch

    + + + +

    PathParameter

    +

    name

    +

    name of the Namespace

    +

    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)

    - - @@ -18915,7 +18896,7 @@

    200

    success

    -

    v1.NodeList

    +

    v1.Namespace

    @@ -18926,7 +18907,13 @@
    • -

      /

      +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

    @@ -18959,10 +18946,10 @@
    -

    delete collection of Node

    +

    list or watch objects of kind Node

    -
    DELETE /api/v1/nodes
    +
    GET /api/v1/nodes
    @@ -19058,7 +19045,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.NodeList

    @@ -19102,10 +19089,10 @@
    -

    create a Node

    +

    delete collection of Node

    -
    POST /api/v1/nodes
    +
    DELETE /api/v1/nodes
    @@ -19139,11 +19126,43 @@ -

    BodyParameter

    -

    body

    +

    QueryParameter

    +

    labelSelector

    +

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +

    false

    +

    string

    -

    true

    -

    v1.Node

    + + +

    QueryParameter

    +

    fieldSelector

    +

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    watch

    +

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    +

    false

    +

    boolean

    + + + +

    QueryParameter

    +

    resourceVersion

    +

    When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

    +

    false

    +

    string

    + + + +

    QueryParameter

    +

    timeoutSeconds

    +

    Timeout for the list/watch call.

    +

    false

    +

    integer (int32)

    @@ -19169,7 +19188,7 @@

    200

    success

    -

    v1.Node

    +

    unversioned.Status

    @@ -19213,6 +19232,117 @@
    +

    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

    @@ -19220,7 +19350,7 @@
    -

    Parameters

    +

    Parameters

    @@ -19276,125 +19406,6 @@
    -
    -
    -

    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

    @@ -19415,7 +19426,7 @@

    200

    success

    -

    v1.Node

    +

    v1.Node

    @@ -19459,10 +19470,10 @@
    -

    delete a Node

    +

    replace the specified Node

    -
    DELETE /api/v1/nodes/{name}
    +
    PUT /api/v1/nodes/{name}
    @@ -19500,7 +19511,7 @@

    body

    true

    -

    v1.DeleteOptions

    +

    v1.Node

    @@ -19534,7 +19545,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.Node

    @@ -19578,10 +19589,10 @@
    -

    partially update the specified Node

    +

    delete a Node

    -
    PATCH /api/v1/nodes/{name}
    +
    DELETE /api/v1/nodes/{name}
    @@ -19619,7 +19630,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1.DeleteOptions

    @@ -19653,7 +19664,7 @@

    200

    success

    -

    v1.Node

    +

    unversioned.Status

    @@ -19664,13 +19675,7 @@
    • -

      application/json-patch+json

      -
    • -
    • -

      application/merge-patch+json

      -
    • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -19703,10 +19708,10 @@
    -

    connect GET requests to proxy of Node

    +

    partially update the specified Node

    -
    GET /api/v1/nodes/{name}/proxy
    +
    PATCH /api/v1/nodes/{name}
    @@ -19733,13 +19738,21 @@

    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

    @@ -19768,9 +19781,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.Node

    @@ -19781,7 +19794,13 @@
    • -

      /

      +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

    @@ -19791,7 +19810,13 @@
    • -

      /

      +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -19808,10 +19833,10 @@
    -

    connect PUT requests to proxy of Node

    +

    connect GET requests to proxy of Node

    -
    PUT /api/v1/nodes/{name}/proxy
    +
    GET /api/v1/nodes/{name}/proxy
    @@ -19913,10 +19938,10 @@
    -

    connect DELETE requests to proxy of Node

    +

    connect PUT requests to proxy of Node

    -
    DELETE /api/v1/nodes/{name}/proxy
    +
    PUT /api/v1/nodes/{name}/proxy
    @@ -20018,10 +20043,10 @@
    -

    connect POST requests to proxy of Node

    +

    connect DELETE requests to proxy of Node

    -
    POST /api/v1/nodes/{name}/proxy
    +
    DELETE /api/v1/nodes/{name}/proxy
    @@ -20123,10 +20148,10 @@
    -

    connect GET requests to proxy of Node

    +

    connect POST requests to proxy of Node

    -
    GET /api/v1/nodes/{name}/proxy/{path}
    +
    POST /api/v1/nodes/{name}/proxy
    @@ -20167,14 +20192,6 @@

    string

    - -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    -

    string

    - - @@ -20236,10 +20253,10 @@
    -

    connect PUT requests to proxy of Node

    +

    connect GET requests to proxy of Node

    -
    PUT /api/v1/nodes/{name}/proxy/{path}
    +
    GET /api/v1/nodes/{name}/proxy/{path}
    @@ -20349,10 +20366,10 @@
    -

    connect DELETE requests to proxy of Node

    +

    connect PUT requests to proxy of Node

    -
    DELETE /api/v1/nodes/{name}/proxy/{path}
    +
    PUT /api/v1/nodes/{name}/proxy/{path}
    @@ -20462,10 +20479,10 @@
    -

    connect POST requests to proxy of Node

    +

    connect DELETE requests to proxy of Node

    -
    POST /api/v1/nodes/{name}/proxy/{path}
    +
    DELETE /api/v1/nodes/{name}/proxy/{path}
    @@ -20575,10 +20592,10 @@
    -

    read status of the specified Node

    +

    connect POST requests to proxy of Node

    -
    GET /api/v1/nodes/{name}/status
    +
    POST /api/v1/nodes/{name}/proxy/{path}
    @@ -20605,8 +20622,8 @@

    QueryParameter

    -

    pretty

    -

    If true, then the output is pretty printed.

    +

    path

    +

    Path is the URL path to use for the current proxy request to node.

    false

    string

    @@ -20619,6 +20636,14 @@

    string

    + +

    PathParameter

    +

    path

    +

    path to the resource

    +

    true

    +

    string

    + + @@ -20640,9 +20665,9 @@ -

    200

    +

    default

    success

    -

    v1.Node

    +

    string

    @@ -20663,13 +20688,7 @@
    • -

      application/json

      -
    • -
    • -

      application/yaml

      -
    • -
    • -

      application/vnd.kubernetes.protobuf

      +

      /

    @@ -20686,10 +20705,10 @@
    -

    replace status of the specified Node

    +

    read status of the specified Node

    -
    PUT /api/v1/nodes/{name}/status
    +
    GET /api/v1/nodes/{name}/status
    @@ -20723,14 +20742,6 @@ -

    BodyParameter

    -

    body

    - -

    true

    -

    v1.Node

    - - -

    PathParameter

    name

    name of the Node

    @@ -20761,7 +20772,7 @@

    200

    success

    -

    v1.Node

    +

    v1.Node

    @@ -20805,10 +20816,10 @@
    -

    partially update status of the specified Node

    +

    replace status of the specified Node

    -
    PATCH /api/v1/nodes/{name}/status
    +
    PUT /api/v1/nodes/{name}/status
    @@ -20846,7 +20857,7 @@

    body

    true

    -

    unversioned.Patch

    +

    v1.Node

    @@ -20880,7 +20891,7 @@

    200

    success

    -

    v1.Node

    +

    v1.Node

    @@ -20891,13 +20902,7 @@
    • -

      application/json-patch+json

      -
    • -
    • -

      application/merge-patch+json

      -
    • -
    • -

      application/strategic-merge-patch+json

      +

      /

    @@ -20930,10 +20935,10 @@
    -

    list or watch objects of kind PersistentVolumeClaim

    +

    partially update status of the specified Node

    -
    GET /api/v1/persistentvolumeclaims
    +
    PATCH /api/v1/nodes/{name}/status
    @@ -20967,45 +20972,21 @@ -

    QueryParameter

    -

    labelSelector

    -

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    -

    false

    +

    BodyParameter

    +

    body

    + +

    true

    +

    unversioned.Patch

    + + + +

    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)

    - - @@ -21029,7 +21010,7 @@

    200

    success

    -

    v1.PersistentVolumeClaimList

    +

    v1.Node

    @@ -21040,7 +21021,13 @@
    • -

      /

      +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

    @@ -21073,10 +21060,10 @@
    -

    list or watch objects of kind PersistentVolume

    +

    list or watch objects of kind PersistentVolumeClaim

    -
    GET /api/v1/persistentvolumes
    +
    GET /api/v1/persistentvolumeclaims
    @@ -21172,7 +21159,7 @@

    200

    success

    -

    v1.PersistentVolumeList

    +

    v1.PersistentVolumeClaimList

    @@ -21216,10 +21203,10 @@
    -

    delete collection of PersistentVolume

    +

    list or watch objects of kind PersistentVolume

    -
    DELETE /api/v1/persistentvolumes
    +
    GET /api/v1/persistentvolumes
    @@ -21315,7 +21302,7 @@

    200

    success

    -

    unversioned.Status

    +

    v1.PersistentVolumeList

    @@ -21359,10 +21346,10 @@
    -

    create a PersistentVolume

    +

    delete collection of PersistentVolume

    -
    POST /api/v1/persistentvolumes
    +
    DELETE /api/v1/persistentvolumes
    @@ -21396,962 +21383,6 @@ -

    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

    - -------- - - - - - - - - - - - - - - - - - - - - @@ -22394,6 +21425,956 @@
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    +
    +
    +

    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

    @@ -22414,7 +22395,7 @@

    200

    success

    -

    v1.PodList

    +

    v1.PersistentVolume

    @@ -22425,7 +22406,13 @@
    • -

      /

      +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

    @@ -22458,10 +22445,10 @@
    -

    list or watch objects of kind PodTemplate

    +

    list or watch objects of kind Pod

    -
    GET /api/v1/podtemplates
    +
    GET /api/v1/pods
    @@ -22557,7 +22544,7 @@

    200

    success

    -

    v1.PodTemplateList

    +

    v1.PodList

    @@ -22601,10 +22588,10 @@
    -

    proxy GET requests to Pod

    +

    list or watch objects of kind PodTemplate

    -
    GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
    +
    GET /api/v1/podtemplates
    @@ -22630,21 +22617,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 Pod

    -

    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)

    + + @@ -22666,9 +22685,9 @@ -

    default

    +

    200

    success

    -

    string

    +

    v1.PodTemplateList

    @@ -22689,7 +22708,13 @@
    • -

      /

      +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

    @@ -22706,10 +22731,10 @@
    -

    proxy PUT requests to Pod

    +

    proxy GET requests to Pod

    -
    PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
    +
    GET /api/v1/proxy/namespaces/{namespace}/pods/{name}
    @@ -22811,10 +22836,10 @@
    -

    proxy DELETE requests to Pod

    +

    proxy PUT requests to Pod

    -
    DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
    +
    PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}
    @@ -22916,10 +22941,10 @@
    -

    proxy POST requests to Pod

    +

    proxy DELETE requests to Pod

    -
    POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
    +
    DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}
    @@ -23021,10 +23046,10 @@
    -

    proxy GET requests to Pod

    +

    proxy POST requests to Pod

    -
    GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    +
    POST /api/v1/proxy/namespaces/{namespace}/pods/{name}
    @@ -23065,14 +23090,6 @@

    string

    - -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    -

    string

    - - @@ -23134,10 +23151,10 @@
    -

    proxy PUT requests to Pod

    +

    proxy GET requests to Pod

    -
    PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    +
    GET /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    @@ -23247,10 +23264,10 @@
    -

    proxy DELETE requests to Pod

    +

    proxy PUT requests to Pod

    -
    DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    +
    PUT /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    @@ -23360,10 +23377,10 @@
    -

    proxy POST requests to Pod

    +

    proxy DELETE requests to Pod

    -
    POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    +
    DELETE /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    @@ -23473,10 +23490,10 @@
    -

    proxy GET requests to Service

    +

    proxy POST requests to Pod

    -
    GET /api/v1/proxy/namespaces/{namespace}/services/{name}
    +
    POST /api/v1/proxy/namespaces/{namespace}/pods/{name}/{path}
    @@ -23512,7 +23529,15 @@

    PathParameter

    name

    -

    name of the Service

    +

    name of the Pod

    +

    true

    +

    string

    + + + +

    PathParameter

    +

    path

    +

    path to the resource

    true

    string

    @@ -23578,10 +23603,10 @@
    -

    proxy PUT requests to Service

    +

    proxy GET requests to Service

    -
    PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
    +
    GET /api/v1/proxy/namespaces/{namespace}/services/{name}
    @@ -23683,10 +23708,10 @@
    -

    proxy DELETE requests to Service

    +

    proxy PUT requests to Service

    -
    DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
    +
    PUT /api/v1/proxy/namespaces/{namespace}/services/{name}
    @@ -23788,10 +23813,10 @@
    -

    proxy POST requests to Service

    +

    proxy DELETE requests to Service

    -
    POST /api/v1/proxy/namespaces/{namespace}/services/{name}
    +
    DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}
    @@ -23893,10 +23918,10 @@
    -

    proxy GET requests to Service

    +

    proxy POST requests to Service

    -
    GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    +
    POST /api/v1/proxy/namespaces/{namespace}/services/{name}
    @@ -23937,14 +23962,6 @@

    string

    - -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    -

    string

    - - @@ -24006,10 +24023,10 @@
    -

    proxy PUT requests to Service

    +

    proxy GET requests to Service

    -
    PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    +
    GET /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    @@ -24119,10 +24136,10 @@
    -

    proxy DELETE requests to Service

    +

    proxy PUT requests to Service

    -
    DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    +
    PUT /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    @@ -24232,10 +24249,10 @@
    -

    proxy POST requests to Service

    +

    proxy DELETE requests to Service

    -
    POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    +
    DELETE /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    @@ -24345,10 +24362,10 @@
    -

    proxy GET requests to Node

    +

    proxy POST requests to Service

    -
    GET /api/v1/proxy/nodes/{name}
    +
    POST /api/v1/proxy/namespaces/{namespace}/services/{name}/{path}
    @@ -24375,8 +24392,24 @@

    PathParameter

    +

    namespace

    +

    object name and auth scope, such as for teams and projects

    +

    true

    +

    string

    + + + +

    PathParameter

    name

    -

    name of the Node

    +

    name of the Service

    +

    true

    +

    string

    + + + +

    PathParameter

    +

    path

    +

    path to the resource

    true

    string

    @@ -24442,10 +24475,10 @@
    -

    proxy PUT requests to Node

    +

    proxy GET requests to Node

    -
    PUT /api/v1/proxy/nodes/{name}
    +
    GET /api/v1/proxy/nodes/{name}
    @@ -24539,10 +24572,10 @@
    -

    proxy DELETE requests to Node

    +

    proxy PUT requests to Node

    -
    DELETE /api/v1/proxy/nodes/{name}
    +
    PUT /api/v1/proxy/nodes/{name}
    @@ -24636,10 +24669,10 @@
    -

    proxy POST requests to Node

    +

    proxy DELETE requests to Node

    -
    POST /api/v1/proxy/nodes/{name}
    +
    DELETE /api/v1/proxy/nodes/{name}
    @@ -24733,10 +24766,10 @@
    -

    proxy GET requests to Node

    +

    proxy POST requests to Node

    -
    GET /api/v1/proxy/nodes/{name}/{path}
    +
    POST /api/v1/proxy/nodes/{name}
    @@ -24769,14 +24802,6 @@

    string

    - -

    PathParameter

    -

    path

    -

    path to the resource

    -

    true

    -

    string

    - - @@ -24838,10 +24863,10 @@
    -

    proxy PUT requests to Node

    +

    proxy GET requests to Node

    -
    PUT /api/v1/proxy/nodes/{name}/{path}
    +
    GET /api/v1/proxy/nodes/{name}/{path}
    @@ -24943,10 +24968,10 @@
    -

    proxy DELETE requests to Node

    +

    proxy PUT requests to Node

    -
    DELETE /api/v1/proxy/nodes/{name}/{path}
    +
    PUT /api/v1/proxy/nodes/{name}/{path}
    @@ -25048,10 +25073,10 @@
    -

    proxy POST requests to Node

    +

    proxy DELETE requests to Node

    -
    POST /api/v1/proxy/nodes/{name}/{path}
    +
    DELETE /api/v1/proxy/nodes/{name}/{path}
    @@ -25153,10 +25178,10 @@
    -

    list or watch objects of kind ReplicationController

    +

    proxy POST requests to Node

    -
    GET /api/v1/replicationcontrollers
    +
    POST /api/v1/proxy/nodes/{name}/{path}
    @@ -25182,53 +25207,21 @@ -

    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

    +

    PathParameter

    +

    path

    +

    path to the resource

    +

    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)

    - - @@ -25250,9 +25243,9 @@ -

    200

    +

    default

    success

    -

    v1.ReplicationControllerList

    +

    string

    @@ -25273,13 +25266,7 @@
    • -

      application/json

      -
    • -
    • -

      application/yaml

      -
    • -
    • -

      application/vnd.kubernetes.protobuf

      +

      /

    @@ -25296,10 +25283,10 @@
    -

    list or watch objects of kind ResourceQuota

    +

    list or watch objects of kind ReplicationController

    -
    GET /api/v1/resourcequotas
    +
    GET /api/v1/replicationcontrollers
    @@ -25395,7 +25382,7 @@

    200

    success

    -

    v1.ResourceQuotaList

    +

    v1.ReplicationControllerList

    @@ -25439,10 +25426,10 @@
    -

    list or watch objects of kind Secret

    +

    list or watch objects of kind ResourceQuota

    -
    GET /api/v1/secrets
    +
    GET /api/v1/resourcequotas
    @@ -25538,7 +25525,7 @@

    200

    success

    -

    v1.SecretList

    +

    v1.ResourceQuotaList

    @@ -25582,10 +25569,10 @@
    -

    list or watch objects of kind ServiceAccount

    +

    list or watch objects of kind Secret

    -
    GET /api/v1/serviceaccounts
    +
    GET /api/v1/secrets
    @@ -25681,7 +25668,7 @@

    200

    success

    -

    v1.ServiceAccountList

    +

    v1.SecretList

    @@ -25725,10 +25712,10 @@
    -

    list or watch objects of kind Service

    +

    list or watch objects of kind ServiceAccount

    -
    GET /api/v1/services
    +
    GET /api/v1/serviceaccounts
    @@ -25824,7 +25811,7 @@

    200

    success

    -

    v1.ServiceList

    +

    v1.ServiceAccountList

    @@ -25868,10 +25855,10 @@
    -

    watch individual changes to a list of ConfigMap

    +

    list or watch objects of kind Service

    -
    GET /api/v1/watch/configmaps
    +
    GET /api/v1/services
    @@ -25967,7 +25954,7 @@

    200

    success

    -

    *versioned.Event

    +

    v1.ServiceList

    @@ -25991,14 +25978,11 @@

    application/json

  • -

    application/json;stream=watch

    +

    application/yaml

  • application/vnd.kubernetes.protobuf

  • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
  • @@ -26014,10 +25998,10 @@
    -

    watch individual changes to a list of Endpoints

    +

    watch individual changes to a list of ConfigMap

    -
    GET /api/v1/watch/endpoints
    +
    GET /api/v1/watch/configmaps
    @@ -26113,7 +26097,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -26160,10 +26144,10 @@
    -

    watch individual changes to a list of Event

    +

    watch individual changes to a list of Endpoints

    -
    GET /api/v1/watch/events
    +
    GET /api/v1/watch/endpoints
    @@ -26259,7 +26243,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -26306,10 +26290,10 @@
    -

    watch individual changes to a list of LimitRange

    +

    watch individual changes to a list of Event

    -
    GET /api/v1/watch/limitranges
    +
    GET /api/v1/watch/events
    @@ -26405,7 +26389,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -26452,10 +26436,10 @@
    -

    watch individual changes to a list of Namespace

    +

    watch individual changes to a list of LimitRange

    -
    GET /api/v1/watch/namespaces
    +
    GET /api/v1/watch/limitranges
    @@ -26551,7 +26535,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -26598,6 +26582,152 @@
    +

    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

    @@ -26605,7 +26735,7 @@
    -

    Parameters

    +

    Parameters

    @@ -26687,7 +26817,7 @@
    -

    Responses

    +

    Responses

    @@ -26705,14 +26835,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -26722,7 +26852,7 @@
    -

    Produces

    +

    Produces

    • @@ -26741,7 +26871,7 @@
    -

    Tags

    +

    Tags

    • @@ -26759,7 +26889,7 @@
    -

    Parameters

    +

    Parameters

    @@ -26849,7 +26979,7 @@
    -

    Responses

    +

    Responses

    @@ -26867,14 +26997,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -26884,7 +27014,7 @@
    -

    Produces

    +

    Produces

    • @@ -26903,7 +27033,7 @@
    -

    Tags

    +

    Tags

    • @@ -26921,7 +27051,7 @@
    -

    Parameters

    +

    Parameters

    @@ -27003,7 +27133,7 @@
    -

    Responses

    +

    Responses

    @@ -27021,14 +27151,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -27038,7 +27168,7 @@
    -

    Produces

    +

    Produces

    • @@ -27057,7 +27187,7 @@
    -

    Tags

    +

    Tags

    • @@ -27075,7 +27205,7 @@
    -

    Parameters

    +

    Parameters

    @@ -27165,7 +27295,7 @@
    -

    Responses

    +

    Responses

    @@ -27183,14 +27313,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -27200,7 +27330,7 @@
    -

    Produces

    +

    Produces

    • @@ -27219,7 +27349,7 @@
    -

    Tags

    +

    Tags

    • @@ -27237,7 +27367,7 @@
    -

    Parameters

    +

    Parameters

    @@ -27319,7 +27449,7 @@
    -

    Responses

    +

    Responses

    @@ -27337,14 +27467,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -27354,7 +27484,7 @@
    -

    Produces

    +

    Produces

    • @@ -27373,7 +27503,7 @@
    -

    Tags

    +

    Tags

    • @@ -27391,7 +27521,7 @@
    -

    Parameters

    +

    Parameters

    @@ -27481,7 +27611,7 @@
    -

    Responses

    +

    Responses

    @@ -27499,14 +27629,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -27516,7 +27646,7 @@
    -

    Produces

    +

    Produces

    • @@ -27535,7 +27665,7 @@
    -

    Tags

    +

    Tags

    • @@ -27553,7 +27683,7 @@
    -

    Parameters

    +

    Parameters

    @@ -27635,7 +27765,7 @@
    -

    Responses

    +

    Responses

    @@ -27653,14 +27783,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -27670,7 +27800,7 @@
    -

    Produces

    +

    Produces

    • @@ -27689,7 +27819,7 @@
    -

    Tags

    +

    Tags

    • @@ -27707,7 +27837,7 @@
    -

    Parameters

    +

    Parameters

    @@ -27797,7 +27927,7 @@
    -

    Responses

    +

    Responses

    @@ -27815,14 +27945,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -27832,7 +27962,7 @@
    -

    Produces

    +

    Produces

    • @@ -27851,7 +27981,7 @@
    -

    Tags

    +

    Tags

    • @@ -27869,7 +27999,7 @@
    -

    Parameters

    +

    Parameters

    @@ -27951,7 +28081,7 @@
    -

    Responses

    +

    Responses

    @@ -27969,14 +28099,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -27986,7 +28116,7 @@
    -

    Produces

    +

    Produces

    • @@ -28005,7 +28135,7 @@
    -

    Tags

    +

    Tags

    • @@ -28023,7 +28153,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28113,7 +28243,7 @@
    -

    Responses

    +

    Responses

    @@ -28131,14 +28261,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -28148,7 +28278,7 @@
    -

    Produces

    +

    Produces

    • @@ -28167,7 +28297,7 @@
    -

    Tags

    +

    Tags

    • @@ -28185,7 +28315,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28267,7 +28397,7 @@
    -

    Responses

    +

    Responses

    @@ -28285,14 +28415,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -28302,7 +28432,7 @@
    -

    Produces

    +

    Produces

    • @@ -28321,7 +28451,7 @@
    -

    Tags

    +

    Tags

    • @@ -28339,7 +28469,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28429,7 +28559,7 @@
    -

    Responses

    +

    Responses

    @@ -28447,14 +28577,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -28464,7 +28594,7 @@
    -

    Produces

    +

    Produces

    • @@ -28483,7 +28613,7 @@
    -

    Tags

    +

    Tags

    • @@ -28501,7 +28631,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28583,7 +28713,7 @@
    -

    Responses

    +

    Responses

    @@ -28601,14 +28731,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -28618,7 +28748,7 @@
    -

    Produces

    +

    Produces

    • @@ -28637,7 +28767,7 @@
    -

    Tags

    +

    Tags

    • @@ -28655,7 +28785,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28745,7 +28875,7 @@
    -

    Responses

    +

    Responses

    @@ -28763,14 +28893,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -28780,7 +28910,7 @@
    -

    Produces

    +

    Produces

    • @@ -28799,7 +28929,7 @@
    -

    Tags

    +

    Tags

    • @@ -28817,7 +28947,7 @@
    -

    Parameters

    +

    Parameters

    @@ -28899,7 +29029,7 @@
    -

    Responses

    +

    Responses

    @@ -28917,14 +29047,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -28934,7 +29064,7 @@
    -

    Produces

    +

    Produces

    • @@ -28953,7 +29083,7 @@
    -

    Tags

    +

    Tags

    • @@ -28971,7 +29101,7 @@
    -

    Parameters

    +

    Parameters

    @@ -29061,7 +29191,7 @@
    -

    Responses

    +

    Responses

    @@ -29079,14 +29209,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -29096,7 +29226,7 @@
    -

    Produces

    +

    Produces

    • @@ -29115,7 +29245,7 @@
    -

    Tags

    +

    Tags

    • @@ -29133,7 +29263,7 @@
    -

    Parameters

    +

    Parameters

    @@ -29215,7 +29345,7 @@
    -

    Responses

    +

    Responses

    @@ -29233,14 +29363,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -29250,7 +29380,7 @@
    -

    Produces

    +

    Produces

    • @@ -29269,7 +29399,7 @@
    -

    Tags

    +

    Tags

    • @@ -29287,7 +29417,7 @@
    -

    Parameters

    +

    Parameters

    @@ -29377,7 +29507,7 @@
    -

    Responses

    +

    Responses

    @@ -29395,14 +29525,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -29412,7 +29542,7 @@
    -

    Produces

    +

    Produces

    • @@ -29431,7 +29561,7 @@
    -

    Tags

    +

    Tags

    • @@ -29449,7 +29579,7 @@
    -

    Parameters

    +

    Parameters

    @@ -29531,7 +29661,7 @@
    -

    Responses

    +

    Responses

    @@ -29549,14 +29679,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -29566,7 +29696,7 @@
    -

    Produces

    +

    Produces

    • @@ -29585,7 +29715,7 @@
    -

    Tags

    +

    Tags

    • @@ -29603,7 +29733,7 @@
    -

    Parameters

    +

    Parameters

    @@ -29693,7 +29823,7 @@
    -

    Responses

    +

    Responses

    @@ -29711,14 +29841,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -29728,7 +29858,7 @@
    -

    Produces

    +

    Produces

    • @@ -29747,7 +29877,7 @@
    -

    Tags

    +

    Tags

    • @@ -29765,7 +29895,7 @@
    -

    Parameters

    +

    Parameters

    @@ -29847,7 +29977,7 @@
    -

    Responses

    +

    Responses

    @@ -29865,14 +29995,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -29882,7 +30012,7 @@
    -

    Produces

    +

    Produces

    • @@ -29901,7 +30031,7 @@
    -

    Tags

    +

    Tags

    • @@ -29919,7 +30049,7 @@
    -

    Parameters

    +

    Parameters

    @@ -30009,7 +30139,7 @@
    -

    Responses

    +

    Responses

    @@ -30027,14 +30157,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -30044,7 +30174,7 @@
    -

    Produces

    +

    Produces

    • @@ -30063,7 +30193,7 @@
    -

    Tags

    +

    Tags

    • @@ -30081,7 +30211,7 @@
    -

    Parameters

    +

    Parameters

    @@ -30163,7 +30293,7 @@
    -

    Responses

    +

    Responses

    @@ -30181,14 +30311,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -30198,7 +30328,7 @@
    -

    Produces

    +

    Produces

    • @@ -30217,7 +30347,7 @@
    -

    Tags

    +

    Tags

    • @@ -30235,7 +30365,7 @@
    -

    Parameters

    +

    Parameters

    @@ -30325,7 +30455,7 @@
    -

    Responses

    +

    Responses

    @@ -30343,14 +30473,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -30360,7 +30490,7 @@
    -

    Produces

    +

    Produces

    • @@ -30379,7 +30509,7 @@
    -

    Tags

    +

    Tags

    • @@ -30397,7 +30527,7 @@
    -

    Parameters

    +

    Parameters

    @@ -30479,7 +30609,7 @@
    -

    Responses

    +

    Responses

    @@ -30497,14 +30627,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -30514,7 +30644,7 @@
    -

    Produces

    +

    Produces

    • @@ -30533,7 +30663,7 @@
    -

    Tags

    +

    Tags

    • @@ -30551,7 +30681,7 @@
    -

    Parameters

    +

    Parameters

    @@ -30625,7 +30755,7 @@
    -

    Responses

    +

    Responses

    @@ -30643,14 +30773,14 @@ - +

    200

    success

    *versioned.Event

    *versioned.Event

    -

    Consumes

    +

    Consumes

    • @@ -30660,7 +30790,7 @@
    -

    Produces

    +

    Produces

    • @@ -30679,7 +30809,7 @@
    -

    Tags

    +

    Tags

    • @@ -30697,7 +30827,7 @@
    -

    Parameters

    +

    Parameters

    @@ -30777,152 +30907,6 @@
    -
    -
    -

    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

    @@ -30943,7 +30927,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -30990,10 +30974,10 @@
    -

    watch individual changes to a list of PersistentVolume

    +

    watch individual changes to a list of PersistentVolumeClaim

    -
    GET /api/v1/watch/persistentvolumes
    +
    GET /api/v1/watch/persistentvolumeclaims
    @@ -31089,7 +31073,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -31136,6 +31120,152 @@
    +

    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

    @@ -31143,7 +31273,7 @@
    -

    Parameters

    +

    Parameters

    @@ -31223,152 +31353,6 @@
    -
    -
    -

    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

    @@ -31389,7 +31373,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -31436,10 +31420,10 @@
    -

    watch individual changes to a list of PodTemplate

    +

    watch individual changes to a list of Pod

    -
    GET /api/v1/watch/podtemplates
    +
    GET /api/v1/watch/pods
    @@ -31535,7 +31519,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -31582,10 +31566,10 @@
    -

    watch individual changes to a list of ReplicationController

    +

    watch individual changes to a list of PodTemplate

    -
    GET /api/v1/watch/replicationcontrollers
    +
    GET /api/v1/watch/podtemplates
    @@ -31681,7 +31665,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -31728,10 +31712,10 @@
    -

    watch individual changes to a list of ResourceQuota

    +

    watch individual changes to a list of ReplicationController

    -
    GET /api/v1/watch/resourcequotas
    +
    GET /api/v1/watch/replicationcontrollers
    @@ -31827,7 +31811,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -31874,10 +31858,10 @@
    -

    watch individual changes to a list of Secret

    +

    watch individual changes to a list of ResourceQuota

    -
    GET /api/v1/watch/secrets
    +
    GET /api/v1/watch/resourcequotas
    @@ -31973,7 +31957,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -32020,10 +32004,10 @@
    -

    watch individual changes to a list of ServiceAccount

    +

    watch individual changes to a list of Secret

    -
    GET /api/v1/watch/serviceaccounts
    +
    GET /api/v1/watch/secrets
    @@ -32119,7 +32103,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -32166,10 +32150,10 @@
    -

    watch individual changes to a list of Service

    +

    watch individual changes to a list of ServiceAccount

    -
    GET /api/v1/watch/services
    +
    GET /api/v1/watch/serviceaccounts
    @@ -32265,7 +32249,7 @@

    200

    success

    -

    *versioned.Event

    +

    *versioned.Event

    @@ -32311,12 +32295,158 @@
    +
    +

    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

      +
    • +
    +
    +
    +
    diff --git a/docs/api-reference/v1/operations.md b/docs/api-reference/v1/operations.md index ec775b411b..f76001cc73 100644 --- a/docs/api-reference/v1/operations.md +++ b/docs/api-reference/v1/operations.md @@ -1,7 +1,7 @@ --- --- -{% include v1.3/v1-operations.html %} +{% include v1.4/v1-operations.html %} diff --git a/docs/getting-started-guides/fluentd-gcp.yaml b/docs/getting-started-guides/fluentd-gcp.yaml index 15226d5d6b..35b0ed23dc 100644 --- a/docs/getting-started-guides/fluentd-gcp.yaml +++ b/docs/getting-started-guides/fluentd-gcp.yaml @@ -11,7 +11,7 @@ spec: dnsPolicy: Default containers: - name: fluentd-cloud-logging - image: gcr.io/google_containers/fluentd-gcp:1.21 + image: gcr.io/google_containers/fluentd-gcp:1.25 resources: limits: memory: 200Mi diff --git a/docs/user-guide/kubectl/kubectl.md b/docs/user-guide/kubectl/kubectl.md index bc9ba1a76f..e5dc7f0afb 100644 --- a/docs/user-guide/kubectl/kubectl.md +++ b/docs/user-guide/kubectl/kubectl.md @@ -19,69 +19,70 @@ kubectl ### Options ``` - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [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. +* [kubectl annotate](kubectl_annotate.md) - Update the annotations on a resource +* [kubectl api-versions](kubectl_api-versions.md) - Print the supported API versions on the server, in the form of "group/version" +* [kubectl apply](kubectl_apply.md) - Apply a configuration to a resource by filename or stdin +* [kubectl attach](kubectl_attach.md) - Attach to a running container +* [kubectl autoscale](kubectl_autoscale.md) - Auto-scale a Deployment, ReplicaSet, or ReplicationController +* [kubectl cluster-info](kubectl_cluster-info.md) - Display cluster info +* [kubectl completion](kubectl_completion.md) - Output shell completion code for the given shell (bash or zsh) +* [kubectl config](kubectl_config.md) - Modify kubeconfig files +* [kubectl convert](kubectl_convert.md) - Convert config files between different API versions +* [kubectl cordon](kubectl_cordon.md) - Mark node as unschedulable +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin +* [kubectl delete](kubectl_delete.md) - Delete resources by filenames, stdin, resources and names, or by resources and label selector +* [kubectl describe](kubectl_describe.md) - Show details of a specific resource or group of resources +* [kubectl drain](kubectl_drain.md) - Drain node in preparation for maintenance +* [kubectl edit](kubectl_edit.md) - Edit a resource on the server +* [kubectl exec](kubectl_exec.md) - Execute a command in a container +* [kubectl explain](kubectl_explain.md) - Documentation of resources +* [kubectl expose](kubectl_expose.md) - Take a replication controller, service, deployment or pod and expose it as a new Kubernetes Service +* [kubectl get](kubectl_get.md) - Display one or many resources +* [kubectl label](kubectl_label.md) - Update the labels on a resource +* [kubectl logs](kubectl_logs.md) - Print the logs for a container in a pod +* [kubectl namespace](kubectl_namespace.md) - Deprecated: config set-context +* [kubectl options](kubectl_options.md) - +* [kubectl patch](kubectl_patch.md) - Update field(s) of a resource using strategic merge patch +* [kubectl port-forward](kubectl_port-forward.md) - Forward one or more local ports to a pod +* [kubectl proxy](kubectl_proxy.md) - Run a proxy to the Kubernetes API server +* [kubectl replace](kubectl_replace.md) - Replace a resource by filename or stdin +* [kubectl rolling-update](kubectl_rolling-update.md) - Perform a rolling update of the given ReplicationController +* [kubectl rollout](kubectl_rollout.md) - Manage a deployment rollout +* [kubectl run](kubectl_run.md) - Run a particular image on the cluster +* [kubectl scale](kubectl_scale.md) - Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job +* [kubectl set](kubectl_set.md) - Set specific features on objects +* [kubectl taint](kubectl_taint.md) - Update the taints on one or more nodes +* [kubectl top](kubectl_top.md) - Display Resource (CPU/Memory/Storage) usage +* [kubectl uncordon](kubectl_uncordon.md) - Mark node as schedulable +* [kubectl version](kubectl_version.md) - Print the client and server version information -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_annotate.md b/docs/user-guide/kubectl/kubectl_annotate.md index 2147a0c495..2111379a6f 100644 --- a/docs/user-guide/kubectl/kubectl_annotate.md +++ b/docs/user-guide/kubectl/kubectl_annotate.md @@ -8,6 +8,7 @@ Update the annotations on a resource ### Synopsis + Update the annotations on one or more resources. An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human-readable, data. @@ -21,7 +22,6 @@ Possible resources include (case insensitive): 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] ``` @@ -29,6 +29,7 @@ kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=V ### Examples ``` + # Update pod 'foo' with the annotation 'description' and the value 'my frontend'. # If the same annotation is set multiple times, only the last value will be applied kubectl annotate pods foo description='my frontend' @@ -53,56 +54,55 @@ kubectl annotate pods foo description- ### 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 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.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.) - --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]. + --all select all resources in the namespace of the specified resource types + -f, --filename value Filename, directory, or URL to a file identifying the resource to update the annotation (default []) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --overwrite If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations. + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --resource-version string 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 string Selector (label query) to filter on + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_api-versions.md b/docs/user-guide/kubectl/kubectl_api-versions.md index 0c64fbffa1..c5c9e1fe59 100644 --- a/docs/user-guide/kubectl/kubectl_api-versions.md +++ b/docs/user-guide/kubectl/kubectl_api-versions.md @@ -3,12 +3,12 @@ ## kubectl api-versions -Print the supported API versions on the server, in the form of "group/version". +Print the supported API versions on the server, in the form of "group/version" ### Synopsis -Print the supported API versions on the server, in the form of "group/version". +Print the supported API versions on the server, in the form of "group/version" ``` kubectl api-versions @@ -17,36 +17,35 @@ kubectl api-versions ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_apply.md b/docs/user-guide/kubectl/kubectl_apply.md index 807a159297..899383c0d5 100644 --- a/docs/user-guide/kubectl/kubectl_apply.md +++ b/docs/user-guide/kubectl/kubectl_apply.md @@ -8,8 +8,9 @@ Apply a configuration to a resource by filename or stdin ### Synopsis + Apply a configuration to a resource by filename or stdin. -The resource will be created if it doesn't exist yet. +This resource will be created if it doesn't exist yet. To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'. JSON and YAML formats are accepted. @@ -21,6 +22,7 @@ kubectl apply -f FILENAME ### Examples ``` + # Apply the configuration in pod.json to a pod. kubectl apply -f ./pod.json @@ -31,48 +33,48 @@ cat pod.json | kubectl apply -f - ### Options ``` - -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 + -f, --filename value Filename, directory, or URL to file that contains the configuration to apply (default []) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + -o, --output string Output mode. Use "-o name" for shorter output (resource/name). + --overwrite Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration (default true) + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + --validate If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_attach.md b/docs/user-guide/kubectl/kubectl_attach.md index 459738508d..860f7ece8d 100644 --- a/docs/user-guide/kubectl/kubectl_attach.md +++ b/docs/user-guide/kubectl/kubectl_attach.md @@ -3,7 +3,7 @@ ## kubectl attach -Attach to a running container. +Attach to a running container ### Synopsis @@ -17,6 +17,7 @@ kubectl attach POD -c CONTAINER ### Examples ``` + # Get output from running pod 123456-7890, using the first container by default kubectl attach 123456-7890 @@ -31,44 +32,43 @@ kubectl attach 123456-7890 -c ruby-container -i -t ### Options ``` - -c, --container="": Container name. If omitted, the first container in the pod will be chosen - -i, --stdin[=false]: Pass stdin to the container - -t, --tty[=false]: Stdin is a TTY + -c, --container string Container name. If omitted, the first container in the pod will be chosen + -i, --stdin Pass stdin to the container + -t, --tty Stdin is a TTY ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_autoscale.md b/docs/user-guide/kubectl/kubectl_autoscale.md index 9e9982df2f..aa3b434d47 100644 --- a/docs/user-guide/kubectl/kubectl_autoscale.md +++ b/docs/user-guide/kubectl/kubectl_autoscale.md @@ -8,6 +8,7 @@ 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, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. @@ -20,69 +21,69 @@ 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, no target CPU utilization specfied so a default autoscaling policy will be used: + +# Auto scale a deployment "foo", with the number of pods between 2 and 10, target CPU utilization specified 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%: +# Auto scale a replication controller "foo", with the number of pods between 1 and 5, target CPU utilization at 80%: kubectl autoscale rc foo --max=5 --cpu-percent=80 ``` ### 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, 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/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.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) - --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]. + --cpu-percent int 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. (default -1) + --dry-run If true, only print the object that would be sent, without sending it. + -f, --filename value Filename, directory, or URL to a file identifying the resource to autoscale. (default []) + --generator string The name of the API generator to use. Currently there is only 1 generator. (default "horizontalpodautoscaler/v1") + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --max int The upper limit for the number of pods that can be set by the autoscaler. Required. (default -1) + --min int 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. (default -1) + --name string The name for the newly created object. If not specified, the name of the input resource will be used. + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --save-config 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 When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_cluster-info.md b/docs/user-guide/kubectl/kubectl_cluster-info.md index 1e59abc4a7..2789f751d4 100644 --- a/docs/user-guide/kubectl/kubectl_cluster-info.md +++ b/docs/user-guide/kubectl/kubectl_cluster-info.md @@ -18,43 +18,42 @@ kubectl cluster-info ### Options ``` - --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true] + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO * [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. +* [kubectl cluster-info dump](kubectl_cluster-info_dump.md) - Dump lots of relevant info for debugging and diagnosis -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_cluster-info_dump.md b/docs/user-guide/kubectl/kubectl_cluster-info_dump.md index c4fd5c4488..0116d85bab 100644 --- a/docs/user-guide/kubectl/kubectl_cluster-info_dump.md +++ b/docs/user-guide/kubectl/kubectl_cluster-info_dump.md @@ -3,7 +3,7 @@ ## kubectl cluster-info dump -Dump lots of relevant info for debugging and diagnosis. +Dump lots of relevant info for debugging and diagnosis ### Synopsis @@ -27,13 +27,13 @@ kubectl cluster-info dump ``` # Dump current cluster state to stdout kubectl cluster-info dump - + # Dump current cluster state to /path/to/cluster-state kubectl cluster-info dump --output-directory=/path/to/cluster-state - + # Dump all namespaces to stdout kubectl cluster-info dump --all-namespaces - + # Dump a set of namespaces to /path/to/cluster-state kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state ``` @@ -41,44 +41,43 @@ kubectl cluster-info dump --namespaces default,kube-system --output-directory=/p ### 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 + --all-namespaces If true, dump all namespaces. If true, --namespaces is ignored. + --namespaces value A comma separated list of namespaces to dump. (default []) + --output-directory string 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_completion.md b/docs/user-guide/kubectl/kubectl_completion.md index 4bd17f0930..b73b02f368 100644 --- a/docs/user-guide/kubectl/kubectl_completion.md +++ b/docs/user-guide/kubectl/kubectl_completion.md @@ -24,52 +24,53 @@ kubectl completion SHELL $ 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: +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, e.g. 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: +If you use zsh*, the following will load kubectl zsh completion: $ source <(kubectl completion zsh) +* zsh completions are only supported in versions of zsh >= 5.2 ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_config.md b/docs/user-guide/kubectl/kubectl_config.md index 5aed2a043c..542820f12d 100644 --- a/docs/user-guide/kubectl/kubectl_config.md +++ b/docs/user-guide/kubectl/kubectl_config.md @@ -3,16 +3,16 @@ ## kubectl config -config modifies kubeconfig files +Modify kubeconfig files ### Synopsis -config modifies kubeconfig files using subcommands like "kubectl config set current-context my-context" +Modify kubeconfig files using subcommands like "kubectl config set current-context my-context" The loading order follows these rules: 1. If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place. -2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system). These paths are merged together. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list. +2. If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system). These paths are merged. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list. 3. Otherwise, ${HOME}/.kube/config is used and no merging takes place. @@ -23,49 +23,52 @@ kubectl config SUBCOMMAND ### Options ``` - --kubeconfig="": use a particular kubeconfig file + --kubeconfig string use a particular kubeconfig file ``` ### 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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager * [kubectl config current-context](kubectl_config_current-context.md) - Displays the current-context +* [kubectl config delete-cluster](kubectl_config_delete-cluster.md) - Delete the specified cluster from the kubeconfig +* [kubectl config delete-context](kubectl_config_delete-context.md) - Delete the specified context from the kubeconfig +* [kubectl config get-clusters](kubectl_config_get-clusters.md) - Display clusters defined in the kubeconfig +* [kubectl config get-contexts](kubectl_config_get-contexts.md) - Describe one or many contexts * [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. +* [kubectl config view](kubectl_config_view.md) - Display merged kubeconfig settings or a specified kubeconfig file -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_current-context.md b/docs/user-guide/kubectl/kubectl_config_current-context.md index e256fd1e7d..0ef7c0023d 100644 --- a/docs/user-guide/kubectl/kubectl_config_current-context.md +++ b/docs/user-guide/kubectl/kubectl_config_current-context.md @@ -8,6 +8,7 @@ Displays the current-context ### Synopsis + Displays the current-context ``` @@ -17,6 +18,7 @@ kubectl config current-context ### Examples ``` + # Display the current-context kubectl config current-context ``` @@ -24,36 +26,35 @@ kubectl config current-context ### 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="": use a particular kubeconfig file - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - Modify kubeconfig files -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_delete-cluster.md b/docs/user-guide/kubectl/kubectl_config_delete-cluster.md new file mode 100644 index 0000000000..0ac6b97716 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_config_delete-cluster.md @@ -0,0 +1,56 @@ +--- +--- + +## kubectl config delete-cluster + +Delete the specified cluster from the kubeconfig + +### Synopsis + + +Delete the specified cluster from the kubeconfig + +``` +kubectl config delete-cluster NAME +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - Modify kubeconfig files + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_delete-cluster.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config_delete-context.md b/docs/user-guide/kubectl/kubectl_config_delete-context.md new file mode 100644 index 0000000000..1249ff0ba3 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_config_delete-context.md @@ -0,0 +1,56 @@ +--- +--- + +## kubectl config delete-context + +Delete the specified context from the kubeconfig + +### Synopsis + + +Delete the specified context from the kubeconfig + +``` +kubectl config delete-context NAME +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - Modify kubeconfig files + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_delete-context.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config_get-clusters.md b/docs/user-guide/kubectl/kubectl_config_get-clusters.md new file mode 100644 index 0000000000..e9e963bbd2 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_config_get-clusters.md @@ -0,0 +1,56 @@ +--- +--- + +## kubectl config get-clusters + +Display clusters defined in the kubeconfig + +### Synopsis + + +Display clusters defined in the kubeconfig + +``` +kubectl config get-clusters +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - Modify kubeconfig files + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_get-clusters.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_config_get-contexts.md b/docs/user-guide/kubectl/kubectl_config_get-contexts.md new file mode 100644 index 0000000000..ade72ec623 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_config_get-contexts.md @@ -0,0 +1,73 @@ +--- +--- + +## kubectl config get-contexts + +Describe one or many contexts + +### Synopsis + + +Displays one or many contexts from the kubeconfig file. + +``` +kubectl config get-contexts [(-o|--output=)name)] +``` + +### Examples + +``` +# List all the contexts in your kubeconfig file +kubectl config get-contexts + +# Describe one context in your kubeconfig file. +kubectl config get-contexts my-context +``` + +### Options + +``` + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl config](kubectl_config.md) - Modify kubeconfig files + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_config_get-contexts.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 6751cb7fa8..e880ea0db6 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-cluster.md +++ b/docs/user-guide/kubectl/kubectl_config_set-cluster.md @@ -8,16 +8,18 @@ Sets a cluster entry in kubeconfig ### Synopsis + Sets a cluster entry in kubeconfig. Specifying a name that already exists will merge new fields on top of existing values for those fields. ``` -kubectl config set-cluster NAME [--server=server] [--certificate-authority=path/to/certficate/authority] [--insecure-skip-tls-verify=true] +kubectl config set-cluster NAME [--server=server] [--certificate-authority=path/to/certificate/authority] [--insecure-skip-tls-verify=true] ``` ### Examples ``` + # Set only the server field on the e2e cluster entry without touching other values. kubectl config set-cluster e2e --server=https://1.2.3.4 @@ -31,43 +33,42 @@ kubectl config set-cluster e2e --insecure-skip-tls-verify=true ### Options ``` - --api-version="": api-version 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 + --api-version value api-version for the cluster entry in kubeconfig + --certificate-authority value path to certificate-authority file for the cluster entry in kubeconfig + --embed-certs value[=true] embed-certs for the cluster entry in kubeconfig + --insecure-skip-tls-verify value[=true] insecure-skip-tls-verify for the cluster entry in kubeconfig + --server value server for the cluster entry in kubeconfig ``` ### Options inherited from parent commands ``` - --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 - --context="": The name of the kubeconfig context to use - --kubeconfig="": use a particular kubeconfig file - --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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - Modify kubeconfig files -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_set-context.md b/docs/user-guide/kubectl/kubectl_config_set-context.md index 2d608e3004..b6ba8a3437 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-context.md +++ b/docs/user-guide/kubectl/kubectl_config_set-context.md @@ -8,6 +8,7 @@ Sets a context entry in kubeconfig ### Synopsis + Sets a context entry in kubeconfig Specifying a name that already exists will merge new fields on top of existing values for those fields. @@ -18,6 +19,7 @@ kubectl config set-context NAME [--cluster=cluster_nickname] [--user=user_nickna ### Examples ``` + # Set the user field on the gce context entry without touching other values kubectl config set-context gce --user=cluster-admin ``` @@ -25,41 +27,40 @@ kubectl config set-context gce --user=cluster-admin ### Options ``` - --cluster="": cluster for the context entry in kubeconfig - --namespace="": namespace for the context entry in kubeconfig - --user="": user for the context entry in kubeconfig + --cluster value cluster for the context entry in kubeconfig + --namespace value namespace for the context entry in kubeconfig + --user value user for the context entry in kubeconfig ``` ### 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. - --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="": use a particular kubeconfig file - --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 - --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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - Modify kubeconfig files -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_set-credentials.md b/docs/user-guide/kubectl/kubectl_config_set-credentials.md index d6dbd53110..8a462134e8 100644 --- a/docs/user-guide/kubectl/kubectl_config_set-credentials.md +++ b/docs/user-guide/kubectl/kubectl_config_set-credentials.md @@ -8,6 +8,7 @@ Sets a user entry in kubeconfig ### Synopsis + Sets a user entry in kubeconfig Specifying a name that already exists will merge new fields on top of existing values. @@ -24,12 +25,13 @@ Specifying a name that already exists will merge new fields on top of existing v ``` -kubectl config set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] +kubectl config set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] [--auth-provider=provider_name] [--auth-provider-arg=key=value] ``` ### Examples ``` + # Set only the "client-key" field on the "cluster-admin" # entry, without touching other values: kubectl config set-credentials cluster-admin --client-key=~/.kube/admin.key @@ -39,47 +41,57 @@ kubectl config set-credentials cluster-admin --username=admin --password=uXFGweU # Embed client certificate data in the "cluster-admin" entry kubectl config set-credentials cluster-admin --client-certificate=~/.kube/admin.crt --embed-certs=true + +# Enable the Google Compute Platform auth provider for the "cluster-admin" entry +kubectl config set-credentials cluster-admin --auth-provider=gcp + +# Enable the OpenID Connect auth provider for the "cluster-admin" entry with additional args +kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-id=foo --auth-provider-arg=client-secret=bar + +# Remove the "client-secret" config value for the OpenID Connect auth provider for the "cluster-admin" entry +kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret- ``` ### Options ``` - --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 - --username="": username for the user entry in kubeconfig + --auth-provider value auth provider for the user entry in kubeconfig + --auth-provider-arg value 'key=value' arugments for the auth provider (default []) + --client-certificate value path to client-certificate file for the user entry in kubeconfig + --client-key value path to client-key file for the user entry in kubeconfig + --embed-certs value[=true] embed client cert/key for the user entry in kubeconfig + --password value password for the user entry in kubeconfig + --token value token for the user entry in kubeconfig + --username value username for the user entry in kubeconfig ``` ### 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. - --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="": use a particular kubeconfig file - --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. - -s, --server="": The address and port of the Kubernetes API server - --stderrthreshold=2: logs at or above this threshold go to stderr - --user="": The name of the kubeconfig user to use - --v=0: log level for V logs - --vmodule=: comma-separated list of pattern=N settings for file-filtered logging + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --user string The name of the kubeconfig user to use + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - Modify kubeconfig files -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_set.md b/docs/user-guide/kubectl/kubectl_config_set.md index 96aa933e04..0ab8e35c1b 100644 --- a/docs/user-guide/kubectl/kubectl_config_set.md +++ b/docs/user-guide/kubectl/kubectl_config_set.md @@ -8,8 +8,9 @@ Sets an individual value in a kubeconfig file ### Synopsis + 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_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. PROPERTY_VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used. ``` @@ -19,42 +20,41 @@ 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. + --set-raw-bytes value[=true] 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. - --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="": use a particular kubeconfig file - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - Modify kubeconfig files -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_unset.md b/docs/user-guide/kubectl/kubectl_config_unset.md index c7d28e2d8d..7004076385 100644 --- a/docs/user-guide/kubectl/kubectl_config_unset.md +++ b/docs/user-guide/kubectl/kubectl_config_unset.md @@ -8,8 +8,9 @@ Unsets an individual value in a kubeconfig file ### Synopsis + Unsets 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_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots. ``` kubectl config unset PROPERTY_NAME @@ -18,36 +19,35 @@ kubectl config unset PROPERTY_NAME ### 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="": use a particular kubeconfig file - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - Modify kubeconfig files -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_use-context.md b/docs/user-guide/kubectl/kubectl_config_use-context.md index eb0040b964..b04ea867bb 100644 --- a/docs/user-guide/kubectl/kubectl_config_use-context.md +++ b/docs/user-guide/kubectl/kubectl_config_use-context.md @@ -17,36 +17,35 @@ kubectl config use-context CONTEXT_NAME ### 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="": use a particular kubeconfig file - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - Modify kubeconfig files -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_config_view.md b/docs/user-guide/kubectl/kubectl_config_view.md index 38c862cb92..0cc9854458 100644 --- a/docs/user-guide/kubectl/kubectl_config_view.md +++ b/docs/user-guide/kubectl/kubectl_config_view.md @@ -3,12 +3,13 @@ ## kubectl config view -Displays merged kubeconfig settings or a specified kubeconfig file. +Display merged kubeconfig settings or a specified kubeconfig file ### Synopsis -Displays merged kubeconfig settings or a specified kubeconfig file. + +Display merged kubeconfig settings or a specified kubeconfig file. You can use --output jsonpath={...} to extract specific values using a jsonpath expression. @@ -19,6 +20,7 @@ kubectl config view ### Examples ``` + # Show Merged kubeconfig settings. kubectl config view @@ -29,52 +31,51 @@ kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}' ### Options ``` - --flatten[=false]: flatten the resulting kubeconfig file into self contained output (useful for creating portable kubeconfig files) - --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.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.) - --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]. + --flatten flatten the resulting kubeconfig file into self-contained output (useful for creating portable kubeconfig files) + --merge value[=true] merge the full hierarchy of kubeconfig files (default true) + --minify remove all information not used by current-context from the output + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --raw display raw byte data + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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="": use a particular kubeconfig file - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string use a particular kubeconfig file + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl config](kubectl_config.md) - config modifies kubeconfig files +* [kubectl config](kubectl_config.md) - Modify kubeconfig files -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_convert.md b/docs/user-guide/kubectl/kubectl_convert.md index df2f8e427b..9809914863 100644 --- a/docs/user-guide/kubectl/kubectl_convert.md +++ b/docs/user-guide/kubectl/kubectl_convert.md @@ -8,6 +8,7 @@ Convert config files between different API versions ### Synopsis + Convert config files between different API versions. Both YAML and JSON formats are accepted. @@ -26,6 +27,7 @@ kubectl convert -f FILENAME ### Examples ``` + # Convert 'pod.yaml' to latest version and print to stdout. kubectl convert -f pod.yaml @@ -41,54 +43,53 @@ kubectl convert -f . | kubectl create -f - ### Options ``` - -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.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) - --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 + -f, --filename value Filename, directory, or URL to file to need to get converted. (default []) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --local If true, convert will NOT try to contact api-server but run locally. (default true) + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_cordon.md b/docs/user-guide/kubectl/kubectl_cordon.md index be15d2e13a..102e8726bf 100644 --- a/docs/user-guide/kubectl/kubectl_cordon.md +++ b/docs/user-guide/kubectl/kubectl_cordon.md @@ -8,6 +8,7 @@ Mark node as unschedulable ### Synopsis + Mark node as unschedulable. @@ -18,6 +19,7 @@ kubectl cordon NODE ### Examples ``` + # Mark node "foo" as unschedulable. kubectl cordon foo @@ -26,36 +28,35 @@ kubectl cordon foo ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_create.md b/docs/user-guide/kubectl/kubectl_create.md index ee8ed497f4..1294ddcaa0 100644 --- a/docs/user-guide/kubectl/kubectl_create.md +++ b/docs/user-guide/kubectl/kubectl_create.md @@ -8,6 +8,7 @@ Create a resource by filename or stdin ### Synopsis + Create a resource by filename or stdin. JSON and YAML formats are accepted. @@ -19,6 +20,7 @@ kubectl create -f FILENAME ### Examples ``` + # Create a pod using the data in pod.json. kubectl create -f ./pod.json @@ -29,53 +31,55 @@ cat pod.json | kubectl create -f - ### Options ``` - -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 + -f, --filename value Filename, directory, or URL to file to use to create the resource (default []) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + -o, --output string Output mode. Use "-o name" for shorter output (resource/name). + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + --validate If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO * [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. +* [kubectl create configmap](kubectl_create_configmap.md) - Create a configmap from a local file, directory or literal value +* [kubectl create deployment](kubectl_create_deployment.md) - Create a deployment with the specified name. +* [kubectl create namespace](kubectl_create_namespace.md) - Create a namespace with the specified name +* [kubectl create quota](kubectl_create_quota.md) - Create a quota with the specified name. +* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand +* [kubectl create service](kubectl_create_service.md) - Create a service using specified subcommand. +* [kubectl create serviceaccount](kubectl_create_serviceaccount.md) - Create a service account with the specified name -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_configmap.md b/docs/user-guide/kubectl/kubectl_create_configmap.md index ced4196333..5641512ef0 100644 --- a/docs/user-guide/kubectl/kubectl_create_configmap.md +++ b/docs/user-guide/kubectl/kubectl_create_configmap.md @@ -3,11 +3,12 @@ ## kubectl create configmap -Create a configMap from a local file, directory or literal value. +Create a configmap from a local file, directory or literal value ### Synopsis + Create a configmap based on a file, directory, or specified literal value. A single configmap may package one or more key/value pairs. @@ -27,68 +28,68 @@ kubectl create configmap NAME [--from-file=[key=]source] [--from-literal=key1=va ### Examples ``` - # Create a new configmap named my-config with keys for each file in folder bar - 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=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt +# Create a new configmap named my-config with keys for each file in folder bar +kubectl create configmap my-config --from-file=path/to/bar - # Create a new configMap named my-config with key1=config1 and key2=config2 - kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2 +# Create a new configmap named my-config with specified keys instead of names on disk +kubectl create configmap my-config --from-file=key1=/path/to/bar/file1.txt --from-file=key2=/path/to/bar/file2.txt + +# Create a new configmap named my-config with key1=config1 and key2=config2 +kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2 ``` ### Options ``` - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - --from-file=[]: Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid configmap key. - --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.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 + --dry-run If true, only print the object that would be sent, without sending it. + --from-file value Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid configmap key. (default []) + --from-literal value Specify a key and literal value to insert in configmap (i.e. mykey=somevalue) (default []) + --generator string The name of the API generator to use. (default "configmap/v1") + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO * [kubectl create](kubectl_create.md) - Create a resource by filename or stdin -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_deployment.md b/docs/user-guide/kubectl/kubectl_create_deployment.md new file mode 100644 index 0000000000..bfca422af9 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_create_deployment.md @@ -0,0 +1,83 @@ +--- +--- + +## kubectl create deployment + +Create a deployment with the specified name. + +### Synopsis + + + +Create a deployment with the specified name. + +``` +kubectl create deployment NAME --image=image [--dry-run] +``` + +### Examples + +``` + +# Create a new deployment named my-dep that runs the busybox image. +kubectl create deployment my-dep --image=busybox +``` + +### Options + +``` + --dry-run If true, only print the object that would be sent, without sending it. + --generator string The name of the API generator to use. (default "deployment-basic/v1beta1") + --image value Image name to run. (default []) + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 If true, use a schema to validate the input before sending it (default true) +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_deployment.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_namespace.md b/docs/user-guide/kubectl/kubectl_create_namespace.md index a0e9198e09..ea8dec22a2 100644 --- a/docs/user-guide/kubectl/kubectl_create_namespace.md +++ b/docs/user-guide/kubectl/kubectl_create_namespace.md @@ -3,7 +3,7 @@ ## kubectl create namespace -Create a namespace with the specified name. +Create a namespace with the specified name ### Synopsis @@ -18,60 +18,60 @@ kubectl create namespace NAME [--dry-run] ### Examples ``` - # Create a new namespace named my-namespace - kubectl create namespace my-namespace + +# Create a new namespace named my-namespace +kubectl create namespace my-namespace ``` ### Options ``` - --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.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 + --dry-run If true, only print the object that would be sent, without sending it. + --generator string The name of the API generator to use. (default "namespace/v1") + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO * [kubectl create](kubectl_create.md) - Create a resource by filename or stdin -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_quota.md b/docs/user-guide/kubectl/kubectl_create_quota.md new file mode 100644 index 0000000000..afbd66e572 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_create_quota.md @@ -0,0 +1,86 @@ +--- +--- + +## kubectl create quota + +Create a quota with the specified name. + +### Synopsis + + + +Create a resourcequota with the specified name, hard limits and optional scopes + +``` +kubectl create quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scope2] [--dry-run=bool] +``` + +### Examples + +``` + // Create a new resourcequota named my-quota + $ kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10 + + // Create a new resourcequota named best-effort + $ kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort +``` + +### Options + +``` + --dry-run If true, only print the object that would be sent, without sending it. + --generator string The name of the API generator to use. (default "resourcequotas/v1") + --hard string A comma-delimited set of resource=quantity pairs that define a hard limit. + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + --scopes string A comma-delimited set of quota scopes that must all match each object tracked by the quota. + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 If true, use a schema to validate the input before sending it (default true) +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_quota.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_secret.md b/docs/user-guide/kubectl/kubectl_create_secret.md index 6c4ef4a935..10dcd20d29 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret.md +++ b/docs/user-guide/kubectl/kubectl_create_secret.md @@ -3,7 +3,7 @@ ## kubectl create secret -Create a secret using specified subcommand. +Create a secret using specified subcommand ### Synopsis @@ -17,39 +17,38 @@ kubectl create secret ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO * [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. +* [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 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 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 1d821f262f..c357816dea 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md @@ -3,7 +3,7 @@ ## kubectl create secret docker-registry -Create a secret for use with a Docker registry. +Create a secret for use with a Docker registry ### Synopsis @@ -29,65 +29,65 @@ kubectl create secret docker-registry NAME --docker-username=user --docker-passw ### Examples ``` - # 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 + +# 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 ``` ### Options ``` - --docker-email="": Email for Docker registry - --docker-password="": Password for Docker registry authentication - --docker-server="https://index.docker.io/v1/": Server location for Docker registry - --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.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 + --docker-email string Email for Docker registry + --docker-password string Password for Docker registry authentication + --docker-server string Server location for Docker registry (default "https://index.docker.io/v1/") + --docker-username string Username for Docker registry authentication + --dry-run If true, only print the object that would be sent, without sending it. + --generator string The name of the API generator to use. (default "secret-for-docker-registry/v1") + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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. +* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_secret_generic.md b/docs/user-guide/kubectl/kubectl_create_secret_generic.md index 9d059b729c..7fb7660038 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_generic.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_generic.md @@ -3,7 +3,7 @@ ## kubectl create secret generic -Create a secret from a local file, directory or literal value. +Create a secret from a local file, directory or literal value ### Synopsis @@ -28,69 +28,69 @@ kubectl create secret generic NAME [--type=string] [--from-file=[key=]source] [- ### Examples ``` - # Create a new secret named my-secret with keys for each file in folder bar - kubectl create secret generic my-secret --from-file=path/to/bar - # Create a new secret named my-secret with specified keys instead of names on disk - kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub +# Create a new secret named my-secret with keys for each file in folder bar +kubectl create secret generic my-secret --from-file=path/to/bar - # Create a new secret named my-secret with key1=supersecret and key2=topsecret - kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret +# Create a new secret named my-secret with specified keys instead of names on disk +kubectl create secret generic my-secret --from-file=ssh-privatekey=~/.ssh/id_rsa --from-file=ssh-publickey=~/.ssh/id_rsa.pub + +# Create a new secret named my-secret with key1=supersecret and key2=topsecret +kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret ``` ### Options ``` - --dry-run[=false]: If true, only print the object that would be sent, without sending it. - --from-file=[]: Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key. - --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.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]. - --type="": The type of secret to create - --validate[=true]: If true, use a schema to validate the input before sending it + --dry-run If true, only print the object that would be sent, without sending it. + --from-file value Key files can be specified using their file path, in which case a default name will be given to them, or optionally with a name and file path, in which case the given name will be used. Specifying a directory will iterate each named file in the directory that is a valid secret key. (default []) + --from-literal value Specify a key and literal value to insert in secret (i.e. mykey=somevalue) (default []) + --generator string The name of the API generator to use. (default "secret/v1") + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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]. + --type string The type of secret to create + --validate If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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. +* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_secret_tls.md b/docs/user-guide/kubectl/kubectl_create_secret_tls.md index e66c20c5a1..4d64f3f38d 100644 --- a/docs/user-guide/kubectl/kubectl_create_secret_tls.md +++ b/docs/user-guide/kubectl/kubectl_create_secret_tls.md @@ -3,7 +3,7 @@ ## kubectl create secret tls -Create a TLS secret. +Create a TLS secret ### Synopsis @@ -20,62 +20,62 @@ kubectl create secret tls NAME --cert=path/to/cert/file --key=path/to/key/file [ ### 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 + +# 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 + --cert string Path to PEM encoded public key certificate. + --dry-run If true, only print the object that would be sent, without sending it. + --generator string The name of the API generator to use. (default "secret-for-tls/v1") + --key string Path to private key associated with given certificate. + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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. +* [kubectl create secret](kubectl_create_secret.md) - Create a secret using specified subcommand -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_create_service.md b/docs/user-guide/kubectl/kubectl_create_service.md new file mode 100644 index 0000000000..ab115fba40 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_create_service.md @@ -0,0 +1,59 @@ +--- +--- + +## kubectl create service + +Create a service using specified subcommand. + +### Synopsis + + +Create a service using specified subcommand. + +``` +kubectl create service +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create](kubectl_create.md) - Create a resource by filename or stdin +* [kubectl create service clusterip](kubectl_create_service_clusterip.md) - Create a clusterIP service. +* [kubectl create service loadbalancer](kubectl_create_service_loadbalancer.md) - Create a LoadBalancer service. +* [kubectl create service nodeport](kubectl_create_service_nodeport.md) - Create a NodePort service. + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_service.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_service_clusterip.md b/docs/user-guide/kubectl/kubectl_create_service_clusterip.md new file mode 100644 index 0000000000..81837bba97 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_create_service_clusterip.md @@ -0,0 +1,87 @@ +--- +--- + +## kubectl create service clusterip + +Create a clusterIP service. + +### Synopsis + + + +Create a clusterIP service with the specified name. + +``` +kubectl create service clusterip NAME [--tcp=:] [--dry-run] +``` + +### Examples + +``` + +# Create a new clusterIP service named my-cs +kubectl create service clusterip my-cs --tcp=5678:8080 + +# Create a new clusterIP service named my-cs (in headless mode) +kubectl create service clusterip my-cs --clusterip="None" +``` + +### Options + +``` + --clusterip string Assign your own ClusterIP or set to 'None' for a 'headless' service (no loadbalancing). + --dry-run If true, only print the object that would be sent, without sending it. + --generator string The name of the API generator to use. (default "service-clusterip/v1") + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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. + --tcp value Port pairs can be specified as ':'. (default []) + --template string 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 If true, use a schema to validate the input before sending it (default true) +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create service](kubectl_create_service.md) - Create a service using specified subcommand. + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_service_clusterip.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md b/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md new file mode 100644 index 0000000000..a12a8a68e1 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md @@ -0,0 +1,83 @@ +--- +--- + +## kubectl create service loadbalancer + +Create a LoadBalancer service. + +### Synopsis + + + +Create a LoadBalancer service with the specified name. + +``` +kubectl create service loadbalancer NAME [--tcp=port:targetPort] [--dry-run] +``` + +### Examples + +``` + +# Create a new nodeport service named my-lbs +kubectl create service loadbalancer my-lbs --tcp=5678:8080 +``` + +### Options + +``` + --dry-run If true, only print the object that would be sent, without sending it. + --generator string The name of the API generator to use. (default "service-loadbalancer/v1") + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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. + --tcp value Port pairs can be specified as ':'. (default []) + --template string 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 If true, use a schema to validate the input before sending it (default true) +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create service](kubectl_create_service.md) - Create a service using specified subcommand. + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_service_nodeport.md b/docs/user-guide/kubectl/kubectl_create_service_nodeport.md new file mode 100644 index 0000000000..3cc3927812 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_create_service_nodeport.md @@ -0,0 +1,83 @@ +--- +--- + +## kubectl create service nodeport + +Create a NodePort service. + +### Synopsis + + + +Create a nodeport service with the specified name. + +``` +kubectl create service nodeport NAME [--tcp=port:targetPort] [--dry-run] +``` + +### Examples + +``` + +# Create a new nodeport service named my-ns +kubectl create service nodeport my-ns --tcp=5678:8080 +``` + +### Options + +``` + --dry-run If true, only print the object that would be sent, without sending it. + --generator string The name of the API generator to use. (default "service-nodeport/v1") + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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. + --tcp value Port pairs can be specified as ':'. (default []) + --template string 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 If true, use a schema to validate the input before sending it (default true) +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl create service](kubectl_create_service.md) - Create a service using specified subcommand. + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_create_service_nodeport.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md index ba1dd8d3e1..3005fefe2d 100644 --- a/docs/user-guide/kubectl/kubectl_create_serviceaccount.md +++ b/docs/user-guide/kubectl/kubectl_create_serviceaccount.md @@ -3,7 +3,7 @@ ## kubectl create serviceaccount -Create a service account with the specified name. +Create a service account with the specified name ### Synopsis @@ -18,61 +18,61 @@ kubectl create serviceaccount NAME [--dry-run] ### Examples ``` - # Create a new service account named my-service-account - $ kubectl create serviceaccount my-service-account + +# Create a new service account named my-service-account +$ kubectl create serviceaccount my-service-account ``` ### Options ``` - --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.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 + --dry-run If true, only print the object that would be sent, without sending it. + --generator string The name of the API generator to use. (default "serviceaccount/v1") + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO * [kubectl create](kubectl_create.md) - Create a resource by filename or stdin -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_delete.md b/docs/user-guide/kubectl/kubectl_delete.md index 244580fa94..af5d21dac0 100644 --- a/docs/user-guide/kubectl/kubectl_delete.md +++ b/docs/user-guide/kubectl/kubectl_delete.md @@ -3,11 +3,12 @@ ## kubectl delete -Delete resources by filenames, stdin, resources and names, or by resources and label selector. +Delete resources by filenames, stdin, resources and names, or by resources and label selector ### Synopsis + Delete resources by filenames, stdin, resources and names, or by resources and label selector. JSON and YAML formats are accepted. @@ -25,6 +26,7 @@ kubectl delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)]) ### Examples ``` + # Delete a pod using the type and name specified in pod.json. kubectl delete -f ./pod.json @@ -50,52 +52,51 @@ kubectl delete pods --all ### Options ``` - --all[=false]: [-all] to select all the specified resources. - --cascade[=true]: If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true. - -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 + --all [-all] to select all the specified resources. + --cascade If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). Default true. (default true) + -f, --filename value Filename, directory, or URL to a file containing the resource to delete. (default []) + --grace-period int Period of time in seconds given to the resource to terminate gracefully. Ignored if negative. (default -1) + --ignore-not-found Treat "resource not found" as a successful delete. Defaults to "true" when --all is specified. + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --now If true, resources are force terminated without graceful deletion (same as --grace-period=0). + -o, --output string Output mode. Use "-o name" for shorter output (resource/name). + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + -l, --selector string Selector (label query) to filter on. + --timeout duration The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the 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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_describe.md b/docs/user-guide/kubectl/kubectl_describe.md index e4a717f571..550018f9ea 100644 --- a/docs/user-guide/kubectl/kubectl_describe.md +++ b/docs/user-guide/kubectl/kubectl_describe.md @@ -8,21 +8,42 @@ Show details of a specific resource or group of resources ### Synopsis -Show details of a specific resource or group of resources. +Show details of a specific resource or group of resources. This command joins many API calls together to form a detailed description of a given resource or group of resources. $ 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 +exists, it will output details for every resource that has a name prefixed with NAME_PREFIX. + +Valid resource types include: + * clusters (valid only for federation apiservers) + * componentstatuses (aka 'cs') + * configmaps (aka 'cm') + * daemonsets (aka 'ds') + * deployments (aka 'deploy') + * events (aka 'ev') + * endpoints (aka 'ep') + * horizontalpodautoscalers (aka 'hpa') + * ingress (aka 'ing') + * jobs + * limitranges (aka 'limits') + * nodes (aka 'no') + * namespaces (aka 'ns') + * petsets (alpha feature, may be unstable) + * pods (aka 'po') + * persistentvolumes (aka 'pv') + * persistentvolumeclaims (aka 'pvc') + * quota + * resourcequotas (aka 'quota') + * replicasets (aka 'rs') + * replicationcontrollers (aka 'rc') + * secrets + * serviceaccounts (aka 'sa') + * services (aka 'svc') -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) @@ -31,6 +52,7 @@ kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME) ### Examples ``` + # Describe a node kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal @@ -54,46 +76,46 @@ kubectl describe pods frontend ### Options ``` - -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. + --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. + -f, --filename value Filename, directory, or URL to a file containing the resource to describe (default []) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + -l, --selector string Selector (label query) to filter on + --show-events If true, display events related to the described object. (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_drain.md b/docs/user-guide/kubectl/kubectl_drain.md index 535b6e024d..9a77254492 100644 --- a/docs/user-guide/kubectl/kubectl_drain.md +++ b/docs/user-guide/kubectl/kubectl_drain.md @@ -8,6 +8,7 @@ Drain node in preparation for maintenance ### Synopsis + Drain node in preparation for maintenance. The given node will be marked unschedulable to prevent new pods from arriving. @@ -23,6 +24,8 @@ use --force. When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again. +![Workflow](http://kubernetes.io/images/docs/kubectl_drain.svg) + ``` kubectl drain NODE @@ -31,6 +34,7 @@ kubectl drain NODE ### Examples ``` + # Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it. $ kubectl drain foo --force @@ -42,45 +46,44 @@ $ kubectl drain foo --grace-period=900 ### Options ``` - --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. + --delete-local-data Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained). + --force Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet. + --grace-period int Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. (default -1) + --ignore-daemonsets Ignore DaemonSet-managed pods. ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_edit.md b/docs/user-guide/kubectl/kubectl_edit.md index 3c0c1c779f..3e0b3f53df 100644 --- a/docs/user-guide/kubectl/kubectl_edit.md +++ b/docs/user-guide/kubectl/kubectl_edit.md @@ -8,6 +8,7 @@ Edit a resource on the server ### Synopsis + Edit a resource from the default editor. The edit command allows you to directly edit any API resource you can retrieve via the @@ -35,62 +36,64 @@ kubectl edit (RESOURCE/NAME | -f FILENAME) ### Examples ``` - # Edit the service named 'docker-registry': - kubectl edit svc/docker-registry - # Use an alternative editor - KUBE_EDITOR="nano" kubectl edit svc/docker-registry +# Edit the service named 'docker-registry': +kubectl edit svc/docker-registry - # Edit the service 'docker-registry' in JSON using the v1 API format: - kubectl edit svc/docker-registry --output-version=v1 -o json +# Use an alternative editor +KUBE_EDITOR="nano" kubectl edit svc/docker-registry + +# Edit the service 'docker-registry' in JSON using the v1 API format: +kubectl edit svc/docker-registry --output-version=v1 -o json ``` ### Options ``` - -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) + -f, --filename value Filename, directory, or URL to file to use to edit the resource (default []) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + -o, --output string Output format. One of: yaml|json. (default "yaml") + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + --validate If true, use a schema to validate the input before sending it (default true) + --windows-line-endings Use Windows line-endings (default Unix line-endings) ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_exec.md b/docs/user-guide/kubectl/kubectl_exec.md index 90ac608d88..f8140491b8 100644 --- a/docs/user-guide/kubectl/kubectl_exec.md +++ b/docs/user-guide/kubectl/kubectl_exec.md @@ -3,7 +3,7 @@ ## kubectl exec -Execute a command in a container. +Execute a command in a container ### Synopsis @@ -17,9 +17,10 @@ kubectl exec POD [-c CONTAINER] -- COMMAND [args...] ### Examples ``` + # Get output from running 'date' from pod 123456-7890, using the first container by default kubectl exec 123456-7890 date - + # Get output from running 'date' in ruby-container from pod 123456-7890 kubectl exec 123456-7890 -c ruby-container date @@ -31,45 +32,44 @@ kubectl exec 123456-7890 -c ruby-container -i -t -- bash -il ### Options ``` - -c, --container="": Container name. If omitted, the first container in the pod will be chosen - -p, --pod="": Pod name - -i, --stdin[=false]: Pass stdin to the container - -t, --tty[=false]: Stdin is a TTY + -c, --container string Container name. If omitted, the first container in the pod will be chosen + -p, --pod string Pod name + -i, --stdin Pass stdin to the container + -t, --tty Stdin is a TTY ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_explain.md b/docs/user-guide/kubectl/kubectl_explain.md index 8834c0bfe7..f4d65ee7cd 100644 --- a/docs/user-guide/kubectl/kubectl_explain.md +++ b/docs/user-guide/kubectl/kubectl_explain.md @@ -3,18 +3,40 @@ ## kubectl explain -Documentation of resources. +Documentation of resources ### Synopsis + Documentation of resources. -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. +Valid resource types include: + * clusters (valid only for federation apiservers) + * componentstatuses (aka 'cs') + * configmaps (aka 'cm') + * daemonsets (aka 'ds') + * deployments (aka 'deploy') + * events (aka 'ev') + * endpoints (aka 'ep') + * horizontalpodautoscalers (aka 'hpa') + * ingress (aka 'ing') + * jobs + * limitranges (aka 'limits') + * nodes (aka 'no') + * namespaces (aka 'ns') + * petsets (alpha feature, may be unstable) + * pods (aka 'po') + * persistentvolumes (aka 'pv') + * persistentvolumeclaims (aka 'pvc') + * quota + * resourcequotas (aka 'quota') + * replicasets (aka 'rs') + * replicationcontrollers (aka 'rc') + * secrets + * serviceaccounts (aka 'sa') + * services (aka 'svc') + ``` kubectl explain RESOURCE @@ -23,6 +45,7 @@ kubectl explain RESOURCE ### Examples ``` + # Get the documentation of the resource and its fields kubectl explain pods @@ -33,43 +56,42 @@ 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) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --recursive Print the fields of fields (Currently only 1 level deep) ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_expose.md b/docs/user-guide/kubectl/kubectl_expose.md index 8721819ff5..d94504cfa2 100644 --- a/docs/user-guide/kubectl/kubectl_expose.md +++ b/docs/user-guide/kubectl/kubectl_expose.md @@ -8,6 +8,7 @@ Take a replication controller, service, deployment or pod and expose it as a new ### Synopsis + 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 @@ -18,8 +19,8 @@ i.e. when the selector contains only the matchLabels component. Note that 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) +pod (po), service (svc), replicationcontroller (rc), +deployment, replicaset (rs) ``` @@ -29,6 +30,7 @@ kubectl expose (-f FILENAME | TYPE NAME) [--port=port] [--protocol=TCP|UDP] [--t ### Examples ``` + # Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000. kubectl expose rc nginx --port=80 --target-port=8000 @@ -54,65 +56,65 @@ kubectl expose deployment nginx --port=80 --target-port=8000 ### Options ``` - --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'. - -l, --labels="": Labels to apply to the service created by this call. - --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.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="": 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' - -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. - --target-port="": Name or number for the port on the container that the service should direct traffic to. Optional. - --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]. - --type="": Type for this service: ClusterIP, NodePort, or LoadBalancer. Default is 'ClusterIP'. + --cluster-ip string ClusterIP to be assigned to the service. Leave empty to auto-allocate, or set to 'None' to create a headless service. + --dry-run If true, only print the object that would be sent, without sending it. + --external-ip string 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 value Filename, directory, or URL to a file identifying the resource to expose a service (default []) + --generator string 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'. (default "service/v2") + -l, --labels string Labels to apply to the service created by this call. + --load-balancer-ip string IP to assign to the Load Balancer. If empty, an ephemeral IP will be created and used (cloud-provider specific). + --name string The name for the newly created object. + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --overrides string 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 string The port that the service should serve on. Copied from the resource being exposed, if unspecified + --protocol string The network protocol for the service to be created. Default is 'TCP'. + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --save-config 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 string 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 string If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP' + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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. + --target-port string Name or number for the port on the container that the service should direct traffic to. Optional. + --template string 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]. + --type string Type for this service: ClusterIP, NodePort, or LoadBalancer. Default is 'ClusterIP'. ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_get.md b/docs/user-guide/kubectl/kubectl_get.md index 33a2200cce..beebab3c5d 100644 --- a/docs/user-guide/kubectl/kubectl_get.md +++ b/docs/user-guide/kubectl/kubectl_get.md @@ -8,24 +8,50 @@ Display one or many resources ### Synopsis + Display one or many resources. -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. +Valid resource types include: + * clusters (valid only for federation apiservers) + * componentstatuses (aka 'cs') + * configmaps (aka 'cm') + * daemonsets (aka 'ds') + * deployments (aka 'deploy') + * events (aka 'ev') + * endpoints (aka 'ep') + * horizontalpodautoscalers (aka 'hpa') + * ingress (aka 'ing') + * jobs + * limitranges (aka 'limits') + * nodes (aka 'no') + * namespaces (aka 'ns') + * petsets (alpha feature, may be unstable) + * pods (aka 'po') + * persistentvolumes (aka 'pv') + * persistentvolumeclaims (aka 'pvc') + * quota + * resourcequotas (aka 'quota') + * replicasets (aka 'rs') + * replicationcontrollers (aka 'rc') + * secrets + * serviceaccounts (aka 'sa') + * services (aka 'svc') + + +This command will hide resources that have completed. For instance, pods that are in the Succeeded or Failed phases. +You can see the full results for any resource by providing the '--show-all' flag. 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). ``` -kubectl get [(-o|--output=)json|yaml|wide|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE [NAME | -l label] | TYPE/NAME ...) [flags] +kubectl get [(-o|--output=)json|yaml|wide|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE [NAME | -l label] | TYPE/NAME ...) [flags] ``` ### Examples ``` + # List all pods in ps output format. kubectl get pods @@ -54,57 +80,58 @@ kubectl get rc/web service/frontend pods/web-pod-13je7 ### Options ``` - --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.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) - --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]. - -w, --watch[=false]: After listing/getting the requested object, watch for changes. - --watch-only[=false]: Watch for changes to the requested object(s), without listing/getting first. + --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. + --export If true, use 'export' for the resources. Exported resources are stripped of cluster-specific information. + -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default []) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + -L, --label-columns value Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2... (default []) + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --raw string Raw URI to request from the server. Uses the transport specified by the kubeconfig file. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + -l, --selector string Selector (label query) to filter on + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-kind If present, list the resource type for the requested object(s). + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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]. + -w, --watch After listing/getting the requested object, watch for changes. + --watch-only Watch for changes to the requested object(s), without listing/getting first. ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_label.md b/docs/user-guide/kubectl/kubectl_label.md index 7aa65a5c89..589dce3bac 100644 --- a/docs/user-guide/kubectl/kubectl_label.md +++ b/docs/user-guide/kubectl/kubectl_label.md @@ -8,6 +8,7 @@ Update the labels on a resource ### Synopsis + Update the labels on a resource. A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters. @@ -21,6 +22,7 @@ kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_ ### Examples ``` + # Update pod 'foo' with the label 'unhealthy' and the value 'true'. kubectl label pods foo unhealthy=true @@ -44,57 +46,56 @@ kubectl label pods foo bar- ### Options ``` - --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.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.) - --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]. + --all select all resources in the namespace of the specified resource types + --dry-run If true, only print the object that would be sent, without sending it. + -f, --filename value Filename, directory, or URL to a file identifying the resource to update the labels (default []) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --overwrite If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --resource-version string 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 string Selector (label query) to filter on + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_logs.md b/docs/user-guide/kubectl/kubectl_logs.md index 19e1d37fdc..8e1acc293d 100644 --- a/docs/user-guide/kubectl/kubectl_logs.md +++ b/docs/user-guide/kubectl/kubectl_logs.md @@ -3,7 +3,7 @@ ## kubectl logs -Print the logs for a container in a pod. +Print the logs for a container in a pod ### Synopsis @@ -17,6 +17,7 @@ kubectl logs [-f] [-p] POD [-c CONTAINER] ### Examples ``` + # Return snapshot logs from pod nginx with only one container kubectl logs nginx @@ -36,50 +37,49 @@ kubectl logs --since=1h nginx ### Options ``` - -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. - --since-time="": Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. - --tail=-1: Lines of recent log file to display. Defaults to -1, showing all log lines. - --timestamps[=false]: Include timestamps on each line in the log output + -c, --container string Print the logs of this container + -f, --follow Specify if the logs should be streamed. + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --limit-bytes int Maximum bytes of logs to return. Defaults to no limit. + -p, --previous If true, print the logs for the previous instance of the container in a pod if it exists. + --since duration 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. + --since-time string Only return logs after a specific date (RFC3339). Defaults to all logs. Only one of since-time / since may be used. + --tail int Lines of recent log file to display. Defaults to -1, showing all log lines. (default -1) + --timestamps Include timestamps on each line in the log output ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_namespace.md b/docs/user-guide/kubectl/kubectl_namespace.md index 2c9a4b43d3..608a0581f8 100644 --- a/docs/user-guide/kubectl/kubectl_namespace.md +++ b/docs/user-guide/kubectl/kubectl_namespace.md @@ -3,15 +3,12 @@ ## kubectl namespace -SUPERSEDED: Set and view the current Kubernetes namespace +Deprecated: config set-context ### Synopsis -SUPERSEDED: Set and view the current Kubernetes namespace scope for command line requests. - -namespace has been superseded by the context.namespace field of .kubeconfig files. See 'kubectl config set-context --help' for more details. - +Deprecated: This command is deprecated, all its functionalities are covered by "kubectl config set-context" ``` kubectl namespace [namespace] @@ -20,36 +17,35 @@ kubectl namespace [namespace] ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_options.md b/docs/user-guide/kubectl/kubectl_options.md new file mode 100644 index 0000000000..014faf6010 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_options.md @@ -0,0 +1,56 @@ +--- +--- + +## kubectl options + + + +### Synopsis + + + + +``` +kubectl options +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_options.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_patch.md b/docs/user-guide/kubectl/kubectl_patch.md index 470c2a6bc9..dcccf49be5 100644 --- a/docs/user-guide/kubectl/kubectl_patch.md +++ b/docs/user-guide/kubectl/kubectl_patch.md @@ -3,16 +3,17 @@ ## kubectl patch -Update field(s) of a resource using strategic merge patch. +Update field(s) of a resource using strategic merge patch ### Synopsis + 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/v1.3.0-beta.0/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/release-1.4/docs/api-reference/v1/definitions.html to find if a field is mutable. ``` kubectl patch (-f FILENAME | TYPE NAME) -p PATCH @@ -22,6 +23,7 @@ kubectl patch (-f FILENAME | TYPE NAME) -p PATCH ``` + # Partially update a node using strategic merge patch kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}' @@ -38,48 +40,54 @@ kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/ ### 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] + -f, --filename value Filename, directory, or URL to a file identifying the resource to update (default []) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --local If true, patch will operate on the content of the file, not the server-side resource. + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + -p, --patch string The patch to be applied to the resource JSON file. + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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]. + --type string The type of patch being provided; one of [json merge strategic] (default "strategic") ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_port-forward.md b/docs/user-guide/kubectl/kubectl_port-forward.md index 4fa519f51b..c8783efaa0 100644 --- a/docs/user-guide/kubectl/kubectl_port-forward.md +++ b/docs/user-guide/kubectl/kubectl_port-forward.md @@ -3,7 +3,7 @@ ## kubectl port-forward -Forward one or more local ports to a pod. +Forward one or more local ports to a pod ### Synopsis @@ -34,42 +34,41 @@ kubectl port-forward mypod 0:5000 ### Options ``` - -p, --pod="": Pod name + -p, --pod string Pod name ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_proxy.md b/docs/user-guide/kubectl/kubectl_proxy.md index 501ba3c5fa..7ebae29472 100644 --- a/docs/user-guide/kubectl/kubectl_proxy.md +++ b/docs/user-guide/kubectl/kubectl_proxy.md @@ -8,6 +8,7 @@ Run a proxy to the Kubernetes API server ### Synopsis + To proxy all of the kubernetes api and nothing else, use: kubectl proxy --api-prefix=/ @@ -32,6 +33,7 @@ kubectl proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-pref ### Examples ``` + # Run a proxy to kubernetes apiserver on port 8011, serving static content from ./local/www/ kubectl proxy --port=8011 --www=./local/www/ @@ -47,52 +49,51 @@ kubectl proxy --api-prefix=/k8s-api ### Options ``` - --accept-hosts="^localhost$,^127\\.0\\.0\\.1$,^\\[::1\\]$": Regular expression for hosts that the proxy should accept. - --accept-paths="^/.*": Regular expression for paths that the proxy should accept. - --address="127.0.0.1": The IP address on which to serve on. - --api-prefix="/": Prefix to serve the proxied API under. - --disable-filter[=false]: If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. - -p, --port=8001: The port on which to run the proxy. Set to 0 to pick a random port. - --reject-methods="POST,PUT,PATCH": Regular expression for HTTP methods that the proxy should reject. - --reject-paths="^/api/.*/exec,^/api/.*/run,^/api/.*/attach": Regular expression for paths that the proxy should reject. - -u, --unix-socket="": Unix socket on which to run the proxy. - -w, --www="": Also serve static files from the given directory under the specified prefix. - -P, --www-prefix="/static/": Prefix to serve static files under, if static file directory is specified. + --accept-hosts string Regular expression for hosts that the proxy should accept. (default "^localhost$,^127\\.0\\.0\\.1$,^\\[::1\\]$") + --accept-paths string Regular expression for paths that the proxy should accept. (default "^/.*") + --address string The IP address on which to serve on. (default "127.0.0.1") + --api-prefix string Prefix to serve the proxied API under. (default "/") + --disable-filter If true, disable request filtering in the proxy. This is dangerous, and can leave you vulnerable to XSRF attacks, when used with an accessible port. + -p, --port int The port on which to run the proxy. Set to 0 to pick a random port. (default 8001) + --reject-methods string Regular expression for HTTP methods that the proxy should reject. (default "POST,PUT,PATCH") + --reject-paths string Regular expression for paths that the proxy should reject. (default "^/api/.*/pods/.*/exec,^/api/.*/pods/.*/attach") + -u, --unix-socket string Unix socket on which to run the proxy. + -w, --www string Also serve static files from the given directory under the specified prefix. + -P, --www-prefix string Prefix to serve static files under, if static file directory is specified. (default "/static/") ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_replace.md b/docs/user-guide/kubectl/kubectl_replace.md index f2edc3c9bc..04abefd976 100644 --- a/docs/user-guide/kubectl/kubectl_replace.md +++ b/docs/user-guide/kubectl/kubectl_replace.md @@ -3,18 +3,19 @@ ## kubectl replace -Replace a resource by filename or stdin. +Replace a resource by filename or stdin ### Synopsis + Replace a resource by filename or stdin. JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by $ kubectl get TYPE NAME -o yaml -Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/v1.3.0-beta.0/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/release-1.4/docs/api-reference/v1/definitions.html to find if a field is mutable. ``` kubectl replace -f FILENAME @@ -23,6 +24,7 @@ kubectl replace -f FILENAME ### Examples ``` + # Replace a pod using the data in pod.json. kubectl replace -f ./pod.json @@ -39,53 +41,52 @@ kubectl replace --force -f ./pod.json ### Options ``` - --cascade[=false]: Only relevant during a force replace. If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). - -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 - --validate[=true]: If true, use a schema to validate the input before sending it + --cascade Only relevant during a force replace. If true, cascade the deletion of the resources managed by this resource (e.g. Pods created by a ReplicationController). + -f, --filename value Filename, directory, or URL to file to use to replace the resource. (default []) + --force Delete and re-create the specified resource + --grace-period int Only relevant during a force replace. Period of time in seconds given to the old resource to terminate gracefully. Ignored if negative. (default -1) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + -o, --output string Output mode. Use "-o name" for shorter output (resource/name). + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --save-config 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 string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + --timeout duration 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. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). + --validate If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_rolling-update.md b/docs/user-guide/kubectl/kubectl_rolling-update.md index 65e330ea9f..d6fa42992e 100644 --- a/docs/user-guide/kubectl/kubectl_rolling-update.md +++ b/docs/user-guide/kubectl/kubectl_rolling-update.md @@ -3,11 +3,12 @@ ## kubectl rolling-update -Perform a rolling update of the given ReplicationController. +Perform a rolling update of the given ReplicationController ### Synopsis + Perform a rolling update of the given ReplicationController. Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the @@ -21,6 +22,7 @@ kubectl rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CO ### Examples ``` + # Update pods of frontend-v1 using new replication controller data in frontend-v2.json. kubectl rolling-update frontend-v1 -f frontend-v2.json @@ -42,61 +44,60 @@ kubectl rolling-update frontend-v1 frontend-v2 --rollback ### Options ``` - --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, 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.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 - --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]. - --timeout=5m0s: Max time to wait for a replication controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". - --update-period=1m0s: Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". - --validate[=true]: If true, use a schema to validate the input before sending it + --container string 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 string The key to use to differentiate between two different controllers, default 'deployment'. Only relevant when --image is specified, ignored otherwise (default "deployment") + --dry-run If true, only print the object that would be sent, without sending it. + -f, --filename value Filename or URL to file to use to create the new replication controller. (default []) + --image string 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 string Explicit policy for when to pull container images. Required when --image is same as existing image, ignored otherwise. + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --poll-interval duration Time delay between polling for replication controller status after the update. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default 3s) + --rollback 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 + --schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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]. + --timeout duration Max time to wait for a replication controller to update before giving up. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default 5m0s) + --update-period duration Time to wait between updating pods. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default 1m0s) + --validate If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout.md b/docs/user-guide/kubectl/kubectl_rollout.md index dc8a696359..1117ae844b 100644 --- a/docs/user-guide/kubectl/kubectl_rollout.md +++ b/docs/user-guide/kubectl/kubectl_rollout.md @@ -3,12 +3,13 @@ ## kubectl rollout -rollout manages a deployment +Manage a deployment rollout ### Synopsis -Manages a deployment using subcommands like "kubectl rollout undo deployment/abc" + +Manage a deployment using subcommands like "kubectl rollout undo deployment/abc" ``` kubectl rollout SUBCOMMAND @@ -17,6 +18,7 @@ kubectl rollout SUBCOMMAND ### Examples ``` + # Rollback to the previous deployment kubectl rollout undo deployment/abc ``` @@ -24,41 +26,40 @@ kubectl rollout undo deployment/abc ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO * [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager -* [kubectl rollout history](kubectl_rollout_history.md) - view rollout history +* [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 +* [kubectl rollout undo](kubectl_rollout_undo.md) - Undo a previous rollout -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout_history.md b/docs/user-guide/kubectl/kubectl_rollout_history.md index b26cdb1b5a..2884cafd13 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_history.md +++ b/docs/user-guide/kubectl/kubectl_rollout_history.md @@ -3,11 +3,12 @@ ## kubectl rollout history -view rollout history +View rollout history ### Synopsis + View previous rollout revisions and configurations. ``` @@ -17,6 +18,7 @@ kubectl rollout history (TYPE NAME | TYPE/NAME) [flags] ### Examples ``` + # View the rollout history of a deployment kubectl rollout history deployment/abc @@ -27,44 +29,43 @@ 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 + -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default []) + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --revision int See the details, including podTemplate of the revision specified ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment +* [kubectl rollout](kubectl_rollout.md) - Manage a deployment rollout -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout_pause.md b/docs/user-guide/kubectl/kubectl_rollout_pause.md index 8e73d917ae..3387e0a06b 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_pause.md +++ b/docs/user-guide/kubectl/kubectl_rollout_pause.md @@ -8,6 +8,7 @@ Mark the provided resource as paused ### Synopsis + Mark the provided resource as paused Paused resources will not be reconciled by a controller. @@ -21,6 +22,7 @@ kubectl rollout pause RESOURCE ### Examples ``` + # Mark the nginx deployment as paused. Any current state of # the deployment will continue its function, new updates to the deployment will not # have an effect as long as the deployment is paused. @@ -30,43 +32,42 @@ kubectl rollout pause 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. + -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default []) + -R, --recursive 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment +* [kubectl rollout](kubectl_rollout.md) - Manage a deployment rollout -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout_resume.md b/docs/user-guide/kubectl/kubectl_rollout_resume.md index 681cf6add6..02ac6476b7 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_resume.md +++ b/docs/user-guide/kubectl/kubectl_rollout_resume.md @@ -8,6 +8,7 @@ Resume a paused resource ### Synopsis + Resume a paused resource Paused resources will not be reconciled by a controller. By resuming a @@ -21,6 +22,7 @@ kubectl rollout resume RESOURCE ### Examples ``` + # Resume an already paused deployment kubectl rollout resume deployment/nginx ``` @@ -28,43 +30,42 @@ kubectl rollout resume 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. + -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default []) + -R, --recursive 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment +* [kubectl rollout](kubectl_rollout.md) - Manage a deployment rollout -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout_status.md b/docs/user-guide/kubectl/kubectl_rollout_status.md index a5ac92c5b2..2d63fc960f 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_status.md +++ b/docs/user-guide/kubectl/kubectl_rollout_status.md @@ -8,6 +8,7 @@ Watch rollout status until it's done ### Synopsis + Watch the status of current rollout, until it's done. ``` @@ -17,6 +18,7 @@ kubectl rollout status (TYPE NAME | TYPE/NAME) [flags] ### Examples ``` + # Watch the rollout status of a deployment kubectl rollout status deployment/nginx ``` @@ -24,43 +26,42 @@ 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. + -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default []) + -R, --recursive 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment +* [kubectl rollout](kubectl_rollout.md) - Manage a deployment rollout -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_rollout_undo.md b/docs/user-guide/kubectl/kubectl_rollout_undo.md index 890cd54b6a..886162f8ab 100644 --- a/docs/user-guide/kubectl/kubectl_rollout_undo.md +++ b/docs/user-guide/kubectl/kubectl_rollout_undo.md @@ -3,11 +3,12 @@ ## kubectl rollout undo -undoes a previous rollout +Undo a previous rollout ### Synopsis + Rollback to a previous rollout. ``` @@ -17,6 +18,7 @@ kubectl rollout undo (TYPE NAME | TYPE/NAME) [flags] ### Examples ``` + # Rollback to the previous deployment kubectl rollout undo deployment/abc @@ -27,44 +29,43 @@ 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). + -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default []) + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --to-revision int The revision to rollback to. Default to 0 (last revision). ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO -* [kubectl rollout](kubectl_rollout.md) - rollout manages a deployment +* [kubectl rollout](kubectl_rollout.md) - Manage a deployment rollout -###### Auto generated by spf13/cobra on 12-Aug-2016 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_run.md b/docs/user-guide/kubectl/kubectl_run.md index e534a24ac8..eea1dcfb80 100644 --- a/docs/user-guide/kubectl/kubectl_run.md +++ b/docs/user-guide/kubectl/kubectl_run.md @@ -3,11 +3,12 @@ ## kubectl run -Run a particular image on the cluster. +Run a particular image on the cluster ### Synopsis + Create and run a particular image, possibly replicated. Creates a deployment or job to manage the created container(s). @@ -18,6 +19,7 @@ kubectl run NAME --image=image [--env="key=value"] [--port=port] [--replicas=rep ### Examples ``` + # Start a single instance of nginx. kubectl run nginx --image=nginx @@ -47,77 +49,82 @@ kubectl run nginx --image=nginx --command -- ... # Start the perl container to compute π to 2000 places and print it out. kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)' + +# Start the scheduled job to compute π to 2000 places and print it out every 5 minutes. +kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)' ``` ### 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/--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, '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'. 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.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'. 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 - --service-overrides="": An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. Only used if --expose is true. - -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. - -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]. - -t, --tty[=false]: Allocated a TTY for each container in the pod. + --attach 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. With '--restart=Never' the exit code of the container process is returned. + --command 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 If true, only print the object that would be sent, without sending it. + --env value Environment variables to set in the container (default []) + --expose If true, a public, external service is created for the container(s) which are run + --generator string 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 int The host port mapping for the container port. To demonstrate a single-machine container. (default -1) + --image string The image for the container to run. + --image-pull-policy string The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + -l, --labels string Labels to apply to the pod(s). + --leave-stdin-open 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 string 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 When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --overrides string 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 int The port that this container exposes. If --expose is true, this is also the port used by the service that is created. (default -1) + --quiet If true, suppress prompt messages. + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -r, --replicas int Number of replicas to create for this container. Default is 1. (default 1) + --requests string 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 string 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' (default "Always") + --rm If true, delete resources created in this command for attached containers. + --save-config If true, the configuration of current object will be saved in its annotation. This is useful when you want to perform kubectl apply on this object in the future. + --schedule string A schedule in the Cron format the job should be run with. + --service-generator string The name of the generator to use for creating a service. Only used if --expose is true (default "service/v2") + --service-overrides string An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. Only used if --expose is true. + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 Keep stdin open on the container(s) in the pod, even if nothing is attached. + --template string 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]. + -t, --tty 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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_scale.md b/docs/user-guide/kubectl/kubectl_scale.md index 415bcf4871..5f6be05bef 100644 --- a/docs/user-guide/kubectl/kubectl_scale.md +++ b/docs/user-guide/kubectl/kubectl_scale.md @@ -3,11 +3,12 @@ ## kubectl scale -Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job. +Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job ### Synopsis + 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. @@ -22,6 +23,7 @@ kubectl scale [--resource-version=version] [--current-replicas=count] --replicas ### Examples ``` + # Scale a replicaset named 'foo' to 3. kubectl scale --replicas=3 rs/foo @@ -41,50 +43,49 @@ kubectl scale --replicas=3 job/cron ### Options ``` - --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. + --current-replicas int Precondition for current size. Requires that the current size of the resource match this value in order to scale. (default -1) + -f, --filename value Filename, directory, or URL to a file identifying the resource to set a new size (default []) + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + -o, --output string Output mode. Use "-o name" for shorter output (resource/name). + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + --replicas int The new desired number of replicas. Required. (default -1) + --resource-version string Precondition for resource version. Requires that the current resource version match this value in order to scale. + --timeout duration The length of time to wait before giving up on a scale operation, zero means don't wait. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h). ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_set.md b/docs/user-guide/kubectl/kubectl_set.md index 13176582fc..25091604c3 100644 --- a/docs/user-guide/kubectl/kubectl_set.md +++ b/docs/user-guide/kubectl/kubectl_set.md @@ -8,6 +8,7 @@ Set specific features on objects ### Synopsis + Configure application resources These commands help you make changes to existing application resources. @@ -19,29 +20,28 @@ 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging ``` ### SEE ALSO @@ -49,7 +49,7 @@ kubectl set SUBCOMMAND * [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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_set_image.md b/docs/user-guide/kubectl/kubectl_set_image.md index e8e7a0fdb0..58e50e8ecd 100644 --- a/docs/user-guide/kubectl/kubectl_set_image.md +++ b/docs/user-guide/kubectl/kubectl_set_image.md @@ -8,6 +8,7 @@ Update image of a pod template ### Synopsis + Update existing container image(s) of resources. Possible resources include (case insensitive): @@ -20,6 +21,7 @@ kubectl set image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 . ### 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 @@ -36,54 +38,53 @@ 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]. + --all select all resources in the namespace of the specified resource types + -f, --filename value Filename, directory, or URL to a file identifying the resource to get from a server. (default []) + --local If true, set image will NOT contact api-server but run locally. + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --record Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists. + -R, --recursive Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. + -l, --selector string Selector (label query) to filter on + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_taint.md b/docs/user-guide/kubectl/kubectl_taint.md index c54e805c7c..075c5ff252 100644 --- a/docs/user-guide/kubectl/kubectl_taint.md +++ b/docs/user-guide/kubectl/kubectl_taint.md @@ -8,6 +8,7 @@ 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. @@ -23,64 +24,68 @@ kubectl taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_ ### 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. +# If a taint with that key and effect already exists, its value is replaced as specified. kubectl taint nodes foo dedicated=special-user:NoSchedule -# Remove from node 'foo' the taint with key 'dedicated' if one exists. + +# Remove from node 'foo' the taint with key 'dedicated' and effect 'NoSchedule' if one exists. +kubectl taint nodes foo dedicated:NoSchedule- + +# Remove from node 'foo' all the taints with key 'dedicated' kubectl taint nodes foo dedicated- ``` ### 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 + --all select all nodes in the cluster + --include-extended-apis If true, include definitions of new APIs via calls to the API server. [default true] (default true) + --no-headers When using the default or custom-column output format, don't print headers. + -o, --output string Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. + --output-version string Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). + --overwrite If true, allow taints to be overwritten, otherwise reject taint updates that overwrite existing taints. + --schema-cache-dir string If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' (default "~/.kube/schema") + -l, --selector string Selector (label query) to filter on + -a, --show-all When printing, show all resources (default hide terminated pods.) + --show-labels When printing, show all labels as the last column (default hide labels column) + --sort-by string 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 string 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 If true, use a schema to validate the input before sending it (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. - --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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_top-node.md b/docs/user-guide/kubectl/kubectl_top-node.md new file mode 100644 index 0000000000..8005933965 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_top-node.md @@ -0,0 +1,14 @@ +--- +--- + +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_top-node.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_top-pod.md b/docs/user-guide/kubectl/kubectl_top-pod.md new file mode 100644 index 0000000000..329174b0d9 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_top-pod.md @@ -0,0 +1,14 @@ +--- +--- + +This file is autogenerated, but we've stopped checking such files into the +repository to reduce the need for rebases. Please run hack/generate-docs.sh to +populate this file. + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_top-pod.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_top.md b/docs/user-guide/kubectl/kubectl_top.md new file mode 100644 index 0000000000..9864b15425 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_top.md @@ -0,0 +1,61 @@ +--- +--- + +## kubectl top + +Display Resource (CPU/Memory/Storage) usage + +### Synopsis + + + +Display Resource (CPU/Memory/Storage) usage. + +The top command allows you to see the resource consumption for nodes or pods. + +``` +kubectl top +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager +* [kubectl top node](kubectl_top_node.md) - Display Resource (CPU/Memory/Storage) usage of nodes +* [kubectl top pod](kubectl_top_pod.md) - Display Resource (CPU/Memory/Storage) usage of pods + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_top.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_top_node.md b/docs/user-guide/kubectl/kubectl_top_node.md new file mode 100644 index 0000000000..2639e4c0a3 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_top_node.md @@ -0,0 +1,76 @@ +--- +--- + +## kubectl top node + +Display Resource (CPU/Memory/Storage) usage of nodes + +### Synopsis + + + +Display Resource (CPU/Memory/Storage) usage of nodes. + +The top-node command allows you to see the resource consumption of nodes. + +``` +kubectl top node [NAME | -l label] +``` + +### Examples + +``` + +# Show metrics for all nodes +kubectl top node + +# Show metrics for a given node +kubectl top node NODE_NAME +``` + +### Options + +``` + -l, --selector string Selector (label query) to filter on +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl top](kubectl_top.md) - Display Resource (CPU/Memory/Storage) usage + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_top_node.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_top_pod.md b/docs/user-guide/kubectl/kubectl_top_pod.md new file mode 100644 index 0000000000..9adcad5c33 --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_top_pod.md @@ -0,0 +1,87 @@ +--- +--- + +## kubectl top pod + +Display Resource (CPU/Memory/Storage) usage of pods + +### Synopsis + + + +Display Resource (CPU/Memory/Storage) usage of pods. + +The 'top pod' command allows you to see the resource consumption of pods. + +Due to the metrics pipeline delay, they may be unavailable for a few minutes +since pod creation. + +``` +kubectl top pod [NAME | -l label] +``` + +### Examples + +``` + +# Show metrics for all pods in the default namespace +kubectl top pod + +# Show metrics for all pods in the given namespace +kubectl top pod --namespace=NAMESPACE + +# Show metrics for a given pod and its containers +kubectl top pod POD_NAME --containers + +# Show metrics for the pods defined by label name=myLabel +kubectl top pod -l name=myLabel +``` + +### Options + +``` + --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. + --containers If present, print usage of containers within a pod. + -l, --selector string Selector (label query) to filter on +``` + +### Options inherited from parent commands + +``` + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO + +* [kubectl top](kubectl_top.md) - Display Resource (CPU/Memory/Storage) usage + +###### Auto generated by spf13/cobra on 2-Sep-2016 + + + + + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_top_pod.md?pixel)]() + diff --git a/docs/user-guide/kubectl/kubectl_uncordon.md b/docs/user-guide/kubectl/kubectl_uncordon.md index 9c6bc9df6e..107666f946 100644 --- a/docs/user-guide/kubectl/kubectl_uncordon.md +++ b/docs/user-guide/kubectl/kubectl_uncordon.md @@ -8,6 +8,7 @@ Mark node as schedulable ### Synopsis + Mark node as schedulable. @@ -18,6 +19,7 @@ kubectl uncordon NODE ### Examples ``` + # Mark node "foo" as schedulable. $ kubectl uncordon foo @@ -26,36 +28,35 @@ $ kubectl uncordon foo ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/docs/user-guide/kubectl/kubectl_version.md b/docs/user-guide/kubectl/kubectl_version.md index 1392de872a..720ae49a59 100644 --- a/docs/user-guide/kubectl/kubectl_version.md +++ b/docs/user-guide/kubectl/kubectl_version.md @@ -3,12 +3,12 @@ ## kubectl version -Print the client and server version information. +Print the client and server version information ### Synopsis -Print the client and server version information. +Print the client and server version information ``` kubectl version @@ -17,42 +17,41 @@ kubectl version ### Options ``` - --client[=false]: Client version only (no server required). + --client Client version only (no server required). ``` ### 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 + --alsologtostderr value log to standard error as well as files + --as string Username to impersonate for the operation + --certificate-authority string Path to a cert. file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --log-backtrace-at value when logging hits line file:N, emit a stack trace (default :0) + --log-dir value If non-empty, write log files in this directory + --logtostderr value log to standard error instead of files + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --password string Password for basic authentication to the API server + -s, --server string The address and port of the Kubernetes API server + --stderrthreshold value logs at or above this threshold go to stderr (default 2) + --token string Bearer token for authentication to the API server + --user string The name of the kubeconfig user to use + --username string Username for basic authentication to the API server + -v, --v value log level for V logs + --vmodule value 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 +###### Auto generated by spf13/cobra on 2-Sep-2016 diff --git a/federation/docs/api-reference/extensions/v1beta1/definitions.html b/federation/docs/api-reference/extensions/v1beta1/definitions.html new file mode 100755 index 0000000000..0e267b46c2 --- /dev/null +++ b/federation/docs/api-reference/extensions/v1beta1/definitions.html @@ -0,0 +1,4820 @@ + + + + + + +Top Level API Objects + + + + +
    +
    +

    Top Level API Objects

    + +
    +
    +

    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

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    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

    + +
    +
    +

    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/HEAD/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/HEAD/docs/user-guide/labels.md#label-selectors

    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

    + +
    +
    +

    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/HEAD/docs/user-guide/volumes.md#nfs

    true

    string

    path

    Path that is exported by the NFS server. More info: http://releases.k8s.io/HEAD/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/HEAD/docs/user-guide/volumes.md#nfs

    false

    boolean

    false

    + +
    +
    +

    v1beta1.IngressBackend

    +
    +

    IngressBackend describes all endpoints for a given service and port.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    serviceName

    Specifies the name of the referenced service.

    true

    string

    servicePort

    Specifies the port of the referenced service.

    true

    string

    + +
    +
    +

    v1beta1.ReplicaSetList

    +
    +

    ReplicaSetList is a collection of ReplicaSets.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    List of ReplicaSets. More info: http://releases.k8s.io/HEAD/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/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

    true

    string array

    path

    Optional: Used as the mounted root, rather than the full Ceph tree, default is /

    false

    string

    user

    Optional: User is the rados user name, default is admin More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

    false

    string

    secretFile

    Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

    false

    string

    secretRef

    Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

    false

    v1.LocalObjectReference

    readOnly

    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it

    false

    boolean

    false

    + +
    +
    +

    v1.HTTPHeader

    +
    +

    HTTPHeader describes a custom header to be used in HTTP probes

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    The header field name

    true

    string

    value

    The header field value

    true

    string

    + +
    +
    +

    v1.FCVolumeSource

    +
    +

    Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    targetWWNs

    Required: FC target 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.IngressStatus

    +
    +

    IngressStatus describe the current state of the Ingress.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    loadBalancer

    LoadBalancer contains the current status of the load-balancer.

    false

    v1.LoadBalancerStatus

    + +
    +
    +

    v1.DownwardAPIVolumeSource

    +
    +

    DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    items

    Items is a list of downward API volume file

    false

    v1.DownwardAPIVolumeFile array

    defaultMode

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    false

    integer (int32)

    + +
    +
    +

    unversioned.StatusCause

    +
    +

    StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    reason

    A machine-readable description of the cause of the error. If this value is empty there is no information available.

    false

    string

    message

    A human-readable description of the cause of the error. This field may be presented as-is to a reader.

    false

    string

    field

    The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
    +
    +Examples:
    + "name" - the field "name" on the current resource
    + "items[0].name" - the field "name" on the first array entry in "items"

    false

    string

    + +
    +
    +

    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/HEAD/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/HEAD/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/HEAD/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/HEAD/docs/user-guide/volumes.md#gcepersistentdisk

    false

    boolean

    false

    + +
    +
    +

    v1.TCPSocketAction

    +
    +

    TCPSocketAction describes an action based on opening a socket

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    port

    Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    true

    string

    + +
    +
    +

    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.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/HEAD/docs/user-guide/identifiers.md#names

    false

    string

    items

    If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

    false

    v1.KeyToPath array

    defaultMode

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    false

    integer (int32)

    + +
    +
    +

    *versioned.Event

    + +
    +
    +

    unversioned.StatusDetails

    +
    +

    StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

    false

    string

    group

    The group attribute of the resource associated with the status StatusReason.

    false

    string

    kind

    The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    causes

    The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

    false

    unversioned.StatusCause array

    retryAfterSeconds

    If specified, the time in seconds before the operation should be retried.

    false

    integer (int32)

    + +
    +
    +

    v1.GitRepoVolumeSource

    +
    +

    Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    repository

    Repository URL

    true

    string

    revision

    Commit hash for the specified revision.

    false

    string

    directory

    Target directory name. Must not contain or start with ... If . is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

    false

    string

    + +
    +
    +

    v1.HTTPGetAction

    +
    +

    HTTPGetAction describes an action based on HTTP Get requests.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    path

    Path to access on the HTTP server.

    false

    string

    port

    Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

    true

    string

    host

    Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

    false

    string

    scheme

    Scheme to use for connecting to the host. Defaults to HTTP.

    false

    string

    httpHeaders

    Custom headers to set in the request. HTTP allows repeated headers.

    false

    v1.HTTPHeader array

    + +
    +
    +

    v1.Capabilities

    +
    +

    Adds and removes POSIX capabilities from running containers.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    add

    Added capabilities

    false

    v1.Capability array

    drop

    Removed capabilities

    false

    v1.Capability array

    + +
    +
    +

    v1.LocalObjectReference

    +
    +

    LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

    false

    string

    + +
    +
    +

    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/HEAD/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/HEAD/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/HEAD/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/HEAD/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/HEAD/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/HEAD/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/HEAD/docs/user-guide/images.md#updating-images

    false

    string

    securityContext

    Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md

    false

    v1.SecurityContext

    stdin

    Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.

    false

    boolean

    false

    stdinOnce

    Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false

    false

    boolean

    false

    tty

    Whether this container should allocate a TTY for itself, also requires stdin to be true. Default is false.

    false

    boolean

    false

    + +
    +
    +

    v1.PodSecurityContext

    +
    +

    PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    seLinuxOptions

    The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

    false

    v1.SELinuxOptions

    runAsUser

    The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container.

    false

    integer (int64)

    runAsNonRoot

    Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

    false

    boolean

    false

    supplementalGroups

    A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.

    false

    integer (int32) array

    fsGroup

    A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:
    +
    +1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR’d with rw-rw

    false

    integer (int64)

    + +
    +
    +

    v1.ExecAction

    +
    +

    ExecAction describes a "run in container" action.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    command

    Command is the command line to execute inside the container, the working directory for the command is root (/) in the container’s filesystem. The command is simply exec’d, it is not run inside a shell, so traditional shell instructions ('

    ', etc) won’t work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

    false

    string array

    + +
    +
    +

    v1.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/HEAD/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/HEAD/docs/devel/api-conventions.md#idempotency

    false

    string

    namespace

    Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
    +
    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/HEAD/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/HEAD/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/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    generation

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    false

    integer (int64)

    creationTimestamp

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
    +
    +Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionTimestamp

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource 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/HEAD/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionGracePeriodSeconds

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    false

    integer (int64)

    labels

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/HEAD/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/HEAD/docs/user-guide/annotations.md

    false

    object

    ownerReferences

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    false

    v1.OwnerReference array

    finalizers

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

    false

    string array

    clusterName

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    false

    string

    + +
    +
    +

    v1.OwnerReference

    +
    +

    OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    apiVersion

    API version of the referent.

    true

    string

    kind

    Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    true

    string

    name

    Name of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

    true

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/HEAD/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/HEAD/docs/user-guide/replication-controller.md#what-is-a-replication-controller

    true

    integer (int32)

    fullyLabeledReplicas

    The number of pods that have labels matching the labels of the pod template of the replicaset.

    false

    integer (int32)

    readyReplicas

    The number of ready replicas for this replica set.

    false

    integer (int32)

    observedGeneration

    ObservedGeneration reflects the generation of the most recently observed ReplicaSet.

    false

    integer (int64)

    + +
    +
    +

    v1beta1.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/HEAD/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/HEAD/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/HEAD/docs/user-guide/replication-controller.md#pod-template

    false

    v1.PodTemplateSpec

    + +
    +
    +

    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

    + +
    +
    +

    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

    + +
    +
    +

    v1beta1.ReplicaSet

    +
    +

    ReplicaSet represents the configuration of a ReplicaSet.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    Spec defines the specification of the desired behavior of the ReplicaSet. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.ReplicaSetSpec

    status

    Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.ReplicaSetStatus

    + +
    +
    +

    types.UID

    + +
    +
    +

    v1.HostPathVolumeSource

    +
    +

    Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    path

    Path of the directory on the host. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#hostpath

    true

    string

    + +
    +
    +

    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/HEAD/docs/user-guide/volumes.md#iscsi

    false

    string

    readOnly

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

    false

    boolean

    false

    + +
    +
    +

    v1beta1.IngressList

    +
    +

    IngressList is a collection of Ingress.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    false

    unversioned.ListMeta

    items

    Items is the list of Ingress.

    true

    v1beta1.Ingress array

    + +
    +
    +

    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/HEAD/docs/user-guide/volumes.md#emptydir

    false

    string

    + +
    +
    +

    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.CinderVolumeSource

    +
    +

    Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    volumeID

    volume id used to identify the volume in cinder More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

    true

    string

    fsType

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

    false

    string

    readOnly

    Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: http://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md

    false

    boolean

    false

    + +
    +
    +

    v1.SecurityContext

    +
    +

    SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    capabilities

    The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime.

    false

    v1.Capabilities

    privileged

    Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.

    false

    boolean

    false

    seLinuxOptions

    The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

    false

    v1.SELinuxOptions

    runAsUser

    The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

    false

    integer (int64)

    runAsNonRoot

    Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

    false

    boolean

    false

    readOnlyRootFilesystem

    Whether this container has a read-only root filesystem. Default is false.

    false

    boolean

    false

    + +
    +
    +

    v1.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/HEAD/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/HEAD/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/HEAD/docs/user-guide/volumes.md#awselasticblockstore

    false

    boolean

    false

    + +
    +
    +

    v1.PersistentVolumeClaimVolumeSource

    +
    +

    PersistentVolumeClaimVolumeSource references the user’s PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    claimName

    ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: http://releases.k8s.io/HEAD/docs/user-guide/persistent-volumes.md#persistentvolumeclaims

    true

    string

    readOnly

    Will force the ReadOnly setting in VolumeMounts. Default false.

    false

    boolean

    false

    + +
    +
    +

    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

    + +
    +
    +

    unversioned.ListMeta

    +
    +

    ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    resourceVersion

    String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    + +
    +
    +

    v1.QuobyteVolumeSource

    +
    +

    Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    registry

    Registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

    true

    string

    volume

    Volume is a string that references an already created Quobyte volume by name.

    true

    string

    readOnly

    ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

    false

    boolean

    false

    user

    User to map volume access to Defaults to serivceaccount user

    false

    string

    group

    Group to map volume access to Default is no group

    false

    string

    + +
    +
    +

    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.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/HEAD/docs/user-guide/volumes.md#secrets

    false

    string

    items

    If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error. Paths must be relative and may not contain the .. path or start with ...

    false

    v1.KeyToPath array

    defaultMode

    Optional: mode bits to use on created files by default. Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    false

    integer (int32)

    + +
    +
    +

    v1.ResourceRequirements

    +
    +

    ResourceRequirements describes the compute resource requirements.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    limits

    Limits describes the maximum amount of compute resources allowed. More info: http://kubernetes.io/docs/user-guide/compute-resources/

    false

    object

    requests

    Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: http://kubernetes.io/docs/user-guide/compute-resources/

    false

    object

    + +
    +
    +

    v1.EnvVarSource

    +
    +

    EnvVarSource represents a source for the value of an EnvVar.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    fieldRef

    Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, status.podIP.

    false

    v1.ObjectFieldSelector

    resourceFieldRef

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

    false

    v1.ResourceFieldSelector

    configMapKeyRef

    Selects a key of a ConfigMap.

    false

    v1.ConfigMapKeySelector

    secretKeyRef

    Selects a key of a secret in the pod’s namespace

    false

    v1.SecretKeySelector

    + +
    +
    +

    v1.FlexVolumeSource

    +
    +

    FlexVolume represents a generic volume resource that is provisioned/attached using 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.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.PodTemplateSpec

    +
    +

    PodTemplateSpec describes the data a pod should have when created from a template

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    Specification of the desired behavior of the pod. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    v1.PodSpec

    + +
    +
    +

    v1.AzureDiskVolumeSource

    +
    +

    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    diskName

    The Name of the data disk in the blob storage

    true

    string

    diskURI

    The URI the data disk in the blob storage

    true

    string

    cachingMode

    Host Caching mode: None, Read Only, Read Write.

    false

    v1.AzureDataDiskCachingMode

    fsType

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    false

    string

    readOnly

    Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

    false

    boolean

    false

    + +
    +
    +

    v1.KeyToPath

    +
    +

    Maps a string key to a path within a volume.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    key

    The key to project.

    true

    string

    path

    The relative path of the file to map the key to. May not be an absolute path. May not contain the path element ... May not start with the string ...

    true

    string

    mode

    Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    false

    integer (int32)

    + +
    +
    +

    v1.VsphereVirtualDiskVolumeSource

    +
    +

    Represents a vSphere volume resource.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    volumePath

    Path that identifies vSphere volume vmdk

    true

    string

    fsType

    Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

    false

    string

    + +
    +
    +

    v1.DeleteOptions

    +
    +

    DeleteOptions may be provided when deleting an API object

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    gracePeriodSeconds

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    false

    integer (int64)

    preconditions

    Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

    false

    v1.Preconditions

    orphanDependents

    Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

    false

    boolean

    false

    + +
    +
    +

    v1.Volume

    +
    +

    Volume represents a named volume in a pod that may be accessed by any container in the pod.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Volume’s name. Must be a DNS_LABEL and unique within the pod. More info: http://releases.k8s.io/HEAD/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/HEAD/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/HEAD/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/HEAD/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/HEAD/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/HEAD/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/HEAD/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/HEAD/examples/volumes/iscsi/README.md

    false

    v1.ISCSIVolumeSource

    glusterfs

    Glusterfs represents a Glusterfs mount on the host that shares a pod’s lifetime. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md

    false

    v1.GlusterfsVolumeSource

    persistentVolumeClaim

    PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: http://releases.k8s.io/HEAD/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/HEAD/examples/volumes/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/HEAD/examples/mysql-cinder-pd/README.md

    false

    v1.CinderVolumeSource

    cephfs

    CephFS represents a Ceph FS mount on the host that shares a pod’s lifetime

    false

    v1.CephFSVolumeSource

    flocker

    Flocker represents a Flocker volume attached to a kubelet’s host machine. This depends on the Flocker control service being running

    false

    v1.FlockerVolumeSource

    downwardAPI

    DownwardAPI represents downward API about the pod that should populate this volume

    false

    v1.DownwardAPIVolumeSource

    fc

    FC represents a Fibre Channel resource that is attached to a kubelet’s host machine and then exposed to the pod.

    false

    v1.FCVolumeSource

    azureFile

    AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

    false

    v1.AzureFileVolumeSource

    configMap

    ConfigMap represents a configMap that should populate this volume

    false

    v1.ConfigMapVolumeSource

    vsphereVolume

    VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

    false

    v1.VsphereVirtualDiskVolumeSource

    quobyte

    Quobyte represents a Quobyte mount on the host that shares a pod’s lifetime

    false

    v1.QuobyteVolumeSource

    azureDisk

    AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

    false

    v1.AzureDiskVolumeSource

    + +
    +
    +

    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/HEAD/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/HEAD/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/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    groupVersion

    groupVersion is the group and version this APIResourceList is for.

    true

    string

    resources

    resources contains the name of the resources and if they are namespaced.

    true

    unversioned.APIResource array

    + +
    +
    +

    v1.SecretKeySelector

    +
    +

    SecretKeySelector selects a key of a Secret.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name of the referent. More info: http://releases.k8s.io/HEAD/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.Status

    +
    +

    Status is a return value for calls that don’t return other objects.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    status

    Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    string

    message

    A human-readable description of the status of this operation.

    false

    string

    reason

    A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

    false

    string

    details

    Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

    false

    unversioned.StatusDetails

    code

    Suggested HTTP return code for this status, 0 if not set.

    false

    integer (int32)

    + +
    +
    +

    unversioned.APIResource

    +
    +

    APIResource specifies the name of a resource and whether it is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    name is the name of the resource.

    true

    string

    namespaced

    namespaced indicates if a resource is namespaced or not.

    true

    boolean

    false

    kind

    kind is the kind for the resource (e.g. Foo is the kind for a resource foo)

    true

    string

    + +
    +
    +

    v1.DownwardAPIVolumeFile

    +
    +

    DownwardAPIVolumeFile represents information to create the file containing the pod field

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    path

    Required: Path is the relative path name of the file to be created. Must not be absolute or contain the .. path. Must be utf-8 encoded. The first item of the relative path must not start with ..

    true

    string

    fieldRef

    Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

    false

    v1.ObjectFieldSelector

    resourceFieldRef

    Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

    false

    v1.ResourceFieldSelector

    mode

    Optional: mode bits to use on this file, must be a value between 0 and 0777. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

    false

    integer (int32)

    + +
    +
    +

    v1.ContainerPort

    +
    +

    ContainerPort represents a network port in a single container.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

    false

    string

    hostPort

    Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

    false

    integer (int32)

    containerPort

    Number of port to expose on the pod’s IP address. This must be a valid port number, 0 < x < 65536.

    true

    integer (int32)

    protocol

    Protocol for port. Must be UDP or TCP. Defaults to "TCP".

    false

    string

    hostIP

    What host IP to bind the external port to.

    false

    string

    + +
    +
    +

    v1.PodSpec

    +
    +

    PodSpec is a description of a pod.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    volumes

    List of volumes that can be mounted by containers belonging to the pod. More info: http://releases.k8s.io/HEAD/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/HEAD/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/HEAD/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/HEAD/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/HEAD/docs/design/service_accounts.md

    false

    string

    serviceAccount

    DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.

    false

    string

    nodeName

    NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.

    false

    string

    hostNetwork

    Host networking requested for this pod. Use the host’s network namespace. If this option is set, the ports that will be used must be specified. Default to false.

    false

    boolean

    false

    hostPID

    Use the host’s pid namespace. Optional: Default to false.

    false

    boolean

    false

    hostIPC

    Use the host’s ipc namespace. Optional: Default to false.

    false

    boolean

    false

    securityContext

    SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

    false

    v1.PodSecurityContext

    imagePullSecrets

    ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: http://releases.k8s.io/HEAD/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/HEAD/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/HEAD/docs/user-guide/container-environment.md#hook-details

    false

    v1.Handler

    + +
    +
    +

    v1.ConfigMapKeySelector

    +
    +

    Selects a key from a ConfigMap.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    Name of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

    false

    string

    key

    The key to select.

    true

    string

    + +
    +
    +

    v1.Handler

    +
    +

    Handler defines a specific action that should be taken

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    exec

    One and only one of the following should be specified. Exec specifies the action to take.

    false

    v1.ExecAction

    httpGet

    HTTPGet specifies the http request to perform.

    false

    v1.HTTPGetAction

    tcpSocket

    TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported

    false

    v1.TCPSocketAction

    + +
    +
    +

    v1.GlusterfsVolumeSource

    +
    +

    Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    endpoints

    EndpointsName is the endpoint name that details Glusterfs topology. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

    true

    string

    path

    Path is the Glusterfs volume path. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

    true

    string

    readOnly

    ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod

    false

    boolean

    false

    + +
    +
    +

    v1beta1.HTTPIngressPath

    +
    +

    HTTPIngressPath associates a path regex with a backend. Incoming urls matching the path are forwarded to the backend.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    path

    Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a /. If unspecified, the path defaults to a catch all sending traffic to the backend.

    false

    string

    backend

    Backend defines the referenced service endpoint to which the traffic will be forwarded to.

    true

    v1beta1.IngressBackend

    + +
    +
    +

    v1beta1.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.Ingress

    +
    +

    Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    Spec is the desired state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.IngressSpec

    status

    Status is the current state of the Ingress. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    v1beta1.IngressStatus

    + +
    +
    +

    v1beta1.Scale

    +
    +

    represents a scaling request for a resource.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object metadata; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata.

    false

    v1.ObjectMeta

    spec

    defines the behavior of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status.

    false

    v1beta1.ScaleSpec

    status

    current status of the scale. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status. Read-only.

    false

    v1beta1.ScaleStatus

    + +
    +
    +

    v1.AzureDataDiskCachingMode

    + +
    +
    +

    v1.RBDVolumeSource

    +
    +

    Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    monitors

    A collection of Ceph monitors. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

    true

    string array

    image

    The rados image name. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

    true

    string

    fsType

    Filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: http://releases.k8s.io/HEAD/docs/user-guide/volumes.md#rbd

    false

    string

    pool

    The rados pool name. Default is rbd. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it.

    false

    string

    user

    The rados user name. Default is admin. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

    false

    string

    keyring

    Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

    false

    string

    secretRef

    SecretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

    false

    v1.LocalObjectReference

    readOnly

    ReadOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: http://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it

    false

    boolean

    false

    + +
    +
    +

    any

    +
    +

    Represents an untyped JSON map - see the description of the field for more info about the structure of this object.

    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/federation/docs/api-reference/extensions/v1beta1/operations.html b/federation/docs/api-reference/extensions/v1beta1/operations.html new file mode 100755 index 0000000000..2c5c8326f9 --- /dev/null +++ b/federation/docs/api-reference/extensions/v1beta1/operations.html @@ -0,0 +1,4687 @@ + + + + + + +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 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 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 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

      +
    • +
    +
    +
    +
    +
    +

    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

      +
    • +
    +
    +
    +
    +
    +

    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 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 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 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

      +
    • +
    +
    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/federation/docs/api-reference/federation/v1beta1/definitions.html b/federation/docs/api-reference/federation/v1beta1/definitions.html new file mode 100755 index 0000000000..d9cb146985 --- /dev/null +++ b/federation/docs/api-reference/federation/v1beta1/definitions.html @@ -0,0 +1,1409 @@ + + + + + + +Top Level API Objects + + + + +
    +
    +

    Top Level API Objects

    + +
    +
    +

    Definitions

    +
    +
    +

    unversioned.Patch

    +
    +

    Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

    +
    +
    +
    +

    v1.DeleteOptions

    +
    +

    DeleteOptions may be provided when deleting an API object

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    gracePeriodSeconds

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    false

    integer (int64)

    preconditions

    Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

    false

    v1.Preconditions

    orphanDependents

    Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

    false

    boolean

    false

    + +
    +
    +

    v1beta1.ServerAddressByClientCIDR

    +
    +

    ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    clientCIDR

    The CIDR with which clients can match their IP to figure out the server address that they should use.

    true

    string

    serverAddress

    Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.

    true

    string

    + +
    +
    +

    *versioned.Event

    + +
    +
    +

    v1beta1.ClusterList

    +
    +

    A list of all the kubernetes clusters registered to the federation

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    List of Cluster objects.

    true

    v1beta1.Cluster array

    + +
    +
    +

    unversioned.StatusDetails

    +
    +

    StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

    false

    string

    group

    The group attribute of the resource associated with the status StatusReason.

    false

    string

    kind

    The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    causes

    The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

    false

    unversioned.StatusCause array

    retryAfterSeconds

    If specified, the time in seconds before the operation should be retried.

    false

    integer (int32)

    + +
    +
    +

    unversioned.ListMeta

    +
    +

    ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    resourceVersion

    String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    + +
    +
    +

    v1beta1.ClusterStatus

    +
    +

    ClusterStatus is information about the current status of a cluster updated by cluster controller peridocally.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    conditions

    Conditions is an array of current cluster conditions.

    false

    v1beta1.ClusterCondition array

    zones

    Zones is the list of avaliability zones in which the nodes of the cluster exist, e.g. us-east1-a. These will always be in the same region.

    false

    string array

    region

    Region is the name of the region in which all of the nodes in the cluster exist. e.g. us-east1.

    false

    string

    + +
    +
    +

    v1.Preconditions

    +
    +

    Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    uid

    Specifies the target UID.

    false

    types.UID

    + +
    +
    +

    v1.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/HEAD/docs/user-guide/identifiers.md#names

    false

    string

    + +
    +
    +

    unversioned.APIResourceList

    +
    +

    APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    groupVersion

    groupVersion is the group and version this APIResourceList is for.

    true

    string

    resources

    resources contains the name of the resources and if they are namespaced.

    true

    unversioned.APIResource array

    + +
    +
    +

    v1beta1.ClusterSpec

    +
    +

    ClusterSpec describes the attributes of a kubernetes cluster.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    serverAddressByClientCIDRs

    A map of client CIDR to server address. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR.

    true

    v1beta1.ServerAddressByClientCIDR array

    secretRef

    Name of the secret containing kubeconfig to access this cluster. The secret is read from the kubernetes cluster that is hosting federation control plane. Admin needs to ensure that the required secret exists. Secret should be in the same namespace where federation control plane is hosted and it should have kubeconfig in its data with key "kubeconfig". This will later be changed to a reference to secret in federation control plane when the federation control plane supports secrets. This can be left empty if the cluster allows insecure access.

    false

    v1.LocalObjectReference

    + +
    +
    +

    unversioned.Status

    +
    +

    Status is a return value for calls that don’t return other objects.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    status

    Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    string

    message

    A human-readable description of the status of this operation.

    false

    string

    reason

    A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

    false

    string

    details

    Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

    false

    unversioned.StatusDetails

    code

    Suggested HTTP return code for this status, 0 if not set.

    false

    integer (int32)

    + +
    +
    +

    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.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/HEAD/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/HEAD/docs/devel/api-conventions.md#idempotency

    false

    string

    namespace

    Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
    +
    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/HEAD/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/HEAD/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/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    generation

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    false

    integer (int64)

    creationTimestamp

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
    +
    +Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionTimestamp

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource 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/HEAD/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionGracePeriodSeconds

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    false

    integer (int64)

    labels

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/HEAD/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/HEAD/docs/user-guide/annotations.md

    false

    object

    ownerReferences

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    false

    v1.OwnerReference array

    finalizers

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

    false

    string array

    clusterName

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    false

    string

    + +
    +
    +

    v1.OwnerReference

    +
    +

    OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    apiVersion

    API version of the referent.

    true

    string

    kind

    Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    true

    string

    name

    Name of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

    true

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids

    true

    string

    controller

    If true, this reference points to the managing controller.

    false

    boolean

    false

    + +
    +
    +

    v1beta1.ClusterCondition

    +
    +

    ClusterCondition describes current state of a cluster.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    type

    Type of cluster condition, Complete or Failed.

    true

    string

    status

    Status of the condition, one of True, False, Unknown.

    true

    string

    lastProbeTime

    Last time the condition was checked.

    false

    string (date-time)

    lastTransitionTime

    Last time the condition transit from one status to another.

    false

    string (date-time)

    reason

    (brief) reason for the condition’s last transition.

    false

    string

    message

    Human readable message indicating details about last transition.

    false

    string

    + +
    +
    +

    types.UID

    + +
    +
    +

    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.Cluster

    +
    +

    Information about a registered cluster in a federated kubernetes setup. Clusters are not namespaced and have unique names in the federation.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    Spec defines the behavior of the Cluster.

    false

    v1beta1.ClusterSpec

    status

    Status describes the current status of a Cluster

    false

    v1beta1.ClusterStatus

    + +
    +
    +

    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/federation/docs/api-reference/federation/v1beta1/operations.html b/federation/docs/api-reference/federation/v1beta1/operations.html new file mode 100755 index 0000000000..ebd75421a2 --- /dev/null +++ b/federation/docs/api-reference/federation/v1beta1/operations.html @@ -0,0 +1,1760 @@ + + + + + + +Operations + + + + +
    +
    +

    Operations

    +
    +
    +

    get available resources

    +
    +
    +
    GET /apis/federation/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

    +
    +
      +
    • +

      apisfederationv1beta1

      +
    • +
    +
    +
    +
    +
    +

    list or watch objects of kind Cluster

    +
    +
    +
    GET /apis/federation/v1beta1/clusters
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version 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.ClusterList

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
    • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

      +
    • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisfederationv1beta1

      +
    • +
    +
    +
    +
    +
    +

    delete collection of Cluster

    +
    +
    +
    DELETE /apis/federation/v1beta1/clusters
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version 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

    +
    +
      +
    • +

      apisfederationv1beta1

      +
    • +
    +
    +
    +
    +
    +

    create a Cluster

    +
    +
    +
    POST /apis/federation/v1beta1/clusters
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1beta1.Cluster

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.Cluster

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
    • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

      +
    • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisfederationv1beta1

      +
    • +
    +
    +
    +
    +
    +

    read the specified Cluster

    +
    +
    +
    GET /apis/federation/v1beta1/clusters/{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 Cluster

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.Cluster

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
    • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

      +
    • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisfederationv1beta1

      +
    • +
    +
    +
    +
    +
    +

    replace the specified Cluster

    +
    +
    +
    PUT /apis/federation/v1beta1/clusters/{name}
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1beta1.Cluster

    PathParameter

    name

    name of the Cluster

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.Cluster

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
    • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

      +
    • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisfederationv1beta1

      +
    • +
    +
    +
    +
    +
    +

    delete a Cluster

    +
    +
    +
    DELETE /apis/federation/v1beta1/clusters/{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 Cluster

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    unversioned.Status

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
    • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

      +
    • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisfederationv1beta1

      +
    • +
    +
    +
    +
    +
    +

    partially update the specified Cluster

    +
    +
    +
    PATCH /apis/federation/v1beta1/clusters/{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 Cluster

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.Cluster

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      application/json-patch+json

      +
    • +
    • +

      application/merge-patch+json

      +
    • +
    • +

      application/strategic-merge-patch+json

      +
    • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

      +
    • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisfederationv1beta1

      +
    • +
    +
    +
    +
    +
    +

    replace status of the specified Cluster

    +
    +
    +
    PUT /apis/federation/v1beta1/clusters/{name}/status
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    BodyParameter

    body

    true

    v1beta1.Cluster

    PathParameter

    name

    name of the Cluster

    true

    string

    + +
    +
    +

    Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    success

    v1beta1.Cluster

    + +
    +
    +

    Consumes

    +
    +
      +
    • +

      /

      +
    • +
    +
    +
    +
    +

    Produces

    +
    +
      +
    • +

      application/json

      +
    • +
    • +

      application/yaml

      +
    • +
    • +

      application/vnd.kubernetes.protobuf

      +
    • +
    +
    +
    +
    +

    Tags

    +
    +
      +
    • +

      apisfederationv1beta1

      +
    • +
    +
    +
    +
    +
    +

    watch individual changes to a list of Cluster

    +
    +
    +
    GET /apis/federation/v1beta1/watch/clusters
    +
    +
    +
    +

    Parameters

    + ++++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    TypeNameDescriptionRequiredSchemaDefault

    QueryParameter

    pretty

    If true, then the output is pretty printed.

    false

    string

    QueryParameter

    labelSelector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

    false

    string

    QueryParameter

    fieldSelector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

    false

    string

    QueryParameter

    watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

    false

    boolean

    QueryParameter

    resourceVersion

    When specified with a watch call, shows changes that occur after that particular version 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

    +
    +
      +
    • +

      apisfederationv1beta1

      +
    • +
    +
    +
    +
    +
    +

    watch changes to an object of kind Cluster

    +
    +
    +
    GET /apis/federation/v1beta1/watch/clusters/{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 Cluster

    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

    +
    +
      +
    • +

      apisfederationv1beta1

      +
    • +
    +
    +
    +
    +
    +
    +
    + + + \ No newline at end of file diff --git a/federation/docs/api-reference/v1/definitions.html b/federation/docs/api-reference/v1/definitions.html new file mode 100755 index 0000000000..d186234b52 --- /dev/null +++ b/federation/docs/api-reference/v1/definitions.html @@ -0,0 +1,2054 @@ + + + + + + +Top Level API Objects + + + + +
    +
    +

    Top Level API Objects

    + +
    +
    +

    Definitions

    +
    +
    +

    unversioned.Patch

    +
    +

    Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

    +
    +
    +
    +

    v1.NamespaceList

    +
    +

    NamespaceList is a list of Namespaces.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    Items is the list of Namespace objects in the list. More info: http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

    true

    v1.Namespace array

    + +
    +
    +

    v1.Namespace

    +
    +

    Namespace provides a scope for Names. Use of multiple namespaces is optional.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    Spec defines the behavior of the Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    v1.NamespaceSpec

    status

    Status describes the current status of a Namespace. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    v1.NamespaceStatus

    + +
    +
    +

    unversioned.ListMeta

    +
    +

    ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    selfLink

    SelfLink is a URL representing this object. Populated by the system. Read-only.

    false

    string

    resourceVersion

    String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    + +
    +
    +

    v1.Preconditions

    +
    +

    Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    uid

    Specifies the target UID.

    false

    types.UID

    + +
    +
    +

    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.Secret

    +
    +

    Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    data

    Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4

    false

    object

    stringData

    stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.

    false

    object

    type

    Used to facilitate programmatic handling of secret data.

    false

    string

    + +
    +
    +

    v1.Event

    +
    +

    Event is a report of an event somewhere in the cluster.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    true

    v1.ObjectMeta

    involvedObject

    The object that this event is about.

    true

    v1.ObjectReference

    reason

    This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.

    false

    string

    message

    A human-readable description of the status of this operation.

    false

    string

    source

    The component reporting this event. Should be a short machine understandable string.

    false

    v1.EventSource

    firstTimestamp

    The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)

    false

    string (date-time)

    lastTimestamp

    The time at which the most recent occurrence of this event was recorded.

    false

    string (date-time)

    count

    The number of times this event has occurred.

    false

    integer (int32)

    type

    Type of this event (Normal, Warning), new types could be added in the future

    false

    string

    + +
    +
    +

    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.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.NamespaceStatus

    +
    +

    NamespaceStatus is information about the current status of a Namespace.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    phase

    Phase is the current lifecycle phase of the namespace. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases

    false

    string

    + +
    +
    +

    v1.NamespaceSpec

    +
    +

    NamespaceSpec describes the attributes on a Namespace.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    finalizers

    Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers

    false

    v1.FinalizerName array

    + +
    +
    +

    v1.ServiceList

    +
    +

    ServiceList holds a list of services.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    List of services

    true

    v1.Service array

    + +
    +
    +

    v1.Service

    +
    +

    Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    false

    v1.ObjectMeta

    spec

    Spec defines the behavior of a service. http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    v1.ServiceSpec

    status

    Most recently observed status of the service. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    v1.ServiceStatus

    + +
    +
    +

    v1.DeleteOptions

    +
    +

    DeleteOptions may be provided when deleting an API object

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    gracePeriodSeconds

    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

    false

    integer (int64)

    preconditions

    Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.

    false

    v1.Preconditions

    orphanDependents

    Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.

    false

    boolean

    false

    + +
    +
    +

    *versioned.Event

    + +
    +
    +

    unversioned.StatusDetails

    +
    +

    StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    name

    The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).

    false

    string

    group

    The group attribute of the resource associated with the status StatusReason.

    false

    string

    kind

    The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    causes

    The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.

    false

    unversioned.StatusCause array

    retryAfterSeconds

    If specified, the time in seconds before the operation should be retried.

    false

    integer (int32)

    + +
    +
    +

    v1.ObjectReference

    +
    +

    ObjectReference contains enough information to let you inspect or modify the referred object.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    namespace

    Namespace of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/namespaces.md

    false

    string

    name

    Name of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

    false

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/HEAD/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/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    fieldPath

    If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

    false

    string

    + +
    +
    +

    unversioned.APIResourceList

    +
    +

    APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    groupVersion

    groupVersion is the group and version this APIResourceList is for.

    true

    string

    resources

    resources contains the name of the resources and if they are namespaced.

    true

    unversioned.APIResource array

    + +
    +
    +

    v1.LoadBalancerStatus

    +
    +

    LoadBalancerStatus represents the status of a load-balancer.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    ingress

    Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

    false

    v1.LoadBalancerIngress array

    + +
    +
    +

    v1.SecretList

    +
    +

    SecretList is a list of Secret.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    Items is a list of secret objects. More info: http://releases.k8s.io/HEAD/docs/user-guide/secrets.md

    true

    v1.Secret array

    + +
    +
    +

    unversioned.Status

    +
    +

    Status is a return value for calls that don’t return other objects.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    status

    Status of the operation. One of: "Success" or "Failure". More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status

    false

    string

    message

    A human-readable description of the status of this operation.

    false

    string

    reason

    A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.

    false

    string

    details

    Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.

    false

    unversioned.StatusDetails

    code

    Suggested HTTP return code for this status, 0 if not set.

    false

    integer (int32)

    + +
    +
    +

    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.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/HEAD/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/HEAD/docs/user-guide/services.md#type—nodeport

    false

    integer (int32)

    + +
    +
    +

    v1.OwnerReference

    +
    +

    OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    apiVersion

    API version of the referent.

    true

    string

    kind

    Kind of the referent. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    true

    string

    name

    Name of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#names

    true

    string

    uid

    UID of the referent. More info: http://releases.k8s.io/HEAD/docs/user-guide/identifiers.md#uids

    true

    string

    controller

    If true, this reference points to the managing controller.

    false

    boolean

    false

    + +
    +
    +

    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/HEAD/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/HEAD/docs/devel/api-conventions.md#idempotency

    false

    string

    namespace

    Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
    +
    +Must be a DNS_LABEL. Cannot be updated. More info: http://releases.k8s.io/HEAD/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/HEAD/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/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency

    false

    string

    generation

    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

    false

    integer (int64)

    creationTimestamp

    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
    +
    +Populated by the system. Read-only. Null for lists. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionTimestamp

    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource 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/HEAD/docs/devel/api-conventions.md#metadata

    false

    string (date-time)

    deletionGracePeriodSeconds

    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

    false

    integer (int64)

    labels

    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://releases.k8s.io/HEAD/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/HEAD/docs/user-guide/annotations.md

    false

    object

    ownerReferences

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    false

    v1.OwnerReference array

    finalizers

    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

    false

    string array

    clusterName

    The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.

    false

    string

    + +
    +
    +

    v1.EventList

    +
    +

    EventList is a list of events.

    +
    + +++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionRequiredSchemaDefault

    kind

    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    string

    apiVersion

    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources

    false

    string

    metadata

    Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds

    false

    unversioned.ListMeta

    items

    List of events

    true

    v1.Event array

    + +
    +
    +

    v1.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/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies

    true

    v1.ServicePort array

    selector

    Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview

    false

    object

    clusterIP

    clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#virtual-ips-and-service-proxies

    false

    string

    type

    type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: http://releases.k8s.io/HEAD/docs/user-guide/services.md#overview

    false

    string

    externalIPs

    externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field.

    false

    string array

    deprecatedPublicIPs

    deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs and externalIPs are set, deprecatedPublicIPs is used.

    false

    string array

    sessionAffinity

    Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: http://releases.k8s.io/HEAD/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/HEAD/docs/user-guide/services-firewalls.md

    false

    string array

    externalName

    externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName.

    false

    string

    + +
    +
    +

    v1.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

    + +
    +
    +

    types.UID

    + +
    +
    +

    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/federation/docs/api-reference/v1/operations.html b/federation/docs/api-reference/v1/operations.html new file mode 100755 index 0000000000..8a6684c5d5 --- /dev/null +++ b/federation/docs/api-reference/v1/operations.html @@ -0,0 +1,7019 @@ + + + + + + +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 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 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

      +
    • +
    +
    +
    +
    +
    +

    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 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 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

      +
    • +
    +
    +
    +
    +
    +

    delete collection of Service

    +
    +
    +
    DELETE /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

    unversioned.Status

    + +
    +
    +

    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

    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 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

      +
    • +
    +
    +
    +
    +
    +

    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

      +
    • +
    +
    +
    +
    +
    +

    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 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 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 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 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 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 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 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 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 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 From 5f8a92fb2c76a184312bd3704cfb5d974afb3d61 Mon Sep 17 00:00:00 2001 From: Yifan Gu Date: Fri, 26 Aug 2016 15:08:19 -0700 Subject: [PATCH 019/115] docs/rkt: Update known issues for rktnetes for 1.4 release. --- docs/getting-started-guides/rkt/index.md | 4 ++-- docs/getting-started-guides/rkt/notes.md | 8 ++++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/getting-started-guides/rkt/index.md b/docs/getting-started-guides/rkt/index.md index e13ec90010..cc1743024f 100644 --- a/docs/getting-started-guides/rkt/index.md +++ b/docs/getting-started-guides/rkt/index.md @@ -14,7 +14,7 @@ This document describes how to run Kubernetes using [rkt](https://github.com/cor * [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. -* [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. +* [Install the latest rkt release](https://coreos.com/rkt/docs/latest/trying-out-rkt.html). The minimum rkt version required is [v1.13.0](https://github.com/coreos/rkt/releases/tag/v1.13.0). 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. * The [rkt API service](https://coreos.com/rkt/docs/latest/subcommands/api-service.html) must be running on the node. @@ -129,7 +129,7 @@ $ export KUBE_CONTAINER_RUNTIME=rkt Optionally, set the version of rkt by setting `KUBE_RKT_VERSION`: ```shell -$ export KUBE_RKT_VERSION=1.9.1 +$ export KUBE_RKT_VERSION=1.13.0 ``` Optionally, select an alternative [stage1 isolator](#modular-isolation-with-interchangeable-stage1-images) for the container runtime by setting `KUBE_RKT_STAGE1_IMAGE`: diff --git a/docs/getting-started-guides/rkt/notes.md b/docs/getting-started-guides/rkt/notes.md index 658d5de2a9..28a622d2ab 100644 --- a/docs/getting-started-guides/rkt/notes.md +++ b/docs/getting-started-guides/rkt/notes.md @@ -34,6 +34,8 @@ spec: name: does-not-exist ``` +Also note that if `subPath` is specified in the container's volumeMounts and the `subPath` doesn't exist in the corresponding volume, the pod execution will fail as well. + ## Kubectl attach The `kubectl attach` command does not work under the rkt container runtime. @@ -97,6 +99,8 @@ On the other hand, when running the pod with [stage1-fly](https://coreos.com/rkt Patching a pod to change the image will result in the entire pod restarting, not just the container that was changed. -## Volume mounts specifying a subPath +## ImagePullPolicy 'Always' -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. +When the container's image pull policy is `Always`, rkt will always pull the image from remote even if the image has not changed at all. +This can add significant latency for large images. +The issue is tracked by rkt upstream at [#2937](https://github.com/coreos/rkt/issues/2937). From c5005ed013c78a7adcede4849110ac20ba22fcb7 Mon Sep 17 00:00:00 2001 From: Johannes Scheuermann Date: Fri, 19 Aug 2016 22:18:35 +0200 Subject: [PATCH 020/115] Add Quobyte volumes in docs --- docs/user-guide/volumes.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/user-guide/volumes.md b/docs/user-guide/volumes.md index d118e4e950..d1f4d92fd0 100644 --- a/docs/user-guide/volumes.md +++ b/docs/user-guide/volumes.md @@ -77,6 +77,7 @@ Kubernetes supports several types of Volumes: * `downwardAPI` * `azureFileVolume` * `vsphereVolume` + * `Quobyte` We welcome additional contributions. @@ -483,6 +484,15 @@ spec: fsType: ext4 ``` +### Quobyte + +A `Quobyte` volume allows an existing [Quobyte](http://www.quobyte.com) volume to be mounted into your pod. + +__Important: You must have your own Quobyte setup running with the volumes created +before you can use it__ + +See the [Quobyte example](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/volumes/quobyte) for more details. + ## Resources The storage media (Disk, SSD, etc) of an `emptyDir` volume is determined by the From 038ece1a705587c57f55aec0456375b0db2f3642 Mon Sep 17 00:00:00 2001 From: Johannes Scheuermann Date: Mon, 5 Sep 2016 13:33:41 +0200 Subject: [PATCH 021/115] Add ScheduledJob to validation --- test/examples_test.go | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/test/examples_test.go b/test/examples_test.go index a2485ac0c2..b282c8b971 100644 --- a/test/examples_test.go +++ b/test/examples_test.go @@ -29,6 +29,7 @@ import ( "k8s.io/kubernetes/pkg/api/testapi" "k8s.io/kubernetes/pkg/api/validation" "k8s.io/kubernetes/pkg/apis/batch" + batch_validation "k8s.io/kubernetes/pkg/apis/batch/validation" "k8s.io/kubernetes/pkg/apis/extensions" expvalidation "k8s.io/kubernetes/pkg/apis/extensions/validation" "k8s.io/kubernetes/pkg/capabilities" @@ -126,6 +127,11 @@ func validateObject(obj runtime.Object) (errors field.ErrorList) { t.Namespace = api.NamespaceDefault } errors = expvalidation.ValidateDaemonSet(t) + case *batch.ScheduledJob: + if t.Namespace == "" { + t.Namespace = api.NamespaceDefault + } + errors = batch_validation.ValidateScheduledJob(t) default: errors = field.ErrorList{} errors = append(errors, field.InternalError(field.NewPath(""), fmt.Errorf("no validation defined for %#v", obj))) @@ -236,6 +242,7 @@ func TestExampleObjectSchemas(t *testing.T) { "redis-resource-deployment": &extensions.Deployment{}, "redis-secret-deployment": &extensions.Deployment{}, "run-my-nginx": &extensions.Deployment{}, + "sj": &batch.ScheduledJob{}, }, "../docs/admin": { "daemon": &extensions.DaemonSet{}, From 4a51e74572ecd1ac4de411cd0523e2402001d25c Mon Sep 17 00:00:00 2001 From: Huamin Chen Date: Wed, 7 Sep 2016 09:47:29 -0400 Subject: [PATCH 022/115] add azure disk volume Signed-off-by: Huamin Chen --- docs/user-guide/volumes.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/user-guide/volumes.md b/docs/user-guide/volumes.md index d118e4e950..ddd9d2cd40 100644 --- a/docs/user-guide/volumes.md +++ b/docs/user-guide/volumes.md @@ -76,6 +76,7 @@ Kubernetes supports several types of Volumes: * `persistentVolumeClaim` * `downwardAPI` * `azureFileVolume` + * `azureDisk` * `vsphereVolume` We welcome additional contributions. @@ -445,6 +446,12 @@ into a Pod. More details can be found [here](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/volumes/azure_file/README.md) +### AzureDiskVolume + +A `AzureDiskVolume` is used to mount a Microsoft Azure [Data Disk](https://azure.microsoft.com/en-us/documentation/articles/virtual-machines-linux-about-disks-vhds/) into a Pod. + +More details can be found [here](https://github.com/kubernetes/kubernetes/tree/{{page.githubbranch}}/examples/volumes/azure_disk/README.md) + ### vsphereVolume A `vsphereVolume` is used to mount a vSphere VMDK Volume into your Pod. The contents From ee859e3a3e2a940575dd5d2e2fae5c7f98a2a99a Mon Sep 17 00:00:00 2001 From: Avesh Agarwal Date: Fri, 26 Aug 2016 13:00:12 -0400 Subject: [PATCH 023/115] Fix downward api docs to have default limits via node allocatables not node capacities. --- docs/user-guide/downward-api/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/downward-api/index.md b/docs/user-guide/downward-api/index.md index 85221fab84..5a957b4323 100644 --- a/docs/user-guide/downward-api/index.md +++ b/docs/user-guide/downward-api/index.md @@ -132,4 +132,4 @@ Some more thorough examples: ## 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. +If cpu and memory limits are not specified for a container, the downward API will default to the node allocatable value for cpu and memory. From fe11f5b9b74944634e2d27563d88caf4d3d076b4 Mon Sep 17 00:00:00 2001 From: "Dr. Stefan Schimanski" Date: Tue, 30 Aug 2016 12:56:27 +0200 Subject: [PATCH 024/115] Add docs/admin/sysctls.md --- docs/admin/index.md | 4 +- docs/admin/sysctls.md | 122 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 125 insertions(+), 1 deletion(-) create mode 100644 docs/admin/sysctls.md diff --git a/docs/admin/index.md b/docs/admin/index.md index 4df7fb3375..a573ec2e5d 100644 --- a/docs/admin/index.md +++ b/docs/admin/index.md @@ -79,4 +79,6 @@ project](/docs/admin/salt). * **Authorization** [authorization](/docs/admin/authorization) -* **Admission Controllers** [admission_controllers](/docs/admin/admission-controllers) \ No newline at end of file +* **Admission Controllers** [admission_controllers](/docs/admin/admission-controllers) + +* **Sysctls** [sysctls](/docs/admin/sysctls.md) diff --git a/docs/admin/sysctls.md b/docs/admin/sysctls.md new file mode 100644 index 0000000000..dc62b8c3d1 --- /dev/null +++ b/docs/admin/sysctls.md @@ -0,0 +1,122 @@ +--- +assignees: +- sttts + +--- + +* TOC +{:toc} + +This document describes how sysctls are used within a Kubernetes cluster. + +## What is a _Sysctl_? + +In Linux, the sysctl interface allows an administrator to modify kernel +parameters at runtime. Parameters are available via the `/proc/sys/` virtual +process file system. The parameters cover various subsystems such as: + +- kernel (common prefix: `kernel.`) +- networking (common prefix: `net.`) +- virtual memory (common prefix: `vm.`) +- MDADM (common prefix: `dev.`) +- More subsystems are described in [Kernel docs](https://www.kernel.org/doc/Documentation/sysctl/README). + +To get a list of all parameters, you can run + +``` +$ sudo sysctl -a +``` + +## Namespaced vs. Node-Level Sysctls + +A number of sysctls are _namespaced_ in today's Linux kernels. This means that +they can be set independently for each pod on a node. Being namespaced is a +requirement for sysctls to be accessible in a pod context within Kubernetes. + +The following sysctls are known to be _namespaced_: + +- `kernel.shm*`, +- `kernel.msg*`, +- `kernel.sem`, +- `fs.mqueue.*`, +- `net.*`. + +Sysctls which are not namespaced are called _node-level_ and must be set +manually by the cluster admin, either by means of the underlying Linux +distribution of the nodes (e.g. via `/etc/sysctls.conf`) or using a DaemonSet +with privileged containers. + +**Note**: it is good practice to consider nodes with special sysctl settings as +_tainted_ within a cluster, and only schedule pods onto them which need those +sysctl settings. It is suggested to use the Kubernetes [_taints and toleration_ +feature](/docs/user-guide/kubectl/kubectl_taint.md) to implement this. + +## Safe vs. Unsafe Sysctls + +Sysctls are grouped into _safe_ and _unsafe_ sysctls. In addition to proper +namespacing a _safe_ sysctl must be properly _isolated_ between pods on the same +node. This means that setting a _safe_ sysctl for one pod + +- must not have any influence on any other pod on the node +- must not allow to harm the node's health +- must not allow to gain CPU or memory resources outside of the resource limits + of a pod. + +By far, most of the _namespaced_ sysctls are not necessarily considered _safe_. + +For Kubernetes 1.4, the following sysctls are supported in the _safe_ set: + +- `kernel.shm_rmid_forced`, +- `net.ipv4.ip_local_port_range`, +- `net.ipv4.tcp_syncookies`. + +This list will be extended in future Kubernetes versions when the kubelet +supports better isolation mechanisms. + +All _safe_ sysctls are enabled by default. + +All _unsafe_ sysctls are disabled by default and must be allowed manually by the +cluster admin on a per-node basis. Pods with disabled unsafe sysctls will be +scheduled, but will fail to launch. + +**Warning**: Due to their nature of being _unsafe_, the use of _unsafe_ sysctls +is at-your-own-risk and can lead to severe problems like wrong behavior of +containers, resource shortage or complete breakage of a node. + +## Enabling Unsafe Sysctls + +With the warning above in mind, the cluster admin can allow certain _unsafe_ +sysctls for very special situations like e.g. high-performance or real-time +application tuning. _Unsafe_ sysctls are enabled on a node-by-node basis with a +flag of the kubelet, e.g.: + +```shell +$ kubelet --experimental-allowed-unsafe-sysctls 'kernel.msg*,net.ipv4.route.min_pmtu' ... +``` + +Only _namespaced_ sysctls can be enabled this way. + +## Setting Sysctls for a Pod + +The sysctl feature is an alpha API in Kubernetes 1.4. Therefore, sysctls are set +using annotations on pods. They apply to all containers in the same pod. + +Here is an example, with different annotations for _safe_ and _unsafe_ sysctls: + +```yaml +apiVersion: v1 +kind: Pod +metadata: + name: sysctl-example + annotations: + security.alpha.kubernetes.io/sysctls: kernel.shm_rmid_forced=1 + security.alpha.kubernetes.io/unsafe-sysctls: net.ipv4.route.min_pmtu=1000,kernel.msgmax=1 2 3 +spec: + ... +``` + +**Note**: a pod with the _unsafe_ sysctls specified above will fail to launch on +any node which has not enabled those two _unsafe_ sysctls explicitly. As with +_node-level_ sysctls it is recommended to use [_taints and toleration_ +feature](/docs/user-guide/kubectl/kubectl_taint.md) or [labels on nodes](/docs +/user-guide/labels.md) to schedule those pods onto the right nodes. From 7f8b65d3e0b1da062670a7e180d52088da75af49 Mon Sep 17 00:00:00 2001 From: Rodrigo Campos Date: Wed, 7 Sep 2016 16:54:38 -0300 Subject: [PATCH 025/115] Add documentation for secret, configmap and downwardAPI file permissions The patch that adds this feature in core kubernetes, https://github.com/kubernetes/kubernetes/pull/28936, was merged and will be released with kubernetes 1.4. --- docs/user-guide/configmap/index.md | 5 ++ docs/user-guide/downward-api/index.md | 4 ++ docs/user-guide/secrets/index.md | 77 +++++++++++++++++++++++++++ 3 files changed, 86 insertions(+) diff --git a/docs/user-guide/configmap/index.md b/docs/user-guide/configmap/index.md index 7b5cd452fc..f37c83f4ac 100644 --- a/docs/user-guide/configmap/index.md +++ b/docs/user-guide/configmap/index.md @@ -414,6 +414,11 @@ When this pod is run, the output will be: very ``` +#### Projecting keys to specific paths and file permissions + +You can project keys to specific paths and specific permissions on a per-file +basis. The [Secrets](/docs/user-guide/secrets/) user guide explains the syntax. + ## Real World Example: Configuring Redis Let's take a look at a real-world example: configuring redis using ConfigMap. Say we want to inject diff --git a/docs/user-guide/downward-api/index.md b/docs/user-guide/downward-api/index.md index 85221fab84..b52958579b 100644 --- a/docs/user-guide/downward-api/index.md +++ b/docs/user-guide/downward-api/index.md @@ -114,6 +114,10 @@ The downward API volume refreshes its data in step with the kubelet refresh loop In future, it will be possible to specify a specific annotation or label. +#### Projecting keys to specific paths and file permissions + +You can project keys to specific paths and specific permissions on a per-file +basis. The [Secrets](/docs/user-guide/secrets/) user guide explains the syntax. ### Example diff --git a/docs/user-guide/secrets/index.md b/docs/user-guide/secrets/index.md index fff246c937..6d388dbebd 100644 --- a/docs/user-guide/secrets/index.md +++ b/docs/user-guide/secrets/index.md @@ -262,6 +262,83 @@ If `spec.volumes[].secret.items` is used, only keys specified in `items` are pro 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. +**Secret files permissions** + +You can also specify the permission mode bits files part of a secret will have. +If you don't specify any, `0644` is used by default. You can sepecify a default +mode for the whole secret volume and override per key if needed. + +For example, you can specify a default mode like this: + +```json +{ + "apiVersion": "v1", + "kind": "Pod", + "metadata": { + "name": "mypod", + "namespace": "myns" + }, + "spec": { + "containers": [{ + "name": "mypod", + "image": "redis", + "volumeMounts": [{ + "name": "foo", + "mountPath": "/etc/foo", + }] + }], + "volumes": [{ + "name": "foo", + "secret": { + "secretName": "mysecret", + "defaultMode": 0400 + } + }] + } +} +``` + +Then, the secret will be mounted on `/etc/foo` and all the files created by the +secret volume mount will have permission `0400`. + +You can also use mapping, as in the previous example, and specify different +permission for different files like this: + +```json +{ + "apiVersion": "v1", + "kind": "Pod", + "metadata": { + "name": "mypod", + "namespace": "myns" + }, + "spec": { + "containers": [{ + "name": "mypod", + "image": "redis", + "volumeMounts": [{ + "name": "foo", + "mountPath": "/etc/foo", + }] + }], + "volumes": [{ + "name": "foo", + "secret": { + "secretName": "mysecret", + "items": [{ + "key": "username", + "path": "my-group/my-username", + "mode": 0777 + }] + } + }] + } +} +``` + +In this case, the file resulting in `/etc/foo/my-group/my-username` will have +permission `0777`. + **Consuming Secret Values from Volumes** Inside the container that mounts a secret volume, the secret keys appear as From 6c4163fa64bf1b0efc2d8cbbfa39b9f3c39c45af Mon Sep 17 00:00:00 2001 From: John Torres Date: Sun, 11 Sep 2016 16:41:02 -0400 Subject: [PATCH 026/115] updates based on comments from @devin-donnelly --- docs/user-guide/accessing-the-cluster.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/accessing-the-cluster.md b/docs/user-guide/accessing-the-cluster.md index 7cfacf0176..73289371e5 100644 --- a/docs/user-guide/accessing-the-cluster.md +++ b/docs/user-guide/accessing-the-cluster.md @@ -71,7 +71,7 @@ $ curl http://localhost:8080/api/ #### Without kubectl proxy (before v1.3.x) -It is also possible to avoid using kubectl proxy by passing an authentication token +It is possible to avoid using kubectl proxy by passing an authentication token directly to the apiserver, like this: ```shell @@ -87,7 +87,7 @@ $ curl $APISERVER/api --header "Authorization: Bearer $TOKEN" --insecure #### Without kubectl proxy (post v1.3.x) -In recent versions of Kubernetes, `kubectl config view` no longer displays the token. Use `kubectl describe secret...` to get the token for the default service account, like this: +In Kubernetes version 1.3 or later, `kubectl config view` no longer displays the token. Use `kubectl describe secret...` to get the token for the default service account, like this: ``` shell $ APISERVER=$(kubectl config view | grep server | cut -f 2- -d ":" | tr -d " ") From 99f7d6d2f144776e21477305902f2edfb73cd6a2 Mon Sep 17 00:00:00 2001 From: gmarek Date: Wed, 31 Aug 2016 14:52:13 +0200 Subject: [PATCH 027/115] update Node admin doc --- docs/admin/node.md | 57 ++++++++++++++++++++++++++++++++-------------- 1 file changed, 40 insertions(+), 17 deletions(-) diff --git a/docs/admin/node.md b/docs/admin/node.md index 1f1c89b4cb..c64169b9bc 100644 --- a/docs/admin/node.md +++ b/docs/admin/node.md @@ -120,25 +120,48 @@ Currently, there are three components that interact with the Kubernetes node int ### Node Controller Node controller is a component in Kubernetes master which manages Node -objects. It performs two major functions: cluster-wide node synchronization -and single node life-cycle management. +objects. -Node controller has a sync loop that deletes Nodes from Kubernetes -based on all matching VM instances listed from the cloud provider. The sync period -can be controlled via flag `--node-sync-period`. If a new VM instance -gets created, Node Controller creates a representation for it. If an existing -instance gets deleted, Node Controller deletes the representation. Note however, -that Node Controller is unable to provision the node for you, i.e. it won't install -any binary; therefore, to -join a node to a Kubernetes cluster, you as an admin need to make sure proper services are -running in the node. In the future, we plan to automatically provision some node -services. +Node controller has mutliple roles in Node's life. First is assigning a CIDR block to +the Node when it is registered (if CIDR assignment is turned on). Second is keeping the +node controller's list of nodes up to date with the cloud provider's list of available +machines. When running in cloud environment whenever a node is unhealthy node controller +asks cloud provider if the VM for that node is still available. If not, the node +controller deletes the node from its list of nodes. -In general, node controller is responsible for updating the NodeReady condition of node -status to ConditionUnknown when a node becomes unreachable (e.g. due to the node being down), -and then later evicting all the pods from the node (using graceful termination) if the node -continues to be unreachable. (The current timeouts for those are 40s and 5m, respectively.) -It also allocates CIDR blocks to the new nodes. +Third responsibiliy is monitoring Node's health. Node controller is responsible for updating +the NodeReady condition of NodeStatus to ConditionUnknown when a node becomes unreachable +(i.e. node controller stops receiving heartbeats e.g. due to the node being down), and then +later evicting all the pods from the node (using graceful termination) if the node continues +to be unreachable (the current timeouts are 40s to start reporting ConditionUnknown and 5m +after that to start evicting pods). Node controller checks the state of each node every +`--node-monitor-period` seconds. + +In 1.4 release we updated the logic of node controller to better handle cases when a +big number of Nodes have problems with reaching the master machine (e.g. because +master machine has networking problem). Starting with 1.4 node controller will look at the +state of all Nodes in the cluster when making a decision about pod eviction. + +In most cases, node controller limits the eviction rate to `--node-eviction-rate` (default 0.1) +per second, meaning it won't evict pods from more than 1 node per 10 seconds. + +The node eviction behavior changes when a node in a given availability zone becomes unhealthy, +node controller checks what percentage of nodes in the zone are unhealthy (NodeReady condition +is ConditionUnknown or ConditionFalse) at the same time. If the fraction of unhealthy nodes is +at least `--unhealthy-zone-threshold` (default 0.55) then the eviction rate is reduced: if +the cluster is small (i.e. has less than or equal to `--large-cluster-size-threshold` +nodes - default 50) then evictions are stopped, otherwise the eviction rate is reduced to +`--secondary-node-eviction-rate` (default 0.01) per second. The reason these policies are +implemented per availability zone is because one availability zone might become partitioned +from the master while the others remain connected. If your cluster does not span multiple cloud +provider availability zones, then there is only one availability zone, namely the whole cluster. + +A key reason for spreading your nodes across availability zones is so that workload can be +shifted to healthy zones when one entire zone goes down. To enable this behavior, if all +nodes in a zone are unhealthy then node controller evicts at the normal rate `--node-eviction-rate`. +The corner case for that is when all zones are completely unhealthy (i.e. there's no healthy node in +the cluster). In such case node controller assumes that there's some problem with master machine +connectivity and stops all evictions until any connectivity is restored. ### Self-Registration of Nodes From 095f9d436e031197cb0e22ea642772be3ce61837 Mon Sep 17 00:00:00 2001 From: Evan Cordell Date: Thu, 8 Sep 2016 16:05:29 -0400 Subject: [PATCH 028/115] Add ImagePolicyWebhook docs --- docs/admin/admission-controllers.md | 112 ++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) diff --git a/docs/admin/admission-controllers.md b/docs/admin/admission-controllers.md index c8fc6b3eb3..b0cdec7023 100644 --- a/docs/admin/admission-controllers.md +++ b/docs/admin/admission-controllers.md @@ -78,6 +78,118 @@ If your cluster supports containers that run with escalated privileges, and you restrict the ability of end-users to exec commands in those containers, we strongly encourage enabling this plug-in. +### ImagePolicyWebhook + +The ImagePolicyWebhook plug-in allows a backend webhook to make admission decisions. You enable this plug-in by setting the admission-control option as follows: + +```shell +--admission-control=ImagePolicyWebhook +``` + +#### Configuration File Format +ImagePolicyWebhook uses the admission controller config file (`--admission-controller-config-file`) to set configuration options for the behavior of the backend. This file may be json or yaml and has the following format: + +```javascript +{ + "imagePolicy": { + "kubeConfigFile": "path/to/kubeconfig/for/backend", + "allowTTL": 50, // time in s to cache approval + "denyTTL": 50, // time in s to cache denial + "retryBackoff": 500, // time in ms to wait between retries + "defaultAllow": true // determines behavior if the webhook backend fails + } +} +``` + +The config file must reference a [kubeconfig](/docs/user-guide/kubeconfig-file/) formatted file which sets up the connection to the backend. It is required that the backend communicate over TLS. + +The kubeconfig file's cluster field must point to the remote service, and the user field must contain the returned authorizer. + +```yaml +# clusters refers to the remote service. +clusters: +- name: name-of-remote-imagepolicy-service + cluster: + certificate-authority: /path/to/ca.pem # CA for verifying the remote service. + server: https://images.example.com/policy # 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 +``` +For additional HTTP configuration, refer to the [kubeconfig](/docs/user-guide/kubeconfig-file/) documentation. + +#### Request Payloads + +When faced with an admission decision, the API Server POSTs a JSON serialized api.imagepolicy.v1alpha1.ImageReview object describing the action. This object contains fields describing the containers being admitted, as well as any pod annotations that match `*.image-policy.k8s.io/*`. + +Note that webhook API objects are subject to the same versioning compatibility rules as other Kubernetes API objects. Implementers should be aware of looser compatibility promises for alpha objects and check the “apiVersion” field of the request to ensure correct deserialization. Additionally, the API Server must enable the imagepolicy.k8s.io/v1alpha1 API extensions group (`--runtime-config=imagepolicy.k8s.io/v1alpha1=true`). + +An example request body: + +``` +{ + "apiVersion":"imagepolicy.k8s.io/v1alpha1", + "kind":"ImageReview", + "spec":{ + "containers":[ + { + "image":"myrepo/myimage:v1" + }, + { + "image":"myrepo/myimage@sha256:beb6bd6a68f114c1dc2ea4b28db81bdf91de202a9014972bec5e4d9171d90ed" + } + ], + "annotations":[ + "mycluster.image-policy.k8s.io/ticket-1234": "break-glass" + ], + "namespace":"mynamespace" + } +} +``` + +The remote service is expected to fill the ImageReviewStatus field of the request and respond to either allow or disallow access. The response body’s “spec” field is ignored and may be omitted. A permissive response would return: + +``` +{ + "apiVersion": "imagepolicy.k8s.io/v1alpha1", + "kind": "ImageReview", + "status": { + "allowed": true + } +} +``` + +To disallow access, the service would return: + +``` +{ + "apiVersion": "imagepolicy.k8s.io/v1alpha1", + "kind": "ImageReview", + "status": { + "allowed": false, + "reason": "image currently blacklisted" + } +} +``` + +For further documentation refer to the `imagepolicy.v1alpha1` API objects and `plugin/pkg/admission/imagepolicy/admission.go`. + +#### Extending with Annotations + +All annotations on a Pod that match `*.image-policy.k8s.io/*` are sent to the webhook. Sending annotations allows users who are aware of the image policy backend to send extra information to it, and for different backends implementations to accept different information. + +Examples of information you might put here are: + + * request to "break glass" to override a policy, in case of emergency. + * a ticket number from a ticket system that documents the break-glass request + * provide a hint to the policy server as to the imageID of the image being provided, to save it a lookup + +In any case, the annotations are provided by the user and are not validated by Kubernetes in any way. In the future, if an annotation is determined to be widely useful, it may be promoted to a named field of ImageReviewSpec. + ### ServiceAccount This plug-in implements automation for [serviceAccounts](/docs/user-guide/service-accounts). From 5ce89f84f33d32a7ff0c3f83c668053bdcf33b29 Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Tue, 6 Sep 2016 18:53:53 -0700 Subject: [PATCH 029/115] Getting started guide which walks through using NetworkPolicy --- _data/guides.yml | 2 + .../calico-network-policy.md | 131 ++++++++++++++++++ docs/user-guide/networkpolicies.md | 3 + 3 files changed, 136 insertions(+) create mode 100644 docs/getting-started-guides/calico-network-policy.md diff --git a/_data/guides.yml b/_data/guides.yml index 3f076b7af9..47039275ca 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -60,6 +60,8 @@ toc: path: /docs/user-guide/working-with-resources/ - title: Garbage collection path: /docs/user-guide/garbage-collector/ + - title: Using Calico NetworkPolicy + path: /docs/getting-started-guides/calico-network-policy/ - title: Batch Jobs section: diff --git a/docs/getting-started-guides/calico-network-policy.md b/docs/getting-started-guides/calico-network-policy.md new file mode 100644 index 0000000000..8617cbe13f --- /dev/null +++ b/docs/getting-started-guides/calico-network-policy.md @@ -0,0 +1,131 @@ +--- +assignees: +- caseydavenport + +--- + +Kubernetes can be used to declare network policies which govern how Pods can communicate with each other. This document helps you get started using the Kubernetes [NetworkPolicy API](/docs/user-guide/networkpolicies), and provides a demonstration thereof. + +In this article we assume that that a Kubernetes cluster has been created with network policy support. It's easy to create such a cluster using the [GCE guide](/docs/getting-started-guides/gce), setting the `NETWORK_POLICY_PROVIDER=calico` environment variable. + +e.g + +```shell +export NETWORK_POLICY_PROVIDER=calico +curl -sS https://get.k8s.io | bash +``` + +## Using NetworkPolicy + +Once your cluster is started, you should see a collection of pods running in the `kube-system` Namespace that support Kubernetes NetworkPolicy. + +```console +$ kubectl get pods --namespace=kube-system +NAME READY STATUS RESTARTS AGE +calico-node-kubernetes-minion-group-jck6 1/1 Running 0 46m +calico-node-kubernetes-minion-group-k9jy 1/1 Running 0 46m +calico-node-kubernetes-minion-group-szgr 1/1 Running 0 46m +calico-policy-controller-65rw1 1/1 Running 0 46m +... +``` + +There are two main components to be aware of: + +- One `calico-node` Pod runs on each node in your cluster, and enforces network policy on the traffic to/from Pods on that machine by configuring iptables. +- The `calico-policy-controller` Pod reads policy and label information from the Kubernetes API and configures Calico appropriately. + +To explain how Kubernetes network policy works let's start off by creating an `nginx` Deployment and expose it via a Service. + +```console +$ kubectl run nginx --image=nginx --replicas=2 +deployment "nginx" created +$ kubectl expose deployment nginx --port=80 +service "nginx" exposed +``` + +This will run two nginx Pods in the default Namespace, and expose them through a Service called `nginx`. + +```console +$ kubectl get svc,pod +NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE +kubernetes 10.100.0.1 443/TCP 46m +nginx 10.100.0.16 80/TCP 33s +NAME READY STATUS RESTARTS AGE +nginx-701339712-e0qfq 1/1 Running 0 35s +nginx-701339712-o00ef 1/1 Running 0 35s +``` + +We should be able to access our new nginx Service from other Pods. Let's try to access it from another Pod +in the default namespace. We haven't put any network policy in place, so this should just work. Start a +busybox container, and use `wget` to hit the nginx Service: + +```console +$ kubectl run busybox --rm -ti --image=busybox /bin/sh +Waiting for pod default/busybox-472357175-y0m47 to be running, status is Pending, pod ready: false + +Hit enter for command prompt + +/ # wget -s --timeout=1 nginx +Connecting to nginx (10.100.0.16:80) +/ # +``` + +Let's say we want to limit access to our nginx Service so that only pods with the label `access: true` can query it. First, we'll +enable ingress isolation on the `default` Namespace. This will prevent _any_ pods from accessing the nginx Service. + +```console +$ kubectl annotate ns default "net.beta.kubernetes.io/network-policy={\"ingress\": {\"isolation\": \"DefaultDeny\"}}" +``` + +With ingress isolation in place, we should no longer be able to access the nginx Service like we were able to before. + +Let's now create a `NetworkPolicy` which allows connections from pods with the label `access: true`. + +```yaml +kind: NetworkPolicy +apiVersion: extensions/v1beta1 +metadata: + name: access-nginx +spec: + podSelector: + matchLabels: + run: nginx + ingress: + - from: + - podSelector: + matchLabels: + access: "true" +``` + +Use kubectl to create the above nginx-policy.yaml file: +```console +$ kubectl create -f nginx-policy.yaml +networkpolicy "access-nginx" created +``` + +If we attempt to access the nginx Service from a pod without the correct labels, the request will timeout: + +```console +$ kubectl run busybox --rm -ti --image=busybox /bin/sh +Waiting for pod default/busybox-472357175-y0m47 to be running, status is Pending, pod ready: false + +Hit enter for command prompt + +/ # wget -s --timeout=1 nginx +Connecting to nginx (10.100.0.16:80) +wget: download timed out +/ # +``` + +However, if we create a Pod with the correct labels, the request will be allowed: + +```console +$ kubectl run busybox --rm -ti --labels="access=true" --image=busybox /bin/sh +Waiting for pod default/busybox-472357175-y0m47 to be running, status is Pending, pod ready: false + +Hit enter for command prompt + +/ # wget -s --timeout=1 nginx +Connecting to nginx (10.100.0.16:80) +/ # +``` diff --git a/docs/user-guide/networkpolicies.md b/docs/user-guide/networkpolicies.md index eb4bbe1b74..982d3bbbac 100644 --- a/docs/user-guide/networkpolicies.md +++ b/docs/user-guide/networkpolicies.md @@ -1,6 +1,7 @@ --- assignees: - thockin +- caseydavenport --- @@ -47,6 +48,8 @@ To configure the annotation via `kubectl`: kubectl annotate ns "net.beta.kubernetes.io/network-policy={\"ingress\": {\"isolation\": \"DefaultDeny\"}}" {% endraw %}``` +See the [NetworkPolicy getting started guide](/docs/getting-started-guides/network-policy) for an example. + ## The `NetworkPolicy` Resource See the [api-reference](/docs/api-reference/extensions/v1beta1/definitions/#_v1beta1_networkpolicy) for a full definition of the resource. From 3dc824673f6ee9f8f66376891eeb34de65bc98c2 Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Mon, 12 Sep 2016 18:32:35 -0700 Subject: [PATCH 030/115] Split out Calico bits --- _data/guides.yml | 8 +++-- .../network-policy/calico.md | 33 +++++++++++++++++++ .../walkthrough.md} | 26 ++------------- docs/user-guide/networkpolicies.md | 2 +- 4 files changed, 42 insertions(+), 27 deletions(-) create mode 100644 docs/getting-started-guides/network-policy/calico.md rename docs/getting-started-guides/{calico-network-policy.md => network-policy/walkthrough.md} (72%) diff --git a/_data/guides.yml b/_data/guides.yml index 47039275ca..5e12d07806 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -60,8 +60,12 @@ toc: path: /docs/user-guide/working-with-resources/ - title: Garbage collection path: /docs/user-guide/garbage-collector/ - - title: Using Calico NetworkPolicy - path: /docs/getting-started-guides/calico-network-policy/ + - title: Using NetworkPolicy + section: + - title: Example Walkthrough + path: /docs/getting-started-guides/network-policy/walkthrough/ + - title: Using Calico for NetworkPolicy + path: /docs/getting-started-guides/network-policy/calico/ - title: Batch Jobs section: diff --git a/docs/getting-started-guides/network-policy/calico.md b/docs/getting-started-guides/network-policy/calico.md new file mode 100644 index 0000000000..45df4018fa --- /dev/null +++ b/docs/getting-started-guides/network-policy/calico.md @@ -0,0 +1,33 @@ +--- +assignees: +- caseydavenport + +--- + +You can deploy a cluster using Calico for network policy in the default [GCE deployment](/docs/getting-started-guides/gce) using the following set of commands: + +```shell +export NETWORK_POLICY_PROVIDER=calico +curl -sS https://get.k8s.io | bash +``` + +See the [Calico documentation](https://github.com/projectcalico/calico-containers/tree/master/docs/cni/kubernetes#getting-started) for more options to deploy Calico with Kubernetes. + +Once your cluster using Calico is running, you should see a collection of pods running in the `kube-system` Namespace that support Kubernetes NetworkPolicy. + +```console +$ kubectl get pods --namespace=kube-system +NAME READY STATUS RESTARTS AGE +calico-node-kubernetes-minion-group-jck6 1/1 Running 0 46m +calico-node-kubernetes-minion-group-k9jy 1/1 Running 0 46m +calico-node-kubernetes-minion-group-szgr 1/1 Running 0 46m +calico-policy-controller-65rw1 1/1 Running 0 46m +... +``` + +There are two main components to be aware of: + +- One `calico-node` Pod runs on each node in your cluster, and enforces network policy on the traffic to/from Pods on that machine by configuring iptables. +- The `calico-policy-controller` Pod reads policy and label information from the Kubernetes API and configures Calico appropriately. + +Once your cluster is running, you can follow the [NetworkPolicy gettting started guide](/docs/getting-started-guides/network-policy/walkthrough) to try out Kubernetes NetworkPolicy. diff --git a/docs/getting-started-guides/calico-network-policy.md b/docs/getting-started-guides/network-policy/walkthrough.md similarity index 72% rename from docs/getting-started-guides/calico-network-policy.md rename to docs/getting-started-guides/network-policy/walkthrough.md index 8617cbe13f..122baa653a 100644 --- a/docs/getting-started-guides/calico-network-policy.md +++ b/docs/getting-started-guides/network-policy/walkthrough.md @@ -6,34 +6,12 @@ assignees: Kubernetes can be used to declare network policies which govern how Pods can communicate with each other. This document helps you get started using the Kubernetes [NetworkPolicy API](/docs/user-guide/networkpolicies), and provides a demonstration thereof. -In this article we assume that that a Kubernetes cluster has been created with network policy support. It's easy to create such a cluster using the [GCE guide](/docs/getting-started-guides/gce), setting the `NETWORK_POLICY_PROVIDER=calico` environment variable. +In this article we assume that a Kubernetes cluster has been created with network policy support. There are a number of network providers which support NetworkPolicy (see the "Using X for NetworkPolicy" articles in this section). The reference implementation is [Calico](/docs/getting-started-guides/network-policy/calico) running on GCE. -e.g - -```shell -export NETWORK_POLICY_PROVIDER=calico -curl -sS https://get.k8s.io | bash -``` +The following example walkthrough will work on a Kubernetes cluster using any of the listed providers. ## Using NetworkPolicy -Once your cluster is started, you should see a collection of pods running in the `kube-system` Namespace that support Kubernetes NetworkPolicy. - -```console -$ kubectl get pods --namespace=kube-system -NAME READY STATUS RESTARTS AGE -calico-node-kubernetes-minion-group-jck6 1/1 Running 0 46m -calico-node-kubernetes-minion-group-k9jy 1/1 Running 0 46m -calico-node-kubernetes-minion-group-szgr 1/1 Running 0 46m -calico-policy-controller-65rw1 1/1 Running 0 46m -... -``` - -There are two main components to be aware of: - -- One `calico-node` Pod runs on each node in your cluster, and enforces network policy on the traffic to/from Pods on that machine by configuring iptables. -- The `calico-policy-controller` Pod reads policy and label information from the Kubernetes API and configures Calico appropriately. - To explain how Kubernetes network policy works let's start off by creating an `nginx` Deployment and expose it via a Service. ```console diff --git a/docs/user-guide/networkpolicies.md b/docs/user-guide/networkpolicies.md index 982d3bbbac..a45534ad96 100644 --- a/docs/user-guide/networkpolicies.md +++ b/docs/user-guide/networkpolicies.md @@ -48,7 +48,7 @@ To configure the annotation via `kubectl`: kubectl annotate ns "net.beta.kubernetes.io/network-policy={\"ingress\": {\"isolation\": \"DefaultDeny\"}}" {% endraw %}``` -See the [NetworkPolicy getting started guide](/docs/getting-started-guides/network-policy) for an example. +See the [NetworkPolicy getting started guide](/docs/getting-started-guides/network-policy/walkthrough) for an example. ## The `NetworkPolicy` Resource From 93df436435b6186ce24319dcc99ba06ae81fa6cd Mon Sep 17 00:00:00 2001 From: Jan Safranek Date: Tue, 13 Sep 2016 10:02:17 +0200 Subject: [PATCH 031/115] Add documentation about DefaultStorageClass plugin. --- docs/admin/admission-controllers.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/admin/admission-controllers.md b/docs/admin/admission-controllers.md index c8fc6b3eb3..575e57029a 100644 --- a/docs/admin/admission-controllers.md +++ b/docs/admin/admission-controllers.md @@ -125,10 +125,31 @@ and ensures that requests in a non-existent `Namespace` are rejected. A `Namespace` deletion kicks off a sequence of operations that remove all objects (pods, services, etc.) in that namespace. In order to enforce integrity of that process, we strongly recommend running this plug-in. +### DefaultStorageClass + +This plug-in observes creation of `PersistentVolumeClaim` objects that do not request any specific storage class +and automatically adds a default storage class to them. +This way, users that do not request any special storage class do no need to care about them at all and they +will get the default one. + +This plug-in does not do anything when no default storage class is configured. When more than one storage +class is marked as default, it rejects any creation of `PersistentVolumeClaim` with an error and administrator +must revisit `StorageClass` objects and mark only one as default. +This plugin ignores any `PersistentVolumeClaim` updates, it acts only on creation. + +See [persistent volume](/docs/user-guide/persistent-volumes) documentation about persistent volume claims and +storage classes and how to mark a storage class as default. + ## Is there a recommended set of plug-ins to use? Yes. +For Kubernetes >= 1.4.0, we strongly recommend running the following set of admission control plug-ins (order matters): + +```shell +--admission-control=NamespaceLifecycle,LimitRanger,ServiceAccount,DefaultStorageClass,ResourceQuota +``` + For Kubernetes >= 1.2.0, we strongly recommend running the following set of admission control plug-ins (order matters): ```shell From 01fe9bf1f28761da4cc7de88a67b8e261075175b Mon Sep 17 00:00:00 2001 From: pweil- Date: Fri, 2 Sep 2016 14:41:59 -0400 Subject: [PATCH 032/115] psp initial documentation --- _data/reference.yml | 2 + .../user-guide/pod-security-policy/OWNERS.txt | 2 + docs/user-guide/pod-security-policy/index.md | 158 ++++++++++++++++++ docs/user-guide/pod-security-policy/psp.yaml | 22 +++ 4 files changed, 184 insertions(+) create mode 100644 docs/user-guide/pod-security-policy/OWNERS.txt create mode 100644 docs/user-guide/pod-security-policy/index.md create mode 100644 docs/user-guide/pod-security-policy/psp.yaml diff --git a/_data/reference.yml b/_data/reference.yml index bf06023fb1..32f2d6b54a 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -212,6 +212,8 @@ toc: path: /docs/user-guide/petset/ - title: Pods path: /docs/user-guide/pods/ + - title: Pod Security Policies + path: /docs/user-guide/pod-security-policy/ - title: Replica Sets path: /docs/user-guide/replicasets/ - title: Replication Controller diff --git a/docs/user-guide/pod-security-policy/OWNERS.txt b/docs/user-guide/pod-security-policy/OWNERS.txt new file mode 100644 index 0000000000..f7232a6fe6 --- /dev/null +++ b/docs/user-guide/pod-security-policy/OWNERS.txt @@ -0,0 +1,2 @@ +assignees: +- pweil- \ No newline at end of file diff --git a/docs/user-guide/pod-security-policy/index.md b/docs/user-guide/pod-security-policy/index.md new file mode 100644 index 0000000000..8287d0c5e1 --- /dev/null +++ b/docs/user-guide/pod-security-policy/index.md @@ -0,0 +1,158 @@ +--- +assignees: +- pweil- + +--- + +Objects of type `podsecuritypolicy` govern the ability +to make requests on a pod that affect the `SecurityContext` that will be +applied to a pod and container. + +See [PodSecurityPolicy proposal](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/proposals/security-context-constraints.md) for more information. + +* TOC +{:toc} + +## What is a _Pod Security Policy_? + +A _Pod Security Policy_ is a cluster-level resource that controls the +actions that a pod can perform and what it has the ability to access. The +`PodSecurityPolicy` objects define a set of conditions that a pod must +run with in order to be accepted into the system. They allow an +administrator to control the following: + +1. Running of privileged containers. +1. Capabilities a container can request to be added. +1. The SELinux context of the container. +1. The user ID. +1. The use of host namespaces and networking. +1. Allocating an FSGroup that owns the pod’s volumes +1. Configuring allowable supplemental groups +1. Requiring the use of a read only root file system +1. Controlling the usage of volume types + +_Pod Security Policies_ are comprised of settings and strategies that +control the security features a pod has access to. These settings fall +into three categories: + +- *Controlled by a boolean*: Fields of this type default to the most +restrictive value. +- *Controlled by an allowable set*: Fields of this type are checked +against the set to ensure their value is allowed. +- *Controlled by a strategy*: Items that have a strategy to generate a value provide +a mechanism to generate the value and a mechanism to ensure that a +specified value falls into the set of allowable values. + + +## Strategies + +### RunAsUser + +- *MustRunAs* - Requires a `*range*` to be configured. Uses the first value +of the range as the default. Validates against the configured range. +- *MustRunAsNonRoot* - Requires that the pod be submitted with a non-zero +`*runAsUser*` or have the `USER` directive defined in the image. No default +provided. +- *RunAsAny* - No default provided. Allows any `*runAsUser*` to be specified. + +### SELinuxContext + +- *MustRunAs* - Requires `*seLinuxOptions*` to be configured if not using +pre-allocated values. Uses `*seLinuxOptions*` as the default. Validates against +`*seLinuxOptions*`. +- *RunAsAny* - No default provided. Allows any `*seLinuxOptions*` to be +specified. + +### SupplementalGroups + +- *MustRunAs* - Requires at least one range to be specified. Uses the +minimum value of the first range as the default. Validates against all ranges. +- *RunAsAny* - No default provided. Allows any `*supplementalGroups*` to be +specified. + +### FSGroup + +- *MustRunAs* - Requires at least one range to be specified. Uses the +minimum value of the first range as the default. Validates against the +first ID in the first range. +- *RunAsAny* - No default provided. Allows any `*fsGroup*` ID to be specified. + +### Controlling Volumes + +The usage of specific volume types can be controlled by setting the +volumes field of the PSP. The allowable values of this field correspond +to the volume sources that are defined when creating a volume: + +1. azureFile +1. flocker +1. flexVolume +1. hostPath +1. emptyDir +1. gcePersistentDisk +1. awsElasticBlockStore +1. gitRepo +1. secret +1. nfs +1. iscsi +1. glusterfs +1. persistentVolumeClaim +1. rbd +1. cinder +1. cephFS +1. downwardAPI +1. fc +1. configMap +1. \* (allow all volumes) + +The recommended minimum set of allowed volumes for new PSPs are +configMap, downwardAPI, emptyDir, persistentVolumeClaim, and secret. + +## Admission + +_Admission control_ with `PodSecurityPolicy` allows for control over the creation of resources +based on the capabilities allowed in the cluster. + +Admission uses the following approach to create the final security context for +the pod: + +1. Retrieve all PSPs available for use. +1. Generate field values for security context settings that were not specified +on the request. +1. Validate the final settings against the available policies. + +If a matching policy is found, then the pod is accepted. If the +request cannot be matched to a PSP, the pod is rejected. + +A pod must validate every field against the PSP. + +## Creating a Pod Security Policy + +Here is an example Pod Security Policy. It has permissive settings for +all fields + +{% include code.html language="yaml" file="sj.yaml" ghlink="/docs/user-guide/pod-security-policy/psp.yaml" %} + +Create the policy by downloading the example file and then running this command: + +```shell +$ kubectl create -f ./psp.yaml +podsecuritypolicy "permissive" created +``` + +## Deleting a Pod Security Policy + +Once you don't need a policy anymore, simply delete it with `kubectl`: + +```shell +$ kubectl delete psp permissive +podsecuritypolicy "permissive" deleted +``` + +## Enabling Pod Security Policies + +In order to use Pod Security Policies in your cluster you must ensure the +following + +1. You have enabled the api type `extensions/v1beta1/podsecuritypolicy` +1. You have enabled the admission controller `PodSecurityPolicy` +1. You have defined your policies \ No newline at end of file diff --git a/docs/user-guide/pod-security-policy/psp.yaml b/docs/user-guide/pod-security-policy/psp.yaml new file mode 100644 index 0000000000..a16c1f350d --- /dev/null +++ b/docs/user-guide/pod-security-policy/psp.yaml @@ -0,0 +1,22 @@ +{ + "kind": "PodSecurityPolicy", + "apiVersion":"extensions/v1beta1", + "metadata": { + "name": "permissive" + }, + "spec": { + "seLinux": { + "rule": "RunAsAny" + }, + "supplementalGroups": { + "rule": "RunAsAny" + }, + "runAsUser": { + "rule": "RunAsAny" + }, + "fsGroup": { + "rule": "RunAsAny" + }, + "volumes": ["*"] + } +} From 462f5817890c0a67089577d8b5781a5f2d03660c Mon Sep 17 00:00:00 2001 From: Rudi C Date: Fri, 19 Aug 2016 11:36:45 -0700 Subject: [PATCH 033/115] Update user guide for ExternalName services This is the documentation part of kubernetes/features#33 cc @kubernetes/docs @thockin @smarterclayton --- docs/user-guide/services/index.md | 45 ++++++++++++++++++++++++++++--- 1 file changed, 41 insertions(+), 4 deletions(-) diff --git a/docs/user-guide/services/index.md b/docs/user-guide/services/index.md index 62b7ff7f50..94faabcd1c 100644 --- a/docs/user-guide/services/index.md +++ b/docs/user-guide/services/index.md @@ -147,11 +147,38 @@ Accessing a `Service` without a selector works the same as if it had selector. The traffic will be routed to endpoints defined by the user (`1.2.3.4:9376` in this example). +An ExternalName service is a special case of service that does not have +selectors. It does not define any ports or endpoints. Rather, it serves as a +way to return an alias to an external service residing outside the cluster. + +```json +{ + "kind": "Service", + "apiVersion": "v1", + "metadata": { + "name": "my-service", + "namespace": "prod" + }, + "spec": { + "type": "ExternalName", + "externalName": "my.database.example.com" + } +} +``` + +When looking up the host `my-service.prod.svc.CLUSTER`, the cluster DNS service +will return a `CNAME` record with the value `my.database.example.com`. Accessing +such a service works in the same way as others, with the only difference that +the redirection happens at the DNS level and no proxying or forwarding occurs. +Should you later decide to move your database into your cluster, you can start +its pods, add appropriate selectors or endpoints and change the service `type`. + ## Virtual IPs and service proxies -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 +Every node in a Kubernetes cluster runs a `kube-proxy`. `kube-proxy` is +responsible for implementing a form of virtual IP for `Service`s of type other +than `ExternalName`. +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. Since Kubernetes v1.2, the iptables proxy is the default. @@ -317,6 +344,9 @@ Kubernetes also supports DNS SRV (service) records for named ports. If the can do a DNS SRV query for `"_http._tcp.my-service.my-ns"` to discover the port number for `"http"`. +The Kubernetes DNS server is the only way to access services of type +`ExternalName`. + ## Headless services Sometimes you don't need or want load-balancing and a single service IP. In @@ -343,7 +373,10 @@ records (addresses) which point directly to the `Pods` backing the `Service`. 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. +either: + - CNAME records for `ExternalName`-type services + - A records for any `Endpoints` that share a name with the service, for all + other types ## Publishing services - service types @@ -359,6 +392,10 @@ services to external traffic. Valid values for the `ServiceType` field are: + * `ExternalName`: map the service to the contents of the `externalName` field + (e.g. `foo.bar.example.com`), by returning a `CNAME` record with its value. + No proxying of any kind is set up. This requires version 1.7 or higher of + `kube-dns`. * `ClusterIP`: use a cluster-internal IP only - this is the default and is discussed above. Choosing this value means that you want this service to be reachable only from inside of the cluster. From 78091516e8220f603e8fb0cc3d2888355bdfc881 Mon Sep 17 00:00:00 2001 From: Maciej Szulik Date: Tue, 6 Sep 2016 16:13:18 +0200 Subject: [PATCH 034/115] Add audit doc --- docs/admin/audit.md | 69 +++++++++++++++++++++++++++++++++++++++++++++ docs/admin/index.md | 4 ++- 2 files changed, 72 insertions(+), 1 deletion(-) create mode 100644 docs/admin/audit.md diff --git a/docs/admin/audit.md b/docs/admin/audit.md new file mode 100644 index 0000000000..c3a6fda6da --- /dev/null +++ b/docs/admin/audit.md @@ -0,0 +1,69 @@ +--- +assignees: +- soltysh +- sttts + +--- + +* TOC +{:toc} + +## Audit in Kubernetes + +Kubernetes Audit provides a security-relevant chronological set of records documenting +the sequence of activities that have affected system by individual users, administrators +or other components of the system. It allows cluster administrator to +answer the following questions: + - what happened? + - when did it happen? + - who initiated it? + - on what did it happen? + - where was it observed? + - from where was it initiated? + - to where was it going? + +NOTE: Currently, Kubernetes provides only basic audit capabilities, there is still a lot +of work going on to provide fully featured auditing capabilities (see https://github.com/kubernetes/features/issues/22). + +Kubernetes audit is part of [kube-apiserver](/docs/admin/kube-apiserver) logging all requests +coming to the server. Each audit log contains two entries: + +1. The request line containing: + - unique id allowing to match the response line (see 2) + - source ip of the request + - HTTP method being invoked + - original user invoking the operation + - impersonated user for the operation + - namespace of the request or + - URI as requested +2. The response line containing: + - the unique id from 1 + - response code + +Example output for user `admin` asking for a list of pods: + +``` +2016-09-07T13:03:57.400333046Z AUDIT: id="5c3b8227-4af9-4322-8a71-542231c3887b" ip="127.0.0.1" method="GET" user="admin" as="" namespace="default" uri="/api/v1/namespaces/default/pods" +2016-09-07T13:03:57.400710987Z AUDIT: id="5c3b8227-4af9-4322-8a71-542231c3887b" response="200" +``` + +NOTE: The audit capabilities are available *only* for the secured endpoint of the API server. + +## Configuration + +[Kube-apiserver](/docs/admin/kube-apiserver) provides following options which are responsible +for configuring where and how audit logs are handled: + +- `audit-log-path` - enables the audit log pointing to a file where the requests are being logged to. +- `audit-log-maxage` - specifies maximum number of days to retain old audit log files based on the timestamp encoded in their filename. +- `audit-log-maxbackup` - specifies maximum number of old audit log files to retain. +- `audit-log-maxsize` - specifies maximum size in megabytes of the audit log file before it gets rotated. Defaults to 100MB + +If an audit log file already exists, Kubernetes appends new audit logs to that file. +Otherwise, Kubernetes creates an audit log file at the location you specified in +`audit-log-path`. If the audit log file exceeds the size you specify in `audit-log-maxsize`, +Kubernetes will rename the current log file by appending the current timestamp on +the file name (before the file extension) and create a new audit log file. +Kubernetes may delete old log files when creating a new log file; you can configure +how many files are retained and how old they can be by specifying the `audit-log-maxbackup` +and `audit-log-maxage` options. diff --git a/docs/admin/index.md b/docs/admin/index.md index a573ec2e5d..47f47f8116 100644 --- a/docs/admin/index.md +++ b/docs/admin/index.md @@ -79,6 +79,8 @@ project](/docs/admin/salt). * **Authorization** [authorization](/docs/admin/authorization) -* **Admission Controllers** [admission_controllers](/docs/admin/admission-controllers) +* **Admission Controllers** [admission controllers](/docs/admin/admission-controllers) * **Sysctls** [sysctls](/docs/admin/sysctls.md) + +* **Audit** [audit](/docs/admin/audit) From ae8d6a053cb9461462dc1c747a037a7978f24de2 Mon Sep 17 00:00:00 2001 From: scotty Date: Wed, 14 Sep 2016 10:39:24 -0700 Subject: [PATCH 035/115] case studies --- _includes/case-study-styles.html | 263 +++++++++++++++++++++++++++++++ _sass/_base.sass | 2 +- _sass/_desktop.sass | 2 +- case-studies/index.html | 88 +++++++++++ case-studies/pearson.html | 88 +++++++++++ case-studies/wikimedia.html | 103 ++++++++++++ js/script.js | 5 + 7 files changed, 549 insertions(+), 2 deletions(-) create mode 100644 _includes/case-study-styles.html create mode 100644 case-studies/index.html create mode 100644 case-studies/pearson.html create mode 100644 case-studies/wikimedia.html diff --git a/_includes/case-study-styles.html b/_includes/case-study-styles.html new file mode 100644 index 0000000000..4e9527c083 --- /dev/null +++ b/_includes/case-study-styles.html @@ -0,0 +1,263 @@ + + diff --git a/_sass/_base.sass b/_sass/_base.sass index afa136b589..c4aee5d557 100644 --- a/_sass/_base.sass +++ b/_sass/_base.sass @@ -1131,7 +1131,7 @@ $feature-box-div-margin-bottom: 40px // Community -#community +#community, #caseStudies &.open-nav, &.flip-nav .logo background-image: url(/images/nav_logo2.svg) diff --git a/_sass/_desktop.sass b/_sass/_desktop.sass index 2574b96811..69ab7bd179 100644 --- a/_sass/_desktop.sass +++ b/_sass/_desktop.sass @@ -270,7 +270,7 @@ $video-section-height: 550px - #community + #community, #caseStudies #hero text-align: left diff --git a/case-studies/index.html b/case-studies/index.html new file mode 100644 index 0000000000..ddbeed1aa2 --- /dev/null +++ b/case-studies/index.html @@ -0,0 +1,88 @@ +--- +title: Case Studies +--- + + + +{% include head-header.html %} + +
    +

    Kubernetes User Case Studies

    +
    + +
    +
    +
    +

    Featured User Case Studies

    +
    +
    + Pearson +

    “We chose Kubernetes because of its flexibility, ease of management and the way it improves our engineers’ productivity.”

    +

    — Chris Jackson, Director for Cloud Product Engineering, Pearson

    + Read about Pearson +
    +
    + Wikimedia +

    “With Kubernetes, we’re simplifying our environment and making it easier for developers to build the tools that make wikis run better.”

    +

    — Yuvi Panda, Operations Engineer, Wikimedia Foundation

    + Read about Wikimedia +
    +
    + eBay +

    Inside eBay’s shift to Kubernetes and containers atop OpenStack

    + Read about eBay +
    +
    + box +

    Kubernetes at Box: Microservices at Maximum Velocity

    + Read about Box +
    +
    +
    +
    +
    + +
    +
    +
    + zulily +

    “I don’t want to deploy software the old way ever again”

    +

    — Dylan Carney, Lead Software Engineer, Zulily

    +
    +
    +
    +
    + +
    +
    +

    Kubernetes Users

    +
    + New York Times + OpenAI + Goldman Sachs + SAP + Samsung SDS + WePay + SoundCloud + UK Home Office + Concur + Amadeus + Ancestry.com + CCP Games + LivePerson + Yahoo! Japan + Tell your story +
    +
    +
    + + +
    + + +
    +{% include footer.html %} +{% include case-study-styles.html %} + + + diff --git a/case-studies/pearson.html b/case-studies/pearson.html new file mode 100644 index 0000000000..c488455b1d --- /dev/null +++ b/case-studies/pearson.html @@ -0,0 +1,88 @@ +--- +title: Pearson Case Study +--- + + + +{% include head-header.html %} + +
    +

    Pearson Case Study

    +
    + +
    +
    +
    +

    Using Kubernetes to reinvent the world’s largest educational company

    +

    + Pearson, the world’s education company, serving 75 million learners worldwide, set a goal to more than double that number to 200 million by 2025. A key part of this growth is in digital learning experiences, and that requires an infrastructure platform that is able to scale quickly and deliver products to market faster. So Pearson’s Cloud Technology team chose Kubernetes to help build a platform to meet the business requirements.

    +
    + Pearson +

    + “To transform our infrastructure, we had to think beyond simply enabling automated provisioning, we realized we had to build a platform that would allow Pearson developers to build manage and deploy applications in a completely different way. We chose Kubernetes because of its flexibility, ease of management and the way it would improve our engineers’ productivity.”

    +

    — Chris Jackson, Director for Cloud Product Engineering, Pearson

    +
    +
    +
    +
    + +
    +
    +
    +
    +

    Challenges:

    +
      +
    • Pearson had difficulty in scaling and adapting to the growing online audience. They wanted to build and deliver content primarily over the web.
    • +
    +
    +
    +

    Why Kubernetes:

    +
      +
    • Kubernetes will allow Pearson’s teams to develop their apps in a consistent manner, saving time and minimizing complexity.
    • +
    +
    +
    +

    Approach:

    +
      +
    • Build a centralized platform for use across the entire enterprise
    • +
    • Use container technology as the core of the platform
    • +
    • Deploy Kubernetes to manage the platform
    • +
    +
    +
    +

    Results:

    +
      +
    • Pearson is building an enterprise-wide platform for delivering innovative, web-based educational content. They expect engineers’ productivity to increase by up to 20 percent.
    • +
    +
    +
    +
    +
    + +
    +
    +
    +

    Kubernetes powers a comprehensive developer experience

    +

    Pearson wanted to use as much open source technology as possible for the platform given that it provides both technical and commercial benefits over the duration of the project. Jackson says, “Building an infrastructure platform based on open source technology in Pearson was a no-brainer, the sharing of technical challenges and advanced use cases in a community of people with talent far beyond what we could hire independently allows us to innovate at a level we could not reach on our own. Our engineers enjoy returning code to the community and participating in talks, blogs and meetings, it’s a great way for us to allow our team to express themselves and share the pride they have in their work.”

    +

    It also wanted to use a container-focused platform. Pearson has 400 development groups and diverse brands with varying business and technical needs. With containers, each brand could experiment with building new types of content using their preferred technologies, and then deliver it using containers. Pearson chose Kubernetes because it believes that is the best technology for managing containers, has the widest community support and offers the most flexible and powerful tools.“

    +

    Kubernetes is at the core of the platform we’ve built for developers. After we get our big spike in back-to-school in traffic, much of Pearson’s traffic will interact with Kubernetes. It is proving to be as effective as we had hoped,” Jackson says.

    +
    +
    +
    + +
    +
    +
    +

    Encouraging experimentation, saving engineers time

    +

    With the new platform, Pearson will increase stability and performance, and to bring products to market more quickly. The company says its engineers will also get a productivity boost because they won’t spend time managing infrastructure. Jackson estimates 15 to 20 percent in productivity savings.

    +

    Beyond that, Pearson says the platform will encourage innovation because of the ease with which new applications can be developed, and because applications will be deployed far more quickly than in the past. It expects that will help the company meet its goal of reaching 200 million learners within the next 10 years.

    +

    “We’re already seeing tremendous benefits with Kubernetes — improved engineering productivity, faster delivery of applications and a simplified infrastructure. But this is just the beginning. Kubernetes will help transform the way that educational content is delivered online,” says Jackson.

    +
    +
    +
    + +{% include footer.html %} +{% include case-study-styles.html %} + + + diff --git a/case-studies/wikimedia.html b/case-studies/wikimedia.html new file mode 100644 index 0000000000..d42522f850 --- /dev/null +++ b/case-studies/wikimedia.html @@ -0,0 +1,103 @@ +--- +title: Wikimedia Case Study +--- + + + +{% include head-header.html %} + +
    +

    Wikimedia Case Study

    +
    + +
    +
    +
    +

    Using Kubernetes to Build Tools to Improve the World's Wikis

    +

    + The non-profit Wikimedia Foundation operates some of the largest collaboratively edited reference projects in the world, including Wikipedia. To help users maintain and use wikis, it runs Wikimedia Tool Labs, a hosting environment for community developers working on tools and bots to help editors and other volunteers do their work, including reducing vandalism. The community around Wikimedia Tool Labs began forming nearly 10 years ago. +

    +
    + Wikimedia +

    + “Wikimedia Tool Labs is vital for making sure wikis all around the world work as well as they possibly can. Because it’s grown organically for almost 10 years, it has become an extremely challenging environment and difficult to maintain. It’s like a big ball of mud — you really can’t see through it. With Kubernetes, we’re simplifying the environment and making it easier for developers to build the tools that make wikis run better.” +

    +

    — Yuvi Panda, operations engineer at Wikimedia Foundation and Wikimedia Tool Labs

    +
    +
    +
    +
    + +
    +
    +
    +
    +

    Challenges:

    +
      +
    • Simplify a complex, difficult-to-manage infrastructure
    • +
    • Allow developers to continue writing tools and bots using existing techniques
    • +
    +
    +
    +

    Why Kubernetes:

    +
      +
    • Wikimedia Tool Labs chose Kubernetes because it can mimic existing workflows, while reducing complexity
    • +
    +
    +
    +

    Approach:

    +
      +
    • Migrate old systems and a complex infrastructure to Kubernetes
    • +
    +
    +
    +

    Results:

    +
      +
    • 20 percent of web tools that account for more than 40 percent of web traffic now run on Kubernetes
    • +
    • A 25-node cluster that keeps up with each new Kubernetes release
    • +
    • Thousands of lines of old code have been deleted, thanks to Kubernetes
    • +
    +
    +
    +
    +
    + +
    +
    +
    +

    Using Kubernetes to provide tools for maintaining wikis

    +

    + Wikimedia Tool Labs is run by a staff of four-and-a-half paid employees and two volunteers. The infrastructure didn't make it easy or intuitive for developers to build bots and other tools to make wikis work more easily. Yuvi says, “It’s incredibly chaotic. We have lots of Perl and Bash duct tape on top of it. Everything is super fragile.” +

    +

    + To solve the problem, Wikimedia Tool Labs migrated parts of its infrastructure to Kubernetes, in preparation for eventually moving its entire system. Yuvi said Kubernetes greatly simplifies maintenance. The goal is to allow developers creating bots and other tools to use whatever development methods they want, but make it easier for the Wikimedia Tool Labs to maintain the required infrastructure for hosting and sharing them. +

    +

    + “With Kubernetes, I’ve been able to remove a lot of our custom-made code, which makes everything easier to maintain. Our users’ code also runs in a more stable way than previously,” says Yuvi. +

    +
    +
    +
    + +
    +
    +
    +

    Simplifying infrastructure and keeping wikis running better

    +

    + Wikimedia Tool Labs has seen great success with the initial Kubernetes deployment. Old code is being simplified and eliminated, contributing developers don’t have to change the way they write their tools and bots, and those tools and bots run in a more stable fashion than they have in the past. The paid staff and volunteers are able to better keep up with fixing issues. +

    +

    + In the future, with a more complete migration to Kubernetes, Wikimedia Tool Labs expects to make it even easier to host and maintain the bots and tools that help run wikis across the world. The tool labs already host approximately 1,300 tools and bots from 800 volunteers, with many more being submitted every day. Twenty percent of the tool labs’ web tools that account for more than 60 percent of web traffic now run on Kubernetes. The tool labs has a 25-node cluster that keeps up with each new Kubernetes release. Many existing web tools are migrating to Kubernetes. +

    +

    + “Our goal is to make sure that people all over the world can share knowledge as easily as possible. Kubernetes helps with that, by making it easier for wikis everywhere to have the tools they need to thrive,” says Yuvi. +

    +
    +
    +
    + +{% include footer.html %} +{% include case-study-styles.html %} + + + diff --git a/js/script.js b/js/script.js index aed501d701..99574e7f83 100755 --- a/js/script.js +++ b/js/script.js @@ -132,8 +132,13 @@ var kub = (function () { } case 'home': + // case 'caseStudies': bodyHeight = windowHeight; break; + + case 'caseStudies': + bodyHeight = windowHeight * 2; + break; default: { bodyHeight = hero.outerHeight() + $('#mainContent').outerHeight(); From 05b2829c7cf75e221ccdd7b6e7e8d14d4d34033d Mon Sep 17 00:00:00 2001 From: "Tim St. Clair" Date: Tue, 30 Aug 2016 18:42:53 -0700 Subject: [PATCH 036/115] AppArmor documentation --- _data/guides.yml | 2 + docs/admin/apparmor/deny-write.profile | 10 + docs/admin/apparmor/hello-apparmor-pod.yaml | 13 + docs/admin/apparmor/index.md | 392 ++++++++++++++++++++ 4 files changed, 417 insertions(+) create mode 100644 docs/admin/apparmor/deny-write.profile create mode 100644 docs/admin/apparmor/hello-apparmor-pod.yaml create mode 100644 docs/admin/apparmor/index.md diff --git a/_data/guides.yml b/_data/guides.yml index 010733257d..2ae2ba44dc 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -286,3 +286,5 @@ toc: path: /docs/admin/salt/ - title: Monitoring Node Health path: /docs/admin/node-problem/ + - title: AppArmor + path: /docs/admin/apparmor/ diff --git a/docs/admin/apparmor/deny-write.profile b/docs/admin/apparmor/deny-write.profile new file mode 100644 index 0000000000..c2653c7112 --- /dev/null +++ b/docs/admin/apparmor/deny-write.profile @@ -0,0 +1,10 @@ +#include + +profile k8s-apparmor-example-deny-write flags=(attach_disconnected) { + #include + + file, + + # Deny all file writes. + deny /** w, +} diff --git a/docs/admin/apparmor/hello-apparmor-pod.yaml b/docs/admin/apparmor/hello-apparmor-pod.yaml new file mode 100644 index 0000000000..3e9b3b2a9c --- /dev/null +++ b/docs/admin/apparmor/hello-apparmor-pod.yaml @@ -0,0 +1,13 @@ +apiVersion: v1 +kind: Pod +metadata: + name: hello-apparmor + annotations: + # Tell Kubernetes to apply the AppArmor profile "k8s-apparmor-example-deny-write". + # Note that this is ignored if the Kubernetes node is not running version 1.4 or greater. + container.apparmor.security.beta.kubernetes.io/hello: localhost/k8s-apparmor-example-deny-write +spec: + containers: + - name: hello + image: busybox + command: [ "sh", "-c", "echo 'Hello AppArmor!' && sleep 1h" ] diff --git a/docs/admin/apparmor/index.md b/docs/admin/apparmor/index.md new file mode 100644 index 0000000000..395aba1989 --- /dev/null +++ b/docs/admin/apparmor/index.md @@ -0,0 +1,392 @@ +--- +assignees: +- stclair + +--- + +AppArmor is a Linux kernel enhancement that can reduce the potential attack surface of an +application and provide greater defense in depth for Applications. Beta support for AppArmor was +added in Kubernetes v1.4. + +* TOC +{:toc} + +## What is AppArmor + +AppArmor is a Linux kernel security module that supplements the standard Linux user and group based +permissions to confine programs to a limited set of resources. AppArmor can be configured for any +application to reduce its potential attack surface and provide greater defense in depth. It is +configured through profiles tuned to whitelist the access needed by a specific program or container, +such as Linux capabilities, network access, file permissions, etc. Each profile can be run in either +enforcing mode, which blocks access to disallowed resources, or complain mode, which only reports +violations. + +AppArmor can help you to run a more secure deployment by restricting what containers are allowed to +do, and /or providing better auditing through system logs. However, it is important to keep in mind +that AppArmor is not a silver bullet, and can only do so much to protect against exploits in your +application code. It is important to provide good, restrictive profiles, and harden your +applications and cluster from other angles as well. + +AppArmor support in Kubernetes is currently in beta. + +## Prerequisites + +1. **Kubernetes version is at least v1.4**. Kubernetes support for AppArmor was added in + v1.4. Kubernetes components older than v1.4 are not aware of the new AppArmor annotations, and + will **silently ignore** any AppArmor settings that are provided. To ensure that your Pods are + receiving the expected protections, it is important to verify the Kubelet version of your nodes: + + $ kubectl get nodes -o=jsonpath=$'{range .items[*]}{@.metadata.name}: {@.status.nodeInfo.kubeletVersion}\n{end}' + gke-test-default-pool-239f5d02-gyn2: v1.4.0 + gke-test-default-pool-239f5d02-x1kf: v1.4.0 + gke-test-default-pool-239f5d02-xwux: v1.4.0 + +2. **AppArmor kernel module is enabled**. For the Linux kernel to enforce an AppArmor profile, the + AppArmor kernel module must be installed and enabled. Several distributions enable the module by + default, such as Ubuntu and SUSE, and many others provide optional support. To check whether the + module is enabled, check the `/sys/module/apparmor/parameters/enabled` file: + + $ cat /sys/module/apparmor/parameters/enabled + Y + + If the Kubelet contains AppArmor support (>= v1.4), it will refuse to run a Pod with AppArmor + options if the kernel module is not enabled. + + *Note: Ubuntu carries many AppArmor patches that have not been merged into the upstream Linux + kernel, including patches that add additional hooks and features. Kubernetes has only been + tested with the upstream version, and does not promise support for other features.* + +3. **Container runtime is Docker**. Currently the only Kubernetes-supported container runtime that + also supports AppArmor is Docker. As more runtimes add AppArmor support, the options will be + expanded. You can verify that your nodes are running docker with: + + $ kubectl get nodes -o=jsonpath=$'{range .items[*]}{@.metadata.name}: {@.status.nodeInfo.containerRuntimeVersion}\n{end}' + gke-test-default-pool-239f5d02-gyn2: docker://1.11.2 + gke-test-default-pool-239f5d02-x1kf: docker://1.11.2 + gke-test-default-pool-239f5d02-xwux: docker://1.11.2 + + If the Kubelet contains AppArmor support (>= v1.4), it will refuse to run a Pod with AppArmor + options if the runtime is not Docker. + +4. **Profile is loaded**. AppArmor is applied to a Pod by specifying an AppArmor profile that each + container should be run with. If any of the specified profiles is not already loaded in the + kernel, the Kubelet (>= v1.4) will reject the Pod. You can view which profiles are loaded on a + node by checking the `/sys/kernel/security/apparmor/profiles` file. For example: + + $ ssh gke-test-default-pool-239f5d02-gyn2 "sudo cat /sys/kernel/security/apparmor/profiles | sort" + apparmor-test-deny-write (enforce) + apparmor-test-audit-write (enforce) + docker-default (enforce) + k8s-nginx (enforce) + + For more details on loading profiles on nodes, see + [Setting up nodes with profiles](#setting-up-nodes-with-profiles). + +As long as the Kubelet version includes AppArmor support (>= v1.4), the Kubelet will reject a Pod +with AppArmor options if any of the prerequisites are not met. You can also verify AppArmor support +on nodes by checking the node ready condition message (though this is likely to be removed in a +later release): + + $ kubectl get nodes -o=jsonpath=$'{range .items[*]}{@.metadata.name}: {.status.conditions[?(@.reason=="KubeletReady")].message}\n{end}' + gke-test-default-pool-239f5d02-gyn2: kubelet is posting ready status. AppArmor enabled + gke-test-default-pool-239f5d02-x1kf: kubelet is posting ready status. AppArmor enabled + gke-test-default-pool-239f5d02-xwux: kubelet is posting ready status. AppArmor enabled + +## Securing a Pod + +*Note: AppArmor is currently in beta, so options are specified as annotations. Once support graduates to +general availability, the annotations will be replaced with first-class fields (more details in +[Upgrade path to GA](#upgrade-path-to-general-availability)).* + +AppArmor profiles are specified *per-container*. To specify the AppArmor profile to run a Pod +container with, add an annotation to the Pod's metadata: + + container.apparmor.security.beta.kubernetes.io/: + +Where `` is the name of the container to apply the profile to, and `` +specifies the profile to apply. The `profile_ref` can be one of: + +- `runtime/default` to apply the runtime's default profile. +- `localhost/` to apply the profile loaded on the host with the name `` + +See the [API Reference](#api-reference) for the full details on the annotation and profile name formats. + +The Kubernetes AppArmor enforcement works by first checking that all the prerequisites have been +met, and then forwarding the profile selection to the container runtime for enforcement. If the +prerequisites have not been met, the Pod will be rejected, and will not run. + +To verify that the profile was applied, you can expect to see the AppArmor security option listed in the container created event: + + $ kubectl get events | grep Created + 22s 22s 1 hello-apparmor Pod spec.containers{hello} Normal Created {kubelet e2e-test-stclair-minion-group-31nt} Created container with docker id 269a53b202d3; Security:[seccomp=unconfined apparmor=k8s-apparmor-example-deny-write] + +You can also verify directly that the container's root process is running with the correct profile by checking its proc attr: + + $ kubectl exec cat /proc/1/attr/current + k8s-apparmor-example-deny-write (enforce) + +## Example + +In this example you'll see: + +- One way to load a profile on a node +- How to enforce the profile on a Pod +- How to check that the profile is loaded +- What happens when a profile is violated +- What happens when a profile cannot be loaded + +*This example assumes you have already set up a cluster with AppArmor support.* + +First, we need to load the profile we want to use onto our nodes. The profile we'll use simply +denies all file writes: + +{% include code.html language="text" file="deny-write.profile" ghlink="/docs/admin/apparmor/deny-write.profile" %} + +Since we don't know where the Pod will be scheduled, we'll need to load the profile on all our +nodes. For this example we'll just use SSH to install the profiles, but other approaches are +discussed in [Setting up nodes with profiles](#setting-up-nodes-with-profiles). + + $ NODES=( + # The SSH-accessible domain names of your nodes + gke-test-default-pool-239f5d02-gyn2.us-central1-a.my-k8s + gke-test-default-pool-239f5d02-x1kf.us-central1-a.my-k8s + gke-test-default-pool-239f5d02-xwux.us-central1-a.my-k8s) + $ for NODE in ${NODES[*]}; do ssh $NODE 'sudo apparmor_parser -q < + + profile k8s-apparmor-example-deny-write flags=(attach_disconnected) { + #include + + file, + + # Deny all file writes. + deny /** w, + } + EOF' + done + +Next, we'll run a simple "Hello AppArmor" pod with the deny-write profile: + +{% include code.html language="yaml" file="hello-apparmor-pod.yaml" ghlink="/docs/admin/apparmor/hello-apparmor-pod.yaml" %} + + $ kubectl create -f /dev/stdin < + Status: Failed + Reason: AppArmor + Message: Pod Cannot enforce AppArmor: profile "k8s-apparmor-example-allow-write" is not loaded + IP: + Controllers: + Containers: + hello: + Image: busybox + Port: + Command: + sh + -c + echo 'Hello AppArmor!' && sleep 1h + Requests: + cpu: 100m + Environment Variables: + Volumes: + default-token-dnz7v: + Type: Secret (a volume populated by a Secret) + SecretName: default-token-dnz7v + QoS Tier: Burstable + Events: + FirstSeen LastSeen Count From SubobjectPath Type Reason Message + --------- -------- ----- ---- ------------- -------- ------ ------- + 23s 23s 1 {default-scheduler } Normal Scheduled Successfully assigned hello-apparmor-2 to e2e-test-stclair-minion-group-t1f5 + 23s 23s 1 {kubelet e2e-test-stclair-minion-group-t1f5} Warning AppArmor Cannot enforce AppArmor: profile "k8s-apparmor-example-allow-write" is not loaded + +Note the pod status is Failed, with a helpful error message: `Pod Cannot enforce AppArmor: profile +"k8s-apparmor-example-allow-write" is not loaded`. An event was also recorded with the same message. + +## Administration + +### Setting up nodes with profiles + +Kubernetes does not currently provide any native mechanisms for loading AppArmor profiles onto +nodes. There are lots of ways to setup the profiles though, such as: + +- Through a [DaemonSet](../daemons/) that runs a Pod on each node to + ensure the correct profiles are loaded. An example implementation can be found + [here](https://github.com/kubernetes/contrib/tree/master/apparmor/loader). +- At node initialization time, using your node initialization scripts (e.g. Salt, Ansible, etc.) or + image. +- By copying the profiles to each node and loading them through SSH, as demonstrated in the + [Example](#example). + +The scheduler is not aware of which profiles are loaded onto which node, so the full set of profiles +must be loaded onto every node. An alternative approach is to add a node label for each profile (or +class of profiles) on the node, and use a +[node selector](../../user-guide/node-selection/) to ensure the Pod is run on a +node with the required profile. + +### Restricting profiles with the PodSecurityPolicy + +If the PodSecurityPolicy extension is enabled, cluster-wide AppArmor restrictions can be applied. To +enable the PodSecurityPolicy, two flags must be set on the `apiserver`: + + --admission-control=PodSecurityPolicy[,others...] + --runtime-config=extensions/v1beta1/podsecuritypolicy[,others...] + +With the extension enabled, the AppArmor options can be specified as annotations on the PodSecurityPolicy: + + apparmor.security.beta.kubernetes.io/defaultProfileName: + apparmor.security.beta.kubernetes.io/allowedProfileNames: [,others...] + +The default profile name option specifies the profile to apply to containers by default when none is +specified. The allowed profile names option specifies a list of profiles that Pod containers are +allowed to be run with. If both options are provided, the default must be allowed. The profiles are +specified in the same format as on containers. See the [API Reference](#api-reference) for the full +specification. + +### Disabling AppArmor + +If you do not want AppArmor to be available on your cluster, it can be disabled by a command-line flag: + + --feature-gates=AppArmor=false + +When disabled, any Pod that includes an AppArmor profile will fail validation with a "Forbidden" +error. Note that by default docker always enables the "docker-default" profile on non-privileged +pods (if the AppArmor kernel module is enabled), and will continue to do so even if the feature-gate +is disabled. The option to disable AppArmor will be removed when AppArmor graduates to general +availability (GA). + +### Upgrading to Kubernetes v1.4 with AppArmor + +No action is required with respect to AppArmor to upgrade your cluster to v1.4. However, if any +existing pods had an AppArmor annotation, they will not go through validation (or PodSecurityPolicy +admission). If permissive profiles are loaded on the nodes, a malicious user could pre-apply a +permissive profile to escalate the pod privileges above the docker-default. If this is a concern, it +is recommended to scrub the cluster of any pods containing an annotation with +`apparmor.security.beta.kubernetes.io`. + +### Upgrade path to General Availability + +When AppArmor is ready to be graduated to general availability (GA), the options currently specified +through annotations will be converted to fields. Supporting all the upgrade and downgrade paths +through the transition is very nuanced, and will be explained in detail when the transition +occurs. We will commit to supporting both fields and annotations for at least 2 releases, and will +explicitly reject the annotations for at least 2 releases after that. + +## Authoring Profiles + +Getting AppArmor profiles specified correctly can be a tricky business. Fortunately there are some +tools to help with that: + +- `aa-genprof` and `aa-logprof` generate profile rules by monitoring an application's activity and + logs, and admitting the actions it takes. Further instructions are provided by the + [AppArmor documentation](http://wiki.apparmor.net/index.php/Profiling_with_tools). +- [bane](https://github.com/jfrazelle/bane) is an AppArmor profile generator for Docker that uses a + simplified profile language. + +It is recommended to run your application through Docker on a development workstation to generate +the profiles, but there is nothing preventing running the tools on the Kubernetes node where your +Pod is running. + +To debug problems with AppArmor, you can check the system logs to see what, specifically, was +denied. AppArmor logs verbose messages to `dmesg`, and errors can usually be found in the system +logs or through `journalctl`. More information is provided in +[AppArmor failures](http://wiki.apparmor.net/index.php/AppArmor_Failures). + +Additional resources: + +- http://wiki.apparmor.net/index.php/QuickProfileLanguage +- http://wiki.apparmor.net/index.php/ProfileLanguage + +## API Reference + +**Pod Annotation**: + +Specifying the profile a container will run with: + +- **key**: `container.apparmor.security.beta.kubernetes.io/` + Where `` matches the name of a container in the Pod. + A separate profile can be specified for each container in the Pod. +- **value**: a profile reference, described below + +**Profile Reference**: + +- `runtime/default`: Refers to the default runtime profile. + - Equivalent to not specifying a profile (without a PodSecurityPolicy default), except it still + requires AppArmor to be enabled. + - For Docker, this resolves to the + [`docker-default`](https://docs.docker.com/engine/security/apparmor/) profile for non-privileged + containers, and unconfined (no profile) for privileged containers. +- `localhost/`: Refers to a profile loaded on the node (localhost) by name. + - The possible profile names are detailed in the + [core policy reference](http://wiki.apparmor.net/index.php/AppArmor_Core_Policy_Reference#Profile_names_and_attachment_specifications) + +Any other profile reference format is invalid. + +**PodSecurityPolicy Annotations** + +Specifying the default profile to apply to containers when none is provided: + +- **key**: `apparmor.security.beta.kubernetes.io/defaultProfileName` +- **value**: a profile reference, described above + +Specifying the list of profiles Pod containers are allowed to specify: + +- **key**: `apparmor.security.beta.kubernetes.io/allowedProfileNames` +- **value**: a comma-separated list of profile references (described above) + - Although an escaped comma is a legal character in a profile name, it cannot be explicitly + allowed here From 27f0b6f2a68ee5fcf0fe9ccf5ba222e120466636 Mon Sep 17 00:00:00 2001 From: nikhiljindal Date: Tue, 13 Sep 2016 18:33:09 -0700 Subject: [PATCH 037/115] Adding user guides for federation events and ns --- _data/reference.yml | 5 ++ docs/user-guide/federation/events.md | 39 ++++++++++ docs/user-guide/federation/index.md | 45 ++++++++++++ docs/user-guide/federation/namespaces.md | 90 ++++++++++++++++++++++++ 4 files changed, 179 insertions(+) create mode 100644 docs/user-guide/federation/events.md create mode 100644 docs/user-guide/federation/index.md create mode 100644 docs/user-guide/federation/namespaces.md diff --git a/_data/reference.yml b/_data/reference.yml index bf06023fb1..12fb095227 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -245,3 +245,8 @@ toc: 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 + +- title: Federation + section: + - title: User guide + path: /docs/user-guide/federation/ diff --git a/docs/user-guide/federation/events.md b/docs/user-guide/federation/events.md new file mode 100644 index 0000000000..a7e2a44a17 --- /dev/null +++ b/docs/user-guide/federation/events.md @@ -0,0 +1,39 @@ +--- +--- + +This guide explains how to use events in federation control plane to help in debugging. + + +* 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. + +## Overview + +Events in federation control plane (refered to as "federation events" in +this guide) are very similar to the traditional Kubernetes +Events providing the same functionality. +Federation Events are stored only in federation control plane and are not passed on to the underlying kubernetes clusters. + +Federation controllers create events as they process API resources to surface to the +user, the state that they are in. +You can get all events from federation apiserver by running: + +```shell +kubectl --context=federation-cluster get events +``` + +The standard kubectl get, update, delete commands will all work. diff --git a/docs/user-guide/federation/index.md b/docs/user-guide/federation/index.md new file mode 100644 index 0000000000..97ed5bdc8d --- /dev/null +++ b/docs/user-guide/federation/index.md @@ -0,0 +1,45 @@ +--- +--- + +This guide explains how we can manage multiple kubernetes clusters using +federation. +[Federation proposal](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/docs/proposals/federation.md) +details the use cases motivating cluster federation. + + +* TOC +{:toc} + +## Setup + +To be able to federate multiple clusters, we first need to setup a federation +control plane. +Follow the [setup guide](/docs/admin/federation/) to setup the +federation control plane. + +## 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 API resources can span different clusters +and cloud providers. + +## API resources + +Once we have the control plane setup, we can start creating federation API +resources. +Following guides explain some of the resources in detail: + +* [Services](/docs/user-guide/federation/federated-services/) +* [Events](/docs/user-guide/federation/events/) +* [Namespaces](/docs/user-guide/federation/namespaces/) + + +[API reference docs](/federation/docs/api-reference/readme/) lists all the +resources supported by federation apiserver. diff --git a/docs/user-guide/federation/namespaces.md b/docs/user-guide/federation/namespaces.md new file mode 100644 index 0000000000..522131bbb7 --- /dev/null +++ b/docs/user-guide/federation/namespaces.md @@ -0,0 +1,90 @@ +--- +--- + +This guide explains how to use namespaces in Federation control plane. + + +* 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 [Namespaces](/docs/user-guide/namespaces/) in particular. + +## Overview + +Namespaces in federation control plane (referred to as "federated namespaces" in +this guide) are very similar to the traditional [Kubernetes +Namespaces](/docs/user-guide/namespaces/) providing the same functionality. +Creating them in the federation control plane ensures that they are synchronized +across all the clusters in federation. + + +## Creating a Federated Namespace + +The API for Federated Namespaces is 100% compatible with the +API for traditional Kubernetes Namespaces. You can create a namespace by sending +a request to the federation apiserver. + +You can do that using kubectl by running: + +``` shell +kubectl --context=federation-cluster create -f myns.yaml +``` + +The '--context=federation-cluster' flag tells kubectl to submit the +request to the Federation apiserver instead of sending it to a kubernetes +cluster. + +Once a federated namespace is created, the federation control plane will create +a matching namespace in all underlying kubernetes clusters. +You can verify this by checking each of the underlying clusters, for example: + +``` shell +kubectl --context=gce-asia-east1a get namespaces myns +``` + +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 +spec of the underlying namespace will match those of +the Federated Namespace that you created above. + + +## Updating a Federated Namespace + +You can update a federated namespace as you would update a Kubernetes +namespace, just send the request to federation apiserver instead of sending it +to a specific kubernetes cluster. +Federation control plan will ensure that whenever the federated namespace is +updated, it updates the corresponding namespaces in all underlying clusters to +match it. + +## Deleting a Federated Namespace + +You can delete a federated namespace as you would delete a Kubernetes +namespace, just send the request to federation apiserver instead of sending it +to a specific kubernetes cluster. + +For example, you can do that using kubectl by running: + +```shell +kubectl --context=federation-cluster delete ns myns +``` + +As in Kubernetes, deleting a federated namespace will delete all resources in that +namespace from the federation control plane. + +Note that at this point, deleting a federated namespace will not delete the +corresponding namespaces and resources in those namespaces from underlying clusters. +Users are expected to delete them manually. +We intend to fix this in the future. From e6c31215e44d04096002024b51fd39260b5e7055 Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Wed, 14 Sep 2016 16:54:35 -0700 Subject: [PATCH 038/115] Use Debian for Calico NetworkPolicy --- docs/getting-started-guides/network-policy/calico.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/getting-started-guides/network-policy/calico.md b/docs/getting-started-guides/network-policy/calico.md index 45df4018fa..8efc32f068 100644 --- a/docs/getting-started-guides/network-policy/calico.md +++ b/docs/getting-started-guides/network-policy/calico.md @@ -8,6 +8,7 @@ You can deploy a cluster using Calico for network policy in the default [GCE dep ```shell export NETWORK_POLICY_PROVIDER=calico +export KUBE_NODE_OS_DISTRIBUTION=debian curl -sS https://get.k8s.io | bash ``` From 2be2ac9cec91cadec0dfb005b0eafc26a9f23b2c Mon Sep 17 00:00:00 2001 From: Chao Xu Date: Fri, 2 Sep 2016 15:29:35 -0700 Subject: [PATCH 039/115] update gc doc --- _data/guides.yml | 4 +-- docs/user-guide/garbage-collection.md | 36 +++++++++++++++++++++++++++ docs/user-guide/garbage-collector.md | 30 ---------------------- 3 files changed, 38 insertions(+), 32 deletions(-) create mode 100644 docs/user-guide/garbage-collection.md delete mode 100644 docs/user-guide/garbage-collector.md diff --git a/_data/guides.yml b/_data/guides.yml index b70623619a..0400272a2f 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -58,8 +58,8 @@ 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: Garbage Collection (Beta) + path: /docs/user-guide/garbage-collection/ - title: Using NetworkPolicy section: - title: Example Walkthrough diff --git a/docs/user-guide/garbage-collection.md b/docs/user-guide/garbage-collection.md new file mode 100644 index 0000000000..bae6ed442f --- /dev/null +++ b/docs/user-guide/garbage-collection.md @@ -0,0 +1,36 @@ +--- +assignees: +- caesarxuchao + +--- + +* TOC +{:toc} + +## Garbage Collection + +Note: the Garbage Collection is a beta feature and is enabled by default in Kubernetes version 1.4. + +### What does Garbage Collector do + +When you delete, for example, a ReplicaSet, it is often desirable for the server to automatically garbage collect all the Pods that the ReplicaSet creates. The Garbage Collector (GC) implements this. In general, when you delete an owner object, GC deletes that owner's dependent objects. + +### How to establish an owner-dependent relationship between objects + +Kubernetes 1.3 added a metadata.ownerReferences field to every Kubernetes API object. If an API object is a dependent of another object, ownerReference should point to the owning API object. + +When you create a ReplicationController or a ReplicaSet in Kubernetes 1.4, the Kubernetes control plane automatically sets the ownerReference field in each created pod to point to the owning ReplicationController or ReplicaSet. + +You can set up owner-dependent relationships among other objects by manually setting the ownerReference field on dependent objects. + +### Controlling whether Garbage Collector deletes dependents + +When deleting an object, you can request the GC to ***asynchronously*** delete its dependents by ***explicitly*** specifying `deleteOptions.orphanDependents=false` in the deletion request that you send to the API server. A 200 OK response from the API server indicates the owner is deleted. + +Synchronous garbage collection will be supported in 1.5 (tracking [issue](https://github.com/kubernetes/kubernetes/issues/29891)). + +If you specify `deleteOptions.orphanDependents=true`, or leave it blank, then the GC will first reset the `ownerReferences` in the dependents, then delete the owner. Note that the deletion of the owner object is asynchronous, that is, a 200 OK response will be sent by the API server before the owner object gets deleted. + +### Other references +[Design Doc](https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/garbage-collection.md) +[Known issues](https://github.com/kubernetes/kubernetes/issues/26120) diff --git a/docs/user-guide/garbage-collector.md b/docs/user-guide/garbage-collector.md deleted file mode 100644 index e31855ac41..0000000000 --- a/docs/user-guide/garbage-collector.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -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`. - From 36fefcf87343ac66703561c6442e513611692a01 Mon Sep 17 00:00:00 2001 From: Pallav Agarwal Date: Mon, 5 Sep 2016 13:50:49 +0530 Subject: [PATCH 040/115] Correct broken links - fix #1154, fix #1161, fix #1162, fix #1163 Fix some broken links in documentation, as well as add a dummy page for single-node docker with deprecation notice to prevent error with old links. --- docs/admin/dns.md | 2 +- docs/getting-started-guides/docker.md | 3 +++ docs/user-guide/kubectl/kubectl_version.md | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 docs/getting-started-guides/docker.md diff --git a/docs/admin/dns.md b/docs/admin/dns.md index bdd0848cf9..a85f2338ce 100644 --- a/docs/admin/dns.md +++ b/docs/admin/dns.md @@ -41,7 +41,7 @@ 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 +See the [Cluster Federation Administrators' Guide](/docs/admin/federation) for more details on Cluster Federation and multi-site support. ## References diff --git a/docs/getting-started-guides/docker.md b/docs/getting-started-guides/docker.md new file mode 100644 index 0000000000..9044058834 --- /dev/null +++ b/docs/getting-started-guides/docker.md @@ -0,0 +1,3 @@ +# *Stop. This guide has been superseded by [Minikube](../minikube/). The link below is present only for historical purposes* + +The document has been moved to [here](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/local-cluster/docker.md) diff --git a/docs/user-guide/kubectl/kubectl_version.md b/docs/user-guide/kubectl/kubectl_version.md index 1392de872a..014d7f5e7b 100644 --- a/docs/user-guide/kubectl/kubectl_version.md +++ b/docs/user-guide/kubectl/kubectl_version.md @@ -50,7 +50,7 @@ kubectl version ### SEE ALSO -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager +* [kubectl](../kubectl.md) - kubectl controls the Kubernetes cluster manager ###### Auto generated by spf13/cobra on 12-Aug-2016 From 6697485f54a140aa83b60fe697b5c70c1ad2050b Mon Sep 17 00:00:00 2001 From: keglevich3 Date: Thu, 15 Sep 2016 17:19:13 +0300 Subject: [PATCH 041/115] This feature wasn't ready in 1.3V --- docs/user-guide/node-selection/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/node-selection/index.md b/docs/user-guide/node-selection/index.md index 74831ace0c..b743948612 100644 --- a/docs/user-guide/node-selection/index.md +++ b/docs/user-guide/node-selection/index.md @@ -67,7 +67,7 @@ met, the pod will still continue to run on the node. In the future we plan to of `requiredDuringSchedulingRequiredDuringExecution` which will be just like `requiredDuringSchedulingIgnoredDuringExecution` except that it will evict pods from nodes that cease to satisfy the pods' node affinity requirements. -Node affinity is currently expressed using an annotation on Pod. In v1.3 it will use a field, and we will +Node affinity is currently expressed using an annotation on Pod. In v1.4 it will use a field, and we will also introduce the second piece of the affinity mechanism, called pod affinity, which allows you to control whether a pod schedules onto a particular node based on which other pods are running on the node, rather than the labels on the node. From 251a6a55f83b1c0bcbeea86ae417e3f7c828592d Mon Sep 17 00:00:00 2001 From: deads2k Date: Tue, 13 Sep 2016 08:14:44 -0400 Subject: [PATCH 042/115] describe subjectaccessreview --- docs/admin/authorization.md | 39 +++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/docs/admin/authorization.md b/docs/admin/authorization.md index 18e97398a3..43dabe7584 100644 --- a/docs/admin/authorization.md +++ b/docs/admin/authorization.md @@ -500,3 +500,42 @@ to a remote authorization service. Authorization modules can implement their own caching to reduce the cost of repeated authorization calls with the same or similar arguments. Developers should then consider the interaction between caching and revocation of permissions. + + +### Checking API Access + +Kubernetes exposes the `subjectaccessreviews.v1beta1.authorization.k8s.io` resource as a +normal resource that allows external access to API authorizer decisions. No matter which authorizer +you choose to use, you can issue a `POST` with a `SubjectAccessReview` just like the webhook +authorizer to the `apis/authorization.k8s.io/v1beta1/subjectaccessreviews` endpoint and +get back a response. For instance: + +```bash +kubectl create --v=8 -f - << __EOF__ +{ + "apiVersion": "authorization.k8s.io/v1beta1", + "kind": "SubjectAccessReview", + "spec": { + "resourceAttributes": { + "namespace": "kittensandponies", + "verb": "GET", + "group": "unicorn.example.org", + "resource": "pods" + }, + "user": "jane", + "group": [ + "group1", + "group2" + ] + } +} +__EOF__ + +--- snip lots of output --- + +I0913 08:12:31.362873 27425 request.go:908] Response Body: {"kind":"SubjectAccessReview","apiVersion":"authorization.k8s.io/v1beta1","metadata":{"creationTimestamp":null},"spec":{"resourceAttributes":{"namespace":"kittensandponies","verb":"GET","group":"*","resource":"pods"},"user":"jane","group":["group1","group2"]},"status":{"allowed":true}} +subjectaccessreview "" created +``` + +This is useful for debugging access problems, in that you can use this resource +to determine what access an authorizer is granting. \ No newline at end of file From d56e805a68ffb456420635e842e0386f32060a2a Mon Sep 17 00:00:00 2001 From: Lantao Liu Date: Mon, 12 Sep 2016 17:01:02 -0700 Subject: [PATCH 043/115] Add document for node conformance test. --- _data/guides.yml | 2 + docs/admin/node-conformance.md | 114 +++++++++++++++++++++++++++++++++ docs/admin/node-problem.md | 2 +- 3 files changed, 117 insertions(+), 1 deletion(-) create mode 100644 docs/admin/node-conformance.md diff --git a/_data/guides.yml b/_data/guides.yml index 269eecebf6..40dddeaf37 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -227,6 +227,8 @@ toc: path: /docs/getting-started-guides/ubuntu/ - title: Ubuntu Nodes with Calico path: /docs/getting-started-guides/ubuntu-calico/ + - title: Validate Node Setup + path: /docs/admin/node-conformance - title: Portable Multi-Node Cluster path: /docs/getting-started-guides/docker-multinode/ - title: Building Large Clusters diff --git a/docs/admin/node-conformance.md b/docs/admin/node-conformance.md new file mode 100644 index 0000000000..2adb159c5c --- /dev/null +++ b/docs/admin/node-conformance.md @@ -0,0 +1,114 @@ +--- +assignees: +- Random-Liu + +--- + +* TOC +{:toc} + +## Node Conformance Test + +*Node conformance test* is a test framework validating whether a node meets the +minimum requirement of Kubernetes with a set of system verification and +functionality test. A node which passes the tests is qualified to join a +Kubernetes cluster. + +## Limitations + +There are following limitations in the current implementation of node +conformance test. They'll be improved in future version. + +* Node conformance test only supports Docker as the container runtime. +* Node conformance test doesn't validate network related system configurations + and functionalities. + +## Prerequisite + +Node conformance test is used to test whether a node is ready to join a +Kubernetes cluster, so the prerequisite is the same with a standard Kubernetes +node. At least, the node should have properly installed: + +* Container Runtime (Docker) +* Kubelet + +Node conformance test validates kernel configurations. If the kenrel module +`configs` is built as module in your environment, it must be loaded before the +test. (See [Caveats #3](#caveats) for more information) + +## Usage + +### Run Node Conformance Test + +* **Step 1:** Point your Kubelet to localhost `--api-servers="http://localhost:8080"`, +because the test framework starts a local master to test Kubelet. + +* **Step 2:** Run the node conformance test with command: + +```shell +# $CONFIG_DIR is the pod manifest path of your kubelet. +# $LOG_DIR is the test output path. +sudo docker run -it --rm --privileged --net=host \ + -v /:/rootfs:ro -v /var/run:/var/run \ + -v $CONFIG_DIR:/etc/manifest -v $LOG_DIR:/var/result \ + gcr.io/google_containers/node-test-amd64:v0.1 +``` + +### Run Node Conformance Test for Other Architectures + +We also build node conformance test docker images for other architectures: + + Arch | Image | +--------|:-----------------:| + amd64 | node-test-amd64 | + arm | node-test-arm | + arm64 | node-test-arm64 | + +### Run Selected Test + +In fact, Node conformance test is a containerized version of [node e2e +test](https://github.com/kubernetes/kubernetes/blob/release-1.4/docs/devel/e2e-node-tests.md). +By default, it runs all conformance test. + +Theoretically, you can run any node e2e test if you configure the container and +mount required volumes properly. But **it is strongly recommended to only run conformance +test**, because the non-conformance test needs much more complex framework configuration. + +To run specific tests, overwrite the environment variable `FOCUS` with the +regular expression of tests you want to run. + +```shell +sudo docker run -it --rm --privileged --net=host \ + -v /:/rootfs:ro -v /var/run:/var/run \ + -v $CONFIG_DIR:/etc/manifest -v $LOG_DIR:/var/result \ + -e FOCUS=MirrorPod \ # Only run MirrorPod test + gcr.io/google_containers/node-test-amd64:v0.1 +``` + +To skip specific tests, overwrite the environment variable `SKIP` with the +regular expression of tests you want to skip. + +```shell +sudo docker run -it --rm --privileged --net=host \ + -v /:/rootfs:ro -v /var/run:/var/run \ + -v $CONFIG_DIR:/etc/manifest -v $LOG_DIR:/var/result \ + -e SKIP=MirrorPod \ # Run all conformance test and skip MirrorPod test + gcr.io/google_containers/node-test-amd64:v0.1 +``` + +### Caveats + +* The test will leave some docker images on the node, including the node + conformance test image and images of containers used in the functionality + test. +* The test will leave dead containers on the node, these containers are created + during the functionality test. +* Node conformance test validates kernel configuration. However, in some os + distro the kernel module `configs` may not be loaded by default, and you will get + the error `no config path in [POSSIBLE KERNEL CONFIG FILE PATHS] is + available`. In that case please do either of the followings: + * Manually load/unload `configs` kernel module: run `sudo modprobe configs` to + load the kernel module, and `sudo modprobe -r configs` to unload it after the test. + * Mount `modprobe` into the container: Add option `-v /bin/kmod:/bin/kmod + -v /sbin/modprobe:/sbin/modprobe -v /lib/modules:/lib/modules` when starting + the test container. diff --git a/docs/admin/node-problem.md b/docs/admin/node-problem.md index abb08abeff..b6926ba15b 100644 --- a/docs/admin/node-problem.md +++ b/docs/admin/node-problem.md @@ -36,7 +36,7 @@ it to [support other log format](/docs/admin/node-problem/#support-other-log-for ## Enable/Disable in GCE cluster -Node problem detector is [running as a cluster addon](cluster-large.md/#Addon-Resources) enabled by default in the +Node problem detector is [running as a cluster addon](cluster-large.md/#addon-resources) enabled by default in the gce cluster. You can enable/disable it by setting the environment variable From c77492ab79a2d0845e0b71c10a4bf898bd026042 Mon Sep 17 00:00:00 2001 From: Matthew Wong Date: Thu, 15 Sep 2016 15:41:05 -0400 Subject: [PATCH 044/115] Update gluster provisioner parameters --- docs/user-guide/persistent-volumes/index.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/user-guide/persistent-volumes/index.md b/docs/user-guide/persistent-volumes/index.md index 8f6bf30a25..48b5f2c630 100644 --- a/docs/user-guide/persistent-volumes/index.md +++ b/docs/user-guide/persistent-volumes/index.md @@ -365,7 +365,7 @@ parameters: #### GLUSTERFS ```yaml -apiVersion: extensions/v1beta1 +apiVersion: storage.k8s.io/v1beta1 kind: StorageClass metadata: name: slow @@ -373,14 +373,16 @@ 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 a valid URL and this is a mandatory parameter for GlusterFS dynamic provisioner. -* `restuser` : Gluster REST service user who has access to create volumes in the Gluster Trusted Pool. This parameter is optional, empty string will be used when omitted. -* `restuserkey` : Gluster REST service user's password which will be used for authentication to the REST server. This parameter is optional, empty string will be used when omitted. +* `resturl` : Gluster REST service url which provisions gluster volumes on demand. The format should be `IPaddress:Port` and this parameter is mandatory when using the GlusterFS dynamic provisioner. +* `restauthenabled` : A boolean value that indicates whether Gluster REST service authentication is enabled on the REST server. If this value is 'true', you must supply values for the 'restuser' and 'restuserkey' parameters." +* `restuser` : Gluster REST service user, who has access to create volumes in the Gluster Trusted Pool. +* `restuserkey` : Gluster REST service user's password, will be used for authentication to the REST server. #### OpenStack Cinder From ef8229f2c6ede7ae88989a83c2752f7db1b23c40 Mon Sep 17 00:00:00 2001 From: Kazuki Suda Date: Fri, 16 Sep 2016 16:23:14 +0900 Subject: [PATCH 045/115] Fix broken link in the authorization page --- docs/admin/authorization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin/authorization.md b/docs/admin/authorization.md index 18e97398a3..3b1fa47e4d 100644 --- a/docs/admin/authorization.md +++ b/docs/admin/authorization.md @@ -204,7 +204,7 @@ 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]( -cluster-management.md/#Turn-on-or-off-an-API-version-for-your-cluster), +/docs/admin/cluster-management/#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 From 9c00377c7c04fb2642f264f392f10f4ed47dcd26 Mon Sep 17 00:00:00 2001 From: Matthew Wong Date: Fri, 16 Sep 2016 10:32:30 -0400 Subject: [PATCH 046/115] Add section on Storage Classes to PV doc This reverts commit 5099afc2c4f6a0aebd4e7091e565da0005a63384. --- docs/user-guide/persistent-volumes/index.md | 189 +++++++++++++++++++- 1 file changed, 186 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/persistent-volumes/index.md b/docs/user-guide/persistent-volumes/index.md index fdfba107e8..32ac8fbd00 100644 --- a/docs/user-guide/persistent-volumes/index.md +++ b/docs/user-guide/persistent-volumes/index.md @@ -20,6 +20,21 @@ 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). +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/). @@ -29,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. Once bound, `PersistentVolumeClaim` binds are exclusive, regardless of the mode used to bind them. +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. @@ -49,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 @@ -78,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 @@ -130,6 +153,16 @@ In the CLI, the access modes are abbreviated to: | 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 @@ -161,6 +194,8 @@ kind: PersistentVolumeClaim apiVersion: v1 metadata: name: myclaim + annotations: + volume.beta.kubernetes.io/storage-class: "slow" spec: accessModes: - ReadWriteOnce @@ -191,6 +226,41 @@ Claims can specify a [label selector](/docs/user-guide/labels/#label-selectors) 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. @@ -216,3 +286,116 @@ spec: ### 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. From fe499ca73eb9623d26be37525b90b5d38e664759 Mon Sep 17 00:00:00 2001 From: Matthew Wong Date: Fri, 16 Sep 2016 10:33:33 -0400 Subject: [PATCH 047/115] Update StorageClass docs This reverts commit f4c98ddce734099b76255399b60cd424203f85ed. --- docs/user-guide/persistent-volumes/index.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/user-guide/persistent-volumes/index.md b/docs/user-guide/persistent-volumes/index.md index 32ac8fbd00..8f6bf30a25 100644 --- a/docs/user-guide/persistent-volumes/index.md +++ b/docs/user-guide/persistent-volumes/index.md @@ -238,7 +238,7 @@ 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) +[`DefaultStorageClass` admission plugin](/docs/admin/admission-controllers/#defaultstorageclass) is turned on. * If the admission plugin is turned on, the administrator may specify a @@ -256,7 +256,8 @@ 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. +the requested labels may be bound to the PVC. Note that currently, a PVC with a +non-empty `selector` can't have a PV dynamically provisioned for it. In the future after beta, the `volume.beta.kubernetes.io/storage-class` annotation will become an attribute. @@ -295,13 +296,12 @@ 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. +of a class 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) +[`PersistentVolumeClaim` section](#persistentvolumeclaims) for details. ```yaml @@ -373,16 +373,14 @@ 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. +* `resturl` : Gluster REST service url which provision gluster volumes on demand. The format should be a valid URL and this is a mandatory parameter for GlusterFS dynamic provisioner. +* `restuser` : Gluster REST service user who has access to create volumes in the Gluster Trusted Pool. This parameter is optional, empty string will be used when omitted. +* `restuserkey` : Gluster REST service user's password which will be used for authentication to the REST server. This parameter is optional, empty string will be used when omitted. #### OpenStack Cinder From ebd9318f37b86c09456d764b04e8a3355af2dd0c Mon Sep 17 00:00:00 2001 From: Piotr Szczesniak Date: Tue, 6 Sep 2016 20:11:24 +0200 Subject: [PATCH 048/115] Added Rescheduler documentation --- docs/admin/rescheduler.md | 58 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 docs/admin/rescheduler.md diff --git a/docs/admin/rescheduler.md b/docs/admin/rescheduler.md new file mode 100644 index 0000000000..f32c185c81 --- /dev/null +++ b/docs/admin/rescheduler.md @@ -0,0 +1,58 @@ +--- +assignees: +- davidopp +- filipg +- piosz + +--- + +* TOC +{:toc} + +# "Guaranteed" scheduling of critical add-on pods + +## Critical add-ons + +In addition to Kubernetes core components like api-server, scheduler, controller-manager running on a master machine +there are a number of add-ons which, for various reasons, must run on a regular cluster node (rather than the Kubernetes master). +Some of these add-ons are critical to a fully functional cluster, such as Heapster, DNS, and UI. +A cluster may stop working properly if a critical add-on is evicted (either manually or as a side effect of another operation like upgrade) +and becomes pending (for example when the cluster is highly utilized and either there are other pending pods that schedule into the space +vacated by the evicted critical add-on pod or the amount of resources available on the node changed for some other reason). + +## Rescheduler: guaranteed scheduling of critical add-ons + +Rescheduler ensures that critical add-ons are always scheduled +(assuming the cluster has enough resources to run the critical add-on pods in the absence of regular pods). +If the scheduler determines that no node has enough free resources to run the critical add-on pod +given the pods that are already running in the cluster +(indicated by critical add-on pod's pod condition PodScheduled set to false, the reason set to Unschedulable) +the rescheduler tries to free up space for the add-on by evicting some pods; then the scheduler will schedule the add-on pod. + +To avoid situation when another pod is scheduled into the space prepared for the critical add-on, +the chosen node gets a temporary taint “CriticalAddonsOnly” before the eviction(s) +(see [more details](https://github.com/kubernetes/kubernetes/blob/master/docs/design/taint-toleration-dedicated.md)). +Each critical add-on has to tolerate it, +the other pods shouldn't tolerate the taint. The tain is removed once the add-on is successfully scheduled. + +*Warning:* currently there is no guarantee which node is chosen and which pods are being killed +in order to schedule crical pod, so if rescheduler is enabled you pods might be occasionally +killed for this purpose. + +## Config + +Rescheduler doesn't have any user facing configuration (component config) or API. +It's enabled by default. It can be disabled: +* during cluster setup by setting `ENABLE_RESCHEDULER` flag to `false` +* on running cluster by deleting its manifest from master node +(default path `/etc/kubernetes/manifests/rescheduler.manifest`) + +### Marking add-on as critical + +To be critical an add-on has to run in `kube-system` namespace (cofigurable via flag) +and have the following annotations specified: +* `scheduler.alpha.kubernetes.io/critical-pod` set to empty string +* `scheduler.alpha.kubernetes.io/tolerations` set to `[{"key":"CriticalAddonsOnly", "operator":"Exists"}]` + +The first one marks a pod a critical. The second one is required by Rescheduler algorithm. + From dd8133f716ba2f1772cf556a3fef9bd351196966 Mon Sep 17 00:00:00 2001 From: markturansky Date: Mon, 12 Sep 2016 12:08:47 -0400 Subject: [PATCH 049/115] added pvc quota to docs --- docs/admin/resourcequota/index.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/admin/resourcequota/index.md b/docs/admin/resourcequota/index.md index d3073848ba..bda5120121 100644 --- a/docs/admin/resourcequota/index.md +++ b/docs/admin/resourcequota/index.md @@ -52,8 +52,10 @@ Resource Quota is enforced in a particular namespace when there is a ## Compute Resource Quota -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: +You can limit the total sum of [compute resources](/docs/user-guide/compute-resources) and [storage resources](/docs/user-guide/persistent-volumes) +that can be requested in a given namespace. + +The following resource types are supported: | Resource Name | Description | | ------------ | ----------- | @@ -63,6 +65,7 @@ in a namespace can be limited. The following compute resource types are support | `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. | +| `requests.storage` | Across all persistent volume claims, the sum of storage requests cannot exceed this value. | ## Object Count Quota From bf8b978cc97d283e1aa5d52f9347831cb668d13a Mon Sep 17 00:00:00 2001 From: Sam Stoelinga Date: Fri, 16 Sep 2016 12:51:51 -0700 Subject: [PATCH 050/115] Fix update-demo references to doc location It seems docs were moved from kubernetes repo and now live in the website repo. I've updated the update-demo docs to work again with actual references. --- docs/user-guide/update-demo/index.md | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/docs/user-guide/update-demo/index.md b/docs/user-guide/update-demo/index.md index aa10b2a362..d51bcffc08 100644 --- a/docs/user-guide/update-demo/index.md +++ b/docs/user-guide/update-demo/index.md @@ -13,11 +13,11 @@ here](https://github.com/kubernetes/kubernetes.github.io/tree/{{page.docsbranch} ### Step Zero: Prerequisites -This example assumes that you have forked the repository and [turned up a Kubernetes cluster](/docs/getting-started-guides/): +This example assumes that you have forked the docs repository and [turned up a Kubernetes cluster](/docs/getting-started-guides/): ```shell -$ cd kubernetes -$ ./cluster/kube-up.sh +$ git clone -b {{page.docsbranch}} https://github.com/kubernetes/kubernetes.github.io +$ cd kubernetes.github.io ``` ### Step One: Turn up the UX for the demo @@ -81,14 +81,7 @@ This first stops the replication controller by turning the target number of repl ### Step Six: Cleanup -To turn down a Kubernetes cluster: - -```shell -$ ./cluster/kube-down.sh -``` - -Kill the proxy running in the background: -After you are done running this demo make sure to kill it: +After you are done running this demo make sure to kill the proxy running in the background: ```shell $ jobs From dccb798817f7fef9ddcf93f78bfe020e82dbd9e8 Mon Sep 17 00:00:00 2001 From: nikhiljindal Date: Wed, 14 Sep 2016 18:24:18 -0700 Subject: [PATCH 051/115] Changing the path at which federation api reference docs are copied --- _data/overrides.yml | 2 +- update-imported-docs.sh | 54 ++++++++++++++++++++++++++++------------- 2 files changed, 38 insertions(+), 18 deletions(-) diff --git a/_data/overrides.yml b/_data/overrides.yml index 2506ba82f7..d38226e61b 100644 --- a/_data/overrides.yml +++ b/_data/overrides.yml @@ -8,11 +8,11 @@ overrides: - path: docs/admin/kube-proxy.md - path: docs/admin/kube-scheduler.md - path: docs/admin/kubelet.md -- path: federation/docs/api-reference - changedpath: docs/api-reference/extensions/v1beta1/definitions.html _includes/v1.4/extensions-v1beta1-definitions.html - changedpath: docs/api-reference/extensions/v1beta1/operations.html _includes/v1.4/extensions-v1beta1-operations.html - changedpath: docs/api-reference/v1/definitions.html _includes/v1.4/v1-definitions.html - changedpath: docs/api-reference/v1/operations.html _includes/v1.4/v1-operations.html +- copypath: k8s/federation/docs/api-reference/ docs/federation/ - 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/update-imported-docs.sh b/update-imported-docs.sh index 0a3bfa4f39..2b9203e168 100755 --- a/update-imported-docs.sh +++ b/update-imported-docs.sh @@ -5,6 +5,33 @@ VERSION=1.4 +# Processes api reference docs. +function process_api_ref_docs { + # Replace html preview links by relative links to let k8s.io render them. + local html_preview_prefix="https:\/\/htmlpreview.github.io\/?https:\/\/github.com\/kubernetes\/kubernetes\/blob\/" + find . -name '*.*' -type f -exec sed -i -e "s/${html_preview_prefix}HEAD//g" {} \; + find . -name '*.*' -type f -exec sed -i -e "s/${html_preview_prefix}release-$VERSION//g" {} \; + + # Format html + find . -name '*.html' -type f -exec sed -i -e '/ +

    partially update status of the specified Namespace

    @@ -4918,7 +4685,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Parameters

    +

    Parameters

    @@ -4968,7 +4735,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Responses

    +

    Responses

    @@ -4993,7 +4760,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Consumes

    +

    Consumes

    • @@ -5009,149 +4776,6 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    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

      @@ -5179,10 +4803,10 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    list or watch objects of kind Service

    +

    list or watch objects of kind Secret

    -
    GET /api/v1/services
    +
    GET /api/v1/secrets
    @@ -5278,7 +4902,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

    200

    success

    -

    v1.ServiceList

    +

    v1.SecretList

    @@ -5322,10 +4946,10 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    watch individual changes to a list of Event

    +

    list or watch objects of kind Service

    -
    GET /api/v1/watch/events
    +
    GET /api/v1/services
    @@ -5421,7 +5045,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

    200

    success

    -

    *versioned.Event

    +

    v1.ServiceList

    @@ -5445,14 +5069,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

    application/json

  • -

    application/json;stream=watch

    +

    application/yaml

  • application/vnd.kubernetes.protobuf

  • -
  • -

    application/vnd.kubernetes.protobuf;stream=watch

    -
  • @@ -5468,10 +5089,10 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    watch individual changes to a list of Namespace

    +

    watch individual changes to a list of Event

    -
    GET /api/v1/watch/namespaces
    +
    GET /api/v1/watch/events
    @@ -5614,6 +5235,152 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    +

    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 Event

    @@ -5621,7 +5388,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Parameters

    +

    Parameters

    @@ -5703,7 +5470,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Responses

    +

    Responses

    @@ -5728,7 +5495,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Consumes

    +

    Consumes

    • @@ -5738,7 +5505,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Produces

    +

    Produces

    • @@ -5757,7 +5524,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Tags

    +

    Tags

    • @@ -5775,7 +5542,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Parameters

    +

    Parameters

    @@ -5865,7 +5632,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Responses

    +

    Responses

    @@ -5890,7 +5657,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Consumes

    +

    Consumes

    • @@ -5900,7 +5667,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Produces

    +

    Produces

    • @@ -5919,7 +5686,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Tags

    +

    Tags

    • @@ -5937,7 +5704,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Parameters

    +

    Parameters

    @@ -6019,7 +5786,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Responses

    +

    Responses

    @@ -6044,7 +5811,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Consumes

    +

    Consumes

    • @@ -6054,7 +5821,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Produces

    +

    Produces

    • @@ -6073,7 +5840,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Tags

    +

    Tags

    • @@ -6091,7 +5858,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Parameters

    +

    Parameters

    @@ -6181,7 +5948,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Responses

    +

    Responses

    @@ -6206,7 +5973,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Consumes

    +

    Consumes

    • @@ -6216,7 +5983,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Produces

    +

    Produces

    • @@ -6235,7 +6002,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Tags

    +

    Tags

    • @@ -6253,7 +6020,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Parameters

    +

    Parameters

    @@ -6335,7 +6102,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Responses

    +

    Responses

    @@ -6360,7 +6127,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Consumes

    +

    Consumes

    • @@ -6370,7 +6137,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Produces

    +

    Produces

    • @@ -6389,7 +6156,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Tags

    +

    Tags

    • @@ -6407,7 +6174,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Parameters

    +

    Parameters

    @@ -6497,7 +6264,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Responses

    +

    Responses

    @@ -6522,7 +6289,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Consumes

    +

    Consumes

    • @@ -6532,7 +6299,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Produces

    +

    Produces

    • @@ -6551,7 +6318,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Tags

    +

    Tags

    • @@ -6569,7 +6336,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    Parameters

    +

    Parameters

    @@ -6649,152 +6416,6 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -
    -
    -

    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

    @@ -6862,10 +6483,10 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    -

    watch individual changes to a list of Service

    +

    watch individual changes to a list of Secret

    -
    GET /api/v1/watch/services
    +
    GET /api/v1/watch/secrets
    @@ -7007,12 +6628,158 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
    +
    +

    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

      +
    • +
    +
    +
    +
    From aaecc8f75db4db3b7a3579c2f38aef4cdaf65988 Mon Sep 17 00:00:00 2001 From: nikhiljindal Date: Tue, 13 Sep 2016 15:54:29 -0700 Subject: [PATCH 053/115] Adding references to federation docs on left side navigation --- _data/reference.yml | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/_data/reference.yml b/_data/reference.yml index f9de6e8f04..dca3bb90ef 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -250,5 +250,13 @@ toc: - title: Federation section: - - title: User guide + - title: User guide path: /docs/user-guide/federation/ + - title: Federation API + path: /docs/federation/api-reference/README/ + - title: Federation Components + section: + - title: federation-apiserver + path: /docs/admin/federation-apiserver.md + - title : federation-controller-mananger + path: /docs/admin/federation-controller-manager.md From 2ee8a639fba4249ccfcca069f3c8b24d0c5ac558 Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Wed, 7 Sep 2016 10:12:30 -0700 Subject: [PATCH 054/115] Add Calico, NetworkPolicy to the from-scratch networking section. --- docs/getting-started-guides/scratch.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/docs/getting-started-guides/scratch.md b/docs/getting-started-guides/scratch.md index c59d22ba1c..f658fb4c1e 100644 --- a/docs/getting-started-guides/scratch.md +++ b/docs/getting-started-guides/scratch.md @@ -57,6 +57,7 @@ on how flags are set on various components. ### Network +#### Network Connectivity Kubernetes has a distinctive [networking model](/docs/admin/networking). Kubernetes allocates an IP address to each pod. When creating a cluster, you @@ -66,21 +67,25 @@ the node is added. A process in one pod should be able to communicate with another pod using the IP of the second pod. This connectivity can be accomplished in two ways: -- Configure network to route Pod IPs +- **Configure underlay network to route Pod IPs** - Harder to setup from scratch. - Google Compute Engine ([GCE](/docs/getting-started-guides/gce)) and [AWS](/docs/getting-started-guides/aws) guides use this approach. - - Need to make the Pod IPs routable by programming routers, switches, etc. - - Can be configured external to Kubernetes, or can implement in the "Routes" interface of a Cloud Provider module. + - Need to make the Pod IPs routable by programming routers, switches, etc. + - This can be done in a few different ways: + - Implement in the "Routes" interface of a Cloud Provider module. + - Manually configure static routing external to Kubernetes. - Generally highest performance. -- Create an Overlay network +- **Use a network plugin** - Easier to setup - - Traffic is encapsulated, so per-pod IPs are routable. + - Pod IPs are made accessible through route distribution or encapsulation. - Examples: - [Flannel](https://github.com/coreos/flannel) + - [Calico](http://https://github.com/projectcalico/calico-containers) - [Weave](http://weave.works/) - [Open vSwitch (OVS)](http://openvswitch.org/) - Does not require "Routes" portion of Cloud Provider module. - Reduced performance (exactly how much depends on your solution). + - More information on network plugins can be found [here](/docs/admin/networking#how-to-achieve-this). You need to select an address range for the Pod IPs. @@ -116,6 +121,16 @@ Also, you need to pick a static IP for master node. - Open any firewalls to allow access to the apiserver ports 80 and/or 443. - Enable ipv4 forwarding sysctl, `net.ipv4.ip_forward = 1` +#### Network Policy + +Kubernetes enables the definition of fine-grained network policy between Pods +using the [NetworkPolicy](/docs/user-guide/networkpolicy) resource. + +For clusters which choose to enable NetworkPolicy, the Calico +[policy controller addon](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/calico-policy-controller) +can enforce the NetworkPolicy API on top of native cloud-provider networking, +Flannel, or Calico networking. + ### Cluster Naming You should pick a name for your cluster. Pick a short name for each cluster From b0ce1986159f589ed7aa253d78f2e6c19fb7e822 Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Fri, 16 Sep 2016 15:57:58 -0700 Subject: [PATCH 055/115] Re-work networking section to be more clear --- docs/getting-started-guides/scratch.md | 49 +++++++++++++++----------- 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/docs/getting-started-guides/scratch.md b/docs/getting-started-guides/scratch.md index f658fb4c1e..38b7fa82f9 100644 --- a/docs/getting-started-guides/scratch.md +++ b/docs/getting-started-guides/scratch.md @@ -67,27 +67,35 @@ the node is added. A process in one pod should be able to communicate with another pod using the IP of the second pod. This connectivity can be accomplished in two ways: -- **Configure underlay network to route Pod IPs** - - Harder to setup from scratch. - - Google Compute Engine ([GCE](/docs/getting-started-guides/gce)) and [AWS](/docs/getting-started-guides/aws) guides use this approach. - - Need to make the Pod IPs routable by programming routers, switches, etc. - - This can be done in a few different ways: - - Implement in the "Routes" interface of a Cloud Provider module. - - Manually configure static routing external to Kubernetes. - - Generally highest performance. -- **Use a network plugin** - - Easier to setup - - Pod IPs are made accessible through route distribution or encapsulation. - - Examples: +- **Using an overlay network** + - An overlay network obscures the underlying network architecture from the + pod network through traffic encapsulation (e.g vxlan). + - Encapsulation reduces performance, though exactly how much depends on your solution. +- **Without an overlay network** + - Configure the underlying network fabric (switches, routers, etc) to be aware of pod IP addresses. + - This does not require the encapsulation provided by an overlay, and so can achieve + better performance. + +Which method you choose depends on your environment and requirements. There are various ways +to implement one of the above options: + +- **Use a network plugin which is called by Kubernetes** + - Kubernetes supports the [CNI](https://github.com/containernetworking/cni) network plugin interface. + - There are a number of solutions which provide plugins for Kubernetes: - [Flannel](https://github.com/coreos/flannel) - [Calico](http://https://github.com/projectcalico/calico-containers) - [Weave](http://weave.works/) - [Open vSwitch (OVS)](http://openvswitch.org/) - - Does not require "Routes" portion of Cloud Provider module. - - Reduced performance (exactly how much depends on your solution). - - More information on network plugins can be found [here](/docs/admin/networking#how-to-achieve-this). + - [More found here](/docs/admin/networking#how-to-achieve-this) + - You can also write your own. +- **Compile support directly into Kubernetes** + - This can be done by implementing the "Routes" interface of a Cloud Provider module. + - The Google Compute Engine ([GCE](/docs/getting-started-guides/gce)) and [AWS](/docs/getting-started-guides/aws) guides use this approach. +- **Configure the network external to Kubernetes** + - This can be done by manually running commands, or through a set of externally maintained scripts. + - You have to implement this yourself, but it can give you an extra degree of flexibility. -You need to select an address range for the Pod IPs. +You will need to select an address range for the Pod IPs. Note that IPv6 is not yet supported for Pod IPs. - Various approaches: - GCE: each project has its own `10.0.0.0/8`. Carve off a `/16` for each @@ -95,10 +103,8 @@ You need to select an address range for the Pod IPs. Each node gets a further subdivision of this space. - AWS: use one VPC for whole organization, carve off a chunk for each cluster, or use different VPC for different clusters. - - IPv6 is not supported yet. - Allocate one CIDR subnet for each node's PodIPs, or a single large CIDR - from which smaller CIDRs are automatically allocated to each node (if nodes - are dynamically added). + from which smaller CIDRs are automatically allocated to each node. - You need max-pods-per-node * max-number-of-nodes IPs in total. A `/24` per node supports 254 pods per machine and is a common choice. If IPs are scarce, a `/26` (62 pods per machine) or even a `/27` (30 pods) may be sufficient. @@ -126,8 +132,9 @@ Also, you need to pick a static IP for master node. Kubernetes enables the definition of fine-grained network policy between Pods using the [NetworkPolicy](/docs/user-guide/networkpolicy) resource. -For clusters which choose to enable NetworkPolicy, the Calico -[policy controller addon](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/calico-policy-controller) +Not all networking providers support the Kubernetes NetworkPolicy features. +For clusters which choose to enable NetworkPolicy, the +[Calico policy controller addon](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/calico-policy-controller) can enforce the NetworkPolicy API on top of native cloud-provider networking, Flannel, or Calico networking. From 3bdaf7675957df222b21f5fe19dc6dab8015e4a0 Mon Sep 17 00:00:00 2001 From: Jan Safranek Date: Thu, 15 Sep 2016 09:17:47 +0200 Subject: [PATCH 056/115] Update StorageClass API endpoint It has been moved from extensions/ to storage.k8s.io/ in 1.4. --- docs/user-guide/persistent-volumes/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/user-guide/persistent-volumes/index.md b/docs/user-guide/persistent-volumes/index.md index 8f6bf30a25..b1086de1b9 100644 --- a/docs/user-guide/persistent-volumes/index.md +++ b/docs/user-guide/persistent-volumes/index.md @@ -306,7 +306,7 @@ for details. ```yaml kind: StorageClass -apiVersion: extensions/v1beta1 +apiVersion: storage.k8s.io/v1beta1 metadata: name: standard provisioner: kubernetes.io/aws-ebs @@ -330,7 +330,7 @@ used. ```yaml kind: StorageClass -apiVersion: extensions/v1beta1 +apiVersion: storage.k8s.io/v1beta1 metadata: name: slow provisioner: kubernetes.io/aws-ebs @@ -350,7 +350,7 @@ parameters: ```yaml kind: StorageClass -apiVersion: extensions/v1beta1 +apiVersion: storage.k8s.io/v1beta1 metadata: name: slow provisioner: kubernetes.io/gce-pd @@ -365,7 +365,7 @@ parameters: #### GLUSTERFS ```yaml -apiVersion: extensions/v1beta1 +apiVersion: storage.k8s.io/v1beta1 kind: StorageClass metadata: name: slow @@ -386,7 +386,7 @@ parameters: ```yaml kind: StorageClass -apiVersion: extensions/v1beta1 +apiVersion: storage.k8s.io/v1beta1 metadata: name: gold provisioner: kubernetes.io/cinder From 75531c6315cf1165247b7b98e374cb63518dfb02 Mon Sep 17 00:00:00 2001 From: bprashanth Date: Mon, 19 Sep 2016 11:19:58 -0700 Subject: [PATCH 057/115] Clarify Ingress multizone docs. --- docs/user-guide/ingress.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/user-guide/ingress.md b/docs/user-guide/ingress.md index 1c82fb3676..6ce1eb915d 100644 --- a/docs/user-guide/ingress.md +++ b/docs/user-guide/ingress.md @@ -271,6 +271,10 @@ test - 178.91.123.132 You can achieve the same by invoking `kubectl replace -f` on a modified Ingress yaml file. +## Failing across availability zones + +Techniques for spreading traffic across failure domains differs between cloud providers. Please check the documentation of the relevant Ingress controller for details. Please refer to the federation [doc](/docs/user-guide/federation/) for details on deploying Ingress in a federated cluster. + ## Future Work * Various modes of HTTPS/TLS support (eg: SNI, re-encryption) From 1117f1a5a643c141cbe4aafab2ea8e27166134ed Mon Sep 17 00:00:00 2001 From: Matt Liggett Date: Fri, 16 Sep 2016 10:21:21 -0700 Subject: [PATCH 058/115] Add disruption admin guide. --- docs/admin/disruptions.md | 93 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 docs/admin/disruptions.md diff --git a/docs/admin/disruptions.md b/docs/admin/disruptions.md new file mode 100644 index 0000000000..96157a5004 --- /dev/null +++ b/docs/admin/disruptions.md @@ -0,0 +1,93 @@ +--- +assignees: +- mml + +--- +This guide is for anyone wishing to specify safety constraints on pods or anyone +wishing to write software (typically automation software) that respects those +constraints. + +* TOC +{:toc} + +## Rationale + +Various cluster management operations may voluntarily evict pods. "Voluntary" +means an eviction can be safely delayed for a reasonable period of time. The +principal examples today are draining a node for maintenance or upgrade +(`kubectl drain`), and cluster autoscaling down. In the future the +[rescheduler](https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/rescheduling.md) +may also perform voluntary evictions. By contrast, something like evicting pods +because a node has become unreachable or reports NotReady, is not "voluntary." + +For voluntary evictions, it can be useful for applications to be able to limit +the number of pods that are down. For example, a quorum-based application would +like to ensure that the number of replicas running is never brought below the +number needed for a quorum, even temporarily. Or a web front end might want to +ensure that the number of replicas serving load never falls below a certain +percentage of the total, even briefly. `PodDisruptionBudget` is an API object +that specifies the minimum number or percentage of replicas of a collection that +must be up at a time. Components that wish to evict a pod subject to disruption +budget use the `/eviction` subresource; unlike a regular pod deletion, this +operation may be rejected by the API server if the eviction would cause a +disruption budget to be violated. + +## Specifying a PodDisruptionBudget + +A `PodDisruptionBudget` has two components: a selector to specify the set of +pods, and a description of the minimum number of available pods for a disruption +to be allowed. The latter can be either an absolute number or a percentage. In +typical usage, a single budget would be used for a collection of pods managed by +a controller—for example, the pods in a single ReplicaSet. + +Note that a disruption budget does not truly guarantee that the specified +number/percentage of pods will always be up. For example, a node that hosts a +pod from the collection may fail when the collection is at the minimum size +specified in the budget, thus bringing the number of available pods from the +collection below the specified size. The budget can only protect against +voluntary evictions, not all causes of unavailability. + +## Requesting an eviction + +If you are writing infrastructure software that wants to produce these voluntary +evictions, you will need to use the eviction API. The eviction subresource of a +pod can be thought of as a kind of policy-controlled DELETE operation on the pod +itself. To attempt an eviction (perhaps more REST-precisely, to attempt to +*create* an eviction), you POST an attempted operation. Here's an example: + +```json +{ + "apiVersion": "policy/v1alpha1", + "kind": "Eviction", + "name": "quux", + "namespace": "default" +} +``` + +and here is how you would attempt this with `curl` + +```bash +curl -v -X POST -H 'Content-type: application/json' +http://127.0.0.1:8080/api/v1/namespaces/default/pods/quux/eviction -d +eviction.json +``` + +The API can respond in one of three ways. + + 1. If the eviction is granted, then the pod is deleted just as if you had sent + a `DELETE` request to the pod's URL and you get back `200 OK`. + 2. If the current state of affairs wouldn't allow an eviction by the rules set + forth in the budget, you get back `429 Too Many Requests`. This is + typically used for generic rate limiting of *any* requests, but here we mean + that this request isn't allowed *right now*, but it may be allowed later. + Currently, callers do not get any `Retry-After` advice, but they may in + future versions. + 3. If there is some kind of misconfiguration, like multiple budgets pointing at + the same pod, you will get `500 Internal Server Error`. + +For a given eviction request, there are two cases. + + 1. There is no budget that matches this pod. In this case, the server always + returns `200 OK`. + 2. There is at least one budget. In this case, any of the three responses may + apply. From 2d4f77995d8e44f571aaa7fd56596770397e82e1 Mon Sep 17 00:00:00 2001 From: Pablo Guerrero Date: Tue, 20 Sep 2016 08:57:00 +0200 Subject: [PATCH 059/115] Minor typo correction --- docs/user-guide/namespaces.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide/namespaces.md b/docs/user-guide/namespaces.md index 0c4b86840d..8fc9ac4735 100644 --- a/docs/user-guide/namespaces.md +++ b/docs/user-guide/namespaces.md @@ -90,7 +90,7 @@ across namespaces, you need to use the fully qualified domain name (FQDN). ## Not All Objects are in a Namespace Most kubernetes resources (e.g. pods, services, replication controllers, and others) are -in a some namespace. However namespace resources are not themselves in a namespace. -And, low-level resources, such as [nodes](/docs/admin/node) and +in some namespace. However namespace resources are not themselves in a namespace. +And low-level resources, such as [nodes](/docs/admin/node) and persistentVolumes, are not in any namespace. Events are an exception: they may or may not have a namespace, depending on the object the event is about. From 1cebef8da4fcf319fccc906bb639ec89da7859cb Mon Sep 17 00:00:00 2001 From: caleb miles Date: Fri, 16 Sep 2016 11:44:25 -0700 Subject: [PATCH 060/115] Adds documentation for TLS bootstrapping Documents workflow for using experimental kublet TLS bootstrapping enabled by https://github.com/kubernetes/features/issues/43 --- docs/admin/master-node-communication.md | 54 +++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/docs/admin/master-node-communication.md b/docs/admin/master-node-communication.md index e574ce6481..84e6b4734c 100644 --- a/docs/admin/master-node-communication.md +++ b/docs/admin/master-node-communication.md @@ -83,3 +83,57 @@ cluster (connecting to the ssh server listening on port 22) and passes all traffic destined for a kubelet, node, pod, or service through the tunnel. This tunnel ensures that the traffic is not exposed outside of the private GCE network in which the cluster is running. + +### Kubelet TLS Bootstrap + +The 1.4 release introduces an experimental API for requesting certificates from a cluster-level CA. The first supported use of this API is the provisioning of TLS client certificates for kubelets. The proposal can be found [here] and progress on the feature is being tracked as [feature #43](https://github.com/kubernetes/features/issues/43). + +Workflow + +##### apiserver configuration +A token file specifies at least one token as a "bootstrap token" assigned to a kubelet boostrap-specific group. This group will later be used in the controller-manager configuration to scope approvals in the default approval controller. As this feature matures, this token should also be bound to an RBAC policy that limits requests using the bootstrap token to only be able to make requests related to certificate provisioning. When RBAC policy is in place, scoping the tokens to a group will allow great flexibility (e.g. you could disable a particular bootstrap group's access when you are done provisioning the nodes). + +##### Token auth file +Tokens are arbitrary, but should represent at least 128 bits of entropy derived from a secure random number generator (such as /dev/urandom on most modern systems). There are lots of ways you could generate tokens; one is: + +`head -c 16 /dev/urandom | od -An -t x | tr -d ' '` + +which will generate tokens that look like `02b50b05283e98dd0fd71db496ef01e8` + +The token file will look like this, where the first three values can be anything and the quoted group name should be as depicted: + +``` +02b50b05283e98dd0fd71db496ef01e8,kubelet-bootstrap,10001,"system:kubelet-bootstrap" +``` + +Add the `--token-auth-file=FILENAME` flag to the apiserver command to enable the token file. See docs at http://kubernetes.io/docs/admin/authentication/#static-token-file for further details + +#### controller-manager configuration +The new feature adds a certificate-issuing control loop to the KCM. This takes the form of a [cfssl](https://blog.cloudflare.com/introducing-cfssl/) local signer using assets on disk. Currently, all certificates issued have one year validity and a default set of key usages. + +##### Signing assets +These provide the signer with the cryptographic materials necessary to issue certificates. This CA should be trusted by the apiserver for authentication with the `--client-ca-file=SOMEFILE` flag. The management of the CA is beyond the scope of this document but it is recommended that you generate a dedicated CA for Kubernetes. Both certificate and key are assumed to be PEM-encoded. + +The new controller-manager flags are: +``` +--cluster-signing-cert-file="/etc/path/to/kubernetes/ca/ca.crt" --cluster-signing-key-file="/etc/path/to/kubernetes/ca/ca.key" +``` + +##### Auto-approval +To ease deployment and testing, the alpha version of the feature includes a flag to approve all certificate requests made by users in a certain group. The intended use of this is to whitelist only the group corresponding to the bootstrap token in the token file above. Use of this flag circumvents makes the "approval" process described below and is not recommended for production use. + +The flag is: +``` +--insecure-experimental-approve-all-kubelet-csrs-for-group="system:kubelet-bootstrap" +``` + +#### kubelet configuration +To use this API to request a client cert, the kubelet needs a path to a kubeconfig file that contains the bootstrap auth token. If the file specified by `--kubeconfig` does not exist, the bootstrap kubeconfig is used to request a client certificate from the API server. On success, a kubeconfig file referencing the generated key and obtained certificate is written to the path specified by `--kubeconfig`. The certificate and key file will be stored in the directory pointed by `--cert-dir`. + +The new flag is: +``` +--experimental-bootstrap-kubeconfig="/path/to/bootstrap/kubeconfig" +``` + +#### kubectl approval +The signing controller does not immediately sign all certificate requests. Instead, it waits until they have been flagged with an "Approved" status by an appropriately-privileged user. This is intended to eventually be an automated process handled by an external approval controller, but for the alpha version of the API it can be done manually by a cluster administrator using kubectl. An administrator can list CSRs with `kubectl get csr`, describe one in detail with `kubectl describe `. There are [currently no direct approve/deny commands] (https://github.com/kubernetes/kubernetes/issues/30163) so an approver will need to update the Status field directly. A rough example of how to do this in bash which should only be used until the porcelain merges is available at https://github.com/gtank/csrctl. From d000e779210fa72c31276c2295611cd7200b6dca Mon Sep 17 00:00:00 2001 From: caleb miles Date: Tue, 20 Sep 2016 09:21:30 -0700 Subject: [PATCH 061/115] Updates docs for TLS bootstrapping. ...now with less passive voice --- docs/admin/master-node-communication.md | 54 ++++++++++++++++++------- 1 file changed, 40 insertions(+), 14 deletions(-) diff --git a/docs/admin/master-node-communication.md b/docs/admin/master-node-communication.md index 84e6b4734c..3860c33475 100644 --- a/docs/admin/master-node-communication.md +++ b/docs/admin/master-node-communication.md @@ -86,33 +86,47 @@ GCE network in which the cluster is running. ### Kubelet TLS Bootstrap -The 1.4 release introduces an experimental API for requesting certificates from a cluster-level CA. The first supported use of this API is the provisioning of TLS client certificates for kubelets. The proposal can be found [here] and progress on the feature is being tracked as [feature #43](https://github.com/kubernetes/features/issues/43). - -Workflow +Kubernetes 1.4 introduces an experimental API for requesting certificates from a cluster-level +Certificate Authority (CA). The first supported use of this API is the provisioning of TLS client +certificates for kubelets. The proposal can be found [here](https://github.com/kubernetes/kubernetes/pull/20439) +and progress on the feature is being tracked as [feature #43](https://github.com/kubernetes/features/issues/43). ##### apiserver configuration -A token file specifies at least one token as a "bootstrap token" assigned to a kubelet boostrap-specific group. This group will later be used in the controller-manager configuration to scope approvals in the default approval controller. As this feature matures, this token should also be bound to an RBAC policy that limits requests using the bootstrap token to only be able to make requests related to certificate provisioning. When RBAC policy is in place, scoping the tokens to a group will allow great flexibility (e.g. you could disable a particular bootstrap group's access when you are done provisioning the nodes). +You must provide a token file which specifies at least one "bootstrap token" assigned to a kubelet boostrap-specific group. +This group will later be used in the controller-manager configuration to scope approvals in the default approval +controller. As this feature matures, you should ensure tokens are bound to an RBAC policy which limits requests +using the bootstrap token to only be able to make requests related to certificate provisioning. When RBAC policy +is in place, scoping the tokens to a group will allow great flexibility (e.g. you could disable a particular +bootstrap group's access when you are done provisioning the nodes). ##### Token auth file -Tokens are arbitrary, but should represent at least 128 bits of entropy derived from a secure random number generator (such as /dev/urandom on most modern systems). There are lots of ways you could generate tokens; one is: +Tokens are arbitrary but should represent at least 128 bits of entropy derived from a secure random number +generator (such as /dev/urandom on most modern systems). There are multiple ways you can generate a token. For example: `head -c 16 /dev/urandom | od -An -t x | tr -d ' '` -which will generate tokens that look like `02b50b05283e98dd0fd71db496ef01e8` +will generate tokens that look like `02b50b05283e98dd0fd71db496ef01e8` -The token file will look like this, where the first three values can be anything and the quoted group name should be as depicted: +The token file will look like the following example, where the first three values can be anything and the quoted group +name should be as depicted: ``` 02b50b05283e98dd0fd71db496ef01e8,kubelet-bootstrap,10001,"system:kubelet-bootstrap" ``` -Add the `--token-auth-file=FILENAME` flag to the apiserver command to enable the token file. See docs at http://kubernetes.io/docs/admin/authentication/#static-token-file for further details +Add the `--token-auth-file=FILENAME` flag to the apiserver command to enable the token file. +See docs at http://kubernetes.io/docs/admin/authentication/#static-token-file for further details. #### controller-manager configuration -The new feature adds a certificate-issuing control loop to the KCM. This takes the form of a [cfssl](https://blog.cloudflare.com/introducing-cfssl/) local signer using assets on disk. Currently, all certificates issued have one year validity and a default set of key usages. +The API for requesting certificates adds a certificate-issuing control loop to the KCM. This takes the form of a +[cfssl](https://blog.cloudflare.com/introducing-cfssl/) local signer using assets on disk. +Currently, all certificates issued have one year validity and a default set of key usages. ##### Signing assets -These provide the signer with the cryptographic materials necessary to issue certificates. This CA should be trusted by the apiserver for authentication with the `--client-ca-file=SOMEFILE` flag. The management of the CA is beyond the scope of this document but it is recommended that you generate a dedicated CA for Kubernetes. Both certificate and key are assumed to be PEM-encoded. +You must provide a Certificate Authority in order to provide the cryptographic materials necessary to issue certificates. +This CA should be trusted by the apiserver for authentication with the `--client-ca-file=SOMEFILE` flag. The management +of the CA is beyond the scope of this document but it is recommended that you generate a dedicated CA for Kubernetes. +Both certificate and key are assumed to be PEM-encoded. The new controller-manager flags are: ``` @@ -120,7 +134,10 @@ The new controller-manager flags are: ``` ##### Auto-approval -To ease deployment and testing, the alpha version of the feature includes a flag to approve all certificate requests made by users in a certain group. The intended use of this is to whitelist only the group corresponding to the bootstrap token in the token file above. Use of this flag circumvents makes the "approval" process described below and is not recommended for production use. +To ease deployment and testing, the alpha version of the certificate request API includes a flag to approve all certificate +requests made by users in a certain group. The intended use of this is to whitelist only the group corresponding to the bootstrap +token in the token file above. Use of this flag circumvents makes the "approval" process described below and is not recommended +for production use. The flag is: ``` @@ -128,12 +145,21 @@ The flag is: ``` #### kubelet configuration -To use this API to request a client cert, the kubelet needs a path to a kubeconfig file that contains the bootstrap auth token. If the file specified by `--kubeconfig` does not exist, the bootstrap kubeconfig is used to request a client certificate from the API server. On success, a kubeconfig file referencing the generated key and obtained certificate is written to the path specified by `--kubeconfig`. The certificate and key file will be stored in the directory pointed by `--cert-dir`. +To use request a client cert from the certificate request API, the kubelet needs a path to a kubeconfig file that contains the +bootstrap auth token. If the file specified by `--kubeconfig` does not exist, the bootstrap kubeconfig is used to request a +client certificate from the API server. On success, a kubeconfig file referencing the generated key and obtained certificate +is written to the path specified by `--kubeconfig`. The certificate and key file will be stored in the directory pointed +by `--cert-dir`. The new flag is: -The new flag is: ``` --experimental-bootstrap-kubeconfig="/path/to/bootstrap/kubeconfig" ``` #### kubectl approval -The signing controller does not immediately sign all certificate requests. Instead, it waits until they have been flagged with an "Approved" status by an appropriately-privileged user. This is intended to eventually be an automated process handled by an external approval controller, but for the alpha version of the API it can be done manually by a cluster administrator using kubectl. An administrator can list CSRs with `kubectl get csr`, describe one in detail with `kubectl describe `. There are [currently no direct approve/deny commands] (https://github.com/kubernetes/kubernetes/issues/30163) so an approver will need to update the Status field directly. A rough example of how to do this in bash which should only be used until the porcelain merges is available at https://github.com/gtank/csrctl. +The signing controller does not immediately sign all certificate requests. Instead, it waits until they have been flagged with an +"Approved" status by an appropriately-privileged user. This is intended to eventually be an automated process handled by an external +approval controller, but for the alpha version of the API it can be done manually by a cluster administrator using kubectl. +An administrator can list CSRs with `kubectl get csr`, describe one in detail with `kubectl describe `. There are +[currently no direct approve/deny commands](https://github.com/kubernetes/kubernetes/issues/30163) so an approver will need to update +the Status field directly. A rough example of how to do this in bash which should only be used until the porcelain merges is available +at https://github.com/gtank/csrctl. From b3d167cfc27789fc5de43c98fcc957b65af5ac06 Mon Sep 17 00:00:00 2001 From: Derek Mahar Date: Tue, 20 Sep 2016 13:01:18 -0400 Subject: [PATCH 062/115] Correct name of secret in example in "Use-Case: Pod with ssh keys". In the example in section "Use-Case: Pod with ssh keys", change name of new SSH secret from "my-secret" to "ssh-key-secret" to match that in the subsequent pod specification that references the secret. --- docs/user-guide/secrets/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/secrets/index.md b/docs/user-guide/secrets/index.md index fff246c937..b0a1d32706 100644 --- a/docs/user-guide/secrets/index.md +++ b/docs/user-guide/secrets/index.md @@ -398,7 +398,7 @@ start until all the pod's volumes are mounted. Create a secret containing some ssh keys: ```shell -$ kubectl create secret generic my-secret --from-file=ssh-privatekey=/path/to/.ssh/id_rsa --from-file=ssh-publickey=/path/to/.ssh/id_rsa.pub +$ kubectl create secret generic ssh-key-secret --from-file=ssh-privatekey=/path/to/.ssh/id_rsa --from-file=ssh-publickey=/path/to/.ssh/id_rsa.pub ``` **Security Note:** think carefully before sending your own ssh keys: other users of the cluster may have access to the secret. Use a service account which you want to have accessible to all the users with whom you share the kubernetes cluster, and can revoke if they are compromised. From 2a613c0158466db998e042b011901f3f76d18332 Mon Sep 17 00:00:00 2001 From: Jeff Mendoza Date: Tue, 20 Sep 2016 12:20:15 -0700 Subject: [PATCH 063/115] Add yaml guidelines to readme.md /editdocs --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index c6c27f9d3f..a5c774ba66 100644 --- a/README.md +++ b/README.md @@ -152,6 +152,32 @@ http://kubernetes-v1-3.github.io/ Editing of these branches will kick off a build using Travis CI that auto-updates these URLs; you can monitor the build progress at [https://travis-ci.org/kubernetes/kubernetes.github.io](https://travis-ci.org/kubernetes/kubernetes.github.io). +## Config yaml guidelines + +Guidelines for config yamls that are included in the site docs. These +are the yaml or json files that contain Kubernetes object +configuration to be used with `kubectl create -f` Config yamls should +be: + +* Separate deployable files, not embedded in the document, unless very + small variations of a full config. +* Included in the doc with the include code + [above.](#include-code-from-another-file) +* In the same directory as the doc that they are being used in + * If you are re-using a yaml from another doc, that is OK, just + leave it there, don't move it up to a higher level directory. +* Tested in + [test/examples_test.go](https://github.com/kubernetes/kubernetes.github.io/blob/master/test/examples_test.go) +* Follows + [best practices.](http://kubernetes.io/docs/user-guide/config-best-practices/) + +Don't assume the reader has this repository checked out, use `kubectl +create -f https://github...` in example commands. For Docker images +used in config yamls, try to use an image from an existing Kubernetes +example. If creating an image for a doc, follow the +[example guidelines](https://github.com/kubernetes/kubernetes/blob/master/examples/guidelines.md#throughout) +section on "Docker images" from the Kubernetes repository. + ## Partners Kubernetes partners refers to the companies who contribute to the Kubernetes core codebase and/or extend their platform to support Kubernetes. Partners can get their logos added to the partner section of the [community page](http://k8s.io/community) by following the below steps and meeting the below logo specifications. Partners will also need to have a URL that is specific to integrating with Kubernetes ready; this URL will be the destination when the logo is clicked. From f7cba5c6ab39e14160db4ed6191e0d73cb1666c8 Mon Sep 17 00:00:00 2001 From: a-mccarthy Date: Tue, 20 Sep 2016 16:37:08 -0400 Subject: [PATCH 064/115] Create ISSUE_TEMPLATE.md Created issue template. --- ISSUE_TEMPLATE.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 ISSUE_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..a0656931f0 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,22 @@ + + + + +**This is a...** + +- [ ] Feature Request +- [ ] Bug Report + +**Problem:** + + +**Proposed Solution:** + + +**Page to Update:** +http://kubernetes.io/... + + + + + From 6d4ea99b12888f5b2ae33aaef17809d0b20f7eb9 Mon Sep 17 00:00:00 2001 From: Jeff Mendoza Date: Tue, 20 Sep 2016 10:17:53 -0700 Subject: [PATCH 065/115] Move staging container to gcr, check in Dockerfile. --- README.md | 6 +++--- docs/templatedemos/index.md | 6 +++--- staging-container/Dockerfile | 13 +++++++++++++ 3 files changed, 19 insertions(+), 6 deletions(-) create mode 100644 staging-container/Dockerfile diff --git a/README.md b/README.md index a5c774ba66..e2fc558f9d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ change the name of the fork to be: YOUR_GITHUB_USERNAME.github.io -Then make your changes. +Then make your changes. 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. @@ -21,11 +21,11 @@ Don't like installing stuff? Download and run a local staging server with a sing 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 + docker run -ti --rm -v "$PWD":/k8sdocs -p 4000:4000 gcr.io/google-samples/k8sdocs:1.0 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). +If you're interested you can view [the Dockerfile for this image](https://github.com/kubernetes/kubernetes.github.io/blob/master/staging-container/Dockerfile). ## Staging the site locally (from scratch setup) diff --git a/docs/templatedemos/index.md b/docs/templatedemos/index.md index ad58731bd7..88a94159f1 100644 --- a/docs/templatedemos/index.md +++ b/docs/templatedemos/index.md @@ -37,14 +37,14 @@ git fetch upstream git reset --hard upstream/docsv2 ``` -### Step 3: Make sure you can serve rendered docs +### 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 +docker run -ti --rm -v "$PWD":/k8sdocs -p 4000:4000 gcr.io/google-samples/k8sdocs:1.0 ``` The site will then be viewable at [http://localhost:4000/](http://localhost:4000/). @@ -246,4 +246,4 @@ You probably shouldn't be using this, but we also have templates which consume Y ### 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 +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. diff --git a/staging-container/Dockerfile b/staging-container/Dockerfile new file mode 100644 index 0000000000..a5b41625b5 --- /dev/null +++ b/staging-container/Dockerfile @@ -0,0 +1,13 @@ +FROM starefossen/ruby-node:2-4 + +RUN gem install github-pages + +VOLUME /k8sdocs + +EXPOSE 4000 + +WORKDIR /k8sdocs + +CMD bundle && jekyll clean && jekyll serve -H 0.0.0.0 -P 4000 + +# For instructions, see http://kubernetes.io/editdocs/ From 6959d6079796871dad932a81b1c233bc3db4346c Mon Sep 17 00:00:00 2001 From: nikhiljindal Date: Tue, 20 Sep 2016 15:06:21 -0700 Subject: [PATCH 066/115] Adding an empty sj.yaml file to fix netlify --- docs/user-guide/pod-security-policy/index.md | 2 +- docs/user-guide/pod-security-policy/sj.yaml | 0 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 docs/user-guide/pod-security-policy/sj.yaml diff --git a/docs/user-guide/pod-security-policy/index.md b/docs/user-guide/pod-security-policy/index.md index 8287d0c5e1..83bff3b9e6 100644 --- a/docs/user-guide/pod-security-policy/index.md +++ b/docs/user-guide/pod-security-policy/index.md @@ -155,4 +155,4 @@ following 1. You have enabled the api type `extensions/v1beta1/podsecuritypolicy` 1. You have enabled the admission controller `PodSecurityPolicy` -1. You have defined your policies \ No newline at end of file +1. You have defined your policies diff --git a/docs/user-guide/pod-security-policy/sj.yaml b/docs/user-guide/pod-security-policy/sj.yaml new file mode 100644 index 0000000000..e69de29bb2 From 80f4dc45fe316822c55aa97445de0ee49d887bff Mon Sep 17 00:00:00 2001 From: "Madhusudan.C.S" Date: Tue, 20 Sep 2016 22:33:51 -0700 Subject: [PATCH 067/115] Update the federation admin guide to use the new, simplified deployment mechanism. --- docs/admin/federation/OWNERS | 1 + docs/admin/federation/index.md | 355 +++++++++++++++++++++++---------- 2 files changed, 253 insertions(+), 103 deletions(-) diff --git a/docs/admin/federation/OWNERS b/docs/admin/federation/OWNERS index 321cd31a2c..3ce2262d48 100644 --- a/docs/admin/federation/OWNERS +++ b/docs/admin/federation/OWNERS @@ -1,4 +1,5 @@ assignees: +- madhusudancs - mml - nikhiljindal diff --git a/docs/admin/federation/index.md b/docs/admin/federation/index.md index bbe4de3b8d..adb703de6a 100644 --- a/docs/admin/federation/index.md +++ b/docs/admin/federation/index.md @@ -1,5 +1,6 @@ --- assignees: +- madhusudancs - mml - nikhiljindal @@ -15,15 +16,261 @@ This guide explains how to set up cluster federation that lets us control multip 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/). +This guide also assumes that we have a Kubernetes release +[downloaded from here](/docs/getting-started-guides/binary_release/), +extracted into a directory and all the commands in this guide are run from +that directory. + +```shell +$ curl -L https://github.com/kubernetes/kubernetes/releases/download/v1.4.0/kubernetes.tar.gz | tar xvzf - +$ cd kubernetes +``` + +This guide also assumes that you have an installation of Docker running +locally, i.e. on the machine where you run the commands described in this +guide. ## Setting up a federation control plane Setting up federation requires running the federation control plane which -consists of etcd, federation-apiserver (via hyperkube binary) and -federation-controller-manager (via hyperkube binary). We can run these -binaries as pods on an existing Kubernetes cluster. +consists of etcd, federation-apiserver (via the hyperkube binary) and +federation-controller-manager (also via the hyperkube binary). We can run +these binaries as pods on an existing Kubernetes cluster. + +Note: This is a new mechanism to turn up Kubernetes Cluster Federation. If +you want to follow the old mechanism, please refer to the section +[Previous Federation turn up mechanism](#previous-federation-turn-up-mechanism) +at the end of this guide. + +### Initial setup + +Create a directory to store the configs required to turn up federation +and export that directory path in the environment variable +`FEDERATION_OUTPUT_ROOT`. This can be an existing directory, but it is +highly recommended to create a separate directory so that it is easier +to clean up later. + +```shell +$ export FEDERATION_OUTPUT_ROOT="${PWD}/_output/federation" +$ mkdir -p "${FEDERATION_OUTPUT_ROOT}" +``` + +Initialize the setup. + +```shell +$ federation/deploy/deploy.sh init +``` + +Optionally we can create/edit `${FEDERATION_OUTPUT_ROOT}/values.yaml` to +customize any value in +[federation/federation/manifests/federation/values.yaml](https://github.com/madhusudancs/kubernetes-anywhere/blob/federation/federation/manifests/federation/values.yaml). Example: + +```yaml +apiserverRegistry: "gcr.io/myrepository" +apiserverVersion: "v1.5.0-alpha.0.1010+892a6d7af59c0b" +controllerManagerRegistry: "gcr.io/myrepository" +controllerManagerVersion: "v1.5.0-alpha.0.1010+892a6d7af59c0b" +``` + +Assuming we have built and pushed the `hyperkube` image to the repository +with the given tag in the example above. + +### Getting images + +To run the federation control plane components as pods, we first need the +images for all the components. We can either use the official release +images or we can build them ourselves from HEAD. + +### Using official release images + +As part of every Kubernetes release, official release images are pushed to +`gcr.io/google_containers`. To use the images in this repository, we can +just set the container image fields in the following configs to point +to the images in this repository. `gcr.io/google_containers/hyperkube` +image includes the federation-apiserver and federation-controller-manager +binaries, so we can point the corresponding configs for those components +to the hyperkube image. + +### Building and pushing images from HEAD + +To run the code from HEAD, we need to build and push our own images. +Assuming that we have checked out the +[Kuberntes repository](https://github.com/kubernetes/kubernetes) and +running these commands from the root of the source directory, we can +build the binaries using the following command: + +```shell +$ federation/develop/develop.sh build_binaries +``` + +We can build the image and push it to the repository by running: + +```shell +$ KUBE_REGISTRY="gcr.io/myrepository" federation/develop/develop.sh build_image +$ KUBE_REGISTRY="gcr.io/myrepository" federation/develop/develop.sh push +``` + +Note: This is going to overwite the values you might have set for +`apiserverRegistry`, `apiserverVersion`, `controllerManagerRegistry` and +`controllerManagerVersion` in your `${FEDERATION_OUTPUT_ROOT}/values.yaml` +file. Hence, it is not recommend to customize these values in +`${FEDERATION_OUTPUT_ROOT}/values.yaml` if you are building the +images from source. + +### Running the federation control plane + +Once we have the images, we can turn up the federation control plane by +running: + +```shell +$ federation/deploy/deploy.sh deploy_federation +``` + +This spins up the federation control components as pods managed by +[`Deployments`](http://kubernetes.io/docs/user-guide/deployments/) on our +existing Kubernetes cluster. It also starts a +[`type: LoadBalancer`](http://kubernetes.io/docs/user-guide/services/#type-loadbalancer) +[`Service`](http://kubernetes.io/docs/user-guide/services/) for the +`federation-apiserver` and a +[`PVC`](http://kubernetes.io/docs/user-guide/persistent-volumes/) backed +by a dynamically provisioned +[`PV`](http://kubernetes.io/docs/user-guide/persistent-volumes/) for + `etcd`. All these components are created in the `federation` namespace. + +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 `deploy.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: Dynamic provisioning for persistent volume currently works only on +AWS, GKE, and GCE. However, you can edit the created `Deployments` to suit +your needs, if required. + +## Registering Kubernetes clusters with 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. + +## Turn down + +In order to turn the federation control plane down run the following +command: + +```shell +$ federation/deploy/deploy.sh destroy_federation +``` + +## Previous Federation turn up mechanism + +This describes the previous mechanism we had to turn up Kubernetes Cluster +Federation. It is recommended to use the new turn up mechanism. If you would +like to use this mechanism instead of the new one, please let us know +why the new mechanism doesn't work for your case by filing an issue here - +[https://github.com/kubernetes/kubernetes/issues/new](https://github.com/kubernetes/kubernetes/issues/new) ### Getting images @@ -99,104 +346,6 @@ 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 From b1bb2d33b6a4c780047bb8fb74442d05a1355d75 Mon Sep 17 00:00:00 2001 From: pweil- Date: Wed, 21 Sep 2016 03:37:16 -0400 Subject: [PATCH 068/115] fix broken file reference --- docs/user-guide/pod-security-policy/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/pod-security-policy/index.md b/docs/user-guide/pod-security-policy/index.md index 8287d0c5e1..3dd2d7ff42 100644 --- a/docs/user-guide/pod-security-policy/index.md +++ b/docs/user-guide/pod-security-policy/index.md @@ -130,7 +130,7 @@ A pod must validate every field against the PSP. Here is an example Pod Security Policy. It has permissive settings for all fields -{% include code.html language="yaml" file="sj.yaml" ghlink="/docs/user-guide/pod-security-policy/psp.yaml" %} +{% include code.html language="yaml" file="psp.yaml" ghlink="/docs/user-guide/pod-security-policy/psp.yaml" %} Create the policy by downloading the example file and then running this command: From d8ffef3e77a63d2fbbcf2ad10c38ed920df7841d Mon Sep 17 00:00:00 2001 From: ankurshukla Date: Wed, 21 Sep 2016 11:58:06 -0700 Subject: [PATCH 069/115] adding Canonical as a partner --- community.html | 1 + .../community_logos/ubuntu_cannonical_logo.png | Bin 0 -> 17457 bytes 2 files changed, 1 insertion(+) create mode 100644 images/community_logos/ubuntu_cannonical_logo.png diff --git a/community.html b/community.html index 43901dd05a..377cd85e1d 100644 --- a/community.html +++ b/community.html @@ -74,6 +74,7 @@ title: Community + diff --git a/images/community_logos/ubuntu_cannonical_logo.png b/images/community_logos/ubuntu_cannonical_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..d126c22f25a9151a271b49d1a088e8a24258c390 GIT binary patch literal 17457 zcmcF{V{;}<(C!`Ewz08o+jnf+&c?RAv2EM-#o1oktPbh=3GX2NeuxVil3- z0Q5vk8WI>}nFx}CbqwVJ6mfBIyz%@9u(-H@7z|}P_$b&ls3VfXxZt9QsL79gpCX%; z?w6C9@0L}8)9Qzura7p7X!tZKR%P}8_zDq1l)d1w;nDpg2BAP$az_9%bdxEG%NH34 z;MI?hkCwC_suuv_xdaCd=$Fs#XTlHvLAnsh)CCC$0qJ*5v!SWC;+E^P1@c0?&dP>QUkV zO(p=kx$H1EV2vKYB&}gC1*mTW^v@#0H3FdF0Zhsfp}zp&J^;gUGBQsQi}wE*(ZH#8m`|0g%%1qmJN>&Hh&Ycj(kI!2QkzTXyu2K^dewr_rX zpD#~)y$9rhEP8>G;IDgw(~oi`_;X1xA;w!L@sgiya6g{}OQgfn#vPh8=!eRvPH|#c zF%K*yq>&;?zeXq)e@qW{={~>&cG&^-)&d|tiS*@qCScF9RLGjH{Rb}qz8{W*`HTfr~Mdg^+VzhKx_@b zeHwCvh>#BtiXe-?ng-xI8~&;e5}^*8sVAT@Wc({cz}By98J6sb$S??ON91=zdN+d3 z9iZ+GgaH>Ghek6Z*@yr!j?yHHgT~4XeI*%?0!NJ|C!UBvS0q>Mc@{R*ofkJ!pJ79>4%;#@j1Gx3aM8gen@ly3R>N0~;?}EIgLOqdnankKfTISA z_rq|2dx#Jl5eiFb%4sUBNtF}hle3|0z;MEVg(weFktUbRHdA(@ybWU;voMEiO3{(6 zpvI#yBKt&$4s(*DMvAgfbtHgFHx#QaqAp4-+N+SA(^X`%N#T+uPi&alG(vHw&=J#) zhaTk|4IQx_;T@6O>%it13po|Psvc0QOj^s}93vmI9YdOBum}T-vQ)Oq3)E29*xa(XXM!=MWlL%bQdss{QMOYF71HN57N^c7&(hDp9zEa@ z!Z3ozA}pwJvazACEpR-r>oVj@ah9TS#?+WNnJ+U=Gm$bKfSNR|G`}$tCt*`%QYlmM zXc*NhDoZPOD&c?+z$vx(3Vl`IS_vSl>R|=U-?S=VWscINDxRuE1#fwHrA4`enqaY? z)>kB?){xwgqG+*leuKeb_b4%(2~LwI9f=J>RhU~K`!Hq0%=&M4ny!p5g05)(%8CMR zQC1mNjV6_c6mvnS!wjd_KduTer_^QX4}MWQ=(oQPe&Lm}$#pQB>DpALrKf3DNmVIV zNnZAF)Lxh6l=g^sX?+AD3XjQ9=~78r#Lq(HoT{#?ZkNH9VaoIKJk>H(+LYiGbcuQN z*_Yj9n!fQe{!IML7!p~y!jj%g8@DVVMZT?dh z)f*BLEip{#F{T9$~FK#H*%)jcFXv>UY>Euw^^B%zd*zmUJlQjzZ{{Z+~< z$168BGd)u{vy#c4&Ck5ba+-aby_&t-W~l9{P1jo9+HNM@c%)sbb<^5yAF9o*RiX*h z)@zce$*G}O>8j}}Ln-S}NLHxIU9lLd|JORvTG576f4l~{S=(yY>T6_SjAhX_Qaf~$ z+>`9v=^OjS4}}oEj#x#YP2lI!?2OK%&a;y>`{zc`cjPhcoY6va4tZ{k^{^Ff>esMU zj%xOjqy?5mhfDB7M0BKV&=f`DWb>$BorZ z_*ULDTi&l+EmoKLp>feY<>LiGxV%&*o84+ZMN!2-inFbIL8Q0+y&-zc8`TEQI}n@cd<0FooowcMeaI!8Fm_hN(O7b4bD!s zPQg(IbFJxR%^Xc>TUmT=2AWz9d)waK&+CWqgPa4nLm#XR#&JDIuY%dZ$Ivp&3I*=P+%>>Rrw|PI; zsDr5cNv$PevKsURnkPNg*4&MJPF|a^hZqpFVd{|8eC<)KG(wupB%AjL4{3^i8aE4F5IiEze`TaEHmh z%&nB>imKrb(>e1+^YfD(`dl5vw9538bVPfE^^InPUG?Vcr)Tj^#`GEL&92~9(T<`% zzV>djvWeLlUO}~DwMVsgHIAFb?G~feSNnwSjq{+TWQ+T`n4HucUq6PoEyK;iR-aRo*7Pcf`AVY)az7wC~kwhWlGvlYi5W+5Vxdgbm4+NdR&OggU z=S=4)bFsb)zo%-kFd6+`moHam7cv$K((lug`|N&~d|mWk;?!-94vrG`PI$61>p!Z0 zTn~6`c@W$d?II~2{U-LO{;_;(cv77&`$)z~PW}N0%Xs)SVWr>vuiqp#ky4Qd0K6#x zfPi2C;O*x>eGUM)F#!M*9-zvln-m;nAi^Z)hu|FV$~ zTCD7Va%gA>S)A_AqnTX(l6`VZBT$f+i%SaHXnjunD5OtO%+igglsYO)n3K$$*OR}TOYRmgQ?amZD|!vt6)s-U3+KRG#3CzyMEN}ZLn)w!?cBEaXFv!R4d!Prha6XmWx@^ukPweIzQK_MV4w#BNAQ#y)Mg^jRWOd{ zk4VBG!y^hKIy$%;>3DB$fl!cAv>1!uFI=ZeK>U1CxFK<|e_GLRCy6g|Ng)FR!s@wr zWkMiqJ@=(Kzvgh`E#Hdr=&`T}VJ1nijA)qxs3xYhEuI!=_PeFX#f1g}JFZ(JS2V(* zl67prBICqyY)q4QJ1^UxdF68*>qi`ae0Oh;cyP)u4qDJ>xkaF<e0s&3&Nq0}3cILEt*r(5slfLC~=Y9YCA z#><4y^ZEE2O*iB?(c_UeemS%R1~7^j~`>1Suj&wM7=4h5amJ-FD&RMi)u>(FZRp;wE(5o^#M=7F>p+1-Z0W|KtU z0$`@sjW67bM&S<6|L zM>4^gy~8~Dv)0Uy&#{cRyUj!{ko>o|c$P;|!GSQ1-o$}2f%uixI@6P)pGGN$05MZZ z^GCWpy#L^n1XU)P;VfG}6<4PNwn@QCT%j~VB*m4H#lxthZoNPcKuA|WAMmJeYc)J~ zo{c!DL~8Q~aZ^}Ra(Q*S&K5ETj4tB6L9vInECj}{#&$z1kVsb;$OSXL9zV+e_%j#H z`Qw1a`%*S(eCjY}+rm?OE-X-|x+tXSB1LTs+PC?L1im)z{&N0(m(tCna{V8Cd-u8G zcM!^z!aZ1g=Skiy#9gN8)ev`}1O}vNZnFKxC{CR>RJQ(yeiCb|%2iMBGiTplTCApU z{>iD-#L}KM8=;gLs;?L%Ois$FMl@#xh@oyP<#Jm3l?LO5 z!TlaV9FH!nkQ~TiZJ`-xBHpw18oc^KPjN96HIfR$@X>b_d+2S%izpy#mN7yve>`t9 zksxo&e=lYN3`eX83ZmnPdbMHx9Dmmv#|DEKi8}xSQn?lE6tpYAC4gP%IJfvU{+YI_ zLmdt#Fqz;~TFwZoI&XhR14&E1u72zeg|LL6OShN zPTO3Agi2UM7O0)H$~~{W`R=7(>_poax4kpbd8?k}`aKp7D9I(u-I@i<<206P z*DDl^SL?mcNnj)tr4IEyZFw$5&!AcG0r;DR$uxqbDIhTJcih5S>7TD1NL&7d5wZVlrb};KIcsg@=ipl4YTHTj3AH{rd7jDBqm) z(qqKr*E0Cd+L<)zJq<#EGrV+tAQ5*K}$#~Y+ z$Dg534FSo^s=Tpc4D@;X@Qoq=fW*^JHo$eAFUoam;(LFgab!XTX}tY!!*R1C@gM>fCA?P^Htg;C#}b%?P$6}6NlQoNT+0Ll{_c8Gat^lem6!45=$<%xesGxC4k9ow zVY&$<>$>SX=;WoJ&2^5(cyX@|$RB&LZ_LE5{ku*?LhGRxvm=$d&5?5l2Jb`C@_TWc z>%JwQ^Qk=%O?g2i$-C(Ow9st0q^di8Lq?&Z1N=K!Cw=3h{7~?x7#S`zc1XKyo9pI0s+_|BuIrsXzAk)v(qz(CVSo;;>yY%JK zrE-T-&eG7}r|Ml_Ce_T02HMF5){x3R9kBSY^rgTa+_$hoMHG_+ZLmnRlioY#FuyYh zwb>5=34^<6L%Iz+wELKMGQy$p_%A+pSArY|y^$*m!3gs6Mq%zphMc;s`+$ThhlaGu zOwc>pn&}`NQ`1ySDYq6JH>&*|JhBs*p1M^u-#b=tKb^>2E+)QLXW?4=+1UaTB~u9T zHe!Wzv%jD{4WnOw0mNQhu!r#nkdP_A*9D>9_T`QD(r81Nh4YBVJAM8Itw4Wz?|+pP zKAZKoX=pRLOm6YtfAi5RBX@3?b9=CPyi+??P1i+>zuK=dqm<%EfqDttF(2afRa^1{ zP^sF%JeqzG>P%-CznHU5Z9kj*C1Qkg$Z+*UUsi7C-|sClynnKPJ>O_muW3eP!`9`Q z=5xOZjp%xdAU^Rs4Js-F{PFn~aUb-VPxfUE?90}*uFZC_OqNZCiwTQet~8af#=QPy z95d6rd*qwY)~r@&n_?wi&^Wsp^yt)JA7?*=W#6pD$k~n&={~TRy=yfM7jd>g=G^{{ z?ehB&pEmgN60smuwK0SWw={UcV7pZEe@w>yEI55)3H8<3fd)_QB0q6f@mMtRj7STm zCFU&f4klgoIi*Z2x39?sdxuVVP=8A$uzdXp9PM|BWrm8A!pYI6F5WX|zZz@YC8h@= za^IGbnsCroLotBQ3aGq4IZ0=I%P6D!HzRL)-YSwOGW{APL_s5>JyCH*t$X`=D>W(l z?K-hT0O`nb98S=`p7T*Co-#P&0}jnqk|+umi) z?2(X+-=OgBUR$-PtA_tgB;>4M^cS#4BDQ;mh6s(>2Vj1B5^;zCkH8C?=Kx>H$VS@N zu(*txNECtkA!}9aPuD|`VM@L4YLaQ;;OG8L%4^q)K_tUgDTXdCT(xcf`}ZG(Hc?_* z6z0B|dsvhTI(e@sW=0%b!uM6KCVW|Im4(cSEqe(v$P(;!2gFcmOWrYLX= zX`~xe*Wl>rRey_f^|dno^joO#t_|`^#9QnDoNW(LPU))0#fX9HRk5!0yPS&YBkxx7 z0Y1{iI0XNN5N)m-7_>#UiN~K3aa?oV4k_I(*pvVe*TNQ~detAYj&;;9JSL8Oy&6<&8cCCsd;@qk4wq z49V-(K_Kz5EsA(j*U^ZFcVOgH6?=#P3j?Kg%B6RH##6gRCK@m)=uHG!-QsV&FnN&6 zz$}$SS{!X%5e5JohrcpN1;?xEs7Y5J@hu z(@RPL{c{fd3BZ`ZMp?fK@^!}yq03mBvj$N^e#36~X|?dX{LSc8;e50hLXG{!J6{zy zURf^CK@IyW3bf7J-G1aWxMehfd;*5wSi9;8#{Gwyf_AVg>!Cd~=y0cT<}#_!vx2y7 zOrpL~WzPrr*{V&ZKuc~Fg^@|Ww;b$q;>WO9|Fd)D=`Gcwu3FZhEL)^bCY=NX{VmRB zSYM8f|IRSaNGPmAB-pc1y-Kt6Yw@JHQ9GJN`TUJQi{He4X6s;192{ZtQ!aVELd)FT z{PfQQk#<@=GV)r|uoHzeY7+T=h%qcmVN@4Z{-@k_>fCDC5Jh?{O!0=2W&3Sv0wZby9^Yl90EHq^ zW_808ImP^%5*3{!1&(KLgsdmuf?npt2GaH#P|oM=eYC?CnilO?_b%VR?yk};-lUmR zs)QaDG`IG%53kxmkLb{$q0=6{mw$ZCpi}!`5_M6da|z}vL4{$Wc7R7MRb+?mq6?P_ z?y&f2;lI%$x#AjD_C(_ir8z~%G1(gsyfH|V`(O7%aD%Z45x1xd%YKOY+fgJ%L^4#F z!iu%^CL?%ZzKQFtBH32>V(6>IaTd^?_u|Csn-^W`2qSv&Fic*p)Bcs%kE)8D)hh+9 zTwY=a5dvz3+KsiaDUe0Lovq<|h!&4jfQ8h?uC6I`!E4xI8m1#b%&Oaaw+R$Spt18u zbW$HS9s9yen)4tO=flIY&vh_Cs)7sWoxc*~r<@UK7LrurlXEvi?S$Z%byO;pDprZ= z!#E%vVQ;NkJ^4<^y__%d-bfre)KbZ%t=dYt9GML01-R4*%D2NNM`ZoSHazWGctRqe zN{R4;pZ0R7#+}WOMVKU0f@y=J?73`fZZjR}HJKXHF2JO!M@~`p{du@GW+eICsS7;; zdB;A5Z5fawrOZynlJ=q~e3g0wbke%eiBEXeqD|mH=Z@VZ{g+8+Y4Vs_B8sG;brlo% z9Q!iX1_y^Ry5n@i1&Z4reKxSlW$PaIlQLmA4wP~J&nb{OGtmXGtjn)lt1YZdOXlp> zD8t!CQk&|HsvzaPfkg`9Hg2>T7~Jd8!Y5Re?w5!1>6(P*otrXMiiI*1T+CjkD&1{0 zKf`j11zG3qQ*App5+-BZD)(Do z=kxOv2xJuPhZ-O!6t2zm-n@`}S{4;>ctg}mo2-27?agFc;E#eBI!X-l)cCRwiFaPl z`Ho5=p#aOt_}j#7I{cuD#xm>=`{CPYw}t#NAMwhiTB59a_nziLR&8V6d0>Lb>GnbA z>STMrHf!bhikTv%l4+;^Zp>JQkez0~r9&6Rl%6Dz06Ee1*cZafF{?MZ;S-j@{dG-s zrpogid4!g8!;5@AOnnPRDKQG=x6kL{&vU3^j*?~pwf9`7v z-YaXO*xQPj3W*^y_%>-JqP(G_tuNKCzVkaBg8z5!1IUI`Hgz0RW&tab^7b>$q}e&X zY_Bt9%!Ss!D1xy8&wFi!8Z9kqsCJEDso48IC^P{xe!)hG^L8kbj)1SJiPG{juh_sa zx-(MY3^W3CD zCS;ETUuCLUlp4CXE1Z>#r^Hx$)$`@oV`+)9O(Ul02@zpb4MJNI-MPx~eRd`?^Y(Rn zq7Dc_J(e<1eUlA_BFocg(OM4cB_~rvJQ|dgda_7Vlj_GUJoag|tXJwW#WBxAX<_@z-7sm<>CnSwvUDrQ$Kz>IcL80ybT z_Jn*i627hCX^sly+crAqM!jS#IoLg_ckU3eJUd!oY7H=N*v zP9Z;NgBaKDT}#$2XU*Cf-(omi)TFBfC=FEtW!YV9mzYN#I%$(A%txsV;z>Ct;K_dK z%0i}nwNfI~-oh=+^$h}S(?TW*u1o`??#ukk)`9Fw6~)C*;0^oc6w|dCC-U2c55vK# z$;}U1TS*Flpny>K8ebWADGh|*rYv{8!MTZN-w!1JMGo4j1JvjYlTH!q%Pf{IQm(1p zFe=CTX%AfpQ@y9|r)z3H@?070))n`2OI0ZPu38uA$Ug=|w1L8Wg#$UlHJ832G?yxEoyX z4lkdtF_-(`E=6Lunsx65X>1&b*2Md9HnFtS`BQ!H{fl zx~t51s>A|)<^EFD*?bxIHw={D(CD+uT;VVK4C>G4s>H8?L3dK>`1!Ssnh1@Ep3G;sq!FX3`w}8W zgfqeV4fiDx$DlUTyeJRU-n?SoFWR<%QaC!X+micO2t>>~I8F@RP1ygC=nv&2g-FzL z6?Kzg=7Pajd;Vg)ThXno%&UIgSmsEw>R)YquRk(IX+kk-3b}jqp>-*ISGgSwt6Xu% zn@)j+0$_@~YG5_k|@3oM}-a%i4&cFp^9z7dP1U;W!}YvTgPgSB=w903WUoM zE!1rDxfyR=d+(E>H`7qmADx6}sFVcqT4zqxtf9zLt4}UPn5HIB5-+o+i2&{cy~{kwMveG)Voj;Vcpg^c+O zdqUBKX(*N0GNMIOTIBPa4rRSTgPGJV-m)fUY}_my{+3Q6cTh&4ZDXwi$tA+L{~bX> zO1^{p8MM5rN=gU^&a2rkYwy~9`6r@@ChWwwS6x#AVo@9Fzc+Y3Vuxmtf>F)jWSFtWyWGmqX{3v>KO&lc3Z|`ed~!uBxQuI ztx2Rct9;o!ea1!2{+YgfFkZY2!y7Unvah!=4X}3GuNsLo?*qHRsPrC_jt-}rpbXMT zv`VwyMeF{HZJoFuhwpb|K9|E?{1PbYG-(3|Y_Zu>jBOyA>-qRab`PH720b*T@5oq@ z2xd2rNaNBUVr_J~3sN^9f6{U7F z1x~GimO^_c<9?MxemRzH_xe~mo)H3-sef;4fABqhXVQG8^mmlU5wkQ$9b`eV%u~|1 zR9;~YwL$bA=X6yp+wZpC4U8&HCW)_}E3F|tcB)x{Bt zN6AHo1rLN*AP??P%Uk?g(Zajiso|;)G}DVxb0ZqPnxc49qrZ*NuF1HK4rc`HJU^+dCXRgi5z;)PuN`pS~Ub?_`yLvYFQ$~6T^ER@1Tr@*LR7G_8V&DWnfN_t;s$(Mj~l{F6pd&?8Ajv znt82A3@!dXb}YA8dnmF0$;eL&ZXcQR1m^q`DZhi*K)F;j@^dtk>d~7RddX6dsn#ON zjLPGg@3A86$3_B#<((n%s~7o{)P0XtNU?&r5Ox7wFcwQQSj(`{i0pe#wtoNp09a@l<})r zuVK0iLtW~9`?a~v_%{x@%vWm(;75Qg2-6-Lt~~3Fr~`*o?1RiTGcfQrKusI1E_Zq_ z{k<*xasGr@vtT8@sN9qA@jO&#J?DJ}*wAK<;ev`^8`oY@TlAjSwB3+Olm0goul4wFLfZS6GVLE!s3mv_H*-f~Mn*O;gEn<#MGd7`;Y<}x1B+RV(! zH21de^*Fg7YZgIaYSfb4A&&b5-h2X&aUt6s zE>NPPqDNi|__U&;hiZ!`lx0*_#{_@zXDtaE^s3v85QU*h63Af=4~xj3U`^Vti?Zc& zP@Tmgx^Fu9b(!!V##=C=0O^>MLUbXoxgN|B3bD^fApi+CWi*ZCl!3&Mg;>0adj=n> z=Y?~3C$G2`_kYL3qw~LDt6RvW<#Hjy4pAyiFrLMGKp$&#+U{o@{E`a_NM<)0B7Hp+ zm~msBJR0JsUsl$F-bdcWZ^5KNS17r#-g}-*8~nY{#fwuz_Uq&R&A9Mgp|r8Gn#E%! z(Ty_Oti~+ZwpdyqqKM*)i>1QajE$9ZUXUxxuq$t57En8%oWLG%-JoDu{;dqjSEIqO zZh`$T2Ql$=Wb#P$m)&5^y}D+uj%32MC7agIFbT-UiV2{ZSoip?4&jpgsLxxO2^K~` zh(ldNXXhmC8krvTTbu8pJRE#{(?cAKy?eyobEkr~2G>KJ%gjZuMqb|Nl{M{PaV96R zef%t1YYaw6B6w+hVG1*o?nq@EGC~YU++eQN>@s}=)OhTn*E8(ijN*BG(gAC+-ZN*Y z80Mbu@ZNq|Lu#CZ>ZaMNoGJ`(sA8cf^iYU4_O7j!tNVZa^7xLC7?3XE1}Y5i>1DDa zWaZBcw>Y-&i)#!0++#;aqZM_p@wj2R?+*C1Vg`SuRGouo0b~?*NT{F(P0-RFwby*8A_oc$_l@jgjiI z8F_gmjr9&c=-2M)4|9TD9_4of%A?l5#GO8*J19vWXPd1#v#+*VqFYQ%j=uO!2B1Xl zLLA#O7Z+8G@nT1*flZOV7Fz>>vbXuK z23#M+d{>3~TIP4&)9lwrvfn@E97FB)UUHoZB9FHr>a$ITx{I&=h32y!rZu* z7w}mi?gsv7hh$`IVJeV~0Yo^4emsZs^W<`68MEk@Z6j;5=8Xx=YXs(omH^JR5v*_M zAFqP<annB|Nj5Lrgul$V+fgJrxJbjGgW; zZ2g3II0F(WS*KOQD4iF&)oFOHv-`T5BI5xOX0}(h)fk;kn4o9Ku6Z1Dch^BVkc?FC z?asqLZJTy~TqI{uy|J)yu#Hw{^@b&wBFTVbzoFsPaHp>`%(ky^Y$K5ZFmAf_)SWJ8 zlv7ixUw>pM%!a~fa%P!GhQoDir;KGohxmGss_fk$))k1HYYy_C-=)tAeHygk|GU>! z;adNIw?UXl5^&5omF3=N;K#AuURtjRRU-Tg$X3=8h(#}2XAX+vsjdY#k2>p=v-vN$QQ%?gUMD@zXi4$bZ0)U`e3>HEr3&$wC^2*zV#E8n)sU3n*H*fV06?^{0LZ{P%C&|y8+0ZNqJ>2n)bVMF!LE69h4ecH@0N@ReUMZ@kaz~Iy*KCsUoond7X^r zFzjx$I$MA?&V<8mBP8*oje{$szd$q@+eA4+NY%uQSYE7i8&g$Pm7j4Re9yP9M$+M{ z`In4G%i`q6y|)nEs@&#M`G$d#(QL(A!Fau*611OAnb;fd|;xVBp1~_4$9#m-z~5xTtzYl)2?N&NU+7 z4Bot7FLE}b4D8H7T=hHMm?a~0TByS&i4cFe*_2JgfP?h_Fp;u! z9W+3C=XOn7K}(t5I!#?e)#$8QvJLNXdM@MrofKf2pNjD1L2>@*7dpIN+1OmI(UB}s(W;Bf zlfL*j+sbj>InY3?P^a!0KE983OJT0l)Nx`~-hu5zFD6(`((N;|XLzSfN*o_w{iV#g zh;yG*64k57+*PBvCdl&-7sy?_z1MoZ^~yPrjaMDZ(U$elhpooQo~9+XQ&;)pr@7)P z1jY#bG>a%N--@YMo2On}o38^<#qQ*aweiJgIZxvBC$3d55aZL=-^f+hKo3i(Yo z1@DETTrn%?t7>y*lr7kD$tYgU$uejf0VB}G74jTC60$4y7GKhM?)y6Xx`v(FEV5%I z$ocRc+9RLi&1t;@rn?|}6A}yVx2W;p!jr1YWE{J}h+T9`9>H79H=W#-Iw>0vYwYG> z()v&R@_Lz`py@fNog7j9(!# zuikExBlhq$8`9Uia)dS3SPi@?Q19a<0bMWVo-OeXUbH_W0DA;F9@#`ch%qB~N3bw( zms5SNdDd?P+lMv`D-Is%_v`%kS68du=IFbd4I`qyzan^D+E45~YvRl0A(?G3l94LA3hs5gEDzBsAc=L>t}LpWhEvAY!u z0cQg7F0#~r_S@>Kg_A^kSN28seFGt~ zF^Q}w6Y+%~!4Z6NM)GPIKPmZ1&-G zlsiG96vn8v_-N)9@(LUqQPTEK(~~CZyk@bvIMRog73*#6e@JNzZe_#HzW<^P$fK?< zIUNK{;08XktzYr)6x{A3XH1~Br>2mo9Up1N_w@6mH6Te zLUKcS0k7V^#4mr?U7_~YGk+50XxI50LY*uBy)$+~Prw7eim)S@PIFZL8K`OBOscks zp6>QD4l&wuVJ2O;w80LoUHmjTMII@*cYlR5utCJJ@)=@P_JgvHPn6webs|_Pa!q|> zQYpNPaDsJcA5~}JuK}*FQ!`vQ>-^(%`>0A8$*3G@Yii+Jq>Lj=`VdiZzG1N2V9`^W zir6)q1;7{{Hy6$tz+#1S3o)h-b(x->W#!!*)E>%eV0W0pjgxjsn6&>%Yx%DfFH59a z5N2g{(MTUQn=d)&FxNF-o30?W%o{%Iq-w~`Uir9`ss5eSY`bCaaJprl?d#sCwzNoS zvo5?{-Sab877$(5RHHm-e+ci8b(b|B*ZaiywI$f{a5EIsV(>EGYRpqqWW!{gYtVkR z0IjH!c!?Zr?NG2GCgQlCx)D~5TP}7I4f&;;)-oG@R#k-oA!tg!`u+8hnPWr9f~rqy ztWOM1d!~~UDcJcFvv22AZ7FDtG{C?BT00#HB|o&c=hjfWD{7R2&P#HZZAY%ifoe_M zgP+SBxoEsQK;^u;-S;4VTA8F;>`-V#e5#|SeCrFNx{yi%<-cea-G;&uC?i7*!u zC;6|pP~Dki0UN=c1cXXhq}WqzZ~oCV>*GMWTpzE3f68LP1evg6bn6^AH)FddR2(n< zSjtuN9UfUg9g+~P3ye0Qm;^RQ|AIbHRu+HUHY{AvJcrA!c@75-d3Cwpv=h&P`P>TB z1LfE>XxzbE$7QuBbGwGK9HOrX4;(g`u$2v%PQ2ChPi&e zV)=ZPd06gjcQ2)vs=m|pO%#Z17v=Tpnv(C_8j?6Hx`J0EPC<$eu5~Chfglaa1;)E{ z>I@Qt5-3qS6YUJr$vF1yW=LpIlzrr+9>vnlE~i?XA1-u8&iBNjbN*u8-xf0yZj_H< zMl~Q|LQr?J)eoXKR!+lk%arLFOZ*s=z$( zJ+YKVFtT6PWIpc(oVbUM3rI6IL&2X2PyZXqT}V3>69Xxzh@uCSmT82$rjqb0MfUkh zR~6ln_ooBw&&;}&gp;KTe|kS^ecxVR&)#Kde17{765+sNkQ*urIccHaOLVP9pqb}9 ze5}~5)mz;T4~H*|Hb0E0w%Kid(hC#mp?{zFW=lB0TWBYVU}tJqtBn7?n;2r~9gd5O zdoypE0BY!sjNb{}=9^eVE?Mf{`J;8bMh=m4UIvg(Qos@!q)j4Y(DXb}h>sla{PEfG zB6D$R5@kR~i)>gL##~hr1HItJ7UNx!@%B9Ig+9nw7mUPlo$O?$^0Z^S=y_K`w=7yC z!4uzYR2Hd@qGICRG`>(u{>NT~l^xMmRLYRHEu%?mJPISADku2oN1s%qNLU|S37E-NGr^N=PAEJeRbubWzzR^@r4uT;oNN71(rw(+GQ6?H0W;^I2ukLhttH>`RFP=g}fHT;t^ej*RCL2LO8cNeQ zbQ>ZFf*>$%#lyRlLqdc?Som3orl+g*SUDcYuw97T57KK!J)njlz`yb{sI?kx3wF_t zw6{2nz==AsEB{*m%5iVAfw13w(31#8-D;tau+hadh;Ebq#zC>j3 z0n8lJ=$3J;9po)SrRCi=dCQ-kL)(~_V1>uVEp#FrY;5kmQ(jJsT2Bt~Z|~RxB}H0j zZ>>9T1ry7&_{M4qxE9~=p30pMjRAGmyd!C`F>X0>dXbkZ%VU+>Cjh8=ihG%?WN1Mm zjWW5x67d{j23(F}U9?H?OKI%XmlLd(b7BTEycl;B-wcmxUUqg@ty1|4F40x%i9y7B zdgTRW2PbO>yOaP*cj>*`|2PqheJaeKB=a<3I%m6FY#L~jCi5SV*>wHGQUXCXKO{sL<- z#z-{}@665PdegYoXWa)wDE-CY^D|d_C+Bx(EsV8^SJ53?T&T! zwJ3%>{md3~3#WX(wr&?AeIPSF%ERb!emJrFp-_<(stOt&#TA1uI1SwioGgw%6oeZU zFkZs3F`&C(1V(-{l-n~8h70B8pN&|deu>m*`)qBaeRTL3|McP6^qPqYcG_RpFsdy- zu(y{PufeQ^ma>j!jKCFC(qL6hzL2~-I=>}TbJjU)cNZ|Td5%$F>GylqxaWZX;0%AK z68GLsV4Z9+x%h>|)uD}De=q0I{P_R|mW`qc{5o4|UcJ9|O86YPl6!u2?{aBrIT^Gs z`{EU750BhWl$cf!mfMHzeo2G|V$NYIqqpRk)%(gn8xB zjig~A?hrlmAA@%7j%PzBYGMC_)bN>9`4J#gY5n}`er)#C!FsmssjKbE-1!GYVovjA zC2&76&$-|=2-3>xtdD_NcBKJ>=&G!`VU7*Gk1(VSJWoTdghJvurf&PrEB*LqAMU4Y zC;XJ;okh(&XuO%`r^#xG@(=AZme$Lqz^ks9k7OcDvc!?>cAx^SDM;Oe|BYTtYy%@2 zLSJ+S4EbkP#+gA@jWpZj$#6y;M|P}wT3PvxD7h)kJ9{@iGAQV3(KIAc{pfG3Cr0#C z4amnQu4>J$O`qPBHl9A4SZN5~8cUSOagylYl`3{uPO#!_54bI#;w8p;sx=(n2d-{# z$7(5rdfw+nn9npdk=3??mZZ3)=>9HAan5J+KZXk*k~k$RRJcN;%GBPiqEGN|>})rEj&&YB*TddfRX;lRu-WCz9* zY~HpxEoI7z69t7PdWYDAU4tjLr>QN{xb*e)^}@@(*VWVWZtk(wcS>1vQ`?XK>07hk z&z{}blq##oFOhsc!EAc6u@h@VmUkkYkZogY54UAspL*HXR7%W<~hB;C^B)R8J zVWmaEU*7AJRYK3%=CjYu6JLCBvbN`!G}S*A1!p&LY0OqU#_Y8_R=qR1C-b=Ck>?6m z_IzKv@YsiPRljG?)6)(-O?X??!n^k=|FX1aQNjPez5l;%{@**#SG})!9{sv&ZkMx^ z)IPtCnxi3iFRT@>E6=(=bMn!{_M4|}G3|3n3l7-Mx43*!m4V-@zs&khK`VbOl+OS2 zZ|2F9ADRAjZQOWb&fe_j8pd0vsTI!+;5@wSE{B=-vy=;uxAeLvt5{vu;0&y}e&oo$ znJU|Qdix|-CsrFQ6r1wWg1=p_`c&}kncx4Mf4<)#$d`@h?ulhTO}=0D`>tQ}(E9uS zr%_GKf3vSP-TF5lczQ!bs7TX-6%AKsjJbT!E=+q%-dI6 zQh7DQkL2Y(c&%-$dh2yvNk-)RUr%SeiSJ%s_oeLABxZBH)pM46oCaLJl4|WZKgjb@NYfv-7yEA|tdE>{oIQAhSN_>1(cXrzg!unf zIt+z9Ten@-e;w7Ocj4{T7+r6>yI1#5>$$jKRptA;`XLeDmSrUBiEBNb#uo2Auk!mL z?kJt^*MHw_IxM}$@W$cddw=G6WZX&K%qcNhC+Ed$iRhZVw7ggER=!j#%!xF%Y7%TN ze!DN>7H9HhfByTm;c+jY>{xN^$W5CSieI9R`TF_-hs`}6WyDN*zOqBSVsqfR;CIn{MCW(kb*ka2tpM?=Pgo?m@(UMfJY_^$g_= X48K=9#q|OAWHNZV`njxgN@xNA<}?B+ literal 0 HcmV?d00001 From e26aa12e2340a911cc6f7488ad07b441c19fcf18 Mon Sep 17 00:00:00 2001 From: derekwaynecarr Date: Fri, 9 Sep 2016 12:46:11 -0400 Subject: [PATCH 070/115] Add documentation for disk based eviction --- docs/admin/out-of-resource.md | 162 ++++++++++++++++++++++++++++++++-- 1 file changed, 153 insertions(+), 9 deletions(-) diff --git a/docs/admin/out-of-resource.md b/docs/admin/out-of-resource.md index 16b8cc9e1e..480e074c42 100644 --- a/docs/admin/out-of-resource.md +++ b/docs/admin/out-of-resource.md @@ -31,10 +31,25 @@ summary API. | Eviction Signal | Description | |------------------|---------------------------------------------------------------------------------| | `memory.available` | `memory.available` := `node.status.capacity[memory]` - `node.stats.memory.workingSet` | +| `nodefs.available` | `nodefs.available` := `node.stats.fs.available` | +| `nodefs.inodesFree` | `nodefs.inodesFree` := `node.stats.fs.inodesFree` | +| `imagefs.available` | `imagefs.available` := `node.stats.runtime.imagefs.available` | +| `imagefs.inodesFree` | `imagefs.inodesFree` := `node.stats.runtime.imagefs.inodesFree` | -In future releases, the `kubelet` will support the ability to trigger eviction decisions based on disk pressure. +Each of the above signals support either a literal or percentage based value. The percentage based value +is calculated relative to the total capacity associated with each signal. -Until that time, it is recommended users take advantage of [garbage collection](/docs/admin/garbage-collection/). +`kubelet` supports only two filesystem partitions. + +1. The `nodefs` filesystem that kubelet uses for volumes, daemon logs, etc. +1. The `imagefs` filesystem that container runtimes uses for storing images and container writable layers. + +`imagefs` is optional. `kubelet` auto-discovers these filesystems using cAdvisor. `kubelet` does not care about any +other filesystems. Any other types of configurations are not currently supported by the kubelet. For example, it is +*not OK* to store volumes and logs in a dedicated `filesystem`. + +In future releases, the `kubelet` will deprecate the existing [garbage collection](/docs/admin/garbage-collection/) +support in favor of eviction in response to disk pressure. ### Eviction Thresholds @@ -47,6 +62,14 @@ 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 +* an eviction threshold can be expressed as a percentage if ends with `%` token. + +For example, if a node has `10Gi` of memory, and the desire is to induce eviction +if available memory falls below `1Gi`, an eviction threshold can be specified as either +of the following (but not both). + +* `memory.available<10%` +* `memory.available<1Gi` #### Soft Eviction Thresholds @@ -84,6 +107,10 @@ 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. +The `kubelet` has the following default hard eviction thresholds: + +* `--eviction-hard=memory.available<100Mi` + ### Eviction Monitoring Interval The `kubelet` evaluates eviction thresholds per its configured housekeeping interval. @@ -103,6 +130,7 @@ The following node conditions are defined that correspond to the specified evict | Node Condition | Eviction Signal | Description | |----------------|------------------|------------------------------------------------------------------| | `MemoryPressure` | `memory.available` | Available memory on the node has satisfied an eviction threshold | +| `DiskPressure` | `nodefs.available`, `nodefs.inodesFree`, `imagefs.available`, or `imagefs.inodesFree` | Available disk space and inodes on either the node's root filesytem or image filesystem 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`. @@ -124,15 +152,44 @@ The `kubelet` would ensure that it has not observed an eviction threshold being for the specified pressure condition for the period specified before toggling the condition back to `false`. -### Eviction of Pods +### Reclaiming node level resources 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` will initiate the process of reclaiming the pressured resource +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. +The `kubelet` attempts to reclaim node level resources prior to evicting end-user pods. If +disk pressure is observed, the `kubelet` reclaims node level resources differently if the +machine has a dedicated `imagefs` configured for the container runtime. + +#### With Imagefs + +If `nodefs` filesystem has met eviction thresholds, `kubelet` will free up disk space in the following order: + +1. Delete dead pods/containers + +If `imagefs` filesystem has met eviction thresholds, `kubelet` will free up disk space in the following order: + +1. Delete all unused images + +#### Without Imagefs + +If `nodefs` filesystem has met eviction thresholds, `kubelet` will free up disk space in the following order: + +1. Delete dead pods/containers +1. Delete all unused images + +### Evicting end-user pods + +If the `kubelet` is unable to reclaim sufficient resource on the node, +it will begin evicting pods. + +The `kubelet` ranks pods for eviction as follows: + +* by their quality of service +* by the consumption of the starved compute resource relative to the pods scheduling request. + +As a result, pod eviction occurs in the following order: * `BestEffort` pods that consume the most of the starved resource are failed first. @@ -151,6 +208,49 @@ and the node only has `Guaranteed` pod(s) remaining, then the node must choose t `Guaranteed` pod in order to preserve node stability, and to limit the impact of the unexpected consumption to other `Guaranteed` pod(s). +Local disk is a `BestEffort` resource. If necessary, `kubelet` will evict pods one at a time to reclaim +disk when `DiskPressure` is encountered. The `kubelet` will rank pods by quality of service. If the `kubelet` +is responding to `inode` starvation, it will reclaim `inodes` by evicting pods with the lowest quality of service +first. If the `kubelet` is responding to lack of available disk, it will rank pods within a quality of service +that consumes the largest amount of disk and kill those first. + +#### With Imagefs + +If `nodefs` is triggering evictions, `kubelet` will sort pods based on the usage on `nodefs` +- local volumes + logs of all its containers. + +If `imagefs` is triggering evictions, `kubelet` will sort pods based on the writable layer usage of all its containers. + +#### Without Imagefs + +If `nodefs` is triggering evictions, `kubelet` will sort pods based on their total disk usage +- local volumes + logs & writable layer of all its containers. + +### Minimum eviction reclaim + +In certain scenarios, eviction of pods could result in reclamation of small amount of resources. This can result in +`kubelet` hitting eviction thresholds in repeated successions. In addition to that, eviction of resources like `disk`, + is time consuming. + +To mitigate these issues, `kubelet` can have a per-resource `minimum-reclaim`. Whenever `kubelet` observes +resource pressure, `kubelet` will attempt to reclaim at least `minimum-reclaim` amount of resource below +the configured eviction threshold. + +For example, with the following configuration: + +``` +--eviction-hard=memory.available<500Mi,nodefs.available<1Gi,imagefs.available<100Gi +--eviction-minimum-reclaim="memory.available=0Mi,nodefs.available=500Mi,imagefs.available=2Gi"` +``` + +If an eviction threshold is triggered for `memory.available`, the `kubelet` will work to ensure +that `memory.available` is at least `500Mi`. For `nodefs.available`, the `kubelet` will work +to ensure that `nodefs.available` is at least `1.5Gi`, and for `imagefs.available` it will +work to ensure that `imagefs.available` is at least `102Gi` before no longer reporting pressure +on their associated resources. + +The default `eviction-minimum-reclaim` is `0` for all resources. + ### Scheduler The node will report a condition when a compute resource is under pressure. The @@ -159,7 +259,8 @@ pods on the node. | Node Condition | Scheduler Behavior | | ---------------- | ------------------------------------------------ | -| `MemoryPressure` | `BestEffort` pods are not scheduled to the node. | +| `MemoryPressure` | No new `BestEffort` pods are scheduled to the node. | +| `DiskPressure` | No new pods are scheduled to the node. | ## Node OOM Behavior @@ -223,3 +324,46 @@ 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. + +## Deprecation of existing feature flags to reclaim disk + +`kubelet` has been freeing up disk space on demand to keep the node stable. + +As disk based eviction matures, the following `kubelet` flags will be marked for deprecation +in favor of the simpler configuation supported around eviction. + +| Existing Flag | New Flag | +| ------------- | -------- | +| `--image-gc-high-threshold` | `--eviction-hard` or `eviction-soft` | +| `--image-gc-low-threshold` | `--eviction-minimum-reclaim` | +| `--maximum-dead-containers` | deprecated | +| `--maximum-dead-containers-per-container` | deprecated | +| `--minimum-container-ttl-duration` | deprecated | +| `--low-diskspace-threshold-mb` | `--eviction-hard` or `eviction-soft` | +| `--outofdisk-transition-frequency` | `--eviction-pressure-transition-period` | + +## Known issues + +### kubelet may not observe memory pressure right away + +The `kubelet` currently polls `cAdvisor` to collect memory usage stats at a regular interval. If memory usage +increases within that window rapidly, the `kubelet` may not observe `MemoryPressure` fast enough, and the `OOMKiller` +will still be invoked. We intend to integrate with the `memcg` notification API in a future release to reduce this +latency, and instead have the kernel tell us when a threshold has been crossed immmediately. + +If you are not trying to achieve extreme utilization, but a sensible measure of overcommit, a viable workaround for +this issue is to set eviction thresholds at approximately 75% capacity. This increases the ability of this feature +to prevent system OOMs, and promote eviction of workloads so cluster state can rebalance. + +### kubelet may evict more pods than needed + +The pod eviction may evict more pods than needed due to stats collection timing gap. This can be mitigated by adding +the ability to get root container stats on an on-demand basis (https://github.com/google/cadvisor/issues/1247) in the future. + +### How kubelet ranks pods for eviction in response to inode exhaustion + +At this time, it is not possible to know how many inodes were consumed by a particular container. If the `kubelet` observes +inode exhaustion, it will evict pods by ranking them by quality of service. The following issue has been opened in cadvisor +to track per container inode consumption (https://github.com/google/cadvisor/issues/1422) which would allow us to rank pods +by inode consumption. For example, this would let us identify a container that created large numbers of 0 byte files, and evict +that pod over others. From 531908510123462dc151323dbe6490b795ef1534 Mon Sep 17 00:00:00 2001 From: Rodrigo Campos Date: Wed, 21 Sep 2016 19:17:06 -0300 Subject: [PATCH 071/115] Fix secret file mode bits example on JSON I tested the example on YAML and, wrongly, asumed that JSON supported it too. Fixes: https://github.com/kubernetes/kubernetes/issues/33162 --- docs/user-guide/secrets/index.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/secrets/index.md b/docs/user-guide/secrets/index.md index 6d388dbebd..7a64f16218 100644 --- a/docs/user-guide/secrets/index.md +++ b/docs/user-guide/secrets/index.md @@ -291,7 +291,7 @@ For example, you can specify a default mode like this: "name": "foo", "secret": { "secretName": "mysecret", - "defaultMode": 0400 + "defaultMode": 256 } }] } @@ -301,6 +301,10 @@ For example, you can specify a default mode like this: Then, the secret will be mounted on `/etc/foo` and all the files created by the secret volume mount will have permission `0400`. +Note that the JSON spec doesn't support octal notation, so use the value 256 for +0400 permissions. If you use yaml instead of json for the pod, you can use octal +notation to specify permissions in a more natural way. + You can also use mapping, as in the previous example, and specify different permission for different files like this: @@ -328,7 +332,7 @@ permission for different files like this: "items": [{ "key": "username", "path": "my-group/my-username", - "mode": 0777 + "mode": 511 }] } }] @@ -337,7 +341,8 @@ permission for different files like this: ``` In this case, the file resulting in `/etc/foo/my-group/my-username` will have -permission `0777`. +permission value of `0777`. Owing to JSON limitations, you must specify the mode +in decimal notation. **Consuming Secret Values from Volumes** From 6446dfe2e8048162fab93f6c44d9da13b8fb5b85 Mon Sep 17 00:00:00 2001 From: keglevich3 Date: Thu, 22 Sep 2016 10:55:16 +0300 Subject: [PATCH 072/115] Changed according to the review --- docs/user-guide/node-selection/index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/user-guide/node-selection/index.md b/docs/user-guide/node-selection/index.md index b743948612..bce615ad74 100644 --- a/docs/user-guide/node-selection/index.md +++ b/docs/user-guide/node-selection/index.md @@ -67,8 +67,7 @@ met, the pod will still continue to run on the node. In the future we plan to of `requiredDuringSchedulingRequiredDuringExecution` which will be just like `requiredDuringSchedulingIgnoredDuringExecution` except that it will evict pods from nodes that cease to satisfy the pods' node affinity requirements. -Node affinity is currently expressed using an annotation on Pod. In v1.4 it will use a field, and we will -also introduce the second piece of the affinity mechanism, called pod affinity, +Node affinity is currently expressed using an annotation on Pod. After the release of 1.4, node affinity will use a field, and it will introduce an additional option for affinity called "pod affinity", which allows you to control whether a pod schedules onto a particular node based on which other pods are running on the node, rather than the labels on the node. From f2b90fa2c3fc23a3cba13a35628c35d59cadeea7 Mon Sep 17 00:00:00 2001 From: YuPengZTE Date: Thu, 22 Sep 2016 16:22:31 +0800 Subject: [PATCH 073/115] 'etc' should be 'etc.' Signed-off-by: YuPengZTE --- docs/getting-started-guides/rackspace.md | 2 +- docs/getting-started-guides/scratch.md | 2 +- docs/user-guide/jobs.md | 2 +- docs/user-guide/volumes.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/getting-started-guides/rackspace.md b/docs/getting-started-guides/rackspace.md index 5ed73f495f..5087344b83 100644 --- a/docs/getting-started-guides/rackspace.md +++ b/docs/getting-started-guides/rackspace.md @@ -62,7 +62,7 @@ There is a specific `cluster/rackspace` directory with the scripts for the follo ## Network Design - eth0 - Public Interface used for servers/containers to reach the internet -- eth1 - ServiceNet - Intra-cluster communication (k8s, etcd, etc) communicate via this interface. The `cloud-config` files use the special CoreOS identifier `$private_ipv4` to configure the services. +- eth1 - ServiceNet - Intra-cluster communication (k8s, etcd, etc.) communicate via this interface. The `cloud-config` files use the special CoreOS identifier `$private_ipv4` to configure the services. - eth2 - Cloud Network - Used for k8s pods to communicate with one another. The proxy service will pass traffic via this interface. ## Support Level diff --git a/docs/getting-started-guides/scratch.md b/docs/getting-started-guides/scratch.md index 38b7fa82f9..773cc796e0 100644 --- a/docs/getting-started-guides/scratch.md +++ b/docs/getting-started-guides/scratch.md @@ -72,7 +72,7 @@ accomplished in two ways: pod network through traffic encapsulation (e.g vxlan). - Encapsulation reduces performance, though exactly how much depends on your solution. - **Without an overlay network** - - Configure the underlying network fabric (switches, routers, etc) to be aware of pod IP addresses. + - Configure the underlying network fabric (switches, routers, etc.) to be aware of pod IP addresses. - This does not require the encapsulation provided by an overlay, and so can achieve better performance. diff --git a/docs/user-guide/jobs.md b/docs/user-guide/jobs.md index 59e09e7bcd..ae5e16b3d3 100644 --- a/docs/user-guide/jobs.md +++ b/docs/user-guide/jobs.md @@ -157,7 +157,7 @@ parallelism, for a variety or reasons: remaining completions. Higher values of `.spec.parallelism` are effectively ignored. - For work queue jobs, no new pods are started after any pod has succeeded -- remaining pods are allowed to complete, however. - If the controller has not had time to react. -- If the controller failed to create pods for any reason (lack of ResourceQuota, lack of permission, etc), +- If the controller failed to create pods for any reason (lack of ResourceQuota, lack of permission, etc.), then there may be fewer pods than requested. - The controller may throttle new pod creation due to excessive previous pod failures in the same Job. - When a pod is gracefully shutdown, it make take time to stop. diff --git a/docs/user-guide/volumes.md b/docs/user-guide/volumes.md index 9ccc8c73c3..0001dbd667 100644 --- a/docs/user-guide/volumes.md +++ b/docs/user-guide/volumes.md @@ -485,7 +485,7 @@ spec: ## Resources -The storage media (Disk, SSD, etc) of an `emptyDir` volume is determined by the +The storage media (Disk, SSD, etc.) of an `emptyDir` volume is determined by the medium of the filesystem holding the kubelet root dir (typically `/var/lib/kubelet`). There is no limit on how much space an `emptyDir` or `hostPath` volume can consume, and no isolation between containers or between From af2976b665327b24956a1e0fc8a51d2e6508a750 Mon Sep 17 00:00:00 2001 From: "Madhusudan.C.S" Date: Thu, 22 Sep 2016 01:53:56 -0700 Subject: [PATCH 074/115] Address review comments. --- docs/admin/federation/index.md | 112 ++++++++++++++++----------------- 1 file changed, 56 insertions(+), 56 deletions(-) diff --git a/docs/admin/federation/index.md b/docs/admin/federation/index.md index adb703de6a..a9d6f7d05c 100644 --- a/docs/admin/federation/index.md +++ b/docs/admin/federation/index.md @@ -13,10 +13,10 @@ This guide explains how to set up cluster federation that lets us control multip ## Prerequisites -This guide assumes that we have a running Kubernetes cluster. +This guide assumes that you 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 a Kubernetes release +This guide also assumes that you have a Kubernetes release [downloaded from here](/docs/getting-started-guides/binary_release/), extracted into a directory and all the commands in this guide are run from that directory. @@ -34,7 +34,7 @@ guide. Setting up federation requires running the federation control plane which consists of etcd, federation-apiserver (via the hyperkube binary) and -federation-controller-manager (also via the hyperkube binary). We can run +federation-controller-manager (also via the hyperkube binary). You can run these binaries as pods on an existing Kubernetes cluster. Note: This is a new mechanism to turn up Kubernetes Cluster Federation. If @@ -61,7 +61,7 @@ Initialize the setup. $ federation/deploy/deploy.sh init ``` -Optionally we can create/edit `${FEDERATION_OUTPUT_ROOT}/values.yaml` to +Optionally, you can create/edit `${FEDERATION_OUTPUT_ROOT}/values.yaml` to customize any value in [federation/federation/manifests/federation/values.yaml](https://github.com/madhusudancs/kubernetes-anywhere/blob/federation/federation/manifests/federation/values.yaml). Example: @@ -72,38 +72,38 @@ controllerManagerRegistry: "gcr.io/myrepository" controllerManagerVersion: "v1.5.0-alpha.0.1010+892a6d7af59c0b" ``` -Assuming we have built and pushed the `hyperkube` image to the repository +Assuming you have built and pushed the `hyperkube` image to the repository with the given tag in the example above. ### Getting images -To run the federation control plane components as pods, we first need the -images for all the components. We can either use the official release -images or we can build them ourselves from HEAD. +To run the federation control plane components as pods, you first need the +images for all the components. You can either use the official release +images or you can build them yourself from HEAD. ### Using official release images As part of every Kubernetes release, official release images are pushed to -`gcr.io/google_containers`. To use the images in this repository, we can -just set the container image fields in the following configs to point -to the images in this repository. `gcr.io/google_containers/hyperkube` -image includes the federation-apiserver and federation-controller-manager -binaries, so we can point the corresponding configs for those components +`gcr.io/google_containers`. To use the images in this repository, you can +set the container image fields in the following configs to point to the +images in this repository. `gcr.io/google_containers/hyperkube` image +includes the federation-apiserver and federation-controller-manager +binaries, so you can point the corresponding configs for those components to the hyperkube image. ### Building and pushing images from HEAD -To run the code from HEAD, we need to build and push our own images. -Assuming that we have checked out the -[Kuberntes repository](https://github.com/kubernetes/kubernetes) and -running these commands from the root of the source directory, we can -build the binaries using the following command: +To run the code from HEAD, you need to build and push your own images. +Check out the +[Kubernetes repository](https://github.com/kubernetes/kubernetes) +and run the following commands from the root of the source directory. +To build the binaries, run the following command: ```shell $ federation/develop/develop.sh build_binaries ``` -We can build the image and push it to the repository by running: +To build the image and push it to the repository run: ```shell $ KUBE_REGISTRY="gcr.io/myrepository" federation/develop/develop.sh build_image @@ -119,7 +119,7 @@ images from source. ### Running the federation control plane -Once we have the images, we can turn up the federation control plane by +Once you have the images, you can turn up the federation control plane by running: ```shell @@ -127,7 +127,7 @@ $ federation/deploy/deploy.sh deploy_federation ``` This spins up the federation control components as pods managed by -[`Deployments`](http://kubernetes.io/docs/user-guide/deployments/) on our +[`Deployments`](http://kubernetes.io/docs/user-guide/deployments/) on your existing Kubernetes cluster. It also starts a [`type: LoadBalancer`](http://kubernetes.io/docs/user-guide/services/#type-loadbalancer) [`Service`](http://kubernetes.io/docs/user-guide/services/) for the @@ -137,7 +137,7 @@ by a dynamically provisioned [`PV`](http://kubernetes.io/docs/user-guide/persistent-volumes/) for `etcd`. All these components are created in the `federation` namespace. -We can verify that the pods are available by running the following +You can verify that the pods are available by running the following command: ```shell @@ -147,8 +147,8 @@ federation-apiserver 1 1 1 1 1m federation-controller-manager 1 1 1 1 1m ``` -Running `deploy.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 +Running `deploy.sh` also creates a new record in your kubeconfig for us +to be able to talk to federation apiserver. You can view this by running `kubectl config view`. Note: Dynamic provisioning for persistent volume currently works only on @@ -157,11 +157,11 @@ your needs, if required. ## Registering Kubernetes clusters with federation -Now that we have the federation control plane up and running, we can start registering Kubernetes clusters. +Now that you have the federation control plane up and running, you 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: +First of all, you 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, you can create this secret in the host Kubernetes cluster (that hosts federation control plane). When federation starts supporting secrets, you will be able to create this secret there. +Suppose that your kubeconfig for Kubernetes cluster is at `/cluster1/kubeconfig`, you can run the following command to create the secret: ```shell $ kubectl create secret generic cluster1 --namespace=federation --from-file=/cluster1/kubeconfig @@ -169,7 +169,7 @@ $ kubectl create secret generic cluster1 --namespace=federation --from-file=/clu 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: +Now that the secret is created, you are ready to register the cluster. The YAML file for cluster will look like: ```yaml apiVersion: federation/v1beta1 @@ -184,16 +184,16 @@ spec: name: ``` -We need to insert the appropriate values for ``, `` and ``. -`` here is name of the secret that we just created. +You need to insert the appropriate values for ``, `` and ``. +`` here is name of the secret that you 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 +can use as per their CIDR. You can set the server's public IP address with CIDR +`"0.0.0.0/0"` which all clients will match. In addition, if you want internal +clients to use server's clusterIP, you 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: +Assuming your YAML file is located at `/cluster1/cluster.yaml`, you can run the following command to register this cluster: ```shell @@ -201,8 +201,8 @@ $ 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 +By specifying `--context=federation-cluster`, you direct the request to +federation apiserver. You can ensure that the cluster registration was successful by running: ```shell @@ -213,8 +213,8 @@ 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 +Once the cluster is registered with the federation, you are all set to use it. +But for the cluster to be able to route federation service requests, you 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: @@ -222,7 +222,7 @@ 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 +To update KubeDNS with federations flag, you 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. @@ -253,7 +253,7 @@ And then delete it by running: $ kubectl delete pods --namespace=kube-system ``` -We are now all set to start using federation. +You are now all set to start using federation. ## Turn down @@ -274,29 +274,29 @@ why the new mechanism doesn't work for your case by filing an issue here - ### 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. +To run these as pods, you first need images for all the components. You can use +official release images or you 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` +these images, set env var `FEDERATION_PUSH_REPO_BASE=gcr.io/google_containers` This will always use the latest image. To use the hyperkube image which includes federation-apiserver and -federation-controller-manager from a specific release, we can set -`FEDERATION_IMAGE_TAG`. +federation-controller-manager from a specific release, set the +`FEDERATION_IMAGE_TAG` environment variable. #### 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: +To run the code from HEAD, you need to build and push your own images. +You 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/`. +Next, you need to push these images to a registry such as Google Container Registry or Docker Hub, so that your cluster can pull them. +If Kubernetes cluster is running on Google Compute Engine (GCE), then you can push the images to `gcr.io/`. The command to push the images will look like: ```shell @@ -305,7 +305,7 @@ $ FEDERATION=true FEDERATION_PUSH_REPO_BASE=gcr.io/ ./build/pu ### Running the federation control plane -Once we have the images, we can run these as pods on our existing kubernetes cluster. +Once you have the images, you can run these as pods on your existing kubernetes cluster. The command to run these pods on an existing GCE cluster will look like: ```shell @@ -320,14 +320,14 @@ 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. +`FEDERATION_NAME` is a name you can choose for your 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 +`DNS_ZONE_NAME` is the domain to be used for DNS records. This is a domain that you 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: +You can verify that the pods are available by running the following command: ```shell $ kubectl get deployments --namespace=federation @@ -336,8 +336,8 @@ 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 +Running `federation-up.sh` also creates a new record in your kubeconfig for us +to be able to talk to federation apiserver. You can view this by running `kubectl config view`. Note: `federation-up.sh` creates the federation-apiserver pod with an etcd From b0d3fd5f6b9f58536d4bc3d72704f8c5789f7d36 Mon Sep 17 00:00:00 2001 From: YuPengZTE Date: Thu, 22 Sep 2016 17:07:06 +0800 Subject: [PATCH 075/115] Capitalizes the first letter Signed-off-by: YuPengZTE --- .../fedora/flannel_multi_node_cluster.md | 2 +- docs/getting-started-guides/gce.md | 8 ++++---- docs/getting-started-guides/scratch.md | 6 +++--- docs/user-guide/federation/federated-services.md | 6 +++--- docs/user-guide/images.md | 8 ++++---- docs/user-guide/jobs/expansions/index.md | 2 +- 6 files changed, 16 insertions(+), 16 deletions(-) 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 4c89d85e90..7f4504f2c9 100644 --- a/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md +++ b/docs/getting-started-guides/fedora/flannel_multi_node_cluster.md @@ -18,7 +18,7 @@ You need 2 or more machines with Fedora installed. **Perform following commands on the Kubernetes master** -* Configure flannel by creating a `flannel-config.json` in your current directory on fed-master. flannel provides udp and vxlan among other overlay networking backend options. In this guide, we choose kernel based vxlan backend. The contents of the json are: +* Configure flannel by creating a `flannel-config.json` in your current directory on fed-master. Flannel provides udp and vxlan among other overlay networking backend options. In this guide, we choose kernel based vxlan backend. The contents of the json are: ```json { diff --git a/docs/getting-started-guides/gce.md b/docs/getting-started-guides/gce.md index d768c4db7f..bbb210f95e 100644 --- a/docs/getting-started-guides/gce.md +++ b/docs/getting-started-guides/gce.md @@ -64,10 +64,10 @@ If you run into trouble, please see the section on [troubleshooting](/docs/getti The next few steps will show you: -1. how to set up the command line client on your workstation to manage the cluster -1. examples of how to use the cluster -1. how to delete the cluster -1. how to start clusters with non-default options (like larger clusters) +1. How to set up the command line client on your workstation to manage the cluster +1. Examples of how to use the cluster +1. How to delete the cluster +1. How to start clusters with non-default options (like larger clusters) ### Installing the Kubernetes command line tools on your workstation diff --git a/docs/getting-started-guides/scratch.md b/docs/getting-started-guides/scratch.md index 38b7fa82f9..7fffe7145e 100644 --- a/docs/getting-started-guides/scratch.md +++ b/docs/getting-started-guides/scratch.md @@ -514,9 +514,9 @@ availability. To run an etcd instance: -1. copy `cluster/saltbase/salt/etcd/etcd.manifest` -1. make any modifications needed -1. start the pod by putting it into the kubelet manifest directory +1. Copy `cluster/saltbase/salt/etcd/etcd.manifest` +1. Make any modifications needed +1. Start the pod by putting it into the kubelet manifest directory ### Apiserver, Controller Manager, and Scheduler diff --git a/docs/user-guide/federation/federated-services.md b/docs/user-guide/federation/federated-services.md index 1734d0af29..18c26d4014 100644 --- a/docs/user-guide/federation/federated-services.md +++ b/docs/user-guide/federation/federated-services.md @@ -40,9 +40,9 @@ 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 provider (like Google Cloud DNS, or AWS Route 53), thus ensuring that clients +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 provider (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. diff --git a/docs/user-guide/images.md b/docs/user-guide/images.md index c4a7b7c00a..e739bb0ca9 100644 --- a/docs/user-guide/images.md +++ b/docs/user-guide/images.md @@ -118,12 +118,12 @@ in the `$HOME` of user `root` on a kubelet, then docker will use it. Here are the recommended steps to configuring your nodes to use a private registry. In this example, run these on your desktop/laptop: - 1. run `docker login [server]` for each set of credentials you want to use. This updates `$HOME/.docker/config.json`. - 1. view `$HOME/.docker/config.json` in an editor to ensure it contains just the credentials you want to use. - 1. get a list of your nodes, for example: + 1. Run `docker login [server]` for each set of credentials you want to use. This updates `$HOME/.docker/config.json`. + 1. View `$HOME/.docker/config.json` in an editor to ensure it contains just the credentials you want to use. + 1. Get a list of your nodes, for example: - if you want the names: `nodes=$(kubectl get nodes -o jsonpath='{range.items[*].metadata}{.name} {end}')` - if you want to get the IPs: `nodes=$(kubectl get nodes -o jsonpath='{range .items[*].status.addresses[?(@.type=="ExternalIP")]}{.address} {end}')` - 1. copy your local `.docker/config.json` to the home directory of root on each node. + 1. Copy your local `.docker/config.json` to the home directory of root on each node. - for example: `for n in $nodes; do scp ~/.docker/config.json root@$n:/root/.docker/config.json; done` Verify by creating a pod that uses a private image, e.g.: diff --git a/docs/user-guide/jobs/expansions/index.md b/docs/user-guide/jobs/expansions/index.md index c955bbf124..9dd2786530 100644 --- a/docs/user-guide/jobs/expansions/index.md +++ b/docs/user-guide/jobs/expansions/index.md @@ -32,7 +32,7 @@ We also put the same label on the pod template so that we can check on all Pods 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. +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. From d322b78c53c1f5f4224aa9ee697d5c6cf53de2b9 Mon Sep 17 00:00:00 2001 From: Chmouel Boudjnah Date: Mon, 19 Sep 2016 13:48:04 +0200 Subject: [PATCH 076/115] minor spelling update using mispellings https://pypi.python.org/pypi/misspellings --- README.md | 2 +- docs/admin/authentication.md | 2 +- docs/admin/cluster-management.md | 2 +- docs/admin/garbage-collection.md | 2 +- docs/admin/multiple-zones.md | 2 +- docs/hellonode.md | 2 +- docs/templatedemos/filledout.md | 4 ++-- docs/user-guide/petset/bootstrapping/index.md | 4 ++-- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e2fc558f9d..a468c1f947 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ Your copy of the site will then be viewable at: [http://localhost:4000](http://l ## GitHub help -If you're a bit rusty with git/GitHub, you might wanna read +If you're a bit rusty with git/GitHub, you might want to read [this](http://readwrite.com/2013/10/02/github-for-beginners-part-2) for a refresher. ## Common Tasks diff --git a/docs/admin/authentication.md b/docs/admin/authentication.md index 08fde3265f..c3c5e52c77 100644 --- a/docs/admin/authentication.md +++ b/docs/admin/authentication.md @@ -228,7 +228,7 @@ it must be an array of strings. Kubernetes does not provide an OpenID Connect Identity Provider. You can use an existing public OpenID Connect Identity Provider (such as Google, or [others](http://connect2id.com/products/nimbus-oauth-openid-connect-sdk/openid-connect-providers)). -Or, you can run your own Identity Provider, such as CoreOS [dex](https://github.com/coreos/dex), [Keycloak](https://github.com/keycloak/keycloak) or CloudFoundary [UAA](https://github.com/cloudfoundry/uaa). +Or, you can run your own Identity Provider, such as CoreOS [dex](https://github.com/coreos/dex), [Keycloak](https://github.com/keycloak/keycloak) or CloudFoundry [UAA](https://github.com/cloudfoundry/uaa). The provider needs to support [OpenID connect discovery](https://openid.net/specs/openid-connect-discovery-1_0.html); not all do. diff --git a/docs/admin/cluster-management.md b/docs/admin/cluster-management.md index c681a45996..7781368bc8 100644 --- a/docs/admin/cluster-management.md +++ b/docs/admin/cluster-management.md @@ -84,7 +84,7 @@ no node that has enough free capacity (or doesn't match other pod requirements) to wait until some pods are terminated or a new node is added. 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. +to the other in the cluster, would help. If yes, then it resizes the cluster to accommodate the waiting pods. 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). diff --git a/docs/admin/garbage-collection.md b/docs/admin/garbage-collection.md index bb7f2c2133..a3112a07f1 100644 --- a/docs/admin/garbage-collection.md +++ b/docs/admin/garbage-collection.md @@ -52,5 +52,5 @@ Containers can potentially be garbage collected before their usefulness has expi can contain logs and other data that can be useful for troubleshooting. A sufficiently large value for `maximum-dead-containers-per-container` is highly recommended to allow at least 2 dead containers to be retained per expected container. A higher value for `maximum-dead-containers` is also recommended for a -similiar reason. +similar reason. See [this issue](https://github.com/kubernetes/kubernetes/issues/13287) for more details. diff --git a/docs/admin/multiple-zones.md b/docs/admin/multiple-zones.md index e5d1367862..bfde54213e 100644 --- a/docs/admin/multiple-zones.md +++ b/docs/admin/multiple-zones.md @@ -39,7 +39,7 @@ or service across nodes in a single-zone cluster (to reduce the impact of failures.) With multiple-zone clusters, this spreading behaviour is extended across zones (to reduce the impact of zone failures.) (This is achieved via `SelectorSpreadPriority`). This is a best-effort -placement, and so if the zones in your cluster are heterogenous +placement, and so if the zones in your cluster are heterogeneous (e.g. different numbers of nodes, different types of nodes, or different pod resource requirements), this might prevent perfectly even spreading of your pods across zones. If desired, you can use diff --git a/docs/hellonode.md b/docs/hellonode.md index e489927aff..602a383a5b 100755 --- a/docs/hellonode.md +++ b/docs/hellonode.md @@ -117,7 +117,7 @@ curl http://localhost:8080 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:* +**Note:** *If you receive 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" diff --git a/docs/templatedemos/filledout.md b/docs/templatedemos/filledout.md index ba56528a20..9622fa2c14 100644 --- a/docs/templatedemos/filledout.md +++ b/docs/templatedemos/filledout.md @@ -42,7 +42,7 @@ kubectl get pod | Return Value | Description | |--------------|-------------| -| `READY` | Describes the number of containers that are ready to recieve traffic. | +| `READY` | Describes the number of containers that are ready to receive 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` @@ -77,4 +77,4 @@ YAML EXAMPLE HERE {% endcapture %} -{% include templates/concept-overview.md %} \ No newline at end of file +{% include templates/concept-overview.md %} diff --git a/docs/user-guide/petset/bootstrapping/index.md b/docs/user-guide/petset/bootstrapping/index.md index 7ad12cc8e8..e9b04fc135 100644 --- a/docs/user-guide/petset/bootstrapping/index.md +++ b/docs/user-guide/petset/bootstrapping/index.md @@ -19,7 +19,7 @@ This example shows you how to "carry over" runtime state across Pet restart by s ### 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 straightforward 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: +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 transferred to future pets. Doing so is straightforward 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 entire 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 @@ -130,7 +130,7 @@ Here's a tiny peer finder helper script that handles peer discovery, [available * 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 +* An `on-change` script to run every time the constituency of the given domain changes The role of the peer finder: From 93afc4cb00cb9a0bcfeb8dcedf500f3287a99d02 Mon Sep 17 00:00:00 2001 From: Matthew Wong Date: Thu, 22 Sep 2016 11:22:02 -0400 Subject: [PATCH 077/115] Add protocol to resturl format --- docs/user-guide/persistent-volumes/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/persistent-volumes/index.md b/docs/user-guide/persistent-volumes/index.md index 48b5f2c630..e16954a2f1 100644 --- a/docs/user-guide/persistent-volumes/index.md +++ b/docs/user-guide/persistent-volumes/index.md @@ -379,7 +379,7 @@ parameters: ``` * `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 provisions gluster volumes on demand. The format should be `IPaddress:Port` and this parameter is mandatory when using the GlusterFS dynamic provisioner. +* `resturl` : Gluster REST service url which provisions gluster volumes on demand. The format should be `http://IPaddress:Port` and this parameter is mandatory when using the GlusterFS dynamic provisioner. * `restauthenabled` : A boolean value that indicates whether Gluster REST service authentication is enabled on the REST server. If this value is 'true', you must supply values for the 'restuser' and 'restuserkey' parameters." * `restuser` : Gluster REST service user, who has access to create volumes in the Gluster Trusted Pool. * `restuserkey` : Gluster REST service user's password, will be used for authentication to the REST server. From 8be6fc2e1eee825ae117aed8ad71c991e045a2e3 Mon Sep 17 00:00:00 2001 From: nikhiljindal Date: Thu, 22 Sep 2016 11:04:06 -0700 Subject: [PATCH 078/115] Deleting empty file --- docs/user-guide/pod-security-policy/sj.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 docs/user-guide/pod-security-policy/sj.yaml diff --git a/docs/user-guide/pod-security-policy/sj.yaml b/docs/user-guide/pod-security-policy/sj.yaml deleted file mode 100644 index e69de29bb2..0000000000 From 78dccc0366deeb2d5b4c2e14df39d59bfac866bc Mon Sep 17 00:00:00 2001 From: "Madhusudan.C.S" Date: Thu, 22 Sep 2016 11:05:18 -0700 Subject: [PATCH 079/115] Address more review comments. --- docs/admin/federation/index.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/admin/federation/index.md b/docs/admin/federation/index.md index a9d6f7d05c..41d43b9572 100644 --- a/docs/admin/federation/index.md +++ b/docs/admin/federation/index.md @@ -93,17 +93,16 @@ to the hyperkube image. ### Building and pushing images from HEAD -To run the code from HEAD, you need to build and push your own images. -Check out the -[Kubernetes repository](https://github.com/kubernetes/kubernetes) -and run the following commands from the root of the source directory. -To build the binaries, run the following command: +To build the binaries, check out the +[Kubernetes repository](https://github.com/kubernetes/kubernetes) and +run the following commands from the root of the source directory: + ```shell $ federation/develop/develop.sh build_binaries ``` -To build the image and push it to the repository run: +To build the image and push it to the repository, run: ```shell $ KUBE_REGISTRY="gcr.io/myrepository" federation/develop/develop.sh build_image From 16751767266a0892aaff1ee6f3d4c6b492bbd939 Mon Sep 17 00:00:00 2001 From: bprashanth Date: Thu, 22 Sep 2016 15:30:57 -0700 Subject: [PATCH 080/115] Clarify petset docs --- docs/user-guide/petset.md | 164 ++++++++++++++++++++++++++++---------- 1 file changed, 124 insertions(+), 40 deletions(-) diff --git a/docs/user-guide/petset.md b/docs/user-guide/petset.md index 7694ca3d87..6063062df6 100644 --- a/docs/user-guide/petset.md +++ b/docs/user-guide/petset.md @@ -18,7 +18,7 @@ Throughout this doc you will see a few terms that are sometimes used interchange * 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. +* Pet: a single member of a PetSet; more generally, a stateful application. * Peer: a process running a server, capable of communicating with other such processes. __Prerequisites__ @@ -31,9 +31,9 @@ This doc assumes familiarity with the following Kubernetes concepts: * [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. +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 PetSet on a hosted Kubernetes provider that has disabled `alpha` resources. -## What is a Pet Set? +## What is a PetSet? 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. @@ -44,7 +44,7 @@ In Kubernetes, most pod management abstractions group them into disposable units | 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". +A PetSet, 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 @@ -54,50 +54,49 @@ A Pet Set, in contrast, is a group of stateful pods that require a stronger noti 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. +The goal of PetSet 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. +__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 PetSet has at most one Pet with a given identity. -## When to use Pet Set? +## When to use PetSet? -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 PetSet 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: +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. PetSet 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. +Only use PetSet if your application requires some or all of these properties. Managing pods as stateless replicas is vastly easier. -Example workloads for Pet Set: +Example workloads for PetSet: * 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. +Before you start deploying applications as PetSets, there are a few limitations you should understand. -* Pet Set is an *alpha* resource, not available in any Kubernetes release prior to 1.3. +* PetSet 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 only updatable field on a PetSet 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. +* Deleting and/or scaling a PetSet down will *not* delete the volumes associated with the PetSet. This is done to ensure safety first, your data is more valuable than an auto purge of all related PetSet resources. **Deleting the Persistent Volume Claims will result in a deletion of the associated volumes**. +* All PetSets 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 PetSet is currently a manual process, meaning you either need to deploy a new PetSet with the new image version, or orphan Pets one by one, update their image, and join them back to the cluster. -## Example Pet Set +## Example PetSet -We'll create a basic Pet Set to demonstrate how Pets are assigned unique and "sticky" identities. +We'll create a basic PetSet 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: +Saving this config into `petset.yaml` and submitting it to a Kubernetes cluster should create the defined PetSet and Pets it manages: ```shell $ kubectl create -f petset.yaml @@ -122,7 +121,7 @@ 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 +2 persistent volumes, one per pod. This is auto created by the PetSet based on the `volumeClaimTemplate` field ```shell $ kubectl get pv @@ -133,11 +132,11 @@ pvc-902733c2-3717-11e6-a46e-42010af00002 1Gi RWO Bound de ### 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. +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 PetSet. -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: +Here are some examples of choices for Cluster Domain, Service name, PetSet 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 Domain | Service (ns/name) | PetSet (ns/name) | PetSet 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} | @@ -181,7 +180,7 @@ 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: +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 PetSet. So let's write our hostname there: ```shell $ for i in 0 1; do @@ -222,11 +221,11 @@ A pet can piece together its own identity: 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). +It's not necessary to "discover" the governing Service of a PetSet, 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). +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 PetSet. 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 discover your peers using DNS records. To illustrate this we can use the previous example (note: one usually doesn't `apt-get` in a container). +PetSet gives you a way to discover 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 @@ -241,13 +240,13 @@ nginx.default.svc.cluster.local service = 10 50 0 web-1.ub.default.svc.cluster.l nginx.default.svc.cluster.local service = 10 50 0 web-0.ub.default.svc.cluster.local. ``` -## Updating a Pet Set +## Updating a PetSet -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). +You cannot update any field of the PetSet except `spec.replicas` and the `containers` in the podTemplate. Updating `spec.replicas` will scale the PetSet, updating `containers` will not have any effect till a Pet is deleted, at which time it is recreated with the modified podTemplate. -## Scaling a Pet Set +## Scaling a PetSet -You can scale a Pet Set by updating the "replicas" field. Note however that the controller will only: +You can scale a PetSet 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 @@ -268,12 +267,97 @@ 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: +You can also use the `kubectl scale` command: ```shell -$ kubectl delete -f petset.yaml +$ kubectl get petset +NAME DESIRED CURRENT AGE +web 3 3 24m + +$ kubectl scale petset web --replicas=5 +petset "web" scaled + +$ kubectl get po --watch-only +NAME READY STATUS RESTARTS AGE +web-0 1/1 Running 0 10m +web-1 1/1 Running 0 27m +web-2 1/1 Running 0 10m +web-3 1/1 Running 0 3m +web-4 0/1 ContainerCreating 0 48s + +$ kubectl get petset web +NAME DESIRED CURRENT AGE +web 5 5 30m +``` + +Note however, that scaling up to N and back down to M *will not* delete the volumes of the M-N pets, as described in the section on [deletion](#deleting-a-petset), i.e scaling back up to M creates new pets that use the same volumes. To see this in action, scale the PetSet back down to 3: + +```shell +$ kubectl get po --watch-only +web-4 1/1 Terminating 0 4m +web-4 1/1 Terminating 0 4m +web-3 1/1 Terminating 0 6m +web-3 1/1 Terminating 0 6m +``` + +Note that we still have 5 pvcs: + +```shell +$ kubectl get pvc +NAME STATUS VOLUME CAPACITY ACCESSMODES AGE +www-web-0 Bound pvc-42ca5cef-8113-11e6-82f6-42010af00002 1Gi RWO 32m +www-web-1 Bound pvc-42de30af-8113-11e6-82f6-42010af00002 1Gi RWO 32m +www-web-2 Bound pvc-ba416413-8115-11e6-82f6-42010af00002 1Gi RWO 14m +www-web-3 Bound pvc-ba45f19c-8115-11e6-82f6-42010af00002 1Gi RWO 14m +www-web-4 Bound pvc-ba47674a-8115-11e6-82f6-42010af00002 1Gi RWO 14m +``` + +This allows you to upgrade the image of a petset and have it come back up with the same data, as described in the next section. + +## Image upgrades + +PetSet currently *does not* support automated image upgrade as noted in the section on [limitations](#alpha-limitations), however you can update the `image` field of any container in the podTemplate and delete Pets one by one, the PetSet controller will recreate it with the new image. + +Edit the image on the PetSet to `gcr.io/google_containers/nginx-slim:0.7` and delete 1 Pet: + +```shell{% raw %} +$ for p in 0 1 2; do kubectl get po web-$p --template '{{range $i, $c := .spec.containers}}{{$c.image}}{{end}}'; echo; done +gcr.io/google_containers/nginx-slim:0.8 +gcr.io/google_containers/nginx-slim:0.8 +gcr.io/google_containers/nginx-slim:0.8 + +$ kubectl delete po web-0 +pod "web-0" deleted + +$ for p in 0 1 2; do kubectl get po web-$p --template '{{range $i, $c := .spec.containers}}{{$c.image}}{{end}}'; echo; done +gcr.io/google_containers/nginx-slim:0.7 +gcr.io/google_containers/nginx-slim:0.8 +gcr.io/google_containers/nginx-slim:0.8 +{% endraw %}``` + +Delete the remaining 2: + +```shell +$ kubectl delete po web-1 web-2 +pod "web-1" deleted +pod "web-2" deleted +``` + +Wait till the PetSet is stable and check the images: + +```shell{% raw %} +$ for p in 0 1 2; do kubectl get po web-$p --template '{{range $i, $c := .spec.containers}}{{$c.image}}{{end}}'; echo; done +gcr.io/google_containers/nginx-slim:0.7 +gcr.io/google_containers/nginx-slim:0.7 +gcr.io/google_containers/nginx-slim:0.7 +{% endraw %}``` + +## Deleting a PetSet + +Deleting a PetSet through kubectl will scale it down to 0, thereby deleting all the Pets. If you wish to delete just the PetSet and not the Pets, use `--cascade=false`: + +```shell +$ kubectl delete -f petset.yaml --cascade=false petset "web" deleted $ kubectl get po -l app=nginx @@ -312,18 +396,18 @@ $ kubectl delete pvc -l app=nginx ## Troubleshooting -You might have noticed an `annotations` field in all the Pet Sets shown above. +You might have noticed an `annotations` field in all the PetSets 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. +This field is a debugging hook. It pauses any scale up/down operations on the entire PetSet. 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 PetSet). If you don't need it, create the PetSet 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. +There are a LOT of planned improvements since PetSet is still in alpha. * Data gravity and local storage * Richer notification events From 22a8dbb58e2d35a9e8ff5c7d3406c432945c96b5 Mon Sep 17 00:00:00 2001 From: Luke Marsden Date: Thu, 15 Sep 2016 13:47:42 +0100 Subject: [PATCH 081/115] Squashed commits for kubeadm and addons docs. --- _data/guides.yml | 8 +- docs/admin/addons.md | 24 +++++ docs/index.md | 13 ++- docs/kubeadm.md | 247 +++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 286 insertions(+), 6 deletions(-) create mode 100644 docs/admin/addons.md create mode 100644 docs/kubeadm.md diff --git a/_data/guides.yml b/_data/guides.yml index 785f58ae26..b956870e58 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -8,10 +8,12 @@ toc: section: - title: What is Kubernetes? path: /docs/whatisk8s/ + - title: Installing Kubernetes Easily on Linux + path: /docs/kubeadm/ + - title: Hello World on Google Container Engine + path: /docs/hellonode/ - title: Downloading or Building Kubernetes path: /docs/getting-started-guides/binary_release/ - - title: Hello World Walkthrough - path: /docs/hellonode/ - title: Online Training Course path: https://www.udacity.com/course/scalable-microservices-with-kubernetes--ud615 @@ -250,6 +252,8 @@ toc: path: /docs/admin/ - title: Cluster Management Guide path: /docs/admin/cluster-management/ + - title: Installing Addons + path: /docs/admin/addons/ - title: Sharing a Cluster with Namespaces path: /docs/admin/namespaces/ - title: Namespaces Walkthrough diff --git a/docs/admin/addons.md b/docs/admin/addons.md new file mode 100644 index 0000000000..4a3d1710f6 --- /dev/null +++ b/docs/admin/addons.md @@ -0,0 +1,24 @@ +--- +--- + +## Overview + +Add-ons extend the functionality of Kubernetes in a pluggable way. + +This page lists some of the available add-ons and links to their respective installation instructions. + +## Networking and Network Policy + +* [Weave Net](https://github.com/weaveworks/weave-kube) is an easy, fast and reliable pod network that carries on working in the face of network partitions, does not depend on a database, and supports Kubernetes policy. +* [Calico](https://github.com/projectcalico/calico-containers/tree/master/docs/cni/kubernetes/manifests/kubeadm) is a simple, scalable, secure L3 networking and network policy provider. +* [Canal](https://github.com/tigera/canal/tree/master/k8s-install/kubeadm) unites Flannel and Calico, providing cloud native networking and network policy. + +## Visualization & Control + +* [Weave Scope](https://www.weave.works/documentation/scope-latest-installing/#k8s) is a tool for graphically visualizing your containers, pods, services etc. Use it in conjunction with a [Weave Cloud account](https://cloud.weave.works/) or host the UI yourself. + +## Legacy Add-ons + +There are several other add-ons documented in the deprecated [cluster/addons](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons) directory. + +Well-maintained ones should be linked to here. PRs welcome! diff --git a/docs/index.md b/docs/index.md index fb40b3fa5f..6c83b696a0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -77,13 +77,18 @@ h2, h3, h4 { Read the Overview
    -

    Hello Node!

    -

    In this quickstart, we’ll be creating a Kubernetes instance that stands up a simple “Hello World” app using Node.js. In just a few minutes you'll go from zero to deployed Kubernetes app on Google Container Engine.

    - Get Started +

    Hello World on Google Container Engine

    +

    In this quickstart, we’ll be creating a Kubernetes instance that stands up a simple “Hello World” app using Node.js. In just a few minutes you'll go from zero to deployed Kubernetes app on Google Container Engine (GKE), a hosted service from Google.

    + Get Started on GKE +
    +
    +

    Installing Kubernetes Easily on Linux

    +

    This quickstart will show you how to install a secure Kubernetes cluster on any computers running Linux, using a tool called kubeadm which is part of Kubernetes. It'll work with local VMs, physical servers and/or cloud servers, either manually or as part of your own automation. It is currently in alpha but please try it out and give us feedback!

    + Install Kubernetes Easily

    Guided Tutorial

    -

    If you’ve completed the quickstart, a great next step is Kubernetes 101. You will follow a path through the various features of Kubernetes, with code examples along the way, learning all of the core concepts. There's also a Kubernetes 201!

    +

    If you’ve completed one of the quickstarts, a great next step is Kubernetes 101. You will follow a path through the various features of Kubernetes, with code examples along the way, learning all of the core concepts. There's also a Kubernetes 201!

    Kubernetes 101
    diff --git a/docs/kubeadm.md b/docs/kubeadm.md new file mode 100644 index 0000000000..c3f3836d8e --- /dev/null +++ b/docs/kubeadm.md @@ -0,0 +1,247 @@ +--- +--- + + + +## Overview + +This quickstart will show you how to easily install a secure Kubernetes cluster on machines running Ubuntu 16.04 or CentOS 7, using a tool called `kubeadm` which is part of Kubernetes. + +This process should work with local VMs, physical servers and/or cloud servers. +It is intended to be simple enough that you can easily integrate its use into your own automation (Terraform, Chef, Puppet, etc). + +**The `kubeadm` tool is currently in alpha but please try it out and give us [feedback](/docs/kubeadm/#feedback)!** + +## Prerequisites + +1. One or more machines running Ubuntu 16.04 or CentOS 7 +1. 2GB or more of RAM per machine +1. A network connection with open ports between the machines (public or private network is fine) + +## Objectives + +* Install a secure Kubernetes cluster on your machines +* Install a pod network on the cluster so that application components (pods) can talk to each other +* Install a sample microservices application (a socks shop) on the cluster + +## Instructions + +### (1/4) Installing kubelet and kubeadm on your hosts + +You will now install the following packages on all the machines: + +* `docker`: the container runtime, which Kubernetes depends on. +* `kubelet`: the most core component of Kubernetes. + It runs on all of the machines in your cluster and does things like starting pods and containers. +* `kubectl`: the command to control the cluster once it's running. + You will only use this on the master. +* `kubeadm`: the command to bootstrap the cluster. + +For each host in turn: + + + + +* SSH into the machine and become `root` if you are not already (for example, run `sudo su -`). +* If the machine is running Ubuntu 16.04, run: + + # apt-get install -y docker.io socat + # curl -s -L \ + "https://www.dropbox.com/s/tso6dc7b94ch2sk/debs-5ab576.txz?dl=1" | tar xJv + # dpkg -i debian/bin/unstable/xenial/*.deb + + If the machine is running CentOS 7, run: + + # cat < /etc/yum.repos.d/k8s.repo + [kubelet] + name=kubelet + baseurl=http://files.rm-rf.ca/rpms/kubelet/ + enabled=1 + gpgcheck=0 + EOF + # yum install docker kubelet kubeadm kubectl kubernetes-cni + # systemctl enable docker && systemctl start docker + # systemctl enable kubelet && systemctl start kubelet + +The kubelet will now be restarting every few seconds, as it waits in a crashloop for `kubeadm` to tell it what to do. + +Optionally, see also [more details on installing Docker](https://docs.docker.com/engine/installation/#/on-linux). + +### (2/4) Initializing your master + +The master is the machine where the "control plane" components run, including `etcd` (the cluster database) and the API server (which the `kubectl` CLI communicates with). +All of these components will run in pods started by `kubelet`. + +To initialize the master, pick one of the machines you previously installed `kubelet` and `kubeadm` on, and run: + +* If you want to be able to schedule pods on the master, for example if you want a single-machine Kubernetes cluster for development, run: + + # kubeadm init --schedule-pods-here + +* If you do not want to be able to schedule pods on the master (perhaps for security reasons), run: + + # kubeadm init + +This will download and install the cluster database and "control plane" components. +This may take several minutes. + +The output should look like: + + generated token: "f0c861.753c505740ecde4c" + created keys and certificates in "/etc/kubernetes/pki" + created "/etc/kubernetes/kubelet.conf" + created "/etc/kubernetes/admin.conf" + created API client configuration + created API client, waiting for the control plane to become ready + all control plane components are healthy after 61.346626 seconds + waiting for at least one node to register and become ready + first node is ready after 4.506807 seconds + created essential addon: kube-discovery + created essential addon: kube-proxy + created essential addon: kube-dns + + Kubernetes master initialised successfully! + + You can connect any number of nodes by running: + + kubeadm join --token + +Make a record of the `kubeadm join` command that `kubeadm init` outputs. +You will need this in a moment. +The key included here is secret, keep it safe — anyone with this key will be able to add authenticated nodes to your cluster. + +The key is used for mutual authentication between the master and the joining nodes. + +### (3/4) Joining your nodes + +The nodes are where your workloads (containers and pods, etc) will run. +If you want to add any new machines as nodes to your cluster, for each machine: SSH to that machine, become root (e.g. `sudo su -`) and run the command that was output by `kubeadm init`. +For example: + + # kubeadm join --token + validating provided token + created cluster info discovery client, requesting info from "http://138.68.156.129:9898/cluster-info/v1/?token-id=0f8588" + cluster info object received, verifying signature using given token + cluster info signature and contents are valid, will use API endpoints [https://138.68.156.129:443] + created API client to obtain unique certificate for this node, generating keys and certificate signing request + received signed certificate from the API server, generating kubelet configuration + created "/etc/kubernetes/kubelet.conf" + + Node join complete: + * Certificate signing request sent to master and response + received. + * Kubelet informed of new secure connection details. + + Run 'kubectl get nodes' on the master to see this machine join. + +A few seconds later, you should notice that running `kubectl get nodes` on the master shows a cluster with as many machines as you created. + +**YOUR CLUSTER IS NOT READY YET!** + +Before you can deploy applications to it, you need to install a pod network. + +### (4/4) Installing a pod network + +You must install a pod network add-on so that your pods can communicate with each other when they are on different hosts. + +Several projects provide Kubernetes pod networks. +You can see a complete list of available network add-ons on the [add-ons page](/docs/admin/addons/). + +By way of example, you can install Weave Net by running on the master: + + # kubectl apply -f https://git.io/weave-kube + daemonset "weave-net" created + +**You should install a pod network on the master before you try to deploy any applications to your cluster.** + +Once a pod network command has installed, a few seconds later you should see the `kube-dns` pod go into `Running` in the output of `kubectl get pods --all-namespaces`. + +**This signifies that your cluster is ready.** + +You can learn more about other available pod networks on the [add-ons page](/docs/admin/addons/). + +### (Optional) Installing a sample application + +As an example, you will now install a sample microservices application, a socks shop, to put your cluster through its paces. +To learn more about the sample microservices app, see the [GitHub README](https://github.com/microservices-demo/microservices-demo). + +Here you will install the NodePort version of the Socks Shop, which doesn't depend on Load Balancer integration, since our cluster doesn't have that: + + # kubectl apply -f https://raw.githubusercontent.com/lukemarsden/microservices-demo/master/deploy/kubernetes/definitions/wholeWeaveDemo-NodePort.yaml + +You can then find out the port that the [NodePort feature of services](/docs/user-guide/services/) allocated for the front-end service by running: + + # kubectl describe svc front-end + Name: front-end + Namespace: default + Labels: name=front-end + Selector: name=front-end + Type: NodePort + IP: 100.66.88.176 + Port: 80/TCP + NodePort: 31869/TCP + Endpoints: + Session Affinity: None + +It will take several minutes to download and start all the containers, watch the output of `kubectl get pods` to see when they're all up and running. + +Then go to the IP address of your cluster's master node in your browser, and specify the given port. +So for example, `http://:`. +In the example above, this was `31869`, but it will be a different port for you. + +If there is a firewall, make sure it exposes this port to the internet before you try to access it. + +### Explore other add-ons + +See the [list of add-ons](/docs/admin/addons/) to explore other add-ons, including tools for logging, monitoring, network policy, visualization & control of your Kubernetes cluster. + + +## What's next + +* Learn more about [Kubernetes concepts and kubectl in Kubernetes 101](/docs/user-guide/walkthrough/). +* Install Kubernetes with [a cloud provider configurations](/docs/getting-started-guides/) to add Load Balancer and Persistent Volume support. + + +## Cleanup + +* To uninstall the socks shop, run `kubectl delete -f https://raw.githubusercontent.com/lukemarsden/microservices-demo/master/deploy/kubernetes/definitions/wholeWeaveDemo-NodePort.yaml`. +* To uninstall Kubernetes, simply delete the machines you created for this tutorial. + Or alternatively, uninstall the `kubelet`, `kubeadm` and `kubectl` packages and then manually delete all the Docker container that were created by this process. + +## Feedback + +* Slack Channel: [#sig-cluster-lifecycle](https://kubernetes.slack.com/messages/sig-cluster-lifecycle/) +* Mailing List: [kubernetes-sig-cluster-lifecycle](https://groups.google.com/forum/#!forum/kubernetes-sig-cluster-lifecycle) +* [GitHub Issues](https://github.com/kubernetes/kubernetes/issues): please tag `kubeadm` issues with `@kubernetes/sig-cluster-lifecycle` + +## Limitations + +Please note: `kubeadm` is a work in progress and these limitations will be addressed in due course. + +1. The cluster created here doesn't have cloud-provider integrations, so for example won't work with (for example) [Load Balancers](/docs/user-guide/load-balancer/) (LBs) or [Persistent Volumes](/docs/user-guide/persistent-volumes/walkthrough/) (PVs). + To easily obtain a cluster which works with LBs and PVs Kubernetes, try [the "hello world" GKE tutorial](/docs/hellonode) or [one of the other cloud-specific installation tutorials](/docs/getting-started-guides/). + + Workaround: use the [NodePort feature of services](/docs/user-guide/services/#type-nodeport) to demonstrate exposing the sample application on the internet. +1. The cluster created here will have a single master, with a single `etcd` database running on it. + This means that if the master fails, your cluster will lose its configuration data and will need to be recreated from scratch. + Adding HA support (multiple `etcd` servers, multiple API servers, etc) to `kubeadm` is still a work-in-progress. + + Workaround: regularly [back up etcd](https://coreos.com/etcd/docs/latest/admin_guide.html). + The `etcd` data directory configured by `kubeadm` is at `/var/lib/etcd` on the master. +1. `kubectl logs` is broken with `kubeadm` clusters due to [#22770](https://github.com/kubernetes/kubernetes/issues/22770). + + Workaround: use `docker logs` on the nodes where the containers are running as a workaround. +1. There is not yet an easy way to generate a `kubeconfig` file which can be used to authenticate to the cluster remotely with `kubectl` on, for example, your workstation. + + Workaround: copy the kubelet's `kubeconfig` from the master: use `scp root@:/etc/kubernetes/kubelet.conf .` and then e.g. `kubectl --kubeconfig ./kubelet.conf get nodes` from your workstation. From 6a54f558229dbfadc4d4f6721c0af730e6832d19 Mon Sep 17 00:00:00 2001 From: Alex Robinson Date: Fri, 23 Sep 2016 11:45:19 -0400 Subject: [PATCH 082/115] Don't reference elasticsearch/kibana in gce getting started guide The default GCE configuration uses fluentd-cloud-logging, so it's misleading to tell people about elasticsearch/kibana being in their cluster. --- docs/getting-started-guides/gce.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started-guides/gce.md b/docs/getting-started-guides/gce.md index bc3d664909..f7cce78a7c 100644 --- a/docs/getting-started-guides/gce.md +++ b/docs/getting-started-guides/gce.md @@ -46,7 +46,7 @@ wget -q -O - https://get.k8s.io | bash Once this command completes, you will have a master VM and four worker VMs, running as a Kubernetes cluster. -By default, some containers will already be running on your cluster. Containers like `kibana` and `elasticsearch` provide [logging](/docs/getting-started-guides/logging), while `heapster` provides [monitoring](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/cluster-monitoring/README.md) services. +By default, some containers will already be running on your cluster. Containers like `fluentd` provide [logging](/docs/getting-started-guides/logging), while `heapster` provides [monitoring](http://releases.k8s.io/{{page.githubbranch}}/cluster/addons/cluster-monitoring/README.md) services. The script run by the commands above creates a cluster with the name/prefix "kubernetes". It defines one specific cluster config, so you can't run it more than once. From b603098192f8c4105723ef50d27354ae9f93f473 Mon Sep 17 00:00:00 2001 From: ankurshukla Date: Fri, 23 Sep 2016 12:50:42 -0700 Subject: [PATCH 083/115] added Nuage Network to partner section --- community.html | 1 + images/community_logos/nuage_network_logo.png | Bin 0 -> 13045 bytes 2 files changed, 1 insertion(+) create mode 100644 images/community_logos/nuage_network_logo.png diff --git a/community.html b/community.html index 377cd85e1d..f47bff33e7 100644 --- a/community.html +++ b/community.html @@ -75,6 +75,7 @@ title: Community + diff --git a/images/community_logos/nuage_network_logo.png b/images/community_logos/nuage_network_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..72da8352cb7864a342b0327b1f5ef14178dfb16a GIT binary patch literal 13045 zcmb_@4p!vg?oM%QafjlR0&jnFXWoC{-VdA2 z=0i5w*<_x~vx!ktkwrlyL<9f;DDrYr8vpd#KM90~{nv8*c@qAo5M1T-JpceCtp5Z8 zkeiPW03fQ`NlL1z*}8mn@vwDqC6||!BzJXpv9@!x0swqA3p8!CG|zB_pLZW56r+RF z6efzz8x5_=@d8+#VG)CEURcK zfUOXqeqJY58lcAxz_wN#5df^S0NCYqt>pks9e{y3bfgvlJTib?JvxE`0PPPjouH!f z0fgrOux0LafxnqR=qHT-B9+qu1XBx0hZw@MxWVb_vXauz$>T9$^O`}L<%+Qm`Q{LC zhH#_(yq^I8ic@g@?e_lNXATuKH^-aUj{1e=ydU)8yiQ5hwBO>5{70|x`7`y zLth4T-yL6rfPbGKfA;NDhj1E)$U?vT9GZDhsvw?EMF=i8MBW^% z$B2EPj_H;tl^cK0SwR^ik;*Viv-D}XzsLLrC9=l@XtEc9@K0f>HnxCzQlvxI`#P}y z3;^79yA1xIhldKb4f{3k{dpt$E?Z0k2)33_bprrQq^Mc7rdmbE;Q;`t;t<9raiWJo zeC7dI;z5}0L8QN?yx|hmBSRAC5{Q<;#O|gH^`R2K14^ER;~D*whQBR z1mB#KBT7$>nQ9d?35yNgKU#8xj~X*Zl9LXc3@P7SuC;`@B(vnKL3PGllgBMbNR>9Z zY3a}cCy>re&NLBmSa3Le$aP3`NO5O~SYR&ZR{o;7Pp>g$uRw5we#CtQYn9C@u3eU^ zu~S{5g~5|#Akk3LuFE`n3yVCxcWaYe9Eu z`b_pT>lEt28yO`MCu}_0hMph~9}eG!z#G3YTd9&@IgVgli=B_-BKsrL^BX1qs^sxP=oLzvrfCVKQvRu8m`O87i7&(#!L8}ilg#$`mq-O}v2yOH1Mt~P% zclJ9;cbsr-O^JXcmjah=tHyo0wJ6*{w%beoR~3X4`l_t^px9mP8-{%bqDpQhFo%_q zLv3bOre2*~oqC<@MK3Sts;Z!}SGrsOEd*73T!GGrPSz%A4yNElb3=2d3b6`TSy=E9 z#9Hf6K~&N$<=yXGb)8+)q*3)uSx39&9TzHS8Ah96oTA z$IS&u!ZyD3TV2w4SWL3QEW<48S9l6|5m>e&lOTf@Z#QOiKz-me<}_AD3rkButEhag ze4VSI46bCT6jBmW8lRn+EuCG>;mH%`SmQj&JIPzi+v_kj@G)R+uWs+Ol5aUQsMNo1 z?{SVW5YVsC(>5?}m1!twpjqv1=&r)30;{B{)D^DU3^)C5pKPz`AZR*Thus3TJGBRz z*_h+mbc}+AuhV+d0=ohe-i6^%qBcA*?>L5?xW*k6ho(3vqV_)h{kp%dJh%8KDrtI@>_Z=$ZO3T zx~kr4yym^OyN=o}n&B>DDAecjSQws={HcDlD2h~+!S1kEAEYX&8e-FSLd9mmmZICR z*3?nqUHfcygD3JN;$CzhascGp<=oZ(GQ&5}G0`!tI_y&TC1OwV8`Y=fr{CuypemRK z!UifPL_EY0^6kYhfTBN9RB+4csb%9zJiZt#jw7BF+7Nm)*g#=Bahcpe@qCg!mojIE z8le_+y1D>oc5D_m9E4045fz~uDVpdStw*@Xk;UV^xGm|iC-p}vQ))NQhC@}Lkwt-r zQKXjD9=OTZ#oZ-3#%irUv!Yj^C-108EWpYL;&pcH+xvTUAGKewk96RVm(4a|?CM)G zH}nuug(tyBNJLX~amXawo^A z?3a3((!=9RJ<3(Vd;|`st4Z!rLQ&eu6D-8d^&)rT6c+5|2un>#c9W>3P)=*NIk!2s z_L{D@ifH*5b&l&`Bh7%DbZAYkhtX$2Y?r7!)iR)8V}xt5vC_5fpN*Lk$gC@5n!TE7 zo!Uy~%fBi5yuuv9{FT~X5vi!lLZWxvTW>GW0(A4;LOj5MVT#m&tp|3-wlg}dsMcNS zW`TlwY5kNPLQDpyLI>L*94?Tw5sxAQFSggNj8*m6^!M7#{zMiKiQvSW)e)aeyy~UO_ zOTX0})-DMy>j!rBSXE8V%?gQXm1{j{{n6sRUfO9hTYGU{ye9JRdE&lY*)r^TeixbS z+tP;6R$j4Qv3iq#Ykd|4#nhg?WWG5WH>fzdU5!I6LA}FKp|-Dqf2@!!32SL2tukH6 zqK=dGeH7eyv!L*zXeZ>4?Nhl*`5vAs`y%5teSJZf>LC7pL>D=fID&W!3TS{O(*3 z*vJ8V?bqApZ~c5mRLD2C^U&-28~1Z{rBFb4r}y5^<$3h^aSwMV$er$eZn}HJo9?=y zN44k6gV>e$hU8Avim2ho_WI5CH~Rta;`_yI*=N{@u=$Ua$0RgKn53Mf=}45wi$Z=8 z0fBu{_xH2ERg&|T^R$I{AEh7DAUs^QpqG`4wYkOY#geSMth9cofQt9?feV7ht+Amo z(!NO_E)J6iowut&?`?0Ao3cGL)x!YtZ}gwGug#B|3srAv1ZioX&`{a;e=WFJw*KKw zatk>PWdOjB1^@^S0{~t>|LHRTz>^&SI5!0V1hWAEJeSljqcQ*hJ-NJ;xR%f6Wr6QD ziFC$ue^u9;$g_ScaAR^xWvDMEI5e1_vTT4q_Vg!zX*F`RAnN&yP-A1+0cT=pbnI62 z)+v2mF*9Wxv&6cD7iNp_Mq%KW>#J+Q8!}@)FnD(a8uO0&$IboOd~ZjWv!|!``+2^g z=XrWHBPl6qH`$mdBpRA3>;K6A@BBCLzcG>miGSJF#z&h<`RpIIX0I(s4Q{Hdvn51y z#qnX1a0cUgw}_@*mfen9BPPYmQW`3BqrY$iY64oWcP_{fZBV|{HRlr^>VuEvJtlj< zpxK1;{Dq7Tz5$1=8(8zMdYrz<)Q6UGA5)%}CQpe;rf>kkHEDQVZ_)8J?yBrhj~t#+ zRkoK)fHK$Zp^YCXM@`myNG9A*XdS-pSI-OarmwA=6cIxfvvRC3X0)!U(>xo2g@=hX z*WSXewQnEfV)+Kv2{k8e%e3f(VW~U;b*6#PY;0hY1n6bGiK1l)*w~~5x_UE`)4!KJ z-xbQ`EKkCu4)x^e0bv6cD((%@4OUO1Q-;gG?+WXX%2j6^=uiYp|r`ORbfN$ zjy~nrI#_270DH6ZF5=e_qXqFzKCL023uQ{MZ{`lLm){wfc1)m5!>>1@g4I(L(&hEg#tEm;j*)%Ilr$Ig@VcDO53SJStmax$3>Z>Lvk?q`9{{e0S7I}{oT6}v#0 zC0|Iz-i3HExoJ&5%`YxtM4%4g^_XEX9mqzfY`EGML>ilmrSF~E{E7(eTAP#gwqTF< z0BL$}$;!c{uL%ZSfVc(5lATOqodv05sG`|Zo6JfE>eV3QWP)Pj+*lHiaI2X!4*P=8 zv*we{8QaZhv+r{rPMYHq0}~;=---KE7$8c%_@P4-~y63g(XZBbY5BKhXe9a@V+-c7YSwrnXl+BP3<( zq!}xne3e#*(K$vS9pr#4n%E#bX)b!M1s*Te!_6%PYgq{3*fuu@(6qPf*S|vt8^nqa z?O@M<4Y+m9u~~9&N*^GKsPkNdkeT@G2Z`&X?-!Mjexlh8wXAQV#kSqYXC#iCRO%|CA}k`ue!{?yE&mZ^Q(YGAtl+SKGot%9N9(h*!a(#RS7U z!G}>gVv1>*tDiwoYWYb4%7pPrMr=bD@tI7mpoSpy>^%Au!|-RPcm?<2dkC0Xn_DoD z7!9<{7POnkEC2H(IJNKt-j1VN6z$)cOrS^I6ib9sGQCP38Inu=7$WrV&_wDE)obRs zS<5yEF?Y=1S6EfBJb{#1d5}gpHGR=$nM%N~$5rY+T-G{2e1r~{^2%0Q9K7XCI1&e7 zF2_LBsIq3}uSU~k_Rz!*)9CPPan|swX;$UCGIOs==Dv6zPx8cSjUfJjNQt#)MSV*$ z04~eKoav||#8WrC!(1D5^r7RQ!D_L%-G@?wc}W(eqA-}x$o+=S(;Xr8Ff9(kbd*j1 zV0lDhmT}-_5az9#e3!3aIHMSqE4RCofO_A{*G!gcZHdD?nZG3erY&29OG7@e`c;&e7;rAuQicg>;!j_=TzgyR)s+}}ZcNIq(Y>~vY~ir|)9 zu@tqp5dRQ%giFj|cAhxwkKha~4U+T;gPLaVlnJSt=6jA<+!;Y~rfySSI2rafVDN&> z1Z)}}XTYU?YHMpVCo{@qqrGSkV|v%a zmENTMTpz!k?}4N;ku@=GiZF_rhR3%Zis6fy`on|~&a`|lYDIe&vMzsvG^r;@a%9c> znU*j<;g0=*Rji>O#AT&+_;4M(B0fLGX63H07&nWhms5q>pZoqOu9B5Yd%zY~CiaNPfXe*ByEXG1N1O*0arYP`SSsqS)O2BAMNcJwwcGO7L= znHGZFj6Q< zs9>Yb6Ioji`H4~ljraogy&obG5cJb8+(BcJ#?JIpAM%Y>N@iqTh?^G$`;l%A?l&sY zv}8=13wGU_kjKFuEyKl7`nQ$zHN~k~t;Z+sCQX_qzLd5@Hi&tc8ei4q+&b;_f!uML zB_8vugy=*V(y`M(18y7p#Q@QZsn?5viAef+yi(wJZm_ahVqTjq>W|>hRi%C7sJrin zmqIi)q8SNW{5evBZMJW^2@++rk6REe!^_EUfEqFK;%i>qp%lA2Y-!P%iZfiS!U=7gHLK z0ZLe*Ss}yK@Ze4B19a*G(3q%7HImgdB?5^uqty(l)gV*4rPkr;DZe2i;}7?nW`~y0 zv7<*jqNgAQlcVd0LO49Y={#cKC^sykj47Dc_ZUV9wzUYL4<5b;;gWSE9FQz-gY z?kM;4I);e2y;h6WQ5x-t=T9oPIb(dDZ#s+0E;TT( zfeklKKl#m!(*WL!Ox%mR9Hsm6OScBxyLwdJYX{F+SbvD++QIj&;Kop z0sS@AANPw5n=;ccOB+*T?8A%aPHmkZd-u$klCSBlfUfyHz-$Xb}o2mN+EHr zc}Vo(Kv;MU5BucYRxNIn`fyA;laW3cb#_kX5==q?c6RqnqLFQUXmsd&(3Bl!6Dxf9 zf?OH?-0WR;6?-!5Q?=HmzKS~!KGT)B{VpXVig`7HRP^0UYIMD$SuB9?9#)xOgM}nF zRLUz~Z*FSll9}V*v|N1L?wM3;{4v;+Z!+oyAt{fbT}{ZzbCm5qJ`=HE_EHAEXP0ff z+^asWn4T8)fgPwkaFZS3yZ`v`R~U9yZDVJaG}w*Hu5RPVp{E;dWPf)nR-XDifT$2rrOn0 zbM?wNvkYyTgfmP%wCb@3L+$!S9D975gg#qoiWCaw3v|eM#~;`lE3-15Vb)B_k=!_P zmISeb6P(KbCMDZ`mpIw=fp`?3VCf~Yi-~%U;q6w92T#GZkQMl_+wiKGzGM`c@&?N{ zY{n?32p`>Yq}IX$LU_(hXw}Fk>JmqV{+qjzps~CM#j=flh?|t#01m@1PZ-o+dJnUMcF@@37KyqCT*a zZc4G3hH*WdnzPFxf(cgi`CQ*wKS7?pm^ld1hmIHd-L&3hw?E1mQd^bvVk$(8S8jK4 zsoKtn>%+yxTr8q?xPSRNAwpIH^rj;Z68WHJEoOfFSfUpY!dzPc5f})vq)yC1#Iwlx zUu|3!@Kk+In8%rcjyE7d&>?$WK8v|Ru)(lZiK`UNUF$D-Ldqj-v#o@bOE4C7e?A=C z$FitYOlY9W2(?Sp%Ez}Ofq2z?v$rc&{}abF`Q z0OE$+G(~8R7k0$8jDwjo(l8!^YKC*jLq-of+K6J~QRI3`U#yrb0h55~x%*x74oN=!xMb6nLA{8_DkU7=N?0HQ`*ToJk1pcpw%MX3q zaPQ0O6C%Qm;|T&YBi3;iCnEm)8aUrstmoF^e(xgty0`p;>!m>vlea@C=zo}L<-X3s zWIE+h`GNL#;q}T`N(2l^qki%Nyyv{C@j9m&vP3XD20C^a=PC>i$$^N&^oQ=j6k(l0 z@KSwF4sayGP_x?m(}8>%t5`pp2#1y&nlXMwX|`VbVygYnsL&0hGMkHo-&Lk%?Um5r zMB#ptyVI6yTuA(l6!H4#`C8?ONG{cB_e%oDU&{kRR>M2)(LnBiXOS};7wu;HY1lXL z&yDeyj~**HbQlolVd$Z_JZ?3jvksB&{b z1Wdk=g(>-zDL@*CHHc^{J9J10QH1a+_znD6^zuqgv=!kki6Ch6wM4TA$BE zik`NH_hpKZA`DlF+;#djOQJZf7OzNQm4h_ym=a64@6o`0BnJ;7Zm8J$cE;_?of%|R zydl!Pigs=;PF`rZLKlOo+s8UfN$av+c7VO;K_bBrE(}L9Zg{597}hgfw0b=bVJ;Re z39*YY35#hr6mKgba48aF)6j}lt2%waItL9wq>)OL}0;np{b9jjS$A&zi z;&e{IE8Cgss%!v{ZInA^fV3!=FaQH~(YkKi<*8i0j`uL!8Dz*Sg)IjVS*O_?HglHH z@7rqpcj1ykg#2IEx7~B5zs*cjX_rV<$UbyF^1UK&a^nvltfbGi$z71CR__WURPVMD zl`k9D8*vp)I-FrdH#=deh6oO5-5+Np`K@MrFw^(1jru6b1^nSzyBhErpdr2?CV-i_ z-4nIbB4zq$Qk>GoKA^NmCX6x98fo^qIsOq3|FW-%8TqA&u?pfstWTLSEqEScJ-sn{ zDr~@TvS$(EgRjY&T<$d=gD_YY<&JA|BaNo1$g|;vAU(r?n{2sMAXQ9A?$B>?<4jNF zf^>{8WDm*(_G2UCT}T$Bn${3$(%Af}a~)3lmA(8{jZ5l@2BTi8zJ&W|N&3It%wEo~ z-PGDIw0dOA&JR-k}kb(o!U zOVR5>8N;qy_XsF7yo-n6A>oHvse^GSW;4&0PwtRY8=RP9iCW>Qucw3GE>eVGm9dircR*XBwCFSD{w<>KF*dMhZHKg)85e+-Y zNI94mPrXJrl8Z=A?OSgUm)`LbD{U(!YUW7dSmd^y@rWW}(+=2pQ=^6<-j*rx_G47l zdIsMHW$Ls3@1i;4!O0kNJbA{U0s68@tUFOdj*+A%Mex_F;`WHK$=60;`LjNsedWSg%b{Jf`VtZ z7XIHGf^|^85^IDT_rOH+~&ppva3zs!@_+W2WW01BR+Eu z7_pz7uWuWNazLM>Tfe{XQdk|3$|!O%8E50`aP_visB^wK)^&QQit5_(t?n*p9ar6- zjv}3PORzZG8^&5hEU(p^kbn+ex+L~i)tZ(!&vC@5{|CnXxP!F|7+@iX9m|M8kYj3f zGNXjT^3p{0iz=L|aq=M(7yup1d}y(1S&K(kQ^>}FL?fEAQPbSJ>j+iXn>s0&hr`;? zx9&~;iyFAsp+VW-NnEIYG(cg4;MZ$^2h#y)=CLKEfjja%DN^h-Cw|g$YZ@`a^&`l8 zZEg&vFc68T9Ijy#cTIOm{Uz%2E1gZJtr?oY79oZ^CA2xb^r^i0ZimlDU9MiC5o)0P zP{wp&MRjJR4gswPZ-=B+B_5v8Y7C& zAks=F=gDS1o&BPl{%+`Rgj5$d5)2dBPn z+kc_Dlm5xIdTO9DzQN8tg|=7Wq7pwj`o;hnRV68JLAPEY6O-* zh7g9x$@!%-;R#QBXExlUjHWp}|9t&0*=;?Q?`!>#7U87g`jv!0CF2+?9W#=QCpibL zr!AOD31v6*P@ULEy)`|cC+V_`&V=eH{S~R19O=a!PR-rW7Dhy&edYio>&c;o=C7N6 z-xXGLMTO# z!jJp@hBUs{ z7Ce%?t)fbl)e8H&_j3B|LA1Vpl+Z1T^cBH)teMwS$m7(pB^c=k#02+nkPl^<7)>?u z)!V3-B!xOF4pE)wbzTN(QHt7ar5ifHR|!Rmz&}iY-5zKd#~RlOb(8E zYXucCZ(C+kzEB1f-O(ADJVr>{6$~nVk;T+H@$hJRY4eOBSB5}dt~`|DpaJQn{Rt5Z zlTUG7pv(CD^WohgVQ=*`0d3OcB3F8{LB%(ItJM)gR#6+o@p(J)EWFSYqKO93$=EC# zXMacBC{*C3Y`Q)9)^U46!^QLyl6y&Q+41cNiy;-eBFH= z(S|JxiQhleFaK3VsRzKiQtBtCf5M`|u)3aHLy^`_eB<2^8O42}F@!Quf!w_kOv0OZ zVrMNO@F8+#-}tJIr#~9DL{d;jsj2?cdY*z4v*t)IZdYI*Zq(BF1#iPR1Xg)pnvT19GV2{yUZBW495;>hiZLqk>F# zQBAS4l({!-M!bC!3C>4%6fBX^71*<1k(K7!kcL_D-GPa4Ue?GDG60jG(8ozX>h~9% zSH;IyvMg`L+o0!9(ae;NNjm_CYipWO6xf5z)2gSp^m4xYA&Aax`geVr9*x9D+_Zn1 z|M7Tc#ZF&=U>((2^FR%#)prMV;*lfEOH$f5s_W@Cn#l&JKM~FpvK35FX!H+A9)X%k zew8aQyk};KgO=jDr+TwFEb}6>;CqT4iT@0@a0a0gUzZ#N;F{&}csf*=Xrq zgQBRmVyr$HQp$5{0z@`IjLSPW2+rI0vy3`zdB&UFQ%iSN<;>%ZvfCZ0PCWqEo;2qo zuku$l{g3+s!B?zj|3ZJ(m3F81FVDUT8U8)Kbi0a07joY&wQl-ZTB$SD3@+Tu`D}ZD z>9TwTZsXGh$|y#v-dh3S z!x&@@#Q%}^_hd$mPE*le4yFWM>52wPR8W9Z1d?+eOP4BZwvBG{mCFPu<~E%W_!lBs zx(ppvl&S(=V{IRDKkeyA4z7S%vfFKqo(EeQpkbf60wQfD{#g-;fMHMs%<>ib#oIuF zil@LPPgB{H-yi$WwAd5Nc1F2Ix2K78tIzz#((3N~@p3<}W>ouq6^*<5r?n zL!|%CNsX2Lx-kd}JiAg=zS%peZ|BdrE8h}F@-+9o^};C1tC#ArUwd--dMvHTwctkG z`SK4})uzcQ&DwR?rNoU7`|b1f88GC_}p$zBP$b!;0;!g~_ z`%7#8-}7>EeyY$PEOXD}oz5LbwVghGQXAjgd*~NKeaS`$L; z7t(E||FY-9rPqfkV_b%m)%9iBb3ZxGsMz_rBx02E?ARhud4{t(6lBvgq08`zth*Zh z<|2UVv82;s5#2dn;IA2>)3hz0am-lxa_=={;NvXqSHlueJ!J6mj#%d~xv&HU{H6SR zi*60Y3gw}+C5o?X#^_@_R_5XI3;BStmHqVmr^K#v6=H_p=X_>OK*fEMbCi)LNlm-% zlOzu2oqbl2V+O2lE-Zho#GT0H5}uH@SKnLj(kw*A!Dpuj%Ura&W=S)1qq!Ax0-546 zT$XOl7BgMSihTT=@i?#2afo`NqH$lxb+D1H)|ryqP032l8;wiu=kzLg9?p3DwYWP- z$Tjvkc27j%AL0I3Q$7VeAv}pi%=iiUQ?wvQ=wfuVfrZyS|mNJ#1xTlhf(_?O;BW0SEq9%pvVjNB>1si!R)yV=fZT6J=L7)sPemv zb>8wPoXV0`mv)2KK^F;2n#nK0*hieR9hF++>vM4GjKhIf6={(?uAJwDaz?;bThXEg zI=)pLO;`(To>n}8#G1c;`_4c^xZv|%Dgqy)gIvZd)mmCo=LP*)tpe&L_lPx-b|BHW3+1PgwjDfc5kb zuH4-oZpPhC{}ujM+yeZsz$NQszbIjRddL=8%>&agYw9!loD`W2CM`H^vIm0vURJTX zkN1p{^K(SQG|z1yZ!&ZJ4Z$oaP{Z9=?s%~&*fDVKdK>F2W{&sh;PvxaqT>pCiW7;N zCMTP(Dsxhxjynqf4?VI#5@td{xwGQW({(cINOA^`RA3|9(dsp3-L9Rz6 zlf#xwDWX@@nuEe&OcRjZ-@%`wmbA|s*PG9+Jg`4sRnB1so_)?7z5{y>{iM~Q{t9jU zsX-!<7m++RB1~cF=$yp3dbgbGAfq+(_$rhGb<%5Dc#);W;4hNHb(Tk>A8Fi|?wE3b z&G~JRleeXCgdAv^ow4UJ5cUG<>yn(n}HMy_K47Zx>`^B4o z(w%H$DTU(P*1dS#%7}_GD50etAA{zdsxAp-^S6T0IysEl z40W64++`9ciH^mKQygbdw-gnRJVZAyC03^*;JW=!8pmiy?6dD=iX5`v@OJ(v<>Y zKU-$hc%3B6!|m%0sxSgR*?cpn1=p8CmkyG literal 0 HcmV?d00001 From 6e7ca595dab8a4083db37e7ad426270bd3a609ef Mon Sep 17 00:00:00 2001 From: Janet Kuo Date: Fri, 23 Sep 2016 14:10:16 -0700 Subject: [PATCH 084/115] Fix Travis CI build failure --- test/examples_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test/examples_test.go b/test/examples_test.go index a2485ac0c2..4f5112c1ce 100644 --- a/test/examples_test.go +++ b/test/examples_test.go @@ -32,7 +32,7 @@ import ( "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/registry/batch/job" "k8s.io/kubernetes/pkg/runtime" "k8s.io/kubernetes/pkg/types" "k8s.io/kubernetes/pkg/util/validation/field" From d376fc98addaca1dba794b6ee619e14d9a9cd14a Mon Sep 17 00:00:00 2001 From: nikhiljindal Date: Thu, 22 Sep 2016 17:39:44 -0700 Subject: [PATCH 085/115] Adding user guides for federation replicasets and namespaces --- docs/user-guide/federation/index.md | 6 +- docs/user-guide/federation/replicasets.md | 105 ++++++++++++++++++++++ docs/user-guide/federation/secrets.md | 87 ++++++++++++++++++ 3 files changed, 196 insertions(+), 2 deletions(-) create mode 100644 docs/user-guide/federation/replicasets.md create mode 100644 docs/user-guide/federation/secrets.md diff --git a/docs/user-guide/federation/index.md b/docs/user-guide/federation/index.md index 97ed5bdc8d..2dfd369c22 100644 --- a/docs/user-guide/federation/index.md +++ b/docs/user-guide/federation/index.md @@ -34,11 +34,13 @@ and cloud providers. Once we have the control plane setup, we can start creating federation API resources. -Following guides explain some of the resources in detail: +The following guides explain some of the resources in detail: -* [Services](/docs/user-guide/federation/federated-services/) * [Events](/docs/user-guide/federation/events/) * [Namespaces](/docs/user-guide/federation/namespaces/) +* [ReplicaSets](/docs/user-guide/federation/replicasets/) +* [Secrets](/docs/user-guide/federation/secrets/) +* [Services](/docs/user-guide/federation/federated-services/) [API reference docs](/federation/docs/api-reference/readme/) lists all the diff --git a/docs/user-guide/federation/replicasets.md b/docs/user-guide/federation/replicasets.md new file mode 100644 index 0000000000..55e0d56dc4 --- /dev/null +++ b/docs/user-guide/federation/replicasets.md @@ -0,0 +1,105 @@ +--- +--- + +This guide explains how to use replica sets in the Federation control plane. + + +* 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 [ReplicaSets](/docs/user-guide/replicasets/) in particular. + +## Overview + +Replica Sets in federation control plane (referred to as "federated replica sets" in +this guide) are very similar to the traditional [Kubernetes +ReplicaSets](/docs/user-guide/replicasets/), and provide the same functionality. +Creating them in the federation control plane ensures that the desired number of +replicas exist across the registered clusters. + + +## Creating a Federated Replica Set + +The API for Federated Replica Set is 100% compatible with the +API for traditional Kubernetes Replica Set. You can create a replica set by sending +a request to the federation apiserver. + +You can do that using [kubectl](/docs/user-guide/kubectl/kubectl/) by running: + +``` shell +kubectl --context=federation-cluster create -f myrs.yaml +``` + +The '--context=federation-cluster' flag tells kubectl to submit the +request to the Federation apiserver instead of sending it to a kubernetes +cluster. + +Once a federated replica set is created, the federation control plane will create +a replica set in all underlying kubernetes clusters. +You can verify this by checking each of the underlying clusters, for example: + +``` shell +kubectl --context=gce-asia-east1a get rs myrs +``` + +The above assumes that you have a context named 'gce-asia-east1a' +configured in your client for your cluster in that zone. + +These replica sets in underlying clusters will match the federation replica set +except in the number of replicas. Federation control plane will ensure that the +sum of replicas in each cluster match the desired number of replicas in the +federation replica set. + +### Spreading Replicas in Underlying Clusters + +By default, replicas are spread equally in all the underlying clusters. For ex: +if you have 3 registered clusters and you create a federated replica set with +`spec.replicas = 9`, then each replica set in the 3 clusters will have +`spec.replicas=3`. +To modify the number of replicas in each cluster, you can specify +[FederatedReplicaSetPreference](https://github.com/kubernetes/kubernetes/blob/{{page.githubbranch}}/federation/apis/federation/types.go) +as an annotation with key `federation.kubernetes.io/replica-set-preferences` +on federated replica set. + + +## Updating a Federated Replica Set + +You can update a federated replica set as you would update a Kubernetes +replica set; however, for a federated replica set, you must send the request to +the federation apiserver instead of sending it to a specific Kubernetes cluster. +The Federation control plan ensures that whenever the federated replica set is +updated, it updates the corresponding replica sets in all underlying clusters to +match it. +If your update includes a change in number of replicas, the federation +control plane will change the number of replicas in underlying clusters to +ensure that their sum remains equal to the number of desired replicas in +federated replica set. + +## Deleting a Federated Replica Set + +You can delete a federated replica set as you would delete a Kubernetes +replica set; however, for a federated replica set, you must send the request to +the federation apiserver instead of sending it to a specific Kubernetes cluster. + +For example, you can do that using kubectl by running: + +```shell +kubectl --context=federation-cluster delete rs myrs +``` + +Note that at this point, deleting a federated replica set will not delete the +corresponding replica sets from underlying clusters. +You must delete the underlying Replica Sets manually. +We intend to fix this in the future. diff --git a/docs/user-guide/federation/secrets.md b/docs/user-guide/federation/secrets.md new file mode 100644 index 0000000000..ed12311a8d --- /dev/null +++ b/docs/user-guide/federation/secrets.md @@ -0,0 +1,87 @@ +--- +--- + +This guide explains how to use secrets in Federation control plane. + + +* 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 [Secrets](/docs/user-guide/secrets/) in particular. + +## Overview + +Secrets in federation control plane (referred to as "federated secrets" in +this guide) are very similar to the traditional [Kubernetes +Secrets](/docs/user-guide/secrets/) providing the same functionality. +Creating them in the federation control plane ensures that they are synchronized +across all the clusters in federation. + + +## Creating a Federated Secret + +The API for Federated Secret is 100% compatible with the +API for traditional Kubernetes Secret. You can create a secret by sending +a request to the federation apiserver. + +You can do that using [kubectl](/docs/user-guide/kubectl/kubectl/) by running: + +``` shell +kubectl --context=federation-cluster create -f mysecret.yaml +``` + +The '--context=federation-cluster' flag tells kubectl to submit the +request to the Federation apiserver instead of sending it to a kubernetes +cluster. + +Once a federated secret is created, the federation control plane will create +a matching secret in all underlying kubernetes clusters. +You can verify this by checking each of the underlying clusters, for example: + +``` shell +kubectl --context=gce-asia-east1a get rs myrs +``` + +The above assumes that you have a context named 'gce-asia-east1a' +configured in your client for your cluster in that zone. + +These secrets in underlying clusters will match the federated secret. + + +## Updating a Federated Secret + +You can update a federated secret as you would update a Kubernetes +secret; however, for a federated secret, you must send the request to +the federation apiserver instead of sending it to a specific Kubernetes cluster. +The Federation control plan ensures that whenever the federated secret is +updated, it updates the corresponding secrets in all underlying clusters to +match it. + +## Deleting a Federated Secret + +You can delete a federated secret as you would delete a Kubernetes +secret; however, for a federated secret, you must send the request to +the federation apiserver instead of sending it to a specific Kubernetes cluster. + +For example, you can do that using kubectl by running: + +```shell +kubectl --context=federation-cluster delete rs myrs +``` + +Note that at this point, deleting a federated secret will not delete the +corresponding secrets from underlying clusters. +You must delete the underlying secrets manually. +We intend to fix this in the future. From b28c58a93c2416b1a767df14bc2ad83787c04180 Mon Sep 17 00:00:00 2001 From: Quinton Hoole Date: Mon, 19 Sep 2016 22:16:40 -0700 Subject: [PATCH 086/115] Federated Ingress User Guide --- .../federation/federated-ingress.md | 267 ++++++++++++++++++ 1 file changed, 267 insertions(+) create mode 100644 docs/user-guide/federation/federated-ingress.md diff --git a/docs/user-guide/federation/federated-ingress.md b/docs/user-guide/federation/federated-ingress.md new file mode 100644 index 0000000000..42e5ad536d --- /dev/null +++ b/docs/user-guide/federation/federated-ingress.md @@ -0,0 +1,267 @@ +--- +--- + +This guide explains how to use Kubernetes Federated Ingress to deploy +a common HTTP(S) virtual IP load balancer across a federated service running in +multiple Kubernetes clusters. As of v1.4, clusters hosted in Google +Cloud (both GKE and GCE, or both) are supported. This makes it +easy to deploy a service that reliably serves HTTP(S) traffic +originating from web clients around the globe on a single, static IP +address. Low +network latency, high fault tolerance and easy administration are +ensured through intelligent request routing and automatic replica +relocation (using [Federated ReplicaSets](docs/user-guide/federation/federated-replicaset.md)). +Clients are automatically routed, via the shortest network path, to +the cluster closest to them with available capacity (despite the fact +that all clients use exactly the same static IP address). The load balancer +automatically checks the health of the pods comprising the service, +and avoids sending requests to unresponsive or slow pods (or entire +unresponsive clusters). + +Federated Ingress is released as a beta feature, and supports Google Cloud (GKE, +GCE and hybrid scenarios involving both) in Kubernetes v1.4. Work is under way to support other cloud +providers such as AWS, and other hybrid cloud scenarios (e.g. services +spanning private on-premise as well as public cloud Kubernetes +clusters). We welcome your feedback. + +* 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 [Ingress](/docs/user-guide/ingress/) in particular. + +## Overview + +Federated Ingresses are created in much that same way as traditional +[Kubernetes Ingresses](/docs/user-guide/ingress/): by making an API +call which specifies the desired properties of your logical ingress point. In the +case of Federated Ingress, this API call is directed to the +Federation API endpoint, rather than a Kubernetes cluster API +endpoint. The API for Federated Ingress is 100% compatible with the +API for traditional Kubernetes Services. + +Once created, the Federated Ingress automatically: + +1. creates matching Kubernetes Ingress objects in every cluster +underlying your Cluster Federation, +2. ensures that all of these in-cluster ingress objects share the same + logical global L7 (i.e. HTTP(S)) load balancer and IP address. +3. monitors the health and capacity of the service "shards" (i.e. your + pods) behind this ingress in each cluster +4. ensures that all client connections are routed to an appropriate +healthy backend service endpoint at all times, even in the event of +pod, cluster, +availability zone or regional outages. + +Note that in the + case of Google Cloud, the logical L7 load balancer is not a single physical device (which + would present both a single point of failure, and a single global + network routing choke point), but rather a [truly global, highly available + load balancing managed service](https://cloud.google.com/load-balancing/), + globally reachable via a single, static IP address. + +Clients inside your federated Kubernetes clusters (i.e. Pods) will be +automatically routed to the cluster-local shard of the Federated Service +backing the Ingress in their +cluster if it exists and is healthy, or the closest healthy shard in a +different cluster if it does not. Note that this involves a network +trip to the HTTP(s) load balancer, which resides outside your local +Kubernetes cluster but inside the same GCP region. + +## Creating a federated ingress + +You can create a federated ingress in any of the usual ways, for example using kubectl: + +``` shell +kubectl --context=federation-cluster create -f myingress.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. TODO: Update links + +As described above, the Federated Ingress will automatically create +and maintain matching Kubernetes ingresses in all of the clusters +underlying your federation. These cluster-specific ingresses (and +their associated ingress controllers) configure and manage the load +balancing and health checking infrastructure that ensures that traffic +is load balanced to each cluster appropriately. + +You can verify this by checking in each of the underlying clusters, for example: + +``` shell +kubectl --context=gce-asia-east1a get ingress myingress +NAME HOSTS ADDRESS PORTS AGE +myingress * 130.211.5.194 80, 443 1m +``` + +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 ingress will automatically match those of +the Federated Ingress that you created above (and if you happen to +have had ingresses 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 Ingress - either way, the end result will be the same). + +The status of your Federated Ingress will automatically reflect the +real-time status of the underlying Kubernetes ingresses, for example: + +``` shell +$kubectl --context=federation-cluster describe ingress myingress + +Name: myingress +Namespace: default +Address: 130.211.5.194 +TLS: + tls-secret terminates +Rules: + Host Path Backends + ---- ---- -------- + * * echoheaders-https:80 (10.152.1.3:8080,10.152.2.4:8080) +Annotations: + https-target-proxy: k8s-tps-default-myingress--ff1107f83ed600c0 + target-proxy: k8s-tp-default-myingress--ff1107f83ed600c0 + url-map: k8s-um-default-myingress--ff1107f83ed600c0 + backends: {"k8s-be-30301--ff1107f83ed600c0":"Unknown"} + forwarding-rule: k8s-fw-default-myingress--ff1107f83ed600c0 + https-forwarding-rule: k8s-fws-default-myingress--ff1107f83ed600c0 +Events: + FirstSeen LastSeen Count From SubobjectPath Type Reason Message + --------- -------- ----- ---- ------------- -------- ------ ------- + 3m 3m 1 {loadbalancer-controller } Normal ADD default/myingress + 2m 2m 1 {loadbalancer-controller } Normal CREATE ip: 130.211.5.194 +``` + +Note the address of your Federated Ingress +corresponds with the address of all of the +underlying Kubernetes ingresses (once these have been allocated - this +may take up to a few minutes). + +Note also that we have not yet provisioned any backend Pods to receive +the network traffic directed to this ingress (i.e. 'Service +Endpoints' behind the service backing the Ingress), so the Federated Ingress does not yet consider these to +be healthy shards and will not direct traffic to any of these clusters. + +## Adding backend services and pods + +To render the underlying ingress shards healthy, we need to add +backend Pods behind the service upon which the Ingress is based. There are several ways to achieve this, but +the easiest is to create a [Federated Service](federated-services.md) and +[Federated Replicaset](federated-replicasets.md). Details of how those +work are covered in the aforementioned user guides - here we'll simply use them, to +create appropriately labelled pods and services in the 13 underlying clusters of +our federation: + +``` shell +kubectl --context=federation-cluster create -f services/nginx.yaml +``` + +``` shell + kubectl --context=federation-cluster create -f myreplicaset.yaml +``` + +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 +``` + + +## 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). However, in Kubernetes v1.4, Federated Ingress is only +supported across Google Cloud clusters. In future versions we intend +to support hybrid cloud Ingress-based deployments. + +## Discovering a federated ingress + +Ingress objects (in both plain Kubernets clusters, and in federations +of clusters) expose one or more IP addresses (via +the Status.Loadbalancer.Ingress field) that remains static for the lifetime +of the Ingress object (in future, automatically managed DNS names +might also be added). All clients (whether internal to your cluster, +or on the external network or internet) should connect to one of these IP +or DNS addresses. As mentioned above, all client requests are automatically +routed, via the shortest network path, to a healthy pod in the +closest cluster to the origin of the request. So for example, HTTP(S) +requests from internet +users in Europe will be routed directly to the closest cluster in +Europe that has available capacity. If there are no such clusters in +Europe, the request will be routed to the next closest cluster +(typically in the U.S.). + +## Handling failures of backend pods and whole clusters + +Ingresses are backed by Services, which are typically (but not always) +backed by one or more ReplicaSets. For Federated Ingresses, it is +common practise to use the federated variants of Services and +ReplicaSets (see [Federated Services](federated-services.md) and +[Federated ReplicaSets](federated-replicasets.md)) for this purpose, as +described above. + +In particular, Federated ReplicaSets ensure that the desired number of +pods are kept running in each cluster, even in the event of node +failures. In the event of entire cluster or availability zone +failures, Federated ReplicaSets automatically place additional +replacas in the other available clusters in the federation to accommodate the +traffic which was previously being served by the now unavailable +cluster. While the Federated ReplicaSet ensures that sufficient replicas are +kept running, the Federated Ingress ensures that user traffic is +automatically redirected away from the failed cluster to other +available clusters. + +## 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 ingress/service/replicaset successfully against the cluster federation API, but no matching ingresses/services/replicasets 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 event 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 + ingresses/services/replicasets in the relevant namespace in the + clusters. Again you should see associated error messages providing + more detail in the above event log file if this is not the case. +4. Whether any other error is preventing the service creation + operation from succeeding (look for `ingress-controller`, + `service-controller` or `replicaset-controller`, + errors in the output of `kubectl logs federation-controller-manager --namespace federation`). + +#### This troubleshooting guide did not help me solve my problem + +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. From 4a85d6255ec09c6a0ada46ba366e7afbc4d9f54d Mon Sep 17 00:00:00 2001 From: David Oppenheimer Date: Sun, 25 Sep 2016 21:30:13 -0700 Subject: [PATCH 087/115] Clarify minAvailable approval semantics --- docs/admin/disruptions.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/admin/disruptions.md b/docs/admin/disruptions.md index 96157a5004..c6e2b7852a 100644 --- a/docs/admin/disruptions.md +++ b/docs/admin/disruptions.md @@ -18,10 +18,10 @@ principal examples today are draining a node for maintenance or upgrade (`kubectl drain`), and cluster autoscaling down. In the future the [rescheduler](https://github.com/kubernetes/kubernetes/blob/master/docs/proposals/rescheduling.md) may also perform voluntary evictions. By contrast, something like evicting pods -because a node has become unreachable or reports NotReady, is not "voluntary." +because a node has become unreachable or reports `NotReady`, is not "voluntary." For voluntary evictions, it can be useful for applications to be able to limit -the number of pods that are down. For example, a quorum-based application would +the number of pods that are down simultaneously. For example, a quorum-based application would like to ensure that the number of replicas running is never brought below the number needed for a quorum, even temporarily. Or a web front end might want to ensure that the number of replicas serving load never falls below a certain @@ -34,9 +34,11 @@ disruption budget to be violated. ## Specifying a PodDisruptionBudget -A `PodDisruptionBudget` has two components: a selector to specify the set of -pods, and a description of the minimum number of available pods for a disruption -to be allowed. The latter can be either an absolute number or a percentage. In +A `PodDisruptionBudget` has two components: a label selector `selector` to specify the set of +pods to which it applies, and `minAvailable` which is a description of the number of pods from that +set that must still be available after the eviction, i.e. even in the absence +of the evicted pod. `minAvailable` can be either an absolute number or a percentage. +So for example, 100% means no voluntary evictions from the set are permitted. In typical usage, a single budget would be used for a collection of pods managed by a controller—for example, the pods in a single ReplicaSet. @@ -79,7 +81,7 @@ The API can respond in one of three ways. 2. If the current state of affairs wouldn't allow an eviction by the rules set forth in the budget, you get back `429 Too Many Requests`. This is typically used for generic rate limiting of *any* requests, but here we mean - that this request isn't allowed *right now*, but it may be allowed later. + that this request isn't allowed *right now* but it may be allowed later. Currently, callers do not get any `Retry-After` advice, but they may in future versions. 3. If there is some kind of misconfiguration, like multiple budgets pointing at @@ -89,5 +91,5 @@ For a given eviction request, there are two cases. 1. There is no budget that matches this pod. In this case, the server always returns `200 OK`. - 2. There is at least one budget. In this case, any of the three responses may + 2. There is at least one budget. In this case, any of the three above responses may apply. From 10884384deaeef2936edaea4eb3d4f7a150e8d61 Mon Sep 17 00:00:00 2001 From: Luke Marsden Date: Fri, 23 Sep 2016 14:29:06 +0100 Subject: [PATCH 088/115] kubeadm and add-ons docs --- _data/guides.yml | 4 +- docs/admin/addons.md | 9 +- docs/{ => getting-started-guides}/kubeadm.md | 96 +++++++++++--------- docs/index.md | 4 +- CNAME => old.CNAME | 0 5 files changed, 60 insertions(+), 53 deletions(-) rename docs/{ => getting-started-guides}/kubeadm.md (69%) rename CNAME => old.CNAME (100%) diff --git a/_data/guides.yml b/_data/guides.yml index b956870e58..7c41285d0e 100644 --- a/_data/guides.yml +++ b/_data/guides.yml @@ -8,8 +8,8 @@ toc: section: - title: What is Kubernetes? path: /docs/whatisk8s/ - - title: Installing Kubernetes Easily on Linux - path: /docs/kubeadm/ + - title: Installing Kubernetes on Linux with kubeadm + path: /docs/getting-started-guides/kubeadm/ - title: Hello World on Google Container Engine path: /docs/hellonode/ - title: Downloading or Building Kubernetes diff --git a/docs/admin/addons.md b/docs/admin/addons.md index 4a3d1710f6..6e28edfaa2 100644 --- a/docs/admin/addons.md +++ b/docs/admin/addons.md @@ -3,19 +3,20 @@ ## Overview -Add-ons extend the functionality of Kubernetes in a pluggable way. +Add-ons extend the functionality of Kubernetes. This page lists some of the available add-ons and links to their respective installation instructions. ## Networking and Network Policy -* [Weave Net](https://github.com/weaveworks/weave-kube) is an easy, fast and reliable pod network that carries on working in the face of network partitions, does not depend on a database, and supports Kubernetes policy. -* [Calico](https://github.com/projectcalico/calico-containers/tree/master/docs/cni/kubernetes/manifests/kubeadm) is a simple, scalable, secure L3 networking and network policy provider. -* [Canal](https://github.com/tigera/canal/tree/master/k8s-install/kubeadm) unites Flannel and Calico, providing cloud native networking and network policy. +* [Weave Net](https://github.com/weaveworks/weave-kube) provides networking and network policy, will carry on working on both sides of a network partition, and does not require an external database. +* [Calico](https://github.com/projectcalico/calico-containers/tree/master/docs/cni/kubernetes/manifests/kubeadm) is a secure L3 networking and network policy provider. +* [Canal](https://github.com/tigera/canal/tree/master/k8s-install/kubeadm) unites Flannel and Calico, providing networking and network policy. ## Visualization & Control * [Weave Scope](https://www.weave.works/documentation/scope-latest-installing/#k8s) is a tool for graphically visualizing your containers, pods, services etc. Use it in conjunction with a [Weave Cloud account](https://cloud.weave.works/) or host the UI yourself. +* [Dashboard](https://github.com/kubernetes/dashboard#kubernetes-dashboard) is a dashboard web interface for Kubernetes. ## Legacy Add-ons diff --git a/docs/kubeadm.md b/docs/getting-started-guides/kubeadm.md similarity index 69% rename from docs/kubeadm.md rename to docs/getting-started-guides/kubeadm.md index c3f3836d8e..c30b732475 100644 --- a/docs/kubeadm.md +++ b/docs/getting-started-guides/kubeadm.md @@ -7,18 +7,19 @@ li>.highlighter-rouge {position:relative; top:3px;} ## Overview -This quickstart will show you how to easily install a secure Kubernetes cluster on machines running Ubuntu 16.04 or CentOS 7, using a tool called `kubeadm` which is part of Kubernetes. +This quickstart shows you how to easily install a secure Kubernetes cluster on machines running Ubuntu 16.04 or CentOS 7. +The installation uses a tool called `kubeadm` which is part of Kubernetes 1.4. -This process should work with local VMs, physical servers and/or cloud servers. -It is intended to be simple enough that you can easily integrate its use into your own automation (Terraform, Chef, Puppet, etc). +This process works with local VMs, physical servers and/or cloud servers. +It is simple enough that you can easily integrate its use into your own automation (Terraform, Chef, Puppet, etc). -**The `kubeadm` tool is currently in alpha but please try it out and give us [feedback](/docs/kubeadm/#feedback)!** +**The `kubeadm` tool is currently in alpha but please try it out and give us [feedback](/docs/getting-started-guides/kubeadm/#feedback)!** ## Prerequisites 1. One or more machines running Ubuntu 16.04 or CentOS 7 -1. 2GB or more of RAM per machine -1. A network connection with open ports between the machines (public or private network is fine) +1. 1GB or more of RAM per machine (any less will leave little room for your apps) +1. Full network connectivity between all machines in the cluster (public or private network is fine) ## Objectives @@ -30,7 +31,7 @@ It is intended to be simple enough that you can easily integrate its use into yo ### (1/4) Installing kubelet and kubeadm on your hosts -You will now install the following packages on all the machines: +You will install the following packages on all the machines: * `docker`: the container runtime, which Kubernetes depends on. * `kubelet`: the most core component of Kubernetes. @@ -44,22 +45,20 @@ For each host in turn: * SSH into the machine and become `root` if you are not already (for example, run `sudo su -`). * If the machine is running Ubuntu 16.04, run: - # apt-get install -y docker.io socat + # apt-get install -y docker.io socat apt-transport-https # curl -s -L \ - "https://www.dropbox.com/s/tso6dc7b94ch2sk/debs-5ab576.txz?dl=1" | tar xJv - # dpkg -i debian/bin/unstable/xenial/*.deb + https://storage.googleapis.com/kubeadm/kubernetes-xenial-preview-bundle.txz | tar xJv + # dpkg -i kubernetes-xenial-preview-bundle/*.deb If the machine is running CentOS 7, run: @@ -74,24 +73,16 @@ For each host in turn: # systemctl enable docker && systemctl start docker # systemctl enable kubelet && systemctl start kubelet -The kubelet will now be restarting every few seconds, as it waits in a crashloop for `kubeadm` to tell it what to do. - -Optionally, see also [more details on installing Docker](https://docs.docker.com/engine/installation/#/on-linux). +The kubelet is now restarting every few seconds, as it waits in a crashloop for `kubeadm` to tell it what to do. ### (2/4) Initializing your master The master is the machine where the "control plane" components run, including `etcd` (the cluster database) and the API server (which the `kubectl` CLI communicates with). -All of these components will run in pods started by `kubelet`. +All of these components run in pods started by `kubelet`. To initialize the master, pick one of the machines you previously installed `kubelet` and `kubeadm` on, and run: -* If you want to be able to schedule pods on the master, for example if you want a single-machine Kubernetes cluster for development, run: - - # kubeadm init --schedule-pods-here - -* If you do not want to be able to schedule pods on the master (perhaps for security reasons), run: - - # kubeadm init + # kubeadm init This will download and install the cluster database and "control plane" components. This may take several minutes. @@ -119,13 +110,20 @@ The output should look like: Make a record of the `kubeadm join` command that `kubeadm init` outputs. You will need this in a moment. -The key included here is secret, keep it safe — anyone with this key will be able to add authenticated nodes to your cluster. +The key included here is secret, keep it safe — anyone with this key can add authenticated nodes to your cluster. The key is used for mutual authentication between the master and the joining nodes. +By default, your cluster will not schedule pods on the master for security reasons. +If you want to be able to schedule pods on the master, for example if you want a single-machine Kubernetes cluster for development, run: + + # kubectl taint nodes --all dedicated- + +This will remove the "dedicated" taint from all nodes, including the master node, meaning that the scheduler will then be able to schedule pods everywhere. + ### (3/4) Joining your nodes -The nodes are where your workloads (containers and pods, etc) will run. +The nodes are where your workloads (containers and pods, etc) run. If you want to add any new machines as nodes to your cluster, for each machine: SSH to that machine, become root (e.g. `sudo su -`) and run the command that was output by `kubeadm init`. For example: @@ -154,31 +152,29 @@ Before you can deploy applications to it, you need to install a pod network. ### (4/4) Installing a pod network You must install a pod network add-on so that your pods can communicate with each other when they are on different hosts. +**It is necessary to do this before you try to deploy any applications to your cluster.** Several projects provide Kubernetes pod networks. You can see a complete list of available network add-ons on the [add-ons page](/docs/admin/addons/). -By way of example, you can install Weave Net by running on the master: +By way of example, you can install [Weave Net](https://github.com/weaveworks/weave-kube) by logging in to the master and running: # kubectl apply -f https://git.io/weave-kube daemonset "weave-net" created -**You should install a pod network on the master before you try to deploy any applications to your cluster.** - -Once a pod network command has installed, a few seconds later you should see the `kube-dns` pod go into `Running` in the output of `kubectl get pods --all-namespaces`. +If you prefer [Calico](https://github.com/projectcalico/calico-containers/tree/master/docs/cni/kubernetes/manifests/kubeadm) or [Canal](https://github.com/tigera/canal/tree/master/k8s-install/kubeadm), please refer to their respective installation guides. +You should only install one pod network per cluster. +Once a pod network has been installed, you can confirm that it is working by checking that the `kube-dns` pod is `Running` in the output of `kubectl get pods --all-namespaces`. **This signifies that your cluster is ready.** -You can learn more about other available pod networks on the [add-ons page](/docs/admin/addons/). - ### (Optional) Installing a sample application -As an example, you will now install a sample microservices application, a socks shop, to put your cluster through its paces. +As an example, install a sample microservices application, a socks shop, to put your cluster through its paces. To learn more about the sample microservices app, see the [GitHub README](https://github.com/microservices-demo/microservices-demo). -Here you will install the NodePort version of the Socks Shop, which doesn't depend on Load Balancer integration, since our cluster doesn't have that: - - # kubectl apply -f https://raw.githubusercontent.com/lukemarsden/microservices-demo/master/deploy/kubernetes/definitions/wholeWeaveDemo-NodePort.yaml + # git clone https://github.com/microservices-demo/microservices-demo + # kubectl apply -f microservices-demo/deploy/kubernetes/manifests You can then find out the port that the [NodePort feature of services](/docs/user-guide/services/) allocated for the front-end service by running: @@ -194,11 +190,11 @@ You can then find out the port that the [NodePort feature of services](/docs/use Endpoints: Session Affinity: None -It will take several minutes to download and start all the containers, watch the output of `kubectl get pods` to see when they're all up and running. +It takes several minutes to download and start all the containers, watch the output of `kubectl get pods` to see when they're all up and running. Then go to the IP address of your cluster's master node in your browser, and specify the given port. So for example, `http://:`. -In the example above, this was `31869`, but it will be a different port for you. +In the example above, this was `31869`, but it is a different port for you. If there is a firewall, make sure it exposes this port to the internet before you try to access it. @@ -215,9 +211,19 @@ See the [list of add-ons](/docs/admin/addons/) to explore other add-ons, includi ## Cleanup -* To uninstall the socks shop, run `kubectl delete -f https://raw.githubusercontent.com/lukemarsden/microservices-demo/master/deploy/kubernetes/definitions/wholeWeaveDemo-NodePort.yaml`. -* To uninstall Kubernetes, simply delete the machines you created for this tutorial. - Or alternatively, uninstall the `kubelet`, `kubeadm` and `kubectl` packages and then manually delete all the Docker container that were created by this process. +* To uninstall the socks shop, run `kubectl delete -f microservices-demo/deploy/kubernetes/manifests` on the master. + +* To uninstall Kubernetes, simply delete the machines you created for this tutorial, or run the script below. +
    + ``` + systemctl stop kubelet + docker rm -f $(docker ps -q); mount | grep "/var/lib/kubelet/*" | awk '{print $3}' | xargs umount 1>/dev/null 2>/dev/null + rm -rf /var/lib/kubelet /etc/kubernetes /var/lib/etcd /etc/cni + ip link set cbr0 down; ip link del cbr0 + ip link set cni0 down; ip link del cni0 + systemctl start kubelet + ``` +
    ## Feedback @@ -233,8 +239,8 @@ Please note: `kubeadm` is a work in progress and these limitations will be addre To easily obtain a cluster which works with LBs and PVs Kubernetes, try [the "hello world" GKE tutorial](/docs/hellonode) or [one of the other cloud-specific installation tutorials](/docs/getting-started-guides/). Workaround: use the [NodePort feature of services](/docs/user-guide/services/#type-nodeport) to demonstrate exposing the sample application on the internet. -1. The cluster created here will have a single master, with a single `etcd` database running on it. - This means that if the master fails, your cluster will lose its configuration data and will need to be recreated from scratch. +1. The cluster created here has a single master, with a single `etcd` database running on it. + This means that if the master fails, your cluster loses its configuration data and will need to be recreated from scratch. Adding HA support (multiple `etcd` servers, multiple API servers, etc) to `kubeadm` is still a work-in-progress. Workaround: regularly [back up etcd](https://coreos.com/etcd/docs/latest/admin_guide.html). @@ -244,4 +250,4 @@ Please note: `kubeadm` is a work in progress and these limitations will be addre Workaround: use `docker logs` on the nodes where the containers are running as a workaround. 1. There is not yet an easy way to generate a `kubeconfig` file which can be used to authenticate to the cluster remotely with `kubectl` on, for example, your workstation. - Workaround: copy the kubelet's `kubeconfig` from the master: use `scp root@:/etc/kubernetes/kubelet.conf .` and then e.g. `kubectl --kubeconfig ./kubelet.conf get nodes` from your workstation. + Workaround: copy the kubelet's `kubeconfig` from the master: use `scp root@:/etc/kubernetes/admin.conf .` and then e.g. `kubectl --kubeconfig ./admin.conf get nodes` from your workstation. diff --git a/docs/index.md b/docs/index.md index 6c83b696a0..5e29c42dcb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -82,9 +82,9 @@ h2, h3, h4 { Get Started on GKE
    -

    Installing Kubernetes Easily on Linux

    +

    Installing Kubernetes on Linux with kubeadm

    This quickstart will show you how to install a secure Kubernetes cluster on any computers running Linux, using a tool called kubeadm which is part of Kubernetes. It'll work with local VMs, physical servers and/or cloud servers, either manually or as part of your own automation. It is currently in alpha but please try it out and give us feedback!

    - Install Kubernetes Easily + Install Kubernetes with kubeadm

    Guided Tutorial

    diff --git a/CNAME b/old.CNAME similarity index 100% rename from CNAME rename to old.CNAME From 3cf4c842f97cde39c0af5b8a3d8004763de1bbda Mon Sep 17 00:00:00 2001 From: Luke Marsden Date: Mon, 26 Sep 2016 14:12:46 +0100 Subject: [PATCH 089/115] Move CNAME file back. --- old.CNAME => CNAME | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename old.CNAME => CNAME (100%) diff --git a/old.CNAME b/CNAME similarity index 100% rename from old.CNAME rename to CNAME From 7d434d58b926b7dd10666cc65918c6730dc8beef Mon Sep 17 00:00:00 2001 From: Luke Marsden Date: Mon, 26 Sep 2016 14:20:47 +0100 Subject: [PATCH 090/115] Clarify that this reverts what kubeadm did rather than uninstalling the packages. --- docs/getting-started-guides/kubeadm.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/getting-started-guides/kubeadm.md b/docs/getting-started-guides/kubeadm.md index c30b732475..9330ffef41 100644 --- a/docs/getting-started-guides/kubeadm.md +++ b/docs/getting-started-guides/kubeadm.md @@ -213,16 +213,14 @@ See the [list of add-ons](/docs/admin/addons/) to explore other add-ons, includi * To uninstall the socks shop, run `kubectl delete -f microservices-demo/deploy/kubernetes/manifests` on the master. -* To uninstall Kubernetes, simply delete the machines you created for this tutorial, or run the script below. +* To undo what `kubeadm` did, simply delete the machines you created for this tutorial, or run the script below and then uninstall the packages.
    - ``` - systemctl stop kubelet - docker rm -f $(docker ps -q); mount | grep "/var/lib/kubelet/*" | awk '{print $3}' | xargs umount 1>/dev/null 2>/dev/null - rm -rf /var/lib/kubelet /etc/kubernetes /var/lib/etcd /etc/cni - ip link set cbr0 down; ip link del cbr0 - ip link set cni0 down; ip link del cni0 - systemctl start kubelet - ``` + systemctl stop kubelet; + docker rm -f $(docker ps -q); mount | grep "/var/lib/kubelet/*" | awk '{print $3}' | xargs umount 1>/dev/null 2>/dev/null; + rm -rf /var/lib/kubelet /etc/kubernetes /var/lib/etcd /etc/cni; + ip link set cbr0 down; ip link del cbr0; + ip link set cni0 down; ip link del cni0; + systemctl start kubelet
    ## Feedback From 8c43a0b759c0d97a125f236ac6b3634aac305134 Mon Sep 17 00:00:00 2001 From: Luke Marsden Date: Mon, 26 Sep 2016 14:25:07 +0100 Subject: [PATCH 091/115] Make the uninstall script look like code --- docs/getting-started-guides/kubeadm.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started-guides/kubeadm.md b/docs/getting-started-guides/kubeadm.md index 9330ffef41..01ab4a3b16 100644 --- a/docs/getting-started-guides/kubeadm.md +++ b/docs/getting-started-guides/kubeadm.md @@ -215,12 +215,12 @@ See the [list of add-ons](/docs/admin/addons/) to explore other add-ons, includi * To undo what `kubeadm` did, simply delete the machines you created for this tutorial, or run the script below and then uninstall the packages.
    - systemctl stop kubelet; +
    systemctl stop kubelet;
          docker rm -f $(docker ps -q); mount | grep "/var/lib/kubelet/*" | awk '{print $3}' | xargs umount 1>/dev/null 2>/dev/null;
          rm -rf /var/lib/kubelet /etc/kubernetes /var/lib/etcd /etc/cni;
          ip link set cbr0 down; ip link del cbr0;
          ip link set cni0 down; ip link del cni0;
    -     systemctl start kubelet
    +     systemctl start kubelet
    ## Feedback From fe30e27200e142b97df096dbe6d06a5538db74b9 Mon Sep 17 00:00:00 2001 From: Luke Marsden Date: Mon, 26 Sep 2016 14:27:06 +0100 Subject: [PATCH 092/115] Fix alignment --- docs/getting-started-guides/kubeadm.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/getting-started-guides/kubeadm.md b/docs/getting-started-guides/kubeadm.md index 01ab4a3b16..8c47628461 100644 --- a/docs/getting-started-guides/kubeadm.md +++ b/docs/getting-started-guides/kubeadm.md @@ -216,12 +216,12 @@ See the [list of add-ons](/docs/admin/addons/) to explore other add-ons, includi * To undo what `kubeadm` did, simply delete the machines you created for this tutorial, or run the script below and then uninstall the packages.
    systemctl stop kubelet;
    -     docker rm -f $(docker ps -q); mount | grep "/var/lib/kubelet/*" | awk '{print $3}' | xargs umount 1>/dev/null 2>/dev/null;
    -     rm -rf /var/lib/kubelet /etc/kubernetes /var/lib/etcd /etc/cni;
    -     ip link set cbr0 down; ip link del cbr0;
    -     ip link set cni0 down; ip link del cni0;
    -     systemctl start kubelet
    -
    + docker rm -f $(docker ps -q); mount | grep "/var/lib/kubelet/*" | awk '{print $3}' | xargs umount 1>/dev/null 2>/dev/null; + rm -rf /var/lib/kubelet /etc/kubernetes /var/lib/etcd /etc/cni; + ip link set cbr0 down; ip link del cbr0; + ip link set cni0 down; ip link del cni0; + systemctl start kubelet + ## Feedback From 807827c645df990fe9c2c9234698e1badc79c41a Mon Sep 17 00:00:00 2001 From: Luke Marsden Date: Mon, 26 Sep 2016 14:35:41 +0100 Subject: [PATCH 093/115] Clarify. --- docs/getting-started-guides/kubeadm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started-guides/kubeadm.md b/docs/getting-started-guides/kubeadm.md index 8c47628461..4c6f8e8246 100644 --- a/docs/getting-started-guides/kubeadm.md +++ b/docs/getting-started-guides/kubeadm.md @@ -236,7 +236,7 @@ Please note: `kubeadm` is a work in progress and these limitations will be addre 1. The cluster created here doesn't have cloud-provider integrations, so for example won't work with (for example) [Load Balancers](/docs/user-guide/load-balancer/) (LBs) or [Persistent Volumes](/docs/user-guide/persistent-volumes/walkthrough/) (PVs). To easily obtain a cluster which works with LBs and PVs Kubernetes, try [the "hello world" GKE tutorial](/docs/hellonode) or [one of the other cloud-specific installation tutorials](/docs/getting-started-guides/). - Workaround: use the [NodePort feature of services](/docs/user-guide/services/#type-nodeport) to demonstrate exposing the sample application on the internet. + Workaround: use the [NodePort feature of services](/docs/user-guide/services/#type-nodeport) for exposing applications to the internet. 1. The cluster created here has a single master, with a single `etcd` database running on it. This means that if the master fails, your cluster loses its configuration data and will need to be recreated from scratch. Adding HA support (multiple `etcd` servers, multiple API servers, etc) to `kubeadm` is still a work-in-progress. From e6f488c555bc91f5c603ffaf6cf45e797377c09b Mon Sep 17 00:00:00 2001 From: Luke Marsden Date: Mon, 26 Sep 2016 15:09:25 +0100 Subject: [PATCH 094/115] Required for now for this to work --- docs/getting-started-guides/kubeadm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started-guides/kubeadm.md b/docs/getting-started-guides/kubeadm.md index 4c6f8e8246..0ed390dae2 100644 --- a/docs/getting-started-guides/kubeadm.md +++ b/docs/getting-started-guides/kubeadm.md @@ -82,7 +82,7 @@ All of these components run in pods started by `kubelet`. To initialize the master, pick one of the machines you previously installed `kubelet` and `kubeadm` on, and run: - # kubeadm init + # kubeadm init --use-kubernetes-version v1.4.0-beta.11 This will download and install the cluster database and "control plane" components. This may take several minutes. From e6eac66c948093898e337acffa1729aed1c8236b Mon Sep 17 00:00:00 2001 From: Luke Marsden Date: Mon, 26 Sep 2016 15:18:33 +0100 Subject: [PATCH 095/115] Include slightly surprising output. --- docs/getting-started-guides/kubeadm.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/getting-started-guides/kubeadm.md b/docs/getting-started-guides/kubeadm.md index 0ed390dae2..22e64fa539 100644 --- a/docs/getting-started-guides/kubeadm.md +++ b/docs/getting-started-guides/kubeadm.md @@ -118,8 +118,11 @@ By default, your cluster will not schedule pods on the master for security reaso If you want to be able to schedule pods on the master, for example if you want a single-machine Kubernetes cluster for development, run: # kubectl taint nodes --all dedicated- + node "test-01" tainted + taint key="dedicated" and effect="" not found. + taint key="dedicated" and effect="" not found. -This will remove the "dedicated" taint from all nodes, including the master node, meaning that the scheduler will then be able to schedule pods everywhere. +This will remove the "dedicated" taint from any nodes that have it, including the master node, meaning that the scheduler will then be able to schedule pods everywhere. ### (3/4) Joining your nodes From 822d59b5e49b148bfbf831e71c6f297a26bd601f Mon Sep 17 00:00:00 2001 From: steveperry-53 Date: Fri, 23 Sep 2016 15:40:21 -0700 Subject: [PATCH 096/115] Write page templates and canonical examples. Conflicts: _data/tasks.yml _data/tutorials.yml docs/tasks/access-kubernetes-api/http-proxy-access-api.md docs/tasks/index.md docs/tutorials/index.md --- _data/concepts.yml | 8 + _data/globals.yml | 5 +- _data/support.yml | 5 + _data/tasks.yml | 13 ++ _data/tutorials.yml | 10 + _includes/templates/concept.md | 32 +++ _includes/templates/task.md | 63 ++++-- _includes/templates/tutorial.md | 68 ++++++ _layouts/docwithnav.html | 31 +-- docs/concepts/index.md | 14 ++ docs/concepts/object-metadata/annotations.md | 60 +++++ docs/contribute/page-templates.md | 205 ++++++++++++++++++ ...load-balance-access-application-cluster.md | 133 ++++++++++++ ...port-forward-access-application-cluster.md | 101 +++++++++ .../redis-master.yaml | 33 +++ .../http-proxy-access-api.md | 90 ++++++++ .../http-proxy-access-api.md | 90 ++++++++ docs/tasks/index.md | 19 ++ docs/tutorials/index.md | 16 ++ .../deployment-update.yaml | 16 ++ .../stateless-application/deployment.yaml | 19 ++ .../expose-external-ip-address-service.md | 146 +++++++++++++ .../run-stateless-application-deployment.md | 114 ++++++++++ 23 files changed, 1254 insertions(+), 37 deletions(-) create mode 100644 _data/concepts.yml create mode 100644 _data/tasks.yml create mode 100644 _data/tutorials.yml create mode 100644 _includes/templates/concept.md create mode 100644 _includes/templates/tutorial.md create mode 100644 docs/concepts/index.md create mode 100644 docs/concepts/object-metadata/annotations.md create mode 100644 docs/contribute/page-templates.md create mode 100644 docs/tasks/access-application-cluster/load-balance-access-application-cluster.md create mode 100644 docs/tasks/access-application-cluster/port-forward-access-application-cluster.md create mode 100644 docs/tasks/access-application-cluster/redis-master.yaml create mode 100644 docs/tasks/access-kubernetes-api/access-kubernetes-api/http-proxy-access-api.md create mode 100644 docs/tasks/access-kubernetes-api/http-proxy-access-api.md create mode 100644 docs/tasks/index.md create mode 100644 docs/tutorials/index.md create mode 100644 docs/tutorials/stateless-application/deployment-update.yaml create mode 100644 docs/tutorials/stateless-application/deployment.yaml create mode 100644 docs/tutorials/stateless-application/expose-external-ip-address-service.md create mode 100644 docs/tutorials/stateless-application/run-stateless-application-deployment.md diff --git a/_data/concepts.yml b/_data/concepts.yml new file mode 100644 index 0000000000..a69276201e --- /dev/null +++ b/_data/concepts.yml @@ -0,0 +1,8 @@ +bigheader: "Concepts" +toc: +- title: Concepts + path: /docs/concepts/ +- title: Object Metadata + section: + - title: Annotations + path: /docs/concepts/object-metadata/annotations/ diff --git a/_data/globals.yml b/_data/globals.yml index fd3be92a16..c83dae26dd 100644 --- a/_data/globals.yml +++ b/_data/globals.yml @@ -1,5 +1,8 @@ tocs: - guides +- tutorials +- tasks +- concepts - reference - samples -- support \ No newline at end of file +- support diff --git a/_data/support.yml b/_data/support.yml index 4ca3b339c8..d287f0ecaa 100644 --- a/_data/support.yml +++ b/_data/support.yml @@ -4,6 +4,11 @@ toc: - title: Support path: /docs/troubleshooting/ +- title: Contributing to the Kubernetes Docs + section: + - title: Using Page Templates + path: /docs/contribute/page-templates/ + - title: Troubleshooting section: - title: Debugging Pods and Replication Controllers diff --git a/_data/tasks.yml b/_data/tasks.yml new file mode 100644 index 0000000000..1019671e66 --- /dev/null +++ b/_data/tasks.yml @@ -0,0 +1,13 @@ +bigheader: "Tasks" +toc: +- title: Tasks + path: /docs/tasks/ +- title: Accessing Applications in a Cluster + section: + - title: Using Port Forwarding to Access Applications in a Cluster + path: /docs/tasks/access-application-cluster/port-forward-access-application-cluster/ +- title: Accessing the Kubernetes API + section: + - title: Using an HTTP Proxy to Access the Kubernetes API + path: /docs/tasks/access-kubernetes-api/http-proxy-access-api/ + diff --git a/_data/tutorials.yml b/_data/tutorials.yml new file mode 100644 index 0000000000..101a21771a --- /dev/null +++ b/_data/tutorials.yml @@ -0,0 +1,10 @@ +bigheader: "Tutorials" +toc: +- title: Tutorials + path: /docs/tutorials/ +- title: Stateless Applications + section: + - title: Running a Stateless Application Using a Deployment + path: /docs/tutorials/stateless-application/run-stateless-application-deployment/ + - title: Exposing an External IP Address Using a Service + path: /docs/tutorials/stateless-application/expose-external-ip-address-service/ diff --git a/_includes/templates/concept.md b/_includes/templates/concept.md new file mode 100644 index 0000000000..dc6efdad13 --- /dev/null +++ b/_includes/templates/concept.md @@ -0,0 +1,32 @@ +{% if overview %} + +{{ overview }} + +{% else %} + +{% include templates/_errorthrower.md missing_block='overview' purpose='provides an overview of this concept.' %} + +{% endif %} + +* TOC +{:toc} + +{% if body %} + +{{ body }} + +{% else %} + +{% include templates/_errorthrower.md missing_block='body' purpose='supplies the body of the page content.' %} + +{% endif %} + + +{% if whatsnext %} + +### What's next + +{{ whatsnext }} + +{% endif %} + diff --git a/_includes/templates/task.md b/_includes/templates/task.md index abb7ea6b10..d74ff3b97a 100644 --- a/_includes/templates/task.md +++ b/_includes/templates/task.md @@ -1,36 +1,55 @@ -{% if purpose %} +{% if overview %} -### Purpose - -{{ purpose }} +{{ overview }} {% 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.' %} +{% include templates/_errorthrower.md missing_block='overview' purpose='states, in one or two sentences, the purpose of this document' %} {% endif %} -{% if step_by_step %} +* TOC +{: toc} -### Step by step -{{ step_by_step }} +{% if prerequisites %} + +### Before you begin + +{{ prerequisites }} {% 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.' %} +{% include templates/_errorthrower.md missing_block='prerequisites' heading='Before you begin' purpose='lists action prerequisites and knowledge prerequisites' %} -{% endif %} \ No newline at end of file +{% endif %} + + +{% if steps %} + +{{ steps }} + +{% else %} + +{% include templates/_errorthrower.md missing_block='steps' purpose='lists a sequence of numbered steps that accomplish the task.' %} + +{% endif %} + + +{% if discussion %} + +{{ discussion }} + +{% else %} + +{% endif %} + + +{% if whatsnext %} + +### What's next + +{{ whatsnext }} + +{% endif %} diff --git a/_includes/templates/tutorial.md b/_includes/templates/tutorial.md new file mode 100644 index 0000000000..9c2d680643 --- /dev/null +++ b/_includes/templates/tutorial.md @@ -0,0 +1,68 @@ +{% if overview %} + +{{ overview }} + +{% else %} + +{% include templates/_errorthrower.md missing_block='overview' purpose='states, in one or two sentences, the purpose of this document' %} + +{% endif %} + + +* TOC +{: toc} + + +{% if objectives %} + +### Objectives + +{{ objectives }} + +{% else %} + +{% include templates/_errorthrower.md missing_block='objectives' heading='Objectives' purpose='lists the objectives for this tutorial.' %} + +{% endif %} + + +{% if prerequisites %} + +### Before you begin + +{{ prerequisites }} + +{% else %} + +{% include templates/_errorthrower.md missing_block='prerequisites' heading='Before you begin' purpose='lists action prerequisites and knowledge prerequisites' %} + +{% endif %} + + +{% if lessoncontent %} + +{{ lessoncontent }} + +{% else %} + +{% include templates/_errorthrower.md missing_block='lessoncontent' purpose='provides the lesson content for this tutorial.' %} + +{% endif %} + + +{% if cleanup %} + +### Cleaning up + +{{ cleanup }} + +{% endif %} + + +{% if whatsnext %} + +### What's next + +{{ whatsnext }} + +{% endif %} diff --git a/_layouts/docwithnav.html b/_layouts/docwithnav.html index 026e4ec287..735fd6adf7 100755 --- a/_layouts/docwithnav.html +++ b/_layouts/docwithnav.html @@ -7,19 +7,22 @@
    -

    {{ site.data[foundTOC].bigheader }}

    -
    {{ site.data[foundTOC].abstract }}
    -
    - - -
    +

    {{ site.data[foundTOC].bigheader }}

    +
    {{ site.data[foundTOC].abstract }}
    +
    + + +
    @@ -34,7 +37,7 @@ {% if notitle != "true" %}

    {{ title }}

    {% endif %} {{ content }}

    Analytics - {% if page.url != "/404.html" && page.url != "/docs/search/" %}

    + {% if page.url != "/404.html" and page.url != "/docs/search/" %}