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) {
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.
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 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.
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 ----
kubectlCommand
-Coming Soon
-
----
curlCommand (requireskubectl proxyto be running)
-Coming Soon
-
---Output
-
-Coming Soon
-
---Response Body
-
-Coming Soon
-
-watch individual changes to a list of CronJob
-GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs
| 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. | -
| Code | -Description | -
|---|---|
| 200 Event |
-OK | -
@@ -2363,7 +2281,7 @@ $ curl -X GET http:// -
kubectlCommandWatch List
+Watch List
@@ -2445,7 +2363,7 @@ $ curl -X GET http:// -
kubectlCommandWatch List All Namespaces
+Watch List All Namespaces
@@ -2523,6 +2441,236 @@ $ curl -X GET http:// +
kubectlCommandStatus Operations
+See supported operations below...
+Patch Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto 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}/statusPath 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+ Response
++ +
++ + + +Code +Description ++ + +200 +
DaemonSetOK +Read Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto 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}/statusPath 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 +
DaemonSetOK +Replace Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto 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}/statusPath 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+ Response
++ +
+ + + +Code +Description ++ + +200 +
DaemonSetOK +
Deployment v1beta1
@@ -2793,9 +2941,9 @@ Appears In DeploymentStrategy -Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -2969,7 +3117,7 @@ spec: -
kubectlCommandReplace
+Replace
@@ -3152,7 +3300,7 @@ spec: -
kubectlCommandPatch
+Patch
@@ -3306,7 +3454,7 @@ $ curl -X PATCH -H 'Content-Type: application/strategic-Delete +
kubectlCommandDelete
@@ -3405,7 +3553,7 @@ orphanDependents: false -
kubectlCommandDelete Collection
+Delete Collection
@@ -3498,9 +3646,9 @@ orphanDependents: false -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -3722,7 +3870,7 @@ $ curl -X GET http:// -
kubectlCommandList
+List
@@ -4096,7 +4244,7 @@ $ kubectl get deployment -o json -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -4174,7 +4322,7 @@ $ kubectl get deployment -o json -
kubectlCommandWatch
+Watch
@@ -4407,7 +4555,7 @@ $ kubectl get deployment deployment-example
kubectlCommand-Watch List
+Watch List
@@ -4489,7 +4637,7 @@ $ kubectl get deployment deployment-example
kubectlCommand-Watch List All Namespaces
+Watch List All Namespaces
@@ -4567,236 +4715,6 @@ $ kubectl get deployment deployment-example
kubectlCommand-Status Operations
-See supported operations below...
-Patch Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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- Response
-- -
-- - - -Code -Description -- - -200 -
DeploymentOK -Read Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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 -
DeploymentOK -Replace Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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- Response
-- -
- - - -Code -Description -- - -200 -
DeploymentOK -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
@@ -5444,7 +5362,7 @@ spec: -
kubectlCommandReplace
+Replace
@@ -5525,7 +5443,7 @@ spec: -
kubectlCommandPatch
+Patch
@@ -5606,7 +5524,7 @@ spec: -
kubectlCommandDelete
+Delete
@@ -5705,7 +5623,7 @@ orphanDependents: false -
kubectlCommandDelete Collection
+Delete Collection
@@ -5798,9 +5716,9 @@ orphanDependents: false -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -5996,7 +5914,7 @@ $ curl -X GET http:// -
kubectlCommandList
+List
@@ -6216,7 +6134,7 @@ $ kubectl get job -o json -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -6294,7 +6212,7 @@ $ kubectl get job -o json -
kubectlCommandWatch
+Watch
@@ -6501,89 +6419,7 @@ $ kubectl get job example-job Watch List -
kubectlCommand---
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/jobsPath 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 -
EventOK -Watch List All Namespaces
+Watch List All Namespaces
@@ -6661,9 +6497,9 @@ $ kubectl get job example-job Status Operations +
kubectlCommandStatus Operations
See supported operations below...
-Patch Status
+Patch Status
@@ -6744,7 +6580,7 @@ $ kubectl get job example-job Read Status +
kubectlCommandRead Status
@@ -6810,7 +6646,7 @@ $ kubectl get job example-job Replace Status +
kubectlCommandReplace Status
@@ -7116,9 +6952,9 @@ Appears In Pod -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -7195,7 +7031,7 @@ Appears In Pod -
kubectlCommandReplace
+Replace
@@ -7276,7 +7112,7 @@ Appears In Pod -
kubectlCommandPatch
+Patch
@@ -7357,7 +7193,7 @@ Appears In Pod -
kubectlCommandDelete
+Delete
@@ -7446,7 +7282,7 @@ Appears In Pod -
kubectlCommandDelete Collection
+Delete Collection
@@ -7539,9 +7375,9 @@ Appears In Pod -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -7626,7 +7462,7 @@ Appears In Pod -
kubectlCommandList
+List
@@ -7719,7 +7555,7 @@ Appears In Pod -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -7797,7 +7633,7 @@ Appears In Pod -
kubectlCommandWatch
+Watch
@@ -7883,7 +7719,7 @@ Appears In Pod -
kubectlCommandWatch List All Namespaces
+Watch List All Namespaces
@@ -9279,7 +9115,7 @@ Appears In Pod -
kubectlCommandMisc Operations
+Misc Operations
See supported operations below...
Read Log
@@ -9374,7 +9210,7 @@ Appears In Pod- @@ -9560,9 +9396,9 @@ Appears In ReplicaSet -200 +
Pod200
stringOK Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -9639,7 +9475,7 @@ Appears In ReplicaSet -
kubectlCommandReplace
+Replace
@@ -9720,7 +9556,7 @@ Appears In ReplicaSet -
kubectlCommandPatch
+Patch
@@ -9801,7 +9637,7 @@ Appears In ReplicaSet -
kubectlCommandDelete
+Delete
@@ -9890,7 +9726,7 @@ Appears In ReplicaSet -
kubectlCommandDelete Collection
+Delete Collection
@@ -9983,9 +9819,9 @@ Appears In ReplicaSet -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -10070,7 +9906,7 @@ Appears In ReplicaSet -
kubectlCommandList
+List
@@ -10163,7 +9999,7 @@ Appears In ReplicaSet -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -10241,7 +10077,7 @@ Appears In ReplicaSet -
kubectlCommandWatch
+Watch
@@ -10327,7 +10163,7 @@ Appears In ReplicaSet -
kubectlCommandWatch List
+Watch List
@@ -10409,7 +10245,7 @@ Appears In ReplicaSet -
kubectlCommandWatch List All Namespaces
+Watch List All Namespaces
@@ -10487,239 +10323,9 @@ Appears In ReplicaSet -
kubectlCommandStatus Operations
+Misc Operations
See supported operations below...
-Patch Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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- Response
-- -
-- - - -Code -Description -- - -200 -
ReplicaSetOK -Read Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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 -
ReplicaSetOK -Replace Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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- Response
-- -
-- - - -Code -Description -- - -200 -
ReplicaSetOK -Misc Operations
-See supported operations below...
-Read Scale
+Read Scale
@@ -10785,7 +10391,7 @@ Appears In ReplicaSet -
kubectlCommandReplace Scale
+Replace Scale
@@ -10866,7 +10472,7 @@ Appears In ReplicaSet -
kubectlCommandPatch Scale
+Patch Scale
@@ -11128,9 +10734,9 @@ Appears In ReplicationController -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -11207,7 +10813,7 @@ Appears In ReplicationController -
kubectlCommandReplace
+Replace
@@ -11288,7 +10894,7 @@ Appears In ReplicationController -
kubectlCommandPatch
+Patch
@@ -11369,7 +10975,7 @@ Appears In ReplicationController -
kubectlCommandDelete
+Delete
@@ -11458,7 +11064,7 @@ Appears In ReplicationController -
kubectlCommandDelete Collection
+Delete Collection
@@ -11551,9 +11157,9 @@ Appears In ReplicationController -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -11638,7 +11244,7 @@ Appears In ReplicationController -
kubectlCommandList
+List
@@ -11731,7 +11337,7 @@ Appears In ReplicationController -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -11809,7 +11415,7 @@ Appears In ReplicationController -
kubectlCommandWatch
+Watch
@@ -11895,89 +11501,7 @@ Appears In ReplicationController -
kubectlCommandWatch List
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/replicationcontrollersPath 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 -
EventOK -Watch List All Namespaces
+Watch List All Namespaces
@@ -12055,236 +11579,6 @@ Appears In ReplicationController -
kubectlCommandStatus Operations
-See supported operations below...
-Patch Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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- Response
-- -
-- - - -Code -Description -- - -200 -
ReplicationControllerOK -Read Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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 -
ReplicationControllerOK -Replace Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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- Response
-- -
- - - -Code -Description -- - -200 -
ReplicationControllerOK -
StatefulSet v1beta1
@@ -12409,9 +11703,9 @@ Appears In StatefulSet
-Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -12488,7 +11782,7 @@ Appears In StatefulSet -
kubectlCommandReplace
+Replace
@@ -12569,7 +11863,7 @@ Appears In StatefulSet -
kubectlCommandPatch
+Patch
@@ -12650,7 +11944,7 @@ Appears In StatefulSet -
kubectlCommandDelete
+Delete
@@ -12739,7 +12033,7 @@ Appears In StatefulSet -
kubectlCommandDelete Collection
+Delete Collection
@@ -12832,9 +12126,9 @@ Appears In StatefulSet -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -12919,7 +12213,7 @@ Appears In StatefulSet -
kubectlCommandList
+List
@@ -13012,7 +12306,7 @@ Appears In StatefulSet -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -13090,7 +12384,7 @@ Appears In StatefulSet -
kubectlCommandWatch
+Watch
@@ -13176,7 +12470,7 @@ Appears In StatefulSet -
kubectlCommandWatch List All Namespaces
+Watch List All Namespaces
@@ -13254,238 +12548,8 @@ Appears In StatefulSet -
kubectlCommandStatus Operations
-See supported operations below...
-Patch Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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- Response
-- -
-- - - -Code -Description -- - -200 -
StatefulSetOK -Read Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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 -
StatefulSetOK -Replace Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/statusPath 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- Response
-- -
- - - -Code -Description -- - -200 -
StatefulSetOK -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
@@ -13565,9 +12629,9 @@ Appears In EndpointsList -kubectl proxycommand.Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -13644,7 +12708,7 @@ Appears In EndpointsList -
kubectlCommandReplace
+Replace
@@ -13725,7 +12789,7 @@ Appears In EndpointsList -
kubectlCommandPatch
+Patch
@@ -13806,7 +12870,7 @@ Appears In EndpointsList -
kubectlCommandDelete
+Delete
@@ -13895,7 +12959,7 @@ Appears In EndpointsList -
kubectlCommandDelete Collection
+Delete Collection
@@ -13988,9 +13052,9 @@ Appears In EndpointsList -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -14075,7 +13139,7 @@ Appears In EndpointsList -
kubectlCommandList
+List
@@ -14168,7 +13232,7 @@ Appears In EndpointsList -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -14246,7 +13310,7 @@ Appears In EndpointsList -
kubectlCommandWatch
+Watch
@@ -14332,89 +13396,7 @@ Appears In EndpointsList -
kubectlCommandWatch List
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto 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}/endpointsPath 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 -
EventOK -Watch List All Namespaces
+Watch List All Namespaces
@@ -14599,9 +13581,9 @@ Appears In Ingress -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -14678,7 +13660,7 @@ Appears In Ingress -
kubectlCommandReplace
+Replace
@@ -14759,7 +13741,7 @@ Appears In Ingress -
kubectlCommandPatch
+Patch
@@ -14840,7 +13822,7 @@ Appears In Ingress -
kubectlCommandDelete
+Delete
@@ -14929,7 +13911,7 @@ Appears In Ingress -
kubectlCommandDelete Collection
+Delete Collection
@@ -15022,9 +14004,9 @@ Appears In Ingress -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -15109,7 +14091,7 @@ Appears In Ingress -
kubectlCommandList
+List
@@ -15202,7 +14184,7 @@ Appears In Ingress -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -15280,7 +14262,7 @@ Appears In Ingress -
kubectlCommandWatch
+Watch
@@ -15366,7 +14348,89 @@ Appears In Ingress -
kubectlCommandWatch List All Namespaces
+Watch List
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto 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}/ingressesPath 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 +
EventOK +Watch List All Namespaces
@@ -15444,6 +14508,236 @@ Appears In Ingress +
kubectlCommandStatus Operations
+See supported operations below...
+Patch Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto 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}/statusPath 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+ Response
++ +
++ + + +Code +Description ++ + +200 +
IngressOK +Read Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto 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}/statusPath 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 +
IngressOK +Replace Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto 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}/statusPath 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+ Response
++ +
+ + + +Code +Description ++ + +200 +
IngressOK +
Service v1
@@ -15627,9 +14921,9 @@ Appears In Service -Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -15763,7 +15057,7 @@ spec: -
kubectlCommandReplace
+Replace
@@ -15917,7 +15211,7 @@ spec: -
kubectlCommandPatch
+Patch
@@ -16039,7 +15333,7 @@ $ curl -X PATCH -H 'Content-Type: application/strategic-Delete +
kubectlCommandDelete
@@ -16115,9 +15409,9 @@ orphanDependents: false -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -16277,7 +15571,7 @@ $ kubectl get service deployment- -
kubectlCommandList
+List
@@ -16369,7 +15663,7 @@ $ kubectl get service -o json -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -16447,7 +15741,7 @@ $ kubectl get service -o json -
kubectlCommandWatch
+Watch
@@ -16614,7 +15908,89 @@ $ kubectl get service deployment-example -
kubectlCommandWatch List All Namespaces
+Watch List
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto 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}/servicesPath 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 +
EventOK +Watch List All Namespaces
@@ -16692,9 +16068,239 @@ $ kubectl get service deployment-example -
kubectlCommandProxy Operations
+Status Operations
See supported operations below...
-Create Connect Proxy
+Patch Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto 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}/statusPath 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+ Response
++ +
++ + + +Code +Description ++ + +200 +
ServiceOK +Read Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto 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}/statusPath 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 +
ServiceOK +Replace Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto 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}/statusPath 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+ Response
++ +
++ + + +Code +Description ++ + +200 +
ServiceOK +Proxy Operations
+See supported operations below...
+Create Connect Proxy
@@ -16760,7 +16366,7 @@ $ kubectl get service deployment-example -
kubectlCommandCreate Connect Proxy Path
+Create Connect Proxy Path
@@ -16830,7 +16436,7 @@ $ kubectl get service deployment-example -
kubectlCommandCreate Proxy
+Create Proxy
@@ -16892,7 +16498,7 @@ $ kubectl get service deployment-example -
kubectlCommandCreate Proxy Path
+Create Proxy Path
@@ -16958,7 +16564,7 @@ $ kubectl get service deployment-example -
kubectlCommandDelete Connect Proxy
+Delete Connect Proxy
@@ -17024,7 +16630,7 @@ $ kubectl get service deployment-example -
kubectlCommandDelete Connect Proxy Path
+Delete Connect Proxy Path
@@ -17094,7 +16700,7 @@ $ kubectl get service deployment-example -
kubectlCommandDelete Proxy
+Delete Proxy
@@ -17156,7 +16762,7 @@ $ kubectl get service deployment-example -
kubectlCommandDelete Proxy Path
+Delete Proxy Path
@@ -17222,7 +16828,7 @@ $ kubectl get service deployment-example -
kubectlCommandGet Connect Proxy
+Get Connect Proxy
@@ -17288,7 +16894,7 @@ $ kubectl get service deployment-example -
kubectlCommandGet Connect Proxy Path
+Get Connect Proxy Path
@@ -17358,7 +16964,7 @@ $ kubectl get service deployment-example -
kubectlCommandGet Proxy
+Get Proxy
@@ -17420,7 +17026,7 @@ $ kubectl get service deployment-example -
kubectlCommandGet Proxy Path
+Get Proxy Path
@@ -17486,7 +17092,7 @@ $ kubectl get service deployment-example -
kubectlCommandHead Connect Proxy
+Head Connect Proxy
@@ -17552,7 +17158,7 @@ $ kubectl get service deployment-example -
kubectlCommandHead Connect Proxy Path
+Head Connect Proxy Path
@@ -17622,7 +17228,7 @@ $ kubectl get service deployment-example -
kubectlCommandReplace Connect Proxy
+Replace Connect Proxy
@@ -17688,7 +17294,7 @@ $ kubectl get service deployment-example -
kubectlCommandReplace Connect Proxy Path
+Replace Connect Proxy Path
@@ -17758,7 +17364,7 @@ $ kubectl get service deployment-example -
kubectlCommandReplace Proxy
+Replace Proxy
@@ -17820,7 +17426,7 @@ $ kubectl get service deployment-example -
kubectlCommandReplace Proxy Path
+Replace Proxy Path
@@ -17887,7 +17493,7 @@ $ kubectl get service deployment-example
kubectlCommandCONFIG & 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:
- ConfigMaps for providing text key value pairs injected into the application through environment variables, command line arguments, or files
@@ -17954,9 +17560,9 @@ Appears In ConfigMapList -Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -18033,7 +17639,7 @@ Appears In ConfigMapList -
kubectlCommandReplace
+Replace
@@ -18114,7 +17720,7 @@ Appears In ConfigMapList -
kubectlCommandPatch
+Patch
@@ -18195,7 +17801,7 @@ Appears In ConfigMapList -
kubectlCommandDelete
+Delete
@@ -18284,7 +17890,7 @@ Appears In ConfigMapList -
kubectlCommandDelete Collection
+Delete Collection
@@ -18377,9 +17983,9 @@ Appears In ConfigMapList -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -18464,7 +18070,7 @@ Appears In ConfigMapList -
kubectlCommandList
+List
@@ -18557,7 +18163,7 @@ Appears In ConfigMapList -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -18635,7 +18241,7 @@ Appears In ConfigMapList -
kubectlCommandWatch
+Watch
@@ -18721,89 +18327,7 @@ Appears In ConfigMapList -
kubectlCommandWatch List
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -watch individual changes to a list of ConfigMap
-HTTP Request
--
GET /api/v1/watch/namespaces/{namespace}/configmapsPath 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 -
EventOK -Watch List All Namespaces
+Watch List All Namespaces
@@ -18948,9 +18472,9 @@ Appears In SecretList -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -19027,7 +18551,7 @@ Appears In SecretList -
kubectlCommandReplace
+Replace
@@ -19108,7 +18632,7 @@ Appears In SecretList -
kubectlCommandPatch
+Patch
@@ -19189,7 +18713,7 @@ Appears In SecretList -
kubectlCommandDelete
+Delete
@@ -19278,7 +18802,7 @@ Appears In SecretList -
kubectlCommandDelete Collection
+Delete Collection
@@ -19371,9 +18895,9 @@ Appears In SecretList -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -19458,7 +18982,7 @@ Appears In SecretList -
kubectlCommandList
+List
@@ -19551,7 +19075,7 @@ Appears In SecretList -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -19629,7 +19153,7 @@ Appears In SecretList -
kubectlCommandWatch
+Watch
@@ -19715,7 +19239,7 @@ Appears In SecretList -
kubectlCommandWatch List All Namespaces
+Watch List All Namespaces
@@ -19917,9 +19441,9 @@ Appears In PersistentVolumeClaim -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -19996,7 +19520,7 @@ Appears In PersistentVolumeClaim -
kubectlCommandReplace
+Replace
@@ -20077,7 +19601,7 @@ Appears In PersistentVolumeClaim -
kubectlCommandPatch
+Patch
@@ -20158,7 +19682,7 @@ Appears In PersistentVolumeClaim -
kubectlCommandDelete
+Delete
@@ -20247,7 +19771,7 @@ Appears In PersistentVolumeClaim -
kubectlCommandDelete Collection
+Delete Collection
@@ -20340,9 +19864,9 @@ Appears In PersistentVolumeClaim -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -20427,7 +19951,7 @@ Appears In PersistentVolumeClaim -
kubectlCommandList
+List
@@ -20520,7 +20044,7 @@ Appears In PersistentVolumeClaim -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -20598,7 +20122,7 @@ Appears In PersistentVolumeClaim -
kubectlCommandWatch
+Watch
@@ -20684,89 +20208,7 @@ Appears In PersistentVolumeClaim -
kubectlCommandWatch List
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -watch individual changes to a list of PersistentVolumeClaim
-HTTP Request
--
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaimsPath 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 -
EventOK -Watch List All Namespaces
+Watch List All Namespaces
@@ -20844,9 +20286,9 @@ Appears In PersistentVolumeClaim -
kubectlCommandStatus Operations
+Status Operations
See supported operations below...
-Patch Status
+Patch Status
@@ -20927,7 +20369,7 @@ Appears In PersistentVolumeClaim -
kubectlCommandRead Status
+Read Status
@@ -20993,7 +20435,7 @@ Appears In PersistentVolumeClaim -
kubectlCommandReplace Status
+Replace Status
@@ -21138,9 +20580,9 @@ Appears In StorageClassList -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -21213,7 +20655,7 @@ Appears In StorageClassList -
kubectlCommandReplace
+Replace
@@ -21290,7 +20732,7 @@ Appears In StorageClassList -
kubectlCommandPatch
+Patch
@@ -21367,7 +20809,7 @@ Appears In StorageClassList -
kubectlCommandDelete
+Delete
@@ -21452,7 +20894,7 @@ Appears In StorageClassList -
kubectlCommandDelete Collection
+Delete Collection
@@ -21541,9 +20983,9 @@ Appears In StorageClassList -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -21624,7 +21066,7 @@ Appears In StorageClassList -
kubectlCommandList
+List
@@ -21713,7 +21155,7 @@ Appears In StorageClassList -
kubectlCommandWatch
+Watch
@@ -21795,6 +21237,84 @@ Appears In StorageClassList +
kubectlCommandWatch List
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +watch individual changes to a list of StorageClass
+HTTP Request
++
GET /apis/storage.k8s.io/v1beta1/watch/storageclassesPath 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 +
EventOK +
Volume v1
@@ -21832,7 +21352,7 @@ Appears In PodSpec
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:
- HorizontalPodAutoscaler (HPA) for automatically scaling the replicacount of your workloads in response to load
@@ -21931,9 +21451,9 @@ Appears In EventList -Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -22010,7 +21530,7 @@ Appears In EventList -
kubectlCommandReplace
+Replace
@@ -22091,7 +21611,7 @@ Appears In EventList -
kubectlCommandPatch
+Patch
@@ -22172,7 +21692,7 @@ Appears In EventList -
kubectlCommandDelete
+Delete
@@ -22261,7 +21781,7 @@ Appears In EventList -
kubectlCommandDelete Collection
+Delete Collection
@@ -22354,9 +21874,9 @@ Appears In EventList -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -22441,7 +21961,7 @@ Appears In EventList -
kubectlCommandList
+List
@@ -22534,7 +22054,7 @@ Appears In EventList -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -22612,7 +22132,7 @@ Appears In EventList -
kubectlCommandWatch
+Watch
@@ -22698,89 +22218,7 @@ Appears In EventList -
kubectlCommandWatch List
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -watch individual changes to a list of Event
-HTTP Request
--
GET /api/v1/watch/namespaces/{namespace}/eventsPath 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 -
EventOK -Watch List All Namespaces
+Watch List All Namespaces
@@ -22935,9 +22373,9 @@ Appears In LimitRange -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -23014,7 +22452,7 @@ Appears In LimitRange -
kubectlCommandReplace
+Replace
@@ -23095,7 +22533,7 @@ Appears In LimitRange -
kubectlCommandPatch
+Patch
@@ -23176,7 +22614,7 @@ Appears In LimitRange -
kubectlCommandDelete
+Delete
@@ -23265,7 +22703,7 @@ Appears In LimitRange -
kubectlCommandDelete Collection
+Delete Collection
@@ -23358,9 +22796,9 @@ Appears In LimitRange -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -23445,7 +22883,7 @@ Appears In LimitRange -
kubectlCommandList
+List
@@ -23538,7 +22976,7 @@ Appears In LimitRange -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -23616,7 +23054,7 @@ Appears In LimitRange -
kubectlCommandWatch
+Watch
@@ -23702,7 +23140,89 @@ Appears In LimitRange -
kubectlCommandWatch List All Namespaces
+Watch List
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +watch individual changes to a list of LimitRange
+HTTP Request
++
GET /api/v1/watch/namespaces/{namespace}/limitrangesPath 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 +
EventOK +Watch List All Namespaces
@@ -23910,9 +23430,9 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -23989,7 +23509,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandReplace
+Replace
@@ -24070,7 +23590,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandPatch
+Patch
@@ -24151,7 +23671,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandDelete
+Delete
@@ -24240,7 +23760,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandDelete Collection
+Delete Collection
@@ -24333,9 +23853,9 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -24420,7 +23940,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandList
+List
@@ -24513,7 +24033,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -24591,7 +24111,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandWatch
+Watch
@@ -24677,7 +24197,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandWatch List All Namespaces
+Watch List All Namespaces
@@ -24836,9 +24356,9 @@ Appears In DaemonSetSpec Write Operations +
kubectlCommandWrite Operations
See supported operations below...
-Create
+Create
@@ -24915,7 +24435,7 @@ Appears In DaemonSetSpec Replace +
kubectlCommandReplace
@@ -24996,7 +24516,7 @@ Appears In DaemonSetSpec Patch +
kubectlCommandPatch
@@ -25077,7 +24597,7 @@ Appears In DaemonSetSpec Delete +
kubectlCommandDelete
@@ -25166,7 +24686,7 @@ Appears In DaemonSetSpec Delete Collection +
kubectlCommandDelete Collection
@@ -25259,9 +24779,9 @@ Appears In DaemonSetSpec Read Operations +
kubectlCommandRead Operations
See supported operations below...
-Read
+Read
@@ -25346,7 +24866,7 @@ Appears In DaemonSetSpec List +
kubectlCommandList
@@ -25439,7 +24959,7 @@ Appears In DaemonSetSpec List All Namespaces +
kubectlCommandList All Namespaces
@@ -25517,7 +25037,7 @@ Appears In DaemonSetSpec Watch +
kubectlCommandWatch
@@ -25603,89 +25123,7 @@ Appears In DaemonSetSpec Watch List -
kubectlCommand---
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -watch individual changes to a list of PodTemplate
-HTTP Request
--
GET /api/v1/watch/namespaces/{namespace}/podtemplatesPath 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 -
EventOK -Watch List All Namespaces
+Watch List All Namespaces
@@ -25886,9 +25324,9 @@ Appears In PodDisruptionBudget -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -25965,7 +25403,7 @@ Appears In PodDisruptionBudget -
kubectlCommandReplace
+Replace
@@ -26046,7 +25484,7 @@ Appears In PodDisruptionBudget -
kubectlCommandPatch
+Patch
@@ -26127,7 +25565,7 @@ Appears In PodDisruptionBudget -
kubectlCommandDelete
+Delete
@@ -26216,7 +25654,7 @@ Appears In PodDisruptionBudget -
kubectlCommandDelete Collection
+Delete Collection
@@ -26309,9 +25747,9 @@ Appears In PodDisruptionBudget -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -26396,7 +25834,7 @@ Appears In PodDisruptionBudget -
kubectlCommandList
+List
@@ -26489,7 +25927,7 @@ Appears In PodDisruptionBudget -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -26567,7 +26005,7 @@ Appears In PodDisruptionBudget -
kubectlCommandWatch
+Watch
@@ -26653,7 +26091,7 @@ Appears In PodDisruptionBudget -
kubectlCommandWatch List
+Watch List
@@ -26735,7 +26173,7 @@ Appears In PodDisruptionBudget -
kubectlCommandWatch List All Namespaces
+Watch List All Namespaces
@@ -26813,9 +26251,9 @@ Appears In PodDisruptionBudget -
kubectlCommandStatus Operations
+Status Operations
See supported operations below...
-Patch Status
+Patch Status
@@ -26896,7 +26334,7 @@ Appears In PodDisruptionBudget -
kubectlCommandRead Status
+Read Status
@@ -26962,7 +26400,7 @@ Appears In PodDisruptionBudget -
kubectlCommandReplace Status
+Replace Status
@@ -27106,9 +26544,9 @@ Appears In ThirdPartyResourceList -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -27181,7 +26619,7 @@ Appears In ThirdPartyResourceList -
kubectlCommandReplace
+Replace
@@ -27258,7 +26696,7 @@ Appears In ThirdPartyResourceList -
kubectlCommandPatch
+Patch
@@ -27335,7 +26773,7 @@ Appears In ThirdPartyResourceList -
kubectlCommandDelete
+Delete
@@ -27420,7 +26858,7 @@ Appears In ThirdPartyResourceList -
kubectlCommandDelete Collection
+Delete Collection
@@ -27509,9 +26947,9 @@ Appears In ThirdPartyResourceList -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -27592,7 +27030,7 @@ Appears In ThirdPartyResourceList -
kubectlCommandList
+List
@@ -27681,7 +27119,7 @@ Appears In ThirdPartyResourceList -
kubectlCommandWatch
+Watch
@@ -27763,8 +27201,86 @@ Appears In ThirdPartyResourceList +
kubectlCommandWatch List
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +watch individual changes to a list of ThirdPartyResource
+HTTP Request
++
GET /apis/extensions/v1beta1/watch/thirdpartyresourcesPath 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 +
EventOK +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.
Binding v1
@@ -27803,9 +27319,9 @@ Appears In ThirdPartyResourceList -Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -27986,9 +27502,9 @@ Appears In CertificateSigningReque -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -28061,7 +27577,7 @@ Appears In CertificateSigningReque -
kubectlCommandReplace
+Replace
@@ -28138,7 +27654,7 @@ Appears In CertificateSigningReque -
kubectlCommandPatch
+Patch
@@ -28215,7 +27731,7 @@ Appears In CertificateSigningReque -
kubectlCommandDelete
+Delete
@@ -28300,7 +27816,7 @@ Appears In CertificateSigningReque -
kubectlCommandDelete Collection
+Delete Collection
@@ -28389,9 +27905,9 @@ Appears In CertificateSigningReque -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -28472,7 +27988,7 @@ Appears In CertificateSigningReque -
kubectlCommandList
+List
@@ -28561,7 +28077,7 @@ Appears In CertificateSigningReque -
kubectlCommandWatch
+Watch
@@ -28643,152 +28159,6 @@ Appears In CertificateSigningReque -
kubectlCommandWatch List
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -watch individual changes to a list of CertificateSigningRequest
-HTTP Request
--
GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequestsPath 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 -
EventOK -Status Operations
-See supported operations below...
-Replace Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -replace status of the specified CertificateSigningRequest
-HTTP Request
--
PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}/statusPath Parameters
-- -
-- - - -Parameter -Description -- -body -
CertificateSigningRequest- - -name -name of the CertificateSigningRequest -- - -pretty -If 'true', then the output is pretty printed. -Response
-- -
- - - -Code -Description -- - -200 -
CertificateSigningRequestOK -
ClusterRole v1alpha1
@@ -28848,9 +28218,9 @@ Appears In ClusterRoleList
-Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -28923,7 +28293,7 @@ Appears In ClusterRoleList -
kubectlCommandReplace
+Replace
@@ -29000,7 +28370,7 @@ Appears In ClusterRoleList -
kubectlCommandPatch
+Patch
@@ -29077,7 +28447,7 @@ Appears In ClusterRoleList -
kubectlCommandDelete
+Delete
@@ -29162,7 +28532,7 @@ Appears In ClusterRoleList -
kubectlCommandDelete Collection
+Delete Collection
@@ -29251,9 +28621,9 @@ Appears In ClusterRoleList -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -29315,7 +28685,7 @@ Appears In ClusterRoleList -
kubectlCommandList
+List
@@ -29404,7 +28774,7 @@ Appears In ClusterRoleList -
kubectlCommandWatch
+Watch
@@ -29486,6 +28856,84 @@ Appears In ClusterRoleList +
kubectlCommandWatch List
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +watch individual changes to a list of ClusterRole
+HTTP Request
++
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolesPath 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 +
EventOK +
ClusterRoleBinding v1alpha1
@@ -29549,9 +28997,9 @@ Appears In ClusterRoleBindingList
-Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -29624,7 +29072,7 @@ Appears In ClusterRoleBindingList -
kubectlCommandReplace
+Replace
@@ -29701,7 +29149,7 @@ Appears In ClusterRoleBindingList -
kubectlCommandPatch
+Patch
@@ -29778,7 +29226,7 @@ Appears In ClusterRoleBindingList -
kubectlCommandDelete
+Delete
@@ -29863,7 +29311,7 @@ Appears In ClusterRoleBindingList -
kubectlCommandDelete Collection
+Delete Collection
@@ -29952,9 +29400,9 @@ Appears In ClusterRoleBindingList -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -30016,7 +29464,7 @@ Appears In ClusterRoleBindingList -
kubectlCommandList
+List
@@ -30105,7 +29553,7 @@ Appears In ClusterRoleBindingList -
kubectlCommandWatch
+Watch
@@ -30187,84 +29635,6 @@ Appears In ClusterRoleBindingList -
kubectlCommandWatch List
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -watch individual changes to a list of ClusterRoleBinding
-HTTP Request
--
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindingsPath 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 -
EventOK -
ComponentStatus v1
@@ -30324,9 +29694,9 @@ Appears In ComponentStatusList
-Read Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -30388,7 +29758,7 @@ Appears In ComponentStatusList -
kubectlCommandList
+List
@@ -30507,9 +29877,9 @@ Appears In ComponentStatusList -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -30674,9 +30044,9 @@ Appears In Namespace -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -30749,7 +30119,7 @@ Appears In Namespace -
kubectlCommandReplace
+Replace
@@ -30826,7 +30196,7 @@ Appears In Namespace -
kubectlCommandPatch
+Patch
@@ -30903,7 +30273,7 @@ Appears In Namespace -
kubectlCommandDelete
+Delete
@@ -30988,7 +30358,7 @@ Appears In Namespace -
kubectlCommandDelete Collection
+Delete Collection
@@ -31077,9 +30447,9 @@ Appears In Namespace -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -31160,7 +30530,7 @@ Appears In Namespace -
kubectlCommandList
+List
@@ -31249,7 +30619,7 @@ Appears In Namespace -
kubectlCommandWatch
+Watch
@@ -31331,84 +30701,6 @@ Appears In Namespace -
kubectlCommandWatch List
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -watch individual changes to a list of Namespace
-HTTP Request
--
GET /api/v1/watch/namespacesPath 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 -
EventOK -
Node v1
@@ -31556,9 +30848,9 @@ Appears In Node
-Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -31631,7 +30923,7 @@ Appears In Node -
kubectlCommandReplace
+Replace
@@ -31708,7 +31000,7 @@ Appears In Node -
kubectlCommandPatch
+Patch
@@ -31785,7 +31077,7 @@ Appears In Node -
kubectlCommandDelete
+Delete
@@ -31870,7 +31162,7 @@ Appears In Node -
kubectlCommandDelete Collection
+Delete Collection
@@ -31959,9 +31251,9 @@ Appears In Node -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -32042,7 +31334,7 @@ Appears In Node -
kubectlCommandList
+List
@@ -32131,7 +31423,7 @@ Appears In Node -
kubectlCommandWatch
+Watch
@@ -32213,7 +31505,7 @@ Appears In Node -
kubectlCommandWatch List
+Watch List
@@ -32291,227 +31583,9 @@ Appears In Node -
kubectlCommandStatus Operations
+Proxy Operations
See supported operations below...
-Patch Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -partially update status of the specified Node
-HTTP Request
--
PATCH /api/v1/nodes/{name}/statusPath Parameters
-- -
-- - - -Parameter -Description -- -name -name of the Node -- - -pretty -If 'true', then the output is pretty printed. -Query Parameters
-- -
-- - - -Parameter -Description -- - -body -
Patch- Response
-- -
-- - - -Code -Description -- - -200 -
NodeOK -Read Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -read status of the specified Node
-HTTP Request
--
GET /api/v1/nodes/{name}/statusPath Parameters
-- -
-- - - -Parameter -Description -- -name -name of the Node -- - -pretty -If 'true', then the output is pretty printed. -Response
-- -
-- - - -Code -Description -- - -200 -
NodeOK -Replace Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -replace status of the specified Node
-HTTP Request
--
PUT /api/v1/nodes/{name}/statusPath Parameters
-- -
-- - - -Parameter -Description -- -name -name of the Node -- - -pretty -If 'true', then the output is pretty printed. -Query Parameters
-- -
-- - - -Parameter -Description -- - -body -
Node- Response
-- -
-- - - -Code -Description -- - -200 -
NodeOK -Proxy Operations
-See supported operations below...
-Create Connect Proxy
+Create Connect Proxy
@@ -32573,7 +31647,7 @@ Appears In Node -
kubectlCommandCreate Connect Proxy Path
+Create Connect Proxy Path
@@ -32639,7 +31713,7 @@ Appears In Node -
kubectlCommandCreate Proxy
+Create Proxy
@@ -32697,7 +31771,7 @@ Appears In Node -
kubectlCommandCreate Proxy Path
+Create Proxy Path
@@ -32759,7 +31833,7 @@ Appears In Node -
kubectlCommandDelete Connect Proxy
+Delete Connect Proxy
@@ -32821,7 +31895,7 @@ Appears In Node -
kubectlCommandDelete Connect Proxy Path
+Delete Connect Proxy Path
@@ -32887,7 +31961,7 @@ Appears In Node -
kubectlCommandDelete Proxy
+Delete Proxy
@@ -32945,7 +32019,7 @@ Appears In Node -
kubectlCommandDelete Proxy Path
+Delete Proxy Path
@@ -33007,7 +32081,7 @@ Appears In Node -
kubectlCommandGet Connect Proxy
+Get Connect Proxy
@@ -33069,7 +32143,7 @@ Appears In Node -
kubectlCommandGet Connect Proxy Path
+Get Connect Proxy Path
@@ -33135,7 +32209,7 @@ Appears In Node -
kubectlCommandGet Proxy
+Get Proxy
@@ -33193,7 +32267,7 @@ Appears In Node -
kubectlCommandGet Proxy Path
+Get Proxy Path
@@ -33255,7 +32329,7 @@ Appears In Node -
kubectlCommandHead Connect Proxy
+Head Connect Proxy
@@ -33317,7 +32391,7 @@ Appears In Node -
kubectlCommandHead Connect Proxy Path
+Head Connect Proxy Path
@@ -33383,7 +32457,7 @@ Appears In Node -
kubectlCommandReplace Connect Proxy
+Replace Connect Proxy
@@ -33445,7 +32519,7 @@ Appears In Node -
kubectlCommandReplace Connect Proxy Path
+Replace Connect Proxy Path
@@ -33511,7 +32585,7 @@ Appears In Node -
kubectlCommandReplace Proxy
+Replace Proxy
@@ -33569,7 +32643,7 @@ Appears In Node -
kubectlCommandReplace Proxy Path
+Replace Proxy Path
@@ -33755,9 +32829,9 @@ Appears In PersistentVolume -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -33830,7 +32904,7 @@ Appears In PersistentVolume -
kubectlCommandReplace
+Replace
@@ -33907,7 +32981,7 @@ Appears In PersistentVolume -
kubectlCommandPatch
+Patch
@@ -33984,7 +33058,7 @@ Appears In PersistentVolume -
kubectlCommandDelete
+Delete
@@ -34069,7 +33143,7 @@ Appears In PersistentVolume -
kubectlCommandDelete Collection
+Delete Collection
@@ -34158,9 +33232,9 @@ Appears In PersistentVolume -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -34241,7 +33315,7 @@ Appears In PersistentVolume -
kubectlCommandList
+List
@@ -34330,7 +33404,7 @@ Appears In PersistentVolume -
kubectlCommandWatch
+Watch
@@ -34412,6 +33486,302 @@ Appears In PersistentVolume +
kubectlCommandWatch List
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +watch individual changes to a list of PersistentVolume
+HTTP Request
++
GET /api/v1/watch/persistentvolumesPath 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 +
EventOK +Status Operations
+See supported operations below...
+Patch Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +partially update status of the specified PersistentVolume
+HTTP Request
++
PATCH /api/v1/persistentvolumes/{name}/statusPath Parameters
++ +
++ + + +Parameter +Description ++ +name +name of the PersistentVolume ++ + +pretty +If 'true', then the output is pretty printed. +Query Parameters
++ +
++ + + +Parameter +Description ++ + +body +
Patch+ Response
++ +
++ + + +Code +Description ++ + +200 +
PersistentVolumeOK +Read Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +read status of the specified PersistentVolume
+HTTP Request
++
GET /api/v1/persistentvolumes/{name}/statusPath Parameters
++ +
++ + + +Parameter +Description ++ +name +name of the PersistentVolume ++ + +pretty +If 'true', then the output is pretty printed. +Response
++ +
++ + + +Code +Description ++ + +200 +
PersistentVolumeOK +Replace Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +replace status of the specified PersistentVolume
+HTTP Request
++
PUT /api/v1/persistentvolumes/{name}/statusPath Parameters
++ +
++ + + +Parameter +Description ++ +name +name of the PersistentVolume ++ + +pretty +If 'true', then the output is pretty printed. +Query Parameters
++ +
++ + + +Parameter +Description ++ + +body +
PersistentVolume+ Response
++ +
+ + + +Code +Description ++ + +200 +
PersistentVolumeOK +
ResourceQuota v1
@@ -34519,9 +33889,9 @@ Appears In ResourceQuota
-Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -34598,7 +33968,7 @@ Appears In ResourceQuota -
kubectlCommandReplace
+Replace
@@ -34679,7 +34049,7 @@ Appears In ResourceQuota -
kubectlCommandPatch
+Patch
@@ -34760,7 +34130,7 @@ Appears In ResourceQuota -
kubectlCommandDelete
+Delete
@@ -34849,7 +34219,7 @@ Appears In ResourceQuota -
kubectlCommandDelete Collection
+Delete Collection
@@ -34942,9 +34312,9 @@ Appears In ResourceQuota -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -35029,7 +34399,7 @@ Appears In ResourceQuota -
kubectlCommandList
+List
@@ -35122,7 +34492,7 @@ Appears In ResourceQuota -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -35200,7 +34570,7 @@ Appears In ResourceQuota -
kubectlCommandWatch
+Watch
@@ -35286,89 +34656,7 @@ Appears In ResourceQuota -
kubectlCommandWatch List
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -watch individual changes to a list of ResourceQuota
-HTTP Request
--
GET /api/v1/watch/namespaces/{namespace}/resourcequotasPath 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 -
EventOK -Watch List All Namespaces
+Watch List All Namespaces
@@ -35446,236 +34734,6 @@ Appears In ResourceQuota -
kubectlCommandStatus Operations
-See supported operations below...
-Patch Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -partially update status of the specified ResourceQuota
-HTTP Request
--
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/statusPath 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- Response
-- -
-- - - -Code -Description -- - -200 -
ResourceQuotaOK -Read Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -read status of the specified ResourceQuota
-HTTP Request
--
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/statusPath 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 -
ResourceQuotaOK -Replace Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -replace status of the specified ResourceQuota
-HTTP Request
--
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/statusPath 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- Response
-- -
- - - -Code -Description -- - -200 -
ResourceQuotaOK -
Role v1alpha1
@@ -35735,9 +34793,9 @@ Appears In RoleList
-Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -35814,7 +34872,7 @@ Appears In RoleList -
kubectlCommandReplace
+Replace
@@ -35895,7 +34953,7 @@ Appears In RoleList -
kubectlCommandPatch
+Patch
@@ -35976,7 +35034,7 @@ Appears In RoleList -
kubectlCommandDelete
+Delete
@@ -36065,7 +35123,7 @@ Appears In RoleList -
kubectlCommandDelete Collection
+Delete Collection
@@ -36158,9 +35216,9 @@ Appears In RoleList -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -36226,7 +35284,7 @@ Appears In RoleList -
kubectlCommandList
+List
@@ -36319,7 +35377,7 @@ Appears In RoleList -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -36397,7 +35455,7 @@ Appears In RoleList -
kubectlCommandWatch
+Watch
@@ -36483,89 +35541,7 @@ Appears In RoleList -
kubectlCommandWatch List
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -watch individual changes to a list of Role
-HTTP Request
--
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolesPath 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 -
EventOK -Watch List All Namespaces
+Watch List All Namespaces
@@ -36706,9 +35682,9 @@ Appears In RoleBindingList -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -36785,7 +35761,7 @@ Appears In RoleBindingList -
kubectlCommandReplace
+Replace
@@ -36866,7 +35842,7 @@ Appears In RoleBindingList -
kubectlCommandPatch
+Patch
@@ -36947,7 +35923,7 @@ Appears In RoleBindingList -
kubectlCommandDelete
+Delete
@@ -37036,7 +36012,7 @@ Appears In RoleBindingList -
kubectlCommandDelete Collection
+Delete Collection
@@ -37129,9 +36105,9 @@ Appears In RoleBindingList -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -37197,7 +36173,7 @@ Appears In RoleBindingList -
kubectlCommandList
+List
@@ -37290,7 +36266,7 @@ Appears In RoleBindingList -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -37368,7 +36344,7 @@ Appears In RoleBindingList -
kubectlCommandWatch
+Watch
@@ -37454,7 +36430,7 @@ Appears In RoleBindingList -
kubectlCommandWatch List
+Watch List
@@ -37536,7 +36512,7 @@ Appears In RoleBindingList -
kubectlCommandWatch List All Namespaces
+Watch List All Namespaces
@@ -37677,9 +36653,9 @@ Appears In SelfSubjectAccessReview -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -37804,9 +36780,9 @@ Appears In ServiceAccountList -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -37883,7 +36859,7 @@ Appears In ServiceAccountList -
kubectlCommandReplace
+Replace
@@ -37964,7 +36940,7 @@ Appears In ServiceAccountList -
kubectlCommandPatch
+Patch
@@ -38045,7 +37021,7 @@ Appears In ServiceAccountList -
kubectlCommandDelete
+Delete
@@ -38134,7 +37110,7 @@ Appears In ServiceAccountList -
kubectlCommandDelete Collection
+Delete Collection
@@ -38227,9 +37203,9 @@ Appears In ServiceAccountList -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -38314,7 +37290,7 @@ Appears In ServiceAccountList -
kubectlCommandList
+List
@@ -38407,7 +37383,7 @@ Appears In ServiceAccountList -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -38485,7 +37461,7 @@ Appears In ServiceAccountList -
kubectlCommandWatch
+Watch
@@ -38571,7 +37547,89 @@ Appears In ServiceAccountList -
kubectlCommandWatch List All Namespaces
+Watch List
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +watch individual changes to a list of ServiceAccount
+HTTP Request
++
GET /api/v1/watch/namespaces/{namespace}/serviceaccountsPath 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 +
EventOK +Watch List All Namespaces
@@ -38750,9 +37808,9 @@ Appears In LocalSubjectAccessReview< -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -38899,9 +37957,9 @@ Appears In TokenReview -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -39043,9 +38101,9 @@ Appears In NetworkPolicy -
kubectlCommandWrite Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -39122,7 +38180,7 @@ Appears In NetworkPolicy -
kubectlCommandReplace
+Replace
@@ -39203,7 +38261,7 @@ Appears In NetworkPolicy -
kubectlCommandPatch
+Patch
@@ -39284,7 +38342,7 @@ Appears In NetworkPolicy -
kubectlCommandDelete
+Delete
@@ -39373,7 +38431,7 @@ Appears In NetworkPolicy -
kubectlCommandDelete Collection
+Delete Collection
@@ -39466,9 +38524,9 @@ Appears In NetworkPolicy -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -39553,7 +38611,7 @@ Appears In NetworkPolicy -
kubectlCommandList
+List
@@ -39646,7 +38704,7 @@ Appears In NetworkPolicy -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -39724,7 +38782,7 @@ Appears In NetworkPolicy -
kubectlCommandWatch
+Watch
@@ -39810,89 +38868,7 @@ Appears In NetworkPolicy -
kubectlCommandWatch List
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -watch individual changes to a list of NetworkPolicy
-HTTP Request
--
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/networkpoliciesPath 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 -
EventOK -Watch List All Namespaces
+Watch List All Namespaces
@@ -39971,7 +38947,7 @@ Appears In NetworkPolicy
kubectlCommandDEFINITIONS
-These are Definitions for objects used by the above APIs
+This section contains definitions for objects used in the Kubernetes APIs.
APIGroup unversioned
@@ -43912,7 +42888,7 @@ Appears In Container
OLD API VERSIONS
-These are older versions of Resources shown above.
+This section contains older versions of resources shown above.
Event versioned
@@ -44083,9 +43059,9 @@ Appears In HorizontalPodAutoscaler
-Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -44162,7 +43138,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandReplace
+Replace
@@ -44243,7 +43219,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandPatch
+Patch
@@ -44324,7 +43300,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandDelete
+Delete
@@ -44413,7 +43389,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandDelete Collection
+Delete Collection
@@ -44506,9 +43482,9 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -44593,7 +43569,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandList
+List
@@ -44686,7 +43662,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -44764,7 +43740,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandWatch
+Watch
@@ -44850,7 +43826,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandWatch List
+Watch List
@@ -44932,7 +43908,7 @@ Appears In HorizontalPodAutoscaler -
kubectlCommandWatch List All Namespaces
+Watch List All Namespaces
@@ -45010,6 +43986,236 @@ Appears In HorizontalPodAutoscaler +
kubectlCommandStatus Operations
+See supported operations below...
+Patch Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +partially update status of the specified HorizontalPodAutoscaler
+HTTP Request
++
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/statusPath 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+ Response
++ +
++ + + +Code +Description ++ + +200 +
HorizontalPodAutoscalerOK +Read Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +read status of the specified HorizontalPodAutoscaler
+HTTP Request
++
GET /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/statusPath 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 +
HorizontalPodAutoscalerOK +Replace Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +replace status of the specified HorizontalPodAutoscaler
+HTTP Request
++
PUT /apis/extensions/v1beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/statusPath 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+ Response
++ +
+ + + +Code +Description ++ + +200 +
HorizontalPodAutoscalerOK +
Job v1beta1
@@ -45152,9 +44358,9 @@ Appears In Job
-Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -45313,7 +44519,7 @@ spec: -
kubectlCommandReplace
+Replace
@@ -45394,7 +44600,7 @@ spec: -
kubectlCommandPatch
+Patch
@@ -45475,7 +44681,7 @@ spec: -
kubectlCommandDelete
+Delete
@@ -45574,7 +44780,7 @@ orphanDependents: false -
kubectlCommandDelete Collection
+Delete Collection
@@ -45667,9 +44873,9 @@ orphanDependents: false -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -45865,7 +45071,7 @@ $ curl -X GET http:// -
kubectlCommandList
+List
@@ -46085,7 +45291,7 @@ $ kubectl get job -o json -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -46163,7 +45369,7 @@ $ kubectl get job -o json -
kubectlCommandWatch
+Watch
@@ -46370,7 +45576,89 @@ $ kubectl get job example-job Watch List All Namespaces +
kubectlCommandWatch List
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +watch individual changes to a list of Job
+HTTP Request
++
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/jobsPath 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 +
EventOK +Watch List All Namespaces
@@ -46448,6 +45736,236 @@ $ kubectl get job example-job Status Operations +
kubectlCommandSee supported operations below...
+Patch Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +partially update status of the specified Job
+HTTP Request
++
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/statusPath 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+ Response
++ +
++ + + +Code +Description ++ + +200 +
JobOK +Read Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +read status of the specified Job
+HTTP Request
++
GET /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/statusPath 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 +
JobOK +Replace Status
++++
kubectlCommand++Coming Soon ++++
curlCommand (requireskubectl proxyto be running)++Coming Soon +++Output
+++Coming Soon +++Response Body
+++Coming Soon +replace status of the specified Job
+HTTP Request
++
PUT /apis/extensions/v1beta1/namespaces/{namespace}/jobs/{name}/statusPath 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+ Response
++ +
+ + + +Code +Description ++ + +200 +
JobOK +
Job v2alpha1
@@ -46590,9 +46108,9 @@ Appears In Job
-Write Operations
+Write Operations
See supported operations below...
-Create
+Create
@@ -46751,7 +46269,7 @@ spec: -
kubectlCommandReplace
+Replace
@@ -46832,7 +46350,7 @@ spec: -
kubectlCommandPatch
+Patch
@@ -46913,7 +46431,7 @@ spec: -
kubectlCommandDelete
+Delete
@@ -47012,7 +46530,7 @@ orphanDependents: false -
kubectlCommandDelete Collection
+Delete Collection
@@ -47105,9 +46623,9 @@ orphanDependents: false -
kubectlCommandRead Operations
+Read Operations
See supported operations below...
-Read
+Read
@@ -47303,7 +46821,7 @@ $ curl -X GET http:// -
kubectlCommandList
+List
@@ -47523,7 +47041,7 @@ $ kubectl get job -o json -
kubectlCommandList All Namespaces
+List All Namespaces
@@ -47601,7 +47119,7 @@ $ kubectl get job -o json -
kubectlCommandWatch
+Watch
@@ -47808,89 +47326,7 @@ $ kubectl get job example-job Watch List -
kubectlCommand---
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -watch individual changes to a list of Job
-HTTP Request
--
GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/jobsPath 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 -
EventOK -Watch List All Namespaces
+Watch List All Namespaces
@@ -47968,236 +47404,6 @@ $ kubectl get job example-job Status Operations -
kubectlCommandSee supported operations below...
-Patch Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -partially update status of the specified Job
-HTTP Request
--
PATCH /apis/batch/v2alpha1/namespaces/{namespace}/jobs/{name}/statusPath 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- Response
-- -
-- - - -Code -Description -- - -200 -
JobOK -Read Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -read status of the specified Job
-HTTP Request
--
GET /apis/batch/v2alpha1/namespaces/{namespace}/jobs/{name}/statusPath 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 -
JobOK -Replace Status
----
kubectlCommand--Coming Soon ----
curlCommand (requireskubectl proxyto be running)--Coming Soon ---Output
---Coming Soon ---Response Body
---Coming Soon -replace status of the specified Job
-HTTP Request
--
PUT /apis/batch/v2alpha1/namespaces/{namespace}/jobs/{name}/statusPath 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- Response
-- -
- - - -Code -Description -- - -200 -
JobOK -
JobCondition v1beta1
APP MANAGEMENT
+This section contains commands for creating, updating, deleting, and +viewing your workloads in a Kubernetes cluster.
annotate
@@ -550,37 +555,43 @@ deployment (deploy), replicaset (rs)-kubectl annotate pods foo description-Update the annotations on one or more resources.
-An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human-readable, data. -It is intended to store non-identifying auxiliary data, especially data manipulated by tools and system extensions. -If --overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error. -If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
-Valid resource types include:
+Update the annotations on one or more resources.
-
+- clusters (valid only for federation apiservers)
-- componentstatuses (aka 'cs')
-- configmaps (aka 'cm')
-- daemonsets (aka 'ds')
-- deployments (aka 'deploy')
-- events (aka 'ev')
-- endpoints (aka 'ep')
-- horizontalpodautoscalers (aka 'hpa')
-- ingress (aka 'ing')
-- jobs
-- limitranges (aka 'limits')
-- nodes (aka 'no')
-- namespaces (aka 'ns')
-- petsets (alpha feature, may be unstable)
-- pods (aka 'po')
-- persistentvolumes (aka 'pv')
-- persistentvolumeclaims (aka 'pvc')
-- quota
-- resourcequotas (aka 'quota')
-- replicasets (aka 'rs')
-- replicationcontrollers (aka 'rc')
-- secrets
-- serviceaccounts (aka 'sa')
-- services (aka 'svc')
+- An annotation is a key/value pair that can hold larger (compared to a label), and possibly not human-readable, data.
+- It is intended to store non-identifying auxiliary data, especially data manipulated by tools and system extensions.
+- If --overwrite is true, then existing annotations can be overwritten, otherwise attempting to overwrite an annotation will result in an error.
+- If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
+Valid resource types include:
++
- clusters (valid only for federation apiservers)
+- componentstatuses (aka 'cs')
+- configmaps (aka 'cm')
+- daemonsets (aka 'ds')
+- deployments (aka 'deploy')
+- endpoints (aka 'ep')
+- events (aka 'ev')
+- horizontalpodautoscalers (aka 'hpa')
+- ingresses (aka 'ing')
+- jobs
+- limitranges (aka 'limits')
+- namespaces (aka 'ns')
+- networkpolicies
+- nodes (aka 'no')
+- persistentvolumeclaims (aka 'pvc')
+- persistentvolumes (aka 'pv')
+- pods (aka 'po')
+- podsecuritypolicies (aka 'psp')
+- podtemplates
+- replicasets (aka 'rs')
+- replicationcontrollers (aka 'rc')
+- resourcequotas (aka 'quota')
+- secrets
+- serviceaccounts (aka 'sa')
+- services (aka 'svc')
+- statefulsets
+- storageclasses
+- thirdpartyresources
Usage
@@ -711,9 +722,8 @@ If --resource-version is specified, then updates will use this resource version,
$ annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]-kubectl autoscale rc foo --max=5 --cpu-percent=80Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster.
-Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. -An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.
+Creates an autoscaler that automatically chooses and sets the number of pods that run in a kubernetes cluster.
+Looks up a Deployment, ReplicaSet, or ReplicationController by name and creates an autoscaler that uses the given resource as a reference. An autoscaler can automatically increase or decrease number of pods deployed within the system as needed.
Usage
$ autoscale (-f FILENAME | TYPE NAME | TYPE/NAME) [--min=MINPODS] --max=MAXPODS [--cpu-percent=CPU] [flags]Flags
@@ -854,13 +864,9 @@ An autoscaler can automatically increase or decrease number of pods deployed wit-kubectl convert -f . | kubectl create -f -Convert config files between different API versions. Both YAML -and JSON formats are accepted.
-The command takes filename, directory, or URL as input, and convert it into format -of version specified by --output-version flag. If target version is not specified or -not supported, convert to latest version.
-The default output will be printed to stdout in YAML format. One can use -o option -to change to output destination.
+Convert config files between different API versions. Both YAML and JSON formats are accepted.
+The command takes filename, directory, or URL as input, and convert it into format of version specified by --output-version flag. If target version is not specified or not supported, convert to latest version.
+The default output will be printed to stdout in YAML format. One can use -o option to change to output destination.
Usage
$ convert -f FILENAMEFlags
@@ -966,7 +972,12 @@ to change to output destination.-cat pod.json | kubectl create -f -Create a resource by filename or stdin.
+++Edit the data in docker-registry.yaml in JSON using the v1 API format then create the resource using the edited data.
++kubectl create -f docker-registry.yaml --edit --output-version=v1 -o json +Create a resource by filename or stdin.
JSON and YAML formats are accepted.
Usage
@@ -982,6 +993,18 @@ to change to output destination.
$ create -f FILENAME+ +dry-run ++ false +If true, only print the object that would be sent, without sending it. ++ +edit ++ false +Edit the API resource before creating +filename f [] @@ -994,10 +1017,22 @@ to change to output destination.If true, include definitions of new APIs via calls to the API server. [default true] + +no-headers ++ false +When using the default or custom-column output format, don't print headers. ++ output o - Output mode. Use "-o name" for shorter output (resource/name). +Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath]. ++ output-version ++ + Output the formatted object with the given group version (for ex: 'extensions/v1beta1'). record @@ -1024,11 +1059,41 @@ to change to output destination.If non-empty, load/store cached API schemas in this directory, default is '$HOME/.kube/schema' + +show-all +a +false +When printing, show all resources (default hide terminated pods.) ++ +show-labels ++ false +When printing, show all labels as the last column (default hide labels column) ++ +sort-by ++ + If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string. ++ +template ++ + Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. ++ validate true If true, use a schema to validate the input before sending it + windows-line-endings ++ false +Only relevant if --edit=true. Use Windows line-endings (default Unix line-endings) +
@@ -1048,13 +1113,10 @@ to change to output destination.
kubectl create configmap my-config --from-literal=key1=config1 --from-literal=key2=config2
-Create a configmap based on a file, directory, or specified literal value.
-A single configmap may package one or more key/value pairs.
-When creating a configmap based on a file, the key will default to the basename of the file, and the value will -default to the file content. If the basename is an invalid key, you may specify an alternate key.
-When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be -packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, -symlinks, devices, pipes, etc).
+Create a configmap based on a file, directory, or specified literal value.
+A single configmap may package one or more key/value pairs.
+When creating a configmap based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key, you may specify an alternate key.
+When creating a configmap based on a directory, each file whose basename is a valid key in the directory will be packaged into the configmap. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
$ configmap NAME [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]
// Create a new resourcequota named my-quota
-$ kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
-// Create a new resourcequota named best-effort
-$ kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort
+
+ Create a new resourcequota named my-quota
+
+$ kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
+
+
+ Create a new resourcequota named best-effort
+
+$ kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort
Create a resourcequota with the specified name, hard limits and optional scopes
Usage
@@ -1469,15 +1536,12 @@ $ kubectl create quota best-effort --hard=pods=100
kubectl create secret docker-registry my-secret --docker-server=DOCKER_REGISTRY_SERVER --docker-username=DOCKER_USER --docker-password=DOCKER_PASSWORD --docker-email=DOCKER_EMAIL
-Create a new secret for use with Docker registries.
-Dockercfg secrets are used to authenticate against Docker registries.
-When using the Docker command line to push images, you can authenticate to a given registry by running
- 'docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'.
-That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to
-authenticate to the registry.
-When creating applications, you may have a Docker registry that requires authentication. In order for the
-nodes to pull images on your behalf, they have to have the credentials. You can provide this information
-by creating a dockercfg secret and attaching it to your service account.
+Create a new secret for use with Docker registries.
+Dockercfg secrets are used to authenticate against Docker registries.
+When using the Docker command line to push images, you can authenticate to a given registry by running
+ $ docker login DOCKER_REGISTRY_SERVER --username=DOCKER_USER --password=DOCKER_PASSWORD --email=DOCKER_EMAIL'.
+That produces a ~/.dockercfg file that is used by subsequent 'docker push' and 'docker pull' commands to authenticate to the registry.
+When creating applications, you may have a Docker registry that requires authentication. In order for the nodes to pull images on your behalf, they have to have the credentials. You can provide this information by creating a dockercfg secret and attaching it to your service account.
Usage
$ docker-registry NAME --docker-username=user --docker-password=password --docker-email=email [--docker-server=string] [--from-literal=key1=value1] [--dry-run]
Flags
@@ -1612,13 +1676,10 @@ by creating a dockercfg secret and attaching it to your service account.
kubectl create secret generic my-secret --from-literal=key1=supersecret --from-literal=key2=topsecret
-Create a secret based on a file, directory, or specified literal value.
-A single secret may package one or more key/value pairs.
-When creating a secret based on a file, the key will default to the basename of the file, and the value will
-default to the file content. If the basename is an invalid key, you may specify an alternate key.
-When creating a secret based on a directory, each file whose basename is a valid key in the directory will be
-packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories,
-symlinks, devices, pipes, etc).
+Create a secret based on a file, directory, or specified literal value.
+A single secret may package one or more key/value pairs.
+When creating a secret based on a file, the key will default to the basename of the file, and the value will default to the file content. If the basename is an invalid key, you may specify an alternate key.
+When creating a secret based on a directory, each file whose basename is a valid key in the directory will be packaged into the secret. Any directory entries except regular files are ignored (e.g. subdirectories, symlinks, devices, pipes, etc).
Usage
$ generic NAME [--type=string] [--from-file=[key=]source] [--from-literal=key1=value1] [--dry-run]
Flags
@@ -1731,7 +1792,7 @@ symlinks, devices, pipes, etc).
kubectl create secret tls tls-secret --cert=path/to/tls.cert --key=path/to/tls.key
-Create a TLS secret from the given public/private key pair.
+Create a TLS secret from the given public/private key pair.
The public/private key pair must exist before hand. The public key certificate must be .PEM encoded and match the given private key.
Usage
$ tls NAME --cert=path/to/cert/file --key=path/to/key/file [--dry-run]
@@ -1952,7 +2013,7 @@ symlinks, devices, pipes, etc).
service loadbalancer
- Create a new nodeport service named my-lbs
+ Create a new LoadBalancer service named my-lbs
kubectl create service loadbalancer my-lbs --tcp=5678:8080
@@ -2281,11 +2342,16 @@ symlinks, devices, pipes, etc).
kubectl delete pods,services -l name=myLabel
- Delete a pod immediately (no graceful shutdown)
+ Delete a pod with minimal delay
kubectl delete pod foo --now
+ Force delete a pod on a dead node
+
+kubectl delete pod foo --grace-period=0 --force
+
+
Delete a pod with UID 1234-56-7890-234234-456456.
kubectl delete pod 1234-56-7890-234234-456456
@@ -2295,12 +2361,11 @@ symlinks, devices, pipes, etc).
kubectl delete pods --all
-Delete resources by filenames, stdin, resources and names, or by resources and label selector.
-JSON and YAML formats are accepted.
-Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector
-Note that the delete command does NOT do resource version checks, so if someone
-submits an update to a resource right when you submit a delete, their update
-will be lost along with the rest of the resource.
+Delete resources by filenames, stdin, resources and names, or by resources and label selector.
+JSON and YAML formats are accepted. Only one type of the arguments may be specified: filenames, resources and names, or resources and label selector.
+Some resources, such as pods, support graceful deletion. These resources define a default period before they are forcibly terminated (the grace period) but you may override that value with the --grace-period flag, or pass --now to set a grace-period of 1. Because these resources often represent entities in the cluster, deletion may not be acknowledged immediately. If the node hosting a pod is down or cannot reach the API server, termination may take significantly longer than the grace period. To force delete a resource, you must pass a grace period of 0 and specify the --force flag.
+IMPORTANT: Force deleting pods does not wait for confirmation that the pod's processes have been terminated, which can leave those processes running until the node detects the deletion and completes graceful deletion. If your processes use shared storage or talk to a remote API and depend on the name of the pod to identify themselves, force deleting those pods may result in multiple processes running on different machines using the same identification which may lead to data corruption or inconsistency. Only force delete pods when you are sure the pod is terminated, or if your application can tolerate multiple copies of the same pod running at once. Also, if you force delete pods the scheduler may place new pods on those nodes before the node has released those resources and causing those pods to be evicted immediately.
+Note that the delete command does NOT do resource version checks, so if someone submits an update to a resource right when you submit a delete, their update will be lost along with the rest of the resource.
Usage
$ delete ([-f FILENAME] | TYPE [(NAME | -l label | --all)])
Flags
@@ -2333,6 +2398,12 @@ will be lost along with the rest of the resource.
Filename, directory, or URL to files containing the resource to delete.
+force
+
+false
+Immediate deletion of some resources may result in inconsistency or data loss and requires confirmation.
+
+
grace-period
-1
@@ -2354,7 +2425,7 @@ will be lost along with the rest of the resource.
now
false
-If true, resources are force terminated without graceful deletion (same as --grace-period=0).
+If true, resources are signaled for immediate shutdown (same as --grace-period=1).
output
@@ -2399,22 +2470,10 @@ will be lost along with the rest of the resource.
kubectl edit svc/docker-registry --output-version=v1 -o json
-Edit a resource from the default editor.
-The edit command allows you to directly edit any API resource you can retrieve via the
-command line tools. It will open the editor defined by your KUBE_EDITOR, or EDITOR
-environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows.
-You can edit multiple objects, although changes are applied one at a time. The command
-accepts filenames as well as command line arguments, although the files you point to must
-be previously saved versions of resources.
-The files to edit will be output in the default API version, or a version specified
-by --output-version. The default format is YAML - if you would like to edit in JSON
-pass -o json. The flag --windows-line-endings can be used to force Windows line endings,
-otherwise the default for your operating system will be used.
-In the event an error occurs while updating, a temporary file will be created on disk
-that contains your unapplied changes. The most common error when updating a resource
-is another editor changing the resource on the server. When this occurs, you will have
-to apply your changes to the newer version of the resource, or update your temporary
-saved copy to include the latest resource version.
+Edit a resource from the default editor.
+The edit command allows you to directly edit any API resource you can retrieve via the command line tools. It will open the editor defined by your KUBE _EDITOR, or EDITOR environment variables, or fall back to 'vi' for Linux or 'notepad' for Windows. You can edit multiple objects, although changes are applied one at a time. The command accepts filenames as well as command line arguments, although the files you point to must be previously saved versions of resources.
+The files to edit will be output in the default API version, or a version specified by --output-version. The default format is YAML - if you would like to edit in JSON pass -o json. The flag --windows-line-endings can be used to force Windows line endings, otherwise the default for your operating system will be used.
+In the event an error occurs while updating, a temporary file will be created on disk that contains your unapplied changes. The most common error when updating a resource is another editor changing the resource on the server. When this occurs, you will have to apply your changes to the newer version of the resource, or update your temporary saved copy to include the latest resource version.
Usage
$ edit (RESOURCE/NAME | -f FILENAME)
Flags
@@ -2532,38 +2591,40 @@ saved copy to include the latest resource version.
kubectl get rc/web service/frontend pods/web-pod-13je7
-Display one or many resources.
-Valid resource types include:
+Display one or many resources.
+Valid resource types include:
-- clusters (valid only for federation apiservers)
-- componentstatuses (aka 'cs')
-- configmaps (aka 'cm')
-- daemonsets (aka 'ds')
-- deployments (aka 'deploy')
-- events (aka 'ev')
-- endpoints (aka 'ep')
-- horizontalpodautoscalers (aka 'hpa')
-- ingress (aka 'ing')
-- jobs
-- limitranges (aka 'limits')
-- nodes (aka 'no')
-- namespaces (aka 'ns')
-- petsets (alpha feature, may be unstable)
-- pods (aka 'po')
-- persistentvolumes (aka 'pv')
-- persistentvolumeclaims (aka 'pvc')
-- quota
-- resourcequotas (aka 'quota')
-- replicasets (aka 'rs')
-- replicationcontrollers (aka 'rc')
-- secrets
-- serviceaccounts (aka 'sa')
-- services (aka 'svc')
+- clusters (valid only for federation apiservers)
+- componentstatuses (aka 'cs')
+- configmaps (aka 'cm')
+- daemonsets (aka 'ds')
+- deployments (aka 'deploy')
+- endpoints (aka 'ep')
+- events (aka 'ev')
+- horizontalpodautoscalers (aka 'hpa')
+- ingresses (aka 'ing')
+- jobs
+- limitranges (aka 'limits')
+- namespaces (aka 'ns')
+- networkpolicies
+- nodes (aka 'no')
+- persistentvolumeclaims (aka 'pvc')
+- persistentvolumes (aka 'pv')
+- pods (aka 'po')
+- podsecuritypolicies (aka 'psp')
+- podtemplates
+- replicasets (aka 'rs')
+- replicationcontrollers (aka 'rc')
+- resourcequotas (aka 'quota')
+- secrets
+- serviceaccounts (aka 'sa')
+- services (aka 'svc')
+- statefulsets
+- storageclasses
+- thirdpartyresources
-This command will hide resources that have completed. For instance, pods that are in the Succeeded or Failed phases.
-You can see the full results for any resource by providing the '--show-all' flag.
-By specifying the output as 'template' and providing a Go template as the value
-of the --template flag, you can filter the attributes of the fetched resource(s).
+This command will hide resources that have completed. For instance, pods that are in the Succeeded or Failed phases. You can see the full results for any resource by providing the '--show-all' flag.
+By specifying the output as 'template' and providing a Go template as the value of the --template flag, you can filter the attributes of the fetched resource(s).
Usage
$ get [(-o|--output=)json|yaml|wide|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=...] (TYPE [NAME | -l label] | TYPE/NAME ...) [flags]
Flags
@@ -2719,10 +2780,12 @@ of the --template flag, you can filter the attributes of the fetched resource(s)
kubectl label pods foo bar-
-Update the labels on a resource.
-A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters.
-If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.
-If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
+Update the labels on a resource.
+
+- A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters.
+- If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.
+- If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
+
Usage
$ label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
Flags
@@ -2862,8 +2925,8 @@ If --resource-version is specified, then updates will use this resource version,
kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
-Update field(s) of a resource using strategic merge patch
-JSON and YAML formats are accepted.
+Update field(s) of a resource using strategic merge patch
+JSON and YAML formats are accepted.
Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.
Usage
$ patch (-f FILENAME | TYPE NAME) -p PATCH
@@ -2986,10 +3049,9 @@ If --resource-version is specified, then updates will use this resource version,
kubectl replace --force -f ./pod.json
-Replace a resource by filename or stdin.
-JSON and YAML formats are accepted. If replacing an existing resource, the
-complete resource spec must be provided. This can be obtained by
-$ kubectl get TYPE NAME -o yaml
+Replace a resource by filename or stdin.
+JSON and YAML formats are accepted. If replacing an existing resource, the complete resource spec must be provided. This can be obtained by
+ $ kubectl get TYPE NAME -o yaml
Please refer to the models in https://htmlpreview.github.io/?https://github.com/kubernetes/kubernetes/blob/HEAD/docs/api-reference/v1/definitions.html to find if a field is mutable.
Usage
$ replace -f FILENAME
@@ -3105,11 +3167,9 @@ $ kubectl get TYPE NAME -o yaml
kubectl rolling-update frontend-v1 frontend-v2 --rollback
-Perform a rolling update of the given ReplicationController.
-Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the
-new PodTemplate. The new-controller.json must specify the same namespace as the
-existing replication controller and overwrite at least one (common) label in its replicaSelector.
-
+Perform a rolling update of the given ReplicationController.
+Replaces the specified replication controller with a new replication controller by updating one pod at a time to use the new PodTemplate. The new-controller.json must specify the same namespace as the existing replication controller and overwrite at least one (common) label in its replicaSelector.
+! http://kubernetes.io/images/docs/kubectl_rollingupdate.svg
Usage
$ rolling-update OLD_CONTROLLER_NAME ([NEW_CONTROLLER_NAME] --image=NEW_CONTAINER_IMAGE | -f NEW_CONTROLLER_SPEC)
Flags
@@ -3308,10 +3368,8 @@ existing replication controller and overwrite at least one (common) label in its
kubectl rollout pause deployment/nginx
-Mark the provided resource as paused
-Paused resources will not be reconciled by a controller.
-Use \"kubectl rollout resume\" to resume a paused resource.
-Currently only deployments support being paused.
+Mark the provided resource as paused
+Paused resources will not be reconciled by a controller. Use \"kubectl rollout resume \" to resume a paused resource. Currently only deployments support being paused.
Usage
$ pause RESOURCE
Flags
@@ -3346,10 +3404,8 @@ Currently only deployments support being paused.
kubectl rollout resume deployment/nginx
-Resume a paused resource
-Paused resources will not be reconciled by a controller. By resuming a
-resource, we allow it to be reconciled again.
-Currently only deployments support being resumed.
+Resume a paused resource
+Paused resources will not be reconciled by a controller. By resuming a resource, we allow it to be reconciled again. Currently only deployments support being resumed.
Usage
$ resume RESOURCE
Flags
@@ -3384,13 +3440,8 @@ Currently only deployments support being resumed.
kubectl rollout status deployment/nginx
-Show the status of the rollout.
-By default 'rollout status' will watch the status of the latest rollout
-until it's done. If you don't want to wait for the rollout to finish then
-you can use --watch=false. Note that if a new rollout starts in-between, then
-'rollout status' will continue watching the latest revision. If you want to
-pin to a specific revision and abort if it is rolled over by another revision,
-use --revision=N where N is the revision you need to watch for.
+Show the status of the rollout.
+By default 'rollout status' will watch the status of the latest rollout until it's done. If you don't want to wait for the rollout to finish then you can use --watch=false. Note that if a new rollout starts in-between, then 'rollout status' will continue watching the latest revision. If you want to pin to a specific revision and abort if it is rolled over by another revision, use --revision=N where N is the revision you need to watch for.
Usage
$ status (TYPE NAME | TYPE/NAME) [flags]
Flags
@@ -3514,11 +3565,9 @@ use --revision=N where N is the revision you need to watch for.
kubectl scale --replicas=3 job/cron
-Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.
-Scale also allows users to specify one or more preconditions for the scale action.
-If --current-replicas or --resource-version is specified, it is validated before the
-scale is attempted, and it is guaranteed that the precondition holds true when the
-scale is sent to the server.
+Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.
+Scale also allows users to specify one or more preconditions for the scale action.
+If --current-replicas or --resource-version is specified, it is validated before the scale is attempted, and it is guaranteed that the precondition holds true when the scale is sent to the server.
Usage
$ scale [--resource-version=version] [--current-replicas=count] --replicas=COUNT (-f FILENAME | TYPE NAME)
Flags
@@ -3590,7 +3639,7 @@ scale is sent to the server.
set
-Configure application resources
+Configure application resources
These commands help you make changes to existing application resources.
Usage
$ set SUBCOMMAND
@@ -3616,9 +3665,9 @@ scale is sent to the server.
kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml
-Update existing container image(s) of resources.
-Possible resources include (case insensitive):
- pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs)
+Update existing container image(s) of resources.
+Possible resources include (case insensitive):
+ pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), job, replicaset (rs)
Usage
$ image (-f FILENAME | TYPE NAME) CONTAINER_NAME_1=CONTAINER_IMAGE_1 ... CONTAINER_NAME_N=CONTAINER_IMAGE_N
Flags
@@ -3715,7 +3764,7 @@ scale is sent to the server.
resources
- Set a deployments nginx container cpu limits to "200m and memory to "512Mi"
+ Set a deployments nginx container cpu limits to "200m" and memory to "512Mi"
kubectl set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi
@@ -3732,12 +3781,11 @@ scale is sent to the server.
Print the result (in yaml format) of updating nginx container limits from a local, without hitting the server
-kubectl set resources -f path/to/file.yaml --limits=cpu=200m,memory=512Mi --dry-run -o yaml
+kubectl set resources -f path/to/file.yaml --limits=cpu=200m,memory=512Mi --local -o yaml
-Specify compute resource requirements (cpu, memory) for any resource that defines a pod template. If a pod is successfully scheduled, it is guaranteed the amount of resource requested, but may burst up to its specified limits.
-for each compute resource, if a limit is specified and a request is omitted, the request will default to the limit.
-Possible resources include (case insensitive):
-replicationcontrollers, deployments, daemonsets, jobs, replicasets
+Specify compute resource requirements (cpu, memory) for any resource that defines a pod template. If a pod is successfully scheduled, it is guaranteed the amount of resource requested, but may burst up to its specified limits.
+for each compute resource, if a limit is specified and a request is omitted, the request will default to the limit.
+Possible resources include (case insensitive): replicationcontroller, deployment, daemonset, job, replicaset.
Usage
$ resources (-f FILENAME | TYPE NAME) ([--limits=LIMITS & --requests=REQUESTS]
Flags
@@ -3782,6 +3830,12 @@ replicationcontrollers, deployments, daemonsets, jobs, replicasets
The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.
+local
+
+false
+If true, set resources will NOT contact api-server but run locally.
+
+
no-headers
false
@@ -3862,10 +3916,18 @@ replicationcontrollers, deployments, daemonsets, jobs, replicasets
cat pod.json | kubectl apply -f -
-Apply a configuration to a resource by filename or stdin.
-This resource will be created if it doesn't exist yet.
-To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'.
-JSON and YAML formats are accepted.
+
+ Note: --prune is still in Alpha # Apply the configuration in manifest.yaml that matches label app=nginx and delete all the other resources that are not in the file and match label app=nginx.
+
+kubectl apply --prune -f manifest.yaml -l app=nginx
+
+
+ Apply the configuration in manifest.yaml and delete all the other configmaps that are not in the file.
+
+kubectl apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap
+
+Apply a configuration to a resource by filename or stdin. This resource will be created if it doesn't exist yet. To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'.
+JSON and YAML formats are accepted.
Alpha Disclaimer: the --prune functionality is not yet complete. Do not use unless you are aware of what the current state is. See https://issues.k8s.io/34274.
Usage
$ apply -f FILENAME
@@ -3890,7 +3952,13 @@ To use 'apply', always create the resource initially with either 'ap
cascade
true
-Only relevant during a prune. If true, cascade the deletion of the resources managed by pruned resources (e.g. Pods created by a ReplicationController).
+Only relevant during a prune or a force apply. If true, cascade the deletion of the resources managed by pruned or deleted resources (e.g. Pods created by a ReplicationController).
+
+
+dry-run
+
+false
+If true, only print the object that would be sent, without sending it.
filename
@@ -3899,10 +3967,16 @@ To use 'apply', always create the resource initially with either 'ap
Filename, directory, or URL to files that contains the configuration to apply
+force
+
+false
+Delete and re-create the specified resource, when PATCH encounters conflict and has retried for 5 times.
+
+
grace-period
-1
-Period of time in seconds given to pruned resources to terminate gracefully. Ignored if negative.
+Only relevant during a prune or a force apply. Period of time in seconds given to pruned or deleted resources to terminate gracefully. Ignored if negative.
include-extended-apis
@@ -3911,10 +3985,22 @@ To use 'apply', always create the resource initially with either 'ap
If true, include definitions of new APIs via calls to the API server. [default true]
+no-headers
+
+false
+When using the default or custom-column output format, don't print headers.
+
+
output
o
-Output mode. Use "-o name" for shorter output (resource/name).
+Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://kubernetes.io/docs/user-guide/jsonpath].
+
+
+output-version
+
+
+Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
overwrite
@@ -3926,7 +4012,13 @@ To use 'apply', always create the resource initially with either 'ap
prune
false
-Automatically delete resource objects that do not appear in the configs
+Automatically delete resource objects that do not appear in the configs and are created by either apply or create --save-config. Should be used with either -l or --all.
+
+
+prune-whitelist
+
+[]
+Overwrite the default whitelist with for --prune
record
@@ -3953,6 +4045,36 @@ To use 'apply', always create the resource initially with either 'ap
Selector (label query) to filter on
+show-all
+a
+false
+When printing, show all resources (default hide terminated pods.)
+
+
+show-labels
+
+false
+When printing, show all labels as the last column (default hide labels column)
+
+
+sort-by
+
+
+If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
+
+
+template
+
+
+Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
+
+
+timeout
+
+0s
+Only relevant during a force apply. The length of time to wait before giving up on a delete of the old resource, zero means determine a timeout from the size of the object. Any other values should contain a corresponding time unit (e.g. 1s, 2m, 3h).
+
+
validate
true
@@ -3960,7 +4082,14 @@ To use 'apply', always create the resource initially with either 'ap
-TROUBLESHOOTING AND DEBUGGING
+WORKING WITH APPS
+This section contains commands for inspecting and debugging your
+applications.
+
+logs will print the logs from the specified pod + container.
+exec can be used to get an interactive shell on a pod + container.
+describe will print debug information about the given resource.
+
attach
@@ -4013,6 +4142,50 @@ To use 'apply', always create the resource initially with either 'ap
+cp
+
+ !!!Important Note!!! # Requires that the 'tar' binary is present in your container # image. If 'tar' is not present, 'kubectl cp' will fail. # Copy /tmp/foo_dir local directory to /tmp/bar_dir in a remote pod in the default namespace
+
+kubectl cp /tmp/foo_dir <some-pod>:/tmp/bar_dir
+
+
+ Copy /tmp/foo local file to /tmp/bar in a remote pod in a specific container
+
+kubectl cp /tmp/foo <some-pod>:/tmp/bar -c <specific-container>
+
+
+ Copy /tmp/foo local file to /tmp/bar in a remote pod in namespace
+
+kubectl cp /tmp/foo <some-namespace>/<some-pod>:/tmp/bar
+
+
+ Copy /tmp/foo from a remote pod to /tmp/bar locally
+
+kubectl cp <some-namespace>/<some-pod>:/tmp/foo /tmp/bar
+
+Copy files and directories to and from containers.
+Usage
+$ cp <file-spec-src> <file-spec-dest>
+Flags
+
+
+
+Name
+Shorthand
+Default
+Usage
+
+
+
+
+container
+c
+
+Container name. If omitted, the first container in the pod will be chosen
+
+
+
+
describe
Describe a node
@@ -4044,38 +4217,39 @@ To use 'apply', always create the resource initially with either 'ap
kubectl describe pods frontend
-Show details of a specific resource or group of resources.
-This command joins many API calls together to form a detailed description of a
-given resource or group of resources.
-$ kubectl describe TYPE NAME_PREFIX
-will first check for an exact match on TYPE and NAME_PREFIX. If no such resource
-exists, it will output details for every resource that has a name prefixed with NAME_PREFIX.
-Valid resource types include:
+Show details of a specific resource or group of resources. This command joins many API calls together to form a detailed description of a given resource or group of resources.
+ $ kubectl describe TYPE NAME_PREFIX
+will first check for an exact match on TYPE and NAME PREFIX. If no such resource exists, it will output details for every resource that has a name prefixed with NAME PREFIX.
+Valid resource types include:
-- clusters (valid only for federation apiservers)
-- componentstatuses (aka 'cs')
-- configmaps (aka 'cm')
-- daemonsets (aka 'ds')
-- deployments (aka 'deploy')
-- events (aka 'ev')
-- endpoints (aka 'ep')
-- horizontalpodautoscalers (aka 'hpa')
-- ingress (aka 'ing')
-- jobs
-- limitranges (aka 'limits')
-- nodes (aka 'no')
-- namespaces (aka 'ns')
-- petsets (alpha feature, may be unstable)
-- pods (aka 'po')
-- persistentvolumes (aka 'pv')
-- persistentvolumeclaims (aka 'pvc')
-- quota
-- resourcequotas (aka 'quota')
-- replicasets (aka 'rs')
-- replicationcontrollers (aka 'rc')
-- secrets
-- serviceaccounts (aka 'sa')
-- services (aka 'svc')
+- clusters (valid only for federation apiservers)
+- componentstatuses (aka 'cs')
+- configmaps (aka 'cm')
+- daemonsets (aka 'ds')
+- deployments (aka 'deploy')
+- endpoints (aka 'ep')
+- events (aka 'ev')
+- horizontalpodautoscalers (aka 'hpa')
+- ingresses (aka 'ing')
+- jobs
+- limitranges (aka 'limits')
+- namespaces (aka 'ns')
+- networkpolicies
+- nodes (aka 'no')
+- persistentvolumeclaims (aka 'pvc')
+- persistentvolumes (aka 'pv')
+- pods (aka 'po')
+- podsecuritypolicies (aka 'psp')
+- podtemplates
+- replicasets (aka 'rs')
+- replicationcontrollers (aka 'rc')
+- resourcequotas (aka 'quota')
+- secrets
+- serviceaccounts (aka 'sa')
+- services (aka 'svc')
+- statefulsets
+- storageclasses
+- thirdpartyresources
Usage
$ describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)
@@ -4349,13 +4523,13 @@ exists, it will output details for every resource that has a name prefixed with
kubectl proxy --api-prefix=/k8s-api
-To proxy all of the kubernetes api and nothing else, use:
-kubectl proxy --api-prefix=/
-To proxy only part of the kubernetes api and also some static files:
-kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
-The above lets you 'curl localhost:8001/api/v1/pods'.
-To proxy the entire kubernetes api at a different root, use:
-kubectl proxy --api-prefix=/custom/
+To proxy all of the kubernetes api and nothing else, use:
+ $ kubectl proxy --api-prefix=/
+To proxy only part of the kubernetes api and also some static files:
+ $ kubectl proxy --www=/my/files --www-prefix=/static/ --api-prefix=/api/
+The above lets you 'curl localhost:8001/api/v1/pods'.
+To proxy the entire kubernetes api at a different root, use:
+ $ kubectl proxy --api-prefix=/custom/
The above lets you 'curl localhost:8001/custom/api/v1/pods'
Usage
$ proxy [--port=PORT] [--www=static-dir] [--www-prefix=prefix] [--api-prefix=prefix]
@@ -4440,7 +4614,7 @@ exists, it will output details for every resource that has a name prefixed with
top
-Display Resource (CPU/Memory/Storage) usage.
+Display Resource (CPU/Memory/Storage) usage.
The top command allows you to see the resource consumption for nodes or pods.
Usage
$ top
@@ -4456,7 +4630,7 @@ exists, it will output details for every resource that has a name prefixed with
kubectl top node NODE_NAME
-Display Resource (CPU/Memory/Storage) usage of nodes.
+Display Resource (CPU/Memory/Storage) usage of nodes.
The top-node command allows you to see the resource consumption of nodes.
Usage
$ node [NAME | -l label]
@@ -4501,10 +4675,9 @@ exists, it will output details for every resource that has a name prefixed with
kubectl top pod -l name=myLabel
-Display Resource (CPU/Memory/Storage) usage of pods.
-The 'top pod' command allows you to see the resource consumption of pods.
-Due to the metrics pipeline delay, they may be unavailable for a few minutes
-since pod creation.
+Display Resource (CPU/Memory/Storage) usage of pods.
+The 'top pod' command allows you to see the resource consumption of pods.
+Due to the metrics pipeline delay, they may be unavailable for a few minutes since pod creation.
Usage
$ pod [NAME | -l label]
Flags
@@ -4544,9 +4717,87 @@ since pod creation.
Usage
$ api-versions
+certificate
+Usage
+$ certificate SUBCOMMAND
+
+approve
+Approve a certificate signing request.
+kubectl certificate approve allows a cluster admin to approve a certificate signing request (CSR). This action tells a certificate signing controller to issue a certificate to the requestor with the attributes requested in the CSR.
+SECURITY NOTICE: Depending on the requested attributes, the issued certificate can potentially grant a requester access to cluster resources or to authenticate as a requested identity. Before approving a CSR, ensure you understand what the signed certificate can do.
+Usage
+$ approve (-f FILENAME | NAME)
+Flags
+
+
+
+Name
+Shorthand
+Default
+Usage
+
+
+
+
+filename
+f
+[]
+Filename, directory, or URL to files identifying the resource to update
+
+
+output
+o
+
+Output mode. Use "-o name" for shorter output (resource/name).
+
+
+recursive
+R
+false
+Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+
+
+
+
+deny
+Deny a certificate signing request.
+kubectl certificate deny allows a cluster admin to deny a certificate signing request (CSR). This action tells a certificate signing controller to not to issue a certificate to the requestor.
+Usage
+$ deny (-f FILENAME | NAME)
+Flags
+
+
+
+Name
+Shorthand
+Default
+Usage
+
+
+
+
+filename
+f
+[]
+Filename, directory, or URL to files identifying the resource to update
+
+
+output
+o
+
+Output mode. Use "-o name" for shorter output (resource/name).
+
+
+recursive
+R
+false
+Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+
+
+
+
cluster-info
-Display addresses of the master and services with label kubernetes.io/cluster-service=true
-To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
+Display addresses of the master and services with label kubernetes.io/cluster-service=true To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.
Usage
$ cluster-info
Flags
@@ -4590,12 +4841,8 @@ To further debug and diagnose cluster problems, use 'kubectl cluster-info du
kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
-Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to
-stdout. You can optionally specify a directory with --output-directory. If you specify a directory, kubernetes will
-build a set of files in that directory. By default only dumps things in the 'kube-system' namespace, but you can
-switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces.
-The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories
-based on namespace and pod name.
+Dumps cluster info out suitable for debugging and diagnosing cluster problems. By default, dumps everything to stdout. You can optionally specify a directory with --output-directory. If you specify a directory, kubernetes will build a set of files in that directory. By default only dumps things in the 'kube-system' namespace, but you can switch to a different namespace with the --namespaces flag, or specify --all-namespaces to dump all namespaces.
+The command also dumps the logs of all of the pods in the cluster, these logs are dumped into different directories based on namespace and pod name.
Usage
$ dump
Flags
@@ -4642,28 +4889,20 @@ based on namespace and pod name.
drain
- Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet on it.
+ Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet on it.
$ kubectl drain foo --force
- As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet, and use a grace period of 15 minutes.
+ As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet, and use a grace period of 15 minutes.
$ kubectl drain foo --grace-period=900
-Drain node in preparation for maintenance.
-The given node will be marked unschedulable to prevent new pods from arriving.
-The 'drain' deletes all pods except mirror pods (which cannot be deleted through
-the API server). If there are DaemonSet-managed pods, drain will not proceed
-without --ignore-daemonsets, and regardless it will not delete any
-DaemonSet-managed pods, because those pods would be immediately replaced by the
-DaemonSet controller, which ignores unschedulable markings. If there are any
-pods that are neither mirror pods nor managed by ReplicationController,
-ReplicaSet, DaemonSet or Job, then drain will not delete any pods unless you
-use --force.
-When you are ready to put the node back into service, use kubectl uncordon, which
-will make the node schedulable again.
-
+Drain node in preparation for maintenance.
+The given node will be marked unschedulable to prevent new pods from arriving. 'drain' evicts the pods if the APIServer supports eviciton (http://kubernetes.io/docs/admin/disruptions/). Otherwise, it will use normal DELETE to delete the pods. The 'drain' evicts or deletes all pods except mirror pods (which cannot be deleted through the API server). If there are DaemonSet-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any DaemonSet-managed pods, because those pods would be immediately replaced by the DaemonSet controller, which ignores unschedulable markings. If there are any pods that are neither mirror pods nor managed by ReplicationController, ReplicaSet, DaemonSet, StatefulSet or Job, then drain will not delete any pods unless you use --force.
+'drain' waits for graceful termination. You should not operate on the machine until the command completes.
+When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again.
+! http://kubernetes.io/images/docs/kubectl_drain.svg
Usage
$ drain NODE
Flags
@@ -4687,7 +4926,7 @@ will make the node schedulable again.
force
false
-Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, or DaemonSet.
+Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet.
grace-period
@@ -4701,6 +4940,12 @@ will make the node schedulable again.
false
Ignore DaemonSet-managed pods.
+
+timeout
+
+0s
+The length of time to wait before giving up, zero means infinite
+
@@ -4720,12 +4965,14 @@ will make the node schedulable again.
kubectl taint nodes foo dedicated-
-Update the taints on one or more nodes.
-A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.
-The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.
-The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.
-The effect must be NoSchedule or PreferNoSchedule.
-Currently taint can only apply to node.
+Update the taints on one or more nodes.
+
+- A taint consists of a key, value, and effect. As an argument here, it is expressed as key=value:effect.
+- The key must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.
+- The value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 253 characters.
+- The effect must be NoSchedule or PreferNoSchedule.
+- Currently taint can only apply to node.
+
Usage
$ taint NODE NAME KEY_1=VAL_1:TAINT_EFFECT_1 ... KEY_N=VAL_N:TAINT_EFFECT_N
Flags
@@ -4832,29 +5079,25 @@ Currently taint can only apply to node.
KUBECTL SETTINGS AND USAGE
completion
-$ source <(kubectl completion bash)
-will load the kubectl completion code for bash. Note that this depends on the
-bash-completion framework. It must be sourced before sourcing the kubectl
-completion, e.g. on the Mac:
-$ brew install bash-completion
-$ source $(brew --prefix)/etc/bash_completion
-$ source <(kubectl completion bash)
-If you use zsh*, the following will load kubectl zsh completion:
-$ source <(kubectl completion zsh)
-* zsh completions are only supported in versions of zsh >= 5.2
-
-Output shell completion code for the given shell (bash or zsh).
-This command prints shell code which must be evaluation to provide interactive
-completion of kubectl commands.
+Output shell completion code for the given shell (bash or zsh).
+This command prints shell code which must be evaluation to provide interactive completion of kubectl commands.
+ $ source <(kubectl completion bash)
+will load the kubectl completion code for bash. Note that this depends on the bash-completion framework. It must be sourced before sourcing the kubectl completion, e.g. on the Mac:
+ $ brew install bash-completion
+ $ source $(brew --prefix)/etc/bash_completion
+ $ source <(kubectl completion bash)
+If you use zsh [1], the following will load kubectl zsh completion:
+ $ source <(kubectl completion zsh)
+ [1] zsh completions are only supported in versions of zsh >= 5.2
Usage
$ completion SHELL
config
-Modify kubeconfig files using subcommands like "kubectl config set current-context my-context"
-The loading order follows these rules:
+Modify kubeconfig files using subcommands like "kubectl config set current-context my-context"
+The loading order follows these rules:
-- If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place.
-- If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system). These paths are merged. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list.
+- If the --kubeconfig flag is set, then only that file is loaded. The flag may only be set once and no merging takes place.
+- If $KUBECONFIG environment variable is set, then it is used a list of paths (normal path delimitting rules for your system). These paths are merged. When a value is modified, it is modified in the file that defines the stanza. When a value is created, it is created in the first file that exists. If no files in the chain exist, then it creates the last file in the list.
- Otherwise, ${HOME}/.kube/config is used and no merging takes place.
Usage
@@ -4942,9 +5185,9 @@ completion of kubectl commands.
set
-Sets an individual value in a kubeconfig file
-PROPERTY_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
-PROPERTY_VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used.
+Sets an individual value in a kubeconfig file
+PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
+PROPERTY _VALUE is the new value you wish to set. Binary fields such as 'certificate-authority-data' expect a base64 encoded string unless the --set-raw-bytes flag is used.
Usage
$ set PROPERTY_NAME PROPERTY_VALUE
Flags
@@ -4983,8 +5226,8 @@ PROPERTY_VALUE is the new value you wish to set. Binary fields such as 'cert
kubectl config set-cluster e2e --insecure-skip-tls-verify=true
-Sets a cluster entry in kubeconfig.
-Specifying a name that already exists will merge new fields on top of existing values for those fields.
+Sets a cluster entry in kubeconfig.
+Specifying a name that already exists will merge new fields on top of existing values for those fields.
Usage
$ set-cluster NAME [--server=server] [--certificate-authority=path/to/certificate/authority] [--insecure-skip-tls-verify=true]
Flags
@@ -5037,8 +5280,8 @@ Specifying a name that already exists will merge new fields on top of existing v
kubectl config set-context gce --user=cluster-admin
-Sets a context entry in kubeconfig
-Specifying a name that already exists will merge new fields on top of existing values for those fields.
+Sets a context entry in kubeconfig
+Specifying a name that already exists will merge new fields on top of existing values for those fields.
Usage
$ set-context NAME [--cluster=cluster_nickname] [--user=user_nickname] [--namespace=namespace]
Flags
@@ -5104,15 +5347,15 @@ Specifying a name that already exists will merge new fields on top of existing v
kubectl config set-credentials cluster-admin --auth-provider=oidc --auth-provider-arg=client-secret-
-Sets a user entry in kubeconfig
-Specifying a name that already exists will merge new fields on top of existing values.
+Sets a user entry in kubeconfig
+Specifying a name that already exists will merge new fields on top of existing values.
Client-certificate flags:
- --client-certificate=certfile --client-key=keyfile
+ --client-certificate=certfile --client-key=keyfile
Bearer token flags:
--token=bearer_token
Basic auth flags:
--username=basic_user --password=basic_password
- Bearer token and basic auth are mutually exclusive.
+Bearer token and basic auth are mutually exclusive.
Usage
$ set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password] [--auth-provider=provider_name] [--auth-provider-arg=key=value]
Flags
@@ -5178,8 +5421,8 @@ Specifying a name that already exists will merge new fields on top of existing v
unset
-Unsets an individual value in a kubeconfig file
-PROPERTY_NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
+Unsets an individual value in a kubeconfig file
+PROPERTY _NAME is a dot delimited name where each token represents either an attribute name or a map key. Map keys may not contain dots.
Usage
$ unset PROPERTY_NAME
@@ -5199,7 +5442,7 @@ PROPERTY_NAME is a dot delimited name where each token represents either an attr
kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}'
-Display merged kubeconfig settings or a specified kubeconfig file.
+Display merged kubeconfig settings or a specified kubeconfig file.
You can use --output jsonpath={...} to extract specific values using a jsonpath expression.
Usage
$ view
@@ -5294,33 +5537,37 @@ PROPERTY_NAME is a dot delimited name where each token represents either an attr
kubectl explain pods.spec.containers
-Documentation of resources.
-Valid resource types include:
+Documentation of resources.
+Valid resource types include:
-- clusters (valid only for federation apiservers)
-- componentstatuses (aka 'cs')
-- configmaps (aka 'cm')
-- daemonsets (aka 'ds')
-- deployments (aka 'deploy')
-- events (aka 'ev')
-- endpoints (aka 'ep')
-- horizontalpodautoscalers (aka 'hpa')
-- ingress (aka 'ing')
-- jobs
-- limitranges (aka 'limits')
-- nodes (aka 'no')
-- namespaces (aka 'ns')
-- petsets (alpha feature, may be unstable)
-- pods (aka 'po')
-- persistentvolumes (aka 'pv')
-- persistentvolumeclaims (aka 'pvc')
-- quota
-- resourcequotas (aka 'quota')
-- replicasets (aka 'rs')
-- replicationcontrollers (aka 'rc')
-- secrets
-- serviceaccounts (aka 'sa')
-- services (aka 'svc')
+- clusters (valid only for federation apiservers)
+- componentstatuses (aka 'cs')
+- configmaps (aka 'cm')
+- daemonsets (aka 'ds')
+- deployments (aka 'deploy')
+- endpoints (aka 'ep')
+- events (aka 'ev')
+- horizontalpodautoscalers (aka 'hpa')
+- ingresses (aka 'ing')
+- jobs
+- limitranges (aka 'limits')
+- namespaces (aka 'ns')
+- networkpolicies
+- nodes (aka 'no')
+- persistentvolumeclaims (aka 'pvc')
+- persistentvolumes (aka 'pv')
+- pods (aka 'po')
+- podsecuritypolicies (aka 'psp')
+- podtemplates
+- replicasets (aka 'rs')
+- replicationcontrollers (aka 'rc')
+- resourcequotas (aka 'quota')
+- secrets
+- serviceaccounts (aka 'sa')
+- services (aka 'svc')
+- statefulsets
+- storageclasses
+- thirdpartyresources
Usage
$ explain RESOURCE
@@ -5374,11 +5621,111 @@ PROPERTY_NAME is a dot delimited name where each token represents either an attr
false
Client version only (no server required).
+
+short
+
+false
+Print just the version number.
+
+
+
+DEPRECATED COMMANDS
+
+stop
+
+ Shut down foo.
+
+kubectl stop replicationcontroller foo
+
+
+ Stop pods and services with label name=myLabel.
+
+kubectl stop pods,services -l name=myLabel
+
+
+ Shut down the service defined in service.json
+
+kubectl stop -f service.json
+
+
+ Shut down all resources in the path/to/resources directory
+
+kubectl stop -f path/to/resources
+
+Deprecated: This command is deprecated, all its functionalities are covered by "kubectl delete"
+Usage
+$ stop (-f FILENAME | TYPE (NAME | -l label | --all))
+Flags
+
+
+
+Name
+Shorthand
+Default
+Usage
+
+
+
+
+all
+
+false
+[-all] to select all the specified resources.
+
+
+filename
+f
+[]
+Filename, directory, or URL to files of resource(s) to be stopped.
+
+
+grace-period
+
+-1
+Period of time in seconds given to the resource to terminate gracefully. Ignored if negative.
+
+
+ignore-not-found
+
+false
+Treat "resource not found" as a successful stop.
+
+
+include-extended-apis
+
+true
+If true, include definitions of new APIs via calls to the API server. [default true]
+
+
+output
+o
+
+Output mode. Use "-o name" for shorter output (resource/name).
+
+
+recursive
+R
+false
+Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
+
+
+selector
+l
+
+Selector (label query) to filter on.
+
+
+timeout
+
+0s
+The length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object
+
<%= foo %>
', {client: true}); str = fn.toString(); if (!process.env.running_under_istanbul) { @@ -116,9 +117,9 @@ suite('ejs.compile(str, options)', function () { }); test('support client mode without locals', function () { - var fn - , str - , preFn; + var fn; + var str; + var preFn; fn = ejs.compile('<%= "foo" %>
', {client: true}); str = fn.toString(); if (!process.env.running_under_istanbul) { @@ -129,16 +130,16 @@ suite('ejs.compile(str, options)', function () { test('not include rethrow() in client mode if compileDebug is false', function () { var fn = ejs.compile('<%= "foo" %>
', { - client: true - , compileDebug: false - }); + client: true, + compileDebug: false + }); // There could be a `rethrow` in the function declaration assert((fn.toString().match(/rethrow/g) || []).length <= 1); }); test('support custom escape function', function () { - var customEscape - , fn; + var customEscape; + var fn; customEscape = function customEscape(str) { return !str ? '' : str.toUpperCase(); }; @@ -147,9 +148,9 @@ suite('ejs.compile(str, options)', function () { }); test('support custom escape function in client mode', function () { - var customEscape - , fn - , str; + var customEscape; + var fn; + var str; customEscape = function customEscape(str) { return !str ? '' : str.toUpperCase(); }; @@ -157,7 +158,7 @@ suite('ejs.compile(str, options)', function () { str = fn.toString(); if (!process.env.running_under_istanbul) { eval('var preFn = ' + str); - assert.equal(preFn({name: 'world'}), 'HELLO WORLD'); + assert.equal(preFn({name: 'world'}), 'HELLO WORLD'); // eslint-disable-line no-undef } }); @@ -167,6 +168,21 @@ suite('ejs.compile(str, options)', function () { }); +/* Old API -- remove when this shim goes away */ +suite('ejs.render(str, dataAndOpts)', function () { + test('render the template with data/opts passed together', function () { + assert.equal(ejs.render('= foo ?>
', {foo: 'yay', delimiter: '?'}), + 'yay
'); + }); + + test('disallow unsafe opts passed along in data', function () { + assert.equal(ejs.render('= locals.foo ?>
', + // localsName should not get reset because it's blacklisted + {_with: false, foo: 'yay', delimiter: '?', localsName: '_'}), + 'yay
'); + }); +}); + suite('ejs.render(str, data, opts)', function () { test('render the template', function () { assert.equal(ejs.render('yay
'), 'yay
'); @@ -228,10 +244,10 @@ suite('ejs.render(str, data, opts)', function () { }); test('support caching', function () { - var file = __dirname + '/tmp/render.ejs' - , options = {cache: true, filename: file} - , out = ejs.render('Old
', {}, options) - , expected = 'Old
'; + var file = __dirname + '/tmp/render.ejs'; + var options = {cache: true, filename: file}; + var out = ejs.render('Old
', {}, options); + var expected = 'Old
'; assert.equal(out, expected); // Assert no change, still in cache out = ejs.render('New
', {}, options); @@ -239,11 +255,11 @@ suite('ejs.render(str, data, opts)', function () { }); test('support LRU caching', function () { - var oldCache = ejs.cache - , file = __dirname + '/tmp/render.ejs' - , options = {cache: true, filename: file} - , out - , expected = 'Old
'; + var oldCache = ejs.cache; + var file = __dirname + '/tmp/render.ejs'; + var options = {cache: true, filename: file}; + var out; + var expected = 'Old
'; // Switch to LRU ejs.cache = LRU(); @@ -259,8 +275,8 @@ suite('ejs.render(str, data, opts)', function () { }); test('opts.context', function () { - var ctxt = {foo: 'FOO'} - , out = ejs.render('<%= this.foo %>', {}, {context: ctxt}); + var ctxt = {foo: 'FOO'}; + var out = ejs.render('<%= this.foo %>', {}, {context: ctxt}); assert.equal(out, ctxt.foo); }); }); @@ -277,8 +293,8 @@ suite('ejs.renderFile(path, [data], [options], fn)', function () { }); test('accept locals', function(done) { - var data = {name: 'fonebone'} - , options = {delimiter: '$'}; + var data = {name: 'fonebone'}; + var options = {delimiter: '$'}; ejs.renderFile('test/fixtures/user.ejs', data, options, function(err, html) { if (err) { return done(err); @@ -289,11 +305,10 @@ suite('ejs.renderFile(path, [data], [options], fn)', function () { }); test('accept locals without using with() {}', function(done) { - var data = {name: 'fonebone'} - , options = {delimiter: '$', _with: false} - , doneCount = 0; - ejs.renderFile('test/fixtures/user-no-with.ejs', data, options, - function(err, html) { + var data = {name: 'fonebone'}; + var options = {delimiter: '$', _with: false}; + var doneCount = 0; + ejs.renderFile('test/fixtures/user-no-with.ejs', data, options, function(err, html) { if (err) { if (doneCount === 2) { return; @@ -323,9 +338,9 @@ suite('ejs.renderFile(path, [data], [options], fn)', function () { }); test('not catch err thrown by callback', function(done) { - var data = {name: 'fonebone'} - , options = {delimiter: '$'} - , counter = 0; + var data = {name: 'fonebone'}; + var options = {delimiter: '$'}; + var counter = 0; var d = require('domain').create(); d.on('error', function (err) { @@ -340,8 +355,7 @@ suite('ejs.renderFile(path, [data], [options], fn)', function () { // domains. Have to make it async. Ticket closed because: "domains are // deprecated :D" process.nextTick(function () { - ejs.renderFile('test/fixtures/user.ejs', data, options, - function(err) { + ejs.renderFile('test/fixtures/user.ejs', data, options, function(err) { counter++; if (err) { assert.notEqual(err.message, 'Exception in callback'); @@ -354,9 +368,9 @@ suite('ejs.renderFile(path, [data], [options], fn)', function () { }); test('support caching', function (done) { - var expected = 'Old
' - , file = __dirname + '/tmp/renderFile.ejs' - , options = {cache: true}; + var expected = 'Old
'; + var file = __dirname + '/tmp/renderFile.ejs'; + var options = {cache: true}; fs.writeFileSync(file, 'Old
'); ejs.renderFile(file, {}, options, function (err, out) { @@ -379,8 +393,7 @@ suite('ejs.renderFile(path, [data], [options], fn)', function () { test('opts.context', function (done) { var ctxt = {foo: 'FOO'}; - ejs.renderFile('test/fixtures/with-context.ejs', {}, - {context: ctxt}, function(err, html) { + ejs.renderFile('test/fixtures/with-context.ejs', {}, {context: ctxt}, function(err, html) { if (err) { return done(err); } @@ -393,10 +406,10 @@ suite('ejs.renderFile(path, [data], [options], fn)', function () { suite('cache specific', function () { test('`clearCache` work properly', function () { - var expected = 'Old
' - , file = __dirname + '/tmp/clearCache.ejs' - , options = {cache: true, filename: file} - , out = ejs.render('Old
', {}, options); + var expected = 'Old
'; + var file = __dirname + '/tmp/clearCache.ejs'; + var options = {cache: true, filename: file}; + var out = ejs.render('Old
', {}, options); assert.equal(out, expected); ejs.clearCache(); @@ -407,11 +420,11 @@ suite('cache specific', function () { }); test('`clearCache` work properly, LRU', function () { - var expected = 'Old
' - , oldCache = ejs.cache - , file = __dirname + '/tmp/clearCache.ejs' - , options = {cache: true, filename: file} - , out; + var expected = 'Old
'; + var oldCache = ejs.cache; + var file = __dirname + '/tmp/clearCache.ejs'; + var options = {cache: true, filename: file}; + var out; ejs.cache = LRU(); @@ -426,11 +439,11 @@ suite('cache specific', function () { }); test('LRU with cache-size 1', function () { - var oldCache = ejs.cache - , options - , out - , expected - , file; + var oldCache = ejs.cache; + var options; + var out; + var expected; + var file; ejs.cache = LRU(1); @@ -476,6 +489,11 @@ suite('<%', function () { }); suite('<%=', function () { + test('should not throw an error with a // comment on the final line', function () { + assert.equal(ejs.render('<%=\n// a comment\nname\n// another comment %>', {name: ' +``` +CDN provided by [cdnjs](https://cdnjs.com/libraries/jquery-scrollTo) +```html + +``` + +### Downloading Manually + +If you want the latest stable version, get the latest release from the [releases page](https://github.com/flesler/jquery.scrollTo/releases). + +## 2.0 + +Version 2.0 has been recently released. It is mostly backwards compatible, if you have any issue first check [this link](https://github.com/flesler/jquery.scrollTo/wiki/Migrating-to-2.0). +If your problem is not solved then go ahead and [report the issue](https://github.com/flesler/jquery.scrollTo/issues/new). + +## Usage + +jQuery.scrollTo's signature is designed to resemble [$().animate()](http://api.jquery.com/animate/). + +```js +$(element).scrollTo(target[,duration][,settings]); +``` + +### _element_ + +This must be a scrollable element, to scroll the whole window use `$(window)`. + +### _target_ + +This defines the position to where `element` must be scrolled. The plugin supports all these formats: + * A number with a fixed position: `250` + * A string with a fixed position with px: `"250px"` + * A string with a percentage (of container's size): `"50%"` + * A string with a relative step: `"+=50px"` + * An object with `left` and `top` containining any of the aforementioned: `{left:250, top:"50px"}` + * The string `"max"` to scroll to the end. + * A string selector that will be relative to the element to scroll: `".section:eq(2)"` + * A DOM element, probably a child of the element to scroll: `document.getElementById("top")` + * A jQuery object with a DOM element: `$("#top")` + +### _settings_ + +The `duration` parameter is a shortcut to the setting with the same name. +These are the supported settings: + * __axis__: The axes to animate: `xy` (default), `x`, `y`, `yx` + * __interrupt__: If `true` will cancel the animation if the user scrolls. Default is `false` + * __limit__: If `true` the plugin will not scroll beyond the container's size. Default is `true` + * __margin__: If `true`, subtracts the margin and border of the `target` element. Default is `false` + * __offset__: Added to the final position, can be a number or an object with `left` and `top` + * __over__: Adds a % of the `target` dimensions: `{left:0.5, top:0.5}` + * __queue__: If `true` will scroll one `axis` and then the other. Default is `false` + * __onAfter(target, settings)__: A callback triggered when the animation ends (jQuery's `complete()`) + * __onAfterFirst(target, settings)__: A callback triggered after the first axis scrolls when queueing + +You can add any setting supported by [$().animate()](http://api.jquery.com/animate/#animate-properties-options) as well: + + * __duration__: Duration of the animation, default is `0` which makes it instantaneous + * __easing__: Name of an easing equation, you must register the easing function: `swing` + * __fail()__: A callback triggered when the animation is stopped (f.e via `interrupt`) + * __step()__: A callback triggered for every animated property on every frame + * __progress()__: A callback triggered on every frame + * And more, check jQuery's [documentation](http://api.jquery.com/animate/#animate-properties-options) + +### window shorthand + +You can use `$.scrollTo(...)` as a shorthand for `$(window).scrollTo(...)`. + +### Changing the default settings + +As with most plugins, the default settings are exposed so they can be changed. +```js +$.extend($.scrollTo.defaults, { + axis: 'y', + duration: 800 +}); +``` + +### Stopping the animation + +jQuery.scrollTo ends up creating ordinary animations which can be stopped by calling [$().stop()](http://api.jquery.com/stop/) or [$().finish()](http://api.jquery.com/finish/) on the same element you called `$().scrollTo()`, including the `window`. +Remember you can pass a `fail()` callback to be called when the animation is stopped. + +## Demo + +Check the [demo](http://demos.flesler.com/jquery/scrollTo/) to see every option in action. + +## Complementary plugins + +There are two plugins, also created by me that depend on jQuery.scrollTo and aim to simplify certain use cases. + +### [jQuery.localScroll](https://github.com/flesler/jquery.localScroll) + +This plugin makes it very easy to implement anchor navigation. +If you don't want to include another plugin, you can try using something like [this minimalistic gist](https://gist.github.com/flesler/3f3e1166690108abf747). + +### [jQuery.serialScroll](https://github.com/flesler/jquery.serialScroll) + +This plugin simplifies the creation of scrolling slideshows. + +## License + +(The MIT License) + +Copyright (c) 2007-2015 Ariel Flesler0
back to top1
back to top2
back to top3
back to top4
back to top5
back to top6
back to top7
back to top0
back to start1
back to start2
back to start3
back to start4
back to start5
back to start6
back to start7
back to start8
back to start9
back to start10
back to start11
back to start12
back to start13
back to start14
back to start15
back to start0
back to start1
back to start2
back to start3
back to start4
back to start5
back to start6
back to start7
back to start8
back to start9
back to start10
back to start11
back to start12
back to start13
back to start14
back to start15
back to start16
back to start17
back to start18
back to start19
back to start20
back to start21
back to start22
back to start23
back to start24
back to start25
back to start26
back to start27
back to start28
back to start29
back to start