Skip to main content

Create a VMO Profile

The Virtual Machine Orchestrator pack conveniently includes several components and automatically installs the Spectro Proxy pack when you use the default profile configuration. To learn about pack components, refer to Palette VMO.

Before you create the profile, review Deployment Modes, which describes each Deployment Mode option in detail, and Authentication Options, which lists the identity provider (IdP) options available in the Presets panel and documents the profile variables that some of those options require.

Limitations​

  • If you are updating the profile of an existing cluster that already has the Spectro Proxy pack. You must restart the Spectro Proxy pod for the proxy to work as expected.

    To restart the Spectro Proxy pod, delete the pod and it will restart automatically. You can issue the following command to delete the pod:

    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 Volume Snapshot Controller pack already present in its cluster profile. The Virtual Machine Orchestrator will configure snapshots.

Prerequisites​

  • A Palette permission key create for the resource clusterProfile.

Regardless of environment, if you pre-provision StorageClasses that VM workloads should use (for example, through GitOps, Terraform, or an imperative script), label each class with vmo-manager.spectrocloud.com/vm-workload: "true". Without the label, the class appears in the VMO UI but the Allow for VMs checkbox is not pre-checked, so the class is not available for VM workloads until an administrator edits it on the Home > Storage > Storage Classes page. Refer to Custom StorageClass Not Appearing as VM-eligible for the fix on an existing class.

Create the Profile​

  1. Log in to Palette.

  2. Select Profiles in the left Main Menu and click the Add Cluster Profile button.

  3. Enter basic information for the profile: name, version if desired, and optional description.

  4. Select type Add-on, and click Next.

  5. In the following screen, click Add New Pack.

  6. Locate the Virtual Machine Orchestrator pack and add it to your profile.

  7. Review the Deployment Mode options in the configuration panel. The pack provides three modes.

    The Proxied and Direct modes seed the access values, including charts.virtual-machine-orchestrator.vmo-manager.service.type, but you can still edit every value in the pack YAML. Refer to Deployment Modes for the values that each mode sets.

    • Proxied mode 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 guide to learn more. This is the default selection. This mode sets the service type to ClusterIP.
    • Direct mode is for clusters that Palette can reach directly, with no firewall or Network Address Translation (NAT) between Palette and the cluster network. This mode requires no proxy and sets the service type to LoadBalancer.
    • Custom mode applies no Deployment Mode values. You provide your own access configuration, including the service type, according to your environment.
    warning

    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.

  1. If you are using a Container Storage Interface (CSI) that installs its own Custom Resource Definitions (CRDs) for VolumeSnapshotClass, VolumeSnapshot, and VolumeSnapshotContent, you need to disable the equivalent CRDs from being installed by the VMO pack. An example of such a CSI is the Portworx with Operator pack.

    To do this, click Values in the Pack Details section. The pack manifest editor appears. Locate the charts.virtual-machine-orchestrator.snapshotController.installCRDs parameter in the manifest and set its value to false.

    charts:
    virtual-machine-orchestrator:
    ...
    snapshotController:
    ...
    installCRDs: false
  1. Click Confirm & Create.

  2. In the following screen, click Next.

  3. Review the profile and click Finish Configuration.

  4. Apply the profile to your cluster. For more information, refer to the Getting Started tutorials.

Validate​

You can validate the profile is created.

  1. Log in to Palette.

  2. Navigate to Profiles from the left Main Menu.

  3. Locate the newly created profile in the list.

  4. From the left Main Menu, click Clusters and select your cluster.

  5. Based on your Single Sign-On (SSO) settings, the Virtual Machines tab may display on the Cluster Overview page, or the Connect button may display next to Virtual Machines Dashboard in cluster details.

Next Steps​

You will need to configure roles and role bindings to give users access to clusters. You can use VM user roles and permissions or standard Kubernetes roles. For configuration guidance, refer to Add Roles and Role Bindings. The VM User Roles and Permissions 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. Refer to the Palette eXtended Kubernetes (PXK) pack additional guidance for more information.

Resources​