Create a Tenancy#

Note

Tenants, tenancies, and other features are available if you have paid for multi-tenant support. Contact Penguin Computing to learn more.

Tenancy requirements are defined in a Terraform file. Either the superadministrator or the tenancy administrator can create and submit the Terraform file to the ICE ClusterWare ™ software to create the tenancy. See Tenancy Terraform File Requirements for details.

Prerequisite: Create the associated tenant in the ClusterWare software.

To create a new tenancy, POST a Terraform file to the /tenant/CURRENT/tenancies endpoint:

curl -X POST http://<head node IP>/api/v1/tenant/<tenant name>/tenancies -F "file=@<terraform path>" -H "Authorization: Bearer $token" -H "Tenancy: <name>"

Where:

  • <head node IP> is the IP address of a super-cluster head node.

  • <tenant name> is the name of the tenant in the ClusterWare software.

  • <terraform path> is the path to the Terraform file being submitted.

  • <name> is a unique name for the new tenancy. Names must start with an alphabet character, not a number.

For example:

curl -X POST http://192.123.1.1/api/v1/tenant/customer/tenancies -F "file=@./main.tf" -H "Authorization: Bearer $token" -H "Tenancy: customer-tenancy"

The ClusterWare software uses the Terraform file to start an automated process where:

  • The tenancy is created within the ClusterWare software.

  • Virtual machines are created within the new tenancy. Virtual machines include a head node, gateway node, Slurm control plane node, login node, and health check node.

  • The specified number of compute nodes are moved from the Available tenancy to the new tenancy.

  • VLAN, VXLAN, VNI, and PKey resources are configured for network isolation.

  • The head node boots with an operating system (OS) image and instance of the ClusterWare software.

  • The gateway node boots with an OS image.

  • The head node boots all other virtual and bare metal machines with a default image.

You can monitor the process by checking if the tenancy is created. If the tenancy is available, but not fully set up, you'll get an alert that the tenancy is created, but not accessible.