Skip to content

Commit dbd0398

Browse files
committed
remove VKS Windows instructions from docs
1 parent a004cb5 commit dbd0398

3 files changed

Lines changed: 15 additions & 283 deletions

File tree

  • calico-enterprise_versioned_docs/version-3.23-2
  • calico-enterprise/getting-started/install-on-clusters

calico-enterprise/getting-started/install-on-clusters/vks.mdx

Lines changed: 7 additions & 141 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
---
2-
description: Install Calico Enterprise as a Supervisor Service on vSphere Kubernetes Service (VKS) and deploy it to guest clusters, with optional Windows node support.
2+
description: Install Calico Enterprise as a Supervisor Service on vSphere Kubernetes Service (VKS) and deploy it to guest clusters.
33
---
44

55
# vSphere Kubernetes Service (VKS)
66

77
## Big picture
88

9-
Install $[prodname] as a Supervisor Service on vSphere Kubernetes Service (VKS), and deploy it to guest clusters with optional Windows node support.
9+
Install $[prodname] as a Supervisor Service on vSphere Kubernetes Service (VKS), and deploy it to guest clusters.
1010

1111
## Before you begin
1212

1313
This guide requires:
1414

15-
- **VM Images**: Ubuntu or Photon (and optionally Windows) OVA images registered for a supported TKR version, with TKR in a healthy state.
15+
- **VM Images**: Ubuntu or Photon OVA images registered for a supported TKR version, with TKR in a healthy state.
1616
- **vSphere Resources**: Sufficient capacity to provision guest clusters with at minimum:
1717
- 1 control plane node
1818
- 3 Linux worker nodes
19-
- 1 Windows worker node (optional, if Windows workloads are required)
2019
- **OCI Registry**: An OCI-compliant registry configured in vSphere for storing package manifests and container images.
2120
- **Tigera pull secret** for accessing the Tigera container registry (contact the Tigera team).
2221

@@ -25,13 +24,6 @@ This guide requires:
2524
| Configuration | Dataplane | Encapsulation | BGP |
2625
|---|---|---|---|
2726
| Linux only (default) | IPTables | IPIP | Enabled |
28-
| Linux + Windows | IPTables | VXLAN | Disabled |
29-
30-
:::note
31-
32-
When Windows nodes are enabled, the encapsulation is automatically set to VXLAN and BGP is disabled. This is handled internally when `calicoWindowsDataplane.enabled` is set to `true` in the AddonConfig.
33-
34-
:::
3527

3628
## How to
3729

@@ -146,7 +138,6 @@ Update the following fields before applying:
146138
- `metadata.name` and `metadata.namespace`
147139
- `spec.addonConfigDefinitionRef` (name and namespace)
148140
- `spec.clusterName`
149-
- `spec.values.installation.calicoWindowsDataplane.enabled` (set to `true` for Windows support, `false` otherwise)
150141
- `spec.values.installation.registry` to use $[prodname] images from a private registry (for air-gapped installs). This should be the same registry where $[prodname] images are pushed to using [Part 4](#part-4-air-gapped-relocate-calico-enterprise-private-images-to-a-private-registry) of this doc. Optionally `spec.values.installation.imagePath` can be set if the $[prodname] images were pushed to a specific folder within the private registry.
151142

152143
:::
@@ -180,8 +171,6 @@ spec:
180171
enabled: true
181172
imagePullSecrets:
182173
- name: tigera-pull-secret
183-
calicoWindowsDataplane:
184-
enabled: false
185174
# registry: quay.io/
186175
# imagePath: ""
187176
# controlPlaneReplicas: 3
@@ -358,136 +347,13 @@ spec:
358347
- protocol: tcp
359348
fromPort: 8444
360349
toPort: 8444
361-
- class: node-pool
362-
metadata:
363-
annotations:
364-
run.tanzu.vmware.com/resolve-os-image: os-name=windows,os-version=2022
365-
name: win-node-pool-1
366-
# if Windows nodes needed
367-
replicas: 0
368-
variables:
369-
overrides:
370-
- name: vmClass
371-
value: best-effort-large
372-
- name: node
373-
value:
374-
firewall:
375-
inboundRules:
376-
# BGP
377-
- protocol: tcp
378-
fromPort: 179
379-
toPort: 179
380-
# VXLAN
381-
- protocol: udp
382-
fromPort: 4789
383-
toPort: 4789
384-
# Typha
385-
- protocol: tcp
386-
fromPort: 5473
387-
toPort: 5473
388-
# Wireguard
389-
- protocol: udp
390-
fromPort: 51820
391-
toPort: 51820
392-
# Elasticsearch
393-
- protocol: tcp
394-
fromPort: 9200
395-
toPort: 9200
396-
# Elasticsearch transport
397-
- protocol: tcp
398-
fromPort: 9300
399-
toPort: 9300
400-
# Tigera Manager UI
401-
- protocol: tcp
402-
fromPort: 9443
403-
toPort: 9443
404-
# Prometheus
405-
- protocol: tcp
406-
fromPort: 9090
407-
toPort: 9090
408-
# Linseed
409-
- protocol: tcp
410-
fromPort: 8444
411-
toPort: 8444
412350
```
413351

414352
#### Step 3: Retrieve the Guest Cluster Kubeconfig
415353

416354
Can be copied from the Supervisor.
417355

418-
#### Step 4: [Windows only] Apply IPAM Configuration
419-
420-
Apply the strict affinity IPAM configuration, after Calico `apiserver` is `Available`.
421-
422-
:::tip
423-
424-
Status can be checked using `kubectl get tigerastatus`.
425-
426-
:::
427-
428-
```bash
429-
kubectl apply -f ./ipam_configuration.yaml
430-
```
431-
432-
```yaml
433-
# Required for Windows nodes - ensures IPAM blocks are strictly
434-
# affinitive to their assigned nodes.
435-
# Apply this after calico-node pods are running.
436-
apiVersion: projectcalico.org/v3
437-
kind: IPAMConfiguration
438-
metadata:
439-
name: default
440-
spec:
441-
strictAffinity: true
442-
```
443-
444-
#### Step 5: [Windows only] Apply the kubernetes-services-endpoint ConfigMap
445-
446-
```bash
447-
export APISERVER_ADDR=<kubernetes-service-host>
448-
export APISERVER_PORT=<kubernetes-service-port>
449-
450-
kubectl apply -f - << EOF
451-
kind: ConfigMap
452-
apiVersion: v1
453-
metadata:
454-
name: kubernetes-services-endpoint
455-
namespace: tigera-operator
456-
data:
457-
KUBERNETES_SERVICE_HOST: "${APISERVER_ADDR}"
458-
KUBERNETES_SERVICE_PORT: "${APISERVER_PORT}"
459-
EOF
460-
```
461-
462-
:::tip
463-
464-
The `APISERVER_ADDR` and `APISERVER_PORT` can be retrieved via `kubectl get endpoints kubernetes -o wide`.
465-
466-
:::
467-
468-
#### Step 6: [Windows only] Apply the kube-proxy on Windows nodes
469-
470-
Apply the Windows kube-proxy:
471-
472-
```bash
473-
curl -L https://raw.githubusercontent.com/kubernetes-sigs/sig-windows-tools/master/hostprocess/calico/kube-proxy/kube-proxy.yml | sed "s/KUBE_PROXY_VERSION/<YOUR_KUBERNETES_VERSION>/g" | kubectl apply -f -
474-
```
475-
476-
Replace `<YOUR_KUBERNETES_VERSION>` with the kube-proxy version, e.g. `v1.35.2`.
477-
478-
:::tip
479-
480-
The Kubernetes version can be retrieved with `kubectl version -o json | jq -r '.serverVersion.gitVersion'`.
481-
482-
:::
483-
484-
:::note
485-
486-
If the version returned is of the form `v1.35.2+vmware.1`, strip the `+vmware.1` suffix unless a VMware-provided kube-proxy image exists in the `sigwindowstools/kube-proxy` repository.
487-
488-
:::
489-
490-
#### Step 7: Wait for Core Components
356+
#### Step 4: Wait for Core Components
491357

492358
Monitor the Tigera status until `calico` and `apiserver` report as `Available`:
493359

@@ -497,13 +363,13 @@ kubectl get tigerastatus
497363

498364
At this point, all nodes should be in `Ready` state.
499365

500-
#### Step 8: Apply the Tigera License
366+
#### Step 5: Apply the Tigera License
501367

502368
```bash
503369
kubectl apply -f tigera-license.yaml
504370
```
505371

506-
#### Step 9: Verify the Installation
372+
#### Step 6: Verify the Installation
507373

508374
Wait for all remaining components to become available:
509375

@@ -575,7 +441,7 @@ Follow the steps in [Push $[prodname] images to your private registry](./private
575441

576442
:::note
577443

578-
Only steps 1, 2, 3, 4 — i.e. `docker pull`, `docker tag` and `docker push` for Linux only; and the `crane cp` for Windows images — need to be performed.
444+
Only steps 1, 2, 3, 4 — i.e. `docker pull`, `docker tag` and `docker push` for Linux only need to be performed.
579445

580446
:::
581447

0 commit comments

Comments
 (0)