To setup a permanent instance of an LRGS do the following, replace --name lrgs with a name
appropriate to your installation.
docker create volume lrgs_volume
docker run -d name lrgs -p 16003:16003 -v lrgs_volume:/lrgs_home -e LRGS_ADMIN_PASSWORD="the password you want" lrgs:latest
16003 is the DDS protocol Port that the gui rtstat application can use. At this time there is no API and this is required for later configuration.
There are additional input sources, and the ability to add additional custom input sources that may require you to
expose additional ports.
| Variable | Default | Description |
|---|---|---|
| LRGSHOME | /lrgs_home | location of primary files and output. |
| LRGS_ADMIN_PASSWORD | Admin password to use. If not set will be randomly generated and printed to console |
The following containers support automated processing. The computation containers, that start with 'comp' require using one of the SQL databases.
| Container | Purpose |
|---|---|
| compdepends | Determines which data inputs trigger computations. |
| compproc | Handles computation |
| routingscheduler | Can pull data from an LRGS or other data source and push to the database or other locations |
The above containers are the same except that the default APPLICATION_NAME and CMD are to match the default purpose.
The migration container supports all of the below items as well as additional values to support the various flyway operations. DATABASE_USER and DATABASE_PASSWORD are replaced by the 4 entries described below.
| Variable | Default | Description |
|---|---|---|
| MIGRATION_USER | Database Schema owning or user permitted to perform Data Definition Language changes | |
| MIGRATION_PASSWORD | Password for the migration user | |
| APP_USER | User name for the initial dbimport and compimport as all as other applications that will connect | |
| APP_PASSWORD | Password for the app users | |
| PLACEHOLDER_* | The SQL files of each implementation may contain Flyway Placeholder values. Any variable starting with PLACEHOLDER_ will have the PLACEHOLDER_ prefix striped and passed along to flyway for use. |
The following environment variables are used to configure the container. For example the DATABASE_URL contains a string such as:
jdbc\:oracle\:thin\:@127.0.0.1\:1521/FREEPDB1?oracle.net.disableOob=true
which tells the container what database to connect to.
note: These variables (except username and password) are used when creating a configuration file in the container.
| Variable | Default | Description |
|---|---|---|
| DATABASE_TYPE | xml | Which type of database this container is for. Current optiosn are XML, OTSDB, CWMS, HDB |
| DATABASE_URL | ${DCSTOOL_USERDIR}/edit-db |
URL for the database. either a directory location or a jdbc URL |
| DATABASE_DRIVER | If non XML database used the JDBC driver class. Only required for 7.0 images | |
| DB_AUTH | env-auth-source:username=DATABASE_USERNAME,password=DATABASE_PASSWORD | How to retrieve database auth information. Defaults to environment. See opendcs properties documentation for how to get information from files. |
| DATABASE_USERNAME | Username for the database connection | |
| DATABASE_PASSWORD | Password for the database connection | |
| CWMS_OFFICE | Only used for CWMS DATABASE_TYPE containers | |
| DATATYPE_STANDARD | Desired Datatype naming standard. See OpenDCS Documentation for options. | |
| KEYGENERATOR | Which sequence/key generated to use. Class name that depends on which DATABASE_TYPE used. | |
| APPLICATION_NAME | Named "process" this container is running as |
7.5, 7.5, latest