Windows documentation overhaul #33582

marosset · 2022-05-09T23:00:52Z

This PR moves all content out of /docs/setup/production-environment/windows to new locations.
Where possible we merged Windows information into the existing docs.

This is a big PR but most of the contents have already been reviewed

Move Windows storage concepts to a new page #31900 for storage related docs
Moving windows networking information to a new page #31852 for networking related docs
Move windows troubleshooting 1.24 #31899 for troubleshooting section

I was initially hoping to get all of these changes in with the 1.24 release branch but in order to ease pressure on the release team we all decided to merge these changes after the 1.24 release.

Part of #31428

/label refactor
/sig windows
/assign @jsturtevant @sftim
/cc @tengqm @aravindhp @nate-double-u

marosset · 2022-05-09T23:01:24Z

/cc @brasmith-ms

k8s-ci-robot · 2022-05-09T23:01:25Z

@marosset: GitHub didn't allow me to request PR reviews from the following users: brasmith-ms.

Note that only kubernetes members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @brasmith-ms

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

netlify · 2022-05-09T23:14:27Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`70206d9`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/628fa56422749f0008335181
😎 Deploy Preview	https://deploy-preview-33582--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/concepts/services-networking/dns-pod-service.md

tengqm · 2022-05-13T01:45:38Z

content/en/docs/concepts/services-networking/dns-pod-service.md

+  qualified has failed
+  On Windows, you can only have 1 DNS suffix, which is the DNS suffix associated with that
+  pod's namespace (mydns.svc.cluster.local for example). Windows can resolve FQDNs
+  and services or names resolvable with just that suffix. For example, a pod spawned


"Windows can resolve FQDNs and services or names resolvable with just that suffix."

This sentence is difficult to parse.

I tried to make this less confusing. Let me know if it makes more sense.

content/en/docs/concepts/services-networking/dns-pod-service.md

content/en/docs/concepts/windows/intro.md

tengqm · 2022-05-15T00:15:37Z

content/en/docs/concepts/windows/intro.md

+* A kubelet running on a Windows node does not have memory
+  restrictions. `--kubelet-reserve` and `--system-reserve` do not set limits on
+  kubelet or processes running on the host. This means kubelet or a process on the host
+  could cause memory resource starvation outside the node-allocatable and scheduler.


“This means kubelet or a process on the host could cause memory resource starvation outside the node-allocatable and scheduler.”

This sentence is difficult to parse.

content/en/docs/concepts/windows/intro.md

jsturtevant

lgtm for sig-windows, The initial plan is move these files with minimal changes to the correct content locations to make edits to them easier and make the Windows Introduction page easier to manage and comprehend.

jsturtevant · 2022-05-16T16:13:09Z

content/en/docs/concepts/services-networking/dual-stack.md

+Kubernetes on Windows does not support single-stack "IPv6-only" networking. However,
+dual-stack IPv4/IPv6 networking for pods and nodes with single-family services
+is supported.


@daschott could you help parse the intent of the paragraph? This was a straight copy of https://kubernetes.io/docs/setup/production-environment/windows/intro-windows-in-kubernetes/#ipv6-networking.

I think the plan was to mostly move things as is in this first iteration but this one is pretty confusing. Another thing missing here is what version of Windows is required. WS2019 does not support dual-stack. It is available in 20H2 and WS2022.

content/en/docs/concepts/services-networking/windows-networking.md

marosset · 2022-05-17T20:50:52Z

@tengqm I have incorporated all of the suggested edits.
Since this PR is primarily moving pages around in an attempt to break up the giant intro-windows-in-kubernetes page (which is hard to edit and consume) would you be OK if the rest of the suggestions get addressed in a seperate PR?

- Move FlexVolume plugins section to docs/concepts/storage/volumes.md - Move CSI plugins section to en/docs/concepts/storage/volumes.md - Move in-tree plugins section to en/docs/concepts/storage/volumes.md

/docs/setup/production-environment/windows to various locations - Moving windows DNS limitations to/docs/concepts/services-networking/dns-pod-service.md - Moving windows session sticky time disclaimer to /docs/concepts/services-networking/service.md - Moving windows dual stack support info to /docs/concepts/services-networking/dual-stack.md - Moving generic Windows content to /docs/concepts/services-networking/windows-networking.md Signed-off-by: Mark Rossetti <marosset@microsoft.com>

…ster/ Signed-off-by: Mark Rossetti <marosset@microsoft.com>

…ment/ Signed-off-by: Mark Rossetti <marosset@microsoft.com>

tengqm · 2022-05-17T23:03:15Z

@tengqm I have incorporated all of the suggested edits. Since this PR is primarily moving pages around in an attempt to break up the giant intro-windows-in-kubernetes page (which is hard to edit and consume) would you be OK if the rest of the suggestions get addressed in a seperate PR?

Sure. I'm okay with whichever approach to improve these pages, provided that the ball is not dropped.

marosset · 2022-05-17T23:09:40Z

@tengqm I have incorporated all of the suggested edits. Since this PR is primarily moving pages around in an attempt to break up the giant intro-windows-in-kubernetes page (which is hard to edit and consume) would you be OK if the rest of the suggestions get addressed in a seperate PR?

Sure. I'm okay with whichever approach to improve these pages, provided that the ball is not dropped.

Understood.
I will follow up with a PR to update the intro-windows page.
I will try and find someone with more networking knowledge to update that page and if not I'll try to update that too.

marosset · 2022-05-25T19:46:31Z

@sftim @tengqm - do you see any issues with the structural changes in this PR?
I can open up new PRs for content changes after this merges.

tengqm · 2022-05-26T00:06:18Z

I'm okay to move this forward.
/approve
/label tide/merge-method-squash

k8s-ci-robot · 2022-05-26T00:06:38Z

[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:

~~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

/lgtm cancel

There's one place where this needs a fix.

sftim · 2022-05-26T12:10:23Z

content/en/docs/concepts/windows/user-guide.md

+=======
+The scheduler does not use the value of `.spec.os.name` when assigning Pods to nodes.
+You should use normal Kubernetes mechanisms for
+[assigning pods to nodes](/docs/concepts/scheduling-eviction/assign-pod-node/)
+to ensure that the control plane for your cluster places pods onto nodes that are running the
+appropriate operating system.
+{{< /note >}}
+>>>>>>> Moving windows containers user guide out of /setup/production-environment/:content/en/docs/concepts/windows/user-guide.md


This looks like a broken merge that needs tidying.

Fixed, I'll scan the rest of the PR again now too.

…environment/

…nvironment/ Signed-off-by: Mark Rossetti <marosset@microsoft.com>

jsturtevant · 2022-05-27T00:19:09Z

/lgtm

k8s-ci-robot · 2022-05-27T00:19:24Z

LGTM label has been added.

Git tree hash: 90cd4e8c0493f2ae84dd933577bd48df20f7ca75

k8s-ci-robot assigned jsturtevant and sftim May 9, 2022

k8s-ci-robot added sig/windows Categorizes an issue or PR as relevant to SIG Windows. refactor Indicates a PR with large refactoring changes e.g. removes files or moves content labels May 9, 2022

k8s-ci-robot requested review from aravindhp, nate-double-u and tengqm May 9, 2022 23:00

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels May 9, 2022

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

marosset force-pushed the windows-docs-merged-updates branch from ac81afe to babc202 Compare May 12, 2022 20:11

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

tengqm reviewed May 15, 2022

View reviewed changes

tengqm mentioned this pull request May 16, 2022

[zh][Umbrella] Setup docs to sync for 1.24 #33475

Closed

4 tasks

jsturtevant reviewed May 16, 2022

View reviewed changes

aravindhp and others added 4 commits May 17, 2022 13:54

Move Windows storage concepts to a new page

ddaa2a8

- Move FlexVolume plugins section to docs/concepts/storage/volumes.md - Move CSI plugins section to en/docs/concepts/storage/volumes.md - Move in-tree plugins section to en/docs/concepts/storage/volumes.md

Moving Windows troubleshooting topics to /tasks/debug-application-clu…

6906297

…ster/ Signed-off-by: Mark Rossetti <marosset@microsoft.com>

Moving windows containers user guide out of /setup/production-environ…

ef13388

…ment/ Signed-off-by: Mark Rossetti <marosset@microsoft.com>

marosset force-pushed the windows-docs-merged-updates branch from e711b4e to 2d955bb Compare May 17, 2022 20:54

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

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label May 26, 2022

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

sftim requested changes May 26, 2022

View reviewed changes

marosset added 2 commits May 26, 2022 09:05

fixup! Moving windows containers user guide out of /setup/production-…

541a0af

…environment/

moving intro-windows-in-kubernetes content out of /setup/production-e…

70206d9

…nvironment/ Signed-off-by: Mark Rossetti <marosset@microsoft.com>

marosset force-pushed the windows-docs-merged-updates branch from 2d955bb to 70206d9 Compare May 26, 2022 16:05

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

k8s-ci-robot merged commit 4d9e6d7 into kubernetes:main May 27, 2022

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

Sea-n mentioned this pull request May 28, 2022

Fix link for debug-cluster #34008

Merged

chrisnegus mentioned this pull request May 31, 2022

[Dockershim removal] Document the change for pod-infra-container-image #30842

Closed

This was referenced May 31, 2022

Overhaul Windows documentation #31428

Open

Removing /docs/setup/production-environment/windows/ #34078

Merged

Updating Windows intro and resource management pages #34083

Merged

Sea-n mentioned this pull request Jun 10, 2022

[zh] Drop windows pages that were moved #34201

Merged

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

[ko] Reorg 'Windows in K8s' docs #35423

Merged

20 tasks

t-inu mentioned this pull request Feb 20, 2023

[ja] Change paths of debug pages (case 3) #39528

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Windows documentation overhaul #33582

Windows documentation overhaul #33582

marosset commented May 9, 2022

marosset commented May 9, 2022

k8s-ci-robot commented May 9, 2022

netlify bot commented May 9, 2022 •

edited

Loading

tengqm May 13, 2022

marosset May 17, 2022

tengqm May 15, 2022

jsturtevant left a comment

jsturtevant May 16, 2022

marosset commented May 17, 2022

tengqm commented May 17, 2022

marosset commented May 17, 2022

marosset commented May 25, 2022

tengqm commented May 26, 2022

k8s-ci-robot commented May 26, 2022

sftim left a comment

sftim May 26, 2022

marosset May 26, 2022

jsturtevant commented May 27, 2022

k8s-ci-robot commented May 27, 2022

Windows documentation overhaul #33582

Windows documentation overhaul #33582

Conversation

marosset commented May 9, 2022

marosset commented May 9, 2022

k8s-ci-robot commented May 9, 2022

netlify bot commented May 9, 2022 • edited Loading

✅ Pull request preview available for checking

tengqm May 13, 2022

Choose a reason for hiding this comment

marosset May 17, 2022

Choose a reason for hiding this comment

tengqm May 15, 2022

Choose a reason for hiding this comment

jsturtevant left a comment

Choose a reason for hiding this comment

jsturtevant May 16, 2022

Choose a reason for hiding this comment

marosset commented May 17, 2022

tengqm commented May 17, 2022

marosset commented May 17, 2022

marosset commented May 25, 2022

tengqm commented May 26, 2022

k8s-ci-robot commented May 26, 2022

sftim left a comment

Choose a reason for hiding this comment

sftim May 26, 2022

Choose a reason for hiding this comment

marosset May 26, 2022

Choose a reason for hiding this comment

jsturtevant commented May 27, 2022

k8s-ci-robot commented May 27, 2022

netlify bot commented May 9, 2022 •

edited

Loading