Realms

Prerequisites

• Access Level: Admin, Super-admin.
• Permission Requirements:
• . Basic VM Interaction
  • View drives (inconsistent, see notes)
  • Edit drives (name and whether to disable backup)
  • View drive keys (necessary to share/attach)
  • Attach drives to VMs
  • Detach drives from VMs
  • View hardware/image setups made available to them
  • View own VM configs and configs shared with them
  • Spawn VMs from VM configs
  • Stop VMs spawned from VM configs
  • View own VM username
  • View anyone's VM username (necessary for sharing VMs)
  • View own VMs and VMs shared with them
  • Connect to own VMs and VMs shared with them
  • View storage pools for any Libvirt realm
• . VM Administration
  • View all VM configs in the system
  • Arbitrarily edit any VM config
  • View host machines and hardware information in any Libvirt realm
  • Register physical VM host machines in Libvirt realms
  • Edit VM host machine info in any Libvirt realm
  • Delete VM host machine info in any Libvirt realm
  • Modify any user's VM username
  • Arbitrarily view logs from any VM

Access Realms

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Realms in the left panel.

View a Realm’s Libvirt Configuration

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Realms in the left panel.
4. Select the realm to view its configuration.
5. Click the View config button in the top right panel.
6. In the pop-up, view the realm configuration from the backend.
7. Click Close.

View Basic Information of a Realm

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Realms in the left panel.
4. Select the realm to view its basic information.
5. Click the View button in the top right panel.
6. In the left panel, view the realm's name and driver.

Refresh Realm's Metadata

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Realms in the left panel.
4. Click the Refresh button in the top right panel.

Refresh All Pools Associated with Realm(s)

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Realms in the left panel.
4. Select the realm(s) to refresh all pools.
5. Click the Open Full Menu button in the top right panel.
6. Select Refresh all pools.

Fix VMs and Refresh tiCrypt’s View of Realm(s)

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Realms in the left panel.
4. Select the realm(s) whose VMs you want to fix.
5. Click the Open Full Menu button in the top right panel.
6. Select Fix VMs.
7. In the pop-up, click Fix VMs.

danger

Fixing VMs will stop all running VMs to reclaim resources for the realm.

Fix Drives and Refresh tiCrypt’s View of the Drives States of Realm(s)

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Realms in the left panel.
4. Select the realm(s) whose drives you want to fix.
5. Click the Open Full Menu button in the top right panel.
6. Select Fix Drives.
7. In the pop-up, click Fix Drives.

caution

Fixing Drives will correct all incorrect drive states based on the state of known running VMs.

Export Realm Metadata in CSV Format

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Realms in the left panel.
4. Click the Export CSV button in the top right panel.
5. Select the All items option.
6. In the local window, click Save.

Export Realm Metadata in JSON Format

bulk-action

1. Go to the Management icon in the top left taskbar.
2. Navigate to the Virtual Machines section.
3. Click the Realms in the left panel.
4. Click the Export JSON button in the top right panel.
5. Select the Export all items option.
6. In the local window, click Save.