Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise page about multiple zones #23498

Merged

Conversation

sftim
Copy link
Contributor

@sftim sftim commented Aug 27, 2020

Revise https://kubernetes.io/docs/setup/best-practices/multiple-zones/ [preview]:

  • Drop provider-specific details, in line with current content guide. We're a long way past Kubernetes 1.2 as well, this page was rather stale.
  • General rewording.

Fixes #14964
Fixes #23982

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 27, 2020
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Aug 27, 2020
@netlify
Copy link

netlify bot commented Aug 27, 2020

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 7196db6

https://deploy-preview-23498--kubernetes-io-master-staging.netlify.app

@sftim
Copy link
Contributor Author

sftim commented Aug 28, 2020

If this merges before PR #23466 then that other PR should ideally be revised before merging.

@sftim sftim force-pushed the 20200827_revise_multiple_zones_setup branch from 465a245 to 4c2ebdc Compare September 6, 2020 15:39
@kbhawkey
Copy link
Contributor

@justinsb Would you have time to review?
@tengqm , Since you recently updated this page (zh) would you have time to review?
In general, things look good. Thanks!

Copy link
Contributor Author

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add suggestions based on feedback

content/en/docs/setup/best-practices/multiple-zones.md Outdated Show resolved Hide resolved
content/en/docs/setup/best-practices/multiple-zones.md Outdated Show resolved Hide resolved
content/en/docs/setup/best-practices/multiple-zones.md Outdated Show resolved Hide resolved
content/en/docs/setup/best-practices/multiple-zones.md Outdated Show resolved Hide resolved
@sftim
Copy link
Contributor Author

sftim commented Sep 22, 2020

/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Sep 22, 2020
@sftim sftim force-pushed the 20200827_revise_multiple_zones_setup branch from 7736683 to 0db4e5a Compare September 22, 2020 11:40
@sftim
Copy link
Contributor Author

sftim commented Sep 22, 2020

/remove-label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot removed the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Sep 22, 2020
When you set up your cluster, you might also need to consider whether and how
your setup can restore service if all of the failure zones in a region go
off-line at the same time. For example, do you rely on there being at least
Make sure that any cluster-critical repair work does not rely
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sftim. I read through the page again. There are a few places to edit.
Have a look at:
For example, do you rely on there being at least Make sure that any cluster-critical repair work does not rely

When persistent volumes are created, the `PersistentVolumeLabel`
[admission controller](/docs/reference/access-authn-authz/admission-controllers/)
automatically adds zone labels to any PersistentVolumes that are linked to a specific
zone. The {< glossary_tooltip text="scheduler" term_id="kube-scheduler" >}} then ensures,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

☝️ This tooltip is not rendering

## Networking

Kubernetes itself does not provide zone-aware networking. You can use a
[network plugin](docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Kubernetes does not provide ...

The pods should be spread across all 3 zones:
When nodes start up, the kubelet on each node automatically adds
{{< glossary_tooltip text="labels" term_id="label" >}} to the the Node object
that represents that specific kubelet in the Kubernetes API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cleanup: the the
possible cleanup: s/Node object/Node/

are only placed into the same zone as that volume.

You can specify a {{< glossary_tooltip text="StorageClass" term_id="storage-class" >}}
for PersistentVolumeClaims that specifies the failure domains (zones) that the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit wording/break up sentence. Would this work?

To learn about configuring a StorageClass with failure domains or zones, see Allowed topologies.

find kubernetes/examples/guestbook-go/ -name '*.json' | xargs -I {} kubectl apply -f {}
```
Kubernetes automatically spreads the Pods for a
workload resources (such as {{< glossary_tooltip text="Deployment" term_id="deployment" >}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cleanup: remove a in for a workload resources

EOF
```
When you deploy a cluster control plane you can place a replica of each
component in each failure zone that you have used. For example, if you
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: simplify:
When you deploy a cluster control plane, place a replica of each
control plane component in each failure zone.

in conjunction with
[Pod topology spread constraints](/docs/concepts/workloads/pods/pod-topology-spread-constraints/)
to control how Pods are spread across your cluster among fault domains.
such as regions, zones, and even specific nodes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check the sentences (rebase mixup).
how Pods are spread across your cluster among fault domains. such as regions, zones, and even specific nodes.

{{< glossary_tooltip text="labels" term_id="label" >}} to the the Node object
that represents that specific kubelet in the Kubernetes API.
These labels can include
[zone information](/docs/reference/kubernetes-api/labels-annotations-taints/#topologykubernetesiozone)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Add period at end of sentence

Drop provider-specific details, in line with current content guide.
Plus general rewording.
@sftim sftim force-pushed the 20200827_revise_multiple_zones_setup branch from 0db4e5a to 7196db6 Compare October 7, 2020 11:19
@kbhawkey
Copy link
Contributor

kbhawkey commented Oct 7, 2020

The docs cleanup looks good.
/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 7, 2020
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 8296e8400701a26d1f5e873ef39c4e8769f26f55

@irvifa
Copy link
Member

irvifa commented Oct 8, 2020

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: irvifa

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 8, 2020
@k8s-ci-robot k8s-ci-robot merged commit 56b0a2f into kubernetes:master Oct 8, 2020
@sftim sftim deleted the 20200827_revise_multiple_zones_setup branch September 12, 2021 10:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Running in multiple zones Bring https://kubernetes.io/docs/setup/best-practices/multiple-zones/ up to date
5 participants