About Domino
Domino Data LabKnowledge BaseData Science BlogTraining

Installation overview

Note

This topic is a basic outline of the Domino installation process.

If you need platform-specific instructions, see the following:

Use fleetcommand-agent to install Domino. fleetcommand-agent is a Python-based automation tool that runs inside a Docker container. Since Domino runs on Kubernetes, fleetcommand-agent uses Helm to deploy Domino into a compatible cluster. You can run fleetcommand-agent locally or as a job in the target cluster.

install diagram

Domino recommends that you use the streamlined domino.yaml files to complete your Domino install. These are configuration files that ease the Domino deployment process. domino.yaml provides a streamlined experience, while domino-full.yaml includes the default fields for advanced configuration. See Streamlined domino.yaml Downloads for more information and a complete list of downloads for supported Kubernetes distributions and cloud platforms.

Requirements

The install automation tools are delivered as a Docker image, and must run on an installation workstation that meets the following requirements:

  • Docker installed.

  • Kubectl service account access to the cluster.

  • Access to download and install Helm through package manager or GitHub.

  • Access to quay.io and credentials for an installation service account with access to the Domino installer image and upstream image repositories. Throughout these instructions, these credentials will be referred to as $QUAY_USERNAME and $QUAY_PASSWORD. Contact your Domino account team if you need new credentials.

Install Domino

  1. Confirm that your workstation fulfills the installation requirements.

  2. If you haven’t done so already, pull the fleetcommand-agent image.

  3. Access the default entrypoint for fleetcommand-agent:

    "Entrypoint": [ "python", "-m", "fleetcommand_agent"]

    This command launches fleetcommand-agent inside the container at /app/fleetcommand_agent. You can access fleetcommand-agent and run commands through docker run:

    docker run --rm quay.io/domino/fleetcommand-agent:v65 $COMMAND $ARGUMENTS

Install process

Important
Note

  1. Connect to a workstation that meets the installation automation requirements listed previously. You do not have to use an account with root privileges to run the installer.

  2. Log in to quay.io with the credentials described in the previous requirements section.

    docker login quay.io

  3. Retrieve the Domino installer image from quay.io.

    docker pull quay.io/domino/fleetcommand-agent:v65

  4. To generate a template configuration file named domino.yml, initialize the installer.

    docker run --rm -it -v $(pwd):/install quay.io/domino/fleetcommand-agent:v65 \
init --file /install/domino.yml

  5. Edit the configuration file with details about the target cluster, storage systems, and host domain. Read the configuration reference for more information about available keys, and consult the configuration examples for guidance about how to get started.

    Update the helm image registry section of your configuration to include your qauy.io credentials.

  6. To install Domino, download the fleetcommand-agent-install.sh script.

  7. Run the fleetcommand-agent-install.sh script from the same directory as the configuration file while specifying the version of Domino you want to install. For example: fleetcommand-agent-install.sh 5.7.0

  8. Installation can take up to 30 minutes to fully complete. The installer will output verbose logs and surface any errors it encounters, but it can also be useful to follow along in another terminal tab by running:

    kubectl get pods --all-namespaces

    This will show the status of all pods created by the installer. If you see a pod enter a crash loop or hang in a non-ready state, you can view the pod’s log:

    kubectl logs $POD_NAME --namespace $NAMESPACE_NAME

    Upon successful installation, the following message appears:

    <timestamp> INFO - fleetcommand_agent.Application - Deployment complete.
Domino is accessible at $YOUR_FQDN

You can now access the application through HTTPS if you configure DNS for your fully-qualified domain name (FQDN) to point to an Ingress load balancer with the appropriate SSL certificates. The load balancer forwards traffic to your platform nodes.

Enable user registration

Use Keycloak to enable user registration, so users can access your fresh Domino install. Keycloak is a user authentication service that runs on a pod in your cluster.