Deployment principles

Prerequisites

Sufficient resources, as described in the previous chapter, to run the to run the solution.

A valid deployment key to log into the Adobis docker registry, in order to retrieve the DataChain © docker images.

The application is deployed using a docker-compose file, which is used to configure the modules to be deployed and their parameters.

In the following chapters, we provide deployment examples, enabling you to deploy the solution in the configuration best suited to your needs.

The examples can be downloaded in zip format.

Each example comprises at least :

a config directory containing the configuration used for the example,
a scripts directory containing startup, shutdown and initialization user insertion scripts (minimal scripts)
a directory for each docker stack used in the example (e.g. datachain, keycloak, etc.).

Three scripts are systematically present:

up.sh, which starts the program and takes as its parameter
- parameter -s (for stack name): example, from a directory 0X.example, which contains a datachain stack:

$ bash scripts/up.sh -s datachain

parameter -d (to display the docker-compose file actually used by docker stack)
- down.sh which allows to stop and takes as parameter
parameter -s (for stack name): example, from a directory 0X.example, which contains a datachain stack:

$ bash scripts/down.sh -s datachain

insert_first_admin.sh to insert a first datachain administrator user (admin/changeIt): example, when the datachain stack has been started, from a 0X.example directory:

$ bash scripts/insert_first_admin.sh

In general, for stacks, the list of files will be as follows:

docker-compose.yml: The docker swarm deployment descriptor for the stack.
one or more env files:
- backend.env: minimum configuration of the backend service
- spark.env: minimum spark configuration
- web_ui.env: minimum web-ui configuration
- keycloak.env: minimum keycloak configuration