Commit Graph

118 Commits (9e5b981f800cc22e34a5fc4ab0bc604e6f10152a)

Author SHA1 Message Date
Louis Raymond a869f00509
Update cheatsheet.md (#19039)
Replaced 'if' ZSH kubectl autocomplete with a more compact form
2020-03-15 21:58:35 -07:00
Naoki Oketani e37b117a3f
remove example of deprecated option: kubectl get --export (#19336) 2020-03-15 21:24:35 -07:00
Andrey Zhelnin 8ccc83fad6
Update kubectl explain usage case (#19612)
You can't specify more then one resources at one for explain. See error below:
$ kubectl explain pods,svc
the server doesn't have a resource type "pods,svc"

error: We accept only this format: explain RESOURCE
2020-03-13 17:50:34 -07:00
Kubernetes Prow Robot ddb114e717
Use <code> block to display pipes in syntax within markdown table in kubectl overview (#19450) 2020-03-05 05:08:37 -08:00
Jie Shen be4809ab13
Remove extra backslash in code block (#19255) 2020-02-23 02:34:47 -08:00
Jamie Luckett fefda3e4ea
Add missing space in documentation line (#19013) 2020-02-19 12:38:47 -08:00
Kabir Kwatra cd2f675b5b
Updated CHANGELOG-11 link (#19036) 2020-02-09 14:53:53 -08:00
Mariyan Dimitrov 3482077227
Remove command prompt from Windows example (#18906)
* Remove command prompt from Windows example

According to the [style
guide](https://kubernetes.io/docs/contribute/style/style-guide/#don-t-include-the-command-prompt),
the command prompt should not be included in the examples. Removing the
Windows command prompt from the jsonpath example.

Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com>

* Put Windows example inside note shortcode

I'm putting the Windows example in a Hug note shortcode to be consistent
with the rest of the documentation.

Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com>
2020-02-09 05:15:52 -08:00
Prasad Honavar 9da040d5d0
Update cheatsheet.md (#18975)
* Update cheatsheet.md

"List all pods in the namespace, with more details" command corrected by adding --all-namespaces

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

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-02-07 11:45:46 -08:00
Aman Gupta 7e0dd4f59f
(fix) Removed `-n test` from `kubectl get pv` command (#18877)
- PV are cluster scoped rather than namespaced scope
    - So, there is no need to list it by namespace

Signed-off-by: Aman Gupta <aman.gupta@mayadata.io>
2020-02-07 07:23:45 -08:00
Mariyan Dimitrov 5cef2f771e
en: Remove kubectl duplicate example (#18656)
With #16974 and the removal of --include-uninitialized flag, the
second
    and third examples of kubectl delete become equal, thus leading to
    duplication and being confusing. Suggest to remove the duplicate and
    replace it with another example in the future if needed.

    Observed in v1.16 and v1.17 documentation.

    Signed-off-by: Mariyan Dimitrov <mariyan.dimitrov@gmail.com>
2020-01-29 15:12:13 -08:00
Steve Bang e6308dc66e Correct description of kubectl (#18172)
* Correct description of kubectl

Given that `kubectl` is not a [command line interface (CLI)](https://en.wikipedia.org/wiki/Command-line_interface), I suggest calling it what it is -- a control utility (ctl = control). The term "tool" is commonly used in place of "utility," including the `kubectl` docs.

A CLI presents the user with a command prompt at which the user can enter multiple command lines that a command-line interpreter interprets and processes. Think of `bash`, `emacs`, or a SQL shell.  Since `kubectl` is not run in a shell, it is not a CLI.

Here are related docs that correctly refer to `kubectl` as a "command-line tool":

- https://kubernetes.io/docs/reference/tools/#kubectl
- https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-kubectl
- https://kubernetes.io/docs/tasks/tools/install-kubectl/
- https://kubernetes.io/docs/reference/kubectl/kubectl/

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

Co-Authored-By: Zach Corleissen <zacharysarah@users.noreply.github.com>

Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
2020-01-21 10:03:37 -08:00
zhouya0 0c57f2c46b add kubectl diff to cheatsheet (#18481) 2020-01-12 17:53:37 -08:00
chendotjs 0c2a5ceb0b Remove useless blank line (#18211) 2020-01-10 14:25:37 -08:00
Antoine Pelisse 40499ac391 Add "rollout restart" to cheatsheet (#18224) 2020-01-07 16:47:40 -08:00
Karen Bradshaw bcfbd1e8f3 regenerate ref docs, 1.17, script chgs (#18067)
* modify comp. tool reference config

* modify home dir to variable

* added k8s_release variable

* added kubectl cmd build

added temporary use of copied Makefile

* added build of api ref

* build api, kubectl cmd refs

* regenerate api with updated bootstrap

* regenerate api ref, corrected definitions
2020-01-03 09:39:40 -08:00
pierwill 6324ff5d75 kubectl cheatsheet edits (#18222)
* Capitalize terms in kubectl cheatsheet

* Edit output flag section of kubectl cheatsheet

Minor edit for readability
2019-12-30 10:53:39 -08:00
Tim Bannister cf5b8b200c Manually fix up home folder path in generated docs (#18037) 2019-12-09 16:47:30 -08:00
Damini Satya 75de70a431 Reference Documentation for Kubernetes Components and Tools for 1.17 (#18010)
* Reference Documentation for Kubernetes Components and Tools

* Update kube-apiserver.md

* Update kubectl.md
2019-12-09 16:31:31 -08:00
Damini Satya dff2f7b960 Official 1.17 Release Docs (#18011)
* feat: graduate TaintNodesByCondition to GA (#17073)

* Promote StartupProbe to beta (enabled by default). (#17164)

* Watch bookmarks to GA (#17026)

* feat: graduate ScheduleDaemonSetPods to GA (#17350)

* Update Docker installation instructions (#17405)

* Use exact version numbers for installing Docker in Ubuntu (#17428)

* Move CSIMigration and CSIMigrationGCE to Beta in Kubernetes v1.17 (#17478)

* Promote NodeLease feature to GA (#17189)

* Update docs for csi topology ga (#17408)

* Update RunAsUsername to beta (#17460)

* doc:Update RunAsUsername to beta

* doc: update samples - kubernetes.io/os is no longer beta

* Updating based on review feedback

* Promote Node-specific volume limits to GA (#17432)

* Promote PodShareProcessNamespace to stable (#17192)

* Promote PodShareProcessNamespace to stable

* Add for_k8s_version to feature-state label

Co-Authored-By: Tim Bannister <tim@scalefactory.com>

* Readd version-check to shareProcessNamespace task

* Update service load balancer finalizer doc for GA (#17438)

* Update Topology Manager docs (#17451)

* Added information on how device plugins can take advantage
of Topology Manager
* Updated the Topology Manager documentation to include additionalinformation and update some out of date sections

* Fix broken Topology Manager link (#17746)

Part of What's Next Device Plugin section

* Update CRD defaulting docs for GA (#17450)

* Add documentation for VolumeSnapshot Beta (#17233)

* Updating EndpointSlice documentation for beta release in 1.17 (#17411)

* (docs/dualstack): v1.17 updates (#17457)

* Add placehold doc updates for dualstack in 1.17

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Add Downward API and /etc/hosts Pod IP validation

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* remove addressed known issue via k/k pr 85246

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Remove known issue and add flag as part of k/k 79993

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* remove follow up placeholders

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Update verbiage

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Make IP addressing consistent throughout the task

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Update to status.podIPs

Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>

* Update content/en/docs/tasks/network/validate-dual-stack.md

Use set instead of env

Co-Authored-By: Khaled Henidak (Kal) <khnidk@outlook.com>

* add topology.kubernetes.io/zone, topology.kubernetes.io/region and node.kubernetes.io/instance-type labels to docs (#17498)

Signed-off-by: Andrew Sy Kim <kiman@vmware.com>

* Service topology alpha documentation (#17459)

* Update list of feature flags for in-tree plugins migrated to CSI (#17533)

Signed-off-by: Deep Debroy <ddebroy@docker.com>

* Update Node concept for TaintNodesByCondition going GA (#17577)

* feat: graduate ResourceQuotaScopeSelectors to GA in 1.17 (#17554)

* kubeadm: update the upgrade documentation for 1.17 (#17587)

* doc: Simplify Windows deployments with RuntimeClass (#16697)

* doc: Simplify Windows deployments with RuntimeClass

* Updating on review feedback

* doc: Adding windows-build label from enhancement 1301

* update doc for kubelet option --reserved-cpus (#17648)

* feat: update TaintNodesByCondition in feature gates table (#17377)

* Update docs for v1 resource quota configuration (#17547)

* AdmissionConfiguration v1 (#17548)

* Update WebhookAdmissionConfiguration examples (#17549)

* Update AWS EBS Migration Feature state (#16126)

* Add resource version section to api-concepts documentation (#16910)

* Add Resource Version semantics section to api concepts

* Clarify risks of going back in time, add details about compaction and watch cache sizes

* Apply suggestions from liggitt

Co-Authored-By: Jordan Liggitt <jordan@liggitt.net>

* remove pesudocode, apply feedback

* Fix typo

* Clarify equality rules

* Cleanup kubectl generators docs (#17609)

* Write ReplicationController without a space

* Drop mentioning unsupported cluster versions

* Fix capitalization for “API group”

* Tweak wording

* Avoid using deprecated generator in example

* add Antrea description in dev-1.17 (#17919)

* Promote VolumeSubpathEnvExpansion to GA

* Reference Documentation for the Kubernetes API for 1.17 (#18019)

* Update feature-gates.md (#18033)

* Reference Documentation for kubectl Commands for 1.17 (#18017)

* Update for v1.17 (#18034)

* Update config.toml(release-1.17) for 1.17 (#18031)
2019-12-09 16:11:29 -08:00
Zach Corleissen bb45a9818d Revert breaking commits (#17967)
* Revert "Remove dead links to old getting started guides (#17889)"

This reverts commit d6285eaac4.

* Revert "Fix a command in kubectl cheatsheet (#17888)"

This reverts commit e03f4b258c.
2019-12-05 15:22:49 -08:00
Qiming e03f4b258c Fix a command in kubectl cheatsheet (#17888)
Closes: #17883
2019-11-30 21:23:03 -08:00
praveen-kg e26dd31892 incorrect command for sort-by operation on pod (#17032)
* incorrect command for sort-by

kubectl get pods -n test --sort-by=.spec.capacity.storage, is incorrect for pod as pods will not have capacity.storage under .spec, rather it should be for PersistentVolume.

So change the command  

kubectl get pv -n test --sort-by=.spec.capacity.storage

* Update cheatsheet.md
2019-11-25 21:29:10 -08:00
Dr Nic Williams 41d5f445b2 jsonpath example of child with dot in name (#17625)
Promoting the solution shown in https://github.com/kubernetes/kubernetes/issues/23386#issuecomment-305348170
to formal documentation.
2019-11-17 17:27:41 -08:00
Luzhenxing 09d2b5848c add resource to be the same as kubectl api-resources (#17367) 2019-11-04 19:50:39 -08:00
Luzhenxing 3aab039ac4 change kubectl get deployment output (#17351) 2019-11-01 21:31:40 -07:00
Ismail Alidzhikov 18ee7f8d94 en: Remove deprecated --include-uninitialized flag (#16974)
Signed-off-by: ialidzhikov <i.alidjikov@gmail.com>
2019-10-23 08:36:19 -07:00
Alexander Zhukov cd1b7d6f45 Use the tidle shortcut in the --cache-dir default (#17115) 2019-10-23 06:28:15 -07:00
Yuk, Yongsu d437e8c6bc en: Change the full link in the document to an inline link. (#17057)
* Change the full link in the document to an inline link.

grep -r "https \: \ / \ / kubernetes \ .io" content/en/docs
Changed to inline link except the following list.
- URLs are mentioned directly in the body
- release note
- url to blog
- url to community
- Url to be redirected

* Apply suggestions from code review

Co-Authored-By: June Yi <june.yi@samsung.com>
2019-10-23 06:20:14 -07:00
Tim Bannister 6a954bb700 Replace sample IP address with documentation use address (#16867)
108.59.85.141 is a genuine IPv4 address; at the time of writing it's
assigned to Google LLC / Google Cloud Platform. Use a documentation IPv4
address instead.
2019-10-14 16:05:51 -07:00
Ahmad Bani jamali 57047b2c2c a small fix in the delete all pods (#16824)
There was a typo in kubectl -n my-ns delete pod,svc --all
2019-10-14 15:33:51 -07:00
Daniel Laing a2edf8f934 Minor text edit (#16760)
Clarified the description of `kubectl edit`.
2019-10-14 15:27:51 -07:00
Peter Mikitsh 3964d24053 fix(cheatsheet): update context cmd description (#15935)
* fix(cheatsheet): update context cmd description

* chore: remove newline
2019-10-14 14:55:51 -07:00
Hardy e5863effe6 Add a example for union operator in the shell env (#16282)
In the current example, single quotes are used, but the union operator can  be confusing.
Incorrect:
`kubectl get pod -o=jsonpath='{.items[*]['metadata.name','spec.nodeName']}'`  
Correct:
`kubectl get pods -o=jsonpath="{.items[*]['metadata.name', 'status.capacity']}"`
2019-10-08 15:55:51 -07:00
Song Shukun 4e1ebaa7c8 Rephrase sentence in k8s.io/docs/reference/kubectl/conventions/ (#16732) 2019-10-07 20:45:11 -07:00
Ismail Alidzhikov 5af784afc0 Remove kubectl stop (#16677)
Signed-off-by: ialidzhikov <i.alidjikov@gmail.com>
2019-10-06 04:35:09 -07:00
Pengcheng Chen 657c976468 Fix indent issue in cheatsheet.md (#16574) 2019-09-27 14:22:43 -07:00
Melony QIN 62b279afbb add kubectl run deploy pod into specific namespace (#15825)
* add kubectl run deploy pod into specific namespace

* add my namespace
2019-09-27 14:04:42 -07:00
Ismail Alidzhikov 5f9fe16f28 Align cheatsheet comments (#16178)
Signed-off-by: ialidzhikov <i.alidjikov@gmail.com>
2019-09-27 13:29:36 -07:00
Deepika Pandhi 7bb1acf3dd removed longer version to fetch labels for pods #14778 (#16268)
* updated OR comments

* removed older long version to fetch labels for pods to use only kubectl get pods --show-labels
2019-09-27 13:03:37 -07:00
Pengcheng Chen 54af88fad2 Update the kubectl config command in cheatsheet.md (#16556)
`kubectl config view -o jsonpath='{.users[].name}' ` in the doc doesn't get the list of users as described in the comment actually.
To get the list of users, the json path should be `'{.users[].name}' `
2019-09-25 19:25:06 -07:00
Deepika Pandhi 3eb7612e88 Removed uninitialized flag reference from kubectl cheetsheet (#16485) 2019-09-22 20:21:22 -07:00
Alena Varkockova 3534a19a55 Fix links for kubectl commands (#16450)
* Fix links for kubectl commands

* Fix remaining links
2019-09-20 11:27:26 -07:00
Karen Bradshaw 234ff08588 update generated comp. files, 1.16 (#16339)
* update generated comp. files, 1.16

* update flags

* Update kubelet.md

* table updates
2019-09-17 09:16:25 -07:00
Melony QIN 7796f3cea6 add rollout history and back to specific revision (#15818)
add rollout history and back to specific revision
2019-08-15 20:36:32 -07:00
Zane Bitter 8344dda2f6 Use literals in jsonpath examples (#15775)
It's very difficult to figure out e.g. the correct quotes to use from
regular text that is subject to being converted for typographers quotes.
Use code literals instead to ensure that nothing is modified, and to
distinguish literals from accompanying text.

Signed-off-by: Zane Bitter <zbitter@redhat.com>
2019-08-11 17:53:10 -07:00
lyveng 306a6201b8 Fixed broken link to logging conventions in kubectl cheatsheet (#15699) 2019-08-06 17:12:54 -07:00
Melony QIN a17f259b8d update cheat sheet (#15677)
add sort by capacity
2019-08-05 20:11:53 -07:00
Tim Bannister 20e45f1331 Add concept page for Operators (#14458)
* Add concept page for Operator pattern

* Link to article about Operator best practices
2019-07-11 17:57:07 -07:00
devasat a90f783820 cheatsheet.md: fix command that queries for label version (#15355)
'rc' in the command is interpreted as pod name
2019-07-11 16:13:05 -07:00