kubeadm: add task pages for adding Linux and Windows worker nodes #47888

neolit123 · 2024-09-11T13:21:57Z

Description

Adjust the "create a kubeadm cluster" page to link to two separate task pages for adding Linux / Windows worker nodes.

Base the Windows page on the existing document:
https://github.com/kubernetes-sigs/sig-windows-tools/blob/master/guides/guide-for-adding-windows-node.md

note: this is a PR for the main branch (not dev-1.32)

Issue

Closes #44248
xref

neolit123 · 2024-09-11T13:23:46Z

/assign @sftim @divya-mohan0209
/cc @pacoxu
for kubeadm
/cc @marosset @jsturtevant @knabben
for windows

/sig cluster-lifecycle windows docs

NOTE: i won't be able to work on this next week, but any feedback will be adjusted after that in case the PR doesn't merge this week...

neolit123 · 2024-09-11T13:26:36Z

/hold

netlify · 2024-09-11T13:31:28Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`65107c7`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/66e28a692c09f20008e12b0e
😎 Deploy Preview	https://deploy-preview-47888--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

sftim

Here's a partial review. I don't have a Windows licence to check out the Windows part.

content/en/docs/tasks/administer-cluster/kubeadm/adding-linux-nodes.md

sftim · 2024-09-11T14:31:09Z

content/en/docs/tasks/administer-cluster/kubeadm/adding-linux-nodes.md

+following commands on the control plane node:
+
+```bash
+openssl x509 -pubkey -in /etc/kubernetes/pki/ca.crt | openssl rsa -pubin -outform der 2>/dev/null | \


Suggested change

openssl x509 -pubkey -in /etc/kubernetes/pki/ca.crt | openssl rsa -pubin -outform der 2>/dev/null | \

# Run this on a control plane node

sudo cat /etc/kubernetes/pki/ca.crt | openssl x509 -pubkey | openssl rsa -pubin -outform der 2>/dev/null | \

(least privilege)

updated, minus the # Run this on a control plane node part. that is already in the prev sentence.

It doesn't block a merge, but experience confidently shows us that people don't read documentation and many people paste the commands in without reading the text in between.

well, it will fail on a joining worker since the ca.crt doens't exist yet.
so then they will go back and read the prev sentence.

content/en/docs/tasks/administer-cluster/kubeadm/adding-linux-nodes.md

sftim · 2024-09-11T14:32:28Z

content/en/docs/tasks/administer-cluster/kubeadm/adding-linux-nodes.md

+By default, tokens expire after 24 hours. If you are joining a node to the cluster after the current token has expired. You can create a new token by running the following command on the control plane node:
+
+```bash
+kubeadm token create


Suggested change

kubeadm token create

# Run this on a control plane node

sudo kubeadm token create

updated, minus # Run this on a control plane node. the prev sentence already mentions ...running the following command on the control plane node

content/en/docs/tasks/administer-cluster/kubeadm/adding-linux-nodes.md

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md

sftim

Some thoughts on the Windows part

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md

sftim · 2024-09-11T14:41:35Z

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md

+when run on the control plane node.
+
+Install kubectl for windows (optional)
+For more information about it : https://kubernetes.io/docs/tasks/tools/install-kubectl-windows/


(at some point) make this a hyperlink.

deleted this as it was a duplicate.
already present in a new ### Install kubectl for Windows (optional) near the bottom.

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md

sftim · 2024-09-11T14:42:22Z

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md

+By default, tokens expire after 24 hours. If you are joining a node to the cluster after the current token has expired. You can create a new token by running the following command on the control plane node:
+
+```bash
+kubeadm token create


Suggested change

kubeadm token create

# Run this on a control plane node

sudo kubeadm token create

updated, minus # Run this on a control plane node. the prev sentence already mentions it.

Should we move the steps about creating kubeadm join tokens to install-kubeadm.md and reference that from both the windows and linux docs?
It looks like some of the docs are duplicated here

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md

sftim · 2024-09-11T14:44:27Z

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md

+* `curl.exe` is installed and present in the `PATH` environment variable.
+* A running kubeadm cluster created by `kubeadm init` and following the steps
+in the document [Creating a cluster with kubeadm](/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/).
+


You'll also need a server running Windows, and administrative access to the server (just having the license is not enough to proceed).

attempted to reword the steps.

sftim · 2024-09-11T14:45:25Z

@neolit123 once you've got the feedback you'd like, you might want to mark this as draft to indicate that you think it needs more work before it can merge.

sftim · 2024-09-11T15:37:01Z

If you're an approver for English and you LGTM this and you need a second person to approve because this is a change to the live site: you can treat this message as grounds to approve it. The change as described above is well worth making.

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md

jsturtevant · 2024-09-11T17:35:00Z

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md

+
+  ```PowerShell
+  curl.exe -LO https://raw.githubusercontent.com/kubernetes-sigs/sig-windows-tools/master/hostprocess/Install-Containerd.ps1
+  .\Install-Containerd.ps1 -ContainerDVersion 1.7.1


Suggested change

.\Install-Containerd.ps1 -ContainerDVersion 1.7.1

.\Install-Containerd.ps1 -ContainerDVersion 1.7.22

should we point to the containerd runtime docs here instead? https://kubernetes.io/docs/setup/production-environment/container-runtimes/#containerd

i did not notice that there are windows install steps in https://kubernetes.io/docs/setup/production-environment/container-runtimes/#containerd (inside the getting started link) that's great because we can just add a prereq for a container runtime and remove this step from here.

ideally we should break the follwing into linux/windows eventually too:
https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#installing-kubeadm-kubelet-and-kubectl

and maybe have PrepareNode.ps be the install step for windows in that guide.

the biggest differences between those docs and what we have are

Checking and enabling the Hyper-V feature - which I don't think we care about for the purposes of this document

Setting the CNI bin and CNI config dir's in the containerd config - I think we do want this

I think if we can get the containerd docs updated to create and set the cni bin/config dirs in the containerd setup script we can move away from the containerd setup doc in sig-windows-tools.
@jsturtevant - WDYT?

agree, That info should live in the containerd install doc

i though about unrolling the install-containerd script but think i'm going to leave this task to SIG Windows. my main problem here is that i have no way to test the containerd install and CNI setup, ATM.

also, it seems out of scope of the PR.

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md

sftim · 2024-09-11T20:46:39Z

I get the sense that this is ready for a pair (Linux, Windows) of tech LGTMs.

pacoxu · 2024-09-12T05:58:35Z

I get the sense that this is ready for a pair (Linux, Windows) of tech LGTMs.

Most of the Linux part is the same as before. Only some structure changes for Linux.

Overall LGTM, but I don't have enough testing or knowledge about windows node. So leave to SIG-Windows to give the LGTM.

Adjust the "create a kubeadm cluster" page to link to two separate task pages for adding Linux / Windows worker nodes. Base the Windows page on the existing document: https://github.com/kubernetes-sigs/sig-windows-tools/blob/master/guides/guide-for-adding-windows-node.md

sftim · 2024-09-12T11:03:28Z

@neolit123 you held this PR. When [ie, what conditions must be met] is it OK to unhold?

neolit123 · 2024-09-12T12:37:29Z

@neolit123 you held this PR. When [ie, what conditions must be met] is it OK to unhold?

just a precaution.
/hold cancel

neolit123 · 2024-09-12T13:07:30Z

@marosset @jsturtevant please review again. looking for LGTM on the Windows side.
i think this is still an open topic but best to send it in a follow up, IMO:
#47888 (comment)

marosset · 2024-09-12T22:31:12Z

LGTM for Windows steps

thanks @neolit123!

tengqm · 2024-09-12T22:58:37Z

/approve

k8s-ci-robot · 2024-09-12T22:58:50Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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:

~~content/en/docs/OWNERS~~ [tengqm]

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

sftim · 2024-09-13T12:35:01Z

/lgtm
for docs

Tech reviews look done

k8s-ci-robot · 2024-09-13T12:35:08Z

LGTM label has been added.

Git tree hash: c79b9486f57d0b75e48d2161f5b033f0ab09754e

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 11, 2024

k8s-ci-robot requested review from natalisucks and salaxander September 11, 2024 13:22

k8s-ci-robot added language/en Issues or PRs related to English language size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 11, 2024

k8s-ci-robot assigned divya-mohan0209 and sftim Sep 11, 2024

k8s-ci-robot added the sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. label Sep 11, 2024

k8s-ci-robot requested a review from jsturtevant September 11, 2024 13:23

k8s-ci-robot added the sig/windows Categorizes an issue or PR as relevant to SIG Windows. label Sep 11, 2024

k8s-ci-robot requested review from knabben, marosset and pacoxu September 11, 2024 13:23

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Sep 11, 2024

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 11, 2024

neolit123 mentioned this pull request Sep 11, 2024

Overhaul Windows documentation #31428

Open

31 tasks

sftim reviewed Sep 11, 2024

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md Show resolved Hide resolved

sftim reviewed Sep 11, 2024

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md Show resolved Hide resolved

neolit123 force-pushed the 1.32-add-linux-windows-task-pages branch 2 times, most recently from cd2cdbf to 5eddc43 Compare September 11, 2024 16:15

neolit123 mentioned this pull request Sep 11, 2024

tracking issue for Windows support kubernetes/kubeadm#1393

Open

17 tasks

marosset reviewed Sep 11, 2024

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md Outdated Show resolved Hide resolved

marosset reviewed Sep 11, 2024

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md Outdated Show resolved Hide resolved

marosset reviewed Sep 11, 2024

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md Outdated Show resolved Hide resolved

jsturtevant reviewed Sep 11, 2024

View reviewed changes

marosset reviewed Sep 11, 2024

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md Outdated Show resolved Hide resolved

neolit123 force-pushed the 1.32-add-linux-windows-task-pages branch from 5eddc43 to 04a73fc Compare September 11, 2024 18:33

sftim reviewed Sep 11, 2024

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md Show resolved Hide resolved

sftim reviewed Sep 11, 2024

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md Outdated Show resolved Hide resolved

sftim reviewed Sep 11, 2024

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md Outdated Show resolved Hide resolved

sftim reviewed Sep 11, 2024

View reviewed changes

content/en/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes.md Outdated Show resolved Hide resolved

neolit123 force-pushed the 1.32-add-linux-windows-task-pages branch from 04a73fc to 65107c7 Compare September 12, 2024 06:29

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 12, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 12, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 13, 2024

sftim mentioned this pull request Sep 13, 2024

Write new task pages about creating Kubernetes nodes #44248

Closed

k8s-ci-robot merged commit 4fc01b4 into kubernetes:main Sep 13, 2024
6 checks passed

This was referenced Sep 13, 2024

Emphasize that some kubeadm node setup commands run on control plane #47911

Merged

Redirect legacy Windows node setup URLs to new page #47912

Merged

	openssl x509 -pubkey -in /etc/kubernetes/pki/ca.crt \| openssl rsa -pubin -outform der 2>/dev/null \| \
	# Run this on a control plane node
	sudo cat /etc/kubernetes/pki/ca.crt \| openssl x509 -pubkey \| openssl rsa -pubin -outform der 2>/dev/null \| \

	kubeadm token create
	# Run this on a control plane node
	sudo kubeadm token create

	.\Install-Containerd.ps1 -ContainerDVersion 1.7.1
	.\Install-Containerd.ps1 -ContainerDVersion 1.7.22

kubeadm: add task pages for adding Linux and Windows worker nodes #47888

kubeadm: add task pages for adding Linux and Windows worker nodes #47888

Conversation

neolit123 commented Sep 11, 2024 • edited Loading

Description

Issue

neolit123 commented Sep 11, 2024

neolit123 commented Sep 11, 2024

netlify bot commented Sep 11, 2024 • edited Loading

✅ Pull request preview available for checking

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neolit123 Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim commented Sep 11, 2024

sftim commented Sep 11, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neolit123 Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

marosset Sep 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim commented Sep 11, 2024

pacoxu commented Sep 12, 2024

sftim commented Sep 12, 2024

neolit123 commented Sep 12, 2024

neolit123 commented Sep 12, 2024

marosset commented Sep 12, 2024

tengqm commented Sep 12, 2024

k8s-ci-robot commented Sep 12, 2024

sftim commented Sep 13, 2024

k8s-ci-robot commented Sep 13, 2024

neolit123 commented Sep 11, 2024 •

edited

Loading

netlify bot commented Sep 11, 2024 •

edited

Loading

neolit123 Sep 11, 2024 •

edited

Loading

neolit123 Sep 11, 2024 •

edited

Loading

marosset Sep 11, 2024 •

edited

Loading