Register a Data Plane

Before registering a Data Plane in Domino, you need to install a Data Plane.

Note

A new method for registering Data Planes is available from 6.1. This documentation describes how to use the new method, which is available if the Feature Flag ShortLived.HybridSuppressHelm is set to true. If this Feature Flag is set to false, please reference the 6.0 docs for the steps to Register a Data Plane. Reach out to the Domino Support team with any questions or for assistance in migrating to this new process.

Follow these steps to register a Data Plane:

  1. Configuration.

  2. Register a Data Plane in Domino UI.

  3. Generate a Data Plane Token.

  4. Run the bootstrap script.

1. Configuration

Validate that the required Data Plane configuration records are set.

The required configuration records are auto-populated for hybrid-enabled control planes deployed.

2. Register Data Plane in Domino UI

  1. In the admin portal, go to Manage resources > Data Planes > Register Data Plane.

  2. Enter the details for the new data plane:

    • Name - An arbitrary, human-readable name for the data plane.

    • Namespace - The Kubernetes namespace where you want to install the data plane in the data plane cluster. This namespace will be created if it does not already exist.

    • Storage Class - The Kubernetes StorageClass name to use for execution volumes in this data plane. If blank, it will default to the control plane’s storage class specified by com.cerebro.domino.computegrid.kubernetes.volume.storageClass in the Configuration records (default: dominodisk).

    • Data Plane Hostname - The subdomain component of the DNS name used for the data plane. For example, if the control plane is example.com and the data plane is dp.example.com, then you would enter dp here. You can also append : and a custom port number if your data plane load balancer runs on a port other than 443. See Enable a data plane for Workspaces.

    • Advanced:

      • Disable File Sync - Disable DFS file sync in this data plane.

      • Enable Istio - Indicate that Istio is running in this data plane’s cluster. This setting must be set for data planes with Istio; it is not sufficient to set the Helm value.

      • Override S3 Endpoint URL - Override the default S3 endpoint URL for this data plane.

  3. Click Done.

3. Generate a Data Plane token

When data plane registration is complete, you will need to create a token:

  1. In the Admin Portal, go to Manage Resources > Data Planes.

  2. In the Actions column, click Setup for the Data Plane you’d like to register.

  3. In the window, click Load bootstrap token.

  4. Once that loads, click Copy token.

Note

The token generated above is only valid for 10 minutes.

If you exceed the 10 minute window, you’ll need to load a new token through the same steps.

4. Run the bootstrap script

  1. Make sure that your default Kubernetes context is the cluster in which you want to deploy the data plane.

  2. Obtain Kubernetes context of the Data Plane:

    tsh login && tsh kube login <dp-deploy-id>

  3. Download the bootsrap-data-plane.sh script from GitHub and save it as an executable file.

    curl -Sso bootstrap-data-plane.sh \
  https://raw.githubusercontent.com/dominodatalab/nexus/refs/heads/main/bootstrap-data-plane.sh && \
  chmod +x bootstrap-data-plane.sh

  4. Execute the bootstrap script with the following command. Replace <token> with the token you copied earlier:

    ./bootstrap-data-plane.sh <token>

    The script will report creation of a secret and exit. In the Domino Admin UI, the data plane should become healthy within a couple of minutes.