Skip to content

Commit

Permalink
docs: fix third-party references in self-hosted airgap guides (#5564)
Browse files Browse the repository at this point in the history
  • Loading branch information
caroldelwing committed Jan 27, 2025
1 parent a160409 commit ea5b9f4
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 38 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ installation. Review this checklist with your Palette support team to ensure you
- [ ] 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.
- [ ] Download the release 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,9 @@ Palette.

- The installation OVA that deploys and initializes the airgap support VM. The installation OVA can be either generic
or release-specific.
- If you are using a generic OVA, ensure you download the airgap Palette installation binary for the version of
Palette you plan to install.
- If you are using a generic OVA, ensure you download the airgap Palette release binary for the version of Palette you
plan to install. This binary contains the core packs and images required for the installation.
- 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.
Expand Down Expand Up @@ -320,24 +319,22 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
</TabItem>
</Tabs>
18. The output of the script contains credentials and values you will need when completing the installation with the
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.
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.
18. 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 start the airgap Palette release binary. The release 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
curl --user XXXXX:YYYYY https://software-private.spectrocloud.com/airgap/thirdparty/airgap-thirdparty-X.X.X.bin \
--output airgap-upload.bin
chmod +x airgap-<version>.bin && ./airgap-<version>.bin
```
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.
Consider the following example for reference.
```shell
chmod +x airgap-upload.bin && ./airgap-upload.bin
chmod +x airgap-v4.4.14.bin && ./airgap-v4.4.14.bin
```
```text hideClipboard
Expand All @@ -353,17 +350,17 @@ 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.
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.
19. 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
20. 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**.
21. 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
22. In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes
distribution OVA required for the installation. Refer to the
[Kubernetes Requirements](../../../install-palette/install-palette.md#kubernetes-requirements) section to learn if
the version of Palette you are installing requires a new OS and Kubernetes OVA.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ installation. Review this checklist with your VerteX support team to ensure you
- [ ] 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.
- [ ] Download the release 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,9 @@ VerteX.

- The installation OVA that deploys and initializes the airgap support VM. The installation OVA can be either generic
or release-specific.
- If you are using a generic OVA, ensure you download the airgap VerteX installation binary for the version of VerteX
you plan to install.
- If you are using a generic OVA, ensure you download the airgap VerteX release binary for the version of VerteX you
plan to install. This binary contains the core packs and images required for the installation.
- 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.
Expand Down Expand Up @@ -324,24 +323,22 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
</TabItem>
</Tabs>
18. The output of the script contains credentials and values you will need when completing the installation with the
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.
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.
18. 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 start the airgap VerteX release binary. The release 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
curl --user XXXXX:YYYYY https://software-private.spectrocloud.com/airgap/thirdparty/airgap-thirdparty-X.X.X.bin \
--output airgap-upload.bin
chmod +x airgap-vertex-<version>.bin && ./airgap-vertex-<version>.bin
```
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.
Consider the following example for reference.
```shell
chmod +x airgap-upload.bin && ./airgap-upload.bin
chmod +x airgap-vertex-v4.4.14.bin && ./airgap-vertex-v4.4.14.bin
```
```text hideClipboard
Expand All @@ -359,17 +356,17 @@ 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.
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.
19. 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
20. 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**.
21. 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
22. In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes
distribution OVA required for the installation. Refer to the
[Kubernetes Requirements](../../../install-palette-vertex/install-palette-vertex.md#kubernetes-requirements) section
to learn if the version of Palette you are installing requires a new OS and Kubernetes OVA.
Expand Down

0 comments on commit ea5b9f4

Please sign in to comment.