[DOC 1368] RHEL base binary options to be used in Airgap mode (#3888)

* docs: add initial draft of the guide * docs: add file server details * docs: review steps, grammar * docs: add partials * docs: restructure folders * docs: fix broken links * docs: restructure vertex folders * docs: add redirects * docs: fix more broken links * docs: fix more broken links * docs: fix existing redirects * docs: fix last broken links * docs: fix broken links * docs: update rhel version, add limitations, add last steps * docs: vale feedback * docs: delete other partials * docs: address review suggestions
spectrocloud · Oct 21, 2024 · cb65489 · cb65489
1 parent 0856be1
commit cb65489
Show file tree

Hide file tree

Showing 17 changed files with 652 additions and 81 deletions.
diff --git a/_partials/self-hosted/_setup-steps.mdx b/_partials/self-hosted/_setup-steps.mdx
diff --git a/...nt/byoos/capi-image-builder/build-image-vmware/airgap-build/rhel-capi-airgap.md b/...nt/byoos/capi-image-builder/build-image-vmware/airgap-build/rhel-capi-airgap.md
@@ -32,7 +32,7 @@ Enterprise Linux (RHEL) image with <VersionedLink text="Palette eXtended Kuberne
   vSphere.
 
 - SSH access to the VMware vSphere
-  [airgap support VM](../../../../enterprise-version/install-palette/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md)
+  [airgap support VM](../../../../enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md)
   utilized to deploy the airgapped instance of Palette or Vertex.
 
 - The following artifacts must be available in the root home directory of the airgap support VM. You can download the

diff --git a/...t/byoos/capi-image-builder/build-image-vmware/airgap-build/rocky-capi-airgap.md b/...t/byoos/capi-image-builder/build-image-vmware/airgap-build/rocky-capi-airgap.md
@@ -28,7 +28,7 @@ This guide teaches you how to use the [CAPI Image Builder](../../capi-image-buil
   vSphere.
 
 - SSH access to the VMware vSphere
-  [airgap support VM](../../../../enterprise-version/install-palette/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md)
+  [airgap support VM](../../../../enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md)
   utilized to deploy the airgapped instance of Palette or Vertex.
 
 - The following artifacts must be available in the root home directory of the airgap support VM. You can download the

diff --git a/docs/docs-content/byoos/capi-image-builder/config-reference.md b/docs/docs-content/byoos/capi-image-builder/config-reference.md
@@ -109,10 +109,10 @@ create a separate configuration file for each.
 Fill out the parameters below if you are building the image in an air-gapped environment. Otherwise, you can skip this
 section.
 
-| Parameter   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                          | Required |
-| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
-| `airgap`    | Set to `true` if you are building the image in an air-gapped environment.                                                                                                                                                                                                                                                                                                                                                                            | Yes      |
-| `airgap_ip` | The IP address or hostname of the airgap support VM that has the required dependencies. Refer to the [Self-Hosted Palette](../../enterprise-version/install-palette/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md) and [Vertex](../../vertex/install-palette-vertex/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md) Environment Setup pages for instructions on how to deploy an airgap support VM. | Yes      |
+| Parameter   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Required |
+| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
+| `airgap`    | Set to `true` if you are building the image in an air-gapped environment.                                                                                                                                                                                                                                                                                                                                                                                                                | Yes      |
+| `airgap_ip` | The IP address or hostname of the airgap support VM that has the required dependencies. Refer to the [Self-Hosted Palette](../../enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md) and [Vertex](../../vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md) Environment Setup pages for instructions on how to deploy an airgap support VM. | Yes      |
 
 ## Example Configuration
 

diff --git a/docs/docs-content/enterprise-version/install-palette/airgap/airgap.md b/docs/docs-content/enterprise-version/install-palette/airgap/airgap.md
@@ -57,7 +57,7 @@ To get started with an airgap Palette installation, check out the respective pla
 
 - [Kubernetes Airgap Instructions](../install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md)
 
-- [VMware vSphere Airgap Instructions](../install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md)
+- [VMware vSphere Airgap Instructions](../install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md)
 
 Each platform guide provides detailed instructions on how to complete the pre-install steps.
 

diff --git a/...rise-version/install-palette/install-on-vmware/airgap-install/airgap-install.md b/...rise-version/install-palette/install-on-vmware/airgap-install/airgap-install.md
@@ -54,11 +54,11 @@ Configure your Palette environment
 ## Get Started
 
 To get started with an airgap Palette installation, begin by reviewing the
-[Environment Setup](./vmware-vsphere-airgap-instructions.md) guide.
+[Environment Setup](./environment-setup/vmware-vsphere-airgap-instructions.md) guide.
 
 ## Resources
 
-- [Environment Setup](./vmware-vsphere-airgap-instructions.md)
+- [Environment Setup](./environment-setup/vmware-vsphere-airgap-instructions.md)
 
 - [Airgap Install Checklist](./checklist.md)
 

diff --git a/...tall-palette/install-on-vmware/airgap-install/environment-setup/env-setup-vm.md b/...tall-palette/install-on-vmware/airgap-install/environment-setup/env-setup-vm.md
@@ -0,0 +1,31 @@
+---
+sidebar_label: "Environment Setup with RHEL"
+title: "Environment Setup with an Existing RHEL VM"
+description: "Learn how to prepare your airgap environment for Palette installation using an existing RHEL VM"
+icon: ""
+hide_table_of_contents: false
+sidebar_position: 30
+tags: ["self-hosted", "enterprise", "airgap", "vmware", "vsphere", "rhel"]
+keywords: ["self-hosted", "enterprise"]
+---
+
+This guide helps you prepare your VMware vSphere airgap environment for Palette installation using an existing Red Hat
+Enterprise Linux (RHEL) VM.
+
+You will learn how to execute an appliance binary in your VM that installs the necessary tools to deploy an OCI registry
+for hosting Palette images and assists in starting the Palette installation.
+
+:::info
+
+This guide is for preparing your airgap environment only. For instructions on installing Palette on VMware, refer to the
+[Install Palette](../install.md) guide.
+
+:::
+
+## Limitations
+
+- Currently, `9.4` is the only supported RHEL version.
+
+import SetupSteps from "../../../../../../../_partials/self-hosted/_setup-steps.mdx";
+
+<PartialsComponent category="self-hosted" name="setup-steps" edition="Palette" />
diff --git a/...palette/install-on-vmware/airgap-install/environment-setup/environment-setup.md b/...palette/install-on-vmware/airgap-install/environment-setup/environment-setup.md
@@ -0,0 +1,26 @@
+---
+sidebar_label: "Environment Setup"
+title: "Environment Setup"
+description: "Learn how to prepare your airgap environment for Palette installation."
+icon: ""
+hide_table_of_contents: false
+sidebar_position: 20
+tags: ["self-hosted", "enterprise", "airgap", "vmware", "vsphere"]
+keywords: ["self-hosted", "enterprise"]
+---
+
+This section helps you prepare your VMware vSphere airgap environment for Palette installation. You can choose between
+two methods to prepare your environment:
+
+1. If you have a Red Hat Enterprise Linux (RHEL) VM deployed in your environment, follow the
+   [Environment Setup with an Existing RHEL VM](./env-setup-vm.md) guide to learn how to prepare this VM for Palette
+   installation.
+2. If you do not have an RHEL VM, follow the [Environment Setup with OVA](./vmware-vsphere-airgap-instructions.md)
+   guide. This guide will show you how to use an OVA to deploy an airgap support VM in your VMware vSphere environment,
+   which will then assist with the Palette installation process.
+
+## Resources
+
+- [Environment Setup with an Existing RHEL VM](./env-setup-vm.md)
+
+- [Environment Setup with OVA](./vmware-vsphere-airgap-instructions.md)
diff --git a/...all/vmware-vsphere-airgap-instructions.md → ...tup/vmware-vsphere-airgap-instructions.md b/...all/vmware-vsphere-airgap-instructions.md → ...tup/vmware-vsphere-airgap-instructions.md
@@ -1,21 +1,22 @@
 ---
-sidebar_label: "Environment Setup"
-title: "Environment Setup"
-description: "Learn how to install Palette in an air gap environment."
+sidebar_label: "Environment Setup with OVA"
+title: "Environment Setup with OVA"
+description: "Learn how to install Palette in an airgap environment."
 icon: ""
 hide_table_of_contents: false
 sidebar_position: 20
 tags: ["self-hosted", "enterprise", "airgap", "vmware", "vsphere"]
 keywords: ["self-hosted", "enterprise"]
 ---
 
-This guide helps you to prepare your airgap environment for Palette installation.
+This guide helps you prepare your airgap environment for Palette installation using an OVA to deploy and initialize an
+airgap support VM.
 
 :::info
 
 This guide is for preparing your airgap environment only. For instructions on installing Palette on VMware, check the
 [Install](../install.md) guide. A checklist of the steps you will complete to prepare your airgap environment for
-Palette is available on the [Checklist](./checklist.md) page.
+Palette is available on the [Checklist](../checklist.md) page.
 
 :::
 
@@ -50,17 +51,17 @@ Palette.
 - Configure the Dynamic Host Configuration Protocol (DHCP) to access the airgap support VM via SSH. You can disable DHCP
   or modify the IP address after deploying the airgap support VM.
 
-- Review the required vSphere [permissions](../../install-on-vmware/vmware-system-requirements.md) and ensure you've
+- Review the required vSphere [permissions](../../../install-on-vmware/vmware-system-requirements.md) and ensure you've
   created the proper custom roles and zone tags. Zone tagging enables dynamic storage allocation across fault domains
   when provisioning workloads that require persistent storage. Refer to
-  [Zone Tagging](../../install-on-vmware/vmware-system-requirements.md#zone-tagging) for information.
+  [Zone Tagging](../../../install-on-vmware/vmware-system-requirements.md#zone-tagging) for information.
 
 :::info
 
 Self-hosted Palette installations provide a system Private Cloud Gateway (PCG) out-of-the-box and typically do not
 require a separate, user-installed PCG. However, you can deploy additional PCG instances to support provisioning into
 remote data centers without a direct incoming connection to Palette. To learn how to install a PCG on VMware, check out
-the [VMware](../../../../clusters/pcg/deploy-pcg/vmware.md) guide.
+the [VMware](../../../../../clusters/pcg/deploy-pcg/vmware.md) guide.
 
 :::
 
@@ -84,28 +85,42 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
 4.  In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes
     distribution OVA required for the installation.
 
-    Consider the following example for reference.
+        Consider the following example for reference.
 
-    ```url
-    https://vmwaregoldenimage-console.s3.us-east-2.amazonaws.com/u-2204-0-k-12610-0.ova
-    ```
+        <!-- prettier-ignore -->
+        <Tabs>
+        <TabItem value="non-fips" label="Non-FIPS">
+
+        ```url
+        https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-1294-0.ova
+        ```
+        <!-- prettier-ignore -->
+        </TabItem>
+        <TabItem value="fips" label="FIPS">
 
-    Place the OVA in the **spectro-templates** folder. Append the `r_` prefix, and remove the `.ova` suffix when
-    assigning its name and target location. For example, the final output should look like `r_u-2004-0-k-12610`. This
-    naming convention is required for the installation process to identify the OVA. Refer to the
-    [Supplement Packs](../../airgap/supplemental-packs.md#additional-ovas) page for a list of additional OS OVAs.
+        ```url
+        https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-1294-fips.ova
+        ```
+        <!-- prettier-ignore -->
+        </TabItem>
+        </Tabs>
 
-    You can terminate the deployment after the OVA is available in the `spectro-templates` folder. Refer to the
-    [Deploy an OVF or OVA Template](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-AFEDC48B-C96F-4088-9C1F-4F0A30E965DE.html)
-    guide for more information about deploying an OVA in vCenter.
+        Place the OVA in the **spectro-templates** folder. Append the `r_` prefix, and remove the `.ova` suffix when
+        assigning its name and target location. For example, the final output should look like `r_u-2204-0-k-1294-0`. This
+        naming convention is required for the installation process to identify the OVA. Refer to the
+        [Supplement Packs](../../../airgap/supplemental-packs.md#additional-ovas) page for a list of additional OS OVAs.
 
-    :::warning
+        You can terminate the deployment after the OVA is available in the `spectro-templates` folder. Refer to the
+        [Deploy an OVF or OVA Template](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-AFEDC48B-C96F-4088-9C1F-4F0A30E965DE.html)
+        guide for more information about deploying an OVA in vCenter.
 
-    If you encounter an error message during the OVA deployment stating unable to retrieve manifest or certificate,
-    refer to this [known issue](https://kb.vmware.com/s/article/79986) from VMware's knowledge base for guidance on how
-    to resolve the issue.
+        :::warning
 
-    :::
+        If you encounter an error message during the OVA deployment stating unable to retrieve manifest or certificate,
+        refer to this [known issue](https://kb.vmware.com/s/article/79986) from VMware's knowledge base for guidance on how
+        to resolve the issue.
+
+        :::
 
 5.  Next, deploy the airgap installation OVA by using the **Deploy OVF Template** wizard again in vSphere. Insert the
     Palette install OVA URL in the **URL** field. The URL is provided to you by your Palette support representative.
@@ -353,7 +368,7 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
 21. The output of the script contains credentials and values you will need when completing the installation with the
     Palette CLI. If you need to review this information in the future, invoke the script again.
 
-22. If you have used a release-specific installation OVA, skip this step. Otherwise, if you have use a generic
+22. If you have used a release-specific installation OVA, skip this step. Otherwise, if you have used a generic
     installation OVA, use the following command to execute the Palette airgap installation binary.
 
     ```shell
@@ -382,8 +397,8 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
 
     Once the airgap binary completes its tasks, you will receive a **Setup Completed** success message.
 
-23. Review the [Additional Packs](../../airgap/supplemental-packs.md) page and identify any additional packs you want to
-    add to your OCI registry. You can also add additional packs after the installation is complete.
+23. Review the [Additional Packs](../../../airgap/supplemental-packs.md) page and identify any additional packs you want
+    to add to your OCI registry. You can also add additional packs after the installation is complete.
 
 You have now completed the preparation steps for an airgap installation. Check out the [Validate](#validate) section to
 ensure the airgap setup process is completed successfully. After you validate the airgap setup process completion,
@@ -460,7 +475,7 @@ installed in the airgap support VM and ready to use.
     palette ec install
     ```
 
-Complete all the Palette CLI steps outlined in the [Install Palette](./install.md) guide from the airgap support VM.
+Complete all the Palette CLI steps outlined in the [Install Palette](../install.md) guide from the airgap support VM.
 
 :::info
 

diff --git a/.../enterprise-version/install-palette/install-on-vmware/airgap-install/install.md b/.../enterprise-version/install-palette/install-on-vmware/airgap-install/install.md
@@ -16,7 +16,7 @@ and assets.
 
 ## Prerequisites
 
-- You have completed the [Environment Setup](./vmware-vsphere-airgap-instructions.md) steps and deployed the airgap
+- You have completed the [Environment Setup](./environment-setup/environment-setup.md) steps and deployed the airgap
   support VM.
 
 - Review the required VMware vSphere [permissions](../vmware-system-requirements.md). Ensure you have created the proper
@@ -109,8 +109,8 @@ Use the following steps to install Palette.
     :::warning
 
     If you deployed the airgap support VM using a generic OVA, the Palette CLI may not be in the `usr/bin` path. Ensure
-    that you complete step **22** of the [Environment Setup](./vmware-vsphere-airgap-instructions.md) guide, which
-    installs the Palette airgap binary and moves the Palette CLI to the correct path.
+    that you complete step **22** of the [Environment Setup](./environment-setup/vmware-vsphere-airgap-instructions.md)
+    guide, which installs the Palette airgap binary and moves the Palette CLI to the correct path.
 
     :::
 
@@ -182,7 +182,7 @@ Use the following steps to install Palette.
     | **Use Public Registry for Images**               | Type `y` to use a public registry for images. Type `n` to a different registry for images. If you are using another registry for images, you will be prompted to enter the registry URL, base path, username, and password. Airgap users, select `n` so that you can specify the values for the OCI registry that contains all the required images. |
 
         	When prompted to **Pull images from public registry**, type `n` and specify the OCI registry configuration values for
-        	your image registry. If you are an airgap support VM, the CLI will automatically detect the airgap environment and prompt you to **Use local, air-gapped Image Registry?** Type `y` to use the local resources and skip filling in the OCI registry URL and credentials.
+        	your image registry. If you are on an airgap support VM, the CLI will automatically detect the airgap environment and prompt you to **Use local, air-gapped Image Registry?** Type `y` to use the local resources and skip filling in the OCI registry URL and credentials.
         Refer to the table above for more information.
 
     :::info

diff --git a/...ertex/install-palette-vertex/install-on-vmware/airgap-install/airgap-install.md b/...ertex/install-palette-vertex/install-on-vmware/airgap-install/airgap-install.md
@@ -54,11 +54,11 @@ Configure your Palette environment
 ## Get Started
 
 To get started with an airgap Palette installation, begin by reviewing the
-[Environment Setup](./vmware-vsphere-airgap-instructions.md) guide.
+[Environment Setup](./environment-setup/vmware-vsphere-airgap-instructions.md) guide.
 
 ## Resources
 
-- [Environment Setup](./vmware-vsphere-airgap-instructions.md)
+- [Environment Setup](./environment-setup/vmware-vsphere-airgap-instructions.md)
 
 - [Airgap Install Checklist](./checklist.md)