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

kubeadm: add task page for cluster reconf #32764

Merged
merged 1 commit into from
Apr 8, 2022

Conversation

neolit123
Copy link
Member

@neolit123 neolit123 commented Apr 5, 2022

Add new task page outlines steps for reconfiguring
a kubeadm cluster and persisting reconfiguration.

Link the new page from the existing "customizing components"
guide and the "create cluster" guide.

The idea of the new page is to document what users have to do today to reconf a kubeadm cluster.
We have no automation today, but some kubeadm / kubectl commands can help.

xref kubernetes/kubeadm#970
xref kubernetes/kubeadm#2317
xref kubernetes/kubeadm#2318

preview
https://deploy-preview-32764--kubernetes-io-main-staging.netlify.app/docs/tasks/administer-cluster/kubeadm/kubeadm-reconf/

@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 Apr 5, 2022
@k8s-ci-robot k8s-ci-robot requested review from onlydole and sftim April 5, 2022 16:37
@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 Apr 5, 2022
@neolit123
Copy link
Member Author

neolit123 commented Apr 5, 2022

/kind feature
/priority backlog
/sig cluster-lifecycle

/cc @pacoxu @SataQiu @RA489
PTAL if you get a chance

@k8s-ci-robot k8s-ci-robot requested review from pacoxu and SataQiu April 5, 2022 16:38
@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. labels Apr 5, 2022
@neolit123 neolit123 force-pushed the 1.24-add-steps-for-reconf branch 2 times, most recently from 9157020 to f25dec4 Compare April 5, 2022 16:46
@netlify
Copy link

netlify bot commented Apr 5, 2022

Deploy Preview for kubernetes-io-main-staging ready!

Name Link
🔨 Latest commit 9157020
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/624c717715db590008e8e598
😎 Deploy Preview https://deploy-preview-32764--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@netlify
Copy link

netlify bot commented Apr 5, 2022

Deploy Preview for kubernetes-io-main-staging ready!

Name Link
🔨 Latest commit 931581e
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/624f6c73cfc71a00081910f3
😎 Deploy Preview https://deploy-preview-32764--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Contributor

@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.

Thanks so much!

This is a partial review.

nit: I'd name the file kubeadm-reconfigure.md not kubeadm-reconf.md

Are there any “what's next” pages you'd also like to link to.

@neolit123
Copy link
Member Author

neolit123 commented Apr 7, 2022

thanks for the reviews! will rebase the PR later after i commit a couple of more changes.

@neolit123
Copy link
Member Author

@sftim

nit: I'd name the file kubeadm-reconfigure.md not kubeadm-reconf.md

yeah, that seems better.

Are there any “what's next” pages you'd also like to link to.

i can link to the these i guess:
https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/control-plane-flags/
https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-certs/

@neolit123 neolit123 force-pushed the 1.24-add-steps-for-reconf branch from c38e52c to 3c8d0ea Compare April 7, 2022 18:12
@neolit123
Copy link
Member Author

neolit123 commented Apr 7, 2022

updated.

EDIT: updated again to include link from the "kubeadm upgrade" page and add "what's next" links.

The new task page outlines steps for reconfiguring
a kubeadm cluster and persisting reconfiguration.

Link the new page from the existing guides for
"customizing components", "creating a cluster",
and "kubeadm upgrade".

Co-authored-by: Paco Xu <paco.xu@daocloud.io>
Co-authored-by: Qiming Teng <tengqm@outlook.com>
@neolit123 neolit123 force-pushed the 1.24-add-steps-for-reconf branch from 3c8d0ea to 931581e Compare April 7, 2022 22:57
@tengqm
Copy link
Contributor

tengqm commented Apr 8, 2022

/lgtm

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

LGTM label has been added.

Git tree hash: 8af8d387383de16dec71752b1dfd7734975d3d69

Copy link
Contributor

@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.

Thanks

/approve

---
reviewers:
- sig-cluster-lifecycle
title: Reconfiguring a kubeadm cluster
Copy link
Contributor

@sftim sftim Apr 8, 2022

Choose a reason for hiding this comment

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

capitalization nit:

Suggested change
title: Reconfiguring a kubeadm cluster
title: Reconfiguring A kubeadm Cluster

or

Suggested change
title: Reconfiguring a kubeadm cluster
title: Reconfiguring A Cluster That Was Deployed Using kubeadm

Obtain the Pod names:

```shell
kubectl get po -n kube-system | grep coredns
Copy link
Contributor

Choose a reason for hiding this comment

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

In docs, I recommend writing kinds out longhand.

 kubectl get pod -n kube-system | grep coredns

The exception is the cheat sheet, where we give folks hint about shortcuts.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: pacoxu, sftim

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 Apr 8, 2022
@k8s-ci-robot k8s-ci-robot merged commit 3b19dbf into kubernetes:main Apr 8, 2022
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. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. 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.

5 participants