diff --git a/docs/docs-content/vm-management/vm-management.md b/docs/docs-content/vm-management/vm-management.md index 947ece390a..cb071dbf8a 100644 --- a/docs/docs-content/vm-management/vm-management.md +++ b/docs/docs-content/vm-management/vm-management.md @@ -18,11 +18,8 @@ Palette Virtual Machine Orchestrator (VMO) provides a unified platform for manag Palette VM Orchestrator is particularly suitable in the following scenarios: -
- - Organizations that want to remove their virtualization infrastructure due to an aging environment or to reduce costs. By using Palette VM Orchestrator, legacy applications and modern, containerized applications can be deployed on VMs. - - Edge locations with a few VMs deployed and where a hypervisor is no longer desired. @@ -30,8 +27,6 @@ Palette VM Orchestrator is particularly suitable in the following scenarios: Palette Virtual Machine Orchestrator requires the following: -
- - Palette version 3.3.0 or higher. @@ -41,8 +36,6 @@ Palette Virtual Machine Orchestrator requires the following: - VMs with Persistent Volume Claim (PVC) must have a StorageClass that supports ``ReadWriteMany`` (``RWX``) access mode for seamless live migration to a different node - either when triggered manually or during a Kubernetes upgrades. -
- :::caution In environments that use nested virtualization, where VMs operate inside of VMs due to lack of hardware to host VMs, it is technically possible to operate VMs in Kubernetes by setting the KubeVirt resource ``useEmulation`` to true. However, we do not recommend this approach. @@ -63,8 +56,6 @@ Palette VM Orchestrator provides various methods to quickly deploy VMs from out- Palette VM Orchestrator utilizes open-source KubeVirt as a component of the **Virtual Machnine Orchestrator** pack to manage VMs and enables the following KubeVirt feature gates by default: -
- - LiveMigration - Snapshot - HotplugVolumes diff --git a/docs/docs-content/vm-management/vm-packs-profiles/add-roles-and-role-bindings.md b/docs/docs-content/vm-management/vm-packs-profiles/add-roles-and-role-bindings.md index 62288c2cd7..16c648771e 100644 --- a/docs/docs-content/vm-management/vm-packs-profiles/add-roles-and-role-bindings.md +++ b/docs/docs-content/vm-management/vm-packs-profiles/add-roles-and-role-bindings.md @@ -19,11 +19,8 @@ You must configure permissions for actions that users can perform on Virtual Mac - Additional cluster roles, based on the user's persona, must be associated with the user by specifying a cluster role binding or a namespace-restricted role binding: - ``spectro-vm-admin`` - - ``spectro-vm-power-user`` - - ``spectro-vm-user`` - - ``spectro-vm-viewer`` Alternatively, you can use standard Kubernetes roles ``cluster-admin``, ``admin``, ``edit``, and ``view`` instead of defining bindings based on ``spectro-vm-*`` roles. @@ -36,8 +33,11 @@ You must configure permissions for actions that users can perform on Virtual Mac 2. From the left **Main Menu**, click **Clusters** and select your cluster. + 3. Click on **Settings** and choose **RBAC** to add role bindings. Refer to [Create a Role Binding](../../clusters/cluster-management/cluster-rbac.md#create-role-bindings) for guidance. Refer to [VM User Roles and Permissions](../vm-roles-permissions.md) for a list of Cluster Roles and equivalent Palette Roles. + If you have OpenID Connect (OIDC) configured at the Kubernetes layer of your cluster profile, you can create a role binding that maps individual users or groups assigned within the OIDC provider's configuration to a role. To learn more, review [Use RBAC with OIDC](../../integrations/kubernetes.md#use-rbac-with-oidc). + 4. Click **Confirm** to update the cluster. The cluster status displays as **Upgrading** on the **Cluster Overview** page. Upgrading can take several minutes depending on your environment. You can track events from the **Events** tab. @@ -46,7 +46,6 @@ The cluster status displays as **Upgrading** on the **Cluster Overview** page. U You can verify role creation and role binding is successful by following the steps below. - 1. Log in to [Palette](https://console.spectrocloud.com). 2. Navigate to the left **Main Menu** and select **Clusters**. diff --git a/docs/docs-content/vm-management/vm-packs-profiles/configure_OIDC.md b/docs/docs-content/vm-management/vm-packs-profiles/configure_OIDC.md new file mode 100644 index 0000000000..cd9d4a5599 --- /dev/null +++ b/docs/docs-content/vm-management/vm-packs-profiles/configure_OIDC.md @@ -0,0 +1,60 @@ +--- +sidebar_label: "Configure OIDC" +title: "Configure OIDC" +description: "Learn how to configure OIDC so Palette displays the Virtual Machine Dashboard." +icon: " " +hide_table_of_contents: false +sidebar_position: 15 +tags: ["vmo", "oidc"] +--- + + + + +Palette displays the Virtual Machine dashboard based on the OpenID Connect (OIDC) Identity Provider option that you select in the Kubernetes layer of the infrastructure profile. + + +## Prerequisites + +- A configured infrastructure profile. For more information, review [Create a Cluster Profile](../../cluster-profiles/task-define-profile.md). + + +## Enable OIDC + +1. Log in to [Palette](https://console.spectrocloud.com/). + +2. From the left **Main Menu** click **Profiles**. + +3. Select the cluster profile to update. Palette displays profile details and the profile stack. + +4. Select the Kubernetes layer in the profile stack, and choose an OIDC Identity Provider option. Refer to [Configure OIDC Identify Provider](../../integrations/kubernetes.md#configure-oidc-identity-provider) to learn more about OIDC options. + + Selecting **None** or **Palette** will display the Virtual Machine dashboard in a tab. + + Selecting **Inherit from Tenant** or **Custom** will display a link to the dashboard on the cluster overview page. + + :::caution + + We do not recommend choosing **None** in a production environment, as it may disable authentication for add-ons that rely on OIDC. + + ::: + +5. Click **Confirm Updates**. + +6. Save your changes. + + +## Validate + +1. From the left **Main Menu** click **Profiles**. + +2. Select the cluster profile you updated. Palette displays profile details and the profile stack. + +3. Select the Kubernetes layer. Palette displays the OIDC Identity Provider you selected - either **None**, **Palette**, **Inherit from Tenant**, or **Custom**. + + +## Next Steps + +You are now ready to create the VMO profile. Refer to [Create the VMO Profile](../vm-packs-profiles/create-vmo-profile.md) for guidance. + + diff --git a/docs/docs-content/vm-management/vm-packs-profiles/create-vmo-profile.md b/docs/docs-content/vm-management/vm-packs-profiles/create-vmo-profile.md index 4996a4d075..ba0406fd12 100644 --- a/docs/docs-content/vm-management/vm-packs-profiles/create-vmo-profile.md +++ b/docs/docs-content/vm-management/vm-packs-profiles/create-vmo-profile.md @@ -4,12 +4,12 @@ title: "Create a VMO Profile" description: "Learn how to create a cluster profile to utilize Palette Virtual Machine Orchestrator capabilities." icon: " " hide_table_of_contents: false -sidebar_position: 0 +sidebar_position: 5 tags: ["vmo"] --- -The **Virtual Machine Orchestrator** pack that you use to create a cluster profile conveniently includes several components and automatically installs the [Spectro Proxy](../../integrations/frp.md) pack when you use the default profile configuration. To learn about pack components, refer to [Virtual Machine Orchestrator Pack](../vm-packs-profiles/vm-packs-profiles.md). +The **Virtual Machine Orchestrator** pack conveniently includes several components and automatically installs the [Spectro Proxy](../../integrations/frp.md) pack when you use the default profile configuration. To learn about pack components, refer to [Virtual Machine Orchestrator Pack](../vm-packs-profiles/vm-packs-profiles.md). ## Prerequisites @@ -35,21 +35,16 @@ The **Virtual Machine Orchestrator** pack that you use to create a cluster profi 6. Use the information below to find the **Virtual Machine Orchestrator** pack: - -
- - **Pack Type**: System App - **Registry**: Public Repo - **Pack Name**: Virtual Machine Orchestrator - **Pack Version**: 1.0 or higher -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. Check out the [Spectro Proxy](../../integrations/frp.md) guide to learn more. Changing the default may require some additional configuration. +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. Check out the [Spectro Proxy](../../integrations/frp.md) 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. -
- :::caution We recommend using the pack defaults. Default settings provide best practices for your clusters. Changing the default settings can introduce misconfigurations. Carefully review the changes you make to a pack. @@ -72,8 +67,6 @@ The **Virtual Machine Orchestrator** pack that you use to create a cluster profi You can validate the profile is created. -
- 1. Log in to [Palette](https://console.spectrocloud.com). @@ -93,6 +86,8 @@ You can validate the profile is created. You will need to configure roles and role bindings to give users access virtual clusters. You can use VM user roles and permissions or standard Kubernetes roles. For configuration guidance, refer to [Add Roles and Role Bindings](add-roles-and-role-bindings.md). The [VM User Roles and Permissions](../vm-roles-permissions.md) reference lists Cluster Roles and equivalent Palette Roles. +If you have OpenID Connect (OIDC) configured at the Kubernetes layer of your cluster profile, you can create a role binding that maps individual users or groups assigned within the OIDC provider's configuration to a role. To learn more, review [Use RBAC with OIDC](../../integrations/kubernetes.md#use-rbac-with-oidc). + ## Resources diff --git a/docs/docs-content/vm-management/vm-packs-profiles/vm-packs-profiles.md b/docs/docs-content/vm-management/vm-packs-profiles/vm-packs-profiles.md index 102dfb32e9..1b12965712 100644 --- a/docs/docs-content/vm-management/vm-packs-profiles/vm-packs-profiles.md +++ b/docs/docs-content/vm-management/vm-packs-profiles/vm-packs-profiles.md @@ -9,8 +9,6 @@ tags: ["vmo"] The **Virtual Machine Orchestrator** pack provides a single-pack experience that consolidates all the dependencies needed to deploy and manage VMs in your Kubernetes host cluster. You use **Virtual Machine Orchestrator** pack to create a VMO cluster profile. The pack's components are described below. All the components are enabled by default in the `charts:` section of the pack YAML configuration file. -
- - **Spectro VM Dashboard**: Enables access to a web console so you can manage and monitor your VMs. The console is accessible from the **Virtual Machines** tab that appears on the cluster overview page when using Palette Virtual Machine Orchestrator (VMO). The dashboard provides a web interface to create and manage VMs in your Kubernetes cluster. @@ -43,5 +41,4 @@ Administrators can configure the out-of-the-box add-on packs, cluster profiles, - [Spectro Proxy](../../integrations/frp.md) - -- [Feature Gates](../vm-management.md#feature-gates) \ No newline at end of file +- [Feature Gates](../vm-management.md#feature-gates)