From 4246218f69a5633d9c35188c8b9d8c1423402a92 Mon Sep 17 00:00:00 2001 From: addetz <43963729+addetz@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:15:44 +0000 Subject: [PATCH 1/4] docs: adjust VMO profile guidance for Spectro Proxy and Snapshot Controller packs --- docs/docs-content/vm-management/architecture.md | 12 +++--------- .../docs-content/vm-management/create-vmo-profile.md | 9 +++++++++ .../vm-management/install-vmo-in-airgap.md | 3 ++- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/docs-content/vm-management/architecture.md b/docs/docs-content/vm-management/architecture.md index 7b6853964e..f6ca8c0c80 100644 --- a/docs/docs-content/vm-management/architecture.md +++ b/docs/docs-content/vm-management/architecture.md @@ -31,15 +31,9 @@ By default, Palette VMO includes the following components: :::info Palette installs a snapshot controller into every cluster where backups are scheduled or have been created on-demand - in the past. To prevent resource conflicts, you can disable the VMO snapshot controller in the pack YAML - configuration. - - ```yaml - charts: - virtual-machine-orchestrator: - snapshot-controller: - enabled: false - ``` + in the past. To prevent resource conflicts, ensure that the + pack + is uninstalled before configuring VMO. ::: diff --git a/docs/docs-content/vm-management/create-vmo-profile.md b/docs/docs-content/vm-management/create-vmo-profile.md index b62669f279..6b2101e873 100644 --- a/docs/docs-content/vm-management/create-vmo-profile.md +++ b/docs/docs-content/vm-management/create-vmo-profile.md @@ -24,6 +24,10 @@ profile configuration. To learn about pack components, refer to [Palette VMO](./ kubectl delete pods --selector app=spectro-proxy --all-namespaces ``` +- Ensure the cluster that you are using with the Virtual Machine Orchestrator pack does not have the + pack + already installed. The Virtual Machine Orchestrator will configure snapshots. + ## Prerequisites @@ -49,6 +53,9 @@ profile configuration. To learn about pack components, refer to [Palette VMO](./ - Ensure the VMO pack is installed in your airgap environment. Refer to the [Install VMO in Airgap Environments](./install-vmo-in-airgap.md) guide for further information. +- Ensure the Spectro Proxy pack is installed in your airgap environment. Refer to the + [Install VMO in Airgap Environments](./install-vmo-in-airgap.md) guide for further information. + @@ -209,6 +216,8 @@ profile configuration. To learn about pack components, refer to [Palette VMO](./ more. The **Direct** option is intended for a private configuration where a proxy is not implemented or not desired. + Ensure that configure the pack + separately in your cluster profile if you select this option. :::warning 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 2334a3f233..dd688d1461 100644 --- a/docs/docs-content/vm-management/install-vmo-in-airgap.md +++ b/docs/docs-content/vm-management/install-vmo-in-airgap.md @@ -55,7 +55,8 @@ instance of Palette and Palette VerteX. ``` 3. Refer to the [Palette Additional Packs](../enterprise-version/install-palette/airgap/supplemental-packs.md) page to - download and install the **airgap-pack-virtual-machine-orchestrator** and **airgap-pack-spectro-proxy** packs. + download and install the **airgap-pack-virtual-machine-orchestrator** and **airgap-pack-spectro-proxy** packs. You + will need these packs for both Proxied and Direct network configuration. 4. If you are planning to deploy VMs with direct network access, repeat step three to install a load balancer pack of your choice. We recommend installing From 3f5233b2fdd1ea8c08e605832ddae7a65cb08cbc Mon Sep 17 00:00:00 2001 From: addetz <43963729+addetz@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:24:23 +0000 Subject: [PATCH 2/4] ci: auto-formatting prettier issues --- docs/docs-content/vm-management/architecture.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docs-content/vm-management/architecture.md b/docs/docs-content/vm-management/architecture.md index f6ca8c0c80..eea374f298 100644 --- a/docs/docs-content/vm-management/architecture.md +++ b/docs/docs-content/vm-management/architecture.md @@ -32,6 +32,7 @@ By default, Palette VMO includes the following components: Palette installs a snapshot controller into every cluster where backups are scheduled or have been created on-demand in the past. To prevent resource conflicts, ensure that the + pack is uninstalled before configuring VMO. From d7b6cb05dda5ece2c878657beb5798115197f927 Mon Sep 17 00:00:00 2001 From: addetz <43963729+addetz@users.noreply.github.com> Date: Tue, 14 Jan 2025 14:35:28 +0000 Subject: [PATCH 3/4] docs: fix up formatting --- docs/docs-content/vm-management/architecture.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/docs-content/vm-management/architecture.md b/docs/docs-content/vm-management/architecture.md index eea374f298..d2b8ab550d 100644 --- a/docs/docs-content/vm-management/architecture.md +++ b/docs/docs-content/vm-management/architecture.md @@ -25,6 +25,8 @@ By default, Palette VMO includes the following components: - **Descheduler**. Enables VM live migration to different nodes in the node pool when the original node is in [maintenance mode](../clusters/cluster-management/maintenance-mode.md). + + - **Snapshot Controller**. Enables you to create VM snapshots. This component is automatically installed when you initiate or schedule cluster backups. @@ -32,12 +34,13 @@ By default, Palette VMO includes the following components: Palette installs a snapshot controller into every cluster where backups are scheduled or have been created on-demand in the past. To prevent resource conflicts, ensure that the - pack is uninstalled before configuring VMO. ::: + + - **Spectro VM Dashboard**. Enables you to create, manage, and monitor VMs from Palette. The dashboard becomes available once the VMO pack is successfully deployed as part of your cluster profile. From 053d692707afafa60ae36ff14fe8d547a87c17f8 Mon Sep 17 00:00:00 2001 From: addetz <43963729+addetz@users.noreply.github.com> Date: Tue, 14 Jan 2025 15:46:31 +0000 Subject: [PATCH 4/4] docs: PR review comments --- docs/docs-content/vm-management/architecture.md | 3 +-- .../vm-management/create-vmo-profile.md | 16 +++++++++++----- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/docs-content/vm-management/architecture.md b/docs/docs-content/vm-management/architecture.md index d2b8ab550d..81720b0cba 100644 --- a/docs/docs-content/vm-management/architecture.md +++ b/docs/docs-content/vm-management/architecture.md @@ -35,8 +35,7 @@ By default, Palette VMO includes the following components: Palette installs a snapshot controller into every cluster where backups are scheduled or have been created on-demand in the past. To prevent resource conflicts, ensure that the pack - is uninstalled before configuring VMO. - + is not a layer in your cluster profile before configuring VMO. ::: diff --git a/docs/docs-content/vm-management/create-vmo-profile.md b/docs/docs-content/vm-management/create-vmo-profile.md index 6b2101e873..1dd4fc0197 100644 --- a/docs/docs-content/vm-management/create-vmo-profile.md +++ b/docs/docs-content/vm-management/create-vmo-profile.md @@ -26,7 +26,7 @@ profile configuration. To learn about pack components, refer to [Palette VMO](./ - Ensure the cluster that you are using with the Virtual Machine Orchestrator pack does not have the pack - already installed. The Virtual Machine Orchestrator will configure snapshots. + already present in its cluster profile. The Virtual Machine Orchestrator will configure snapshots. ## Prerequisites @@ -83,7 +83,9 @@ profile configuration. To learn about pack components, refer to [Palette VMO](./ out the guide to learn more. Changing the default may require some additional configuration. - The **Direct** option is intended for a private configuration where a proxy is not implemented or not desired. + The **Direct** option is intended for a private configuration where a proxy is not implemented or not desired. Ensure + that you configure the pack + separately in your cluster profile if you select this option. :::warning @@ -121,7 +123,11 @@ profile configuration. To learn about pack components, refer to [Palette VMO](./ 7. Review the **Access** configuration panel at right. The default setting is **Proxied**, which automatically adds the **Spectro Proxy** pack when you create the cluster, allowing access to the Spectro VM Dashboard from anywhere. Changing the default may require some additional configuration. Check out the - guide to learn more. The **Direct** option is intended for a private configuration where a proxy is not implemented or not desired. + guide to learn more. + + The **Direct** option is intended for a private configuration where a proxy is not implemented or not desired. + Ensure that you configure the pack + separately in your cluster profile if you select this option. 8. If you are using PKX-E, no change is required and you can skip this step. @@ -216,8 +222,8 @@ profile configuration. To learn about pack components, refer to [Palette VMO](./ more. The **Direct** option is intended for a private configuration where a proxy is not implemented or not desired. - Ensure that configure the pack - separately in your cluster profile if you select this option. + Ensure that you configure the + pack separately in your cluster profile if you select this option. :::warning