Split guide to make easier to follow #272
Conversation
k8s-ci-robot
added
approved
|
/assign @fabi200123 |
|
@jsturtevant: GitHub didn't allow me to assign the following users: fabi200123. Note that only kubernetes-sigs members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. In response to this:
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. |
github-actions
bot
added
the
tide/merge-method-squash
k8s-ci-robot
added
the
size/L
There was a problem hiding this comment.
This is much easier to follow and I believe it is better to have calico and flannel in 2 different files. Also, shall we remove the refference that this is work in progress and the reference to #239?
Also, I believe the PR name should be "Split guide..." not "Split guild..."
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: fabi200123, jsturtevant 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:
Approvers can indicate their approval by writing |
jsturtevant
changed the title
done |
| ```bash | ||
| kubectl create -f https://raw.githubusercontent.com/projectcalico/calico/$CALICO_VERSION/manifests/tigera-operator.yaml | ||
| curl https://raw.githubusercontent.com/projectcalico/calico/$CALICO_VERSION/manifests/custom-resources.yaml -O | ||
| # If IP CIDR differs from 192.168.0.0/16, make sure to modify it in custom-resources.yaml. |
There was a problem hiding this comment.
This is the cluster CIDR right (not pod cidr)?
We should specify here.
There was a problem hiding this comment.
I think this is the pod CIDR. I didn't modify this aspect of the guide. @fabi200123 do you know off hand?
| Now you can add Windows-compatible versions of calico and kube-proxy. In order to ensure that you get a compatible version of kube-proxy, you'll need to substitute the tag of the image. The following example shows usage for Kubernetes v1.25.3, but you should adjust the version for your own deployment. | ||
|
|
||
| ```bash | ||
| curl -L https://raw.githubusercontent.com/kubernetes-sigs/sig-windows-tools/master/hostprocess/calico/kube-proxy/kube-proxy.yml | sed 's/KUBE_PROXY_VERSION/v1.25.3/g' | kubectl apply -f - |
There was a problem hiding this comment.
nit should we export KUBE_PROXY_VERSION and CALICO_VERSION env vars at the beginning so it is more obvious which values need to be set by the user?
There was a problem hiding this comment.
let's follow up with this, I this was a copy/paste of what is there currently to make it easier to follow/maintain
| Now you can add Windows-compatible versions of Flannel and kube-proxy. In order to ensure that you get a compatible version of kube-proxy, you'll need to substitute the tag of the image. The following example shows usage for Kubernetes v1.24.3, but you should adjust the version for your own deployment. | ||
|
|
||
| ```bash | ||
| curl -L https://raw.githubusercontent.com/kubernetes-sigs/sig-windows-tools/master/hostprocess/flannel/kube-proxy/kube-proxy.yml | sed 's/KUBE_PROXY_VERSION/v1.25.3/g' | kubectl apply -f - |
There was a problem hiding this comment.
| ## Before you begin | ||
|
|
||
| Your Kubernetes server must be at or later than version 1.22. To check the version, enter `kubectl version`. |
There was a problem hiding this comment.
Will be nice to add a link to setting up the Linux master node here too; perhaps to the official upstream docs? This way, this page can be a one-stop shop for fresh set up. I see that's already mentioned in bullet 2 below, perhaps that should be the first bullet?
There was a problem hiding this comment.
I just went through setting up the master node on a Hyper-V Ubuntu 22.04 VM and it was blood and tears; you don't want to go over it again -- but I want to challenge myself to do a quickstart guide that just highlights the pitfalls and common issues. Later, I would like to do an unattended shell script for setting up the master node (for dev purposes).
There was a problem hiding this comment.
I just went through setting up the master node on a Hyper-V Ubuntu 22.04 VM and it was blood and tears;
Yes setting up a cluster from scratch isn't a trivial game. There are tons of vendors and providers who attempt to solve this problem.
| ## Before you begin | ||
|
|
||
| Your Kubernetes server must be at or later than version 1.22. To check the version, enter `kubectl version`. | ||
| Your Kubernetes cluster must be at or later than version 1.23. To check the version, enter `kubectl version`. | ||
|
|
||
| - Obtain a [Windows Server 2019 license](https://www.microsoft.com/en-us/cloud-platform/windows-server-pricing) (or higher) in order to configure the Windows node that hosts Windows containers. If you are using VXLAN/Overlay networking you must have also have [KB4489899](https://support.microsoft.com/help/4489899) installed. |
There was a problem hiding this comment.
Is the license needed? I'm setting up mine a 2022 Evaluation Copy.
There was a problem hiding this comment.
you can use an evaluation copy for testing purposes
| ### Joining a Windows worker node | ||
|
|
||
| > **Note:** All code snippets in Windows sections are to be run in a PowerShell environment with elevated permissions (Administrator) on the Windows worker node. | ||
|
|
||
| 1. Install ContainerD, wins, kubelet, and kubeadm. | ||
| 1. Install ContainerD, kubelet, and kubeadm. | ||
|
|
||
| ```PowerShell | ||
| # Install ContainerD |
There was a problem hiding this comment.
nit: will be nice for Install -Containerd.ps1 to require the version other than having 6.1.8 as default as it's fast becoming outdated. We are now at 6.1.15. Perhaps to recommend that they have same version as they one they set up on the master node? And for dev purposes, latest is better.
There was a problem hiding this comment.
Note to self, I'll need to investigate this further: within the VM, curl.exe kept on failing consistently (just drops connection). I had to switch to Invoke-WebRequest -Uri $source -OutFile $destination which worked okay. I'll need to investigate a little more on what could have been happening.
| ### Joining a Windows worker node | ||
|
|
||
| > **Note:** All code snippets in Windows sections are to be run in a PowerShell environment with elevated permissions (Administrator) on the Windows worker node. | ||
|
|
||
| 1. Install ContainerD, wins, kubelet, and kubeadm. | ||
| 1. Install ContainerD, kubelet, and kubeadm. |
There was a problem hiding this comment.
nit: add Git installation step before .\PrepareNode.ps1 step since it's depended on it.
C:\Users\Administrator\k8s-setup\PrepareNode.ps1 : The term 'git' is not recognized as the name of a cmdlet, function,
script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is
correct and try again.
At line:1 char:1
+ .\PrepareNode.ps1 -KubernetesVersion v1.26.0
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There was a problem hiding this comment.
nit: make .\PrepareNode.ps1 script idempotent; fails after running the second time when an initially created file is re-created:
---- ------------- ------ ----
d----- 1/22/2023 10:28 PM pki
New-Item : NewItemIOError
At C:\Users\Administrator\k8s-setup\PrepareNode.ps1:61 char:1
+ New-Item -path C:\var\lib\kubelet\etc\kubernetes\pki -type SymbolicLi ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : ResourceExists: (C:\var\lib\kubelet\etc\kubernetes\pki:String) [New-Item], IOException
+ FullyQualifiedErrorId : NewItemIOError,Microsoft.PowerShell.Commands.NewItemCommand
Actually it's only these 2 other places:
Registering kubelet service
Error creating service!
CreateService(): The specified service already exists.
Set parameter "DependOnService" for service "kubelet".
New-NetFirewallRule : Cannot create a file when that file already exists.
At C:\Users\Administrator\k8s-setup\PrepareNode.ps1:106 char:1
+ New-NetFirewallRule -Name kubelet -DisplayName 'kubelet' -Enabled Tru ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : ResourceExists: (MSFT_NetFirewallRule:root/standardcimv2/MSFT_NetFirewallRule) [New-NetF
irewallRule], CimException
+ FullyQualifiedErrorId : Windows System Error 183,New-NetFirewallRule
There was a problem hiding this comment.
nit: add Git installation step before
.\PrepareNode.ps1step since it's depended on it.
#280 should resolve this
nit: make .\PrepareNode.ps1 script idempotent; fails after running the second time when an initially created file is re-created:
let's do a follow up for this. This PR is just a copy/paste so it is easier to maintain
k8s-ci-robot
added
the
needs-rebase
|
Nudging this PR as it's getting stale and blocking important documentation updates. |
k8s-ci-robot
added
size/XXL
Co-authored-by: Mark Rossetti <marosset@microsoft.com>
k8s-ci-robot
added
size/L
|
/assign @marosset |
|
What's the state here? |
k8s-ci-robot
added
the
needs-rebase
|
PR needs rebase. 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. |
|
will need to update since some changes went in. If you want we can merge your other PR's and you can submit a PR like this and I will be able to merge it since it is a straight move to split the files out. |
|
@jsturtevant I just did so :). |
|
/close |
|
@jsturtevant: Closed this PR. In response to this:
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. |
Signed-off-by: James Sturtevant jstur@microsoft.com
Reason for PR:
The guide had multiple CNI providers in the one doc and was hard to follow. This splits it out so it is easier to follow.
Issue Fixed:
Issue #
Requirements
Notes: