Skip to content

Commit

Permalink
docs: restructure folders
Browse files Browse the repository at this point in the history
  • Loading branch information
caroldelwing committed Sep 16, 2024
1 parent 172eba2 commit f901b52
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ for hosting Palette images and also assists in starting the Palette installation
:::info

This guide is for preparing your airgap environment only. For instructions on installing Palette on VMware, refer to the
[Install Palette](./install.md) guide.
[Install Palette](../install.md) guide.

:::

Expand Down
Original file line number Diff line number Diff line change
@@ -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. There are two ways 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 a 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 a airgap support VM in your VMware vSphere environment, which will
assist with the Palette installation.

## Resources

- [Environment Setup with OVA](./vmware-vsphere-airgap-instructions.md)

- [Environment Setup with an Existing RHEL VM](./env-setup-vm.md)
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +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 using an OVA to deploy and initialize
an airgap support VM.
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 in the [Checklist](./checklist.md) page.
[Install](../install.md) guide. A checklist of the steps you will complete to prepare your airgap environment for
Palette is available in the [Checklist](../checklist.md) page.

:::

Expand Down Expand Up @@ -49,17 +49,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.

:::

Expand Down Expand Up @@ -90,7 +90,7 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
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.
[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)
Expand Down Expand Up @@ -350,8 +350,8 @@ 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. Review the [Additional Packs](../../airgap/supplemental-packs.md) page and identify any additional packs you want to
add to your OCI registry. By default, the installation includes only the minimum required packs. You can also add
22. Review the [Additional Packs](../../../airgap/supplemental-packs.md) page and identify any additional packs you want
to add to your OCI registry. By default, the installation includes only the minimum required packs. 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
Expand Down Expand Up @@ -429,7 +429,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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ and assets.

:::warning

Complete the [Environment Setup](./vmware-vsphere-airgap-instructions.md) steps before proceeding with the installation.
Complete the [Environment Setup](./environment-setup/vmware-vsphere-airgap-instructions.md) steps before proceeding with
the installation.

:::

Expand Down

0 comments on commit f901b52

Please sign in to comment.