Install on a Kubernetes cluster using Helm charts

Step 1. Add the Datalore Helm repository

To add the repository, run the following command:

Step 2. Start configuring deployment

1. Create a datalore.values.yaml file.

2. Add the Datalore domain by adding the following parameter to datalore.values.yaml:

   dataloreEnv: ... # Make sure the URL doesn't have a trailing slash DATALORE_PUBLIC_URL: "<url>"

   Replace <url> with the desired URL.

3. Datalore requires at least two volumes to store the files attached to notebooks and outputs that notebooks produce.

   To configure volumes, add the following parameters to datalore.values.yaml:

   volumeClaimTemplates: - metadata: name: storage spec: accessModes: - ReadWriteOnce resources: requests: storage: 120Gi - metadata: name: postgresql-data spec: accessModes: - ReadWriteOnce resources: requests: storage: 10Gi

Step 3. Create a Kubernetes secret for the database password

To create a Kubernetes secret for storing the database password in a secure way:

1. Generate the password and store it in the Kubernetes secret, as described below. The pwgen tool is used here as an example. You can use any other tool or method to generate a password.

   PASSWORD=$(pwgen -N1 -y 32) kubectl create secret generic datalore-db-password --from-literal=DATALORE_DB_PASSWORD="$PASSWORD"

2. Modify (or add, if not present yet) the databaseSecret block in your datalore.values.yaml as follows:

   databaseSecret: create: false name: datalore-db-password key: DATALORE_DB_PASSWORD

   The value of the name value is referring to a secret name defined at the previous step, while the key value is referring to the key within the secret that contains the password.

3. (Optional) If you are moving from plain text password storage to the secret reference: remove the password key with its value from the databaseSecret block.

Step 4. (Optional) Use an external Postgres database

Datalore requires a PostgreSQL database (version 15 or higher). The default Helm chart that deploys Datalore also provisions a single-instance PostgreSQL database.

If you want to use an external database, take the following steps:

1. Deploy a Postgres database (version 15 or higher), create a database user, and get the connection string.

2. Add the internalDatabase parameter to datalore.values.yaml:

   internalDatabase: false

3. Add the database user and connection string in the dataloreEnv block as follows:

   dataloreEnv: ... DB_USER: <database_user> DB_URL: "jdbc:postgresql://<database_host>:<database_port>/<database_name>"

Step 5. (Optional) Enable an email allowlist

You can enable an allowlist for new user registration so that only users with email addresses included in the allowlist can register.

To do this, add the following parameter to datalore.values.yaml:

The Email allowlist tab will be available in the Admin panel. For more details, see Restrict registration with Email allowlist.

Step 6. (Optional) Enable user filtration based on Hub group membership

By default, all Hub users can get registered unless you disable registration in the Admin panel.

If you want to grant Datalore access only to members of a specific Hub group, add the following parameter to datalore.values.yaml:

Step 7. Deploy Datalore

Step 8. Expose Datalore

1. To route traffic to Datalore, configure Ingress.

2. (Optional, recommended) If you use a reverse proxy, enable Gzip compression by following these instructions.

Step 9. Add your Datalore license

1. Open the URL you earlier specified in DATALORE_PUBLIC_URL and register as a new user. This first user automatically receives the Super Admin role.

2. Add your license. To do this, click your avatar at the top right, select Admin panel | License, and provide your license key.

   For more information about Datalore licensing, see Manage licenses.

   

Required configuration steps

1. Configure agents: Customize how your agents work to manage your computational resources.

2. Enable GPU machines: Enable GPU machines in your installation.

3. Manage users: Create and manage users and viewers.

4. Configure plans: Customize resource usage among your Datalore users.

Optional configuration steps

• Set up JetBrains Hub: Integrate an authentication service.

• Customize or update environment: Build custom images tailored for your needs.

• Enable gift codes: Activate the service for generating and processing gift codes.

• Enable the email service: Activate email notifications.

• Enable audit logging: Turn on extended activity logging for Datalore users.