datavirtuality/dvserver repository overview

⁠CData Virtuality Platform

⁠Quick Reference:

CData Virtuality platform documentation:

https://docs.datavirtuality.com⁠

⁠How to use this image:

Although the CData Virtuality Platform image can run without any volumes attached or ports exposed, it is strongly recommended to attach a volume so that Data Virtuality Platform is able to persist needed data. All the data the platforms has to keep is concentrated in /opt/datavirtuality/dvserver/standalone internal folder, so it should be bound to an external volume. In addition, it is also recommended to expose platform ports to have a possibility to communicate with the platform. It is listening on the ports below:

8080/tcp	- plain HTTP for server REST API
31000/tcp 	- plain JDBC
31001/tcp	- SSL JDBC
35432/tcp	- plain ODBC
35433/tcp	- SSL ODBC

A single JDBC port is sufficient to be able to manage the platform with the desktop client, so the minimum recommended run command to start the image is:

docker run --name dvserver --detach -p 31000:31000 datavirtuality/dvserver:<TAG>

TAG here stands for a particular version you'd like to run.

With this minimal command DVServer will be storing all its data inside the container and this data may be lost when the container is removed. So it's a good practice to mount an external volume to the container to store the data outside of the container. This can be done using either way docker (or another container engine) supports:

https://docs.docker.com/engine/storage/⁠

The external volume must be mapped to /opt/datavirtuality/dvserver/standalone directory inside the container so that DVServer is able to store all the needed data. For example, with standard bind volume it can be site like this:

docker run --name dvserver --detach -p 31000:31000 -v <OS PATH>:/opt/datavirtuality/dvserver/standalone datavirtuality/dvserver:4.11

Note, however, that direct filesystem path use may not behave correctly on Windows, so it's better to use either pre-created volume (created by docker volume create command) or another storage faciity.

CData Virtuality Platform relies upon PostgreSQL Database as an internal configuration database. The image already contains an embedded PostgreSQL database, and if no external database set, the platform will use embedded one. In this case, the database files are being stored in 'pgsql' directory on the attached volume. It is also possible to use an external PostgreSQL database v.9 - v.17.4, the following environment variables must be set in the container:

DVCONFIG_HOST	- IP address or DNS name of the database server
DVCONFIG_PORT	- port the server is listening to
DVCONFIG_DB	- database name
DVCONFIG_USR	- username for the connection
DVCONFIG_PWD	- user's password
DVCONFIG_SCHEMA	- schema