Skip to content

Commit

Permalink
docs: updated airgap diagrams (#2315)
Browse files Browse the repository at this point in the history
* docs: updated airgap diagrams

* Optimised images with calibre/image-actions

* docs: re-trigger CI

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
1 parent 7e84062 commit c0c920f
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,25 @@ following diagram outlines the major pre-install steps for an airgap installatio

![An architecture diagram outlining the five different install phases](/enterprise-version_air-gap-repo_overview-order-diagram.png)

1. Download the airgap setup binary from the support team. The airgap setup binary is a self-extracting archive that
contains the Palette platform manifests, images, and required packs. The airgap setup binary is a one-time use binary
for uploading Palette images and packs to your OCI registry. You will not use the airgap setup binary again after the
initial installation.
1. Download the airgap setup binary from the URL provided by the support team. The airgap setup binary is a
self-extracting archive that contains the Palette platform manifests, images, and required packs. The airgap setup
binary is a one-time use binary for uploading Palette images and packs to your OCI registry. You will not use the
airgap setup binary again after the initial installation. This step must be completed in an environment with internet
access.

2. Extract the manifest content from the airgap setup binary. The manifest content is hosted on a file server.
2. Move the airgap setup binary to the airgap environment. The airgap setup binary is used to extract the manifest
content and upload the required images and packs to your private OCI registry. Start the airgap setup binary in a
Linux Virtual Machine (VM).

3. Install Palette using the Palette CLI. The Palette CLI is used to install Palette into your vSphere environment.
3. The airgap script will push the required images and packs to your private OCI registry.

4. Configure your Palette environment.
4. Extract the manifest content from the airgap setup binary. The manifest content must be hosted on a web server that
is accessible from the airgap environment. You can use the same Linux VM from step 2 to host the manifest content or
use a different web server.

5. Install Palette using the Palette CLI or the Kubernetes Helm chart.

6. Configure your Palette environment.

## Get Started

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ keywords: ["self-hosted", "enterprise"]
![Overview diagram of the pre-install steps eager-load](/enterprise-version_air-gap-repo_overview-order-diagram-focus.png)

This guide provides instructions to prepare your airgap environment for a Palette installation by completing the
required preparatory steps 1 and 2 shown in the diagram. The respective installation guides for each platform cover the
remaining installation process.
required preparatory steps 1 through 4 shown in the diagram. The respective installation guides for each platform cover
the remaining installation process.

## Prepare Airgap Installation

Expand Down
23 changes: 16 additions & 7 deletions docs/docs-content/vertex/install-palette-vertex/airgap/airgap.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,25 @@ following diagram outlines the major pre-install steps for an airgap installatio

![An architecture diagram outlining the five different install phases](/enterprise-version_air-gap-repo_overview-order-diagram.png)

1. Download the airgap setup binary from the support team. The airgap setup binary is a self-extracting archive that
contains the Palette platform manifests, images, and required packs. The airgap setup binary is a one-time use binary
for uploading VerteX images and packs to your OCI registry. You will not use the airgap setup binary again after the
initial installation.
1. Download the airgap setup binary from the URL provided by the support team. The airgap setup binary is a
self-extracting archive that contains the Palette platform manifests, images, and required packs. The airgap setup
binary is a one-time use binary for uploading VerteX images and packs to your OCI registry. You will not use the
airgap setup binary again after the initial installation. This step must be completed in an environment with internet
access.

2. Extract the manifest content from the airgap setup binary. The manifest content is hosted on a file server.
2. Move the airgap setup binary to the airgap environment. The airgap setup binary is used to extract the manifest
content and upload the required images and packs to your private OCI registry. Start the airgap setup binary in a
Linux Virtual Machine (VM).

3. Install VerteX using the Palette CLI. The Palette CLI is used to install VerteX into your vSphere environment.
3. The airgap script will push the required images and packs to your private OCI registry.

4. Configure your VerteX environment.
4. Extract the manifest content from the airgap setup binary. The manifest content must be hosted on a web server that
is accessible from the airgap environment. You can use the same Linux VM from step 2 to host the manifest content or
use a different web server.

5. Install Palette using the Palette CLI or the Kubernetes Helm chart.

6. Configure your VerteX environment.

## Get Started

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ keywords: ["self-hosted", "vertex"]
![Overview diagram of the pre-install steps eager-load](/enterprise-version_air-gap-repo_overview-order-diagram-focus.png)

This guide provides instructions to prepare your airgap environment for a Palette VerteX installation by completing the
required preparatory steps 1 and 2 shown in the diagram. The respective installation guides for each platform cover the
remaining installation process.
required preparatory steps 1 through 4 shown in the diagram. The respective installation guides for each platform cover
the remaining installation process

## Prepare Airgap Installation

Expand Down Expand Up @@ -54,8 +54,6 @@ Each prerequisite is required for a successful installation.

- [Caddy](https://caddyserver.com/)

<br />

:::warning

Take the necessary steps to secure your file server and ensure it can automatically recover from a failure. The file
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c0c920f

Please sign in to comment.