Install on a Kubernetes cluster using Helm charts

Install Datalore

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. Create a Kubernetes secret for storing the database password securely. See Use Kubernetes native secrets for storing a database password for further guidance.

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).

   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.24

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.

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"

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.

   

Run Datalore in a non-default namespace

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.24

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> instances: ...

   Find more details about configuring agents in this topic

3. Under dataloreEnv in datalore.values.yaml, you can 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.

Use an external postgres database

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 an email whitelist

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.