Requirements
Datavault Builder is shipped as a set of docker images. The application is accessible via a webbased frontend. The backend then directly connects to your target database, where the data warehouse lives on.
For the setup, therefore the following requirements have to be fullfilled.
Client
- Chromium based browser to access the frontend
The graphical user interface is fine tuned for Chromium Based Browser (e.g. Google Chrome, MS Edge) and will refuse a login using any other browser.
Host
To deploy docker images for backend.
Hint
The Datavault Builder can be installed on any system capable of running docker images (e.g. also kubernetes cluster).
The following specification is based on a setup using a docker host and docker compose to deploy.
- Hardware (depending on host type):
Disk: 50 GB
Hint
Additionally you will need more disk space, memory and cpu if you run your database as well as container. Please refer to the minimal requirements for your database to the database manufacturer. A rough approximation rule: Required Database Disk Space = 4 * Sourcedata-Diskspace
Memory: 16-32 GB
CPU: 4-8 x86_64 Cores
Warning
ARM CPU architecture is not supported, make sure your host runs on x86_64.
- OS
Preferably Ubuntu (LTS 22.04)
But can be any of the Linux based OS supported by Docker https://docs.docker.com/engine/install/
- Software (depending on chosen deployment type):
Docker: min 20.10.13+
Docker Compose Plugin: min 2.3.3+
Optional: Python (only used during the install for setting up Snowflake)
- Networking
Open port 80/443 for frontend
Docker Repository access to docker.datavault-builder.com to download the docker images.
SSH-access (e.g. Port 22) to configure the environment for the install.
Database access to communicate with the target database (e.g. Postgres, MS SQL, Exasol, Oracle, Snowflake)
Data source access to communicate with the source systems to extract and load data from.
Hint
For a list with a current overview of supported Environments for docker please visit: https://docs.docker.com/engine/install/
Target database
Is where your dwh lives. Since Datavault Builder does not generate some generic SQL Code, but statements adjusted for the used target database, only a set of defined targets are supported.
- General
Collation: Case-Sensitive
Empty database, preferably called “datavaultbuilder”
Make sure to set the timezone to the same as the Datavault Builder
Sizing: A rough approximation rule: Required Database Disk Space = 4 * Sourcedata-Diskspace
Network: Access to this database from your preferred consuming application (e.g. Reporting tool).
Furthermore, please respect the following tested minimal versions and configurations:
Oracle
Min. Version: 12.2
User with admin rights
Grants to initially create SYS-Triggers
3*2 GB Redo-Log
2 GB Undo-Log
max_string_size = extended (recommended)
MS SQL
Min. Version: 2017
Collation: SQL_Latin1_General_CP1_CS_AS
Login databaseowner user
Login
authenticator
(does not need specific grants)Compatibility level 140 or higher:
EXEC dbo.sp_dbcmptlevel @DB, 140
Set Recovery mode to simple unless taking care of backing up transaction logs:
ALTER DATABASE [DB_NAME] SET RECOVERY SIMPLE;
MS Azure SQL database
Login databaseowner user
Collation: SQL_Latin1_General_CP1_CS_AS
Login
authenticator
(does not need specific grants)
Synapse (Dedicated SQL Pool)
Login databaseowner user
Collation: SQL_Latin1_General_CP1_CS_AS
Min. Warehouse: DW200c
EXASOL
Min Version: 6.2.7
Postgres
Min. Version: 9.6
ENCODING = ‘UTF8’
Must be compiled with
NAMEDATALEN >= 128
(contact us for more information)Must be compiled with extionsions (since we need the pgcrypto extension):
make world make install-world
- Needs the 3rd party extension ‘set_user’
Compile instructions are in the git repo descriptions https://github.com/pgaudit/set_user#compile-and-install
Change this config parameter in postgresql.conf
shared_preload_libraries = 'plpgsql,set_user'
User
dbadmin
must be database owner of database (datavaultbuilder by default, but can be different):CREATE ROLE dbadmin SUPERUSER CREATEROLE REPLICATION LOGIN; ALTER DATABASE datavaultbuilder OWNER TO dbadmin;
Snowflake
Only required for the install: User with permissions to create database, database objects, users and user roles. The user must have the following privileges:
USE ROLE ACCOUNTADMIN; USE ROLE SYSADMIN;
Hint
When using the Datavault Builder, by default for the client-database as well a containerized version is started up (if available). Nevertheless, if you would like you can as well connect to a separate instance of your database.
Note
Please feel free to contact us for the support of other versions.