Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adjust VMO profile guidance for Spectro Proxy and Snapshot Controller DOC-1590 DOC-1591 #5425

Merged
merged 4 commits into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions docs/docs-content/vm-management/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,21 @@ 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).

<!-- prettier-ignore-start -->

- **Snapshot Controller**. Enables you to create VM snapshots. This component is automatically installed when you
initiate or schedule cluster backups.

:::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
<VersionedLink text=" Volume Snapshot Controller" url="/integrations/packs/?pack=volume-snapshot-controller" /> pack
is not a layer in your cluster profile before configuring VMO.
:::

<!-- prettier-ignore-end -->

- **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.

Expand Down
19 changes: 17 additions & 2 deletions docs/docs-content/vm-management/create-vmo-profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<VersionedLink text=" Volume Snapshot Controller" url="/integrations/packs/?pack=volume-snapshot-controller" /> pack
already present in its cluster profile. The Virtual Machine Orchestrator will configure snapshots.

## Prerequisites

<Tabs groupId="environment">
Expand All @@ -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.

</TabItem>

</Tabs>
Expand Down Expand Up @@ -76,7 +83,9 @@ profile configuration. To learn about pack components, refer to [Palette VMO](./
out the <VersionedLink text="Spectro Proxy" url="/integrations/packs/?pack=spectro-proxy" /> 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 <VersionedLink text="Spectro Proxy" url="/integrations/packs/?pack=spectro-proxy" /> pack
separately in your cluster profile if you select this option.

:::warning

Expand Down Expand Up @@ -114,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
<VersionedLink text="Spectro Proxy" url="/integrations/packs/?pack=spectro-proxy" /> guide to learn more. The **Direct** option is intended for a private configuration where a proxy is not implemented or not desired.
<VersionedLink text="Spectro Proxy" url="/integrations/packs/?pack=spectro-proxy" /> 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 <VersionedLink text="Spectro Proxy" url="/integrations/packs/?pack=spectro-proxy" /> 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.

Expand Down Expand Up @@ -209,6 +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 you configure the <VersionedLink text="Spectro Proxy" url="/integrations/packs/?pack=spectro-proxy" />
pack separately in your cluster profile if you select this option.

:::warning

Expand Down
3 changes: 2 additions & 1 deletion docs/docs-content/vm-management/install-vmo-in-airgap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
addetz marked this conversation as resolved.
Show resolved Hide resolved

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 <VersionedLink text="MetalLB" url="/integrations/packs/?pack=lb-metallb" />
Expand Down
Loading