sig-windows contributing.md updates
Signed-off-by: Mark Rossetti <marosset@microsoft.com>
This commit is contained in:
Mark Rossetti
parent
fbc5ca53d6
commit
a09c374401
|
|
@ -2,23 +2,23 @@
|
|||
|
||||
Contains a list of common resources when contributing in the effort to support Windows Node and Windows Server containers in Kubernetes.
|
||||
|
||||
- [Joining the community of other contributors](#joining-the-community-of-other-contributors)
|
||||
- [Find work in progress](#find-work-in-progress)
|
||||
- [Building Kubernetes for Windows from Source](#building-kubernetes-for-windows-from-source)
|
||||
- [Build Prerequisites](#build-prerequisites)
|
||||
- [Building Kubernetes binaries for Windows](#building-kubernetes-binaries-for-windows)
|
||||
- [Updating the Node binaries](#updating-the-node-binaries)
|
||||
- [Joining the community of other contributors](#joining-the-community-of-other-contributors)
|
||||
- [Find work in progress](#find-work-in-progress)
|
||||
- [Building Kubernetes for Windows from Source](#building-kubernetes-for-windows-from-source)
|
||||
- [Build Prerequisites](#build-prerequisites)
|
||||
- [Building Kubernetes binaries for Windows](#building-kubernetes-binaries-for-windows)
|
||||
- [Updating the Node binaries](#updating-the-node-binaries)
|
||||
- [Creating a PR](#creating-a-pr)
|
||||
- [API Considerations](#api-considerations)
|
||||
- [Running Tests](#running-tests)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Reporting Issues and Feature Requests](#reporting-issues-and-feature-requests)
|
||||
- [Gathering Logs](#gathering-logs)
|
||||
- [Reporting Issues and Feature Requests](#reporting-issues-and-feature-requests)
|
||||
- [Gathering Logs](#gathering-logs)
|
||||
- [Collecting Networking Logs](#collecting-networking-logs)
|
||||
|
||||
## Joining the community of other contributors
|
||||
|
||||
The best way to get in contact with the contributors working on Windows support is through the Kubernetes Slack. To get a Slack invite, visit [http://slack.k8s.io/](http://slack.k8s.io/) . Once you're logged in, join us in the [#SIG-Windows](https://kubernetes.slack.com/messages/sig-windows) channel. You can also use the [Kubernetes Community Forums](https://discuss.kubernetes.io/c/general-discussions/windows) to chat about Windows containers on Kubernetes.
|
||||
The best way to get in contact with the contributors working on Windows support is through the Kubernetes Slack. To get a Slack invite, visit [http://slack.k8s.io/](http://slack.k8s.io/) . Once you're logged in, join us in the [#SIG-Windows](https://kubernetes.slack.com/messages/sig-windows) channel.
|
||||
|
||||
To get access to shared documents, meeting calendar, and additional discussions, be sure to also join the [SIG-Windows Google Group](https://groups.google.com/forum/#!forum/kubernetes-sig-windows).
|
||||
|
||||
|
|
@ -26,21 +26,22 @@ View the leadership team in SIG-Windows and other subprojects in the [getting st
|
|||
|
||||
## Find work in progress
|
||||
|
||||
To get a handle on current work, you can view [outstanding PRs](https://github.com/kubernetes/kubernetes/pulls?q=is%3Apr+is%3Aopen+label%3Asig%2Fwindows+is%3Apr).
|
||||
View the SIG-Windows [project board](https://github.com/orgs/kubernetes/projects/8).
|
||||
This project board is updated during our [bi-weekly backlog refinement meeting](https://github.com/kubernetes/community/tree/master/sig-windows#meetings).
|
||||
|
||||
View the SIG-Windows project board, tracking detailed [issues across Kubernetes releases](https://github.com/orgs/kubernetes/projects/8).
|
||||
View current [outstanding PRs](https://github.com/kubernetes/kubernetes/pulls?q=is%3Apr+is%3Aopen+label%3Asig%2Fwindows) and [open issues](https://github.com/kubernetes/kubernetes/issues?q=is%3Aissue+is%3Aopen+label%3Asig%2Fwindows).
|
||||
|
||||
## Building Kubernetes for Windows from Source
|
||||
|
||||
The Kubernetes build scripts have not been ported to Windows, so it's best to run in a Linux VM where you can run the same Docker container used in the official Kubernetes builds. This simplifies the steps, but means that you cannot build under Windows Subsystem for Linux (WSL).
|
||||
The Kubernetes build scripts have not been ported to Windows, so it's best to develop in a Linux VM or [WSL2](https://docs.microsoft.com/windows/wsl/) environment where you can run the same Docker container used in the official Kubernetes builds.
|
||||
|
||||
It's best to skim over the [Building Kubernetes](https://github.com/kubernetes/kubernetes/blob/master/build/README.md) guide if you have never built Kubernetes before to get the latest info. These steps are a summary focused on cross-building the Windows node binaries (kubelet & kube-proxy).
|
||||
It's best to read through the [Building Kubernetes](https://github.com/kubernetes/kubernetes/blob/master/build/README.md) guide if you have never built Kubernetes before to get the latest info. These steps are a summary focused on cross-building the Windows node binaries (kubectl, kubelet, and kube-proxy).
|
||||
|
||||
### Build Prerequisites
|
||||
|
||||
At least 60GB of disk space is required, and 16GB of memory (or memory + swap).
|
||||
|
||||
Once you have a VM, install Git, [Docker-CE](https://docs.docker.com/install/), and make. The build scripts will pull a Docker container with the required version of golang and other needed tools preinstalled.
|
||||
In your developer environment, install Git, [Docker-CE](https://docs.docker.com/install/), and make. The build scripts will pull a Docker container with the required version of golang and other needed tools preinstalled.
|
||||
|
||||
If you're using Ubuntu, then install the following packages: git, build-essential, [Docker-CE](https://docs.docker.com/install/linux/docker-ce/ubuntu/).
|
||||
|
||||
|
|
@ -52,30 +53,36 @@ If you would like to build all binaries at once, then run `./build/run.sh make c
|
|||
|
||||
Once the build completes, the files will be in `_output/dockerized/bin`.
|
||||
|
||||
### Updating the Node binaries
|
||||
### Testing your changes
|
||||
|
||||
Once you have binaries built, the easiest way to test them is to replace them on an existing cluster. This section assumes you already have a cluster in the cloud of your choice. To update the binaries on an existing node, follow these steps:
|
||||
#### Build a local cluster
|
||||
|
||||
1. Drain & cordon a node with `kubectl drain <nodename>`
|
||||
The easist way to test changes is to use the community maintained [SIG Windows developer environment](https://github.com/kubernetes-sigs/sig-windows-dev-tools#welcome-to-the-sig-windows-development-environment) project.
|
||||
You can use this to build a fully functional cluster locally with binaries built from source.
|
||||
|
||||
#### Updating the Node binaries
|
||||
|
||||
If you already have an existing cluster you also test your changes by swapping the binaries on a node.
|
||||
To update the binaries on an existing node, follow these steps:
|
||||
|
||||
1. Drain & cordon a node with `kubectl drain <nodename>`.
|
||||
2. Connect to the node with SSH or Windows Remote Desktop, and start PowerShell
|
||||
3. On the node, run `Stop-Service kubelet -Force`
|
||||
4. Copy kubelet.exe and kube-proxy.exe to a cloud storage account, or use SSH to copy them directly to the node.
|
||||
3. On the node, run `Stop-Service kube-proxy -Force` followed by `Stop-Service kubelet -Force`.
|
||||
4. Copy kubelet.exe and kube-proxy.exe to the node.
|
||||
5. Overwrite the existing kubelet & kube-proxy binaries. If you don't know where they are, run `sc.exe qc kubelet` or `sc.exe qc kube-proxy` and look at the BINARY_PATH_NAME returned.
|
||||
6. Start the updated kubelet & kube-proxy with `Start-Service kubelet`
|
||||
6. Start the updated kubelet & kube-proxy with `Start-Service kubelet`.
|
||||
|
||||
## Creating a PR
|
||||
|
||||
Congratulations on contributing to the SIG-Windows ecosystem. If there is a PR you would like to build, it's easy. You can create a working branch, pull the changes from GitHub in a patch, apply, then build.
|
||||
Congratulations on contributing to the SIG-Windows ecosystem.
|
||||
If there is a PR you would like to build, it's easy. You can create a working branch, pull the changes from GitHub in a patch, apply, then build.
|
||||
|
||||
The detailed steps here are based off an example PR on GitHub: [https://github.com/kubernetes/kubernetes/pull/74788](https://github.com/kubernetes/kubernetes/pull/74788). Be sure to replace the URL and steps with the PR you want to test.
|
||||
Please follow the Kubernetes contribute guide for [pull-requests](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md) when submitting your changes.
|
||||
|
||||
1. Make sure your local clone is up-to-date with master: `git checkout master ; git pull master`
|
||||
2. Create a branch in your repo: `git checkout -b pr74788`
|
||||
3. Get the patch for the PR you want. Append `.patch` to the URL, and download it with curl: `curl -L -o pr74788.patch https://github.com/kubernetes/kubernetes/pull/74788.patch`
|
||||
4. Merge it with `patch -p1 < pr74788.patch`
|
||||
5. If there are errors, fix them as needed. Once you're done, delete the `.patch` file and then `git commit` the rest to your local branch.
|
||||
6. Deploy your own cluster, including Windows Nodes
|
||||
7. Test Your Changes
|
||||
Additionally please perform the following:
|
||||
|
||||
1. Add the **sig/windows** label to your PR by adding `/sig windows` in the pull request description or a comment.
|
||||
1. Trigger windows specific e2e test by adding `/test pull-kubernetes-e2e-aks-engine-windows-containerd` in a comment.
|
||||
|
||||
## API Considerations
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue