It is possible to have a tenant adopt a storage domain so it can be accessed through the Content Portal if the storage domain is created outside the Content Management API (such as a replication cluster). There is a special variation to the domain adoption procedure, noted below if that storage domain was created with Swarm's legacy auth/auth.

Verify the following for domain adoption:

• The tenant exists.

• The cluster administrator executes these actions directly against the storage cluster and not through the Gateway.

To Adopt a Domain

1. Retrieve all custom metadata attached to the domain.

2. Update the domain providing all custom metadata and an x-tenant-meta-name header.

This is an example of the commands. The strings {tenant} and {domain} are substituted for the actual tenant name and storage domain name.

The first step is to retrieve all current, custom metadata name/value pairs for the domain:

There is a Castor-Authorization header in the response or a "401 Unauthorized" response to the previous request may be received if the domain has Swarm's legacy auth/auth on it. See the section below for instructions to remove the legacy auth/auth.

Certain field names are valid as custom metadata. In general, use Castor-* (except for Castor-System-*), Content-*, X-*-Meta, and X-*-Meta-* headers in the HEAD response as custom metadata for the storage domain. With the exception of Castor-Authorization, these are the fields to preserve.

For details about headers, see https://perifery.atlassian.net/wiki/spaces/public/pages/2443820996 and https://perifery.atlassian.net/wiki/spaces/public/pages/2443821408.

Use the COPY request to replace all object metadata in the storage domain and include the adoptive tenant's name after retrieving all custom metadata name/value pairs (denoted as {mdName#} and {mdValue#}) from the HEAD request:

The x-tenant-meta-name must match the name of an existing tenant created through the Gateway Management API or Content Portal.

Upon completion of the domain adoption procedure, the storage domain is now subject to the tenant access control policy in addition to the root and domain policies. The storage domain switches to using the tenant IDSYS rather than the root IDSYS if the storage domain does not define a separate IDSYS, was previously using the root IDSYS, and the adoptive tenant defines an IDSYS.

Removing Legacy Auth/Auth

Legacy auth/auth needs to be removed so the domain can be used correctly through Gateway if the storage domain has legacy auth/auth on it. These examples use the curl command line utility since it is able to perform HTTP digest authentication. These examples can be adapted for use with another tool or library to issue the HEAD and COPY commands. Since this process is very similar to the previous one for domains without legacy auth/auth, references are made to the instructions from the previous section. The {adminUser} username in these examples must be for one of the Swarm administrators defined in the storage cluster's configuration. The {storageNode} string is the host or IP for any node in the storage cluster.

Get the current metadata for the storage domain.

All custom metadata name/value pairs are needed with the exception of the Castor-Authorization header.

The previously described COPY request is performed using HTTP digest authentication.

All prior discussion about the x-tenant-meta-name value and post-creation domain behavior apply.