nutanix

The Nutanix realm uses a Nutanix Cluster to execute the VMs and to host the VM Drives and Images.

The paramaters required by the Nutanix driver depend on an already set up environment in Nutanix PRISM. In particular, you need to:

Create a network and obtain the network ID.
Create a storage container for drives and obtain the ID

Parameter	Type	Required	Description
`disabled`	*Boolean*	Required	Is the realm disabled?
`driver`	nutanix	Required	This is a Nutanix realm
`name`	*String*	Required	Displayable name of realm
`network-id`	*String*	Required	The network ID in Nutanix
`drives.storage-container-id`	*String*	Required	The storage ID
`hostname`	*String*	Required	The hostname of Nutanix cluster
`port`	*Port*	Optional	The port of PRISM API, default 9440
`username`	*String*	Optional	Defaults to `ticrypt`
`password`	*String*	Required	The password of the Nutanix account
`task-poll-freq`	*Duration*	Optional	How often to get task updates
`registration-timeout`	*Duration*	Optional	VM startup timeout
`drives.min-size`	*Size*	Optional	Minimum drive size
`drives.max-size`	*Size*	Optional	Maximum drive size

registration-timeout is somewhat critical. Too short and the VMs do not have enough time to register and get killed.

To debug VMs that do not correctly register, increase registration-timeout and attach a console.

You almost always want to increase drives.max-size. The default value is 32 GiB.

VM Images can only be imported via the Nutanix PRISM interface.

VM Naming Configuration

In addition, Nutanix VMs are automatically prepended with a tag to specify that they are part of tiCrypt. By default, they are named "tc-<name>", but the automatic naming can be changed via the nutanix realm’s config.

In the nutanix realm config:

    vm-name: "tc-<name>"
    vm-desc: "tiCrypt managed VM | Owner: <owner> (<ownerID>) | Brick: <brick> (<brickID>)"

The tags in brackets will be filled by that vm’s information, and the following tags can be used:

Tag	Description	Example
<name>:	VM name	Nutanix VM 1
<team>:	Team name	Tera Insights
<owner>:	VM owner’s full name	TiCrypt User
<ownerID>:	VM owner’s ID	289f4326-a3a8-49e5-8327-2bdba30d3aba
<project>:	Project name	TiCrypt Testing
<brick>:	Brick name	Nutanix-CentOS
<brickID>:	Brick ID	bdd65456-0f1e-4d29-aa65-fdcc71926431

Drive Naming Configuration

The same mechanism is available for drives on Nutanix.

In the nutanix realm config:

    drive-name: "tc-<name>"
    drive-desc: "tiCrypt managed drive | Owner: <owner> (<ownerID>) | Format: <format>"

The tags in brackets will be filled by that drive’s information, and the following tags can be used:

Tag	Description	Example
<name>:	VM name	Nutanix VM 1
<team>:	Team name	Tera Insights
<owner>:	VM owner’s full name	TiCrypt User
<ownerID>:	VM owner’s ID	289f4326-a3a8-49e5-8327-2bdba30d3aba
<project>:	Project name	TiCrypt Testing
<format>:	Drive format	ext4