From cc12b16d99e3385f21ea085f714481aad22a3195 Mon Sep 17 00:00:00 2001 From: Phillip Wittrock Date: Tue, 3 Jan 2017 08:51:38 -0800 Subject: [PATCH] Update api reference docs from review comments. Uses latest brodocs release. --- _data/reference.yml | 6 +- docs/api-reference/1_5/README.md | 5 + docs/api-reference/1_5/brodoc.js | 1 + docs/api-reference/1_5/documents/_cluster.md | 2 +- docs/api-reference/1_5/documents/_config.md | 2 +- .../1_5/documents/_definitions.md | 2 +- ...tificatesigningrequest_v1alpha1_concept.md | 122 - ...catesigningrequestlist_v1alpha1_concept.md | 67 +- ...esigningrequestlist_v1alpha1_definition.md | 2 +- ...tesigningrequeststatus_v1alpha1_concept.md | 64 +- ...igningrequeststatus_v1alpha1_definition.md | 2 +- ..._generated_clusterrole_v1alpha1_concept.md | 60 + ...ted_clusterrolebinding_v1alpha1_concept.md | 60 - ...clusterrolebindinglist_v1alpha1_concept.md | 67 +- ...sterrolebindinglist_v1alpha1_definition.md | 2 +- ...erated_clusterrolelist_v1alpha1_concept.md | 67 +- ...ted_clusterrolelist_v1alpha1_definition.md | 2 +- .../_generated_configmap_v1_concept.md | 61 - .../_generated_configmaplist_v1_concept.md | 66 + .../_generated_cronjob_v2alpha1_concept.md | 61 - ..._generated_cronjoblist_v2alpha1_concept.md | 68 +- ...nerated_cronjoblist_v2alpha1_definition.md | 2 +- .../_generated_daemonset_v1beta1_concept.md | 186 + ...nerated_daemonsetstatus_v1beta1_concept.md | 193 +- ...ated_daemonsetstatus_v1beta1_definition.md | 2 +- .../_generated_deployment_v1beta1_concept.md | 186 - ...erated_deploymentstatus_v1beta1_concept.md | 193 +- ...ted_deploymentstatus_v1beta1_definition.md | 2 +- .../_generated_endpoints_v1_concept.md | 61 - .../_generated_endpointslist_v1_concept.md | 66 + .../documents/_generated_event_v1_concept.md | 61 - .../_generated_eventlist_v1_concept.md | 66 + ...horizontalpodautoscaler_v1beta1_concept.md | 186 + ...ntalpodautoscalerstatus_v1beta1_concept.md | 193 +- ...lpodautoscalerstatus_v1beta1_definition.md | 2 +- .../_generated_ingress_v1beta1_concept.md | 247 + .../_generated_ingresslist_v1beta1_concept.md | 68 +- ...enerated_ingresslist_v1beta1_definition.md | 2 +- ...generated_ingressstatus_v1beta1_concept.md | 193 +- ...erated_ingressstatus_v1beta1_definition.md | 2 +- .../documents/_generated_job_v1_concept.md | 61 - .../_generated_job_v1beta1_concept.md | 247 + .../_generated_job_v2alpha1_concept.md | 247 - .../_generated_joblist_v1_concept.md | 68 +- .../_generated_joblist_v1_definition.md | 2 +- .../_generated_joblist_v1beta1_concept.md | 68 +- .../_generated_joblist_v1beta1_definition.md | 2 +- .../_generated_joblist_v2alpha1_concept.md | 68 +- .../_generated_joblist_v2alpha1_definition.md | 2 +- .../_generated_jobstatus_v1beta1_concept.md | 193 +- ..._generated_jobstatus_v1beta1_definition.md | 2 +- .../_generated_jobstatus_v2alpha1_concept.md | 193 +- ...generated_jobstatus_v2alpha1_definition.md | 2 +- .../_generated_limitrange_v1_concept.md | 61 + .../_generated_limitrangelist_v1_concept.md | 66 - .../_generated_namespace_v1_concept.md | 60 - .../_generated_namespacelist_v1_concept.md | 65 + ...generated_networkpolicy_v1beta1_concept.md | 61 - ...rated_networkpolicylist_v1beta1_concept.md | 68 +- ...ed_networkpolicylist_v1beta1_definition.md | 2 +- .../documents/_generated_node_v1_concept.md | 183 - .../_generated_nodestatus_v1_concept.md | 188 + .../_generated_persistentvolume_v1_concept.md | 243 + ...erated_persistentvolumeclaim_v1_concept.md | 61 - ...ed_persistentvolumeclaimlist_v1_concept.md | 66 + ...nerated_persistentvolumelist_v1_concept.md | 65 - ...rated_persistentvolumestatus_v1_concept.md | 188 - .../documents/_generated_pod_v1_concept.md | 2 +- .../_generated_podtemplate_v1_concept.md | 61 - .../_generated_podtemplatelist_v1_concept.md | 66 + .../_generated_replicaset_v1beta1_concept.md | 186 - ...erated_replicasetstatus_v1beta1_concept.md | 193 +- ...ted_replicasetstatus_v1beta1_definition.md | 2 +- ...erated_replicationcontroller_v1_concept.md | 247 - ...ed_replicationcontrollerlist_v1_concept.md | 66 + ..._replicationcontrollerstatus_v1_concept.md | 191 + .../_generated_resourcequota_v1_concept.md | 247 - ..._generated_resourcequotalist_v1_concept.md | 66 + ...enerated_resourcequotastatus_v1_concept.md | 191 + .../_generated_role_v1alpha1_concept.md | 61 - .../_generated_rolelist_v1alpha1_concept.md | 68 +- ..._generated_rolelist_v1alpha1_definition.md | 2 +- .../_generated_service_v1_concept.md | 247 + .../_generated_serviceaccount_v1_concept.md | 61 + ...generated_serviceaccountlist_v1_concept.md | 66 - .../_generated_servicelist_v1_concept.md | 66 - .../_generated_servicestatus_v1_concept.md | 191 - .../_generated_statefulset_v1beta1_concept.md | 186 - ...rated_statefulsetstatus_v1beta1_concept.md | 193 +- ...ed_statefulsetstatus_v1beta1_definition.md | 2 +- ..._generated_storageclass_v1beta1_concept.md | 60 + ...erated_storageclasslist_v1beta1_concept.md | 67 +- ...ted_storageclasslist_v1beta1_definition.md | 2 +- ...ated_thirdpartyresource_v1beta1_concept.md | 60 + ..._thirdpartyresourcelist_v1beta1_concept.md | 67 +- ...irdpartyresourcelist_v1beta1_definition.md | 2 +- docs/api-reference/1_5/documents/_meta.md | 2 +- .../1_5/documents/_oldversions.md | 2 +- docs/api-reference/1_5/documents/_overview.md | 16 +- .../1_5/documents/_servicediscovery.md | 2 +- .../api-reference/1_5/documents/_workloads.md | 2 +- docs/api-reference/1_5/index.html | 5919 +++++++---------- docs/api-reference/1_5/navData.js | 2 +- .../1_5/node_modules/ejs/Jakefile | 77 +- .../api-reference/1_5/node_modules/ejs/ejs.js | 386 +- .../1_5/node_modules/ejs/ejs.min.js | 2 +- .../1_5/node_modules/ejs/lib/ejs.js | 191 +- .../1_5/node_modules/ejs/lib/utils.js | 44 +- .../1_5/node_modules/ejs/package.json | 31 +- .../1_5/node_modules/ejs/test/ejs.js | 274 +- .../ejs/test/fixtures/no.newlines.error.ejs | 2 +- .../highlight.js/lib/highlight.js | 6 +- .../node_modules/highlight.js/lib/index.js | 1 + .../lib/languages/coffeescript.js | 13 +- .../highlight.js/lib/languages/delphi.js | 31 +- .../highlight.js/lib/languages/llvm.js | 88 + .../highlight.js/lib/languages/ruby.js | 2 +- .../highlight.js/lib/languages/sqf.js | 748 +-- .../highlight.js/lib/languages/typescript.js | 20 +- .../node_modules/highlight.js/package.json | 22 +- .../1_5/node_modules/jquery.scrollto/.jscsrc | 41 + .../node_modules/jquery.scrollto/.jshintrc | 23 + .../node_modules/jquery.scrollto/.npmignore | 16 + .../node_modules/jquery.scrollto/CHANGELOG.md | 186 + .../1_5/node_modules/jquery.scrollto/LICENSE | 22 + .../node_modules/jquery.scrollto/README.md | 151 + .../node_modules/jquery.scrollto/bower.json | 28 + .../jquery.scrollto/composer.json | 32 + .../jquery.scrollto/demo/css/style.css | 150 + .../jquery.scrollto/demo/css/style.old.css | 69 + .../jquery.scrollto/demo/index.html | 252 + .../jquery.scrollto/demo/index.old.html | 128 + .../jquery.scrollto/jquery.scrollTo.js | 210 + .../jquery.scrollto/jquery.scrollTo.min.js | 7 + .../node_modules/jquery.scrollto/package.json | 104 + .../tests/ElemMaxY-compat.html | 21 + .../tests/ElemMaxY-quirks.html | 20 + .../jquery.scrollto/tests/WinMaxY-compat.html | 19 + .../jquery.scrollto/tests/WinMaxY-quirks.html | 18 + .../tests/WinMaxY-to-iframe-compat.html | 20 + .../tests/WinMaxY-to-iframe-quirks.html | 19 + .../tests/WinMaxY-with-iframe-compat.html | 11 + .../tests/WinMaxY-with-iframe-quirks.html | 10 + .../jquery.scrollto/tests/index.html | 24 + .../jquery.scrollto/tests/test.js | 21 + .../1_5/node_modules/jquery/package.json | 3 +- docs/api-reference/1_5/package.json | 3 +- docs/api-reference/1_5/scroll.js | 58 +- docs/api-reference/1_5/stylesheet.css | 104 +- docs/user-guide/kubectl/1_5/README.md | 5 + docs/user-guide/kubectl/1_5/brodoc.js | 1 + .../kubectl/1_5/documents/_app_management.md | 4 + .../1_5/documents/_generated_annotate.md | 65 +- .../kubectl/1_5/documents/_generated_apply.md | 35 +- .../1_5/documents/_generated_autoscale.md | 6 +- .../_generated_category_app_management.md | 1 - ..._generated_category_deprecated_commands.md | 1 + .../_generated_category_getting_started.md | 1 - ..._category_troubleshooting_and_debugging.md | 1 - .../1_5/documents/_generated_certificate.md | 68 + .../1_5/documents/_generated_cluster-info.md | 13 +- .../1_5/documents/_generated_completion.md | 29 +- .../1_5/documents/_generated_config.md | 44 +- .../1_5/documents/_generated_convert.md | 12 +- .../1_5/documents/_generated_cordon.md | 2 - .../kubectl/1_5/documents/_generated_cp.md | 44 + .../1_5/documents/_generated_create.md | 81 +- .../1_5/documents/_generated_delete.md | 22 +- .../1_5/documents/_generated_describe.md | 66 +- .../kubectl/1_5/documents/_generated_drain.md | 26 +- .../kubectl/1_5/documents/_generated_edit.md | 21 +- .../1_5/documents/_generated_explain.md | 57 +- .../1_5/documents/_generated_expose.md | 13 +- .../kubectl/1_5/documents/_generated_get.md | 63 +- .../kubectl/1_5/documents/_generated_label.md | 9 +- .../kubectl/1_5/documents/_generated_patch.md | 5 +- .../kubectl/1_5/documents/_generated_proxy.md | 22 +- .../1_5/documents/_generated_replace.md | 9 +- .../documents/_generated_rolling-update.md | 10 +- .../1_5/documents/_generated_rollout.md | 27 +- .../kubectl/1_5/documents/_generated_run.md | 8 +- .../kubectl/1_5/documents/_generated_scale.md | 8 +- .../kubectl/1_5/documents/_generated_set.md | 19 +- .../kubectl/1_5/documents/_generated_stop.md | 52 + .../kubectl/1_5/documents/_generated_taint.md | 13 +- .../kubectl/1_5/documents/_generated_top.md | 14 +- .../1_5/documents/_generated_uncordon.md | 2 - .../1_5/documents/_generated_version.md | 1 + .../kubectl/1_5/documents/_getting_started.md | 11 + .../1_5/documents/_working_with_apps.md | 8 + docs/user-guide/kubectl/1_5/index.html | 1001 ++- docs/user-guide/kubectl/1_5/manifest.json | 18 +- docs/user-guide/kubectl/1_5/navData.js | 2 +- .../kubectl/1_5/node_modules/ejs/Jakefile | 77 +- .../kubectl/1_5/node_modules/ejs/ejs.js | 386 +- .../kubectl/1_5/node_modules/ejs/ejs.min.js | 2 +- .../kubectl/1_5/node_modules/ejs/lib/ejs.js | 191 +- .../kubectl/1_5/node_modules/ejs/lib/utils.js | 44 +- .../kubectl/1_5/node_modules/ejs/package.json | 31 +- .../kubectl/1_5/node_modules/ejs/test/ejs.js | 274 +- .../ejs/test/fixtures/no.newlines.error.ejs | 2 +- .../highlight.js/lib/highlight.js | 6 +- .../node_modules/highlight.js/lib/index.js | 1 + .../lib/languages/coffeescript.js | 13 +- .../highlight.js/lib/languages/delphi.js | 31 +- .../highlight.js/lib/languages/llvm.js | 88 + .../highlight.js/lib/languages/ruby.js | 2 +- .../highlight.js/lib/languages/sqf.js | 748 +-- .../highlight.js/lib/languages/typescript.js | 20 +- .../node_modules/highlight.js/package.json | 22 +- .../1_5/node_modules/jquery.scrollto/.jscsrc | 41 + .../node_modules/jquery.scrollto/.jshintrc | 23 + .../node_modules/jquery.scrollto/.npmignore | 16 + .../node_modules/jquery.scrollto/CHANGELOG.md | 186 + .../1_5/node_modules/jquery.scrollto/LICENSE | 22 + .../node_modules/jquery.scrollto/README.md | 151 + .../node_modules/jquery.scrollto/bower.json | 28 + .../jquery.scrollto/composer.json | 32 + .../jquery.scrollto/demo/css/style.css | 150 + .../jquery.scrollto/demo/css/style.old.css | 69 + .../jquery.scrollto/demo/index.html | 252 + .../jquery.scrollto/demo/index.old.html | 128 + .../jquery.scrollto/jquery.scrollTo.js | 210 + .../jquery.scrollto/jquery.scrollTo.min.js | 7 + .../node_modules/jquery.scrollto/package.json | 104 + .../tests/ElemMaxY-compat.html | 21 + .../tests/ElemMaxY-quirks.html | 20 + .../jquery.scrollto/tests/WinMaxY-compat.html | 19 + .../jquery.scrollto/tests/WinMaxY-quirks.html | 18 + .../tests/WinMaxY-to-iframe-compat.html | 20 + .../tests/WinMaxY-to-iframe-quirks.html | 19 + .../tests/WinMaxY-with-iframe-compat.html | 11 + .../tests/WinMaxY-with-iframe-quirks.html | 10 + .../jquery.scrollto/tests/index.html | 24 + .../jquery.scrollto/tests/test.js | 21 + .../1_5/node_modules/jquery/package.json | 3 +- docs/user-guide/kubectl/1_5/package.json | 3 +- docs/user-guide/kubectl/1_5/scroll.js | 58 +- docs/user-guide/kubectl/1_5/stylesheet.css | 104 +- skip_toc_check.txt | 1082 +++ 240 files changed, 14530 insertions(+), 9984 deletions(-) create mode 100644 docs/api-reference/1_5/node_modules/highlight.js/lib/languages/llvm.js create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/.jscsrc create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/.jshintrc create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/.npmignore create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/CHANGELOG.md create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/LICENSE create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/README.md create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/bower.json create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/composer.json create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/demo/css/style.css create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/demo/css/style.old.css create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/demo/index.html create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/demo/index.old.html create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/jquery.scrollTo.js create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/jquery.scrollTo.min.js create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/package.json create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/tests/ElemMaxY-compat.html create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/tests/ElemMaxY-quirks.html create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/tests/WinMaxY-compat.html create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/tests/WinMaxY-quirks.html create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/tests/WinMaxY-to-iframe-compat.html create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/tests/WinMaxY-to-iframe-quirks.html create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/tests/WinMaxY-with-iframe-compat.html create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/tests/WinMaxY-with-iframe-quirks.html create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/tests/index.html create mode 100644 docs/api-reference/1_5/node_modules/jquery.scrollto/tests/test.js create mode 100644 docs/user-guide/kubectl/1_5/documents/_app_management.md delete mode 100644 docs/user-guide/kubectl/1_5/documents/_generated_category_app_management.md create mode 100644 docs/user-guide/kubectl/1_5/documents/_generated_category_deprecated_commands.md delete mode 100644 docs/user-guide/kubectl/1_5/documents/_generated_category_getting_started.md delete mode 100644 docs/user-guide/kubectl/1_5/documents/_generated_category_troubleshooting_and_debugging.md create mode 100644 docs/user-guide/kubectl/1_5/documents/_generated_certificate.md create mode 100644 docs/user-guide/kubectl/1_5/documents/_generated_cp.md create mode 100644 docs/user-guide/kubectl/1_5/documents/_generated_stop.md create mode 100644 docs/user-guide/kubectl/1_5/documents/_getting_started.md create mode 100644 docs/user-guide/kubectl/1_5/documents/_working_with_apps.md create mode 100644 docs/user-guide/kubectl/1_5/node_modules/highlight.js/lib/languages/llvm.js create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/.jscsrc create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/.jshintrc create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/.npmignore create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/CHANGELOG.md create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/LICENSE create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/README.md create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/bower.json create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/composer.json create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/demo/css/style.css create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/demo/css/style.old.css create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/demo/index.html create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/demo/index.old.html create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/jquery.scrollTo.js create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/jquery.scrollTo.min.js create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/package.json create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/tests/ElemMaxY-compat.html create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/tests/ElemMaxY-quirks.html create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/tests/WinMaxY-compat.html create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/tests/WinMaxY-quirks.html create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/tests/WinMaxY-to-iframe-compat.html create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/tests/WinMaxY-to-iframe-quirks.html create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/tests/WinMaxY-with-iframe-compat.html create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/tests/WinMaxY-with-iframe-quirks.html create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/tests/index.html create mode 100644 docs/user-guide/kubectl/1_5/node_modules/jquery.scrollto/tests/test.js diff --git a/_data/reference.yml b/_data/reference.yml index 2538f3b84c..f8752aa252 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -3,15 +3,15 @@ abstract: "Design docs, concept definitions, and references for APIs and CLIs." toc: - docs/reference.md -- title: Kubernetes API Reference (New Beta Docs) +- title: "Kubernetes API (New Docs Style)" section: - title: Version 1.5 path: /docs/api-reference/1_5/ -- title: Kubectl Command Reference (New Beta Docs) +- title: "Kubectl Commands (New Docs Style)" section: - title: Version 1.5 - path: /docs/user-guide/kubectl/1_5 + path: /docs/user-guide/kubectl/1_5/ - title: Kubernetes API section: diff --git a/docs/api-reference/1_5/README.md b/docs/api-reference/1_5/README.md index 36c86b6906..f6799c18b9 100644 --- a/docs/api-reference/1_5/README.md +++ b/docs/api-reference/1_5/README.md @@ -62,3 +62,8 @@ npm start ## License Apache License Version 2.0 + +## FAQ + +Q: Why is it named brodocs? +A: This project was born out of a collaboration with my brother to create a suitable docs app for his purposes. It was a fun name for the the two of us to use as actual brothers. \ No newline at end of file diff --git a/docs/api-reference/1_5/brodoc.js b/docs/api-reference/1_5/brodoc.js index 904f674b3d..da3507af76 100644 --- a/docs/api-reference/1_5/brodoc.js +++ b/docs/api-reference/1_5/brodoc.js @@ -195,6 +195,7 @@ function generateDoc(navContent, bodyContent, codeTabContent) {
${bodyContent}
+ diff --git a/docs/api-reference/1_5/documents/_cluster.md b/docs/api-reference/1_5/documents/_cluster.md index f0119f1c7b..5c74168efb 100644 --- a/docs/api-reference/1_5/documents/_cluster.md +++ b/docs/api-reference/1_5/documents/_cluster.md @@ -1,5 +1,5 @@ # CLUSTER -These are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators. +Cluster resources are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators. ------------ diff --git a/docs/api-reference/1_5/documents/_config.md b/docs/api-reference/1_5/documents/_config.md index 2dd32a3d6f..555578e2b3 100644 --- a/docs/api-reference/1_5/documents/_config.md +++ b/docs/api-reference/1_5/documents/_config.md @@ -1,6 +1,6 @@ # CONFIG & STORAGE -These are responsible for injecting data into your applications and persisting data externally to your container. +Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container. Common resource types: diff --git a/docs/api-reference/1_5/documents/_definitions.md b/docs/api-reference/1_5/documents/_definitions.md index b71e4e1b57..337695b8d5 100644 --- a/docs/api-reference/1_5/documents/_definitions.md +++ b/docs/api-reference/1_5/documents/_definitions.md @@ -1,3 +1,3 @@ # DEFINITIONS -These are Definitions for objects used by the above APIs +This section contains definitions for objects used in the Kubernetes APIs. diff --git a/docs/api-reference/1_5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md index c9cc5d535d..91a3e7e2ca 100644 --- a/docs/api-reference/1_5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_certificatesigningrequest_v1alpha1_concept.md @@ -566,127 +566,5 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of CertificateSigningRequest - -### HTTP Request - -`GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - -## Status Operations - -See supported operations below... - -## Replace Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified CertificateSigningRequest - -### HTTP Request - -`PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -body
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | -name | name of the CertificateSigningRequest -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK - - diff --git a/docs/api-reference/1_5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md index d67ab588c5..f06b45882c 100644 --- a/docs/api-reference/1_5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_certificatesigningrequestlist_v1alpha1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestList +Certificates | v1alpha1 | CertificateSigningRequestList @@ -28,4 +28,69 @@ metadata
*[ListMeta](#listmeta-unversioned)* | +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of CertificateSigningRequest + +### HTTP Request + +`GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md b/docs/api-reference/1_5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md index 51c4e6f342..b618ce6a40 100644 --- a/docs/api-reference/1_5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_certificatesigningrequestlist_v1alpha1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestList +Certificates | v1alpha1 | CertificateSigningRequestList diff --git a/docs/api-reference/1_5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md index a51938509e..dd927e259b 100644 --- a/docs/api-reference/1_5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_certificatesigningrequeststatus_v1alpha1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestStatus +Certificates | v1alpha1 | CertificateSigningRequestStatus @@ -29,4 +29,66 @@ conditions
*[CertificateSigningRequestCondition](#certificatesigningreque +## Write Operations + +See supported operations below... + +## Replace + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified CertificateSigningRequest + +### HTTP Request + +`PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +body
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | +name | name of the CertificateSigningRequest +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md b/docs/api-reference/1_5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md index 570ad1795d..55a929b145 100644 --- a/docs/api-reference/1_5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_certificatesigningrequeststatus_v1alpha1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1alpha1 | CertificateSigningRequestStatus +Certificates | v1alpha1 | CertificateSigningRequestStatus diff --git a/docs/api-reference/1_5/documents/_generated_clusterrole_v1alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_clusterrole_v1alpha1_concept.md index 1d96b1293a..6e829a2d86 100644 --- a/docs/api-reference/1_5/documents/_generated_clusterrole_v1alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_clusterrole_v1alpha1_concept.md @@ -537,5 +537,65 @@ Code | Description 200
*[Event](#event-versioned)* | OK +## Watch List + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of ClusterRole + +### HTTP Request + +`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + diff --git a/docs/api-reference/1_5/documents/_generated_clusterrolebinding_v1alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_clusterrolebinding_v1alpha1_concept.md index 5dfaabe85f..8e39037a88 100644 --- a/docs/api-reference/1_5/documents/_generated_clusterrolebinding_v1alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_clusterrolebinding_v1alpha1_concept.md @@ -538,65 +538,5 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ClusterRoleBinding - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - diff --git a/docs/api-reference/1_5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md index 68e0b478c2..2f6cc5edf7 100644 --- a/docs/api-reference/1_5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_clusterrolebindinglist_v1alpha1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1alpha1 | ClusterRoleBindingList +RbacAuthorization | v1alpha1 | ClusterRoleBindingList @@ -28,4 +28,69 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard object's metadat +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of ClusterRoleBinding + +### HTTP Request + +`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md b/docs/api-reference/1_5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md index 8cb35e443f..cbf72459fc 100644 --- a/docs/api-reference/1_5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_clusterrolebindinglist_v1alpha1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1alpha1 | ClusterRoleBindingList +RbacAuthorization | v1alpha1 | ClusterRoleBindingList diff --git a/docs/api-reference/1_5/documents/_generated_clusterrolelist_v1alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_clusterrolelist_v1alpha1_concept.md index de8b39899d..fc2468dc6e 100644 --- a/docs/api-reference/1_5/documents/_generated_clusterrolelist_v1alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_clusterrolelist_v1alpha1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRoleList +Core | v1alpha1 | ClusterRoleList @@ -28,69 +28,4 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard object's metadat -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ClusterRole - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_clusterrolelist_v1alpha1_definition.md b/docs/api-reference/1_5/documents/_generated_clusterrolelist_v1alpha1_definition.md index 2ce209b37c..de3b45bd16 100644 --- a/docs/api-reference/1_5/documents/_generated_clusterrolelist_v1alpha1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_clusterrolelist_v1alpha1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -RbacAuthorization | v1alpha1 | ClusterRoleList +Core | v1alpha1 | ClusterRoleList diff --git a/docs/api-reference/1_5/documents/_generated_configmap_v1_concept.md b/docs/api-reference/1_5/documents/_generated_configmap_v1_concept.md index ab7c39376f..d31e5aac23 100644 --- a/docs/api-reference/1_5/documents/_generated_configmap_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_configmap_v1_concept.md @@ -611,67 +611,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ConfigMap - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/configmaps` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command diff --git a/docs/api-reference/1_5/documents/_generated_configmaplist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_configmaplist_v1_concept.md index cb63a2e0ef..799ed34747 100644 --- a/docs/api-reference/1_5/documents/_generated_configmaplist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_configmaplist_v1_concept.md @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | More info: http://release +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of ConfigMap + +### HTTP Request + +`GET /api/v1/watch/namespaces/{namespace}/configmaps` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_cronjob_v2alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_cronjob_v2alpha1_concept.md index bc44b5d349..a23099c608 100644 --- a/docs/api-reference/1_5/documents/_generated_cronjob_v2alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_cronjob_v2alpha1_concept.md @@ -635,67 +635,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of CronJob - -### HTTP Request - -`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command diff --git a/docs/api-reference/1_5/documents/_generated_cronjoblist_v2alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_cronjoblist_v2alpha1_concept.md index b77f09d318..4661f733e0 100644 --- a/docs/api-reference/1_5/documents/_generated_cronjoblist_v2alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_cronjoblist_v2alpha1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v2alpha1 | CronJobList +Batch | v2alpha1 | CronJobList @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata Mo +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of CronJob + +### HTTP Request + +`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_cronjoblist_v2alpha1_definition.md b/docs/api-reference/1_5/documents/_generated_cronjoblist_v2alpha1_definition.md index bc440f14da..3c57015261 100644 --- a/docs/api-reference/1_5/documents/_generated_cronjoblist_v2alpha1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_cronjoblist_v2alpha1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v2alpha1 | CronJobList +Batch | v2alpha1 | CronJobList diff --git a/docs/api-reference/1_5/documents/_generated_daemonset_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_daemonset_v1beta1_concept.md index 49370756a3..aa7a6d8b49 100644 --- a/docs/api-reference/1_5/documents/_generated_daemonset_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_daemonset_v1beta1_concept.md @@ -933,4 +933,190 @@ Code | Description +## Status Operations + +See supported operations below... + +## Patch Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified DaemonSet + +### HTTP Request + +`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the DaemonSet +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[DaemonSet](#daemonset-v1beta1)* | OK + + +## Read Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified DaemonSet + +### HTTP Request + +`GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the DaemonSet +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[DaemonSet](#daemonset-v1beta1)* | OK + + +## Replace Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified DaemonSet + +### HTTP Request + +`PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the DaemonSet +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[DaemonSet](#daemonset-v1beta1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[DaemonSet](#daemonset-v1beta1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_daemonsetstatus_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_daemonsetstatus_v1beta1_concept.md index 4e63bdac73..e299365409 100644 --- a/docs/api-reference/1_5/documents/_generated_daemonsetstatus_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_daemonsetstatus_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | DaemonSetStatus +Core | v1beta1 | DaemonSetStatus @@ -31,195 +31,4 @@ numberReady
*integer* | NumberReady is the number of nodes that should b -## Write Operations - -See supported operations below... - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified DaemonSet - -### HTTP Request - -`PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the DaemonSet -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[DaemonSet](#daemonset-v1beta1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[DaemonSet](#daemonset-v1beta1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified DaemonSet - -### HTTP Request - -`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the DaemonSet -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[DaemonSet](#daemonset-v1beta1)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified DaemonSet - -### HTTP Request - -`GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the DaemonSet -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[DaemonSet](#daemonset-v1beta1)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_daemonsetstatus_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_daemonsetstatus_v1beta1_definition.md index 2ae59355d6..50ef8d21ca 100644 --- a/docs/api-reference/1_5/documents/_generated_daemonsetstatus_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_daemonsetstatus_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | DaemonSetStatus +Core | v1beta1 | DaemonSetStatus diff --git a/docs/api-reference/1_5/documents/_generated_deployment_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_deployment_v1beta1_concept.md index 445ecd2a21..0a1c4abb19 100644 --- a/docs/api-reference/1_5/documents/_generated_deployment_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_deployment_v1beta1_concept.md @@ -1705,192 +1705,6 @@ Code | Description -## Status Operations - -See supported operations below... - -## Patch Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified Deployment - -### HTTP Request - -`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Deployment -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Deployment](#deployment-v1beta1)* | OK - - -## Read Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified Deployment - -### HTTP Request - -`GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Deployment -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[Deployment](#deployment-v1beta1)* | OK - - -## Replace Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified Deployment - -### HTTP Request - -`PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Deployment -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Deployment](#deployment-v1beta1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Deployment](#deployment-v1beta1)* | OK - - - ## Misc Operations See supported operations below... diff --git a/docs/api-reference/1_5/documents/_generated_deploymentstatus_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_deploymentstatus_v1beta1_concept.md index a48b1826d3..e2ea5c1b57 100644 --- a/docs/api-reference/1_5/documents/_generated_deploymentstatus_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_deploymentstatus_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1beta1 | DeploymentStatus +Extensions | v1beta1 | DeploymentStatus @@ -33,4 +33,195 @@ updatedReplicas
*integer* | Total number of non-terminated pods targeted +## Write Operations + +See supported operations below... + +## Replace + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified Deployment + +### HTTP Request + +`PUT /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Deployment +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Deployment](#deployment-v1beta1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Deployment](#deployment-v1beta1)* | OK + + +## Patch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified Deployment + +### HTTP Request + +`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Deployment +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Deployment](#deployment-v1beta1)* | OK + + + +## Read Operations + +See supported operations below... + +## Read + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified Deployment + +### HTTP Request + +`GET /apis/extensions/v1beta1/namespaces/{namespace}/deployments/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Deployment +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[Deployment](#deployment-v1beta1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_deploymentstatus_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_deploymentstatus_v1beta1_definition.md index 267b92166f..bec3badea1 100644 --- a/docs/api-reference/1_5/documents/_generated_deploymentstatus_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_deploymentstatus_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1beta1 | DeploymentStatus +Extensions | v1beta1 | DeploymentStatus diff --git a/docs/api-reference/1_5/documents/_generated_endpoints_v1_concept.md b/docs/api-reference/1_5/documents/_generated_endpoints_v1_concept.md index 1a9932ea8a..9adb5972f2 100644 --- a/docs/api-reference/1_5/documents/_generated_endpoints_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_endpoints_v1_concept.md @@ -622,67 +622,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of Endpoints - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/endpoints` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command diff --git a/docs/api-reference/1_5/documents/_generated_endpointslist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_endpointslist_v1_concept.md index a86cd00d15..24ca305e62 100644 --- a/docs/api-reference/1_5/documents/_generated_endpointslist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_endpointslist_v1_concept.md @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of Endpoints + +### HTTP Request + +`GET /api/v1/watch/namespaces/{namespace}/endpoints` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_event_v1_concept.md b/docs/api-reference/1_5/documents/_generated_event_v1_concept.md index 4c75d5f5ff..db06f96f86 100644 --- a/docs/api-reference/1_5/documents/_generated_event_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_event_v1_concept.md @@ -618,67 +618,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of Event - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/events` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command diff --git a/docs/api-reference/1_5/documents/_generated_eventlist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_eventlist_v1_concept.md index 35db7a83de..ae900816bf 100644 --- a/docs/api-reference/1_5/documents/_generated_eventlist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_eventlist_v1_concept.md @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of Event + +### HTTP Request + +`GET /api/v1/watch/namespaces/{namespace}/events` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_horizontalpodautoscaler_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_horizontalpodautoscaler_v1beta1_concept.md index 8618e3a3ff..2b894a745f 100644 --- a/docs/api-reference/1_5/documents/_generated_horizontalpodautoscaler_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_horizontalpodautoscaler_v1beta1_concept.md @@ -759,4 +759,190 @@ Code | Description +## Status Operations + +See supported operations below... + +## Patch Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified HorizontalPodAutoscaler + +### HTTP Request + +`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the HorizontalPodAutoscaler +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* | OK + + +## Read Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified HorizontalPodAutoscaler + +### HTTP Request + +`GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the HorizontalPodAutoscaler +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* | OK + + +## Replace Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified HorizontalPodAutoscaler + +### HTTP Request + +`PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the HorizontalPodAutoscaler +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_horizontalpodautoscalerstatus_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_horizontalpodautoscalerstatus_v1beta1_concept.md index 9027f8c80b..e239517552 100644 --- a/docs/api-reference/1_5/documents/_generated_horizontalpodautoscalerstatus_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_horizontalpodautoscalerstatus_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | HorizontalPodAutoscalerStatus +Core | v1beta1 | HorizontalPodAutoscalerStatus @@ -32,195 +32,4 @@ observedGeneration
*integer* | most recent generation observed by this a -## Write Operations - -See supported operations below... - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified HorizontalPodAutoscaler - -### HTTP Request - -`PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the HorizontalPodAutoscaler -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified HorizontalPodAutoscaler - -### HTTP Request - -`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the HorizontalPodAutoscaler -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified HorizontalPodAutoscaler - -### HTTP Request - -`GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the HorizontalPodAutoscaler -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[HorizontalPodAutoscaler](#horizontalpodautoscaler-v1beta1)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_horizontalpodautoscalerstatus_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_horizontalpodautoscalerstatus_v1beta1_definition.md index 4a4c8aeda0..f650532bd5 100644 --- a/docs/api-reference/1_5/documents/_generated_horizontalpodautoscalerstatus_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_horizontalpodautoscalerstatus_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | HorizontalPodAutoscalerStatus +Core | v1beta1 | HorizontalPodAutoscalerStatus diff --git a/docs/api-reference/1_5/documents/_generated_ingress_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_ingress_v1beta1_concept.md index 136591c178..1fbb682aea 100644 --- a/docs/api-reference/1_5/documents/_generated_ingress_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_ingress_v1beta1_concept.md @@ -632,6 +632,67 @@ Code | Description 200
*[Event](#event-versioned)* | OK +## Watch List + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of Ingress + +### HTTP Request + +`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command @@ -693,4 +754,190 @@ Code | Description +## Status Operations + +See supported operations below... + +## Patch Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified Ingress + +### HTTP Request + +`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Ingress +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Ingress](#ingress-v1beta1)* | OK + + +## Read Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified Ingress + +### HTTP Request + +`GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Ingress +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[Ingress](#ingress-v1beta1)* | OK + + +## Replace Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified Ingress + +### HTTP Request + +`PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Ingress +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Ingress](#ingress-v1beta1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Ingress](#ingress-v1beta1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_ingresslist_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_ingresslist_v1beta1_concept.md index 9e2ec750b6..299114a699 100644 --- a/docs/api-reference/1_5/documents/_generated_ingresslist_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_ingresslist_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | IngressList +Core | v1beta1 | IngressList @@ -28,70 +28,4 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard object's metadat -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of Ingress - -### HTTP Request - -`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_ingresslist_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_ingresslist_v1beta1_definition.md index 2bbe6cc6d1..b2f5d47f25 100644 --- a/docs/api-reference/1_5/documents/_generated_ingresslist_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_ingresslist_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | IngressList +Core | v1beta1 | IngressList diff --git a/docs/api-reference/1_5/documents/_generated_ingressstatus_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_ingressstatus_v1beta1_concept.md index d64e83514e..72ed1a6634 100644 --- a/docs/api-reference/1_5/documents/_generated_ingressstatus_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_ingressstatus_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | IngressStatus +Core | v1beta1 | IngressStatus @@ -28,195 +28,4 @@ loadBalancer
*[LoadBalancerStatus](#loadbalancerstatus-v1)* | LoadBalanc -## Write Operations - -See supported operations below... - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified Ingress - -### HTTP Request - -`PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Ingress -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Ingress](#ingress-v1beta1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Ingress](#ingress-v1beta1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified Ingress - -### HTTP Request - -`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Ingress -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Ingress](#ingress-v1beta1)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified Ingress - -### HTTP Request - -`GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Ingress -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[Ingress](#ingress-v1beta1)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_ingressstatus_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_ingressstatus_v1beta1_definition.md index 6331749cf2..86c5fc2df8 100644 --- a/docs/api-reference/1_5/documents/_generated_ingressstatus_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_ingressstatus_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | IngressStatus +Core | v1beta1 | IngressStatus diff --git a/docs/api-reference/1_5/documents/_generated_job_v1_concept.md b/docs/api-reference/1_5/documents/_generated_job_v1_concept.md index 43484693d8..904a02b1de 100644 --- a/docs/api-reference/1_5/documents/_generated_job_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_job_v1_concept.md @@ -1140,67 +1140,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of Job - -### HTTP Request - -`GET /apis/batch/v1/watch/namespaces/{namespace}/jobs` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command diff --git a/docs/api-reference/1_5/documents/_generated_job_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_job_v1beta1_concept.md index 4f1b51a690..6a73521123 100644 --- a/docs/api-reference/1_5/documents/_generated_job_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_job_v1beta1_concept.md @@ -1092,6 +1092,67 @@ Code | Description 200
*[Event](#event-versioned)* | OK +## Watch List + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of Job + +### HTTP Request + +`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/jobs` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command @@ -1153,4 +1214,190 @@ Code | Description +## Status Operations + +See supported operations below... + +## Patch Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified Job + +### HTTP Request + +`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Job +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Job](#job-v1beta1)* | OK + + +## Read Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified Job + +### HTTP Request + +`GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Job +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[Job](#job-v1beta1)* | OK + + +## Replace Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified Job + +### HTTP Request + +`PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Job +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Job](#job-v1beta1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Job](#job-v1beta1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_job_v2alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_job_v2alpha1_concept.md index 9b86a32000..8f4d2fea8e 100644 --- a/docs/api-reference/1_5/documents/_generated_job_v2alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_job_v2alpha1_concept.md @@ -1092,67 +1092,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of Job - -### HTTP Request - -`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/jobs` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command @@ -1214,190 +1153,4 @@ Code | Description -## Status Operations - -See supported operations below... - -## Patch Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified Job - -### HTTP Request - -`PATCH /apis/batch/v2alpha1/namespaces/{namespace}/jobs/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Job -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Job](#job-v2alpha1)* | OK - - -## Read Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified Job - -### HTTP Request - -`GET /apis/batch/v2alpha1/namespaces/{namespace}/jobs/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Job -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[Job](#job-v2alpha1)* | OK - - -## Replace Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified Job - -### HTTP Request - -`PUT /apis/batch/v2alpha1/namespaces/{namespace}/jobs/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Job -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Job](#job-v2alpha1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Job](#job-v2alpha1)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_joblist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_joblist_v1_concept.md index e8522f804e..27e3d382e5 100644 --- a/docs/api-reference/1_5/documents/_generated_joblist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_joblist_v1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1 | JobList +Batch | v1 | JobList @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata Mo +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of Job + +### HTTP Request + +`GET /apis/batch/v1/watch/namespaces/{namespace}/jobs` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_joblist_v1_definition.md b/docs/api-reference/1_5/documents/_generated_joblist_v1_definition.md index 7b34e34cf7..1c4bff3079 100644 --- a/docs/api-reference/1_5/documents/_generated_joblist_v1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_joblist_v1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1 | JobList +Batch | v1 | JobList diff --git a/docs/api-reference/1_5/documents/_generated_joblist_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_joblist_v1beta1_concept.md index edc564375e..14466b13cd 100644 --- a/docs/api-reference/1_5/documents/_generated_joblist_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_joblist_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | JobList +Core | v1beta1 | JobList @@ -28,70 +28,4 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata Mo -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of Job - -### HTTP Request - -`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/jobs` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_joblist_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_joblist_v1beta1_definition.md index cad6613b84..caae13ec38 100644 --- a/docs/api-reference/1_5/documents/_generated_joblist_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_joblist_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | JobList +Core | v1beta1 | JobList diff --git a/docs/api-reference/1_5/documents/_generated_joblist_v2alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_joblist_v2alpha1_concept.md index c2e0f69f6b..4c8f385167 100644 --- a/docs/api-reference/1_5/documents/_generated_joblist_v2alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_joblist_v2alpha1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v2alpha1 | JobList +Batch | v2alpha1 | JobList @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata Mo +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of Job + +### HTTP Request + +`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/jobs` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_joblist_v2alpha1_definition.md b/docs/api-reference/1_5/documents/_generated_joblist_v2alpha1_definition.md index 5ebcfd1a5c..61a8f32c20 100644 --- a/docs/api-reference/1_5/documents/_generated_joblist_v2alpha1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_joblist_v2alpha1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v2alpha1 | JobList +Batch | v2alpha1 | JobList diff --git a/docs/api-reference/1_5/documents/_generated_jobstatus_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_jobstatus_v1beta1_concept.md index 858878030a..6d31facbaa 100644 --- a/docs/api-reference/1_5/documents/_generated_jobstatus_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_jobstatus_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | JobStatus +Core | v1beta1 | JobStatus @@ -33,195 +33,4 @@ succeeded
*integer* | Succeeded is the number of pods which reached Phas -## Write Operations - -See supported operations below... - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified Job - -### HTTP Request - -`PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Job -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Job](#job-v1beta1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Job](#job-v1beta1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified Job - -### HTTP Request - -`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Job -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Job](#job-v1beta1)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified Job - -### HTTP Request - -`GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Job -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[Job](#job-v1beta1)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_jobstatus_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_jobstatus_v1beta1_definition.md index bb566c813f..70a705e425 100644 --- a/docs/api-reference/1_5/documents/_generated_jobstatus_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_jobstatus_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | JobStatus +Core | v1beta1 | JobStatus diff --git a/docs/api-reference/1_5/documents/_generated_jobstatus_v2alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_jobstatus_v2alpha1_concept.md index c5d9a225c6..5c979bc821 100644 --- a/docs/api-reference/1_5/documents/_generated_jobstatus_v2alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_jobstatus_v2alpha1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v2alpha1 | JobStatus +Batch | v2alpha1 | JobStatus @@ -33,4 +33,195 @@ succeeded
*integer* | Succeeded is the number of pods which reached Phas +## Write Operations + +See supported operations below... + +## Replace + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified Job + +### HTTP Request + +`PUT /apis/batch/v2alpha1/namespaces/{namespace}/jobs/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Job +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Job](#job-v2alpha1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Job](#job-v2alpha1)* | OK + + +## Patch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified Job + +### HTTP Request + +`PATCH /apis/batch/v2alpha1/namespaces/{namespace}/jobs/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Job +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Job](#job-v2alpha1)* | OK + + + +## Read Operations + +See supported operations below... + +## Read + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified Job + +### HTTP Request + +`GET /apis/batch/v2alpha1/namespaces/{namespace}/jobs/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Job +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[Job](#job-v2alpha1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_jobstatus_v2alpha1_definition.md b/docs/api-reference/1_5/documents/_generated_jobstatus_v2alpha1_definition.md index c898bc3539..9b3702d200 100644 --- a/docs/api-reference/1_5/documents/_generated_jobstatus_v2alpha1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_jobstatus_v2alpha1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v2alpha1 | JobStatus +Batch | v2alpha1 | JobStatus diff --git a/docs/api-reference/1_5/documents/_generated_limitrange_v1_concept.md b/docs/api-reference/1_5/documents/_generated_limitrange_v1_concept.md index e110ffa7ed..01e08cd649 100644 --- a/docs/api-reference/1_5/documents/_generated_limitrange_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_limitrange_v1_concept.md @@ -620,6 +620,67 @@ Code | Description 200
*[Event](#event-versioned)* | OK +## Watch List + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of LimitRange + +### HTTP Request + +`GET /api/v1/watch/namespaces/{namespace}/limitranges` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command diff --git a/docs/api-reference/1_5/documents/_generated_limitrangelist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_limitrangelist_v1_concept.md index c422099e15..9e66bd28bb 100644 --- a/docs/api-reference/1_5/documents/_generated_limitrangelist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_limitrangelist_v1_concept.md @@ -28,70 +28,4 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of LimitRange - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/limitranges` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_namespace_v1_concept.md b/docs/api-reference/1_5/documents/_generated_namespace_v1_concept.md index e224d52800..4121d6104b 100644 --- a/docs/api-reference/1_5/documents/_generated_namespace_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_namespace_v1_concept.md @@ -562,65 +562,5 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of Namespace - -### HTTP Request - -`GET /api/v1/watch/namespaces` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - diff --git a/docs/api-reference/1_5/documents/_generated_namespacelist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_namespacelist_v1_concept.md index f02292c8d2..db1656a831 100644 --- a/docs/api-reference/1_5/documents/_generated_namespacelist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_namespacelist_v1_concept.md @@ -28,4 +28,69 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of Namespace + +### HTTP Request + +`GET /api/v1/watch/namespaces` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_networkpolicy_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_networkpolicy_v1beta1_concept.md index 83069faa61..a77aa0e978 100644 --- a/docs/api-reference/1_5/documents/_generated_networkpolicy_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_networkpolicy_v1beta1_concept.md @@ -621,67 +621,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of NetworkPolicy - -### HTTP Request - -`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command diff --git a/docs/api-reference/1_5/documents/_generated_networkpolicylist_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_networkpolicylist_v1beta1_concept.md index ed3eeaa240..4a144da98b 100644 --- a/docs/api-reference/1_5/documents/_generated_networkpolicylist_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_networkpolicylist_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1beta1 | NetworkPolicyList +Extensions | v1beta1 | NetworkPolicyList @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of NetworkPolicy + +### HTTP Request + +`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpolicies` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_networkpolicylist_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_networkpolicylist_v1beta1_definition.md index b85720ac6b..5563e67b52 100644 --- a/docs/api-reference/1_5/documents/_generated_networkpolicylist_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_networkpolicylist_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1beta1 | NetworkPolicyList +Extensions | v1beta1 | NetworkPolicyList diff --git a/docs/api-reference/1_5/documents/_generated_node_v1_concept.md b/docs/api-reference/1_5/documents/_generated_node_v1_concept.md index 4034070997..c2141c61ec 100644 --- a/docs/api-reference/1_5/documents/_generated_node_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_node_v1_concept.md @@ -635,189 +635,6 @@ Code | Description -## Status Operations - -See supported operations below... - -## Patch Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified Node - -### HTTP Request - -`PATCH /api/v1/nodes/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Node -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Node](#node-v1)* | OK - - -## Read Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified Node - -### HTTP Request - -`GET /api/v1/nodes/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Node -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[Node](#node-v1)* | OK - - -## Replace Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified Node - -### HTTP Request - -`PUT /api/v1/nodes/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Node -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Node](#node-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Node](#node-v1)* | OK - - - ## Proxy Operations See supported operations below... diff --git a/docs/api-reference/1_5/documents/_generated_nodestatus_v1_concept.md b/docs/api-reference/1_5/documents/_generated_nodestatus_v1_concept.md index c00b2ab43d..34438097b3 100644 --- a/docs/api-reference/1_5/documents/_generated_nodestatus_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_nodestatus_v1_concept.md @@ -37,4 +37,192 @@ volumesInUse
*string array* | List of attachable volumes in use (mounted +## Write Operations + +See supported operations below... + +## Replace + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified Node + +### HTTP Request + +`PUT /api/v1/nodes/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Node +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Node](#node-v1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Node](#node-v1)* | OK + + +## Patch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified Node + +### HTTP Request + +`PATCH /api/v1/nodes/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Node +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Node](#node-v1)* | OK + + + +## Read Operations + +See supported operations below... + +## Read + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified Node + +### HTTP Request + +`GET /api/v1/nodes/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Node +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[Node](#node-v1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_persistentvolume_v1_concept.md b/docs/api-reference/1_5/documents/_generated_persistentvolume_v1_concept.md index 1a6d4f5575..5778a0af10 100644 --- a/docs/api-reference/1_5/documents/_generated_persistentvolume_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_persistentvolume_v1_concept.md @@ -567,5 +567,248 @@ Code | Description 200
*[Event](#event-versioned)* | OK +## Watch List + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of PersistentVolume + +### HTTP Request + +`GET /api/v1/watch/persistentvolumes` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + +## Status Operations + +See supported operations below... + +## Patch Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified PersistentVolume + +### HTTP Request + +`PATCH /api/v1/persistentvolumes/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the PersistentVolume +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[PersistentVolume](#persistentvolume-v1)* | OK + + +## Read Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified PersistentVolume + +### HTTP Request + +`GET /api/v1/persistentvolumes/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the PersistentVolume +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[PersistentVolume](#persistentvolume-v1)* | OK + + +## Replace Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified PersistentVolume + +### HTTP Request + +`PUT /api/v1/persistentvolumes/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the PersistentVolume +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[PersistentVolume](#persistentvolume-v1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[PersistentVolume](#persistentvolume-v1)* | OK + + diff --git a/docs/api-reference/1_5/documents/_generated_persistentvolumeclaim_v1_concept.md b/docs/api-reference/1_5/documents/_generated_persistentvolumeclaim_v1_concept.md index 042f462858..b103b4e89c 100644 --- a/docs/api-reference/1_5/documents/_generated_persistentvolumeclaim_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_persistentvolumeclaim_v1_concept.md @@ -635,67 +635,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of PersistentVolumeClaim - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command diff --git a/docs/api-reference/1_5/documents/_generated_persistentvolumeclaimlist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_persistentvolumeclaimlist_v1_concept.md index a166d1139e..cca787d89f 100644 --- a/docs/api-reference/1_5/documents/_generated_persistentvolumeclaimlist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_persistentvolumeclaimlist_v1_concept.md @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of PersistentVolumeClaim + +### HTTP Request + +`GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_persistentvolumelist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_persistentvolumelist_v1_concept.md index a2f5546a32..2699818efb 100644 --- a/docs/api-reference/1_5/documents/_generated_persistentvolumelist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_persistentvolumelist_v1_concept.md @@ -28,69 +28,4 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of PersistentVolume - -### HTTP Request - -`GET /api/v1/watch/persistentvolumes` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_persistentvolumestatus_v1_concept.md b/docs/api-reference/1_5/documents/_generated_persistentvolumestatus_v1_concept.md index b9e495116c..59a2ff4f63 100644 --- a/docs/api-reference/1_5/documents/_generated_persistentvolumestatus_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_persistentvolumestatus_v1_concept.md @@ -30,192 +30,4 @@ reason
*string* | Reason is a brief CamelCase string that describes any -## Write Operations - -See supported operations below... - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified PersistentVolume - -### HTTP Request - -`PUT /api/v1/persistentvolumes/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the PersistentVolume -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[PersistentVolume](#persistentvolume-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[PersistentVolume](#persistentvolume-v1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified PersistentVolume - -### HTTP Request - -`PATCH /api/v1/persistentvolumes/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the PersistentVolume -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[PersistentVolume](#persistentvolume-v1)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified PersistentVolume - -### HTTP Request - -`GET /api/v1/persistentvolumes/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the PersistentVolume -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[PersistentVolume](#persistentvolume-v1)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_pod_v1_concept.md b/docs/api-reference/1_5/documents/_generated_pod_v1_concept.md index 90e4d57088..cccf6779bf 100644 --- a/docs/api-reference/1_5/documents/_generated_pod_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_pod_v1_concept.md @@ -1956,7 +1956,7 @@ timestamps | If true, add an RFC3339 or RFC3339Nano timestamp at the beginning Code | Description ------------ | ----------- -200
*[Pod](#pod-v1)* | OK +200
*string* | OK diff --git a/docs/api-reference/1_5/documents/_generated_podtemplate_v1_concept.md b/docs/api-reference/1_5/documents/_generated_podtemplate_v1_concept.md index 006b183820..8449d06e34 100644 --- a/docs/api-reference/1_5/documents/_generated_podtemplate_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_podtemplate_v1_concept.md @@ -621,67 +621,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of PodTemplate - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/podtemplates` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command diff --git a/docs/api-reference/1_5/documents/_generated_podtemplatelist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_podtemplatelist_v1_concept.md index 226b6a0e91..4d60bc9782 100644 --- a/docs/api-reference/1_5/documents/_generated_podtemplatelist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_podtemplatelist_v1_concept.md @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of PodTemplate + +### HTTP Request + +`GET /api/v1/watch/namespaces/{namespace}/podtemplates` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_replicaset_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_replicaset_v1beta1_concept.md index 9addd32868..7accf91269 100644 --- a/docs/api-reference/1_5/documents/_generated_replicaset_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_replicaset_v1beta1_concept.md @@ -808,192 +808,6 @@ Code | Description -## Status Operations - -See supported operations below... - -## Patch Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified ReplicaSet - -### HTTP Request - -`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ReplicaSet -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ReplicaSet](#replicaset-v1beta1)* | OK - - -## Read Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified ReplicaSet - -### HTTP Request - -`GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ReplicaSet -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[ReplicaSet](#replicaset-v1beta1)* | OK - - -## Replace Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified ReplicaSet - -### HTTP Request - -`PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ReplicaSet -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[ReplicaSet](#replicaset-v1beta1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ReplicaSet](#replicaset-v1beta1)* | OK - - - ## Misc Operations See supported operations below... diff --git a/docs/api-reference/1_5/documents/_generated_replicasetstatus_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_replicasetstatus_v1beta1_concept.md index 4a5141b767..e584470eed 100644 --- a/docs/api-reference/1_5/documents/_generated_replicasetstatus_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_replicasetstatus_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1beta1 | ReplicaSetStatus +Extensions | v1beta1 | ReplicaSetStatus @@ -33,4 +33,195 @@ replicas
*integer* | Replicas is the most recently oberved number of rep +## Write Operations + +See supported operations below... + +## Replace + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified ReplicaSet + +### HTTP Request + +`PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the ReplicaSet +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[ReplicaSet](#replicaset-v1beta1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[ReplicaSet](#replicaset-v1beta1)* | OK + + +## Patch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified ReplicaSet + +### HTTP Request + +`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the ReplicaSet +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[ReplicaSet](#replicaset-v1beta1)* | OK + + + +## Read Operations + +See supported operations below... + +## Read + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified ReplicaSet + +### HTTP Request + +`GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the ReplicaSet +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[ReplicaSet](#replicaset-v1beta1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_replicasetstatus_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_replicasetstatus_v1beta1_definition.md index 4e32fe55b2..4c1aea131e 100644 --- a/docs/api-reference/1_5/documents/_generated_replicasetstatus_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_replicasetstatus_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1beta1 | ReplicaSetStatus +Extensions | v1beta1 | ReplicaSetStatus diff --git a/docs/api-reference/1_5/documents/_generated_replicationcontroller_v1_concept.md b/docs/api-reference/1_5/documents/_generated_replicationcontroller_v1_concept.md index 4a00068db8..c46ec43906 100644 --- a/docs/api-reference/1_5/documents/_generated_replicationcontroller_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_replicationcontroller_v1_concept.md @@ -686,67 +686,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ReplicationController - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command @@ -808,190 +747,4 @@ Code | Description -## Status Operations - -See supported operations below... - -## Patch Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified ReplicationController - -### HTTP Request - -`PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ReplicationController -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ReplicationController](#replicationcontroller-v1)* | OK - - -## Read Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified ReplicationController - -### HTTP Request - -`GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ReplicationController -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[ReplicationController](#replicationcontroller-v1)* | OK - - -## Replace Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified ReplicationController - -### HTTP Request - -`PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ReplicationController -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[ReplicationController](#replicationcontroller-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ReplicationController](#replicationcontroller-v1)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_replicationcontrollerlist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_replicationcontrollerlist_v1_concept.md index b06c979221..65af725e63 100644 --- a/docs/api-reference/1_5/documents/_generated_replicationcontrollerlist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_replicationcontrollerlist_v1_concept.md @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of ReplicationController + +### HTTP Request + +`GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_replicationcontrollerstatus_v1_concept.md b/docs/api-reference/1_5/documents/_generated_replicationcontrollerstatus_v1_concept.md index 6a2c922cb6..828096ffa8 100644 --- a/docs/api-reference/1_5/documents/_generated_replicationcontrollerstatus_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_replicationcontrollerstatus_v1_concept.md @@ -33,4 +33,195 @@ replicas
*integer* | Replicas is the most recently oberved number of rep +## Write Operations + +See supported operations below... + +## Replace + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified ReplicationController + +### HTTP Request + +`PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the ReplicationController +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[ReplicationController](#replicationcontroller-v1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[ReplicationController](#replicationcontroller-v1)* | OK + + +## Patch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified ReplicationController + +### HTTP Request + +`PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the ReplicationController +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[ReplicationController](#replicationcontroller-v1)* | OK + + + +## Read Operations + +See supported operations below... + +## Read + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified ReplicationController + +### HTTP Request + +`GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the ReplicationController +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[ReplicationController](#replicationcontroller-v1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_resourcequota_v1_concept.md b/docs/api-reference/1_5/documents/_generated_resourcequota_v1_concept.md index 86d00ac62f..cf11107101 100644 --- a/docs/api-reference/1_5/documents/_generated_resourcequota_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_resourcequota_v1_concept.md @@ -632,67 +632,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ResourceQuota - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/resourcequotas` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command @@ -754,190 +693,4 @@ Code | Description -## Status Operations - -See supported operations below... - -## Patch Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified ResourceQuota - -### HTTP Request - -`PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ResourceQuota -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ResourceQuota](#resourcequota-v1)* | OK - - -## Read Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified ResourceQuota - -### HTTP Request - -`GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ResourceQuota -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[ResourceQuota](#resourcequota-v1)* | OK - - -## Replace Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified ResourceQuota - -### HTTP Request - -`PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the ResourceQuota -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[ResourceQuota](#resourcequota-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[ResourceQuota](#resourcequota-v1)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_resourcequotalist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_resourcequotalist_v1_concept.md index a059598249..d81526e571 100644 --- a/docs/api-reference/1_5/documents/_generated_resourcequotalist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_resourcequotalist_v1_concept.md @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of ResourceQuota + +### HTTP Request + +`GET /api/v1/watch/namespaces/{namespace}/resourcequotas` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_resourcequotastatus_v1_concept.md b/docs/api-reference/1_5/documents/_generated_resourcequotastatus_v1_concept.md index 862134d6eb..f8041f28cf 100644 --- a/docs/api-reference/1_5/documents/_generated_resourcequotastatus_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_resourcequotastatus_v1_concept.md @@ -29,4 +29,195 @@ used
*object* | Used is the current observed total usage of the resource +## Write Operations + +See supported operations below... + +## Replace + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified ResourceQuota + +### HTTP Request + +`PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the ResourceQuota +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[ResourceQuota](#resourcequota-v1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[ResourceQuota](#resourcequota-v1)* | OK + + +## Patch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified ResourceQuota + +### HTTP Request + +`PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the ResourceQuota +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[ResourceQuota](#resourcequota-v1)* | OK + + + +## Read Operations + +See supported operations below... + +## Read + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified ResourceQuota + +### HTTP Request + +`GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the ResourceQuota +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[ResourceQuota](#resourcequota-v1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_role_v1alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_role_v1alpha1_concept.md index 9287bda217..482eca1a65 100644 --- a/docs/api-reference/1_5/documents/_generated_role_v1alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_role_v1alpha1_concept.md @@ -605,67 +605,6 @@ Code | Description 200
*[Event](#event-versioned)* | OK -## Watch List - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of Role - -### HTTP Request - -`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command diff --git a/docs/api-reference/1_5/documents/_generated_rolelist_v1alpha1_concept.md b/docs/api-reference/1_5/documents/_generated_rolelist_v1alpha1_concept.md index e371149d08..c3e761995d 100644 --- a/docs/api-reference/1_5/documents/_generated_rolelist_v1alpha1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_rolelist_v1alpha1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1alpha1 | RoleList +RbacAuthorization | v1alpha1 | RoleList @@ -28,4 +28,70 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard object's metadat +## Read Operations + +See supported operations below... + +## Watch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of Role + +### HTTP Request + +`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_rolelist_v1alpha1_definition.md b/docs/api-reference/1_5/documents/_generated_rolelist_v1alpha1_definition.md index f98ba074fa..d346430bf6 100644 --- a/docs/api-reference/1_5/documents/_generated_rolelist_v1alpha1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_rolelist_v1alpha1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1alpha1 | RoleList +RbacAuthorization | v1alpha1 | RoleList diff --git a/docs/api-reference/1_5/documents/_generated_service_v1_concept.md b/docs/api-reference/1_5/documents/_generated_service_v1_concept.md index da096dcc72..538ce5c23e 100644 --- a/docs/api-reference/1_5/documents/_generated_service_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_service_v1_concept.md @@ -958,6 +958,67 @@ Code | Description 200
*[Event](#event-versioned)* | OK +## Watch List + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of Service + +### HTTP Request + +`GET /api/v1/watch/namespaces/{namespace}/services` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command @@ -1019,6 +1080,192 @@ Code | Description +## Status Operations + +See supported operations below... + +## Patch Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified Service + +### HTTP Request + +`PATCH /api/v1/namespaces/{namespace}/services/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Service +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Service](#service-v1)* | OK + + +## Read Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified Service + +### HTTP Request + +`GET /api/v1/namespaces/{namespace}/services/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Service +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[Service](#service-v1)* | OK + + +## Replace Status + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified Service + +### HTTP Request + +`PUT /api/v1/namespaces/{namespace}/services/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the Service +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Service](#service-v1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[Service](#service-v1)* | OK + + + ## Proxy Operations See supported operations below... diff --git a/docs/api-reference/1_5/documents/_generated_serviceaccount_v1_concept.md b/docs/api-reference/1_5/documents/_generated_serviceaccount_v1_concept.md index bee16df75c..4628297e7b 100644 --- a/docs/api-reference/1_5/documents/_generated_serviceaccount_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_serviceaccount_v1_concept.md @@ -612,6 +612,67 @@ Code | Description 200
*[Event](#event-versioned)* | OK +## Watch List + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of ServiceAccount + +### HTTP Request + +`GET /api/v1/watch/namespaces/{namespace}/serviceaccounts` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + ## Watch List All Namespaces >bdocs-tab:kubectl `kubectl` Command diff --git a/docs/api-reference/1_5/documents/_generated_serviceaccountlist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_serviceaccountlist_v1_concept.md index 2f0d05487d..7570b81ce2 100644 --- a/docs/api-reference/1_5/documents/_generated_serviceaccountlist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_serviceaccountlist_v1_concept.md @@ -28,70 +28,4 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ServiceAccount - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/serviceaccounts` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_servicelist_v1_concept.md b/docs/api-reference/1_5/documents/_generated_servicelist_v1_concept.md index d10bff0ca2..073232204f 100644 --- a/docs/api-reference/1_5/documents/_generated_servicelist_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_servicelist_v1_concept.md @@ -28,70 +28,4 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. M -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of Service - -### HTTP Request - -`GET /api/v1/watch/namespaces/{namespace}/services` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_servicestatus_v1_concept.md b/docs/api-reference/1_5/documents/_generated_servicestatus_v1_concept.md index 3ec4c5e23a..51aad575cc 100644 --- a/docs/api-reference/1_5/documents/_generated_servicestatus_v1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_servicestatus_v1_concept.md @@ -28,195 +28,4 @@ loadBalancer
*[LoadBalancerStatus](#loadbalancerstatus-v1)* | LoadBalanc -## Write Operations - -See supported operations below... - -## Replace - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified Service - -### HTTP Request - -`PUT /api/v1/namespaces/{namespace}/services/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Service -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Service](#service-v1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Service](#service-v1)* | OK - - -## Patch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified Service - -### HTTP Request - -`PATCH /api/v1/namespaces/{namespace}/services/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Service -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[Service](#service-v1)* | OK - - - -## Read Operations - -See supported operations below... - -## Read - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified Service - -### HTTP Request - -`GET /api/v1/namespaces/{namespace}/services/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the Service -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[Service](#service-v1)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_statefulset_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_statefulset_v1beta1_concept.md index 90d656875b..2bbd4875c9 100644 --- a/docs/api-reference/1_5/documents/_generated_statefulset_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_statefulset_v1beta1_concept.md @@ -699,190 +699,4 @@ Code | Description -## Status Operations - -See supported operations below... - -## Patch Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -partially update status of the specified StatefulSet - -### HTTP Request - -`PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the StatefulSet -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[Patch](#patch-unversioned)* | - -### Response - -Code | Description ------------- | ----------- -200
*[StatefulSet](#statefulset-v1beta1)* | OK - - -## Read Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -read status of the specified StatefulSet - -### HTTP Request - -`GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the StatefulSet -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - - -### Response - -Code | Description ------------- | ----------- -200
*[StatefulSet](#statefulset-v1beta1)* | OK - - -## Replace Status - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -replace status of the specified StatefulSet - -### HTTP Request - -`PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status` - -### Path Parameters - -Parameter | Description ------------- | ----------- -name | name of the StatefulSet -namespace | object name and auth scope, such as for teams and projects -pretty | If 'true', then the output is pretty printed. - -### Query Parameters - -Parameter | Description ------------- | ----------- -body
*[StatefulSet](#statefulset-v1beta1)* | - -### Response - -Code | Description ------------- | ----------- -200
*[StatefulSet](#statefulset-v1beta1)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_statefulsetstatus_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_statefulsetstatus_v1beta1_concept.md index b279ca2b2c..cd20a432f8 100644 --- a/docs/api-reference/1_5/documents/_generated_statefulsetstatus_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_statefulsetstatus_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1beta1 | StatefulSetStatus +Apps | v1beta1 | StatefulSetStatus @@ -29,4 +29,195 @@ replicas
*integer* | Replicas is the number of actual replicas. +## Write Operations + +See supported operations below... + +## Replace + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +replace status of the specified StatefulSet + +### HTTP Request + +`PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the StatefulSet +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[StatefulSet](#statefulset-v1beta1)* | + +### Response + +Code | Description +------------ | ----------- +200
*[StatefulSet](#statefulset-v1beta1)* | OK + + +## Patch + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +partially update status of the specified StatefulSet + +### HTTP Request + +`PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the StatefulSet +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + +### Query Parameters + +Parameter | Description +------------ | ----------- +body
*[Patch](#patch-unversioned)* | + +### Response + +Code | Description +------------ | ----------- +200
*[StatefulSet](#statefulset-v1beta1)* | OK + + + +## Read Operations + +See supported operations below... + +## Read + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +read status of the specified StatefulSet + +### HTTP Request + +`GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status` + +### Path Parameters + +Parameter | Description +------------ | ----------- +name | name of the StatefulSet +namespace | object name and auth scope, such as for teams and projects +pretty | If 'true', then the output is pretty printed. + + +### Response + +Code | Description +------------ | ----------- +200
*[StatefulSet](#statefulset-v1beta1)* | OK + + + diff --git a/docs/api-reference/1_5/documents/_generated_statefulsetstatus_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_statefulsetstatus_v1beta1_definition.md index 07b24606aa..d7633988be 100644 --- a/docs/api-reference/1_5/documents/_generated_statefulsetstatus_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_statefulsetstatus_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Core | v1beta1 | StatefulSetStatus +Apps | v1beta1 | StatefulSetStatus diff --git a/docs/api-reference/1_5/documents/_generated_storageclass_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_storageclass_v1beta1_concept.md index b2ecc9a083..de931c0a6b 100644 --- a/docs/api-reference/1_5/documents/_generated_storageclass_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_storageclass_v1beta1_concept.md @@ -546,5 +546,65 @@ Code | Description 200
*[Event](#event-versioned)* | OK +## Watch List + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of StorageClass + +### HTTP Request + +`GET /apis/storage.k8s.io/v1beta1/watch/storageclasses` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + diff --git a/docs/api-reference/1_5/documents/_generated_storageclasslist_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_storageclasslist_v1beta1_concept.md index 22a8071be0..9571c67b39 100644 --- a/docs/api-reference/1_5/documents/_generated_storageclasslist_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_storageclasslist_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Storage | v1beta1 | StorageClassList +Core | v1beta1 | StorageClassList @@ -28,69 +28,4 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata Mo -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of StorageClass - -### HTTP Request - -`GET /apis/storage.k8s.io/v1beta1/watch/storageclasses` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_storageclasslist_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_storageclasslist_v1beta1_definition.md index be271eeb45..3c759c12f6 100644 --- a/docs/api-reference/1_5/documents/_generated_storageclasslist_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_storageclasslist_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Storage | v1beta1 | StorageClassList +Core | v1beta1 | StorageClassList diff --git a/docs/api-reference/1_5/documents/_generated_thirdpartyresource_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_thirdpartyresource_v1beta1_concept.md index 1fc65321d2..228972a6c5 100644 --- a/docs/api-reference/1_5/documents/_generated_thirdpartyresource_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_thirdpartyresource_v1beta1_concept.md @@ -544,5 +544,65 @@ Code | Description 200
*[Event](#event-versioned)* | OK +## Watch List + +>bdocs-tab:kubectl `kubectl` Command + +```bdocs-tab:kubectl_shell + +Coming Soon + +``` + +>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) + +```bdocs-tab:curl_shell + +Coming Soon + +``` + +>bdocs-tab:kubectl Output + +```bdocs-tab:kubectl_json + +Coming Soon + +``` +>bdocs-tab:curl Response Body + +```bdocs-tab:curl_json + +Coming Soon + +``` + + + +watch individual changes to a list of ThirdPartyResource + +### HTTP Request + +`GET /apis/extensions/v1beta1/watch/thirdpartyresources` + +### Path Parameters + +Parameter | Description +------------ | ----------- +fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. +labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. +pretty | If 'true', then the output is pretty printed. +resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. +timeoutSeconds | Timeout for the list/watch call. +watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. + + +### Response + +Code | Description +------------ | ----------- +200
*[Event](#event-versioned)* | OK + + diff --git a/docs/api-reference/1_5/documents/_generated_thirdpartyresourcelist_v1beta1_concept.md b/docs/api-reference/1_5/documents/_generated_thirdpartyresourcelist_v1beta1_concept.md index 0efd801ee1..019691b0bc 100644 --- a/docs/api-reference/1_5/documents/_generated_thirdpartyresourcelist_v1beta1_concept.md +++ b/docs/api-reference/1_5/documents/_generated_thirdpartyresourcelist_v1beta1_concept.md @@ -7,7 +7,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | ThirdPartyResourceList +Core | v1beta1 | ThirdPartyResourceList @@ -28,69 +28,4 @@ metadata
*[ListMeta](#listmeta-unversioned)* | Standard list metadata. -## Read Operations - -See supported operations below... - -## Watch - ->bdocs-tab:kubectl `kubectl` Command - -```bdocs-tab:kubectl_shell - -Coming Soon - -``` - ->bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*) - -```bdocs-tab:curl_shell - -Coming Soon - -``` - ->bdocs-tab:kubectl Output - -```bdocs-tab:kubectl_json - -Coming Soon - -``` ->bdocs-tab:curl Response Body - -```bdocs-tab:curl_json - -Coming Soon - -``` - - - -watch individual changes to a list of ThirdPartyResource - -### HTTP Request - -`GET /apis/extensions/v1beta1/watch/thirdpartyresources` - -### Path Parameters - -Parameter | Description ------------- | ----------- -fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. -labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. -pretty | If 'true', then the output is pretty printed. -resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. -timeoutSeconds | Timeout for the list/watch call. -watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. - - -### Response - -Code | Description ------------- | ----------- -200
*[Event](#event-versioned)* | OK - - - diff --git a/docs/api-reference/1_5/documents/_generated_thirdpartyresourcelist_v1beta1_definition.md b/docs/api-reference/1_5/documents/_generated_thirdpartyresourcelist_v1beta1_definition.md index 304fca9c37..72822779cd 100644 --- a/docs/api-reference/1_5/documents/_generated_thirdpartyresourcelist_v1beta1_definition.md +++ b/docs/api-reference/1_5/documents/_generated_thirdpartyresourcelist_v1beta1_definition.md @@ -2,7 +2,7 @@ Group | Version | Kind ------------ | ---------- | ----------- -Extensions | v1beta1 | ThirdPartyResourceList +Core | v1beta1 | ThirdPartyResourceList diff --git a/docs/api-reference/1_5/documents/_meta.md b/docs/api-reference/1_5/documents/_meta.md index 1023ca4b3e..6436afb95d 100644 --- a/docs/api-reference/1_5/documents/_meta.md +++ b/docs/api-reference/1_5/documents/_meta.md @@ -1,6 +1,6 @@ # METADATA -These are responsible for configuring behavior of your other Resources within the Cluster. +Metadata resources are responsible for configuring behavior of your other Resources within the Cluster. Common resource types: diff --git a/docs/api-reference/1_5/documents/_oldversions.md b/docs/api-reference/1_5/documents/_oldversions.md index 85a2fc1f41..4f5580f837 100644 --- a/docs/api-reference/1_5/documents/_oldversions.md +++ b/docs/api-reference/1_5/documents/_oldversions.md @@ -1,3 +1,3 @@ # OLD API VERSIONS -These are older versions of Resources shown above. +This section contains older versions of resources shown above. diff --git a/docs/api-reference/1_5/documents/_overview.md b/docs/api-reference/1_5/documents/_overview.md index 9785b99569..82a4d09b24 100644 --- a/docs/api-reference/1_5/documents/_overview.md +++ b/docs/api-reference/1_5/documents/_overview.md @@ -1,21 +1,21 @@ # API OVERVIEW -Welcome to the Kubernetes API. You can use our API to access Kubernetes API endpoints to read and write Kubernetes -resource objects. +Welcome to the Kubernetes API. You can use the Kubernetes API to read +and write Kubernetes resource objects via a Kubernetes API endpoint. ## Resource Categories -This is a highlevel overview of the basic types of resources provide by the Kubernetes API and their primary functions. +This is a high-level overview of the basic types of resources provide by the Kubernetes API and their primary functions. -**Workloads** *Run your containers*: These are responsible for managing and running your containers on the cluster. +**Workloads** are objects you use to manage and run your containers on the cluster. -**Discovery & LB Resources** *Access your containers*: These are responsible for stitching your workloads together into an externally accessible Loadbalanced Service. +**Discovery & LB** resources are objects you use to "stitch" your workloads together into an externally accessible, load-balanced Service. -**Config & Storage Resources** *Inject initialization data into your containers*: These are responsible for injecting data into your applications and persisting data externally to your container. +**Config & Storage** resources are objects you use to inject initialization data into your applications, and to persist data that is external to your container. -**Cluster Resources** *Manage your cluster*: These are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators. +**Cluster** resources objects define how the cluster itself is configured; these are typically used only by cluster operators. -**Metadata Resources** *Configure resource meta behavior*: These are responsible for configuring behavior of your other Resources within the Cluster. +**Metadata** resources are objects you use to configure the behavior of other resources within the cluster, such as HorizontalPodAutoscaler for scaling workloads. ------------ diff --git a/docs/api-reference/1_5/documents/_servicediscovery.md b/docs/api-reference/1_5/documents/_servicediscovery.md index 2dc34e45a0..4499261a66 100644 --- a/docs/api-reference/1_5/documents/_servicediscovery.md +++ b/docs/api-reference/1_5/documents/_servicediscovery.md @@ -1,6 +1,6 @@ # DISCOVERY & LOAD BALANCING -These are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default, +Discovery and Load Balancing resources are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default, [Workloads](#workloads) are only accessible within the cluster, and they must be exposed externally using a either a *LoadBalancer* or *NodePort* [Service](#service-v1). For development, internally accessible Workloads can be accessed via proxy through the api master using the `kubectl proxy` command. diff --git a/docs/api-reference/1_5/documents/_workloads.md b/docs/api-reference/1_5/documents/_workloads.md index 752563d0dc..39d052ee98 100644 --- a/docs/api-reference/1_5/documents/_workloads.md +++ b/docs/api-reference/1_5/documents/_workloads.md @@ -1,6 +1,6 @@ # WORKLOADS -These are responsible for managing and running your containers on the cluster. [Containers](#container-v1) are created +Worloads resources are responsible for managing and running your containers on the cluster. [Containers](#container-v1) are created by Controllers through [Pods](#pod-v1). Pods run Containers and provide environmental dependencies such as shared or persistent storage [Volumes](#volume-v1) and [Configuration](#configmap-v1) or [Secret](#secret-v1) data injected into the container. diff --git a/docs/api-reference/1_5/index.html b/docs/api-reference/1_5/index.html index 37b7ab1209..1b30567349 100644 --- a/docs/api-reference/1_5/index.html +++ b/docs/api-reference/1_5/index.html @@ -11,19 +11,19 @@ - +
  • kubectl
  • curl

API OVERVIEW

-

Welcome to the Kubernetes API. You can use our API to access Kubernetes API endpoints to read and write Kubernetes -resource objects.

+

Welcome to the Kubernetes API. You can use the Kubernetes API to read +and write Kubernetes resource objects via a Kubernetes API endpoint.

Resource Categories

-

This is a highlevel overview of the basic types of resources provide by the Kubernetes API and their primary functions.

-

Workloads Run your containers: These are responsible for managing and running your containers on the cluster.

-

Discovery & LB Resources Access your containers: These are responsible for stitching your workloads together into an externally accessible Loadbalanced Service.

-

Config & Storage Resources Inject initialization data into your containers: These are responsible for injecting data into your applications and persisting data externally to your container.

-

Cluster Resources Manage your cluster: These are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators.

-

Metadata Resources Configure resource meta behavior: These are responsible for configuring behavior of your other Resources within the Cluster.

+

This is a high-level overview of the basic types of resources provide by the Kubernetes API and their primary functions.

+

Workloads are objects you use to manage and run your containers on the cluster.

+

Discovery & LB resources are objects you use to "stitch" your workloads together into an externally accessible, load-balanced Service.

+

Config & Storage resources are objects you use to inject initialization data into your applications, and to persist data that is external to your container.

+

Cluster resources objects define how the cluster itself is configured; these are typically used only by cluster operators.

+

Metadata resources are objects you use to configure the behavior of other resources within the cluster, such as HorizontalPodAutoscaler for scaling workloads.

Resource Objects

Resource objects typically have 3 components:

@@ -74,7 +74,7 @@ notes on specific resource objects for details.

Read / Write Status: Read or Update the Status for a resource object. The Status can only changed through these update operations.

WORKLOADS

-

These are responsible for managing and running your containers on the cluster. Containers are created +

Worloads resources are responsible for managing and running your containers on the cluster. Containers are created by Controllers through Pods. Pods run Containers and provide environmental dependencies such as shared or persistent storage Volumes and Configuration or Secret data injected into the container.

@@ -1149,88 +1149,6 @@ Appears In CronJob -

Watch List

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

watch individual changes to a list of CronJob

-

HTTP Request

-

GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSecondsTimeout for the list/watch call.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
Event		OK

Watch List All Namespaces

kubectl Command

@@ -2363,7 +2281,7 @@ $ curl -X GET http:// -

Watch List

+

Watch List

kubectl Command

@@ -2445,7 +2363,7 @@ $ curl -X GET http:// -

Watch List All Namespaces

+

Watch List All Namespaces

kubectl Command

@@ -2523,6 +2441,236 @@ $ curl -X GET http:// +

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified DaemonSet

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified DaemonSet

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified DaemonSet

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the DaemonSet
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
DaemonSet
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
DaemonSet		OK

Deployment v1beta1

@@ -2793,9 +2941,9 @@ Appears In DeploymentStrategy -

Write Operations

+

Write Operations

See supported operations below...

-

Create

+

Create

kubectl Command

@@ -2969,7 +3117,7 @@ spec: -

Replace

+

Replace

kubectl Command

@@ -3152,7 +3300,7 @@ spec: -

Patch

+

Patch

kubectl Command

@@ -3306,7 +3454,7 @@ $ curl -X PATCH -H 'Content-Type: application/strategic-Delete +

Delete

kubectl Command

@@ -3405,7 +3553,7 @@ orphanDependents: false -

Delete Collection

+

Delete Collection

kubectl Command

@@ -3498,9 +3646,9 @@ orphanDependents: false -

Read Operations

+

Read Operations

See supported operations below...

-

Read

+

Read

kubectl Command

@@ -3722,7 +3870,7 @@ $ curl -X GET http:// -

List

+

List

kubectl Command

@@ -4096,7 +4244,7 @@ $ kubectl get deployment -o json -

List All Namespaces

+

List All Namespaces

kubectl Command

@@ -4174,7 +4322,7 @@ $ kubectl get deployment -o json -

Watch

+

Watch

kubectl Command

@@ -4407,7 +4555,7 @@ $ kubectl get deployment deployment-example -

Watch List

+

Watch List

kubectl Command

@@ -4489,7 +4637,7 @@ $ kubectl get deployment deployment-example -

Watch List All Namespaces

+

Watch List All Namespaces

kubectl Command

@@ -4567,236 +4715,6 @@ $ kubectl get deployment deployment-example -

Status Operations

-

See supported operations below...

-

Patch Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

partially update status of the specified Deployment

-

HTTP Request

-

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

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Query Parameters

- - - - - - - - - - - - - -
ParameterDescription
body
Patch
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
Deployment		OK
-

Read Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

read status of the specified Deployment

-

HTTP Request

-

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

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
Deployment		OK
-

Replace Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

replace status of the specified Deployment

-

HTTP Request

-

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

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the Deployment
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Query Parameters

- - - - - - - - - - - - - -
ParameterDescription
body
Deployment
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
Deployment		OK

Misc Operations

See supported operations below...

Read Scale

@@ -5283,9 +5201,9 @@ Appears In Job -

Write Operations

+

Write Operations

See supported operations below...

-

Create

+

Create

kubectl Command

@@ -5444,7 +5362,7 @@ spec: -

Replace

+

Replace

kubectl Command

@@ -5525,7 +5443,7 @@ spec: -

Patch

+

Patch

kubectl Command

@@ -5606,7 +5524,7 @@ spec: -

Delete

+

Delete

kubectl Command

@@ -5705,7 +5623,7 @@ orphanDependents: false -

Delete Collection

+

Delete Collection

kubectl Command

@@ -5798,9 +5716,9 @@ orphanDependents: false -

Read Operations

+

Read Operations

See supported operations below...

-

Read

+

Read

kubectl Command

@@ -5996,7 +5914,7 @@ $ curl -X GET http:// -

List

+

List

kubectl Command

@@ -6216,7 +6134,7 @@ $ kubectl get job -o json -

List All Namespaces

+

List All Namespaces

kubectl Command

@@ -6294,7 +6212,7 @@ $ kubectl get job -o json -

Watch

+

Watch

kubectl Command

@@ -6501,89 +6419,7 @@ $ kubectl get job example-job Watch List -
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

watch individual changes to a list of Job

-

HTTP Request

-

GET /apis/batch/v1/watch/namespaces/{namespace}/jobs

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSecondsTimeout for the list/watch call.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
Event		OK
-

Watch List All Namespaces

+

Watch List All Namespaces

kubectl Command

@@ -6661,9 +6497,9 @@ $ kubectl get job example-job Status Operations +

Status Operations

See supported operations below...

-

Patch Status

+

Patch Status

kubectl Command

@@ -6744,7 +6580,7 @@ $ kubectl get job example-job Read Status +

Read Status

kubectl Command

@@ -6810,7 +6646,7 @@ $ kubectl get job example-job Replace Status +

Replace Status

kubectl Command

@@ -7116,9 +6952,9 @@ Appears In Pod -

Write Operations

+

Write Operations

See supported operations below...

-

Create

+

Create

kubectl Command

@@ -7195,7 +7031,7 @@ Appears In Pod -

Replace

+

Replace

kubectl Command

@@ -7276,7 +7112,7 @@ Appears In Pod -

Patch

+

Patch

kubectl Command

@@ -7357,7 +7193,7 @@ Appears In Pod -

Delete

+

Delete

kubectl Command

@@ -7446,7 +7282,7 @@ Appears In Pod -

Delete Collection

+

Delete Collection

kubectl Command

@@ -7539,9 +7375,9 @@ Appears In Pod -

Read Operations

+

Read Operations

See supported operations below...

-

Read

+

Read

kubectl Command

@@ -7626,7 +7462,7 @@ Appears In Pod -

List

+

List

kubectl Command

@@ -7719,7 +7555,7 @@ Appears In Pod -

List All Namespaces

+

List All Namespaces

kubectl Command

@@ -7797,7 +7633,7 @@ Appears In Pod -

Watch

+

Watch

kubectl Command

@@ -7883,7 +7719,7 @@ Appears In Pod -

Watch List All Namespaces

+

Watch List All Namespaces

kubectl Command

@@ -9279,7 +9115,7 @@ Appears In Pod -

Misc Operations

+

Misc Operations

See supported operations below...

Read Log

@@ -9374,7 +9210,7 @@ Appears In Pod -200
Pod +200
string OK @@ -9560,9 +9396,9 @@ Appears In ReplicaSet -

Write Operations

+

Write Operations

See supported operations below...

-

Create

+

Create

kubectl Command

@@ -9639,7 +9475,7 @@ Appears In ReplicaSet -

Replace

+

Replace

kubectl Command

@@ -9720,7 +9556,7 @@ Appears In ReplicaSet -

Patch

+

Patch

kubectl Command

@@ -9801,7 +9637,7 @@ Appears In ReplicaSet -

Delete

+

Delete

kubectl Command

@@ -9890,7 +9726,7 @@ Appears In ReplicaSet -

Delete Collection

+

Delete Collection

kubectl Command

@@ -9983,9 +9819,9 @@ Appears In ReplicaSet -

Read Operations

+

Read Operations

See supported operations below...

-

Read

+

Read

kubectl Command

@@ -10070,7 +9906,7 @@ Appears In ReplicaSet -

List

+

List

kubectl Command

@@ -10163,7 +9999,7 @@ Appears In ReplicaSet -

List All Namespaces

+

List All Namespaces

kubectl Command

@@ -10241,7 +10077,7 @@ Appears In ReplicaSet -

Watch

+

Watch

kubectl Command

@@ -10327,7 +10163,7 @@ Appears In ReplicaSet -

Watch List

+

Watch List

kubectl Command

@@ -10409,7 +10245,7 @@ Appears In ReplicaSet -

Watch List All Namespaces

+

Watch List All Namespaces

kubectl Command

@@ -10487,239 +10323,9 @@ Appears In ReplicaSet -

Status Operations

+

Misc Operations

See supported operations below...

-

Patch Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

partially update status of the specified ReplicaSet

-

HTTP Request

-

PATCH /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Query Parameters

- - - - - - - - - - - - - -
ParameterDescription
body
Patch
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
ReplicaSet		OK
-

Read Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

read status of the specified ReplicaSet

-

HTTP Request

-

GET /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
ReplicaSet		OK
-

Replace Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

replace status of the specified ReplicaSet

-

HTTP Request

-

PUT /apis/extensions/v1beta1/namespaces/{namespace}/replicasets/{name}/status

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the ReplicaSet
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Query Parameters

- - - - - - - - - - - - - -
ParameterDescription
body
ReplicaSet
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
ReplicaSet		OK
-

Misc Operations

-

See supported operations below...

-

Read Scale

+

Read Scale

kubectl Command

@@ -10785,7 +10391,7 @@ Appears In ReplicaSet -

Replace Scale

+

Replace Scale

kubectl Command

@@ -10866,7 +10472,7 @@ Appears In ReplicaSet -

Patch Scale

+

Patch Scale

kubectl Command

@@ -11128,9 +10734,9 @@ Appears In ReplicationController -

Write Operations

+

Write Operations

See supported operations below...

-

Create

+

Create

kubectl Command

@@ -11207,7 +10813,7 @@ Appears In ReplicationController -

Replace

+

Replace

kubectl Command

@@ -11288,7 +10894,7 @@ Appears In ReplicationController -

Patch

+

Patch

kubectl Command

@@ -11369,7 +10975,7 @@ Appears In ReplicationController -

Delete

+

Delete

kubectl Command

@@ -11458,7 +11064,7 @@ Appears In ReplicationController -

Delete Collection

+

Delete Collection

kubectl Command

@@ -11551,9 +11157,9 @@ Appears In ReplicationController -

Read Operations

+

Read Operations

See supported operations below...

-

Read

+

Read

kubectl Command

@@ -11638,7 +11244,7 @@ Appears In ReplicationController -

List

+

List

kubectl Command

@@ -11731,7 +11337,7 @@ Appears In ReplicationController -

List All Namespaces

+

List All Namespaces

kubectl Command

@@ -11809,7 +11415,7 @@ Appears In ReplicationController -

Watch

+

Watch

kubectl Command

@@ -11895,89 +11501,7 @@ Appears In ReplicationController -

Watch List

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

watch individual changes to a list of ReplicationController

-

HTTP Request

-

GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSecondsTimeout for the list/watch call.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
Event		OK
-

Watch List All Namespaces

+

Watch List All Namespaces

kubectl Command

@@ -12055,236 +11579,6 @@ Appears In ReplicationController -

Status Operations

-

See supported operations below...

-

Patch Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

partially update status of the specified ReplicationController

-

HTTP Request

-

PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the ReplicationController
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Query Parameters

- - - - - - - - - - - - - -
ParameterDescription
body
Patch
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
ReplicationController		OK
-

Read Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

read status of the specified ReplicationController

-

HTTP Request

-

GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the ReplicationController
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
ReplicationController		OK
-

Replace Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

replace status of the specified ReplicationController

-

HTTP Request

-

PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the ReplicationController
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Query Parameters

- - - - - - - - - - - - - -
ParameterDescription
body
ReplicationController
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
ReplicationController		OK

StatefulSet v1beta1

@@ -12409,9 +11703,9 @@ Appears In StatefulSet
-

Write Operations

+

Write Operations

See supported operations below...

-

Create

+

Create

kubectl Command

@@ -12488,7 +11782,7 @@ Appears In StatefulSet -

Replace

+

Replace

kubectl Command

@@ -12569,7 +11863,7 @@ Appears In StatefulSet -

Patch

+

Patch

kubectl Command

@@ -12650,7 +11944,7 @@ Appears In StatefulSet -

Delete

+

Delete

kubectl Command

@@ -12739,7 +12033,7 @@ Appears In StatefulSet -

Delete Collection

+

Delete Collection

kubectl Command

@@ -12832,9 +12126,9 @@ Appears In StatefulSet -

Read Operations

+

Read Operations

See supported operations below...

-

Read

+

Read

kubectl Command

@@ -12919,7 +12213,7 @@ Appears In StatefulSet -

List

+

List

kubectl Command

@@ -13012,7 +12306,7 @@ Appears In StatefulSet -

List All Namespaces

+

List All Namespaces

kubectl Command

@@ -13090,7 +12384,7 @@ Appears In StatefulSet -

Watch

+

Watch

kubectl Command

@@ -13176,7 +12470,7 @@ Appears In StatefulSet -

Watch List All Namespaces

+

Watch List All Namespaces

kubectl Command

@@ -13254,238 +12548,8 @@ Appears In StatefulSet -

Status Operations

-

See supported operations below...

-

Patch Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

partially update status of the specified StatefulSet

-

HTTP Request

-

PATCH /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Query Parameters

- - - - - - - - - - - - - -
ParameterDescription
body
Patch
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
StatefulSet		OK
-

Read Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

read status of the specified StatefulSet

-

HTTP Request

-

GET /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
StatefulSet		OK
-

Replace Status

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

replace status of the specified StatefulSet

-

HTTP Request

-

PUT /apis/apps/v1beta1/namespaces/{namespace}/statefulsets/{name}/status

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
namename of the StatefulSet
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
-

Query Parameters

- - - - - - - - - - - - - -
ParameterDescription
body
StatefulSet
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
StatefulSet		OK

DISCOVERY & LOAD BALANCING

-

These are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default, +

Discovery and Load Balancing resources are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default, Workloads are only accessible within the cluster, and they must be exposed externally using a either a LoadBalancer or NodePort Service. For development, internally accessible Workloads can be accessed via proxy through the api master using the kubectl proxy command.

@@ -13565,9 +12629,9 @@ Appears In EndpointsList -

Write Operations

+

Write Operations

See supported operations below...

-

Create

+

Create

kubectl Command

@@ -13644,7 +12708,7 @@ Appears In EndpointsList -

Replace

+

Replace

kubectl Command

@@ -13725,7 +12789,7 @@ Appears In EndpointsList -

Patch

+

Patch

kubectl Command

@@ -13806,7 +12870,7 @@ Appears In EndpointsList -

Delete

+

Delete

kubectl Command

@@ -13895,7 +12959,7 @@ Appears In EndpointsList -

Delete Collection

+

Delete Collection

kubectl Command

@@ -13988,9 +13052,9 @@ Appears In EndpointsList -

Read Operations

+

Read Operations

See supported operations below...

-

Read

+

Read

kubectl Command

@@ -14075,7 +13139,7 @@ Appears In EndpointsList -

List

+

List

kubectl Command

@@ -14168,7 +13232,7 @@ Appears In EndpointsList -

List All Namespaces

+

List All Namespaces

kubectl Command

@@ -14246,7 +13310,7 @@ Appears In EndpointsList -

Watch

+

Watch

kubectl Command

@@ -14332,89 +13396,7 @@ Appears In EndpointsList -

Watch List

-
-

kubectl Command

-
-

-Coming Soon
-
-
-

curl Command (requires kubectl proxy to be running)

-
-

-Coming Soon
-
-
-

Output

-
-

-Coming Soon
-
-
-

Response Body

-
-

-Coming Soon
-
-

watch individual changes to a list of Endpoints

-

HTTP Request

-

GET /api/v1/watch/namespaces/{namespace}/endpoints

-

Path Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ParameterDescription
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSecondsTimeout for the list/watch call.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
-

Response

- - - - - - - - - - - - - -
CodeDescription
200
Event		OK
-

Watch List All Namespaces

+

Watch List All Namespaces

kubectl Command

@@ -14599,9 +13581,9 @@ Appears In Ingress -

Write Operations

+

Write Operations

See supported operations below...

-

Create

+

Create

kubectl Command

@@ -14678,7 +13660,7 @@ Appears In Ingress -

Replace

+

Replace

kubectl Command

@@ -14759,7 +13741,7 @@ Appears In Ingress -

Patch

+

Patch

kubectl Command

@@ -14840,7 +13822,7 @@ Appears In Ingress -

Delete

+

Delete

kubectl Command

@@ -14929,7 +13911,7 @@ Appears In Ingress -

Delete Collection

+

Delete Collection

kubectl Command

@@ -15022,9 +14004,9 @@ Appears In Ingress -

Read Operations

+

Read Operations

See supported operations below...

-

Read

+

Read

kubectl Command

@@ -15109,7 +14091,7 @@ Appears In Ingress -

List

+

List

kubectl Command

@@ -15202,7 +14184,7 @@ Appears In Ingress -

List All Namespaces

+

List All Namespaces

kubectl Command

@@ -15280,7 +14262,7 @@ Appears In Ingress -

Watch

+

Watch

kubectl Command

@@ -15366,7 +14348,89 @@ Appears In Ingress -

Watch List All Namespaces

+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Ingress

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSecondsTimeout for the list/watch call.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Event		OK
+

Watch List All Namespaces

kubectl Command

@@ -15444,6 +14508,236 @@ Appears In Ingress +

Status Operations

+

See supported operations below...

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Ingress

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Ingress
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Ingress

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Ingress
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Ingress

+

HTTP Request

+

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

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Ingress
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Ingress
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Ingress		OK

Service v1

@@ -15627,9 +14921,9 @@ Appears In Service -

Write Operations

+

Write Operations

See supported operations below...

-

Create

+

Create

kubectl Command

@@ -15763,7 +15057,7 @@ spec: -

Replace

+

Replace

kubectl Command

@@ -15917,7 +15211,7 @@ spec: -

Patch

+

Patch

kubectl Command

@@ -16039,7 +15333,7 @@ $ curl -X PATCH -H 'Content-Type: application/strategic-Delete +

Delete

kubectl Command

@@ -16115,9 +15409,9 @@ orphanDependents: false -

Read Operations

+

Read Operations

See supported operations below...

-

Read

+

Read

kubectl Command

@@ -16277,7 +15571,7 @@ $ kubectl get service deployment- -

List

+

List

kubectl Command

@@ -16369,7 +15663,7 @@ $ kubectl get service -o json -

List All Namespaces

+

List All Namespaces

kubectl Command

@@ -16447,7 +15741,7 @@ $ kubectl get service -o json -

Watch

+

Watch

kubectl Command

@@ -16614,7 +15908,89 @@ $ kubectl get service deployment-example -

Watch List All Namespaces

+

Watch List

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

watch individual changes to a list of Service

+

HTTP Request

+

GET /api/v1/watch/namespaces/{namespace}/services

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
fieldSelectorA selector to restrict the list of returned objects by their fields. Defaults to everything.
labelSelectorA selector to restrict the list of returned objects by their labels. Defaults to everything.
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
resourceVersionWhen specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
timeoutSecondsTimeout for the list/watch call.
watchWatch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Event		OK
+

Watch List All Namespaces

kubectl Command

@@ -16692,9 +16068,239 @@ $ kubectl get service deployment-example -

Proxy Operations

+

Status Operations

See supported operations below...

-

Create Connect Proxy

+

Patch Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

partially update status of the specified Service

+

HTTP Request

+

PATCH /api/v1/namespaces/{namespace}/services/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Patch
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Service		OK
+

Read Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

read status of the specified Service

+

HTTP Request

+

GET /api/v1/namespaces/{namespace}/services/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Service		OK
+

Replace Status

+
+

kubectl Command

+
+

+Coming Soon
+
+
+

curl Command (requires kubectl proxy to be running)

+
+

+Coming Soon
+
+
+

Output

+
+

+Coming Soon
+
+
+

Response Body

+
+

+Coming Soon
+
+

replace status of the specified Service

+

HTTP Request

+

PUT /api/v1/namespaces/{namespace}/services/{name}/status

+

Path Parameters

+ + + + + + + + + + + + + + + + + + + + + +
ParameterDescription
namename of the Service
namespaceobject name and auth scope, such as for teams and projects
prettyIf 'true', then the output is pretty printed.
+

Query Parameters

+ + + + + + + + + + + + + +
ParameterDescription
body
Service
+

Response

+ + + + + + + + + + + + + +
CodeDescription
200
Service		OK
+

Proxy Operations

+

See supported operations below...

+

Create Connect Proxy

kubectl Command

@@ -16760,7 +16366,7 @@ $ kubectl get service deployment-example -

Create Connect Proxy Path

+

Create Connect Proxy Path

kubectl Command

@@ -16830,7 +16436,7 @@ $ kubectl get service deployment-example -

Create Proxy

+

Create Proxy

kubectl Command

@@ -16892,7 +16498,7 @@ $ kubectl get service deployment-example -

Create Proxy Path

+

Create Proxy Path

kubectl Command

@@ -16958,7 +16564,7 @@ $ kubectl get service deployment-example -

Delete Connect Proxy

+

Delete Connect Proxy

kubectl Command

@@ -17024,7 +16630,7 @@ $ kubectl get service deployment-example -

Delete Connect Proxy Path

+

Delete Connect Proxy Path

kubectl Command

@@ -17094,7 +16700,7 @@ $ kubectl get service deployment-example -

Delete Proxy

+

Delete Proxy

kubectl Command

@@ -17156,7 +16762,7 @@ $ kubectl get service deployment-example -

Delete Proxy Path

+

Delete Proxy Path

kubectl Command

@@ -17222,7 +16828,7 @@ $ kubectl get service deployment-example -

Get Connect Proxy

+

Get Connect Proxy

kubectl Command

@@ -17288,7 +16894,7 @@ $ kubectl get service deployment-example -

Get Connect Proxy Path

+

Get Connect Proxy Path

kubectl Command

@@ -17358,7 +16964,7 @@ $ kubectl get service deployment-example -

Get Proxy

+

Get Proxy

kubectl Command

@@ -17420,7 +17026,7 @@ $ kubectl get service deployment-example -

Get Proxy Path

+

Get Proxy Path

kubectl Command

@@ -17486,7 +17092,7 @@ $ kubectl get service deployment-example -

Head Connect Proxy

+

Head Connect Proxy

kubectl Command

@@ -17552,7 +17158,7 @@ $ kubectl get service deployment-example -

Head Connect Proxy Path

+

Head Connect Proxy Path

kubectl Command

@@ -17622,7 +17228,7 @@ $ kubectl get service deployment-example -

Replace Connect Proxy

+

Replace Connect Proxy

kubectl Command

@@ -17688,7 +17294,7 @@ $ kubectl get service deployment-example -

Replace Connect Proxy Path

+

Replace Connect Proxy Path

kubectl Command

@@ -17758,7 +17364,7 @@ $ kubectl get service deployment-example -

Replace Proxy

+

Replace Proxy

kubectl Command

@@ -17820,7 +17426,7 @@ $ kubectl get service deployment-example -

Replace Proxy Path

+

Replace Proxy Path

kubectl Command

@@ -17887,7 +17493,7 @@ $ kubectl get service deployment-example

CONFIG & STORAGE

-

These are responsible for injecting data into your applications and persisting data externally to your container.

+

Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container.

Common resource types: