Overhaul Windows documentation #31428

marosset · 2022-01-20T19:25:53Z

This issue will track a number of improvements SIG-Windows would like to make to the windows documentation.

Review / update the following pages windows specific pages
- https://kubernetes.io/docs/setup/production-environment/windows/intro-windows-in-kubernetes/
  - Specify minimum or recommended system requirements
  - Split up content into multiple pages
    - Move https://kubernetes.io/docs/setup/production-environment/windows/intro-windows-in-kubernetes/#resource-management to new page in /docs/concepts/configuration
      - Moving windows resource management to separate page #31850
      - Updating Windows intro and resource management pages #34083
    - Move https://kubernetes.io/docs/setup/production-environment/windows/intro-windows-in-kubernetes/#security to new page in /docs/concepts/security
      - Moving Windows security info to new page #31851
    - Move https://kubernetes.io/docs/setup/production-environment/windows/intro-windows-in-kubernetes/#compatibility-storage somewhere under /docs/concepts/storage (either new page or move content into existing pages)
      - Windows documentation overhaul #33582
      - Review docs/concepts/storage/windows-storage/ for accuracy
    - Move https://kubernetes.io/docs/setup/production-environment/windows/intro-windows-in-kubernetes/#compatibility-networking into new page in under /docs/concepts/services-networking/
      - Windows documentation overhaul #33582
      - Update documentation around win-overlay/win-bridge (used by dockershim) to sdn-overlay/sdn-bridge (used by containerd)
      - Review networking docs for accuracy
    - Move https://kubernetes.io/docs/setup/production-environment/windows/intro-windows-in-kubernetes/#troubleshooting to new page
      - Windows documentation overhaul #33582
    - Move remaining content out of /docs/setup/production-environment/
      - Windows documentation overhaul #33582
      - review https://kubernetes.io/docs/concepts/windows/intro/ for accuracy
    - move https://kubernetes.io/docs/setup/production-environment/windows/user-guide-windows-containers/
      - Windows documentation overhaul #33582
      - review https://kubernetes.io/docs/concepts/windows/user-guide/ for accuracy
- https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes/
  - @brasmith-ms / @jsturtevant
  - replace docker EE instructions with moby bits
  - check for updates
  - update containerd install / join steps
- https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/upgrading-windows-nodes/
  - @jsturtevant
  - check for updates
- https://kubernetes.io/docs/tasks/configure-pod-container/configure-gmsa/ @marosset
  - configure-gmsa.md updates #31412
- https://kubernetes.io/docs/tasks/configure-pod-container/configure-runasusername/ @aravindhp
- https://kubernetes.io/docs/tasks/configure-pod-container/create-hostprocess-pod/ @marosset / @brasmith-ms
- https://kubernetes.io/docs/tasks/tools/install-kubectl-windows/ @marosset
Add windows specific information to other tasks/concepts/etc pages as needed

(I'll continue to update this list over the next few days)

/milestone v1.24
/sig windows

k8s-ci-robot · 2022-01-20T19:25:54Z

marosset · 2022-01-20T19:26:28Z

/cc @brasmith-ms @jsturtevant @jayunit100 @claudiubelu @aravindhp

jihoon-seo · 2022-01-21T01:51:13Z

/triage accepted

tengqm · 2022-01-21T01:54:09Z

Thank you for filing an umbrella issue before working on it.

sftim · 2022-01-21T14:41:27Z

This looks like a partial duplicate of #29769

We should close one of these, I think.
/language en
/remove-kind feature

sftim · 2022-01-21T14:43:57Z

Much of https://kubernetes.io/docs/setup/production-environment/windows/intro-windows-in-kubernetes/ does not belong in the “production environment” section; it's not specific to deploying into production.
We should identify sections of that page to migrate elsewhere.

When moving existing content around, please add the “refactor” label to the PRs - or highlight to a reviewer that this label needs adding. That label helps localization teams spot when apparently-new content is actually being reused.

sftim · 2022-01-21T14:44:29Z

/priority important-longterm

sftim · 2022-05-25T14:37:46Z

Great to see progress here.

sftim · 2022-05-28T14:38:31Z

@marosset would you be willing to revisit the checkboxes in the issue description and confirm that these are up to date?

marosset · 2022-05-31T17:57:02Z

@marosset would you be willing to revisit the checkboxes in the issue description and confirm that these are up to date?

Done!

I'll start reviewing the moved content for accuracy now and will either open the PRs myself of find more appropriate PR authors.

k8s-triage-robot · 2022-09-05T16:47:32Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

aravindhp · 2022-09-06T15:17:13Z

/remove-lifecycle stale

aravindhp · 2022-09-14T21:29:46Z

@marosset I have reviewed configure-runasusername. I don't see anything missing. I don't see a reason to link to projected volumes and Windows RunAsUsername securitycontext-interactions. Folks who are using projected volumes would read that page and will become aware of the limitation.

k8s-triage-robot · 2022-12-13T21:42:16Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

sftim · 2022-12-14T00:10:47Z

@marosset, would you consider these docs overhauled?

k8s-triage-robot · 2023-01-13T00:42:36Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

sftim · 2023-01-13T09:59:43Z

/remove-lifecycle rotten

Query not yet answered. Anyone from SIG Windows is welcome to answer it.

sftim · 2023-05-02T10:52:56Z

How's this work going?

sftim · 2023-07-24T03:43:49Z

/lifecycle stale

aravindhp · 2023-07-25T17:01:04Z

@sftim sorry about the late response. I brought this up at today's sig-windows meeting. We decided to make this a rolling agenda item that will be discussed every week when we have a light agenda. Hopefully that will attract more contributors and we can move forward with improving the Windows docs.

aravindhp · 2023-08-01T16:57:02Z

To kick things off with https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes/ we are going to wait on #34476 (comment) that calls out that the Linux sections need to get filled in.

aravindhp · 2023-08-01T16:59:40Z

@tzifudzi will take up Specify minimum or recommended system requirements.

sftim · 2024-01-31T12:15:56Z

Also see #44964

marosset added the kind/feature Categorizes issue or PR as related to a new feature. label Jan 20, 2022

k8s-ci-robot added sig/windows Categorizes an issue or PR as relevant to SIG Windows. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jan 20, 2022

marosset added this to In Progress (v1.24) in SIG-Windows Jan 20, 2022

k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jan 21, 2022

k8s-ci-robot added language/en Issues or PRs related to English language and removed kind/feature Categorizes issue or PR as related to a new feature. labels Jan 21, 2022

sftim mentioned this issue Jan 21, 2022

Tidy Windows cluster setup pages #29894

Closed

k8s-ci-robot added the priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. label Jan 21, 2022

brasmith-ms mentioned this issue Jan 21, 2022

Adding in the basic restructuring of intro-to-windows-containers. #31457

Closed

jsturtevant mentioned this issue Jan 21, 2022

simplify sig-windows docs #29769

Closed

jihoon-seo mentioned this issue Jan 26, 2022

Outdated Korean windows/intro-windows-in-kubernetes.md #30364

Closed

This was referenced Feb 22, 2022

Moving windows resource management to separate page #31850

Merged

Moving Windows security info to new page #31851

Merged

Moving windows networking information to a new page #31852

Closed

Move windows troubleshooting 1.24 #31899

Closed

aravindhp mentioned this issue Feb 25, 2022

Move Windows storage concepts to a new page #31900

Closed

marosset moved this from In Progress (v1.24) to Docs updates (#31428) in SIG-Windows Mar 10, 2022

neolit123 mentioned this issue Mar 16, 2022

Issue with k8s.io/docs/tasks/administer-cluster/kubeadm/adding-windows-nodes/ #32299

Closed

This was referenced Mar 31, 2022

Moving windows containers user guide out of /setup/production-environment/ #32691

Closed

Move remaining intro windows content 1.24 #32767

Closed

moving intro-windows-in-kubernetes content out of /setup/production-environment/ #32768

Closed

jihoon-seo mentioned this issue May 17, 2022

Outdated Korean contents in the dev-1.24-ko.1 #33472

Closed

marosset mentioned this issue May 31, 2022

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

Merged

marosset mentioned this issue May 31, 2022

Updating Windows intro and resource management pages #34083

Merged

jihoon-seo mentioned this issue Jul 11, 2022

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

Closed

jihoon-seo mentioned this issue Jul 27, 2022

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

Merged

20 tasks

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 5, 2022

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 6, 2022

marosset removed this from Docs updates (#31428) in SIG-Windows Sep 21, 2022

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 13, 2022

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Jan 13, 2023

k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Jan 13, 2023

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 24, 2023

tzifudzi mentioned this issue Aug 12, 2023

Specify recommended Windows hardware requirements #42518

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Overhaul Windows documentation #31428

Overhaul Windows documentation #31428

marosset commented Jan 20, 2022 •

edited

Loading

k8s-ci-robot commented Jan 20, 2022

marosset commented Jan 20, 2022

jihoon-seo commented Jan 21, 2022

tengqm commented Jan 21, 2022

sftim commented Jan 21, 2022

sftim commented Jan 21, 2022

sftim commented Jan 21, 2022

sftim commented May 25, 2022

sftim commented May 28, 2022

marosset commented May 31, 2022

k8s-triage-robot commented Sep 5, 2022

aravindhp commented Sep 6, 2022

aravindhp commented Sep 14, 2022

k8s-triage-robot commented Dec 13, 2022

sftim commented Dec 14, 2022

k8s-triage-robot commented Jan 13, 2023

sftim commented Jan 13, 2023

sftim commented May 2, 2023

sftim commented Jul 24, 2023

aravindhp commented Jul 25, 2023

aravindhp commented Aug 1, 2023

aravindhp commented Aug 1, 2023

sftim commented Jan 31, 2024

Overhaul Windows documentation #31428

Overhaul Windows documentation #31428

Comments

marosset commented Jan 20, 2022 • edited Loading

k8s-ci-robot commented Jan 20, 2022

marosset commented Jan 20, 2022

jihoon-seo commented Jan 21, 2022

tengqm commented Jan 21, 2022

sftim commented Jan 21, 2022

sftim commented Jan 21, 2022

sftim commented Jan 21, 2022

sftim commented May 25, 2022

sftim commented May 28, 2022

marosset commented May 31, 2022

k8s-triage-robot commented Sep 5, 2022

aravindhp commented Sep 6, 2022

aravindhp commented Sep 14, 2022

k8s-triage-robot commented Dec 13, 2022

sftim commented Dec 14, 2022

k8s-triage-robot commented Jan 13, 2023

sftim commented Jan 13, 2023

sftim commented May 2, 2023

sftim commented Jul 24, 2023

aravindhp commented Jul 25, 2023

aravindhp commented Aug 1, 2023

aravindhp commented Aug 1, 2023

sftim commented Jan 31, 2024

marosset commented Jan 20, 2022 •

edited

Loading