Commit Graph

338 Commits

Author SHA1 Message Date
Asaf Malin 1dc2a5f457
Update cheatsheet.md 2023-01-26 21:11:51 +02:00
Kubernetes Prow Robot 0ecc914172
Merge pull request #37788 from alexzielenski/explain-alpha
document kubectl explain openapi v3
2022-12-07 05:28:40 -08:00
Tim Bannister 8f9446f87d
Merge branch 'main' into dev-1.26 2022-12-03 21:36:34 +00:00
Oliver Teichmann 39efa7b932
Merge branch 'kubernetes:main' into main 2022-11-28 17:24:57 +01:00
Arda Güçlü 1c26c7be36 move events to correct place 2022-11-28 08:22:05 +03:00
Michael 3e20970eb3 Fix typos in cheatsheet.md 2022-11-23 09:57:35 +08:00
Arda Güçlü 232983a4a2 Events beta docs update 2022-11-16 09:39:14 +03:00
Alexander Zielenski 65953e46d5 document kubectl explain openapiv3 envar 2022-11-15 11:44:10 -08:00
Abigail McCarthy 98f310ab58 Updates page weights in reference docs section
Some of these pages are autogenerated, but not all. This PR updates the pages that are not autogenerated within the docs/en/reference section
2022-11-04 11:37:59 -04:00
Oliver Teichmann 0df1710f9a
Update cheatsheet.md
Add syntax to remove labels
2022-11-04 09:15:04 +01:00
Kubernetes Prow Robot d942d08c13
Merge pull request #35732 from swadhinbharat/patch-1
Fix comment for kubectl dry-run in cheatsheet
2022-10-30 05:16:44 -07:00
NitishKumar06 ecb0c27fad Minor modification in kubectl-cheatsheet.md applied 2022-10-13 21:41:30 +05:30
NitishKumar06 d3ada38039 Minor modification in Kubectl cheatsheet.md 2022-10-13 21:24:54 +05:30
Swadhin Patel 8a359c8973
Updated the command putting in single line
Updated the command so that it stays in single line as per review comment
2022-10-04 12:31:45 +08:00
Swadhin Patel 63b59a31d2
Merge branch 'kubernetes:main' into patch-1 2022-10-04 09:57:07 +05:30
Kubernetes Prow Robot 754a380601
Merge pull request #37069 from akankshakumari393/kubectl_default_namespace
Correct the default namespace specified for kubectl running outside cluster
2022-09-30 05:48:29 -07:00
Rishit Dagli 27a79cdebe
Update Resource Types table for 1.25 (#35763)
* Update Resource types table

* Update table formatting

* Update content/en/docs/reference/kubectl/_index.md

Co-authored-by: Meha Bhalodiya <mehabhalodiya@gmail.com>

* Fix typo

Co-authored-by: Sean <me@sean.taipei>

* Fix typo

* Update for 1.25.0

Co-authored-by: Meha Bhalodiya <mehabhalodiya@gmail.com>
Co-authored-by: Sean <me@sean.taipei>
2022-09-29 16:20:42 -07:00
Akanksha Kumari e6a21b58f2 Update information on how to change default namespace 2022-09-30 00:15:55 +05:30
Akanksha Kumari 2fbf62ea2e Correct the default namespace mentioned for kubectl running outside cluster 2022-09-28 22:52:19 +05:30
Arnaud Meukam a180cd6853
Update docs to reference new container image registry
k8s.gcr.io is deprecated in favor of registry.k8s.io. The kubernetes
codebase have been updated with the new endpoint.

Ref: https://github.com/kubernetes/k8s.io/issues/3411

Signed-off-by: Arnaud Meukam <ameukam@gmail.com>
2022-08-18 16:35:26 +02:00
Swadhin Patel e343b36d72
Update cheatsheet.md
It's wrong to say "Run pod nginx" along with the spec being written to the file as the option --dry-run would make sure that the actual executing is not happening but only the preview is generated

The statement would have been correct if the command were something like ...
kubectl run nginx --image=nginx -o yaml > pod.yaml
2022-08-05 18:22:20 +08:00
Kubernetes Prow Robot fe1136848d
Merge pull request #32491 from stemid/patch-1
Cheatsheet syntax to retrieve Secret values with dashes (-) in their key names
2022-07-12 02:36:50 -07:00
Kourtney a0feb8580e
Update content/en/docs/reference/kubectl/cheatsheet.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2022-07-07 10:43:47 -04:00
Kourtney 484713a60b
Update cheatsheet.md
Document kubectl set-cluster --proxy-url
2022-07-06 11:30:19 -04:00
Kubernetes Prow Robot 119fd7bb29
Merge pull request #34450 from Kwazimolo/patch-1
Updated cheatsheet.md with 'get taints' command
2022-07-02 01:15:23 -07:00
Shannon -jj Behrens 5aa48c49e8
Fixed a zsh bug
Using double quotes causes the code to be evaluated too early and ends up not working if you don't have kubectl installed.
2022-06-24 20:18:26 -07:00
Brandon Richard 2f2a4d5bae
Updated cheatsheet.md with 'get taints' command
Updated the kubectl cheat sheet (cheatsheet.md) with a command for viewing taints which exists on current nodes.
2022-06-21 15:04:37 +01:00
Stefan Midjich dd9061e326
clarify that the value is base64 encoded
Co-authored-by: Rey Lejano <rlejano@gmail.com>
2022-06-17 19:41:52 +02:00
Stefan Midjich 95dd0b33ab
Update content/en/docs/reference/kubectl/cheatsheet.md
Co-authored-by: Rey Lejano <rlejano@gmail.com>
2022-06-14 21:17:03 +02:00
Kubernetes Prow Robot e1a1a953c6
Merge pull request #32127 from mtovmassian/fix-en-bash-alias-auto-completion
[en] Update Bash alias auto-completion
2022-06-13 21:11:34 -07:00
lostick cfb897169b Fix typos in tasks docs 2022-05-31 14:47:40 +01:00
Nate W 5ead53b3e8 Merge remote-tracking branch 'upstream/main' into dev-1.24 2022-05-02 10:29:49 -07:00
wei.wang 64f58b2c75 [en]Update content/en/docs/reference/kubectl/docker-cli-to-kubectl.md 2022-04-30 03:11:53 +08:00
Kubernetes Prow Robot 49a2655d25
Merge pull request #32604 from nikhita/kubectl-subresource-support-docs
Document kubectl subresource support
2022-04-07 22:32:43 -07:00
Nikhita Raghunath 73563a3d7a Add docs for kubectl subresource support 2022-04-08 09:11:02 +05:30
Nate W 7c67921f3f Merge remote-tracking branch 'upstream/main' into dev-1.24 2022-03-28 08:48:23 -07:00
Kubernetes Prow Robot 39fd63ba12
Merge pull request #31989 from guettli/31930__fix_busybox_image_1.28
fix busybox image to version 1.28
2022-03-25 15:45:59 -07:00
Kubernetes Prow Robot 689417422e
Merge pull request #32012 from bwolmarans/patch-1
--all-namespaces shorthand
2022-03-25 15:41:58 -07:00
Stefan Midjich 5e9e7d0b21
Template syntax to retrieve values with dashes (-) in their key names
This template syntax was not obvious to me until someone pointed it out on stackexchange, it should be in the cheatsheet for future users. Because trying to retrieve a value with dashes in its key-name using the normal template syntax will result in an error.
2022-03-25 10:23:26 +01:00
Brett Wolmarans 2d69c47782
Update content/en/docs/reference/kubectl/cheatsheet.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2022-03-24 10:29:42 -07:00
Nate W ee1a85d08e Merge remote-tracking branch 'upstream/main' into dev-1.24 2022-03-21 07:53:48 -07:00
Rohinton Kazak 1d1f3edd65
Update cheatsheet.md
typo ?
2022-03-17 19:30:49 -07:00
Martin Tovmassian d05fb625f4 [en] Update Bash alias auto-completion 2022-03-08 16:54:48 +01:00
Nate W 5a0f2583c6 Merge remote-tracking branch 'upstream/main' into dev-1.24 2022-03-07 16:23:45 -08:00
Tim Bannister 77a598cb33 Use in-page “what's next” list for kubectl 2022-03-03 10:03:01 +00:00
Tim Bannister e0d4b37070 Highlight link to kubectl cheat sheet
Also, reorder the section overall.
2022-03-03 10:03:01 +00:00
Tim Bannister 73cd38cdc6 Move kubectl overview to be section index
Also:
- use glossary definition in page introduction
- tidy broken link in What's Next section
- update links to refer to moved page
2022-03-03 10:03:00 +00:00
Thomas Guettler 7122a4498a fix busybox image to 1.28 (issues with `nslookup`).
Changes where done with these commands:

reprec 'image: busybox(?!:)' 'image: busybox:1.28' */docs */examples
reprec -- '--image=busybox(?!:)' '--image=busybox:1.28' */docs */examples

Related issues:

 https://github.com/docker-library/busybox/issues/48
 https://github.com/kubernetes/kubernetes/issues/66924
2022-03-02 20:48:26 +01:00
Brett Wolmarans 8dd6fa677d
--all-namespaces shorthand
As a beginner to kubectl, I must have typed (and re-typed due to typos) --all-namespaces many hundreds of times before I stumbled across the -A shorthand notation for this.  I sincerely would be grateful on behalf of all kubectl beginners if this very useful cheat could be added to this cheatsheet.  I have proposed in this PR a location quite near the beginning of the cheatsheet for this so that it is very hard to miss.
2022-03-02 09:21:06 -08:00
Nate W b7f8b0daae Merge remote-tracking branch 'upstream/main' into dev-1.24 2022-02-28 16:18:31 -08:00
Kubernetes Prow Robot dfa6e8a258
Merge pull request #30740 from mtilson/patch-1
short alias to set/show namespace
2022-02-27 14:09:18 -08:00
Lubomir I. Ivanov 806518df13 kubeadm: update references of "master" label/taint for 1.24
In 1.24 kubeadm will:
- stop using the "master" label on CP nodes.
- start tainting CP nodes with both "master" and "control-plane" taints.

In 1.25 the "master" taint will be removed.

Adjust references of the "master" label/taint to the above.
2022-02-23 19:22:50 +02:00
Meng-Yuan Huang f62e3032af
Simplify commands.
Simplify commands to output paths to all elements.
Note: the jq filter "path(..)" is simplified to "paths," however, there is a trivial difference: the filter "paths" doesn't output the top path "[]."
2022-02-14 10:20:18 +08:00
mtilson 071d27ea12
More clarification according to the discussion 2022-02-07 00:56:58 +03:00
mtilson dc9f8bf21f
Update content/en/docs/reference/kubectl/cheatsheet.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2022-02-07 00:43:21 +03:00
Mohammed Shoukath Ali 105610d0bb Fixed issue - borken link https://kubernetes.io/docs/reference/kubectl/conventions/ #31078 2022-01-23 19:55:37 +05:30
mtilson 1e85065aaa
Alias for context 2022-01-09 12:47:43 +03:00
prabhsimransingh 5f369513e0
Fixing kubectl cheatsheet run command comment to be more accurate (#29879)
* Fixing kubectl cheatsheet run command comment to be more accurate

* remove new line
2021-12-05 15:10:32 -08:00
mtilson 9c8367804c
short alias to set/show namespace
usage:
$ kn              # shows current namespace
$ kn default # switch to specified namespace
2021-12-05 14:54:13 +03:00
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