Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Windows documentation updates for 1.14 #12929

Merged
merged 33 commits into from
Mar 19, 2019
Merged
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
264f4ed
Updated the note to indicate doc work for 1.14
craiglpeters Mar 1, 2019
aef823f
first attempt at md export from gdoc
craiglpeters Mar 12, 2019
0e14aa5
simplifyig
craiglpeters Mar 12, 2019
425a934
big attempt
craiglpeters Mar 12, 2019
23508d5
moving DRAFT windows content to PR for review
craiglpeters Mar 13, 2019
5ebda61
moving content to PR in markdown for review
craiglpeters Mar 13, 2019
a449d5e
updated note tags
craiglpeters Mar 13, 2019
06c7578
Delete windows-contributing.md
michmike Mar 13, 2019
7ad4efc
fixed formatting in intro and cluster setup guide
craiglpeters Mar 13, 2019
5292447
updating formatting for running containers guide
craiglpeters Mar 13, 2019
07352c0
rejiggered end of troubleshooting
craiglpeters Mar 13, 2019
e220d25
fixed minor typos
craiglpeters Mar 13, 2019
67d065b
Clarified the windows binary download step
craiglpeters Mar 13, 2019
2889599
Update _index.md
michmike Mar 16, 2019
3dd18c3
Update _index.md
michmike Mar 16, 2019
f146655
Update _index.md
michmike Mar 17, 2019
9b1b1b3
Update _index.md
michmike Mar 18, 2019
185124a
updating relative docs links
michmike Mar 18, 2019
394937e
Update _index.md
michmike Mar 18, 2019
a13278b
Update _index.md
michmike Mar 18, 2019
945e282
formatted for correct step numbering
craiglpeters Mar 18, 2019
914af4f
fix typos
craiglpeters Mar 18, 2019
530f56d
Update _index.md
michmike Mar 18, 2019
e495861
Update _index.md
michmike Mar 18, 2019
f4210e6
Update _index.md
michmike Mar 18, 2019
cd82c1f
Update _index.md
michmike Mar 18, 2019
81d5ac7
Update _index.md
michmike Mar 18, 2019
f18f1a8
Update _index.md
michmike Mar 19, 2019
b24c692
Fixed a few whitespace issues
craiglpeters Mar 19, 2019
418fd43
Update _index.md
michmike Mar 19, 2019
814f384
Update _index.md
michmike Mar 19, 2019
8376485
Update _index.md
michmike Mar 19, 2019
1591c84
Merge branch 'dev-1.14' into dev-1.14
michmike Mar 19, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 19 additions & 17 deletions content/en/docs/getting-started-guides/windows/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -534,10 +534,12 @@ Once you have a Linux-based Kubernetes master node you are ready to choose a net
1. The cluster subnet (e.g. "10.244.0.0/16") is set as per your IP plan.
* VNI 4096 is set in the backend
* Port 4789 is set in the backend
2. In the `cni-conf.json` section of your `kube-flannel.yml`, change the network name to "`vxlan0"`.
{{< note >}}
The VNI must be set to 4096 and port 4789 for Flannel on Linux to interoperate with Flannel on Windows. Support for other VNIs is coming soon. See [VXLAN](https://github.com/coreos/flannel/blob/master/Documentation/backends.md#vxlan) for an explanation of these fields.
{{< /note >}}
2. In the `cni-conf.json` section of your `kube-flannel.yml`, change the network name to `vxlan0`.

{{< note >}}
The VNI must be set to 4096 and port 4789 for Flannel on Linux to interoperate with Flannel on Windows. Support for other VNIs is coming soon. See [VXLAN](https://github.com/coreos/flannel/blob/master/Documentation/backends.md#vxlan) for an explanation of these fields.
{{< /note >}}

Your `cni-conf.json` should look as follows:

```json
Expand Down Expand Up @@ -619,18 +621,17 @@ All code snippets in Windows sections are to be run in a PowerShell environment
[Environment]::SetEnvironmentVariable("HTTPS_PROXY", "http://proxy.example.com:443/", [EnvironmentVariableTarget]::Machine)
```

If after reboot you may see the following error:
If after reboot you see the following error, you need to restart the docker service manually

![alt_text](windows-docker-error.png "windows docker error screen capture")
If so then you need to restart the docker service manually:
![alt_text](windows-docker-error.png "windows docker error screen capture")

```PowerShell
Start-Service docker
```

{{< note >}}
The "pause" (infrastructure) image is on Microsoft Container Registry (MCR) and the DOCKERFILE is available at [https://github.com/Microsoft/SDN/blob/master/Kubernetes/windows/Dockerfile](https://github.com/Microsoft/SDN/blob/master/Kubernetes/windows/Dockerfile)
{{< /note >}}
{{< note >}}
The "pause" (infrastructure) image is hosted on Microsoft Container Registry (MCR) and the DOCKERFILE is available at [https://github.com/Microsoft/SDN/blob/master/Kubernetes/windows/Dockerfile](https://github.com/Microsoft/SDN/blob/master/Kubernetes/windows/Dockerfile)
{{< /note >}}

```PowerShell
docker pull mcr.microsoft.com/k8s/core/pause:1.0.0
Expand All @@ -646,7 +647,7 @@ All code snippets in Windows sections are to be run in a PowerShell environment

1. Copy Kubernetes certificate

Copy the Kubernetes certificate file (`$HOME/.kube/config`) [from Linux controller](https://docs.microsoft.com/en-us/virtualization/windowscontainers/kubernetes/creating-a-linux-master#collect-cluster-information) to this new `C:\k` directory on your Windows node.
Copy the Kubernetes certificate file `$HOME/.kube/config` [from the Linux controller](https://docs.microsoft.com/en-us/virtualization/windowscontainers/kubernetes/creating-a-linux-master#collect-cluster-information) to this new `C:\k` directory on your Windows node.

Tip: You can use tools such as [xcopy](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/xcopy), [WinSCP](https://winscp.net/eng/download.php), or this [PowerShell wrapper for WinSCP](https://www.powershellgallery.com/packages/WinSCP/5.13.2.0) to transfer the config file between nodes.

Expand Down Expand Up @@ -838,9 +839,9 @@ To deploy a Windows container on Kubernetes, you must first create an example ap
beta.kubernetes.io/os: windows
```

{{< note >}}
Note: Port mapping is also supported, but for simplicity in this example the container port 80 is exposed directly to the service.
{{< /note >}}
{{< note >}}
Port mapping is also supported, but for simplicity in this example the container port 80 is exposed directly to the service.
{{< /note >}}

1. Check that all nodes are healthy:

Expand All @@ -867,9 +868,10 @@ To deploy a Windows container on Kubernetes, you must first create an example ap
* Service discovery, `curl` the service name with the Kubernetes [default DNS suffix](/docs/concepts/services-networking/dns-pod-service/#services)
* Inbound connectivity, `curl` the NodePort from the Linux master or machines outside of the cluster
* Outbound connectivity, `curl` external IPs from inside the pod using kubectl exec
{{< note >}}
**Windows _container hosts_ are not able to access the IP of services scheduled on them due to current platform limitations of the Windows networking stack. Only Windows _pods_ are able to access service IPs.
{{< /note >}}

{{< note >}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • If you want the page to look like the other content pages, you can add a template type attribute in the front matter:
    content_template: templates/concept. With this template, you are required to include an overview and then a body. See another page under concepts for an example. This template will provide an internal toc at the top, based upon the main headers in the doc. May help navigation of the page.

  • Or, I see that other pages in setup do not set a template type and instead include the toc shortcode at the top,
    {{< toc >}}. See content/en/docs/setup/node-conformance.md as an example.

  • nit: the tables could be converted to Markdown

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let us merge this PR and i will create a new one to do these changes. very helpful hints @kbhawkey

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kbhawkey i fixed this in another PR and will ping you there :)

Windows container hosts are not able to access the IP of services scheduled on them due to current platform limitations of the Windows networking stack. Only Windows pods are able to access service IPs.
{{< /note >}}

## Managing Workload Identity with Group Managed Service Accounts

Expand Down