Commit Graph

247 Commits

Author SHA1 Message Date
Jizu Sun a6f27be7e1
Update content/en/docs/concepts/overview/working-with-objects/finalizers.md
Co-authored-by: Qiming Teng <tengqm@outlook.com>
2021-10-19 10:48:54 +08:00
Tim Bannister dc84f0cb97 Mark figures' intended size
This commit activates Sass styling to make image sizes more responsive
on the rendered page.
2021-10-17 21:31:52 +01:00
Shabir Mohamed Abdul Samadh b3ff003048
doc: accommodate re-write of intro line 2021-10-14 20:31:16 -04:00
Shabir Mohamed Abdul Samadh 86b6584d0a
doc: accept review suggestion 2021-10-14 20:25:30 -04:00
shabirmean 0ca22ac568 doc: update definition for namespaces
Update namespace definition to not use _Virtual Clusters_ as a means of explaining namespaces.

Motif: KubeCon NA 21 Talk on ***"Beyond Namespaces: Virtual Clusters are the Future of Multi-Tenancy - Lukas Gentele, Loft Labs"***
2021-10-14 15:06:29 -04:00
Jizu Sun 5c0dd0414b remove blank 2021-10-09 10:50:09 +08:00
Jizu Sun 95a772fea7 fix link 2021-10-09 10:47:55 +08:00
naisu 5220cdf8d2
Explain leases in `kube-node-lease` namespace doc
Add a reference to `Lease` resource api doc

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2021-08-26 02:22:45 +02:00
naisu 497a5231df
Improve wording of `kube-node-lease` namespace doc
Correct grammar and provide a reference to more detailed documentation of concepts mentioned.
2021-08-25 17:20:22 +02:00
Ramdas Potale 988a62b463
Update components.md
I think adding the "for" word in the below sentence makes more sense.

"This document outlines the various components you need to have "for"
a complete and working Kubernetes cluster."
2021-08-21 09:27:03 +05:30
Kubernetes Prow Robot cdefcc3a8b
Merge pull request #29477 from brakmic/patch-1
trivial: typo
2021-08-19 20:39:24 -07:00
Rey Lejano 64f91d8e2c add note on owner references in garbage collection page
add note on owner references to owner dependents page
2021-08-19 17:43:09 -07:00
Harris Brakmić 2b268b1a76
trivial: typo
A small typo.
2021-08-19 22:07:59 +02:00
David M. Lentz e47fba2b92
Fix typo 2021-08-06 07:46:25 -06:00
Tim Bannister cba4f57124 Update link from Working With Objects to Kubernetes API Reference 2021-08-04 22:42:14 +01:00
Qiming Teng 651a0c2183 Amend the annotation concept 2021-07-28 11:30:35 +08:00
Kubernetes Prow Robot d078b427b8
Merge pull request #28870 from shannonxtreme/gc-docs
Create garbage collection docs
2021-07-26 22:40:45 -07:00
Qiming Teng 26748e36b0 Fix service name requirement 2021-07-25 19:57:50 +08:00
Kubernetes Prow Robot 959d0c759b
Merge pull request #28738 from vaibhav2107/link-labels
Add the links in docs/concepts/overview/working-with-objects/labels/
2021-07-23 19:03:06 -07:00
Mengjiao Liu 9eb90fddd8 Fix Observability format to be consistent with other items 2021-07-23 11:09:55 +08:00
Shannon Kularathna b1573ad314 Create garbage collection docs 2021-07-13 20:32:50 +00:00
vaibhav 1f42a30967 Add the links in docs/concepts/overview/working-with-objects/labels/ 2021-07-01 19:08:36 +05:30
Kubernetes Prow Robot 5dfcf92490
Merge pull request #28447 from tengqm/fix-file-modes
Remove exec permission on markdown files
2021-06-17 19:04:04 -07:00
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
Alex bff31ff2b4
Correcting entry in Multiple Resource Types
We *can* use field selectors across multiple resource types.
2021-05-26 08:53:51 +05:30
Kubernetes Prow Robot 6db449cdab
Merge pull request #27839 from jai/jai/fix-25639
docs(overview): add info on k8s abbreviation
2021-05-10 15:17:37 -07:00
toshokan 50a5dbb21d
Fixes grammar typo 2021-05-07 16:08:57 -04:00
Quentin Bisson bca8c4b6e5
Add created by label (#27612)
* Add created by label

* Update content/en/docs/concepts/overview/working-with-objects/common-labels.md
2021-05-06 10:10:00 -07:00
Jai Govindani 170304e282
docs(overview): add info on k8s abbreviation
Signed-off-by: Jai Govindani <jai@honestbank.com>
2021-04-30 21:43:56 +07:00
Mauricio Vásquez 08b8930751
Update content/en/docs/concepts/overview/working-with-objects/labels.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2021-04-22 06:59:44 -05:00
Mauricio Vásquez 4f319fd5ab Fix requirements for label value
Value *can* indeed be empty.

Fixes: bd55d498df ("Clarify requirements for label value syntax")

Signed-off-by: Mauricio Vásquez <mauricio@kinvolk.io>
2021-04-20 13:43:29 -05:00
Tim Bannister 965aa51daf Merge master into dev-1.21 to keep in sync, plus latest API reference
This sync merge includes API reference updates.
2021-04-06 21:38:24 +01:00
Kubernetes Prow Robot 7841e9e509
Merge pull request #26725 from cristiklein/patch-1
Change to inclusive naming
2021-04-05 17:39:19 -07:00
Tim Bannister 6c935b6f90 Improve docs for NamespaceDefaultLabelName 2021-04-01 21:43:47 +01:00
Kubernetes Prow Robot 2d31364e3c
Merge pull request #26920 from SergeyKanzhelev/nameAsIdentifier
added note about the name being an identifier
2021-03-27 01:52:43 -07:00
Cristian Klein c5e0cc66d8
Update content/en/docs/concepts/overview/components.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2021-03-18 21:10:04 +01:00
Karen Bradshaw 3ff5ec1eff clean up use of word: just 2021-03-17 19:57:40 -04:00
Sergey Kanzhelev eb4b67d8a2
Update content/en/docs/concepts/overview/working-with-objects/names.md
Co-authored-by: Celeste Horgan <celeste@cncf.io>
2021-03-16 23:22:10 -07:00
Sergey Kanzhelev 6c60620ad4 added note about the name being an identifier 2021-03-06 06:42:50 +00:00
Kubernetes Prow Robot d54500d55d
Merge pull request #25918 from slashr/master
Replaced deprecated ReplicationController with JobController
2021-02-27 19:20:38 -08:00
Cristian Klein 79113f3f68
Change to inclusive naming
See https://inclusivenaming.org/ on why "multi-master" should be avoided.
2021-02-26 10:32:30 +01:00
veyu bd55d498df
Clarify requirements for label value syntax 2021-02-24 18:58:22 +01:00
Karen Bradshaw 3fd65482e8 clean up use of word: simply 2021-02-07 12:15:29 -05:00
Karen Bradshaw 7d9916af0c clean up use of word: easy 2021-02-01 15:14:25 -05:00
slashr 976c260ef4 Modified description 2021-01-03 10:22:36 +05:30
slashr 34f1d1911c Replaced deprecated ReplicationController with JobController for reference 2021-01-03 00:26:17 +05:30
AUT0R3V c4b818c1f1
Update common-labels.md 2020-12-30 14:35:16 +05:30
Mike Gehard 9c38911446
Make wording in overview more in line with the description
The description talks about the server one way and the overview text talks about it a bit differently.

This change aligns them and make them easier to understand in my opinion.
2020-12-08 13:07:34 -05:00
Kubernetes Prow Robot d6636e50c2
Merge pull request #24474 from sftim/20201010_clarify_api_versions_redux
Tweak docs about Kubernetes API versions
2020-12-03 08:51:00 -08:00
ying 8e0973b22b
Update md format to make it more easier to read
Before the changes,  the statement of the set-values messed up together, so it is hard to read it out clearly.
2020-12-02 23:59:14 +08:00
Noah Kantrowitz fcdcfba359
Containers don't get their own CPU (#24659)
* 🐛 Containers don't get their own CPU

This is overly broad, in all default setup containers all share the underlying host CPUs so I wouldn't say they "have their own".

* Change wording to "share of CPU" to more closely reflect reality.

Co-authored-by: Tim Bannister <tim@scalefactory.com>

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-10-22 06:45:36 -07:00
Qiming Teng 070023b24a Fix links in concepts section 2020-10-22 14:24:56 +08:00
Tim Bannister 4e0b662954 Tweak docs about Kubernetes API versions
Co-authored-by: Karen Bradshaw <kbhawkey@gmail.com>
2020-10-21 15:07:46 +01:00
Tim Bannister 78351ecaf5 Transfer “Controlling Access to the Kubernetes API” to the Concepts section
Readers from several different backgrounds will find it useful to know
about how Kubernetes controls access to its API. Promote this overview
to the Security subsection of Concepts.
2020-10-20 23:41:56 +01:00
Tim Bannister 3edb970570 Move API overview to be a Docsy section overview 2020-10-20 23:41:54 +01:00
Kubernetes Prow Robot 5857387107
Merge pull request #24149 from sftim/20200926_set_priority_for_key_pages
Set sitemap priority for key pages
2020-10-13 10:44:27 -07:00
Tim Bannister dd88014f30 Remove statement about future of namespaces 2020-10-10 19:15:14 +01:00
Qiming Teng 3d416c6417 Clarify what API versions mean 2020-10-10 08:51:14 +08:00
Tim Bannister 961438877d Set sitemap priority for key pages
The very key pages get 1.0 priority; other good landing pages get 0.9
and the remaining pages have a default priority, 0.75.
2020-09-26 14:06:22 +01:00
Qiming Teng 3cc1371651 Remove duplicated content in concepts and reference
We currently have quite some contents duplicated between the concepts
and the reference section, which is not good. This PR is an effort to
remove the duplicated content from the two pages while providing links
for readers to check the reference easily.
2020-09-19 08:36:47 +08:00
Tim Bannister 94b2f857bb
Update Kubernetes architectural diagram (#23138)
* Update Kubernetes architectural diagram

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

* Switch Kubernetes Component diagram to SVG

Co-authored-by: David Kypuros <davidkypuros@gmail.com>
2020-08-28 08:49:50 -07:00
TAKAHASHI Shuuji c6a96128c4
Replace special quote characters with normal ones. 2020-08-11 21:05:22 +09:00
Qiming Teng c8f4704873 Fix links in concepts section (2) 2020-08-02 09:11:14 +08:00
Tim Bannister 49eee8fd3d
Revise Pod concept (#22603)
* Revise Pod concept

Adapt the existing Pod documentation to suit the Docsy theme, by
promoting the Pod concept itself to /docs/concepts/workloads/pods/

Following on from this, update the Pod Lifecycle page to cover the
lifecycle of a Pod and follow on directly from the Pod concept,
for readers keen to understand things in detail.

This change also removes the automatic contents list from the Pod
overview page. Instead, the new page links to all the pages
inside the Pod section.

* Update links to Pod concept

Link to updated content

* Incorporate Pod concept suggestions

Co-authored-by: Celeste Horgan <celeste@cncf.io>

* Revise StatefulSet suggestion for Pod concept

Co-authored-by: Celeste Horgan <celeste@cncf.io>

Co-authored-by: Celeste Horgan <celeste@cncf.io>
2020-07-26 20:18:16 -07:00
Kubernetes Prow Robot 9880cbd671
Merge pull request #22318 from tengqm/fix-19996
Fix pages that reference removed API groups
2020-07-26 19:38:18 -07:00
Kubernetes Prow Robot 9e0d6d8110
Merge pull request #22399 from rmauge/patch-1
Updates for minor spelling correction
2020-07-13 08:30:33 -07:00
Jens Reimann f4d296d1c3 Fix the example values in the first examples
In the lower part of the document `instance` is derived from the `name` field. However, in the beginning of the document the value of the `instance` field is aligned with the `part-of` field. Which seems wrong, reading through the rest of the page.

Signed-off-by: Jens Reimann <jreimann@redhat.com>
2020-07-10 12:30:09 +02:00
Raymond Maugé 52f2920d5f
Updates minor spelling correction
"can not" to "cannot"
2020-07-06 18:03:45 -04:00
Qiming Teng e097b93c8e Fix pages that reference removed API groups
Quite some resources have been moved out of the `extensions` API group
since 1.18; the `apps/v1beta1` and `apps/v1beta2` group versions are
also dropped. This PR updates the pages which still reference such API
groups or group versions.
2020-07-04 13:23:26 +08:00
Kubernetes Prow Robot 86d373b0f9
Merge pull request #21997 from sftim/20200622_tidy_concepts_section_post_docsy
Tidy concepts section post-Docsy
2020-06-27 17:12:14 -07:00
Kubernetes Prow Robot de02f2f27d
Merge pull request #22054 from soltysh/kubectl_run_updates
Update kubectl run from docs where necessary
2020-06-26 14:30:14 -07:00
Tim Bannister 3ff7312cff Add descriptions to Concept sections
Each section directly beneath Concepts gains a description.
2020-06-25 17:09:58 +01: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
Rohit Mohta d41074866e Add a note about reserved namespace prefix
A namespace with prefix 'kube-' is reserved, even though k8s will let you create that
2020-06-23 18:10:41 -07:00
Roman Marusyk 3823b6239d
Improve kubernetes description 2020-06-17 19:32:06 +03:00
Kubernetes Prow Robot 26eeae1a29
Merge pull request #21674 from cloudmelon/melonbranch
Add node lease namespace
2020-06-14 10:03:56 -07:00
Qiming Teng af17530b46 Fix dangling link for CRD 2020-06-13 12:37:51 +08:00
cloudmelon 6cf2449a2e add lease namespace new commit 2020-06-11 22:18:27 +01:00
Karen Bradshaw 5fe8c3ca5e move setup konnectivity svc
move api-access to extend-kubernetes
2020-06-10 16:06:01 -04:00
Karen Bradshaw ecc27bbbe7 add en pages 2020-06-09 19:33:15 -04:00
Sebastian Winkler 2f6093bfd7
workaround for new lines in field selector example 2020-06-08 19:10:26 +02:00
Tim Bannister 1b78735e6e Revise Kubernetes API concept
- update request header table
- drop references to deprecated details (eg Swagger)
- reword to match website style guide
2020-06-02 22:14:42 +01:00
ialidzhikov 9eca2d9bd7 Nit: align namespaces output
Signed-off-by: ialidzhikov <i.alidjikov@gmail.com>
2020-05-19 21:55:08 +03:00
Adam Kaplan 55e17b86f2 mv "Assign Pods" and "Taints and Tolerations" concepts to "Scheduling and Eviction"
* Moved "Assigning Pods to Nodes" article to Concepts -> Scheduling and Eviction
* Moved "Taints and Tolerations" article to Concepts -> Scheduling and Eviction
* Updated weight of the "Kubernetes Scheduler" article so it appears first
* Updated redirects
* Replaced links to "Assigning Pods to Nodes" and "Taints and Tolerations" articles
to avoid redirects.

Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
2020-05-11 11:29:16 -04:00
Kubernetes Prow Robot 2da45fa3a6
Merge pull request #17509 from sftim/20191109_node_concept_improvements
Improve Node, Taints, and Tolerations concepts
2020-05-09 08:59:51 -07:00
Tim Bannister c5abd7704a Improve Node, Taints, and Tolerations concepts
- Use glossary shortcodes in Node concept
  Add glossary tooltips to help new readers take in unfamiliar concepts.
- Move minion hint to glossary
  The page about Node need not mention the former name (minion): it has
  been many releases since the name change.
  Instead, add a hint to the full glossary definition.
- Use note shortcodes where appropriate
- Order node management section first in concept page
- Drop list of components that act on Nodes
  With Operators and CustomResourceDefinitions now common, plus the
  cluster API, it's less easy to give a definitive list of components that
  interacr with Node objects.
- Tidy old mentions of GA features for Node
- Give node tainting by condition its own section
- Introduce toleration concept before using it
- Mention version in TopologyManager feature state
- Other rewording
- Tidy Node condition table
- Explain SchedulingDisabled synthesized condition
- Drop details of supported versions for NodeRestriction
  Assume that cluster version is v1.13 or later
2020-04-28 23:30:05 +01:00
Tim Bannister 5db3af4938 Revise cloud-controller-manager documentation 2020-04-21 19:59:45 +01:00
Fabio Alessandro Locati f477fd8d37
control plane should not be capitalized 2020-04-18 14:45:57 +02:00
Kubernetes Prow Robot ba59b859b1
Merge pull request #20253 from chrizel/chrizel-patch-1
Added missing word back again
2020-04-17 07:53:06 -07:00
Adam Kaplan 1bb09e6d0d Rename "Scheduling: concept as "Scheduling and Eviction"
* Rename `docs/concepts/scheduling` to `docs/concepts/scheduling-eviction`
* Retitle concept header to "Scheduling and Eviction"
* Update redirects
* Update internal links (en only)

Part of proposal #19081

Signed-off-by: Adam Kaplan <adam.kaplan@redhat.com>
2020-04-14 08:51:00 -04:00
Christian Zeller e1d688af2e
Update kubernetes-objects.md
Added missing word
2020-04-11 21:58:52 +00:00
Melony QIN 1817100ed5
Add namespaces for 1.17 + default namespace
Each Node has an associated Lease object in the kube-node-lease namespace. Lease is a lightweight resource, which improves the performance of the node heartbeats as the cluster scales.
2020-04-02 18:59:02 +01:00
Prasad Katti 3c64ac4d96
Add a question mark to the end of the question (#19990) 2020-03-31 13:43:28 -07:00
inductor 4297f3b29c
Update nginx to modern versions (#19198)
* update nginx versions

* update

* update examples
2020-03-17 10:48:23 -07:00
Tim Bannister f9aa0bc0e5
Revise “What is Kubernetes” (#19534)
* Expand list of places Kubernetes can run

As well as GKE, there are AKS, EKS, and more.

* Add page description

* Link to blog post about Borg

The blog post has (a better) link to Google's paper about Borg. Because
of the historical relevance of that paper and that blog article to the
history of Kubernetes, I think it's OK to link there.

Linking to the blog article provides a less academic introduction to the
history of Kubernetes, with the option to click through and learn things
in detail.
2020-03-15 23:06:35 -07:00
Tim Bannister 19c883dd82
Admit that some objects don't have a spec (#18050)
Whilst most objects have a spec, it will confuse readers who come to
this page from a page about an object that doesn't (eg Secret,
Namespace, Role).
2020-03-15 22:58:35 -07:00
makocchi 6c0e47e652
Add defails about enabling or disabling extensions/v1beta1 api group (#18842) 2020-03-15 22:12:35 -07:00
Chris Chinchilla 01e7453cdf
Update "what is kubernetes" subheading (#19115)
* Update what-is-kubernetes.md

The sub heading felt awkward as it was asking a question, but there was no question mark. As question marks in headings are not ideal in technical documentation anyway, I thought swapping the word order slightly made it sounds _slightly_ better.

* Update content/en/docs/concepts/overview/what-is-kubernetes.md

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

Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-03-15 21:50:35 -07:00
Qiming Teng ceccbc049c
Resource name constraints (1) (#19106)
xref: #17969, #19099, #18746
2020-02-19 15:44:30 -08:00
Kirk Larkin 3fce287782
Add missing "in" for DeploymentSpec link (#19135) 2020-02-16 06:21:28 -08:00