* 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>
* 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>
These markers where introduced to describe topology of lists, maps,
structs - primarily in support of server-side apply.
Secondarily, a small typo fix:)
- Use the glossary to correctly reference runtimes
- Updated runtime class documentation for CRI-O
- Removed rktlet from runtimes since its EOL
Signed-off-by: Sascha Grunert <sgrunert@suse.com>
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>
* Use Control Plane instead of Master
* improve image. The SVG was not matching the PNG, so I basically had to re-create it from scratch. I kept the visual similarities as mush as possible
* remove tautological phrase
* fix glossary references as well
* improve cluster glossary to move from Master to Control Plane
* improve english form
* Fix pod status phases + more
A number of improvements introduced in the glossary entry for Pod Lifecycle
* Completed / CrashLoopBackOff were removed from the list of pod status phases
* The link to PodStatus in the generated kubernetes api was parametrized regarding version
* Minor editorial changes
* Rework Pod Lifecycle entry to better describe term
The term definition was reworked after the review comments from
kbhawkey
* Add tooltip for addons in Hello Minikube page
* Update glossary title and add more descriptive info
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
- move the sections about custom certificates and external CA
to the kubeadm-certs page
- minor cleanups to the kubeadm-certs page, including updated output
for the check-expiration command
- link the implementation details page to the new locations
for custom certs and external CA
In 203391835d, an explicit anchor '#noderestriction' was added to the
NodeRestriction section of the Admission Controllers reference document,
which caused the link to the '#NodeRestriction' anchor in the Node
Authorization document to break and lead to the top of the Admission
Controllers document instead of to the NodeRestriction section further
down the page. This change fixes the link to point to the intended
section instead of to the whole page in general.
* 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)
* 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.
* 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
After PVCProtection was deprecated in kubernetes/website@be48fb38e9 was
removed task used to describe concept of it. Link wasn't removed
everywhere (this PR removes it) and was living in site documentation
since then.
In Addition from tasks.yaml removed link pvc-protection articles
(also not exists).
* Tidy feature gate metadata
* Tweak feature gate headings
Use sentence case where appropriate
* Add feature gate explanation for GA
* Add what's next section to feature gate page
* Signpost readers to explanation of feature gate stages
Add further details about the difference between the
two feature gate tables. The additional information and
table titles should help authors when creating or
updating the table entries.
Rearrange the order of the kubeadm init phase subcommand documentation
to match that in which the commands are executed in kubeadm init. This
change doesn't introduce any changes to actual content of the
documentation and only modifies the order in which it is presented.
- renamed docs/reference/kubernetes-api/index.md
- added weight to files in docs/reference/kubernetes-api
- attempt to clean up labels-annotations-taints.md
- updated _redirects file
* 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>
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.
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']}"`
`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}' `
This PR separates the graduated/deprecated feature gates into a separate
table. When updating the table contents by browsing the source code, we
also found some missing items which are added in this PR as well.
* storage: CSI inline volumes in beta
* storage: remove historic information for CSI inline volumes
As pointed out during review, this information is better captured in
the feature gates reference page.
* Added documentation to support Topology Manager feature in Kubelet.
* Added new document outlining feature
* Updated feature-gates.md to include feature gate for feature
* Update kubelet.md to include kubelet flags for feature
* Added Topology Manager reference to relevant pages
Co-authored-by: Tim Bannister <tim@scalefactory.com>
* Update Topology Manager Policies section
Also, I've snuck in a trivial update for the ShareProcessNamespace
feature gate, adding an "Until" version which had been omitted.
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Create a concepts page, link to it from scheduler concept page,
update feature gates reference and describe briefly in the
runtime-class page.
Signed-off-by: Eric Ernst <eric.ernst@intel.com>
* Documenting how to use EvenPodsSpread feature
* address comments
* address comments
* address sftim's comments
* move to folder workloads/pods
* address comments
* move yamls to examples folder and reference back in the document
* Link from scheduling to topology spread constraints
This patch turns the glossary entry for "workloads" into "workload" in
order to be consistent with other terms in the glossary. In addition,
the definition is modified to match what the overlay tip for the
"Workload" tag at the top of the glossary page says, which is
"Applications running on Kubernetes".
A workload is *not* a core object itself. Rather, it is a general
concept. Various other core objects describe different types of
workloads, and the glossary definition is appropriately modified to make
that clear.
Fixes Issue #14107
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>
* Update device plugin docs for Kubernetes 1.14
& related pages
This change is mainly about feature-state shortcodes & similar.
(if there's a way to get the short version string, eg "1.14" rather
than "v1.14", then that could go in place of the hard coded value
in this commit).
* Fix code block formatting
eg code blocks incorrectly marked as:
```shell
* Use glossary shortcodes where appropriate
* Hyperlink to Prometheus
* Tidy Markdown formatting
* Change example vendor domain name
Use a name inside ".example" to highlight that this is a DNS
domain name.
* Reword device plugins documentation
* Tweak headings for device plugins
* Add "what's next" to device plugins docs
* Tweak wording for device plugins docs
* Add KubeVirt device plugins
The content describing authorization modes used the term "authorization
modules" erroneously. This patch uses the term "mode" as is appropriate
but keeps the section link header the old "authorization-modules" in
order not to break older links.
- Mark as relevant to networking.
- Unmark as a core object. kube-proxy is not an API object.
- Fix hyperlink to reference docs.
- Include hyperlink in definition. This is used in /docs/concepts/overview/components/
- Revise wording.
* remove doc from kubeadm-init.md which is duplicated in kubelet-integration.md
This section in reference/setup-tools/kubeadm/kubeadm-init.md seems to significantly overlap with setup/production-environment/tools/kubeadm/kubelet-integration.md - looks like someone copy/pasted it at some point? The information in kubelet-integration.md looks more up to date than this (e.g. there actually is no `--allow-privileged=true` or `--network-plugin=cni` here?). Therefore lets delete the sections content, and have a short line linking to the other one.
If this is accepted, then #15421 is moot (because #15423 moves it to the new place).
* shorten link re. removed doc from kubeadm-init.md
as requested in https://github.com/kubernetes/website/pull/15424/ review
* drop https://kubernetes.io from link in kubeadm-init.md
* Revert "shorten link re. removed doc from kubeadm-init.md"
This reverts commit f128ce7dc2.
* fix bad wording
* update kubeadm-init.md based on kbhawkey review feedback
* remove duplicate sentence in kubeadm-init.md
* Adding cgroup to glossary
Adding cgroup to glossary
* Removed value from aka field
* Updating cgroups.md with cgroups changed to cgroup
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Modified cgroups to singular
* Title update and remove etc
Updated the title as mentioned in v2 docs and removed etc
* Update cgroups.md
Adding different short description
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Updated cgroups.md short description
* Changed file name and glossary title
* Changed the title to make it consistent
All admission control plugins support two modes for specifying their
configuration: linking to an external file using the `path` key in the
shared admission configuration file, or directly embedding the
configuration using the `configuration` key in the shared admission
configuration file.
This commit makes the ImagePolicyWebhook documentation mention the
embedded configuration option.
Mariyan Dimitrov
Prasad Honavar
Tim Bannister
Aman Gupta
Maria Ntalla
Julian V. Modesto
Karen Bradshaw
Sascha Grunert
Gerasimos Dimitriadis
Joe Betz
Steve Bang
YAMAMOTO Takashi
Fabio Alessandro Locati
Maya Kaczorowski
Jacky Wu
Rob Scott
Paco Xu
Habib Ridho
zhouya0
chendotjs
Lubomir I. Ivanov
Jin Hase
Antoine Pelisse
Mikalai Radchuk
Colleen Murphy
Oleg Butuzov
pierwill
makocchi
Xiang Dai
chendotjs
vishakha
Damini Satya
Zach Corleissen
mhamdi semah
umiblue
Qiming
Tomasz Prus
praveen-kg
reung37
Alena Varkockova
chentanjun
chentanjun
Dr Nic Williams
sivanzcw
Mitesh Jain
Lubomir I. Ivanov
Joseph Moukarzel
Luzhenxing
Tunde Olu-Isa
Jim Angel
Jordan Liggitt
Jennifer Buckley
Donald Little
Ashish
Ismail Alidzhikov
Alexander Zhukov
Yuk, Yongsu
aimeeu
Deep Debroy
David Eads
Ahmad Bani jamali
Daniel Laing
Peter Mikitsh
Jian Zeng
Yushiro FURUKAWA
Mike Danese
Hardy
Song Shukun
Tony Compton
Grant Griffiths
J M
Pengcheng Chen
Melony QIN
Deepika Pandhi
Marian Steinbach
conwaychriscosmo
simplytunde
k1eran
houjun
Praveen Sastry
joshmsamuels
Kubernetes Prow Robot
Haowei Cai (Roy)
Patrick Ohly
Louise Daly
Lee Verberne
Eric Ernst
Wei Huang
John Griffith
Matthias Bertschy
RA489
Jay Pipes
Clayton Coleman
Anders Eknert
Kevin Wiesmüller
Wojciech Tyczynski
Justin Biggs
Marek Counts
Zane Bitter
Johannes Liebermann
lyveng
Patrick East
Jesse Hu
Sunghoon Kang
Akshay Mankar
Stuart P. Bentley
Michael Vorburger ⛑️
ljnaresh
Taahir Ahmed
mohamed chiheb ben jemaa
devasat
Michael Shen
Hypo
Kohei Toyoda
Brian Grant
Maruf Tuhin
icheikhrouhou
Prasad Katti
Barnabas Makonda