Skip to main content

Datastore Installation

Please note that the Data On-Premise feature is only available on the Enterprise plan. Contact us to enable the Data On-Premise feature for your organization.

Follow these installation instructions to deploy the Datastore in your environment, either on Kubernetes or Docker.

These instructions were written under the assumption that an ETL Controller is already up and running.


There are two ways to deploy the Datastore on Kubernetes.

Install using Helm

To install our Helm chart, execute according to your Helm version:

helm repo add rookout
helm repo update
helm install --name my-datastore rookout/datastore --set datastore.token=[Your Rookout Token]

Install without Helm

If you're not using Helm with your Kubernetes cluster, you'll still be able to deploy the Datastore.

Helm is needed to be installed locally (Helm) to create the yaml file from the templates.

First, Clone our Helm charts repository and go to the directory called "charts/datastore".

Next, execute according to your Helm version:

helm template --name my-datastore . --set datastore.token=[Your Rookout Token] > rookout-datastore.yaml

This command should create a file called "rookout-datastore.yaml" including the Kubernetes deployment and service configuration.

To apply the configuration, execute:

kubectl apply -f rookout-datastore.yaml


To deploy the Datastore as a Docker container (using this image), execute the following:

docker run -p 8080:8080 -e "ROOKOUT_DOP_SERVER_MODE=PLAIN" -e "ROOKOUT_TOKEN=[Your Rookout Token]" rookout/data-on-prem

Next Steps

The instructions above describe the deployment process of the Datastore with the most basic configuration.

Using the Datastore requires setting up a TLS termination proxy (recommended) or providing it with a TLS certificate for encryption purposes.

To configure the Rookout app to use the datastore, go to the "Setup" page in the settings menu and check the "Enable On-Prem Datastore component" box. Then, enter the URL for the Datastore in the text boxes, and click "Test" to test the connection.

The first URL is called "Datastore URL accessible from user's browser" which should start with https:// followed by the domain name of the datastore that is accessible from the user's computers.

The second URL is called "Datastore URL accessible from the Rookout Controller". It should start with http:// or https://, depending on the type of the connection between the ETL Controller and the Datastore.

To further configure your Datastore installation:

  • Kubernetes - add configuration values using the helm upgrade or helm install commands (using the values.yaml file or the --set parameter).
  • Docker - add configuration values as environment variables using the -e flag to the docker run command.

Read more about encryption, and all other configuration values here.