[DE-4343] Add VKS install page under Install on clusters#2816
Open
sujeet-kr wants to merge 6 commits into
Open
[DE-4343] Add VKS install page under Install on clusters#2816sujeet-kr wants to merge 6 commits into
sujeet-kr wants to merge 6 commits into
Conversation
Add a "VMware Kubernetes Service (VKS)" page to the Calico Enterprise install-on-clusters section and wire it into the sidebar after TKG. Covers installing Calico Enterprise on VKS: Part 1 Supervisor Service setup (Carvel package build/publish), Part 2 guest-cluster deployment with optional Windows node support, and Parts 3-4 air-gapped bundle/image relocation. Ported from tigera/vks CE-install.md: blockquote callouts converted to Docusaurus admonitions, an internal vSphere lab URL removed, the private- registry cross-link made site-relative, and $[prodname] used in body prose. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Copy the VKS install page into calico-enterprise_versioned_docs/version-3.23-2 and add it to that version's sidebar after TKG. Also switch the private-registry cross-link from an absolute /latest path to a relative .mdx link so it resolves to the correct version on both the latest and versioned pages. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Fix "Configmap" -> "ConfigMap" (correct Kubernetes kind casing) in the Step 6 heading. - Use kubectl apply -f for the Tigera license (idempotent on re-runs) instead of create -f. - Use grep -E 'tigera|calico' in the verification step (portable; BRE \| isn't on BSD/macOS grep). Copilot's /latest-link comment was already resolved by the prior relative-.mdx-link change. Applied to both the latest and 3.23-2 versioned copies. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Reorganize into Big picture / Before you begin / How to / Next steps to match the other "Install on clusters" pages (tkg, openshift, etc.); the Parts 1-4 procedure now lives under How to as ### subsections. Drop the body --- rules (headings already delimit sections), rename per-part "Prerequisites" headings to avoid duplicate slugs, update in-page anchor links to the new slugs, and add a Next steps section. Applied to both the latest and 3.23-2 versioned copies. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds new Calico Enterprise documentation for installing on VMware Kubernetes Service (VKS), and exposes it in both the “next” (unversioned) and versioned (3.23-2) navigation under Getting started → Install on clusters.
Changes:
- Adds a new VKS install guide (unversioned and versioned 3.23-2) covering Supervisor Service setup, guest cluster deployment (incl. optional Windows), and air-gapped relocation.
- Wires the new VKS page into the Calico Enterprise sidebar and the 3.23-2 versioned sidebar immediately after TKG.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 14 comments.
| File | Description |
|---|---|
| sidebars-calico-enterprise.js | Adds the VKS doc entry to the unversioned Calico Enterprise sidebar. |
| calico-enterprise/getting-started/install-on-clusters/vks.mdx | New VKS install guide for “next” docs. |
| calico-enterprise_versioned_sidebars/version-3.23-2-sidebars.json | Adds the VKS doc entry to the 3.23-2 versioned sidebar. |
| calico-enterprise_versioned_docs/version-3.23-2/getting-started/install-on-clusters/vks.mdx | New VKS install guide for version 3.23-2 docs. |
Comment on lines
+446
to
+455
| kubectl apply -f - << EOF | ||
| kind: ConfigMap | ||
| apiVersion: v1 | ||
| metadata: | ||
| name: kubernetes-services-endpoint | ||
| namespace: tigera-operator | ||
| data: | ||
| KUBERNETES_SERVICE_HOST: "${APISERVER_ADDR}" | ||
| KUBERNETES_SERVICE_PORT: "${APISERVER_PORT}" | ||
| EOF |
Comment on lines
+90
to
+92
| # Apply this on the Supervisor cluster for the namespaces where guest clusters will be provisioned with Calico Enterprise. | ||
| # The source Secret containing the manifests CRS will mirror | ||
| apiVersion: v1 |
Comment on lines
+90
to
+92
| # Apply this on the Supervisor cluster for the namespaces where guest clusters will be provisioned with Calico Enterprise. | ||
| # The source Secret containing the manifests CRS will mirror | ||
| apiVersion: v1 |
Comment on lines
+414
to
+417
| #### Step 3: Retrieve the Guest Cluster Kubeconfig | ||
|
|
||
|
|
||
| #### Step 5: [Windows only] Apply IPAM Configuration |
Comment on lines
+560
to
+562
| #### Step 4: Upload `calico-enterprise-svs.yaml` i.e. Package and PackageMetadata resource to the Supervisor | ||
|
|
||
|
|
Collaborator
|
My PR #2809 can be closed I think since this captures everything ! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new VMware Kubernetes Service (VKS) install page under Getting started → Install on clusters (Calico Enterprise), wired into the sidebar after TKG.
The page covers installing Calico Enterprise on VKS:
Part 1 — Supervisor Service setup (Carvel package build/publish)
Part 2 — guest-cluster deployment, with optional Windows node support
Parts 3–4 — air-gapped bundle/image relocation
Updates to #2809