Install on a Kubernetes cluster using Helm charts

1. Add the Datalore Helm repository:

   helm repo add datalore https://jetbrains.github.io/datalore-configs/charts

2. Create a datalore.values.yaml file. This file will be used later as a source of truth for the Datalore configuration. Therefore, we advise to put this file under the version control.

   Add the dataloreEnv block to the file as follows, replacing the value between the quotes with the actual endpoint you're planning to access Datalore with.

   dataloreEnv:
     DATALORE_PUBLIC_URL: "...."

   tip

   Make sure the URL does not contain a trailing slash.

3. Create a Kubernetes secret for storing the database password securely.

   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.

      tip

      If, for any reason, you do not want to create a secret manually, you may specify the password in the Helm config file. In this case, the secret will be provisioned automatically - but keep in mind that the password will be stored in plain text in your configuration file.

      In that scenario, adjust the databaseSecret block in datalore.values.yaml, as follows:

      databaseSecret:
        create: true
        password: xxxx

   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.

   4. Proceed based on whether this is your fresh deployment or Datalore is already installed.

      Fresh deployment

      Datalore is already installed

      Proceed with the installation. No further action is required.

      Apply the configuration

      warning

      If you proceed with this step, the Datalore server will restart.

      helm upgrade --install -f datalore.values.yaml datalore datalore/datalore --version 0.2.28

4. Datalore requires a PostgreSQL database (with a version no lower than Postgres 15) to operate.

   If you want to use the built-in Postgres database shipped with Datalore, skip this step, as by default, the Helm chart used for Datalore's deployment provisions a single-instance PostgreSQL database.

   However, if you want to use an externally-configured database, add a new parameter in datalore.values.yaml as follows:

   internalDatabase: false

   Additionally, the database connection string should be specified explicitly by adjusting the dataloreEnv block defined previously, as follows:

   dataloreEnv:
     # any other previously defined parameters
     DB_USER: "<database_user>"
     DB_URL: "jdbc:postgresql://[database_host]:[database_port]/[database_name]"

   note

   It is also possible to use a custom JDBC driver to connect to Datalore's database. See Using custom Postgres driver for further guidance.

5. Datalore requires at least two Kubernetes persistent volumes for its operation. These volumes will be used to store the attached files of the notebooks and all other outputs produced by the notebooks.

   In datalore.values.yaml, add the following parameters:

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

6. Run the following command and wait for Datalore to start up:

   helm install -f datalore.values.yaml datalore datalore/datalore --version 0.2.28

   note

   Important

   You can run kubectl port-forward svc/datalore 8080 to test if Datalore can start up. However, to make it accessible, make sure you configure ingress and install the corresponding ingress controller prior to Datalore deployment.

   Below is a plain http ingress setup example:

   ingress:
     enabled: true
     hosts:
       - host: datalore.mycompany.com
         paths:
           - path: /
             pathType: Prefix

   Also, when using ingress, use this annotation to adjust file size in your configuration.

7. Go to URL defined at the first step, and sign up the first user. The first signed-up user will automatically receive admin rights.

   tip

   Unless the email service is configured, there is no registration confirmation. You can log in right after providing the credentials.

8. Once logged in, the license should be installed. Click your avatar in the upper right corner, select Admin panel | License and provide your license key.

   For more information about Datalore licensing, see this article

   

1. To deploy the Datalore server into a non-default namespace, run the following command:

   helm install -n <non_default_namespace> -f datalore.values.yaml datalore datalore/datalore --version 0.2.28

2. To specify the non-default namespace for your agents configs, define the namespace variable in datalore.values.yaml as shown in the code block below:

   agentsConfig:
     k8s:
       namespace: <non_default_namespace_name>
       instances:
           ...

   Find more details about configuring agents in this topic

3. Under dataloreEnv in datalore.values.yaml, define the following variables:

   Name	Type	Default value	Description
   DATABASES_K8S_NAMESPACE	String	default	K8s namespace where all database connector pods will be spawned.
   GIT_TASK_K8S_NAMESPACE	String	default	K8s namespace where all Git-related task pods will be spawned.

   Find the full list of customized server configuration options in this topic.

Enable a whitelist for new user registration. Only users with emails entered to the whitelist can be registered.

1. Open the values.yaml file.

2. Add the following parameter:

   dataloreEnv:
     ...
     EMAIL_ALLOWLIST_ENABLED: "true"

The respective tab will be available on the Admin panel.