Install a flow runtime using Docker-compose

Prerequisites

You have a platform that supports the minimum requirements:

• Docker is installed

• Docker Compose is installed

1. Install a flow runtime using Docker-compose

Log in to https://registry.flows.connect.aveva.com/

Open a terminal and enter:

[sudo] docker login https://registry.flows.connect.aveva.com/

When prompted, enter the username and password.

If necesary, to find the username and password:

1. Navigate to the Docker Credentials section.

2. Select the settings icon.

3. From the flow runtime page select the Register flow runtime tab.

   2. Get docker-compose.ymlo use docker-compose a configuration file is needed. Download the file docker-compose.yml into a local folder, or copy the content below into a docker-compose.yml.

   services:

   :

   container_name: CONNECT-Flows

   restart: always

   environment:

   - SecurityConfiguration__Credentials__NodeId=ENTER-YOUR-NODEID-HERE

   - SecurityConfiguration__Credentials__AccessKey=ENTER-YOUR-ACCESS-KEY-HERE

   #Increase log level (optional)

   #- EdgeNodeConfiguration__LogLevel=Debug

   ports:

   - 9090:9090

   - 9191:9191

   - 1883:1883

   volumes:

   - "./data:/application/data"

   #Map certificate bundle from host (optional)

   #- "/etc/ssl/certs/ca-certificates.crt:/etc/ssl/certs/ca-certificates.crt:ro"

   logging:

   driver: json-file

   options:

   max-size: "50m"

   max-file: "2"

3. Set credentials

3.1 With NodeId and AccessKey

Replace ENTER-YOUR-NODEID-HERE and ENTER-YOUR-ACCESS-KEY-HERE in your docker-compose.yml file with the values received when registering the flow runtime above.

3.2 With Global key (only for mass deployment)

In the docker-compose.yml file replace these two lines:

- SecurityConfiguration__Credentials__NodeId=ENTER-YOUR-NODEID-HERE

- SecurityConfiguration__Credentials__AccessKey=ENTER-YOUR-ACCESS-KEY-HERE

with these lines:

- SecurityConfiguration__Registration__Key=ENTER-YOUR-GLOBAL-KEY-HERE

- SecurityConfiguration__Registration__Name=UNIQUE-NAME-HERE

Then replace ENTER-YOUR-GLOBAL-KEY-HERE with the global registration key you, or your administrator, generated and replace UNIQUE-NAME-HERE with the name required for the flow runtime

Note: Only alphanumeric characters and underscore are allowed in flow runtime names).

4. Star the flow runtime

Run this command from the folder where the docker-compose.yml was created.

[sudo] docker-compose up -d

The flow runtime downloads from the docker registry and starts.

5. Error check

4. Validate that a green checkmark appears next to the Flow runtime on the Nodes or Dashboard pages.

5. If no errors are reported, then the flow runtime is successfuly running and connected to Flow manager.

6. Next, build and deploy some flows on the new flow runtime.