VM Configurations
Virtual machine configurations are a combination of operating system hardware and the actual drives themselves. Once a configuration is created, a user can launch a VM using that configuration.
Virtual machine configurations are a combination of operating system hardware and the actual drives. Once a configuration is created, a user can launch a VM using that configuration.
Create VM Configuration
To create a new VM configuration navigate to tab, in the Virtual Machines
section.
- Click the the
Create configuration
icon in the top left. - In the prompt, enter the following details:
- VM name
- Team name
- Optional project
- Select a Hardware Setup.
- Select a Drive for the VM, either an existing or a new one.
Side note: To create a new drive click on the button on the right.
- Additionally, you can assign additional drives to the VM.
- Optionally, tick "Launch a VM from this configuration immediately".
A team is necessary for creating a VM as the team maintains the hardware and software quotas.
A project is optional, meaning there may not be a security level associated with access to the VM.
Hardware Setups are created and maintained in the Management tab
by the admins.
Restricted projects in VMs are enforced as follows:
- Unrestricted VM configurations = Unrestricted drives
- Restricted VMs + Read-and-Write drives = Same level of project restriction required
- Restricted VMs + Read-only drives = Same level restriction or unrestricted project allowed
Edit VM Configuration
To edit a VM configuration navigate to tab, in the Virtual Machines
section.
- Select the VM configuration you would like to edit.
- Click the the
Edit
icon in the top right. - In the prompt, you can rename the VM, change the team for the VM, add a project, change the image, or change the drives.
- Once you finished, click Save.
Please recall that VM configurations that are restricted by a project have higher restrictions and must match up with the drive.
- You cannot edit a VM if you are not its owner.
- You can edit a VM only if it's shut down.
Add User(s) to VM Configuration
To add users to a VM configuration navigate to tab, in the Virtual Machines
section.
- Select the virtual machine you want to add users to.
- Click the
User Management
card on the right panel. - Click the
Add User(s)
button at the top panel. - In the prompt, type the user name(s) you want to add to the VM configuration.
- Select the VM profile.
- Select the user(s) role.
- Select the user(s) permissions.
- Click then add more users in the same way.
- Once you are happy with the changes, click .
- All VM users and their permissions will show up in the VM
table
orlist
within theUser Management
card. - All regular VM users should be added in this way.
- New added users must connect to the VM configuration; they do not need to attach any drive.
- Users can add other users to the VM configuration if they are on the same team and have permission to add other users.
- The user names listed on the
Managers
card are usually the owners of the virtual machine.
Edit User(s) permissions in VM Configuration
To edit users permissions in a VM configuration navigate to tab, in the Virtual Machines
section.
- Select the virtual machine you want to edit users permissions for.
- Click the
User Management
card on the right panel. - Click the
Users
card on the central left. - Click the button on the right.
- Next,
tick
oruntick
the checkboxes corresponding to each user's permission in the VM.- Optionally, click the
Managers
card to edit managers permissions in the VM.
- Optionally, click the
- Click .
Sync User Access in VM Configuration
This command is available to VM owners only.
When syncing user access, the following actions take place automatically:
- Ask the tiCrypt server to which users can connect to your VM.
- Check who the VM trusts via its registered user list and users' roles in the VM (user or manager).
User is registered on the Server | User is registered in the VM | Automated Action |
---|---|---|
Yes | Yes | No action is taking place. |
Yes | No | The VM is synced with the server. |
No | Yes | The system de-authorizes the user and then re-authorizes them with the correct user role (user or manager). |
No | No | Re-register the user in the VM. |
VM configuration owners who were not registered in the VM but are registered on the server will be automatically added as managers with full permissions to the VM configuration.
To sync user acess in a VM configuration navigate to tab, in the Virtual Machines
section.
- Select the connected virtual machine where you want to sync the users.
- Select the
User Management
card. - Click the
Three dots
option on the right. - In the prompt click the
Sync user access
option. - Click .
To re-authorize a user manually, navigate to the User Management
card then click the Fix authorization
option on the right of the appropriate user.
Remove User(s) from VM Configuration
To remove users from a VM configuration navigate to tab, in the Virtual Machines
section.
- Select the virtual machine you want to remove users from.
- Click the
User Management
card on the right panel. - In the table/list, click the
Remove
button on the right under theEdit
option. - In the prompt, click .
Share VM Configuration
To share a VM configuration navigate to tab, in the Virtual Machines
section.
- Select the VM configuration you would like to share.
- Click the the
Three dots
icon in the top right. - Select
Share
from the options. - In the prompt, type the user name(s) you want to share the VM configuration with.
- Sync user access to whether or not the new VM owners will be registered as managers with full permissions.
- Select auto-share drives to determine whether or not new VM owners will have drive access for VM rebooting purposes.
- Click .
- Users must be part of the same team to share virtual machine configurations.
- Sharing a VM configuration will allow direct access to the drives; to add regular users to your VM scroll up to add users to VM configuration section.
- Sharing a VM requires sharing permissions from the admin.
- Shared VM Configurations are viewable after a re-login.
- You must be the owner of the VM to be able to share it.
- Sharing VM configuration should be conducted between VM owners and managers only.
- We recommend setting the sync user access option to active to reduce friction between VM owners and their VM permissions.
- For good practice, you should have the
auto-share drives
option active if you are on holiday or unavailable; the other VM owners can perform rebooting actions for the VM users.
Delete VM Configuration
To delete a VM configuration navigate to tab, in the Virtual Machines
section.
- Select the VM configuration you would like to delete.
- Click the the
Three dots
icon in the top right or by the selected VM configuration. - Select the the
Delete
icon from the options. - Click .
You must have your VM shutdown
under the Inactive Configurations section to be able to delete it.
Create VM User Profile
To create a new VM User Profile navigate to tab, in the Virtual Machines
section.
- Select the connected VM you want to add a VM User Profile.
- Click the
User Profiles
card in the bottom right - Click
Add Profile
button in the top left. - In the prompt, type a VM User Profile name.
- Select the VM User Profile role.
- Select the VM User Profile permissions.
- Click button.
To create actions, you must have VM manager role permissions or own the respective VM configuration.
Edit VM User Profile
To edit a VM User Profile navigate to tab, in the Virtual Machines
section.
- Select the connected VM you want to edit the VM User Profile of.
- Click the
User Profiles
card. - Select the appropriate VM User Profile from the table/list.
- Click the
Edit
button in the top right under users/managersactions
column. - In the prompt, edit the VM User Profile name.
- Edit the VM User Profile permissions.
- Select whether or not the changes apply to existing VM User Profile users.
- Additionally, you can click on the button on the top right of the user profile table to access the same edit prompt.
- Click .
You cannot change VM profile permissions for yourself. These changes may be conducted by an admin only.
To perform editing actions, you must have VM manager role permissions or own the respective VM configuration.
Delete VM User Profile
To delete a VM User Profile navigate to tab, in the Virtual Machines
section.
- Select the connected VM you want to delete the VM User Profile of.
- Click the
User Profiles
card. - Select the appropriate VM User Profile from the table/list.
- Click the
Delete
button in the top right under users/managersactions
column. - Click .