docs: airgap refactor DOC-1044 DOC-1043 DOC-973

* docs: updated diagram * chore: more content * docs: added more steps * chore: save * chore: save * chore: merged master * docs: more step * save * docs: updated airgap VMware step * docs: DOC-1044 metalLB limitation * docs: DOC-1043 Grafana issue * docs: language cleanup * docs: ready for ent refactpr * docs: added OVAs * docs: prep for palette airgap * docs: save * docs: final touches * docs: vale feedback * Optimised images with calibre/image-actions * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <[email protected]> * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <[email protected]> * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <[email protected]> * docs: feedback - manual * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <[email protected]> * docs: ready for merge * chore: prettier fix --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Yuliia Horbenko <[email protected]>
spectrocloud · Jan 29, 2024 · 4823023 · 4823023
1 parent 2c629c9
commit 4823023
Show file tree

Hide file tree

Showing 15 changed files with 1,118 additions and 918 deletions.
diff --git a/docs/docs-content/enterprise-version/install-palette/airgap/airgap.md b/docs/docs-content/enterprise-version/install-palette/airgap/airgap.md
@@ -56,6 +56,8 @@ Palette installation.
 
 ## Supported Platforms
 
+The following table outlines the platforms supported for airgap VerteX installation and the supported OCI registries.
+
 | **Platform**   | **OCI Registry** | **Supported** |
 | -------------- | ---------------- | ------------- |
 | Kubernetes     | Harbor           | ✅            |

diff --git a/docs/docs-content/enterprise-version/install-palette/airgap/checklist.md b/docs/docs-content/enterprise-version/install-palette/airgap/checklist.md
@@ -24,66 +24,44 @@ installation.
 
 - [ ] `zip` is installed and available.
 
-- [ ] Downloaded the airgap setup binary from the support team.
+- [ ] Download the airgap setup binary from the support team.
 
-- [ ] Created a private repository with the name `spectro-packs` in your OCI registry. You can use a different name if
-      you prefer.
+- [ ] Create a private repository named `spectro-packs` in your OCI registry. You can use a different name if you
+      prefer.
 
-- [ ] Created a public repository with the name `spectro-images` in your OCI registry. You can use a different name if
-      you prefer.
+- [ ] Create a public repository named `spectro-images` in your OCI registry. You can use a different name if you
+      prefer.
 
-- [ ] Authenticated with your OCI registry and acquired credentials to both repositories.
+- [ ] Authenticate with your OCI registry and acquired credentials to both repositories.
+
+- [ ] Download the Certificate Authority (CA) certificate from your OCI registry.
 
 - [ ] Set the required environment variables for the airgap setup binary. The values are different depending on what
       type of OCI registry you use.
 
-- [ ] Started the airgap setup binary and verified the setup completed successfully.
+- [ ] Start the airgap setup binary and verified the setup completed successfully.
 
-- [ ] Reviewed the list of pack binaries to download and upload to your OCI registry.
+- [ ] Review the list of pack binaries to download and upload to your OCI registry.
 
-- [ ] Extracted the manifest content from the airgap setup binary to an HTTP file server.
+- [ ] Extract the manifest content from the airgap setup binary to an HTTP file server.
 
-- [ ] Ensured the manifest content is hosted on an HTTP file server that is accessible from the environment you are
+- [ ] Ensure the manifest content is hosted on an HTTP file server accessible from the environment to which you are
       installing Palette.
 
 </TabItem>
 
 <TabItem label="VMware vSphere" value="vsphere">
 
-- [ ] `oras` CLI v1.0.0 is installed and available.
-
-- [ ] `aws` CLI v2 or greater CLI is installed and available.
-
-- [ ] `zip` is installed and available.
-
-- [ ] Downloaded the airgap setup binary from the support team.
+- [ ] Create a vSphere VM and Template folder named `spectro-templates`.
 
-- [ ] Created a vSphere VM and Template folder with the name `spectro-templates`.
-
-- [ ] Imported the Operating System and Kubernetes distribution OVA required for the install and placed the OVA in the
+- [ ] Import the Operating System and Kubernetes distribution OVA required for the installation and place the OVA in the
       `spectro-templates` folder.
 
-- [ ] Appended an `r_` prefix to the OVA name after the import.
-
-- [ ] Created a private repository with the name `spectro-packs` in your OCI registry. You can use a different name if
-      you prefer.
-
-- [ ] Created a public repository with the name `spectro-images` in your OCI registry. You can use a different name if
-      you prefer.
-
-- [ ] Authenticated with your OCI registry and acquired credentials to both repositories.
-
-- [ ] Set the required environment variables for the airgap setup binary. Refer to step 8 in the
-      [Preparation](#preperation) section for information.
-
-- [ ] Started the airgap setup binary and verified the setup completed successfully
-
-- [ ] Reviewed the list of pack binaries to download and upload to your OCI registry.
+- [ ] Append the `r_` prefix and remove the `.ova` suffix from the OVA name after the import.
 
-- [ ] Extracted the manifest content from the airgap setup binary to an HTTP file server.
+- [ ] Start the airgap setup binary and verify the setup is completed successfully.
 
-- [ ] Ensured the manifest content is hosted on an HTTP file server that is accessible from the vSphere environment you
-      are installing Palette.
+- [ ] Review the list of [pack binaries](./supplemental-packs.md) to download and upload to your OCI registry.
 
 </TabItem>
 

diff --git a/docs/docs-content/enterprise-version/install-palette/airgap/supplemental-packs.md b/docs/docs-content/enterprise-version/install-palette/airgap/supplemental-packs.md
@@ -74,7 +74,7 @@ our support team to [obtain the credentials](../../enterprise-version.md#access-
 how to download the `airgap-pack-aws-alb-2.5.1.bin` binary.
 
 ```bash
-$ curl --user XXXXX:YYYYY https://software-private.spectrocloud.com/airgap/packs/airgap-pack-aws-alb-2.5.1.bin \
+curl --user XXXXX:YYYYY https://software-private.spectrocloud.com/airgap/packs/airgap-pack-aws-alb-2.5.1.bin \
  --output airgap-pack-aws-alb-2.5.1.bin
 ```
 
@@ -83,3 +83,50 @@ $ curl --user XXXXX:YYYYY https://software-private.spectrocloud.com/airgap/packs
 All binaries require the OCI environment variables to be set and for the registry credentials to be available.
 
 :::
+
+## Additional OVAs
+
+The following table lists additional OVAs you may need depending on the Kubernetes version and distribution you want to
+use for the workload clusters.
+
+| **Kubernetes Version** | **OVA Name**            | **Download URL**                                                                           |
+| ---------------------- | ----------------------- | ------------------------------------------------------------------------------------------ |
+| Kubernetes 1.26.4      | u-2204-0-k-1264-0       | `https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-1264-0.ova`       |
+| Kubernetes 1.26.5      | u-2204-0-k-1265-0       | `https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-1265-0.ova`       |
+| Kubernetes 1.26.10     | u-2204-0-k-12610-0      | `https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-12610-0.ova`      |
+| Kubernetes 1.27.1      | u-2204-0-k-1271-0       | `https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-1271-0.ova`       |
+| Kubernetes 1.27.2      | u-2204-0-k-1272-0       | `https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-1272-0.ova`       |
+| Kubernetes 1.28.2      | u-2204-0-k-1282-0       | `https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-1282-0.ova`       |
+| RKE2 1.26.11           | u-2204-0-k-rke2-12611-0 | `https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-rke2-12611-0.ova` |
+| RKE2 1.27.8            | u-2204-0-k-rke2-1278-0  | `https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-rke2-1278-0.ova`  |
+| RKE2 1.28.4            | u-2204-0-k-rke2-1284-0  | `https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-rke2-1284-0.ova`  |
+
+### Usage Instructions
+
+Use the provided download URL to download the OVA and upload it to your vSphere environment. The OVA must be uploaded to
+the `spectro-templates ` so Palette can access it.
+
+One additional note about uploaded OVAs, the OVA name must be prefixed with `r_` to be recognized by Palette. You can
+rename the OVA before you upload it or after you upload it to vSphere. Use the following command examples to download
+and rename the necessary OVA files with `curl` or `wget`.
+
+<Tabs>
+<TabItem label="curl" value="curl">
+
+```shell
+curl --output r_u-2204-0-k-12610-0.ova \
+https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-12610-0.ova
+```
+
+</TabItem>
+
+<TabItem label="wget" value="wget">
+
+```shell
+wget --quiet --show-progress \
+--output-document=r_u-2204-0-k-12610-0.ova \
+https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-12610-0.ova
+```
+
+</TabItem> 
+</Tabs>