Partitioning a Qumulo Cluster into Tenants

This section explains how to enable, disable, and use network multitenancy in Qumulo Core.

In Qumulo Core 5.3.4 (and higher), network multitenancy lets you partition a single physical Qumulo cluster into multiple virtual tenants. You can define a tenant by using a name and one or more networks. When you assign a network to a tenant, Qumulo Core treats any client that connects from that network as part of that tenant. For more information, see Connect to Multiple Networks in Qumulo Core on Qumulo Care.

For each tenant, you can specify individual management protocol access and configuration and file system protocol access and configuration.

Note
All tenants share the cluster’s underlying file system, identity providers, role-based access control (RBAC) configuration, and other global settings.

Prerequisites

To manage network multitenancy and tenants, your user must have membership in a Qumulo role with the following privileges.

PRIVILEGE_NETWORK_READ: Viewing networks
PRIVILEGE_NETWORK_WRITE: Assigning networks to tenants
PRIVILEGE_TENANT_READ: Viewing tenants
PRIVILEGE_TENANT_WRITE: Enabling network multitenancy and creating, modifying, and deleting tenants

Enabling and Disabling Network Multitenancy

To add tenants to your Qumulo cluster, you must enable network multitenancy. This section explains how to enable and disable network multitenancy on your Qumulo cluster.

To Enable Network Multitenancy by Using the Web UI

Log in to Qumulo Core.
Click Cluster > Network Multitenancy.
On the Network Tenants page, in the upper right, click Enable Multitenancy…
In the Enable Multitenancy? dialog box, click Yes, Enable Multitenancy…

Qumulo Core creates a tenant with the name Default and all of the cluster’s networks. It enables all management protocols for the tenant. The tenant also retains the same file system protocol configuration as when multitenancy was disabled.

Enabling Network Multitenancy by Using the qq CLI

Use the qq multitenancy_enable command and specify a name for your tenant. For example:

$ qq multitenancy_enable \
  --name my_tenant

Your cluster creates a tenant with the specified name and all of the cluster’s networks. It enables all management protocols for the tenant. The tenant also retains the same file system protocol configuration as when multitenancy was disabled.

Disabling Network Multitenancy by Using the qq CLI

Note
You can disable multitenancy on your Qumulo cluster if it has only one tenant.

To disable network multitenancy for your cluster, use the qq multitenancy disable command. The cluster:

Deletes the last tenant
Makes the SMB shares and NFS exports associated with this tenant available on all networks
Retains global settings and deletes tenant-specific settings

Creating, Configuring, and Unassigning Tenants by Using the qq CLI.

This section explains the lifecycle of working with tenants, including creating tenants, assigning networks to new and existing tenants, viewing tenant configuration, and unassigning tenants.

Step 1: Create a New Tenant

After you enable multitenancy for your cluster, you can create a new tenant.

Use the qq multitenancy_create_tenant command and specify a name for your tenant. For example:

$ qq multitenancy_create_tenant \
  --name my_tenant

Your cluster creates a new tenant with no networks assigned to it. By default, Qumulo Core disables access to the tenant through all protocols.

Step 2: Assign Networks to a Tenant

To allow a tenant to apply its configuration to clients that connect to the cluster from specific networks, you must associate the tenant with one or more networks. To do this, you can:

Create a new tenant with networks assigned to it.
Assign networks to, and unassign networks from, an existing tenant.
Move networks between tenants.

Creating a New Tenant with Assigned Networks

Use the qq multitenancy_create_tenant and specify the tenant name and network ID.

Important
The network must not be assigned to another tenant already.

In the following example, we specify a single network.

$ qq multitenancy_create_tenant \
  --name my_tenant_name \
  --network-id 2

Assigning a Single Network to an Existing Tenant

To assign a single network to a tenant, modify the tenant that belongs to the network. Use the qq network_mod_network command and specify the network and tenant ID.

$ qq network_mod_network \
  --network-id 3 \
  --tenant-id 2

Assigning Multiple Networks to an Existing Tenant

To assign multiple networks to a tenant, modify the networks that belong to the tenant. Use the qq multitenancy_modify_tenant command and specify the tenant and network ID.

Important
Any existing networks not specified after the --network-id flag become unassigned.

In the following example, we specify three networks.

$ qq multitenancy_modify_tenant \
  --id 2 \
  --network-id 2 3 4

Unassigning a Single Network from a Tenant

To unassign a single network from a tenant, clear the tenant that belongs to the network. Use the qq network_mod_network command and specify the network and the --clear-tenant-id flag.

Note
After you unassign a network from a tenant, you can assign it to another tenant.

$ qq network_mod_network \
  --network-id 3 \
  --clear-tenant-id

Unassigning All Networks from a Tenant

To unassign all networks from a tenant, clear the networks that belong to the tenant. Use the qq multitenancy_modify_tenant command and specify the tenant and network ID.

Note

After you unassign a network from a tenant, you can assign it to another tenant.
Don't specify any arguments for the --network-id flag.

$ qq multitenancy_modify_tenant \
  --id 2 \
  --network-id

Moving Networks between Tenants

Use the qq network_mod_network command and specify the network and target tenant.

$ qq network_mod_network \
  --network-id 2 \
  --tenant-id 1

Step 3: View Tenant Information

To determine a tenant’s network assignments and enabled management and file system protocols, you can view the tenant information.

Viewing Information for a Single Tenant

To view the information for a single tenant, use the qq multitenancy_get_tenants command.

$ qq multitenancy_get_tenant \
  --id 1

Viewing Information for All Tenants

In the Web UI, log in to Qumulo Core and then click Cluster > Network Multitenancy.
In the qq CLI, use the multitenancy_list_tenants command.

Determining the Tenant Assignment for Networks

To view the information for a single network, use the qq network_get_network command.
```
$ qq network_get_network \
  --network-id 2
```
To view the information for all networks, use the qq network_list_networks command.

Step 4: Delete a Tenant

Important

When you delete a tenant, Qumulo Core removes the tenant's entire configuration from your cluster, including NFS exports and SMB shares associated with the tenant.
It isn't possible to delete the last tenant. To do this you must disable network multitenancy.

To delete a tenant, use the qq multitenancy_delete_tenant command and specify the tenant ID.

$ qq multitenancy_delete_tenant \
  --id 2

Known Network Multitenancy Limitations in Qumulo Core

Currently, Qumulo Core doesn’t support:

Using network multitenancy with cloud-based clusters
Using one VLAN on multiple tenants
Using a separate Active Directory, standalone LDAP, or user-defined mapping configuration for each tenant
Using a separate DNS configuration for each tenant
Scoping RBAC privileges to each tenant