Refresh kubeadm docs for Windows #33324

jsturtevant · 2022-04-29T18:00:42Z

Updates Windows kubeadm documentation:

aligns with the documentation policy as specified in https://kubernetes.io/blog/2020/05/third-party-dual-sourced-content/ removing flannel specific details.
Make note for users in the standard join documentation. Running kubeadm join from windows doesn't require additional work beyond specifying the correct cri-socket parameter.
updates the upgrade documentation

This is a follow up from the feedback recieved in #32862 (comment)

jsturtevant · 2022-04-29T18:00:55Z

/sig windows
/cc @marosset

marosset · 2022-04-29T18:23:34Z

content/en/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md

@@ -333,6 +333,10 @@ The nodes are where your workloads (containers and Pods, etc) run. To add new no
  kubeadm join --token <token> <control-plane-host>:<control-plane-port> --discovery-token-ca-cert-hash sha256:<hash>
  ```

+{{< note >}}
+On Windows you may need to specify the `cri-socket` parameter.  For example, with Containerd as the runtime add `--cri-socket "npipe:////./pipe/containerd-containerd"` to the `kubeadm join` command


When do users not need to specify the cri-socket parameter for Windows?
If we say may need to I think we should give guidance on when they would or wouldn't need to specify the extra arg.

Makes sense. I believe it is required for any remote runtimes. If using docker shim then it is not required. Since these docs are for 1.24+ should I be more direct and be more direct that it is requird something like:

Suggested change

On Windows you may need to specify the `cri-socket` parameter. For example, with Containerd as the runtime add `--cri-socket "npipe:////./pipe/containerd-containerd"` to the `kubeadm join` command

On Windows when using a remote runtime the `cri-socket` parameter is required. For example when using Containerd as the runtime add `--cri-socket "npipe:////./pipe/containerd-containerd"` to the `kubeadm join` command

I think from Tuesday (the expected v1.24 release date), setting a CRI socket path becomes mandatory.

Is this required then?

Maybe we should say:

On Windows you should specify the cri-socket parameter in the kubeadm join command. The default path is "npipe:////./pipe/containerd-containerd" for containerd.

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

netlify · 2022-04-29T18:26:01Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`3693d1c`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/62a760cc8cbbb90009e7a610
😎 Deploy Preview	https://deploy-preview-33324--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 settings.

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

sftim

/hold

Until v1.24 is released, I'd like to avoid provoking merge conflicts for the v1.24 docs branch. This PR touches a doc that was updated in light of the dockershim removal.

OK to unhold after that release.

sftim · 2022-04-29T19:06:21Z

content/en/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md

@@ -333,6 +333,10 @@ The nodes are where your workloads (containers and Pods, etc) run. To add new no
  kubeadm join --token <token> <control-plane-host>:<control-plane-port> --discovery-token-ca-cert-hash sha256:<hash>
  ```

+{{< note >}}
+On Windows you may need to specify the `cri-socket` parameter.  For example, with Containerd as the runtime add `--cri-socket "npipe:////./pipe/containerd-containerd"` to the `kubeadm join` command


I think from Tuesday (the expected v1.24 release date), setting a CRI socket path becomes mandatory.

marosset · 2022-05-26T16:56:09Z

/lgtm

marosset · 2022-05-26T16:58:10Z

/assign @onlydole
/hold cancel

jsturtevant · 2022-06-03T18:53:12Z

/assign @sftim

sftim

If someone visits https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes/ then this PR will serve them a 404 response.

Can we redirect them to a different page?

Also, some specific (inline) feedback.

content/en/docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm.md

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

jsturtevant · 2022-06-08T17:41:59Z

I've updated the docs based on the feedback. Thanks!

marosset · 2022-06-08T20:30:26Z

/lgtm

sftim · 2022-06-12T17:34:51Z

@jsturtevant could you add the redirect that I mentioned in #33324 (review) ?

The file to change is static/_redirects.

/lgtm cancel
(until that redirect is in place)

jsturtevant · 2022-06-13T17:49:27Z

@sftim sorry about missing that, updated. There were a few other redirects on that file, I left them in place but let me know if they should be consolidated in someway.

sftim

Thanks

/approve

k8s-ci-robot · 2022-06-20T11:04:07Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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:

~~OWNERS~~ [sftim]

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

tengqm · 2022-06-20T12:58:56Z

/lgtm

k8s-ci-robot · 2022-06-20T12:59:15Z

LGTM label has been added.

Git tree hash: 5a4e6acdf3111856706ac92d9527060d7e5e1394

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 29, 2022

k8s-ci-robot requested a review from marosset April 29, 2022 18:00

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. sig/windows Categorizes an issue or PR as relevant to SIG Windows. labels Apr 29, 2022

k8s-ci-robot requested a review from natalisucks April 29, 2022 18:01

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 29, 2022

marosset reviewed Apr 29, 2022

View reviewed changes

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

marosset reviewed Apr 29, 2022

View reviewed changes

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

sftim reviewed Apr 29, 2022

View reviewed changes

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

jsturtevant force-pushed the windows-kubeadm branch 2 times, most recently from 289e095 to 1e032ac Compare May 2, 2022 16:25

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 4, 2022

Refresh kubeadm docs for Windows

f875adc

jsturtevant force-pushed the windows-kubeadm branch from 1e032ac to f875adc Compare May 10, 2022 20:28

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 10, 2022

marosset added this to Docs updates (#31428) in SIG-Windows May 20, 2022

k8s-ci-robot assigned marosset May 26, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 26, 2022

k8s-ci-robot assigned onlydole May 26, 2022

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

k8s-ci-robot assigned sftim Jun 3, 2022

sftim requested changes Jun 6, 2022

View reviewed changes

k8s-ci-robot requested a review from sftim June 6, 2022 12:40

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

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 12, 2022

updates from feedback

3693d1c

jsturtevant force-pushed the windows-kubeadm branch from 5be91b0 to 3693d1c Compare June 13, 2022 16:07

sftim reviewed Jun 20, 2022

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 20, 2022

k8s-ci-robot assigned tengqm Jun 20, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 20, 2022

k8s-ci-robot merged commit 117fa22 into kubernetes:main Jun 20, 2022

SIG-Windows automation moved this from Docs updates (#31428) to Done (v1.25) Jun 20, 2022

This was referenced Jun 22, 2022

Cannot find page about adding Windows nodes #34476

Open

Production environment page retains link to adding Windows nodes #34566

Closed

fenggw-fnst mentioned this pull request Jun 28, 2022

[zh-cn] Refresh kubeadm docs for Windows #34661

Merged

marosset deleted the windows-kubeadm branch July 5, 2022 18:45

marosset restored the windows-kubeadm branch July 5, 2022 18:45

marosset deleted the windows-kubeadm branch July 5, 2022 18:45

marosset restored the windows-kubeadm branch July 5, 2022 18:45

marosset deleted the windows-kubeadm branch July 5, 2022 18:45

jihoon-seo mentioned this pull request Jul 11, 2022

Outdated Korean contents in the dev-1.24-ko.2 #34903

Closed

jihoon-seo mentioned this pull request Jul 29, 2022

[ko] Remove files deleted from upstream #35525

Merged

sftim mentioned this pull request Oct 11, 2022

Creating a cluster with kubeadm - missing information "Adding Windows Nodes" #37266

Closed

divya-mohan0209 mentioned this pull request Dec 7, 2023

Write a new task page about creating Kubernetes nodes #44248

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refresh kubeadm docs for Windows #33324

Refresh kubeadm docs for Windows #33324

jsturtevant commented Apr 29, 2022 •

edited

Loading

jsturtevant commented Apr 29, 2022

marosset Apr 29, 2022

jsturtevant Apr 29, 2022

sftim Apr 29, 2022

jsturtevant Apr 29, 2022

marosset Apr 29, 2022

jsturtevant May 2, 2022

netlify bot commented Apr 29, 2022 •

edited

Loading

sftim left a comment

sftim Apr 29, 2022

marosset commented May 26, 2022

marosset commented May 26, 2022

jsturtevant commented Jun 3, 2022

sftim left a comment

jsturtevant commented Jun 8, 2022

marosset commented Jun 8, 2022

sftim commented Jun 12, 2022

jsturtevant commented Jun 13, 2022

sftim left a comment

k8s-ci-robot commented Jun 20, 2022

tengqm commented Jun 20, 2022

k8s-ci-robot commented Jun 20, 2022

	On Windows you may need to specify the `cri-socket` parameter. For example, with Containerd as the runtime add `--cri-socket "npipe:////./pipe/containerd-containerd"` to the `kubeadm join` command
	On Windows when using a remote runtime the `cri-socket` parameter is required. For example when using Containerd as the runtime add `--cri-socket "npipe:////./pipe/containerd-containerd"` to the `kubeadm join` command

Refresh kubeadm docs for Windows #33324

Refresh kubeadm docs for Windows #33324

Conversation

jsturtevant commented Apr 29, 2022 • edited Loading

jsturtevant commented Apr 29, 2022

marosset Apr 29, 2022

Choose a reason for hiding this comment

jsturtevant Apr 29, 2022

Choose a reason for hiding this comment

sftim Apr 29, 2022

Choose a reason for hiding this comment

jsturtevant Apr 29, 2022

Choose a reason for hiding this comment

marosset Apr 29, 2022

Choose a reason for hiding this comment

jsturtevant May 2, 2022

Choose a reason for hiding this comment

netlify bot commented Apr 29, 2022 • edited Loading

✅ Pull request preview available for checking

sftim left a comment

Choose a reason for hiding this comment

sftim Apr 29, 2022

Choose a reason for hiding this comment

marosset commented May 26, 2022

marosset commented May 26, 2022

jsturtevant commented Jun 3, 2022

sftim left a comment

Choose a reason for hiding this comment

jsturtevant commented Jun 8, 2022

marosset commented Jun 8, 2022

sftim commented Jun 12, 2022

jsturtevant commented Jun 13, 2022

sftim left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jun 20, 2022

tengqm commented Jun 20, 2022

k8s-ci-robot commented Jun 20, 2022

jsturtevant commented Apr 29, 2022 •

edited

Loading

netlify bot commented Apr 29, 2022 •

edited

Loading