-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* docs: refactor for self-hosted Palette DOC-465 * docs: updated palette content * docs: added VMware install docs * docs: image updates and deprecation * chore: gitleaks and FRPS clean-up * docs: refactor and condensed pages * docs: updated headings * chore: rebased * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * Optimised images with calibre/image-actions * docs: feedback incoporated * docs: minor language touchup * docs: touche dup the system requirements document * docs: fixed bold * docs: updated VerteX permissions page * docs: updated VerteX * chore: addresses DOC-886 * docs: feedback incorporated * docs: fixed a sentence * docs: airgap document start * docs: documented prereqs * save * save * save * docs: added more steps * chore: doc updaters * docs: save * docs: created tape file * docs: updated Kubernetes instructions * docs: testing no-line numbers * docs: remove lineNumbers * docs: airgap install * docs: update VMware steps * docs: update palette install VMware * docs: updated Palette tapes and recording * docs: updated VerteX airgap docs for k8s * docs: updated airgap videos * doc: vertex VMware pre-work * docs: updated VerteX docs * docs: updated VerteX and Palette docs * save * docs: vale feedback * docs: more vale feedback * docs: more minor vale feedback * docs: added link to enterprise install * Optimised images with calibre/image-actions * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * docs: last set of feedback --------- Co-authored-by: Rita Watson <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> (cherry picked from commit adc39eb) Co-authored-by: Karl Cardenas <[email protected]>
- Loading branch information
1 parent
2ea247b
commit 6223938
Showing
46 changed files
with
3,964 additions
and
1,875 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
docs/docs-content/enterprise-version/install-palette/airgap/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "position": 30 | ||
| } | ||
|
|
76 changes: 76 additions & 0 deletions
76
docs/docs-content/enterprise-version/install-palette/airgap/airgap.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| --- | ||
| sidebar_label: "Airgap" | ||
| title: "Airgap" | ||
| description: "Learn about Palette in an airgap environment and how to install Palette in an airgap environment." | ||
| icon: "" | ||
| sidebar_position: 10 | ||
| hide_table_of_contents: false | ||
| tags: ["palette", "self-hosted", "airgap"] | ||
| --- | ||
|
|
||
|
|
||
| You can install Palette in an airgapped environment. An airgap environment lacks direct access to the internet and is intended for environments with strict security requirements. | ||
|
|
||
| The installation process for an airgap environment is different due to the lack of internet access. Before the primary Palette installation steps, you must download the following artifacts. | ||
|
|
||
| * Palette platform manifests and required platform packages. | ||
|
|
||
|
|
||
| * Container images for core platform components and third-party dependencies. | ||
|
|
||
|
|
||
| * Palette packs. | ||
|
|
||
|
|
||
| The other significant change is that Palette's default public OCI registry is not used. Instead, a private OCI registry is utilized for storing images and packs. | ||
|
|
||
|
|
||
|
|
||
| ## Overview | ||
| Before you can install Palette in an airgap environment, you must complete all the required pre-install steps. | ||
| The following diagram outlines the major pre-install steps for an airgap installation. | ||
|
|
||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
| 2. Extract the manifest content from the airgap setup binary. The manifest content is hosted on a file server. | ||
|
|
||
| 3. Install Palette using the Palette CLI. The Palette CLI is used to install Palette into your vSphere environment. | ||
|
|
||
| 4. Configure your Palette environment. | ||
|
|
||
|
|
||
| ## Get Started | ||
|
|
||
| To get started with an airgap Palette installation, check out the respective platform guide. | ||
|
|
||
| - [Kubernetes Airgap Instructions](kubernetes-airgap-instructions.md) | ||
|
|
||
| - [VMware vSphere Airgap Instructions](vmware-vsphere-airgap-instructions.md) | ||
|
|
||
|
|
||
| Each platform guide provides detailed instructions on how to complete the pre-install steps. We also recommend you review the [Checklist](checklist.md) to ensure you have completed all the required steps before deploying the airgap Palette installation. | ||
|
|
||
|
|
||
| ## Supported Platforms | ||
|
|
||
|
|
||
| | **Platform** | **OCI Registry** | **Supported**| | ||
| | ------------- | ------------ | -----| | ||
| | Kubernetes | Harbor | ✅ | | ||
| | Kubernetes | AWS ECR | ✅ | | ||
| | VMware vSphere | Harbor | ✅ | | ||
| | VMware vSphere | AWS ECR | ✅ | | ||
|
|
||
|
|
||
| ## Resources | ||
|
|
||
| - [Kubernetes Airgap Instructions](kubernetes-airgap-instructions.md) | ||
|
|
||
| - [VMware vSphere Airgap Instructions](vmware-vsphere-airgap-instructions.md) | ||
|
|
||
| - [Checklist](checklist.md) | ||
|
|
||
| - [Additional Packs](supplemental-packs.md) |
81 changes: 81 additions & 0 deletions
81
docs/docs-content/enterprise-version/install-palette/airgap/checklist.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| --- | ||
| sidebar_label: "Checklist" | ||
| title: "Checklist" | ||
| description: "An airgap installation of Palette requires a few steps to be completed before the installation can begin. This checklist will help you prepare for the installation." | ||
| icon: "" | ||
| sidebar_position: 40 | ||
| hide_table_of_contents: false | ||
| tags: ["palette", "self-hosted", "airgap"] | ||
| --- | ||
|
|
||
|
|
||
| Use the following checklist to ensure you have completed all the required steps before deploying the airgap Palette installation. | ||
|
|
||
| <Tabs queryString="platform"> | ||
|
|
||
| <TabItem label="Kubernetes" value="k8s"> | ||
|
|
||
| - [ ] `oras` CLI v1.1.0 or greater is installed and available. | ||
|
|
||
| - [ ] `aws` CLI v2 or greater CLI is installed and available. | ||
|
|
||
| - [ ] `zip` is installed and available. | ||
|
|
||
| - [ ] Downloaded the airgap setup binary from the support team. | ||
|
|
||
| - [ ] Created a private repository with the name `spectro-packs` in your OCI registry. You can use a different name if you prefer. | ||
|
|
||
| - [ ] Created a public repository with the name `spectro-images` in your OCI registry. You can use a different name if you prefer. | ||
|
|
||
| - [ ] Authenticated with your OCI registry and acquired credentials to both repositories. | ||
|
|
||
| - [ ] Set the required environment variables for the airgap setup binary. The values are different depending on what type of OCI registry you use. | ||
|
|
||
| - [ ] Started the airgap setup binary and verified the setup completed successfully. | ||
|
|
||
| - [ ] Reviewed the list of pack binaries to download and upload to your OCI registry. | ||
|
|
||
| - [ ] Extracted the manifest content from the airgap setup binary to an HTTP file server. | ||
|
|
||
| - [ ] Ensured the manifest content is hosted on an HTTP file server that is accessible from the environment you are installing Palette. | ||
|
|
||
| </TabItem> | ||
|
|
||
|
|
||
|
|
||
| <TabItem label="VMware vSphere" value="vsphere"> | ||
|
|
||
| - [ ] `oras` CLI v1.1.0 or greater is installed and available. | ||
|
|
||
| - [ ] `aws` CLI v2 or greater CLI is installed and available. | ||
|
|
||
| - [ ] `zip` is installed and available. | ||
|
|
||
| - [ ] Downloaded the airgap setup binary from the support team. | ||
|
|
||
| - [ ] Created a vSphere VM and Template folder with the name `spectro-templates`. | ||
|
|
||
| - [ ] Imported the Operating System and Kubernetes distribution OVA required for the install and placed the OVA in the `spectro-templates` folder. | ||
|
|
||
| - [ ] Appended an `r_` prefix to the OVA name after the import. | ||
|
|
||
| - [ ] Created a private repository with the name `spectro-packs` in your OCI registry. You can use a different name if you prefer. | ||
|
|
||
| - [ ] Created a public repository with the name `spectro-images` in your OCI registry. You can use a different name if you prefer. | ||
|
|
||
| - [ ] Authenticated with your OCI registry and acquired credentials to both repositories. | ||
|
|
||
| - [ ] Set the required environment variables for the airgap setup binary. Refer to step 8 in the [Preparation](#preperation) section for information. | ||
|
|
||
| - [ ] Started the airgap setup binary and verified the setup completed successfully | ||
|
|
||
| - [ ] Reviewed the list of pack binaries to download and upload to your OCI registry. | ||
|
|
||
| - [ ] Extracted the manifest content from the airgap setup binary to an HTTP file server. | ||
|
|
||
| - [ ] Ensured the manifest content is hosted on an HTTP file server that is accessible from the vSphere environment you are installing Palette. | ||
|
|
||
| </TabItem> | ||
|
|
||
|
|
||
| </Tabs> |
Oops, something went wrong.