Commit Graph

279 Commits

Author SHA1 Message Date
Tim Bannister 5799a8cd48 Add immediate pod deletion to cheat sheet 2021-11-27 18:20:19 +00:00
Robot Jelly fbe2194d5b
added line separation in kubectl page (#30359)
* added line separation in kubectl page

added line separation in kubectl page - 2

added line separation in kubectl page - 3 added space at ends

final changes

added spaces at end

* removed Line-549 from end of the file

* added Line-548 at the end of file
2021-11-25 01:26:33 -08:00
Kubernetes Prow Robot 2363c92474
Merge pull request #28701 from rajeshdeshpande02/add-cp-command
Adding kubectl cp command examples in the cheat sheet
2021-11-22 17:56:16 -08:00
Samuel Culpepper 7a8fef9992
update pod mapping to avoid deprecation notice 2021-11-04 14:30:51 +01:00
Maxym Zalata 8555d69bb5 fix duplicate words 2021-09-08 13:51:27 +03:00
Geoffrey Cline 57c0fe1120 update desc of namespace defaulting in CLI 2021-08-17 18:27:10 +00:00
Victor Palade 61ac44bb11 Merge master into dev-1.22 to keep in sync 2021-08-04 19:43:06 +02:00
bhumijgupta 60d8eaf339 Add requirement note for kubectl convert command reference
Signed-off-by: bhumijgupta <bhumijgupta@gmail.com>
2021-07-29 09:10:42 +05:30
Sean Sullivan 8a6badcb68 placeholder 2021-07-22 11:52:20 -07:00
rajeshdeshpande02 d0f94114a1 Adding kubectl cp command examples in cheatsheet 2021-07-01 16:08:39 +05:30
Qiming Teng e9703497a1 Remove exec permission on markdown files
For some unknown reasons, we have got many markdown files with exec
permission. That is weird and risky.
2021-06-16 17:57:00 +08:00
Kubernetes Prow Robot 6a2b65d85d
Merge pull request #27557 from robertsonai/patch-1
Add common command to list ENV for all pods
2021-05-19 05:26:51 -07:00
joostas ee1361dc0d [en] Fix label selector in "kubectl for Docker Users"
Before
```sh
kubectl get po -l
run=nginx-app
No resources found in default namespace.
```
Because:
```sh
kubectl get po --show-labels
NAME                         READY   STATUS    RESTARTS   AGE   LABELS
nginx-app-58cfd4c468-jx6qp   1/1     Running   0          17m app=nginx-app,pod-template-hash=58cfd4c468
```
After:
```sh
kubectl get po -l app=nginx-app
NAME                         READY   STATUS    RESTARTS   AGE
nginx-app-58cfd4c468-jx6qp   1/1     Running   0          18m
```
2021-05-11 23:08:49 +03:00
Adam Robertson 21bf5f96bc
Update cheatsheet.md
Adding comments to ensure default namespace, container and that the command is supported.
Add note to show you can substitute `env` for any supported command.
2021-04-15 11:28:07 -07:00
Adam Robertson 98a20fb123
Update cheatsheet.md
Adding a common command I use to ensure common or namespace wide ENV variables are properly set, i.e. by a ConfigMap
2021-04-14 12:41:44 -07:00
Kubernetes Prow Robot 27cf5a0f0d
Merge pull request #26574 from AliRezaTaleghani/patch-1
Update cheatsheet.md
2021-03-26 04:42:43 -07:00
Karen Bradshaw 3ff5ec1eff clean up use of word: just 2021-03-17 19:57:40 -04:00
Akihito INOH f553cbbebc Replace redirect links of install kubectl
/docs/tasks/tools/install-kubectl/ is redirected to
/docs/tasks/tools/
This commit replace the redirect links for installing kubectl
with direct links.
2021-03-15 08:22:29 +09:00
Kubernetes Prow Robot 6beb1b12de
Merge pull request #24727 from raghvenders/patch-3
Clean up reference section
2021-03-05 01:44:22 -08:00
Kubernetes Prow Robot 203ad6d6a9
Merge pull request #26062 from notchairmk/cheatsheet_deploy_svc
Update cheatsheet: add interacting with Deployments and Services
2021-03-04 16:42:22 -08:00
andrzejsydor b7a3e4c971
address typos docker-cli-kubectl (#26050)
* fix typos

fix typos

* Update docker-cli-to-kubectl.md

* fix typos
2021-03-04 16:34:22 -08:00
raghvenders c77e38066f Review Comments 2021-02-28 20:40:16 -06:00
raghvenders 2b6074e8ed changes 2021-02-22 19:13:26 -06:00
AliRezaTaleghani 5316aaf207
Update cheatsheet.md
fix CLA sign
2021-02-16 20:09:06 +01:00
AliRezaTaleghani 21100c15ee
Update cheatsheet.md
activate CLA
2021-02-16 20:01:07 +01:00
AliRezaTaleghani c3245e47d7
Update cheatsheet.md
adding blank space between examples
2021-02-16 19:56:24 +01:00
AliRezaTaleghani c8d58f3d52
Update cheatsheet.md
adding a custom output to format output by listing Images per Pod in table.
2021-02-16 19:48:47 +01:00
Kubernetes Prow Robot 0c26cd90eb
Merge pull request #26092 from anapsix/patch-2
Update cheatsheet.md
2021-02-01 16:50:28 -08:00
chenxuc 9d3e4467d5 Update invalid web page link for api group
The old link
"https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-groups"
points to an nonexistent section of that page. The correct section
should be
"https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-groups-and-versioning"
.
2021-02-01 13:00:47 +08:00
Anastas Dancha 8589a9c76a
Update cheatsheet.md
- improve on [pr #26053](https://github.com/kubernetes/website/pull/26053)
- use idiomatic secret name in example
2021-01-14 16:12:53 +03:00
Kubernetes Prow Robot a422f01f3f
Merge pull request #26053 from anapsix/patch-2
Update cheatsheet.md
2021-01-13 09:44:36 -08:00
Taylor Chaparro 535743edbe
Update cheatsheet: add section for interacting with Deployments and Services 2021-01-12 12:19:40 -08:00
Kubernetes Prow Robot 466de5e75a
Merge pull request #25337 from smashse/patch-2
Update docker-cli-to-kubectl.md
2021-01-12 11:10:38 -08:00
Kubernetes Prow Robot eecf1c47e1
Merge pull request #25549 from tomkivlin/patch-1
Tidy list of generators for “kubectl create”
2021-01-12 03:58:25 -08:00
Tom Kivlin f095cf3ecf
update resource terms to CamelCase
where a resource is mentioned in the description, use CamelCase.
2021-01-12 08:03:14 +00:00
Anastas Dancha 4076cf0b0b
Update cheatsheet.md
adding example for decoding secret ".data" without relying on external CLI tools
2021-01-11 19:34:31 +03:00
andrzejsydor 1537aa20a2
Update cheatsheet.md (Add --sort-by option for `top` command)
Update cheatsheet.md (Add --sort-by option for `top` command)
2021-01-08 20:18:56 +01:00
Kubernetes Prow Robot 3dd4721e9c
Merge pull request #25389 from sangam14/patch-1
Update cheatsheet.md
2021-01-04 17:17:57 -08:00
Tom Kivlin 441cafec53
monospaced --> unordered list
As mentioned in issue #25501.
2020-12-10 19:47:28 +00:00
Kubernetes Prow Robot 02dc538596
Merge pull request #25496 from browningjp/patch-1
Clarified kubectl generators being deprecated
2020-12-08 14:15:34 -08:00
Jonny Browning 23d2722023
Clarified kubectl generators being deprecated
Previously it was not clear that it was only the generators used by `kubectl run` that are deprecated, not those used by `kubectl create`
2020-12-08 15:20:33 +00:00
Anna Jung (VMware) 7f43aceddb Merge remote-tracking branch 'upstream/master' into dev-1.20 2020-12-07 10:39:57 -06:00
Sangam Biradar 619eb00575
Update cheatsheet.md 2020-12-04 05:00:46 +05:30
Anna Jung (VMware) edc2d65641 Generate reference doc for 1.20.0-rc.0 and update api index page 2020-12-03 16:51:44 -06:00
Anderson Gama f4e15f337f
Update docker-cli-to-kubectl.md 2020-12-01 13:56:50 -03:00
keshy f3107d250b
Update content/en/docs/reference/kubectl/cheatsheet.md
Ack on recommended change.

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-11-29 23:37:13 -08:00
keshy b752ca0690
Update cheatsheet.md
Added another useful command for obtaining shell access to a running k8s pod.
2020-11-27 11:40:28 -08:00
Kubernetes Prow Robot a27c157ef7
Merge pull request #24701 from ramnar/patch-1
commands to create job and cronjob
2020-11-25 16:14:19 -08:00
zhaojizhuang 7beee58927 fix example error when use kubectl get -f 2020-11-20 23:59:51 +08:00
ramnar 4ed2587df3
implemented review comments 2020-11-18 10:03:23 +05:30
ramnar ba4b043336
updated review comments
updated review comments
2020-11-10 07:08:40 +05:30
ramnar 18e4eaff07
implemented feedback
implemented feedback
2020-11-10 07:05:16 +05:30
ramnar bc2b4f2e5b
implemented review comments
implemented review comments
2020-10-28 07:28:32 +05:30
ramnar 177fb0d6f2
implementing review comments
implementing review comments
2020-10-25 16:05:29 +05:30
ramnar 18eb0bfc02
commands to create job and cronjob 2020-10-24 10:36:54 +05:30
Tomas Menito f24bf6f60b Update dry-run flag
dry-run is deprecated and can be replaced with --dry-run=client.
2020-09-29 07:25:48 -03:00
yuanhao ed053d7061 update kubectl api-resouces list base on 1.19.1 2020-09-18 14:23:34 +08:00
Adam Russell 82546d3ff8 Fix a couple issues in docker-cli-to-kubectl.md 2020-09-17 11:50:46 -05:00
Kubernetes Prow Robot d1a9cf8f44
Merge pull request #23141 from webmutation/jsonpath-regex-nosupport
Jsonpath regex nosupport
2020-08-27 15:33:29 -07:00
Daniel Mendes 691ca62bb3
Update content/en/docs/reference/kubectl/jsonpath.md
Co-authored-by: Daniel Smith <dbsmith@google.com>
2020-08-26 19:55:51 +02:00
Daniel Mendes 5a4c534e57
Update content/en/docs/reference/kubectl/jsonpath.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-08-26 19:55:26 +02:00
Savitha Raghunathan 95c94c03d5 resolving conflicts 2020-08-23 12:13:37 -04:00
Daniel Mendes 6262a5dae3
Update jsonpath.md 2020-08-18 19:59:10 +02:00
Kubernetes Prow Robot 8c60bd2208
Merge pull request #22975 from kbhawkey/kb-fix-heading-cheatsheet
remove extra title in kubectl cheatsheet
2020-08-16 14:10:18 -07:00
Daniel Mendes 5247eaccc3
Apply suggestions from code review
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-08-14 14:55:00 +02:00
Daniel Mendes 869817b56c
Update jsonpath.md 2020-08-14 11:40:11 +02:00
Daniel Mendes 2a33dfdcd6
Update jsonpath.md
Adding note that JSONPath in kubectl cli does not currently support RegEx.
2020-08-14 11:31:00 +02:00
Savitha Raghunathan 50cfe280cd Updating generated files for v1.19.0-rc.4 2020-08-13 16:45:52 -04:00
Anna Jung 09d0f598fa Merge master into dev-1.19 to keep in sync 2020-08-11 08:34:02 -05:00
Kubernetes Prow Robot 3960775d8a
Merge pull request #23014 from tengqm/links-reference
Replace redirections in the reference section
2020-08-08 05:04:19 -07:00
Qiming Teng d592baed54 Replace redirections in the reference section
This PR removes the redirections used in the reference section and fixes
some bad links.
2020-08-08 12:35:52 +08:00
Garron Kramer 05a417c303
Assist those who struggle to find path to relevant keys in Json output. 2020-08-07 14:57:15 +03:00
Karen Bradshaw 672af3395a remove extra title kubectl cheatsheet 2020-08-05 09:19:49 -04:00
Savitha Raghunathan 53f2d23359 resolving conflicts 2020-07-19 19:15:36 -04:00
Qiming Teng 4ddc1663f2 Add a kubectl tip for working with keys with dots 2020-07-02 16:30:52 +08:00
Savitha Raghunathan 220d754880 Merge remote-tracking branch 'upstream/master' into dev-1.19 2020-06-30 18:02:37 -04:00
Maciej Szulik 00f502fa6a
Update kubectl run from docs where necessary
kubectl run starting from 1.18 is creating only Pods and there is no option to
create any other resource. Users should be using kubectl create
commands instead. This update the documentation in all those places
where kubectl create should be used instead or changes description to
reflect the situation.
2020-06-25 13:37:14 +02:00
Kubernetes Prow Robot 7313e210cb
Merge pull request #21774 from ptux/patch-1
update latest kubectl run syntax
2020-06-19 22:48:39 -07:00
Savitha Raghunathan 7ddedb00a0 resolving conflicts 2020-06-17 17:11:24 -04:00
Kubernetes Prow Robot c1dcada5de
Merge pull request #21536 from Cweiping/remove_kubectl_run_command_deprecated_en
deprecated kubectl run command for en
2020-06-15 14:41:57 -07:00
Wang(わん) 622e5f9713
update latest kubectl run syntax
--dry-run is deprecated

`--restart=Never` flag is unnecessary to create a pod from 1.18
2020-06-15 21:06:55 +09:00
Kubernetes Prow Robot 54e1f493a1
Merge pull request #21707 from Cweiping/remove_kubectl_run_command_deprecated_en_from_dev_1.19
use kubectl create deployment to create deployment with  --replicas and --port
2020-06-14 06:09:55 -07:00
Weiping Cai 0202db7c00
use replicas to replace kubectl scale deployment.
Signed-off-by: Weiping Cai <weiping.cai@daocloud.io>
2020-06-14 19:08:31 +08:00
Weiping Cai cf3becadff
use kubectl create deployment to create deployment with --replicas and --port.
Signed-off-by: Weiping Cai <weiping.cai@daocloud.io>
2020-06-13 17:31:10 +08:00
Weiping Cai 81027d6226
use kubectl create deployment to create Deployment 2020-06-12 17:15:10 +08:00
Cweiping a255ff8fbd
Merge branch 'master' into remove_kubectl_run_command_deprecated_en 2020-06-12 16:11:28 +08:00
Tim Bannister 400c98fb5f Revise kubectl overview
- Reword some examples
- Correct sample output labelled as Bourne shell code
- Address the reader as “you”
- Fix Markdown formatting
- other corrections
2020-06-11 23:17:21 +01:00
Karen Bradshaw 87f68710ff correct tool reference front matter 2020-06-09 21:01:24 -04:00
Karen Bradshaw ecc27bbbe7 add en pages 2020-06-09 19:33:15 -04:00
Jerry Park cb00e9fbd9 Fix issue with k8s.io/docs/reference/kubectl/overview/ 2020-06-08 05:55:07 +00:00
Weiping Cai a01ea635e2
deprecated kubectl run command flag replicas and add note
Signed-off-by: Weiping Cai <weiping.cai@daocloud.io>
2020-06-07 10:53:21 +08:00
Weiping Cai e990e46f63
deprecated kubectl run command flag replicas for en
Signed-off-by: Weiping Cai <weiping.cai@daocloud.io>
2020-06-06 15:45:54 +08:00
Teodor Haret c57fa62223 Update kubectl overview page - list of operations 2020-05-12 12:20:01 +03:00
Vinicius Barbosa d77e95a8e8 Update overview.md: remove a depreciated flag 2020-05-09 13:35:14 -03:00
sharet-adl a3690b62a2
Fix couple of issues - display issue for pipe char, output for flag --server-print, labels sample, exec extra --, config sample missing newline
Proposing fixes for some issues in the page:

1. Handle display issue for the 'kubectl run' command, where pipe character ('|') is not properly escaped, so the text gets trimmed.  
Currently the text is rendered like this: "run	`kubectl run NAME --image=image [--env=“key=value”] [--port=port] [--replicas=replicas] [--dry-run=server".

The correct text will be displayed like:  
"kubectl run NAME --image=image [--env="key=value"] [--port=port] [--replicas=replicas] [--dry-run=server|client|none] [--overrides=inline-json] [flags]".  
Also, the description column would be displayed properly.

2. Fixing output of 'get pods' command, when flag --server-print is set to false.  
The only displayed columns would be NAME and AGE.  

3. Fixing description and sample command for delete pods (kubectl delete pods,service ..), where 'label-name' text is ambiguously used as the label's value. Labels are key-value pairs.  
Suggested way of writting it:  
"# Delete all the pods and services that have the label '<label-key>=<label-value>'.  
kubectl delete pods,services -l <label-key>=<label-value>"

Another way to write it could be:  
"# Delete all the pods and services that have the label 'name=<label-value>'.  
kubectl delete pods,services -l name=<label-value>"

4. Updating the syntax for three 'kubectl exec' commands, to include the '--' before the user's command, to be inline with current way of working and to avoid deprecation message.  

5. Enhance sample for 'kubectl config' command, where the newline was not handled properly.  
Before:  
[user@wstation ~]$ kubectl config view --template='{{ range .contexts }}{{ if eq .name "'$(kubectl config current-context)'" }}Current user: {{ .context.user }}{{ end }}{{ end }}'  
Current user: kubernetes-admin[user@wstation ~]$

After:  
[user@wstation ~]$ kubectl config view --template='{{ range .contexts }}{{ if eq .name "'$(kubectl config current-context)'" }}Current user: {{ printf "%s\n" .context.user }}{{ end }}{{ end }}'  
Current user: kubernetes-admin  
[user@wstation ~]$
2020-05-09 12:54:02 +03:00
Kubernetes Prow Robot accd7591b0
Merge pull request #20107 from n0npax/fix-restart-always-docs
Fix --restart=always docs
2020-04-21 20:21:53 -07:00
Marcin Niemira 57d4d52817
change sentence to nicer form as requested during CR 2020-04-21 20:40:49 +10:00
gosoon 1847278b1f fix: error message 2020-04-21 17:22:23 +08:00
Marcin Niemira b09893bbcc
rm mentioned generator from kubectl run 2020-04-21 19:08:05 +10:00
Marcin Niemira df2204ffd0
Merge branch 'master' of https://github.com/kubernetes/website into fix-restart-always-docs 2020-04-21 19:04:13 +10:00