From cb654896b382d5fa08405d2aee4224b18ba7e133 Mon Sep 17 00:00:00 2001 From: caroldelwing Date: Mon, 21 Oct 2024 09:06:40 -0400 Subject: [PATCH] [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 --- _partials/self-hosted/_setup-steps.mdx | 418 ++++++++++++++++++ .../airgap-build/rhel-capi-airgap.md | 2 +- .../airgap-build/rocky-capi-airgap.md | 2 +- .../capi-image-builder/config-reference.md | 8 +- .../install-palette/airgap/airgap.md | 2 +- .../airgap-install/airgap-install.md | 4 +- .../environment-setup/env-setup-vm.md | 31 ++ .../environment-setup/environment-setup.md | 26 ++ .../vmware-vsphere-airgap-instructions.md | 71 +-- .../airgap-install/install.md | 8 +- .../airgap-install/airgap-install.md | 4 +- .../environment-setup/env-setup-vm-vertex.md | 31 ++ .../environment-setup/environment-setup.md | 26 ++ .../vmware-vsphere-airgap-instructions.md | 53 ++- .../airgap-install/install.md | 33 +- .../install-on-vmware/install.md | 2 +- redirects.js | 12 +- 17 files changed, 652 insertions(+), 81 deletions(-) create mode 100644 _partials/self-hosted/_setup-steps.mdx create mode 100644 docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/env-setup-vm.md create mode 100644 docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/environment-setup.md rename docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/{ => environment-setup}/vmware-vsphere-airgap-instructions.md (87%) create mode 100644 docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/env-setup-vm-vertex.md create mode 100644 docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/environment-setup.md rename docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/{ => environment-setup}/vmware-vsphere-airgap-instructions.md (92%) diff --git a/_partials/self-hosted/_setup-steps.mdx b/_partials/self-hosted/_setup-steps.mdx new file mode 100644 index 0000000000..2de5320e35 --- /dev/null +++ b/_partials/self-hosted/_setup-steps.mdx @@ -0,0 +1,418 @@ +--- +partial_category: self-hosted +partial_name: setup-steps +--- + +## Prerequisites + +- An RHEL airgap VM deployed in your VMware vSphere. The VM must be registered with + [Red Hat](https://access.redhat.com/solutions/253273) and have ports `80` and `443` available. This guide uses RHEL + version `9.4` as an example. + +- The RHEL VM must have a Fully Qualified Domain Name (FQDN) that is DNS resolvable and must be accessible via SSH. + +- The RHEL VM must have Podman installed. + +- An HTTP file server installed within the RHEL VM to host the {props.edition} files. The file server must serve files from the + `/var/www/html` directory and have SSL support enabled. Below is a list of common file servers. This guide uses Apache + as an example. + + - [Apache HTTP Server](https://httpd.apache.org/) + + - [Nginx](https://www.nginx.com/) + + - [Caddy](https://caddyserver.com/) + + :::warning + + Take the necessary steps to secure your file server and ensure it can automatically recover from failure. The file + server is a critical component of the airgap installation and must be available post-install for {props.edition} to function + properly. + + ::: + +- Review the required vSphere and ensure you have + 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 for information. + +- The following artifacts must be available in the root home directory of the RHEL airgap VM. You can download the files + in a system with internet access and then transfer them to your airgap environment. Contact your {props.edition} support + representative to obtain the latest version of each artifact. + - RHEL airgap appliance binary. + - {props.edition} airgap installation binary. + +## Prepare for Airgap Installation + +1. Log in to your vCenter environment. + +2. Create a vSphere template folder named `spectro-templates`. Ensure you can access this folder with the user account + you plan to use when deploying the {props.edition} installation. + +3. Right-click on your cluster or resource group and select **Deploy OVF Template**. + +4. In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes + distribution OVA required for the {props.edition} nodes creation. Contact your {props.edition} support representative to learn if + the version of {props.edition} you are using requires a new OS and Kubernetes OVA. + + + + + ```url + https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-1294-0.ova + ``` + + + + + ```url + https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-1294-fips.ova + ``` + + + + + 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 + page for a list of additional OS and + Kubernetes OVAs. + + 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. + + :::warning + + If you encounter an error message during the OVA deployment stating that vCenter is unable to retrieve a 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. Open a terminal window and SSH into the RHEL airgap VM as a root user with the command below. Replace + `/path/to/private_key` with the path to your private SSH key, `docs` with the username, and `palette.example.com` + with the FQDN of the RHEL airgap VM. + + ```shell + ssh -i /path/to/private_key docs@palette.example.com + ``` + +6. Switch to the `root` user account to complete the remaining steps. + + ```shell + sudo --login + ``` + +7. Set the VM timezone to Coordinated Universal Time (UTC). + + ```shell + timedatectl set-timezone UTC + ``` + +8. Ensure that ports `80` and `443` are not in use by your file server, as these ports will be used by the Harbor + registry that will be installed later. + + Open the `/etc/httpd/conf.d/ssl.conf` file and make the following changes: + + - Replace the line `Listen 443 https` with `Listen 8443 https`. + - Replace the line `` with ``. + + Save and exit the file. + +9. Next, open the `/etc/httpd/conf/httpd.conf` file and replace the line `Listen 80` with `Listen 8080`. Save and exit + the file. + +10. Restart the Apache HTTP server to apply the configuration changes. + + ```shell + systemctl restart httpd.service + ``` + +11. Allow TCP traffic on ports `80`, `8080`, `443`, and `8443`, then reload the firewall. + + ```shell + firewall-cmd --permanent --add-port=80/tcp + firewall-cmd --permanent --add-port=8080/tcp + firewall-cmd --permanent --add-port=443/tcp + firewall-cmd --permanent --add-port=8443/tcp + firewall-cmd --reload + ``` + + The output displays a success message. + + ```text hideClipboard + success + ``` + +12. Set the `AIRGAP_BUILD` variable as `true`. This is required for the RHEL airgap appliance binary. + + ```shell + export AIRGAP_BUILD=true + ``` + +13. Start the RHEL airgap appliance binary, which installs the tools and configures the manifests that are required to + set up the Harbor registry and push images. Replace `` with the version of the binary received from the support team. + + ```shell + chmod +x ./airgap-appliance--rhel-podman.bin && ./airgap-appliance--rhel-podman.bin + ``` + + Consider the following example for reference. + + ```shell + chmod +x ./airgap-appliance-v4.4.2-rhel-podman.bin && ./airgap-appliance-v4.4.2-rhel-podman.bin + ``` + + ```text hideClipboard + Verifying archive integrity... 100% MD5 checksums are OK. All good. + Uncompressing Airgap Appliance Setup - 4.4.2 100% + Setting up directories and certs + warning: /opt/spectro/pwgen-2.08-3.el8.x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID 2f86d6a1: NOKEY + Verifying... ################################# [100%] + Preparing... ################################# [100%] + Updating / installing... + 1:pwgen-2.08-3.el8 ################################# [100%] + Skipping setting up Nginx and Podman for airgap + Installing Podman + Setting up Harbor + Setting up oras and jq + Setting up Manifests + Cleaning up setup files + Reboot the system for selinux changes to take effect + ``` + +14. Reboot your RHEL VM to apply the changes. + + ```shell + reboot + ``` + + + Your SSH connection will be terminated. + +15. Start a new SSH session and switch to `sudo` mode before proceeding. + + ```shell + sudo --login + ``` + +16. Issue the following command to configure the Harbor registry. Replace `palette.example.com` with the FQDN of the + RHEL airgap VM. The script will generate a self-signed certificate for the value you provide. + + ```shell + /bin/airgap-setup.sh palette.example.com + ``` + + The script output should look similar to the example below. It contains the 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. + + ```text hideClipboard + Setting up SSL Certs + /opt/spectro/functions.sh: line 118: /etc/nginx/.htpasswd: No such file or directory + chmod: cannot access '/etc/nginx/.htpasswd': No such file or directory + mkdir: cannot create directory ‘/etc/nginx/ssl’: No such file or directory + cp: target '/etc/nginx/ssl' is not a directory + Setting up Harbor + setenforce is /usr/sbin/setenforce + Setup Completed + + Details: + ------- + Spectro Cloud Repository + Location: https://palette.example.com:8443 + UserName: spectro + Password: ************** + CA certificate filepath: /opt/spectro/ssl/server.crt + + Pack OCI Registry + Endpoint: https://palette.example.com + Base Content Path: spectro-packs + CA certificate Filepath: /opt/spectro/ssl/server.crt + Username: admin + Password: ************** + + Image OCI Registry + Endpoint: https://palette.example.comv + Base Content Path: spectro-images + CA certificate Filepath: /opt/spectro/ssl/server.crt + Username: admin + Password: ************** + ``` + +17. Update the SSL certificate file and key in the **httpd** service. + + :::warning + + You can skip this step if you do not plan to use the local Spectro Cloud Artifact Repository (SCAR) during the + [{props.edition} installation](#next-steps) process. + + ::: + + Open the `/etc/httpd/conf.d/ssl.conf` file and add the path to the certificate and key generated in step **15** of + this guide: + + - Replace the line `SSLCertificateFile /etc/pki/tls/certs/localhost.crt` with + `SSLCertificateFile /opt/spectro/ssl/server.crt`. + - Replace the line `SSLCertificateKeyFile /etc/pki/tls/private/localhost.key` with + `SSLCertificateKeyFile /opt/spectro/ssl/server.key`. + + Save and exit the file. Next, restart the HTTP server to apply the changes. + + ```shell + systemctl restart httpd.service + ``` + +18. Start the {props.edition} installation binary, which uploads release-specific {props.edition} images and packs to the Harbor registry. Replace `` with the version of the binary received from the support team. + + ```shell + chmod +x airgap-.bin && ./airgap-.bin + ``` + + Consider the following example for reference. + + ```shell + chmod +x airgap-4-4-14.bin && ./airgap-4-4-14.bin + ``` + + This step may take some time to complete. A `Setup Completed` message confirms it is finished. + + ```text hideClipboard {8} + Verifying archive integrity... 100% MD5 checksums are OK. All good. + Uncompressing Airgap Setup - Version 4.4.14 100% + Setting up CLI + Setting up Manifests + Setting up Packs + ... + + Setup Completed + ``` + +19. Grant the Apache user and group the necessary permissions to serve the files in the `/var/www/html` directory. + + ```shell + chown -R apache.apache /var/www/html + ``` + + Restart the HTTP server to apply the changes. + + ```shell + systemctl restart httpd.service + ``` + +20. Review the page and identify any additional packs you want + to add to your 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, +review the [Next Steps](#next-steps). + +:::warning + +Do not power off the RHEL VM. The RHEL VM is required for {props.edition} to function properly and must +remain available at all times. If for some reason the VM is powered off, power the VM back on and restart +the required services. + +Switch to `sudo` mode and restart the file server. + +```shell +sudo --login +systemctl restart httpd +``` + +Next, navigate to the **/opt/spectro/harbor** directory and issue the following command to restart the registry. + +```shell +docker compose up --detach +``` + +::: + +## Validate + +1. SSH into the RHEL airgap VM as a root user with the command below. Replace `/path/to/private_key` with the path to + the private SSH key, `docs` with the username, and `palette.example.com` with the FQDN of the RHEL airgap VM. + + ```shell + ssh -i /path/to/private_key docs@palette.example.com + ``` + +2. Switch to the `root` user account. + + ```shell + sudo --login + ``` + +3. Issue the following command to validate that you have successfully completed the airgap setup process. Replace + `palette.example.com` with the FQDN of the RHEL airgap VM. + + ```shell + bin/airgap-setup.sh palette.example.com + ``` + + The output must include the registry location and credentials, which must be accessible from within your + environment. + + ```shell hideClipboard + Setting up SSL Certs + /opt/spectro/functions.sh: line 118: /etc/nginx/.htpasswd: No such file or directory + chmod: cannot access '/etc/nginx/.htpasswd': No such file or directory + mkdir: cannot create directory ‘/etc/nginx/ssl’: No such file or directory + cp: target '/etc/nginx/ssl' is not a directory + Setting up Harbor + setenforce is /usr/sbin/setenforce + Setup Completed + + Details: + ------- + Spectro Cloud Repository + Location: https://palette.example.com:8443 + UserName: spectro + Password: ************** + CA certificate filepath: /opt/spectro/ssl/server.crt + + Pack OCI Registry + Endpoint: https://palette.example.com + Base Content Path: spectro-packs + CA certificate Filepath: /opt/spectro/ssl/server.crt + Username: admin + Password: ************** + + Image OCI Registry + Endpoint: https://palette.example.comv + Base Content Path: spectro-images + CA certificate Filepath: /opt/spectro/ssl/server.crt + Username: admin + Password: ************** + ``` + +## Next Steps + +You are now ready to deploy {props.edition} in an airgapped environment with the Palette CLI. As a root user, issue the Palette CLI +command below to start the installation. + + ```shell + palette ec install + ``` + +Complete all the Palette CLI steps outlined in the guide from the RHEL VM. + +:::info + +The following table maps the airgap script output values to their respective Palette CLI prompts and example values. The +example values are for reference only. + +| Output Value | Palette CLI Prompt | Example Value | +| ------------------------------------- | ------------------------------------ | ------------------------------------------------------ | +| **Spectro Cloud Repository Location** | **SCAR Location** | `https://palette.example.com:8443` | +| **CA certificate filepath** | **SCAR CA certificate filepath** | `/opt/spectro/ssl/server.crt` | +| **OCI Registry** | **Registry Type** | `OCI` | +| **Pack OCI Registry** | **Registry Endpoint** | `https://palette.example.com` | +| **CA certificate Filepath** | **Registry CA certificate filepath** | `/opt/spectro/ssl/server.crt` | +| **Image OCI Registry** | **Registry Endpoint** | `https://palette.example.com` | +| **CA certificate Filepath** | **Registry CA certificate filepath** | `/opt/spectro/ssl/server.crt` | + +When prompted for **Allow Insecure Connection (Bypass x509 Verification)?**, enter `n` to continue and specify the +server certificate file path from the script output. + +::: \ No newline at end of file diff --git a/docs/docs-content/byoos/capi-image-builder/build-image-vmware/airgap-build/rhel-capi-airgap.md b/docs/docs-content/byoos/capi-image-builder/build-image-vmware/airgap-build/rhel-capi-airgap.md index 3c50c7f1b1..5b8599dddf 100644 --- a/docs/docs-content/byoos/capi-image-builder/build-image-vmware/airgap-build/rhel-capi-airgap.md +++ b/docs/docs-content/byoos/capi-image-builder/build-image-vmware/airgap-build/rhel-capi-airgap.md @@ -32,7 +32,7 @@ Enterprise Linux (RHEL) image with diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/environment-setup.md b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/environment-setup.md new file mode 100644 index 0000000000..52cc7bf117 --- /dev/null +++ b/docs/docs-content/enterprise-version/install-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/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md similarity index 87% rename from docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md rename to docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md index 1e2a55f884..26c4b6e0dc 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md @@ -1,7 +1,7 @@ --- -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 @@ -9,13 +9,14 @@ 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 - ``` + + + + + ```url + https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-1294-0.ova + ``` + + + - 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 + ``` + + + - 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/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md index 1ea84a061a..68625d67b3 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md +++ b/docs/docs-content/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/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/airgap-install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/airgap-install.md index af36199b16..8425dbf140 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/airgap-install.md +++ b/docs/docs-content/vertex/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) diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/env-setup-vm-vertex.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/env-setup-vm-vertex.md new file mode 100644 index 0000000000..88b492bb61 --- /dev/null +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/env-setup-vm-vertex.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 VerteX installation using an existing RHEL VM" +icon: "" +hide_table_of_contents: false +sidebar_position: 35 +tags: ["self-hosted", "vertex", "airgap", "vmware", "vsphere", "rhel"] +keywords: ["self-hosted", "vertex"] +--- + +This guide helps you prepare your VMware vSphere airgap environment for VerteX 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 VerteX images and assists in starting the VerteX installation. + +:::info + +This guide is for preparing your airgap environment only. For instructions on installing VerteX on VMware, refer to the +[Install VerteX](../install.md) guide. + +::: + +## Limitations + +- Currently, `9.4` is the only supported RHEL version. + +import SetupSteps from "../../../../../../../_partials/self-hosted/_setup-steps.mdx"; + + diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/environment-setup.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/environment-setup.md new file mode 100644 index 0000000000..2393dd35c2 --- /dev/null +++ b/docs/docs-content/vertex/install-palette-vertex/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 VerteX installation." +icon: "" +hide_table_of_contents: false +sidebar_position: 20 +tags: ["self-hosted", "vertex", "airgap", "vmware", "vsphere"] +keywords: ["self-hosted", "vertex"] +--- + +This section helps you prepare your VMware vSphere airgap environment for VerteX 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-vertex.md) guide to learn how to prepare this VM for + VerteX 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 VerteX installation process. + +## Resources + +- [Environment Setup with an Existing RHEL VM](./env-setup-vm-vertex.md) + +- [Environment Setup with OVA](./vmware-vsphere-airgap-instructions.md) diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md similarity index 92% rename from docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md rename to docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md index 4e9492d121..cf4b96d941 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md @@ -1,7 +1,7 @@ --- -sidebar_label: "Environment Setup" -title: "Environment Setup" -description: "Learn how to install VerteX in an air gap environment." +sidebar_label: "Environment Setup with OVA" +title: "Environment Setup with OVA" +description: "Learn how to install VerteX in an airgap environment." icon: "" hide_table_of_contents: false sidebar_position: 20 @@ -9,13 +9,14 @@ tags: ["vertex", "enterprise", "airgap", "vmware", "vsphere"] keywords: ["self-hosted", "vertex"] --- -This guide helps you to prepare your airgap environment for Palette VerteX installation. +This guide helps you to prepare your airgap environment for VerteX 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 VerteX on VMware, check the [Install](../install.md) guide. A checklist of the steps you will complete to prepare your airgap environment for VerteX -is available on the [Checklist](./checklist.md) page. +is available on the [Checklist](../checklist.md) page. ::: @@ -50,10 +51,10 @@ VerteX. - 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](../vmware-system-requirements.md) and ensure you've created the proper +- Review the required vSphere [permissions](../../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](../vmware-system-requirements.md#zone-tagging) for - information. + workloads that require persistent storage. Refer to [Zone Tagging](../../vmware-system-requirements.md#zone-tagging) + for information.
@@ -62,7 +63,7 @@ VerteX. Self-hosted VerteX 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 VerteX. 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. ::: @@ -88,16 +89,30 @@ 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-12711-0.ova - ``` + + + + + ```url + https://vmwaregoldenimage-console.s3.amazonaws.com/u-2204-0-k-1294-0.ova + ``` + + + + + ```url + https://vmwaregoldenimage-console.s3.amazonaws.com/u-2004-0-k-1294-fips.ova + ``` + + + 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-12711-0`. This + 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) page for a list of additional OS OVAs. + [Supplement Packs](../../../airgap/supplemental-packs.md) page for a list of additional OS OVAs. 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) @@ -357,7 +372,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 VerteX airgap installation binary. ```shell @@ -387,8 +402,8 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock Once the Palette VerteX 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, @@ -465,7 +480,7 @@ installed in the airgap support VM and ready to use. palette ec install ``` -Complete all the Palette CLI steps outlined in the [Install VerteX](./install.md) guide from the airgap support VM. +Complete all the Palette CLI steps outlined in the [Install VerteX](../install.md) guide from the airgap support VM. :::info diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md index 04a4b3682c..bf208248b5 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md @@ -3,7 +3,7 @@ sidebar_label: "Install VerteX" title: "Install VerteX" description: "Learn how to install VerteX in an airgap VMware environment." icon: "" -sidebar_position: 30 +sidebar_position: 40 hide_table_of_contents: false tags: ["vertex", "enterprise", "airgap", "vmware", "vsphere"] keywords: ["self-hosted", "vertex"] @@ -16,7 +16,7 @@ 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. - You can choose between two Operating Systems (OS) when installing Vertex. Review the requirements for each OS. @@ -131,8 +131,8 @@ Use the following steps to install Palette VerteX. :::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 VerteX 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 VerteX airgap binary and moves the Palette CLI to the correct path. ::: @@ -162,10 +162,10 @@ Use the following steps to install Palette VerteX. :::info - If you are using the Palette CLI from inside an [airgap support VM](./vmware-vsphere-airgap-instructions.md), the - CLI will automatically detect the airgap environment and prompt you to **Use local, air-gapped Spectro Cloud - Artifact Repository (SCAR) configuration**. Type `y` to use the local resources and skip filling in the repository - URL and credentials. + If you are using the Palette CLI from inside an + [airgap support VM](./environment-setup/vmware-vsphere-airgap-instructions.md), the CLI will automatically detect + the airgap environment and prompt you to **Use local, air-gapped Spectro Cloud Artifact Repository (SCAR) + configuration**. Type `y` to use the local resources and skip filling in the repository URL and credentials. ::: @@ -191,9 +191,10 @@ Use the following steps to install Palette VerteX. | **Service IP Range** | Enter the IP address range that will be used to assign IP addresses to services in the EC cluster. The service IP addresses should be unique and not overlap with any machine IPs in the environment. | 11. Select the OCI registry type and provide the configuration values. Review the following table for more information. - If you are using the Palette CLI from inside an [airgap support VM](./vmware-vsphere-airgap-instructions.md), the - CLI will automatically detect the airgap environment and prompt you to **Use local, air-gapped Pack Registry?** Type - `y` to use the local resources and skip filling in the OCI registry URL and credentials. + If you are using the Palette CLI from inside an + [airgap support VM](./environment-setup/vmware-vsphere-airgap-instructions.md), the CLI will automatically detect + the airgap environment and prompt you to **Use local, air-gapped Pack Registry?** Type `y` to use the local + resources and skip filling in the OCI registry URL and credentials. :::warning @@ -222,10 +223,10 @@ Use the following steps to install Palette VerteX. | **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](./vmware-vsphere-airgap-instructions.md), 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. + for your image registry. If you are on an + [airgap support VM](./environment-setup/vmware-vsphere-airgap-instructions.md), 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 @@ -445,7 +446,7 @@ teams. ## Resources -- [Environment Setup](./vmware-vsphere-airgap-instructions.md) +- [Environment Setup](./environment-setup/vmware-vsphere-airgap-instructions.md) - [Create a Tenant](../../../system-management/tenant-management.md) diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md index c682fe9846..cda78a1f0e 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md @@ -417,7 +417,7 @@ teams. ## Resources -- [Airgap Instructions](./airgap-install/vmware-vsphere-airgap-instructions.md) +- [Airgap Instructions](./airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md) - [Create a Tenant](../../system-management/tenant-management.md) diff --git a/redirects.js b/redirects.js index 3cb2a16574..bcc04db47b 100644 --- a/redirects.js +++ b/redirects.js @@ -410,7 +410,7 @@ const redirects = [ }, { from: "/enterprise-version/install-palette/airgap/vmware-vsphere-airgap-instructions/", - to: "/enterprise-version/install-palette/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions/", + to: "/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions/", }, { from: "/vertex/install-palette-vertex/airgap/kubernetes-airgap-instructions/", @@ -418,7 +418,7 @@ const redirects = [ }, { from: "/vertex/install-palette-vertex/airgap/vmware-vsphere-airgap-instructions/", - to: "/vertex/install-palette-vertex/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions/", + to: "/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions/", }, { from: "/vertex/install-palette-vertex/airgap/checklist/", @@ -553,6 +553,14 @@ const redirects = [ from: "/automation/palette-cli/commands/validator/", to: "/automation/palette-cli/commands/ec/", }, + { + from: "/enterprise-version/install-palette/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions/", + to: "/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions/", + }, + { + from: "/vertex/install-palette-vertex/install-on-vmware/airgap-install/vmware-vsphere-airgap-instructions/", + to: "/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions/", + }, { from: "/legal-licenses/oss-licenses/", to: "/legal-licenses/oss-licenses-index/",