Commit Graph

217 Commits

Author SHA1 Message Date
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
Tim Bannister 2faf1024d9
Tweak linking for Kubernetes object concept (#18122)
- Add a link from /docs/reference/using-api/api-concepts/
- Tweak other incoming links to match
2020-02-10 19:24:01 -08:00
Naoki Oketani ae7ace0f71
Replace links with redirect destination (#19038) 2020-02-10 18:18:01 -08:00
Shivesh Abhishek b647b6ec55 Update field-selectors.md (#18641) 2020-01-18 08:41:35 -08:00
Fabio Alessandro Locati 99ca9c0397 Use Control Plane instead of Master (#18438)
* 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
2020-01-16 05:24:22 -08:00
Deepankar Malhan 51aaacaf76 Update kubernetes-api.md (#17406)
* Update kubernetes-api.md

Updated the docs to reflect a change that has already been made in v1.14 instead of going to be made in v1.14 with us being at v1.16 now.

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

Co-Authored-By: Barnabas Makonda <6409210+makoscafee@users.noreply.github.com>

Co-authored-by: Barnabas Makonda <6409210+makoscafee@users.noreply.github.com>
2020-01-15 03:11:33 -08:00
Sharjeel Aziz 49ca117430 Minor heading update according to the guideline (#17747)
* Minor heading update according to the guideline

Fixed title of the document to use title case as described in the community guidelines.

* Capitalization fixes.
2019-11-25 20:41:10 -08:00
Tanveer Alam 6ee68467a7 Added Open Service Broker reference link (#17721)
`https://openservicebrokerapi.org/` contains information such as `what are service brokers?`, how they work, building services for Kubernetes using `Open Service Broker API` etc.
2019-11-21 12:21:29 -08:00
Supriya Sirbi ab1a66f158 #13332 No diagram on /concepts/overview/components/ (#17157)
* #13332 No diagram on /concepts/overview/components/

* Added Components of Kubernetes png file

* Added svg file
2019-11-13 02:45:12 -08:00
CRC 66243a6dc2 Update label selectors caution about OR operator (#17477) 2019-11-11 18:24:06 -08:00
Luzhenxing 5522e5ddf9 add the same namespace (#17394) 2019-11-04 22:24:38 -08:00
Tim Bannister 1ab35587c9 Reword Notes & UIDs concept (#16202)
- Note that Kubernetes UIDs are UUIDs
- Don't mention container name in Name concept (it could mislead
  readers)
2019-10-14 15:55:50 -07:00
Tim Bannister 6a4c73b112 Rename architecture section (#16286)
* Rename architecture section

"Kubernetes" goes without saying. This section is mainly talking about
cluster architecture, so make the title match that.

* Introduce “cluster” before Cluster Architecture section

Make sure the reader can learn what a cluster is before they read about
elements of cluster architecture.
2019-10-09 14:07:50 -07:00
Xin Jin cd1d62ab0f Update kubernetes-objects.md (#16747)
Make `spec` one of the required items.
2019-10-08 17:57:51 -07:00
Tim Bannister 9a7b191bcc Add concept page about Controllers (#15733)
* Add controller concept

* Fix controller glossary entries

* Link from Understanding Kubernetes Objects to Controllers
2019-10-02 10:06:08 -07:00
Michal Srb 351a306344 Validate namespace preference in current context with --minify option (#16448)
Signed-off-by: Michal Srb <michal@redhat.com>
2019-09-25 10:44:02 -07:00
Jay Pipes c1cf090946 Correct improper use of "comprised" (#16132)
Corrects an improper use of "is comprised of".

Fixes Issue #16123
2019-09-04 20:08:51 -07:00
Scot Marvin 7671f4bfb2 Changed a confusing heading (#15453)
I changed a question that had no question mark into a statement. I also changed the heading from the first person to the second person, because the topic it treats the reader as the second person everywhere else.
2019-07-16 17:22:35 -07:00
Tim Bannister 8e6c0abc54 Revise Addons section of components (#15173) 2019-07-11 17:39:04 -07:00
Tim Bannister d550d112af Add scheduler concept guide (#14637)
* Add scheduler concept page

* Rename scheduling overview

* Fix non-ASCII colon symbols

* Reword scheduler concept page

* Move scheduler performance tuning into scheduling

* Signpost from overview to kube-scheduler, etc

* Add whatsnext section to scheduler concept

* Restructure scheduling concept

Now there's a concept page for scheduling, some of the details
in the performance tuning page can have a better home.

* Omit link to (unwritten) scheduling extensions page

* Drop deprecated / superseded filtering rules
2019-07-09 12:28:25 -07:00
shankarsundaram 4f841f0cab Update what-is-kubernetes.md (#15181)
container needs to start i cant be the same container . so renamed from restart to start
2019-07-06 20:52:33 -07:00
Himanshu Pandey 147687dddb Added the hyperlink for pod in the page (#15113)
* add the hyperlink for pod in the page

* Changed Pod href to tooltip
2019-07-03 06:56:35 -07:00
shub-asa1 1f4345b57b fix for issue #15214 (#15215)
fix for issue #15214  added --all-namespaces in a command as the result of command will always be "no resources"
2019-07-01 03:13:18 -07:00
Jesse Glick a23fcb5727 kubectl config set-context --current (#15039) 2019-06-25 08:44:37 -07:00
Justin Walz b2965e704e Update common-labels.md (#15058)
Small change, but consistent ordering reads nicer to those looking for the difference between each block.
2019-06-23 23:55:56 -07:00
Rajesh Deshpande 2fb8128b30 Correcting details about current request namespace (#15061)
Removed ambiguous word 'temporarily', as namespace set using that method, is not temporary. It is permanent for a current resource and there is no concept of a temporary namespace in K8s. 
Also, for consisteny '--namespace' flag added after the actual command.
2019-06-23 23:33:55 -07:00
Rajesh Deshpande aba753c189 Adding what's next section to namespace concepts (#15017)
* Adding what's new section to namespace concepts

To learn more about namespaces and give better navigation this section is added.

* Update namespaces.md
2019-06-20 10:04:48 -07:00
Ryan Stephen 20189c2000 Update what-is-kubernetes.md - Grammar Syntax Edit (#15019)
Removed capitalization for lines succeeding a colon ":". Edits from line 40-49.
2019-06-20 05:24:49 -07:00
Rajesh Deshpande 5a4b7a38bc Adding pod configuration file with names (#14971)
Adding pod configuration file with pod and container name. This explains the usage of names and how it looks like in actual YAML.
2019-06-19 12:10:33 -07:00
Weston Carlson cef94610c8 Improve mysql instance label value. (#14827) 2019-06-18 14:01:49 -07:00
shavidissa 1e8b524f26 Updates the What is Kubernetes page (#14657)
* Updates the What is Kubernetes page

* Adds content to the what is kubernetes used for section.

* Updates the ordered list.

* Formats the content.

* Update the content as per the comments

* Fix a broken link
2019-06-18 12:51:49 -07:00