diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/checklist.md b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/checklist.md index c3b2bbeb09..1fa6ffff19 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/checklist.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/checklist.md @@ -12,9 +12,10 @@ keywords: ["self-hosted", "enterprise"] --- Use the following checklist to ensure you have completed all the required steps before deploying the airgap Palette -installation. +installation. Review this checklist with your Palette support team to ensure you have all the required assets. -- [ ] Create a vSphere VM and Template folder named `spectro-templates`. +- [ ] Create a vSphere VM and Template folder named `spectro-templates`. You may choose a different name for the folder + if you prefer. - [ ] Import the Operating System and Kubernetes distribution OVA required for the installation and place the OVA in the `spectro-templates` folder. @@ -25,6 +26,9 @@ installation. - [ ] Review the list of [pack binaries](../../airgap/supplemental-packs.md) to download and upload to your OCI registry. + +- [ ] Download the required third-party binary that contains the core packs and images required for the installation. + - [ ] If you have custom SSL certificates you want to include, copy the custom SSL certificates, in base64 PEM format, to the support VM. The custom certificates must be placed in the **/opt/spectro/ssl** folder. Include the following files: diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/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 index 58cdbbdec6..b17556f0d9 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/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 @@ -34,6 +34,7 @@ Palette. - If you are using a generic OVA, ensure you download the airgap Palette installation binary for the version of Palette you plan to install. - An OVA with the operating system and Kubernetes distribution required for the Palette nodes. + - The third-party binary that contains the core packs and images required for the installation. For sensitive environments, you can download the OVAs to a system with internet access and then transfer them to your airgap environment. @@ -77,70 +78,24 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock 1. Log in to your vCenter environment. -2. Create a vSphere VM and Template folder named `spectro-templates`. Ensure you can access this folder with the user - account you plan to use when deploying the Palette 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 installation. Contact your support representative to learn if the version of - Palette you are installing requires a new OS and Kubernetes OVA. - - Consider the following example for reference. - - - - - - ```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 - [Supplement Packs](../../../airgap/supplemental-packs.md#additional-ovas) 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) - guide for more information about deploying an OVA in vCenter. - - :::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. - Click on **Next** to continue. +2. 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. Click on + **Next** to continue. ![View of the OVF deploy wizard](/vertex_airgap_vmware-vsphere-airgap-instructions_ovf-wizard.webp) -6. Assign a name to the virtual machine and select a target location. Click on **Next** to continue. +3. Assign a name to the virtual machine and select a target location. Click on **Next** to continue. -7. Select a compute resource and click on **Next** to continue. +4. Select a compute resource and click on **Next** to continue. -8. Review the details and click on **Ignore All** to dismiss any warning messages. The OVA contains a self-signed +5. Review the details and click on **Ignore All** to dismiss any warning messages. The OVA contains a self-signed certificate, which causes vSphere to issue a warning. Click on **Next** to continue. -9. Select the storage location and click on **Next** to continue. +6. Select the storage location and click on **Next** to continue. -10. Select the network and click on **Next** to continue. +7. Select the network and click on **Next** to continue. -11. The last step is to customize the template. Review the table below to learn more about each field. Click on **Next** +8. The last step is to customize the template. Review the table below to learn more about each field. Click on **Next** after you have completed the customization to continue. | Parameter | Description | Required | @@ -152,22 +107,22 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock | **Hostname** | Enter a fully qualified hostname for the airgap support VM. For example, `palette.example.com`. The default value is `ubuntuguest`. | Yes | | **Url to seed instance data from** | You can specify a URL to seed instance data from. You can leave this value empty. | No | -12. Review the details and click on **Finish** to deploy the airgap support VM. +9. Review the details and click on **Finish** to deploy the airgap support VM. -13. It takes a while for the airgap support VM to deploy, approximately 45 min or more depending on your internet +10. It takes a while for the airgap support VM to deploy, approximately 45 min or more depending on your internet connection. The download of the OVA takes up majority of the time. The image is over 30 GB and contains all the dependencies required to deploy a Palette. Once the deployment is complete, the airgap support VM is displayed in the vSphere inventory. The VM will be powered off. Power on the VM to continue. -14. SSH into the airgap support VM. Use the following command to SSH into the VM. Replace the IP address below with the +11. SSH into the airgap support VM. Use the following command to SSH into the VM. Replace the IP address below with the IP address or hostname of the airgap support VM. The default user account is `ubuntu`. Replace the path to the private SSH key and the IP address with the IP address or domain name of the airgap support VM. ```shell - ssh -identity_file /path/to/private/key ubuntu@palette.example.com + ssh -i /path/to/private/key ubuntu@palette.example.com ``` -15. Change the password for the `ubuntu` user account. You will be prompted to change the password the first time you +12. Change the password for the `ubuntu` user account. You will be prompted to change the password the first time you log in through SSH. The new password must meet the following requirements: - At least 14 characters long @@ -177,7 +132,7 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock - At least 1 number - At least 1 special character -16. Once you change the password, the SSH session will be terminated. SSH back into the airgap support VM with the new +13. Once you change the password, the SSH session will be terminated. SSH back into the airgap support VM with the new password. :::info @@ -192,7 +147,7 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock Connection to palette.example.com closed. ``` -17. If you want to assign a static IP address to the airgap support VM, you can do so now. Click on the box below to +14. If you want to assign a static IP address to the airgap support VM, you can do so now. Click on the box below to expand the instructions. Otherwise, proceed to the next step.
@@ -250,13 +205,13 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
-18. Switch to the `root` user account. You will need to use the `root` user account to complete the remaining steps. +15. Switch to the `root` user account. You will need to use the `root` user account to complete the remaining steps. ```shell sudo --login ``` -19. If you have custom SSL certificates you want to apply to the image and pack registry, and the Spectro Cloud +16. If you have custom SSL certificates you want to apply to the image and pack registry, and the Spectro Cloud Repository, copy the custom SSL certificates, in base64 PEM format, to the airgap support VM. If you do not provide a custom SSL certificate, the airgap setup process will generate a self-signed certificate for @@ -285,7 +240,7 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock - **server.crt** - **server.key** -20. Start the airgap initialization process by issuing the following command. The script requires the hostname or IP +17. Start the airgap initialization process by issuing the following command. The script requires the hostname or IP address of the airgap support VM. Choose the preferred method for your environment. Be aware that the script will generate a self-signed certificate for the value you provide. @@ -366,25 +321,26 @@ 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 +18. 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 used a generic - installation OVA, use the following command to execute the Palette airgap installation binary. +19. Next, download the third party binary. Your support representative will provide you with credentials to access the + third-party binary. Use the following command to download the third-party binary. Replace the `XXXXX` and `YYYYY` + placeholders with the credentials provided to you. Replace the `X.X` placeholder with the version of the third-party + binary you are downloading. Ask your support representative for the version of the third-party binary you need. ```shell - chmod +x airgap-.bin && ./airgap-.bin + curl --user XXXXX:YYYYY https://software-private.spectrocloud.com/airgap/thirdparty/airgap-thirdparty-X.X.X.bin \ + --output airgap-upload.bin ``` - Consider the following example for reference. +20. Use the following command to start the third-party binary. The third-party binary uploads the release-specific packs + and images to the registry configured in step **17** of this guide. This process may take some time to complete. ```shell - chmod +x airgap-v4.4.14.bin && ./airgap-v4.4.14.bin + chmod +x airgap-upload.bin && ./airgap-upload.bin ``` - After the Palette airgap installation binary is verified and uncompressed, it uploads the release-specific packs and - images to the registry configured in step **20** of this guide. This process may take some time to complete. - ```text hideClipboard Verifying archive integrity... 100% MD5 checksums are OK. All good. Uncompressing Airgap Setup - Version 4.4.14 100% @@ -398,9 +354,57 @@ 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 +21. 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. +22. Navigate back to the vSphere console and create a vSphere VM and Template folder named `spectro-templates`. Ensure + you can access this folder with the user account you plan to use when deploying the VerteX installation. You can + choose a different name for the folder if you prefer, but ensure you use the same name when the Palette CLI prompts + you for the folder name. + +23. Right-click on your cluster or resource group and select **Deploy OVF Template**. + +24. In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes + distribution OVA required for the installation. Contact your support representative to learn if the version of + Palette you are installing requires a new OS and Kubernetes OVA. + + Consider the following example for reference. + + + + + + ```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 or in the folder you created in step **21**. 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. + + 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 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. + +::: + 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, review the [Next Steps](#next-steps). 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 53f2933217..68a7ccada6 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 @@ -210,17 +210,18 @@ Use the following steps to install Palette. use the provided VMware credentials to retrieve information from your VMware vSphere environment and present options for you to select from. - | **Parameter** | **Description** | - | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | **Datacenter** | The installer retrieves the Datacenter automatically. | - | **Folder** | Select the folder that contains the VM instance. | - | **Cluster** | Select the cluster where you want to deploy Palette. | - | **Network** | Select the network where you want to deploy Palette. | - | **Resource Pool** | Select the resource pool where you want to deploy Palette. | - | **Datastore** | Select the datastore where you want to deploy Palette. | - | **Fault Domains** | Configure one or more fault domains by selecting values for these properties: Cluster, Network (with network connectivity), Resource Pool, and Storage Type (Datastore or VM Storage Policy). Note that when configuring the Network, if you are using a distributed switch, choose the network that contains the switch. | - | **NTP Servers** | You can provide a list of Network Time Protocol (NTP) servers. | - | **SSH Public Keys** | Provide any public SSH keys to access your Palette VMs. This option opens up your system's default text editor. Vi is the default text editor for most Linux distributions. To review basic vi commands, check out the [vi Commands](https://www.cs.colostate.edu/helpdocs/vi.html) reference. | + | **Parameter** | **Description** | + | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | **Datacenter** | The installer retrieves the Datacenter automatically. | + | **Folder** | Select the folder that contains the VM instance. | + | **Image Template Folder** | Select the folder that contains the CAPI image templates. | + | **Cluster** | Select the cluster where you want to deploy Palette. | + | **Network** | Select the network where you want to deploy Palette. | + | **Resource Pool** | Select the resource pool where you want to deploy Palette. | + | **Datastore** | Select the datastore where you want to deploy Palette. | + | **Fault Domains** | Configure one or more fault domains by selecting values for these properties: Cluster, Network (with network connectivity), Resource Pool, and Storage Type (Datastore or VM Storage Policy). Note that when configuring the Network, if you are using a distributed switch, choose the network that contains the switch. | + | **NTP Servers** | You can provide a list of Network Time Protocol (NTP) servers. | + | **SSH Public Keys** | Provide any public SSH keys to access your Palette VMs. This option opens up your system's default text editor. Vi is the default text editor for most Linux distributions. To review basic vi commands, check out the [vi Commands](https://www.cs.colostate.edu/helpdocs/vi.html) reference. | 12. Specify the IP pool configuration. The placement type can be Static or Dynamic Host Configuration Protocol (DHCP). Choosing static placement creates an IP pool from which VMs are assigned IP addresses. Choosing DHCP assigns IP diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md index 418a0fbd32..ecf6171ca7 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md @@ -182,17 +182,18 @@ Use the following steps to install Palette. use the provided VMware credentials to retrieve information from your VMware vSphere environment and present options for you to select from. - | **Parameter** | **Description** | - | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | **Datacenter** | The installer retrieves the Datacenter automatically. | - | **Folder** | Select the folder that contains the VM instance. | - | **Cluster** | Select the cluster where you want to deploy Palette. | - | **Network** | Select the network where you want to deploy Palette. | - | **Resource Pool** | Select the resource pool where you want to deploy Palette. | - | **Datastore** | Select the datastore where you want to deploy Palette. | - | **Fault Domains** | Configure one or more fault domains by selecting values for these properties: Cluster, Network (with network connectivity), Resource Pool, and Storage Type (Datastore or VM Storage Policy). Note that when configuring the Network, if you are using a distributed switch, choose the network that contains the switch. | - | **NTP Servers** | You can provide a list of Network Time Protocol (NTP) servers. | - | **SSH Public Keys** | Provide any public SSH keys to access your Palette VMs. This option opens up your system's default text editor. Vi is the default text editor for most Linux distributions. To review basic vi commands, check out the [vi Commands](https://www.cs.colostate.edu/helpdocs/vi.html) reference. | + | **Parameter** | **Description** | + | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | **Datacenter** | The installer retrieves the Datacenter automatically. | + | **Folder** | Select the folder that contains the VM instance. | + | **Image Template Folder** | Select the folder that contains the CAPI image templates. | + | **Cluster** | Select the cluster where you want to deploy Palette. | + | **Network** | Select the network where you want to deploy Palette. | + | **Resource Pool** | Select the resource pool where you want to deploy Palette. | + | **Datastore** | Select the datastore where you want to deploy Palette. | + | **Fault Domains** | Configure one or more fault domains by selecting values for these properties: Cluster, Network (with network connectivity), Resource Pool, and Storage Type (Datastore or VM Storage Policy). Note that when configuring the Network, if you are using a distributed switch, choose the network that contains the switch. | + | **NTP Servers** | You can provide a list of Network Time Protocol (NTP) servers. | + | **SSH Public Keys** | Provide any public SSH keys to access your Palette VMs. This option opens up your system's default text editor. Vi is the default text editor for most Linux distributions. To review basic vi commands, check out the [vi Commands](https://www.cs.colostate.edu/helpdocs/vi.html) reference. | 15. Specify the IP pool configuration. The placement type can be Static or Dynamic Host Configuration Protocol (DHCP). Choosing static placement creates an IP pool from which VMs are assigned IP addresses. Choosing DHCP assigns IP diff --git a/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/airgap.md b/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/airgap.md index b11913a241..b16d257b91 100644 --- a/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/airgap.md +++ b/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/airgap.md @@ -90,13 +90,13 @@ steps one through four. Otherwise, start at step five. your private SSH key, your username, and the IP or domain of the airgap support VM. The default username is `ubuntu`. ```shell - ssh -identity_file ubuntu@ + ssh -i ubuntu@ ``` Consider the following command example for reference. ```shell - ssh -identity_file /docs/ssh-private-key.pem ubuntu@palette.example.com + ssh -i /docs/ssh-private-key.pem ubuntu@palette.example.com ``` 6. Use the following command to switch to the `root` user account, which you need to proceed with the upgrade. diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/checklist.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/checklist.md index 9aec39d3fe..7709c90f86 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/checklist.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/checklist.md @@ -12,7 +12,7 @@ keywords: ["self-hosted", "enterprise"] --- Use the following checklist to ensure you have completed all the required steps before deploying the airgap Palette -installation. +installation. Review this checklist with your VerteX support team to ensure you have all the required assets. - [ ] Create a vSphere VM and Template folder named `spectro-templates`. @@ -34,6 +34,8 @@ installation. - [ ] Review the list of [pack binaries](../../airgap/supplemental-packs.md) to download and upload to your OCI registry. +- [ ] Download the required third-party binary that contains the core packs and images required for the installation. + - [ ] If you have custom SSL certificates you want to include, copy the custom SSL certificates, in base64 PEM format, to the support VM. The custom certificates must be placed in the **/opt/spectro/ssl** folder. Include the following files: diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/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 index 965a573ae8..bb350eefcb 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/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 @@ -34,6 +34,7 @@ VerteX. - If you are using a generic OVA, ensure you download the airgap VerteX installation binary for the version of VerteX you plan to install. - An OVA with the operating system and Kubernetes distribution required for the VerteX nodes. + - The third-party binary that contains the core packs and images required for the installation. For sensitive environments, you can download the OVAs to a system with internet access and then transfer them to your airgap environment. @@ -81,71 +82,24 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock 1. Log in to your vCenter environment. -2. Create a vSphere VM and Template folder named `spectro-templates`. Ensure you can access this folder with the user - account you plan to use when deploying the VerteX 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 installation. Contact your support representative to learn if the version of - VerteX you are installing requires a new OS and Kubernetes OVA. - - Consider the following example for reference. - - - - - - ```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 - [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) - guide for more information about deploying an OVA in vCenter. - - :::warning - - You may encounter an error message during the OVA deployment stating unable to retrieve manifest or certificate. - This is a known issue that was fixed in the - [VMware vCenter Server 7.0 Update 3q](https://docs.vmware.com/en/VMware-vSphere/7.0/rn/vsphere-vcenter-server-70u3q-release-notes/index.html). - Reach out to [Broadcom Support](https://support.broadcom.com) if you need further guidance. - - ::: - -5. Next, deploy the airgap installation OVA by using the **Deploy OVF Template** wizard again in vSphere. Insert the - VerteX install OVA URL in the **URL** field. The URL is provided to you by your Palette support representative. - Click on **Next** to continue. +2. Deploy the airgap installation OVA by using the **Deploy OVF Template** wizard again in vSphere. Insert the VerteX + install OVA URL in the **URL** field. The URL is provided to you by your Palette support representative. Click on + **Next** to continue. ![View of the OVF deploy wizard](/vertex_airgap_vmware-vsphere-airgap-instructions_ovf-wizard.webp) -6. Assign a name to the virtual machine and select a target location. Click on **Next** to continue. +3. Assign a name to the virtual machine and select a target location. Click on **Next** to continue. -7. Select a compute resource and click on **Next** to continue. +4. Select a compute resource and click on **Next** to continue. -8. Review the details and click on **Ignore All** to dismiss any warning messages. The OVA contains a self-signed +5. Review the details and click on **Ignore All** to dismiss any warning messages. The OVA contains a self-signed certificate, which causes vSphere to issue a warning. Click on **Next** to continue. -9. Select the storage location and click on **Next** to continue. +6. Select the storage location and click on **Next** to continue. -10. Select the network and click on **Next** to continue. +7. Select the network and click on **Next** to continue. -11. The last step is to customize the template. Review the table below to learn more about each field. Click on **Next** +8. The last step is to customize the template. Review the table below to learn more about each field. Click on **Next** after you have completed the customization to continue. | Parameter | Description | Required | @@ -157,22 +111,22 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock | **Hostname** | Enter a fully qualified hostname for the airgap support VM. For example, `vertex.example.com`. The default value is `ubuntuguest`. | Yes | | **Url to seed instance data from** | You can specify a URL to seed instance data from. You can leave this value empty. | No | -12. Review the details and click on **Finish** to deploy the airgap support VM. +9. Review the details and click on **Finish** to deploy the airgap support VM. -13. It takes a while for the airgap support VM to deploy, approximately 45 min or more depending on your internet +10. It takes a while for the airgap support VM to deploy, approximately 45 min or more depending on your internet connection. The download of the OVA takes up majority of the time. The image is over 30 GB and contains all the dependencies required to deploy a VerteX. Once the deployment is complete, the airgap support VM is displayed in the vSphere inventory. The VM will be powered off. Power on the VM to continue. -14. SSH into the airgap support VM. Use the following command to SSH into the VM. Replace the IP address below with the +11. SSH into the airgap support VM. Use the following command to SSH into the VM. Replace the IP address below with the IP address or hostname of the airgap support VM. The default user account is `ubuntu`. Replace the path to the private SSH key and the IP address with the IP address or domain name of the airgap support VM. ```shell - ssh -identity_file /path/to/private/key ubuntu@vertex.example.com + ssh -i /path/to/private/key ubuntu@vertex.example.com ``` -15. Change the password for the `ubuntu` user account. You will be prompted to change the password the first time you +12. Change the password for the `ubuntu` user account. You will be prompted to change the password the first time you log in through SSH. The new password must meet the following requirements: - At least 14 characters long @@ -182,7 +136,7 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock - At least 1 number - At least 1 special character -16. Once you change the password, the SSH session will be terminated. SSH back into the airgap support VM with the new +13. Once you change the password, the SSH session will be terminated. SSH back into the airgap support VM with the new password. :::info @@ -197,7 +151,7 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock Connection to vertex.example.com closed. ``` -17. If you want to assign a static IP address to the airgap support VM, you can do so now. Click on the box below to +14. If you want to assign a static IP address to the airgap support VM, you can do so now. Click on the box below to expand the instructions. Otherwise, proceed to the next step.
@@ -255,13 +209,13 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
-18. Switch to the `root` user account. You will need to use the `root` user account to complete the remaining steps. +15. Switch to the `root` user account. You will need to use the `root` user account to complete the remaining steps. ```shell sudo --login ``` -19. If you have custom SSL certificates you want to apply to the image and pack registry, and the Spectro Cloud +16. If you have custom SSL certificates you want to apply to the image and pack registry, and the Spectro Cloud Repository, copy the custom SSL certificates, in base64 PEM format, to the airgap support VM. If you do not provide a custom SSL certificate, the airgap setup process will generate a self-signed certificate for @@ -290,7 +244,7 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock - **server.crt** - **server.key** -20. Start the airgap initialization process by issuing the following command. The script requires the hostname or IP +17. Start the airgap initialization process by issuing the following command. The script requires the hostname or IP address of the airgap support VM. Choose the preferred method for your environment. Be aware that the script will generate a self-signed certificate for the value you provide. @@ -371,26 +325,26 @@ 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 +18. 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 used a generic - installation OVA, use the following command to execute the Palette VerteX airgap installation binary. +19. Next, download the third party binary. Your support representative will provide you with credentials to access the + third-party binary. Use the following command to download the third-party binary. Replace the `XXXXX` and `YYYYY` + placeholders with the credentials provided to you. Replace the `X.X` placeholder with the version of the third-party + binary you are downloading. Ask your support representative for the version of the third-party binary you need. ```shell - chmod +x airgap-vertex-.bin && ./airgap-vertex-.bin + curl --user XXXXX:YYYYY https://software-private.spectrocloud.com/airgap/thirdparty/airgap-thirdparty-X.X.X.bin \ + --output airgap-upload.bin ``` - Consider the following example for reference. +20. Use the following command to start the third-party binary. The third-party binary uploads the release-specific packs + and images to the registry configured in step **17** of this guide. This process may take some time to complete. ```shell - chmod +x airgap-vertex-v4.4.14.bin && ./airgap-vertex-v4.4.14.bin + chmod +x airgap-upload.bin && ./airgap-upload.bin ``` - After the Palette VerteX airgap installation binary is verified and uncompressed, it uploads the release-specific - packs and images to the registry configured in step **20** of this guide. This process may take some time to - complete. - ```text hideClipboard Verifying archive integrity... 100% MD5 checksums are OK. All good. Uncompressing Airgap Setup - Version 4.4.14 100% @@ -402,11 +356,63 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock Setup Completed ``` + Once the airgap binary completes its tasks, you will receive a **Setup Completed** success message. + 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 +21. 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. +22. Navigate back to the vSphere console and create a vSphere VM and Template folder named `spectro-templates`. Ensure + you can access this folder with the user account you plan to use when deploying the VerteX installation. You can + choose a different name for the folder if you prefer, but ensure you use the same name when the Palette CLI prompts + you for the folder name. + +23. Next, right-click on your cluster or resource group and select **Deploy OVF Template**. + +24. In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes + distribution OVA required for the installation. Contact your support representative to learn if the version of + VerteX you are installing requires a new OS and Kubernetes OVA. + + Consider the following example for reference. + + + + + + ```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 or in the folder you created in step **21**. 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) 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) + guide for more information about deploying an OVA in vCenter. + + :::warning + + You may encounter an error message during the OVA deployment stating unable to retrieve manifest or certificate. + This is a known issue that was fixed in the + [VMware vCenter Server 7.0 Update 3q](https://docs.vmware.com/en/VMware-vSphere/7.0/rn/vsphere-vcenter-server-70u3q-release-notes/index.html). + Reach out to [Broadcom Support](https://support.broadcom.com) if you need further guidance. + + ::: + 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, review the [Next Steps](#next-steps). 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 bf208248b5..59e4985513 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 @@ -257,6 +257,7 @@ Use the following steps to install Palette VerteX. | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Datacenter** | The installer retrieves the Datacenter automatically. | | **Folder** | Select the folder that contains the VM instance. | + | **Image Template Folder** | Select the folder that contains the CAPI image templates. | | **Cluster** | Select the cluster where you want to deploy Palette. | | **Network** | Select the network where you want to deploy Palette. | | **Resource Pool** | Select the resource pool where you want to deploy Palette. | 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 3a6307ac58..efa2f4f12c 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 @@ -228,6 +228,7 @@ Use the following steps to install Palette VerteX. | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Datacenter** | The installer retrieves the Datacenter automatically. | | **Folder** | Select the folder that contains the VM instance. | + | **Image Template Folder** | Select the folder that contains the CAPI image templates. | | **Cluster** | Select the cluster where you want to deploy Palette. | | **Network** | Select the network where you want to deploy Palette. | | **Resource Pool** | Select the resource pool where you want to deploy Palette. | diff --git a/docs/docs-content/vertex/upgrade/upgrade-vmware/airgap.md b/docs/docs-content/vertex/upgrade/upgrade-vmware/airgap.md index 98b61d261a..70d0f41b78 100644 --- a/docs/docs-content/vertex/upgrade/upgrade-vmware/airgap.md +++ b/docs/docs-content/vertex/upgrade/upgrade-vmware/airgap.md @@ -92,13 +92,13 @@ one through four. Otherwise, start at step five. `ubuntu`. ```shell - ssh -identity_file ubuntu@ + ssh -i ubuntu@ ``` Consider the following command example for reference. ```shell - ssh -identity_file /docs/ssh-private-key.pem ubuntu@palette.example.com + ssh -i /docs/ssh-private-key.pem ubuntu@palette.example.com ``` 6. Use the following command to switch to the `root` user account, which you need to proceed with the upgrade. diff --git a/docs/docs-content/vm-management/install-vmo-in-airgap.md b/docs/docs-content/vm-management/install-vmo-in-airgap.md index 6b6a5fe68a..2334a3f233 100644 --- a/docs/docs-content/vm-management/install-vmo-in-airgap.md +++ b/docs/docs-content/vm-management/install-vmo-in-airgap.md @@ -39,13 +39,13 @@ instance of Palette and Palette VerteX. your private SSH key, username, and the IP or domain of the airgap support VM. The default username is `ubuntu`. ```shell - ssh -identity_file @ + ssh -i @ ``` Consider the following command example for reference. ```shell - ssh -identity_file /docs/ssh-private-key.pem ubuntu@palette.example.com + ssh -i /docs/ssh-private-key.pem ubuntu@palette.example.com ``` 2. Execute the following command to switch to the `root` user account. diff --git a/static/assets/docs/images/vertex_airgap_vmware-vsphere-airgap-instructions_order-operations.webp b/static/assets/docs/images/vertex_airgap_vmware-vsphere-airgap-instructions_order-operations.webp index 4ce705efad..ef490276fb 100644 Binary files a/static/assets/docs/images/vertex_airgap_vmware-vsphere-airgap-instructions_order-operations.webp and b/static/assets/docs/images/vertex_airgap_vmware-vsphere-airgap-instructions_order-operations.webp differ