Before registering a Data Plane in Domino, you need to have a Data Plane installed. Contact your Domino Admin if you need help with this.
Follow these steps to register a Data Plane:
-
In the admin portal, go to Manage resources > Data Planes > Register Data Plane.
-
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 the
com.cerebro.domino.computegrid.kubernetes.volume.storageClass
configuration record (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 isdp.example.com
, then you would enterdp
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.
-
-
-
Click Done.
When data plane registration is complete, you will need to create a token:
-
In the Admin Portal, go to Manage Resources > Data Planes.
-
In the Actions column, click Setup for the Data Plane you’d like to register.
-
In the next window, click Load bootstrap token.
-
Once the token 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. |
-
Make sure that your default Kubernetes context is the cluster in which you want to deploy the data plane.
-
Obtain Kubernetes context of the Data Plane:
tsh login && tsh kube login <dp-deploy-id>
-
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
-
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.