Commit Graph

370 Commits

Author SHA1 Message Date
steve-hardman e822502654 Update jq link 2023-10-03 12:55:01 +00:00
Kubernetes Prow Robot 8ec7897298
Merge pull request #40331 from utkarsh-singh1/update-docs-reference-kubectl-cheatsheet-md
Added kubectl completion command for fish shell in kubect cheatsheet docmentation
2023-09-25 01:46:57 -07:00
Utkarsh Singh 92fbd57141 Updated /content/en/docs/reference/kubectl/cheatsheet
Signed-off-by: Utkarsh Singh <96516301+utkarsh-singh1@users.noreply.github.com>
2023-09-24 16:34:35 +00:00
Ritikaa96 94c174024f Updating in kubectl reference
Signed-off-by: Ritikaa96 <ritika@india.nec.com>
2023-09-15 12:32:02 +09:00
Arda Güçlü d26e66def0 Remove alpha environment variable because feature is in beta 2023-09-06 09:04:42 +03:00
Kubernetes Prow Robot e6987bde68
Merge pull request #41049 from able8/add-go-template-to-kubectl-output-format
Add the go-template output format in "kubectl Cheat Sheet" page
2023-08-18 11:14:28 -07:00
Kubernetes Prow Robot eb9db45aa3
Merge pull request #41987 from sftim/20230712_revise_home_page
Revise docs home page
2023-08-15 21:22:27 -07:00
Tim Bannister 9520b96a61 Revise docs home page
Reorder and replace cards to better (I hope!) serve our readers.
2023-08-09 11:49:12 +01:00
Tim Bannister 20b43d6095
Merge branch 'main' into 'dev-1.28' 2023-08-09 11:13:31 +01:00
Mengjiao Liu 2987c60d92 Fix inconsistent command in the JSONPath Support page 2023-07-28 10:47:06 +08:00
Arda Güçlü cecd565f90 Update environment variable description 2023-07-12 08:26:16 +03:00
Arda Güçlü 7a89284fbd document kubectl delete --interactive flag 2023-07-11 14:44:06 +03:00
Kubernetes Prow Robot 91afacf8a6
Merge pull request #40444 from Tariqs/patch-1
Add cheat sheet entry: overwrite an existing value of label
2023-05-17 03:32:33 -07:00
Kubernetes Prow Robot edc769baa4
Merge pull request #39576 from sftim/20220108_improve_api_documentation_objects_part_1
Reorganize Working with Kubernetes Objects section
2023-05-10 18:39:09 -07:00
able8 b3c81f249c Add go-template to kubectl output format 2023-05-09 22:19:16 +08:00
Marcelo Giles ff5d7b9383
Remove empty line 2023-05-02 12:24:48 -07:00
Marcelo Giles c764279d89
Add note tags and version prefix 2023-05-01 21:53:22 -07:00
Marcelo Giles 585024554c
Add version information to kubectl cheat sheet 2023-04-30 17:36:24 -07:00
Tim Bannister 634c17f61c Reorganize Working with Kubernetes Objects section
- move Understanding Kubernetes Objects to be section overview
- within the section, consistently link to the new (moved) page from the
  first mention of “object”
- add a redirect

Co-authored-by: Divya Mohan <divya.mohan0209@gmail.com>
2023-04-29 21:39:42 +01:00
iyear d9ef7b3849 kubectl/jsonpath: add example of escaping termination character
Signed-off-by: iyear <ljyngup@gmail.com>
2023-04-28 10:08:20 +08:00
Kubernetes Prow Robot 686eefe27a
Merge pull request #40447 from Tariqs/patch-2
Add cheat sheet entry: remove annotation from pod
2023-04-27 16:40:15 -07:00
Mickey Boxell 9252eb08f5 Merge remote-tracking branch 'upstream/main' into dev-1.27 2023-04-10 12:20:33 -07:00
Kubernetes Prow Robot 182b8b3611
Merge pull request #39828 from MadhavJivrajani/docs-update-kubectl-subresource
reference/kubectl: Update docs for moving kubectl subresource to beta
2023-04-07 07:47:14 -07:00
Madhav Jivrajani b8651be9c2 reference/kubectl: Update docs for moving feaature to beta
Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com>
2023-04-07 13:59:31 +05:30
Kubernetes Prow Robot 9f76854ffe
Merge pull request #40532 from mickeyboxell/merged-main-dev-1.27
Merged main dev 1.27
2023-04-05 16:37:48 -07:00
Juergen Hoetzel f1606cc9f7 Simplify kubectl heredoc usage in cheatsheet
Remove the unnecessary cat command.
2023-04-02 15:02:49 +02:00
Muhammad Tariq 7c707e9384
Remove annotation from pod 2023-04-02 19:47:21 +07:00
Muhammad Tariq 49682e9e41
Overwrite an existing value of label 2023-04-02 14:18:19 +07:00
utkarsh-singh1 142a543d56 Updated kubect cheatsheet docmentation
Signed-off-by: utkarsh-singh1 <utkarsh.singh1@india.nec.com>
2023-03-27 16:48:42 +05:30
utkarsh-singh1 99928d6054 Added kubectl completion command for fish shell in kubect cheatsheet docmentation
Signed-off-by: utkarsh-singh1 <utkarsh.singh1@india.nec.com>
2023-03-27 13:10:51 +05:30
utkarsh-singh1 7827c1965b Added kubectl completion command for fish shell in kubect cheatsheet docmentation
Signed-off-by: utkarsh-singh1 <utkarsh.singh1@india.nec.com>
2023-03-25 16:50:36 +05:30
Arda Güçlü 1cbca5cf36 document plugin resolution as subcommand for builtin commands 2023-03-10 08:31:38 +03:00
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