sig-windows-tools icon indicating copy to clipboard operation
sig-windows-tools copied to clipboard

docs sharding for super easy to update windows Recipes

Open jayunit100 opened this issue 3 years ago • 6 comments
trafficstars

We need a more easy to use and easy to update, less beuracratic, windows-centric way to install and maintain windows nodes, w recipes for people to quickly borrow and use.

  • minimize the windows docs in kubernetes.io that arent foundational... i.e. things involving CNIs, external tools, PS1 scripts, and so on
  • Add a doc page for all the real world windows use cases
    • windows-image builder
    • Windows CSI drivers
    • Windows CSI-proxy intro and installation
    • NSSM, how to use and inspect it
    • Example of using containerd on windows kubelets
    • windows CNI
      • w antrea -> symlinked to dev tools
      • w calico -> symlinked to official calico docs or dev tools
    • Intro to windows w/ sig-win-dev-tools
    • Intro to windows clusters w/ CAPZ
    • Intro to windows using GKE
    • Intro to windows using EKS
    • Intro to windows using AKS
    • Intro to host-process recipes
      • sym link to calico docs
      • sym link to sig-win-dev-tools for antrea EXPERIMENTS/ doc (maybe zac or amim makes it)
    • GMSA walkthrough and introduction (xinqi ?)

As part of this lets add some recipes to sig-windows dev tools on

  • how calico woks and is installed
  • how antrea works and is installed

jayunit100 avatar May 03 '22 19:05 jayunit100

this needs an owner, sig win folks (me, mark, amim, claudio ) can pair with the owner on helping w technical content

jayunit100 avatar May 03 '22 19:05 jayunit100

As someone mentioned in the call - +1 for the idea of using the CAPI standard project for this: https://rust-lang.github.io/mdBook/

knabben avatar May 03 '22 19:05 knabben

www.kubernetes.io discourages providing documentation (including setup) for third party content. This means that setup instructions for various things like contianerd, individual CNIs, etc or any solutions that require other tools (like NSSM) are generally rejected. Unfortunately a lot of the Windows solutions require extra tools or advanced configuration.

In an ideal world each project would be updated to fully document how things work on Windows as well as they do for linux. While we work towards achieving that goal SIG-Windows leadership feels it is important to provide that documentation someplace for the benefit of users and the best location we came up with was this repository.

marosset avatar May 03 '22 19:05 marosset

There are several unofficial guides that could be used as reference:

https://github.com/kubernetes-sigs/sig-windows-tools/issues/128#issuecomment-1135605935 https://github.com/kubernetes-sigs/sig-windows-tools/issues/128#issuecomment-1068271427 https://github.com/kubernetes-sigs/sig-windows-tools/issues/128#issuecomment-1172470841 https://github.com/kubernetes-sigs/sig-windows-tools/issues/128#issuecomment-1172585274

jsturtevant avatar Jul 22 '22 17:07 jsturtevant

As we already have some content in https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/set-up-environment?tabs=containerd#windows-server-1 may this would be a suitable place?

lippertmarkus avatar Jul 23 '22 07:07 lippertmarkus

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

k8s-triage-robot avatar Oct 21 '22 08:10 k8s-triage-robot

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

k8s-triage-robot avatar Nov 20 '22 08:11 k8s-triage-robot

/remove-lifecycle rotten /remove-lifecycle stale

being worked on #239

jsturtevant avatar Nov 22 '22 18:11 jsturtevant

this needs an owner, sig win folks (me, mark, amim, claudio ) can pair with the owner on helping w technical content

I can take this up, but will need some guidance on the best approach; as per the discussion with James here #255

profnandaa avatar Dec 09 '22 06:12 profnandaa

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

This bot triages issues 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:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close not-planned

k8s-triage-robot avatar Jan 08 '23 06:01 k8s-triage-robot

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

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

This bot triages issues 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:

  • Reopen this issue with /reopen
  • Mark this issue as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close not-planned

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.

k8s-ci-robot avatar Jan 08 '23 06:01 k8s-ci-robot