* 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.
* Fix incorrect advice about creating a secret
The existing command does not use code style as required by the style
guide and it is incorrect as rendered. Also, there's an easier way to do
this.
* Add reviewer suggested improvement for secret escaping
Adding sftim's suggestion phrasing explanation of escaping shell special characters.
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Make secret escaping instructions consistent
* Update DaemonSet deletion documentation
The "Updating a DaemonSet" section referred to pre-1.6 behavior, where
rolling updates of DaemonSets were not supported and thus orphaned pods
from deleted DaemonSets would not be replaced by a new DaemonSet.
Describe the new behavior, where orphaned pods can be adopted by a new
DaemonSet and may be replaced depending on the update strategy in use.
* Tweak language around Pod replacement after DaemonSet deletion
* Update note about DaemonSet rolling updates
No need to call out the version in which rolling updates for DaemonSets
were introduced given how long they've been supported.
* initial commit for IPv4/IPv6 dual stack docs
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Apply suggestions from code review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Remove warning, Add What's next section
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Add Service section
Add Provising a dual stack Kubernetes cluster section
Add Ecosystem tooling section
Update prerequisites
Update flags
Update supported features
Move validation to task
Add Service validation
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Apply suggestions from code review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Remove ecosystem tooling
Remove provisioning tools
Add backtics to ipFamily values
Update loadbalancer section
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Fix feature gate link typo
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Update to dual-stack
Add default use-case to Service validation
Add note to default Service behaviour
Add default Service example
Update egress routing description
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Update api-server to the API server
Fix small typo based on feedback
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Add for_k8s_version feature state
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Update service IP address verbiage to be more concise
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Move to tasks/network
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Move dual-stack under services-networking
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Remove dual-stack from glossary
Add codenew blocks
Split command from output
Renamed pod name
Created subheading to validate node and pod addressing
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Apply suggestions from code review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Verbiage update based on review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Signed-off-by: Lachlan Evenson <lachlan.evenson@microsoft.com>
* Apply suggestions from code review
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* 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
It switched from a naming scheme of service1/service2 to s1/s2. That can be confusing for new people, and I propose we stick to only one naming scheme.
* 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
* Document the enableServiceLinks flag
There are many cases of service discovery environment variables clashing with env vars expected by programs, causing hard to debug problems. The enableServiceLinks flag added in 1.13 should be mentioned here and not only on the API reference.
* Update connect-applications-service.md
* Update content/en/docs/concepts/services-networking/connect-applications-service.md
Co-Authored-By: Qiming <tengqim@cn.ibm.com>
* rephrased the action to use active voice style
* Update volumes examples that are no longer in staging
Update volumes examples that are no longer in staging
per
c16a976d98
a lot of links are now broken in the docs
* Remove /staging from ceph examples
Remove /staging from ceph examples
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.
* Switch to "failure zone" term
Previous wording, "availability zone", is specific to certain cloud
service providers (eg AWS).
* Refer to glossary terms where appropriate
* Reword signposting to examples
* Assign stable name to anchor
* Link to standard node labels
* Fix incorrect feature state claims
* NodeRestriction admission plugin needs Kubernetes v1.11
(or later)
* Move further reading to whatsnext section
* Fix link to cluster setup
* Drop advice about older kubectl
Kubernetes v1.14+ definitely does offer a compatible kubectl
* Drop outdated comment about downloading examples
* Call an availability zone an availability zone
* Improve init containers page
- Overall rewording
- Link to “Debug init containers” in whatsnext
- Explain terms / use glossary references
- Use glossary shortcodes where appropriate
- Expand terms like QoS and cgroup that aren't in the glossary
- Only document & recommend stable syntax
- Tweak initContainer examples to use project style
- Drop vestigialreference to StatefulSet
Also: write “container” in lower case
Most of the places where this page talks about containers, it's as a
concept rather than an object in the Kubernetes API. Adjust case
accordingly.
* Reword what's next section
* 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
* Update and organize the content on Deployments
fix formatting issues
Format a note
Formats the content
Format content
Fix formatting issues
Format content
Format content
Update and organize the content on Deployments
* Update the content as per the comments
* Update as per the comments
* Update as per the comments
Init Containers were specified using custom annotations in k8s 1.5. In
k8s 1.6, these annotations were replaced with the
`Pod.Spec.initContainers` collection and the old annotations were
deprecated in 1.6 and no longer supported in 1.8. There's no reason to
clutter the docs with the old annotation syntax.
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.
* Updates HAProxy Ingress Controller information to point to new controller supported by haproxytech
* Update content/en/docs/concepts/services-networking/ingress-controllers.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Added listing for AWS VPC CNI
Added listing for AWS VPC CNI under "How to implement the Kubernetes networking model".
* Added AWS VPC CNI
* Added AWS VPC CNI to Installing a pod network add-on
* Updated tabs to alphabetical order
* Adding what's new section to namespace concepts
To learn more about namespaces and give better navigation this section is added.
* Update namespaces.md
* 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
* Highlight feature state for Ingress concept
* Fix command output marked as shell script
* Write "load balancer" as two words
* Clarify prerequisites for Ingress
* Tidy & reword
* Add link to Ingress Controllers topic
(further reading)
* Use a glossary tooltip for Secret
(readers may not have encountered that concept yet)
* Update term definitions in Ingress concept
- Adopt wording from glossary
(NB: glossary_definition shortcode didn't seem suitable)
- Replace terms with glossary_tooltip where appropriate
* feat: add job application has some error and restartPolicy is not Nerver pod will be delete note
* feat: optimize delete pods related suggestion
* Update jobs-run-to-completion.md
* clarify Conditions section in arch/nodes.md
The field name is `conditions` (plural), so have the section name match
the field name. In addition, updates the JSON output of an individual
Condition to match all the fields returned in k8s 1.14+.
* add information about Allocatable to nodes.md
Since k8s 1.6, a Node object returns information about both the node's
capacity as well as the allocatable resources on the node. The latter is
a representation of the resources that are available for normal pods to
consume.
This patch adds information about capacity vs. allocatable to the
documentation about nodes and provides a link to where the reader can
find more information about reserving compute resources.
* Correction: sysctl entries aren't annotations
First, thank you for your work on this documentation. It means so much to so many users. I found that the sysctl documentation linked here explains that sysctl pod security policy entries are in the spec field, not done via annotation. This corrects it, using as much of the original language as possible from the linked sysctl documentation.
* Update pod-security-policy.md
* Adding example to show labels in POD yaml
This page talk about labels and its usage. Also it talk about syntax for specifying labels. But it does not show how we can have labels in resource manifest. So with this PR i am adding example which shows that how we can have labels in pod manifest.
* Changes to resolve review comments
Changes to resolve review comments
* Adding annotation example
Adding example to show how annotation looks like in manifest. This will help users to understand where exactly we can use the annotations whose details are already given on this page. Annotation `imageregistry: https://hub.docker.com/` used intentionally to make it more relevant as earlier section talk about registry address annotation.
* Resolving review comments
Resolving review comments
This patch promotes re-use of the existing kube-proxy glossary
definition by referencing it from overview/components.md. Similarly, we
move the definition of Container Runtime into a new glossary definition
so that other pages may refer to it.
* Update images.md
* Update content/en/docs/concepts/containers/images.md
That works fine and thank you.
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
* Reword glossary entry for Service
New wording should be more suitable for inclusion via a
glossary_definition shortcode.
* Improve What's Next section for Service concept
* Rename Services concept to singular
This matches other concept documentation, eg Deployment.
* Use documentation IP address range
1.2.3.4 is outside the blocks reserved for documentation.
* Reword Service concept description
Services direct traffic to Pods, not containers
* Write IPVS in uppercase
* Use glossary references where appropriate
* Link from Pod overview to detailed Pod concept
* Assume that privileged containers are stable
* Improve wording
* Write Pod in upper case
As Pod is an API object, write it in upper case.
This patch swaps all uses with extensions/v1beta1 with the new
networking.k8s.io/v1beta1 apiVersion for the Ingress resource.
Signed-off-by: Christopher M. Luciano <cmluciano@us.ibm.com>
The orders of kind and metadata were inconsistent, and that made the
doc unreadable.
This fixes the orders in consistent way under pods/init-containers.md.
by kubectl apply.
The docs imply that lists whose elements are all primitives
are replaced by the applied config instead of being updated.
This PR states that explicitly for clarity.
* fix an offense against the style guide.
> Refer to API objects without saying “object,” unless omitting “object” leads to an awkward construction.
* fix another one.
removed hyperlink from "An example" in the statement An example of this approach is a small container running logrotate periodically. However, it's recommended to use stdout and stderr directly and leave rotation and retention policies to the kubelet.
This fix is for issue #13656
I've attempted to have it make more sense by removing the word 'is'. Optionally, depending on the intended meaning, the sentence could read differently by leaving the word 'is' alone and changing the word 'through' to 'though'.
k8s does not support nested namespaces but this is not specified anywhere in the document. I find this is the right place to document it as we introduce namespace concept here. Also these details are important to mention specifically for users who are coming from Docker UCP background.
* Remove enable resource quota note
As of now, `ResourceQuotaScopeSelectors` is enabled by default, since it's in beta. So, let's remove it.
* Update resource-quotas.md
Yuk, Yongsu
Tanveer Alam
vishakha
Roy Hvaara
Tim Bannister
Yushiro FURUKAWA
Mike Danese
Jimmy Jones
Melony QIN
Xin Jin
Jorge I. Gasca
houjun
Yukun Sun
Bob Furu
Abhik Chakraborty
PingWang
Dimitri Mitropoulos
Andrew Sy Kim
Nate Taber
Trey Tacon
bells17
Benjamin Fuller
mohamed chiheb ben jemaa
Lee Verberne
Saed Alavinia
Raghuram Devarakonda
Michal Srb
widearea101
Eric Briand
John Howard
M00nF1sh
simplytunde
David Eads
Josh Gavant
Adam Wolfe Gordon
Praveen Sastry
Kubernetes Prow Robot
Rob Scott
Lachlan Evenson
Patrick Ohly
Louise Daly
Jeff Wenzbauer
Lee Verberne
Eric Ernst
Wei Huang
sudeshsh
John Griffith
Matthias Bertschy
Dr. Stefan Schimanski
Hemant Kumar
Tim Allclair (St. Clair)
John Reese
Jay Pipes
Ismail Alidzhikov
Draven
Xing Yang
savitharaghunathan
Carlos Sanchez
Stephan
Angel
boxboatjeremy
Kane York
Arnaud M
Vincent Gramer
ponypaver
Bill Mulligan
Iva Koevska
Xiang Dai
Wojciech Tyczynski
Jordan Liggitt
Andreas Lindhé
Manish Bansal
Eduardo Roldan
Naoki Oketani
Kobayashi Daisuke
Alex Punnen
Conlan Cesar
Kenneth Massada
elmbrain
Sandor Szücs
yokoyama tatsuo
Robert Kielty
Neha Gupta
Weidong Cai
Nikita Potapenko
Damon Wang
Brandon Marick
Jiacheng Xu
Eric Hu
Saish Dharvotkar
Scot Marvin
Donghui Wang
Justin Biggs
David Ricordel
shankarsundaram
Brian Grant
David Dieulivol
Samuel Walker
Wayne Khan
Himanshu Pandey
William Zhang
Rong Gao
Dan Mueller
shavidissa
youmoo
Metri Dmitriev
shub-asa1
Anthony Watherston
Jesse Glick
Oilbeater
Tammer Saleh
Vladimir Vivien
Justin Walz
Rajesh Deshpande
NickMRamirez
Kohei Toyoda
Ryan Stephen
Hypo
Barnabas Makonda
Joseph Irving
Fabian Deutsch
Supriya Sirbi
MAKOSCAFEE
Richard Marcum
Serdar Osman Onur
Josiah Bjorgaard
Weston Carlson
Haoran Wang
Pingan
Rajakavitha1
Jingfang Liu
Babak "Bobby" Salamat
zhangqx2010
fudali
Jakob Jarosch
Nicolas Rouquette
Vallery Lancey
Chaminda Divitotawela
Weidong Cai
Kevin Taylor
Rostislav M. Georgiev
Jay Beale
Seth
David Ashpole
Vageesha17
Deep Debroy
Carlone
rishgh
Austin
Josef Brandl
Robert Krawitz
Zach Arnold
Tom Janson
Martin Vladev
adisky
Craig Peters
Julien Brochet
Santhosh Kumar Tekuri
Steven Sherry
Adebayo Adesanya
Sahin Vardar
Abubakar Siddiq Ango
Ashish Thakur
Karen Bradshaw
Aaron Sun
krmayankk
Renan Gonçalves
/v\atthew L Daniel
Suhwan Cha
Brian Xu
Jean-Rémy Bancel
dnoland1
cmluciano
Elvadas NONO
Kenichi Omichi
Karthik Ravikanti
zdeisidr
noctarius aka Christoph Engelbert
Xin He
千夜
clicklog
David Xia
Hunter Loftis
Prankul
王(Wang)
Vladimir Masarik
silenceshell
Guy Templeton
giri
Christoph Stäbler
yanghaichao12
codyc
Danny Berger
Zihong Zheng
Srinivas R Kulkarni
Paul Roth
Jan Dolecek
Andrew Sy Kim
Rajesh Deshpande
RaviSantosh Gudimetla
Shashank Patel
AJ Moore