Requirements

Hardware requirements

You can distinguish the requirements for beVault part (metavault, states and workers) and the data part (database) and their sizing should be directly related to your usage :

• CPU : depends on the maximum number of users connected at the same time, whether all services are hosted on the same server, the complexity of the information mart scripts, …

• Memory : depends on the size of all data that will be processed by beVault

• Storage : a typical installation uses around 2GB, but additional space for the database and sources files should be planned

For single project where all beVault services are hosted on the same server but the database is another one, our recommendation and typical configuration is :

• CPU : 2 vCore

• Memory : 4 Gb of RAM

• Storage : 20 Gb SSD

Of course our support team could help you estimate the right sizing according to your data and future usage.

Software requirements

beVault product rely on the docker engine and docker compose orchestrator. We strongly recommend to use at least docker version 23.0.6 to be able to use docker compose as a docker plugin and do not specify a version in the docker compose file.

Please refer to the official documentation to know how to install and exploit Docker in your environment.

The application is container-based and so should be compatible with other alternatives :

• Other container engine (Podman, …)

• Other container orchestrator (Kubernetes, OpenShift, Hashicorp Nomad, …)

• Specific cloud provider solutions (Azure App services, Amazon ECS, …)

Access requirements

All beVault container images are hosted on the official Quay.io registry, we don’t use any other registry. To be able to retrieve and use beVault packages, you will need to have access to this registry by contacting dFakto support who will provide you dedicated credentials. After that, you must activate access to this registry, for example if you use docker, by executing the following command on your target environment

docker login quay.io

External solution requirements

DNS

To be able to reach all beVault components, you will need to have 2 DNS that resolve the nodes where you will install the stack.

For example:

• beVault.example.com → resolves to the metavault server

• orcheestrator.example.com → resolves to the states server

Identity provider

beVault does not support built-in authentication but rely on the OpenId Connect protocol (OIDC) + Proof Key for Code Exchange (PKCE) flow to manage authentication. See dedicated section for more information about the expected configuration for some Identity provider solutions.

Database server

beVault needs at least one target database server to manage data and deploy the data warehouse. See dedicated section for more information about expected configuration depending on the database type.

Redis

A redis server is required by the States component to manage queue & cache data.

Post deployment requirements

Once beVault is deployed, a licence is required in for the metavault component. dFakto can provide you a licence based on a installation id that you can retrieve once connected.