Merge pull request #166 from atlanticwave-sdx/165.env-cleanup-round-two

Environment cleanup round two

Author: sajith

.github/workflows/test.yml

@@ -79,7 +79,6 @@ jobs:
           SDX_VERSION: '1.0.0'
           SDX_NAME: 'sdx-controller-test'
           MQ_HOST: 'localhost'
-          MQ_NAME: 'sdx-controller'
           SUB_QUEUE: 'sdx-controller-test-queue'
           DB_NAME: 'sdx-controllder-test-db'
           DB_CONFIG_TABLE_NAME: 'sdx-controller-test-table'

.gitignore

@@ -109,6 +109,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+env
 
 # Spyder project settings
 .spyderproject

README.md

@@ -55,8 +55,8 @@ Local controller sends domain information to SDX controller:
 
 ### Configuration
 
-Copy the `env.template` to `.env`, and adjust it according to your
-environment.
+Copy the provided `env.template` file to `.env`, and adjust it
+according to your environment.
 
 The communication between SDX controller and Local controller is
 enabled by RabbitMQ, which can either run on the same node as SDX
@@ -77,6 +77,7 @@ sdx-controller, bapm-server, and a MongoDB instance used by
 sdx-controller.  From the project root directory, do:
 
 ```console
+$ source .env
 $ docker compose up --build
 ```
 

docker-compose.yml

@@ -4,53 +4,55 @@ services:
 
   # See https://hub.docker.com/_/mongo/ for documentation about
   # MongoDB Docker images.
-  sdx-controller-mongodb:
+  mongodb-service:
     image: mongo:3.7
-    container_name: mongodb
     environment:
-      # MONGO_INITDB_DATABASE: test
-      MONGO_INITDB_ROOT_USERNAME: guest
-      MONGO_INITDB_ROOT_PASSWORD: guest
+      MONGO_INITDB_ROOT_USERNAME: ${MONGO_INITDB_ROOT_USERNAME}
+      MONGO_INITDB_ROOT_PASSWORD: ${MONGO_INITDB_ROOT_PASSWORD}
       MONGODB_DATA_DIR: /data/db
     volumes:
-      # Named volumes. The 'Z' option tells Docker to label the
-      # content with a private unshared label. Private volumes can
-      # only be used by the current container.  See
+      # See https://docs.docker.com/storage/volumes/
+      #
+      # The 'Z' option tells Docker to label the content with a
+      # private unshared label. Private volumes can only be used by
+      # the current container.  See
       # https://docs.docker.com/engine/reference/commandline/run/
-      - ./db:/data/db:Z
+      - type: volume
+        source: mongodb
+        target: /data/db:Z
 
-  sdx-controller:
+  sdx-controller-service:
     image: sdx-controller
-    container_name: sdx-controller
+    depends_on:
+      - mongodb-service
     tty: true
     build: ./
     ports:
       - 8080:8080
     environment:
-      # Use sdx-controller-mongodb service specified above.
-      - MONGODB_CONNSTRING=mongodb://guest:guest@sdx-controller-mongodb:27017/
-      - SDX_HOST=aw-sdx-controller.renci.org
-      - SDX_PORT=8080
-      - SDX_VERSION=1.0.0
-      - PUB_TOPIC=connection
-      - SUB_QUEUE=sdx_q1
-      - SUB_TOPIC=topo
-      - SUB_QUEUE=topo
-      - SUB_TOPIC=sdx_q1
-      - MQ_HOST=aw-sdx-monitor.renci.org
-      - DB_NAME=test-db
-      - DB_CONFIG_TABLE_NAME=sdx-config-test-1
+      # Use mongodb-service specified above.  Note that we do not use
+      # the same MONGODB_CONNSTRING variable from .env here, because
+      # that is helpful for running unit/integration tests.
+      - MONGODB_CONNSTRING=mongodb://${MONGO_INITDB_ROOT_USERNAME}:${MONGO_INITDB_ROOT_PASSWORD}@mongodb-service:27017/
+      - SDX_HOST=${SDX_HOST}
+      - SDX_PORT=${SDX_PORT}
+      - SDX_VERSION=${SDX_VERSION}
+      - MQ_HOST=${MQ_HOST}
+      - SUB_QUEUE=${SUB_QUEUE}
+      - DB_NAME=${DB_NAME}
+      - DB_CONFIG_TABLE_NAME=${DB_CONFIG_TABLE_NAME}
 
-  bapm-server:
+  bapm-server-service:
     image: bapm-server
-    container_name: bapm-server
-    # network_mode: "host"
     tty: true
     build: ./bapm_server
     environment:
-      - ES_HOST=localhost
-      - ES_PORT=9200
-      - BAPM_MQ_HOST=amqp://guest:guest@aw-sdx-monitor.renci.org:5672/%2F
-      - BAPM_EXCHANGE=measurement
-      - BAPM_QUEUE=sdx_q_measurement
-      - BAPM_ROUTING_KEY=measurement.bapm
+      - ES_HOST=${ES_HOST}
+      - ES_PORT=${ES_PORT}
+      - BAPM_MQ_HOST=${BAPM_MQ_HOST}
+      - BAPM_EXCHANGE=${BAPM_EXCHANGE}
+      - BAPM_QUEUE=${BAPM_QUEUE}
+      - BAPM_ROUTING_KEY=${BAPM_ROUTING_KEY}
+
+volumes:
+  mongodb:

env.template

@@ -1,17 +1,33 @@
 # SDX Controller settings.
-export SDX_HOST='localhost'
-export SDX_PORT='8080'
-export SDX_VERSION='1.0.0'
-export SDX_NAME='sdx-controller-test'
+export SDX_HOST="localhost"
+export SDX_PORT="8080"
+export SDX_VERSION="1.0.0"
+export SDX_NAME="sdx-controller-test"
 
-# Message queue settings.
-export MQ_HOST='localhost'
-export MQ_NAME='sdx-controller'
-export PUB_TOPIC='sdx-test-connection'
-export SUB_TOPIC='sdx-test-topology'
-export SUB_QUEUE='sdx-controller-test-queue'
+# Message queue settings for SDX Controller.
+export MQ_HOST="aw-sdx-monitor.renci.org"
+export SUB_QUEUE="topo"
 
-# Database settings.
-export MONGODB_CONNSTRING='mongodb://guest:guest@localhost:27017/'
-export DB_NAME='sdx-controllder-test-db'
-export DB_CONFIG_TABLE_NAME='sdx-controller-test-table'
+# MongoDB settings for SDX Controller.
+export MONGO_INITDB_ROOT_USERNAME="guest"
+export MONGO_INITDB_ROOT_PASSWORD="guest"
+
+# To run tests locally (with tox), localhost is convenient as
+# MONGO_HOST; for Docker Compose, we hard-code the container name in
+# the compose file.
+export MONGO_HOST="localhost"
+export MONGO_PORT="27017"
+export MONGODB_CONNSTRING="mongodb://${MONGO_INITDB_ROOT_USERNAME}:${MONGO_INITDB_ROOT_PASSWORD}@${MONGO_HOST}:${MONGO_PORT}/"
+
+export DB_NAME="sdx-controllder-test-db"
+export DB_CONFIG_TABLE_NAME="sdx-controller-test-table"
+
+# Elastic Search for BAPM Server.
+export ES_HOST="localhost"
+export ES_PORT="9200"
+
+# Message queue settings for BAPM Server.
+export BAPM_MQ_HOST="amqp://guest:guest@aw-sdx-monitor.renci.org:5672/%2F"
+export BAPM_EXCHANGE="measurement"
+export BAPM_QUEUE="sdx_q_measurement"
+export BAPM_ROUTING_KEY="measurement.bapm"