Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
K
k3s
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Registry
Registry
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Jacklull
k3s
Commits
cac9e88c
Commit
cac9e88c
authored
Nov 19, 2015
by
Jerzy Szczepkowski
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Updated kubectl help messages.
Updated kubectl help messages: added info about hpa. Fixes #17357.
parent
7c660bc2
Hide whitespace changes
Inline
Side-by-side
Showing
13 changed files
with
26 additions
and
16 deletions
+26
-16
kubectl-annotate.1
docs/man/man1/kubectl-annotate.1
+1
-1
kubectl-describe.1
docs/man/man1/kubectl-describe.1
+2
-1
kubectl-explain.1
docs/man/man1/kubectl-explain.1
+2
-1
kubectl-get.1
docs/man/man1/kubectl-get.1
+2
-1
kubectl_annotate.md
docs/user-guide/kubectl/kubectl_annotate.md
+2
-2
kubectl_describe.md
docs/user-guide/kubectl/kubectl_describe.md
+3
-2
kubectl_explain.md
docs/user-guide/kubectl/kubectl_explain.md
+3
-2
kubectl_get.md
docs/user-guide/kubectl/kubectl_get.md
+3
-2
annotate.go
pkg/kubectl/cmd/annotate.go
+1
-1
cmd.go
pkg/kubectl/cmd/cmd.go
+1
-0
describe.go
pkg/kubectl/cmd/describe.go
+2
-1
explain.go
pkg/kubectl/cmd/explain.go
+2
-1
get.go
pkg/kubectl/cmd/get.go
+2
-1
No files found.
docs/man/man1/kubectl-annotate.1
View file @
cac9e88c
...
@@ -25,7 +25,7 @@ If \-\-resource\-version is specified, then updates will use this resource versi
...
@@ -25,7 +25,7 @@ If \-\-resource\-version is specified, then updates will use this resource versi
Possible resources include (case insensitive): pods (po), services (svc),
Possible resources include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota) or secrets.
horizontalpodautoscalers (hpa),
resourcequotas (quota) or secrets.
.SH OPTIONS
.SH OPTIONS
...
...
docs/man/man1/kubectl-describe.1
View file @
cac9e88c
...
@@ -30,7 +30,8 @@ exists, it will output details for every resource that has a name prefixed with
...
@@ -30,7 +30,8 @@ exists, it will output details for every resource that has a name prefixed with
Possible resource types include (case insensitive): pods (po), services (svc),
Possible resource types include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
namespaces (ns), serviceaccounts, endpoints (ep) or secrets.
namespaces (ns), serviceaccounts, horizontalpodautoscalers (hpa),
endpoints (ep) or secrets.
.SH OPTIONS
.SH OPTIONS
...
...
docs/man/man1/kubectl-explain.1
View file @
cac9e88c
...
@@ -19,7 +19,8 @@ Documentation of resources.
...
@@ -19,7 +19,8 @@ Documentation of resources.
Possible resource types include: pods (po), services (svc),
Possible resource types include: pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota), namespaces (ns) or endpoints (ep).
resourcequotas (quota), namespaces (ns), horizontalpodautoscalers (hpa)
or endpoints (ep).
.SH OPTIONS
.SH OPTIONS
...
...
docs/man/man1/kubectl-get.1
View file @
cac9e88c
...
@@ -19,7 +19,8 @@ Display one or many resources.
...
@@ -19,7 +19,8 @@ Display one or many resources.
Possible resource types include (case insensitive): pods (po), services (svc),
Possible resource types include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota), namespaces (ns), endpoints (ep), serviceaccounts or secrets.
resourcequotas (quota), namespaces (ns), endpoints (ep),
horizontalpodautoscalers (hpa), serviceaccounts or secrets.
.PP
.PP
By specifying the output as 'template' and providing a Go template as the value
By specifying the output as 'template' and providing a Go template as the value
...
...
docs/user-guide/kubectl/kubectl_annotate.md
View file @
cac9e88c
...
@@ -48,7 +48,7 @@ If --resource-version is specified, then updates will use this resource version,
...
@@ -48,7 +48,7 @@ If --resource-version is specified, then updates will use this resource version,
Possible resources include (case insensitive): pods (po), services (svc),
Possible resources include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota) or secrets.
horizontalpodautoscalers (hpa),
resourcequotas (quota) or secrets.
```
```
kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
...
@@ -125,7 +125,7 @@ $ kubectl annotate pods foo description-
...
@@ -125,7 +125,7 @@ $ kubectl annotate pods foo description-
*
[
kubectl
](
kubectl.md
)
- kubectl controls the Kubernetes cluster manager
*
[
kubectl
](
kubectl.md
)
- kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra on 1
4
-Nov-2015
###### Auto generated by spf13/cobra on 1
9
-Nov-2015
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[

]()
[

]()
...
...
docs/user-guide/kubectl/kubectl_describe.md
View file @
cac9e88c
...
@@ -51,7 +51,8 @@ exists, it will output details for every resource that has a name prefixed with
...
@@ -51,7 +51,8 @@ exists, it will output details for every resource that has a name prefixed with
Possible resource types include (case insensitive): pods (po), services (svc),
Possible resource types include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
namespaces (ns), serviceaccounts, endpoints (ep) or secrets.
namespaces (ns), serviceaccounts, horizontalpodautoscalers (hpa),
endpoints (ep) or secrets.
```
```
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)
kubectl describe (-f FILENAME | TYPE [NAME_PREFIX | -l label] | TYPE/NAME)
...
@@ -119,7 +120,7 @@ $ kubectl describe pods frontend
...
@@ -119,7 +120,7 @@ $ kubectl describe pods frontend
*
[
kubectl
](
kubectl.md
)
- kubectl controls the Kubernetes cluster manager
*
[
kubectl
](
kubectl.md
)
- kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra on
5
-Nov-2015
###### Auto generated by spf13/cobra on
19
-Nov-2015
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[

]()
[

]()
...
...
docs/user-guide/kubectl/kubectl_explain.md
View file @
cac9e88c
...
@@ -43,7 +43,8 @@ Documentation of resources.
...
@@ -43,7 +43,8 @@ Documentation of resources.
Possible resource types include: pods (po), services (svc),
Possible resource types include: pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota), namespaces (ns) or endpoints (ep).
resourcequotas (quota), namespaces (ns), horizontalpodautoscalers (hpa)
or endpoints (ep).
```
```
kubectl explain RESOURCE
kubectl explain RESOURCE
...
@@ -97,7 +98,7 @@ $ kubectl explain pods.spec.containers
...
@@ -97,7 +98,7 @@ $ kubectl explain pods.spec.containers
*
[
kubectl
](
kubectl.md
)
- kubectl controls the Kubernetes cluster manager
*
[
kubectl
](
kubectl.md
)
- kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra
at 2015-09-25 11:07:41.758531939 +0000 UTC
###### Auto generated by spf13/cobra
on 19-Nov-2015
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[

]()
[

]()
...
...
docs/user-guide/kubectl/kubectl_get.md
View file @
cac9e88c
...
@@ -43,7 +43,8 @@ Display one or many resources.
...
@@ -43,7 +43,8 @@ Display one or many resources.
Possible resource types include (case insensitive): pods (po), services (svc),
Possible resource types include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota), namespaces (ns), endpoints (ep), serviceaccounts or secrets.
resourcequotas (quota), namespaces (ns), endpoints (ep),
horizontalpodautoscalers (hpa), serviceaccounts or secrets.
By specifying the output as 'template' and providing a Go template as the value
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).
of the --template flag, you can filter the attributes of the fetched resource(s).
...
@@ -129,7 +130,7 @@ $ kubectl get rc/web service/frontend pods/web-pod-13je7
...
@@ -129,7 +130,7 @@ $ kubectl get rc/web service/frontend pods/web-pod-13je7
*
[
kubectl
](
kubectl.md
)
- kubectl controls the Kubernetes cluster manager
*
[
kubectl
](
kubectl.md
)
- kubectl controls the Kubernetes cluster manager
###### Auto generated by spf13/cobra on
4
-Nov-2015
###### Auto generated by spf13/cobra on
19
-Nov-2015
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[

]()
[

]()
...
...
pkg/kubectl/cmd/annotate.go
View file @
cac9e88c
...
@@ -60,7 +60,7 @@ If --resource-version is specified, then updates will use this resource version,
...
@@ -60,7 +60,7 @@ If --resource-version is specified, then updates will use this resource version,
Possible resources include (case insensitive): pods (po), services (svc),
Possible resources include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota) or secrets.`
horizontalpodautoscalers (hpa),
resourcequotas (quota) or secrets.`
annotate_example
=
`# Update pod 'foo' with the annotation 'description' and the value 'my frontend'.
annotate_example
=
`# Update pod 'foo' with the annotation 'description' and the value 'my frontend'.
# If the same annotation is set multiple times, only the last value will be applied
# If the same annotation is set multiple times, only the last value will be applied
$ kubectl annotate pods foo description='my frontend'
$ kubectl annotate pods foo description='my frontend'
...
...
pkg/kubectl/cmd/cmd.go
View file @
cac9e88c
...
@@ -125,6 +125,7 @@ __custom_func() {
...
@@ -125,6 +125,7 @@ __custom_func() {
* componentstatuses (aka 'cs')
* componentstatuses (aka 'cs')
* endpoints (aka 'ep')
* endpoints (aka 'ep')
* quota
* quota
* horizontalpodautoscalers (aka 'hpa')
`
`
)
)
...
...
pkg/kubectl/cmd/describe.go
View file @
cac9e88c
...
@@ -52,7 +52,8 @@ exists, it will output details for every resource that has a name prefixed with
...
@@ -52,7 +52,8 @@ exists, it will output details for every resource that has a name prefixed with
Possible resource types include (case insensitive): pods (po), services (svc),
Possible resource types include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
replicationcontrollers (rc), nodes (no), events (ev), limitranges (limits),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
persistentvolumes (pv), persistentvolumeclaims (pvc), resourcequotas (quota),
namespaces (ns), serviceaccounts, endpoints (ep) or secrets.`
namespaces (ns), serviceaccounts, horizontalpodautoscalers (hpa),
endpoints (ep) or secrets.`
describe_example
=
`# Describe a node
describe_example
=
`# Describe a node
$ kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal
$ kubectl describe nodes kubernetes-minion-emt8.c.myproject.internal
...
...
pkg/kubectl/cmd/explain.go
View file @
cac9e88c
...
@@ -38,7 +38,8 @@ $ kubectl explain pods.spec.containers`
...
@@ -38,7 +38,8 @@ $ kubectl explain pods.spec.containers`
Possible resource types include: pods (po), services (svc),
Possible resource types include: pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota), namespaces (ns) or endpoints (ep).`
resourcequotas (quota), namespaces (ns), horizontalpodautoscalers (hpa)
or endpoints (ep).`
)
)
// NewCmdExplain returns a cobra command for swagger docs
// NewCmdExplain returns a cobra command for swagger docs
...
...
pkg/kubectl/cmd/get.go
View file @
cac9e88c
...
@@ -41,7 +41,8 @@ const (
...
@@ -41,7 +41,8 @@ const (
Possible resource types include (case insensitive): pods (po), services (svc),
Possible resource types include (case insensitive): pods (po), services (svc),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
replicationcontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
limitranges (limits), persistentvolumes (pv), persistentvolumeclaims (pvc),
resourcequotas (quota), namespaces (ns), endpoints (ep), serviceaccounts or secrets.
resourcequotas (quota), namespaces (ns), endpoints (ep),
horizontalpodautoscalers (hpa), serviceaccounts or secrets.
By specifying the output as 'template' and providing a Go template as the value
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).`
of the --template flag, you can filter the attributes of the fetched resource(s).`
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment