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.

3. In datalore.values.yaml, add a databaseSecret parameter to set up your database password. A random string is advised.

   databaseSecret:
     password: xxxx

4. Configure your volumes. In datalore.values.yaml, add the following parameters:

   volumes:
    - name: storage
      ...
    - name: postgresql-data
      ...

   where:

   • storage: contains workbook data, such as attached files (UID:GID 5000:5000).

   • postgresql-data: contains PostgreSQL database data (UID:GID 999:999).

   note

   Important

   Make sure that you back up the content of the storage and postgresql-data volumes regularly.

   Below are exemplary procedures of configuring your volumes:

   Configure hostPath volumes

   1. Create directories:

      mkdir -p /data/postgresql
      mkdir -p /data/datalore
      chown 999:999 /data/postgresql
      chown 5000:5000 /data/datalore

   2. Add to datalore.values.yaml:

      volumes:
        - name: postgresql-data
          hostPath:
            path: /data/postgresql
            type: Directory
        - name: storage
          hostPath:
            path: /data/datalore
            type: Directory

   Use volumeClaimTemplates

   If you set up volume auto-provisioning in Kubernetes, you can replace volumes with volumeClaimTemplates.

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

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

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

   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.

   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.

6. Go to http://127.0.0.1:8080/ 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.

7. To access Datalore by a domain other than 127.0.0.1, add a URL with this host as the DATALORE_PUBLIC_URL parameter in the datalore.values.yaml file.

   For example, if you want to use the https://datalore.yourcompany.com domain, add the following:

   dataloreEnv:
     ...
     DATALORE_PUBLIC_URL: "https://datalore.yourcompany.com"

   tip

   • Make sure the URL does not contain a trailing slash.

   • You will need to configure your DNS yourself.

8. Click your avatar in the upper-right corner, select Admin panel | License and provide your license key.

   

1. When running Datalore, specify the namespace:

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

2. (Optional) If you use a custom config, add the namespace under the agentsConfig key as shown in the code below:

   k8s:
     namespace: <non_default_namespace>
     instances:
       ...

1. Add two variables under dataloreEnv: database user and database URL.

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

2. Set internalDatabase to false.

Enable a whitelist for new user registration. Only users with emails entered to the whitelist can be registered. The respective tab will be available on the Admin panel.

1. Open the values.yaml file.

2. Add the following parameter:

   dataloreEnv:
     ...
     EMAIL_ALLOWLIST_ENABLED = TRUE

The respective tab will become available on the Admin panel.