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
- Non-edge
- Edge
- Airgap
- A Palette permission key
createfor the resourceclusterProfile.
-
A Palette permission key
createfor the resourceclusterProfile. -
Your Edge cluster profile must have a Container Storage Interface (CSI) pack.
We recommend using Ubuntu 22.04 as the OS image for Edge clusters deployed in appliance mode. Refer to Palette Edge Getting Started for further guidance.
-
A Palette permission key
createfor the resourceclusterProfile. -
Ensure the VMO pack is installed in your airgap environment. Refer to the Install VMO in Airgap Environments guide for further information.
-
Ensure the Spectro Proxy pack is installed in your airgap environment. Refer to the Install VMO in Airgap Environments guide for further information.
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
- Non-edge
- Edge
- Airgap
-
Log in to Palette.
-
Select Profiles in the left Main Menu and click the Add Cluster Profile button.
-
Enter basic information for the profile: name, version if desired, and optional description.
-
Select type Add-on, and click Next.
-
In the following screen, click Add New Pack.
-
Locate the Virtual Machine Orchestrator pack and add it to your profile.
-
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.
warningWe 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.
- 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
-
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.installCRDsparameter in the manifest and set its value tofalse.charts:
virtual-machine-orchestrator:
...
snapshotController:
...
installCRDs: false
-
Click Confirm & Create.
-
In the following screen, click Next.
-
Review the profile and click Finish Configuration.
-
Apply the profile to your cluster. For more information, refer to the Getting Started tutorials.
-
Log in to Palette.
-
Select Profiles in the left Main Menu and click the Add Cluster Profile button.
-
Enter basic information for the profile: name, version if desired, and optional description.
-
Select type Add-on, and click Next.
-
In the following screen, click Add New Pack.
-
Locate the Virtual Machine Orchestrator pack and add it to your profile.
-
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.
- 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
-
If you are using PKX-E, no change is required and you can skip this step.
If you are using K3s or RKE2 as the Kubernetes layer in your cluster profile, you need to update the
charts.virtual-machine-orchestrator.multus.networkControllerparameter in thevalues.yamlfor the VMO pack. Add a line for the parameterenableK3SHostPathand set its value totrue. In addition, changecriSocketContainerPathto/host/run/containerd/containerd.sock.networkController:
criSocket:
enableK3SHostPath: true
criSocketContainerPath: /host/run/containerd/containerd.sock
-
If your cluster profile does include a load balancer such as MetalLB, no changes are required and you can skip this step. For more information about MetalLB, refer to the MetalLB pack documentation
If your cluster profile does not include a load balancer, update the services
charts.virtual-machine-orchestrator.kubevirtandcharts.virtual-machine-orchestrator.cdito type ClusterIP in values.yaml for the VMO pack:- cdi
- kubevirt
cdi:
enabled: true
replicas: 1
image:
repository: quay.io/kubevirt/cdi-operator
pullPolicy: IfNotPresent
# Overrides the image tag whose default is the chart appVersion.
tag: "v1.56.0"
service:
type: ClusterIP
port: 443
targetPort: 8443kubevirt:
enabled: true
# defaults to kubevirt
namespace: kubevirt
replicas: 1
service:
type: ClusterIP
port: 443
targetPort: 8443
-
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.installCRDsparameter in the manifest and set its value tofalse.charts:
virtual-machine-orchestrator:
...
snapshotController:
...
installCRDs: false
-
Click Confirm & Create.
-
In the following screen, click Next.
-
Review the profile and click Finish Configuration.
-
Add the add-on profile when you create a cluster. For more information, refer to Create Cluster Definition.
-
Log in to a tenant that belongs to your instance of Palette or Palette VerteX.
-
In the left Main Menu, select Profiles and click Add Cluster Profile.
-
Enter basic information for the profile: name, version if desired, and optional description.
-
Select type Add-on, and click Next.
-
In the following screen, click Add New Pack.
-
Locate the Virtual Machine Orchestrator pack and add it to your profile.
-
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.
warningWe 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.
- 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
-
Click Values in the Pack Details section. The pack manifest editor appears. Locate the
pack.cdi.privateRegistrysection in the manifest. The table below contains a brief description of each field exposed by the private registry. Set thepack.cdi.privateRegistry.enabledfield to true and fill in the registry IP address and base path according to your environment. This configures the VMO pack to pull images from your airgap environment private registry.Field Description pack.cdi.privateRegistry.enabledFlag to enable the profile to use the airgap private image registry. pack.cdi.privateRegistry.registryIPThe IP address the private image registry. pack.cdi.privateRegistry.registryBasePathThe base path of the private image registry. cdi:
privateRegistry:
enabled: true
registryIP: <REPLACE ME>
registryBasePath: <REPLACE ME>
-
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.installCRDsparameter in the manifest and set its value tofalse.charts:
virtual-machine-orchestrator:
...
snapshotController:
...
installCRDs: false
-
Click Confirm & Create.
-
On the following screen, click Next.
-
Review the profile and click Finish Configuration.
-
Apply the profile to your cluster. For more information, refer to the Getting Started tutorials.
If you want to use direct access in an environment configured to use an external proxy, you must exclude your cluster's
load balancer IP range from proxy routing. Expand the following section to learn how you can configure your
environment's No Proxy list. Download the Kubeconfig file of the airgap support VM. Open a terminal window and set the environment variable Execute the following command to find the namespace which contains your environment proxy configuration. Make a note of the namespace. Issue following command to edit the pod preset. Replace the placeholder with the namespace you identified previously. Add your load balancer IP range to the Save your changes and close the editor. Your configuration changes are automatically applied.Configure the No Proxy list
KUBECONFIG to point to the file you downloaded.export KUBECONFIG=<path-to-downloaded-kubeconfig-file>kubectl get podpreset --all-namespaces --field-selector=metadata.name=proxykubectl edit podpreset proxy --namespace <namespace>NO_PROXY configuration under the spec.env section.env:
- name: NO_PROXY
value: "REPLACE ME"
Validate
You can validate the profile is created.
- Non-edge
- Edge
- Airgap
-
Log in to Palette.
-
Navigate to Profiles from the left Main Menu.
-
Locate the newly created profile in the list.
-
From the left Main Menu, click Clusters and select your cluster.
-
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.
-
Log in to Palette.
-
Navigate to Profiles from the left Main Menu.
-
Locate the newly created profile in the list.
-
From the left Main Menu, click Clusters and select your cluster.
-
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.
-
Log in to a tenant that belongs to your instance of Palette or Palette VerteX.
-
Navigate to Profiles from the left Main Menu.
-
Locate the newly created profile in the list.
-
From the left Main Menu, click Clusters and select your cluster.
-
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.