Moving credentials to .env file

Author: shreyashankar

.flaskenv

@@ -1,2 +1,3 @@
 FLASK_APP=mltrace/server/__init__.py
-FLASK_ENV=production
+FLASK_ENV=production
+DB_URI=postgresql://admin:admin@database:5432/sqlalchemy

.postgresenv

@@ -0,0 +1,3 @@
+POSTGRES_USER=admin
+POSTGRES_PASSWORD=admin
+POSTGRES_DB=sqlalchemy

README.md

@@ -29,7 +29,9 @@ If you are interested in learning about specific `mltrace` concepts, please read
 
 ### Database setup (server-side)
 
-We use Postgres-backed SQLAlchemy. Assuming you have Docker installed, you can run the following commands from the
+First, you will need to create DB credentials. We use Postgres. There is a `.postgresenv` file in the root directory, but you should set your own values for the params.
+
+Assuming you have Docker installed, you can run the following commands from the
 root directory after cloning the most recent release:
 
 ```
@@ -72,6 +74,8 @@ You can also look at `examples` for ways to integrate `mltrace` into your ML pip
 
 ### Launch UI (client-side)
 
+Double check the Postgres credentials in `.flaskenv` match the credentials set in `.postgresenv`.
+
 If you ran `docker-compose up` from the root directory, you can just navigate to the server's IP address at port 8080 (or `localhost:8080`) in your browser. To launch a dev version of the UI, navigate to `./mltrace/server/ui` and execute `yarn install` then `yarn start`. It should be served at [localhost:3000](localhost:3000). The UI is based on `create-react-app` and [`blueprintjs`](https://blueprintjs.com/docs/). Here's an example of what tracing an output would give:
 
 ![screenshot](./res/trace.png)

docker-compose-not-ui.yml

@@ -3,12 +3,10 @@ services:
 
   database:
     image: postgres
-    volumes:      
-       - postgres_data:/var/lib/postgresql/data
-    environment:
-      POSTGRES_USER: admin
-      POSTGRES_PASSWORD: admin
-      POSTGRES_DB: sqlalchemy
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    env_file:
+      - ./.postgresenv
     ports:
       - "5432:5432"
     restart: always
@@ -21,11 +19,8 @@ services:
     build:
       context: .
       dockerfile: ./mltrace/server/Dockerfile
-      # dockerfile: ./mltrace/server/Dockerfile
-      # dockerfile: ./mltrace/server/Dockerfile
     environment:
       PYTHONPATH: /src
-      DB_URI: "postgresql://admin:admin@database:5432/sqlalchemy"
     volumes:
       - .:/src
     ports:
@@ -40,10 +35,10 @@ services:
         aliases:
           - api
 
-volumes:  
+volumes:
   postgres_data:
 
 networks:
   services-network:
     name: services-network
-    driver: bridge
+    driver: bridge

docker-compose.yml

@@ -16,12 +16,10 @@ services:
 
   database:
     image: postgres
-    volumes:      
-       - postgres_data:/var/lib/postgresql/data
-    environment:
-      POSTGRES_USER: admin
-      POSTGRES_PASSWORD: admin
-      POSTGRES_DB: sqlalchemy
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    env_file:
+      - ./.postgresenv
     ports:
       - "5432:5432"
     restart: always
@@ -36,7 +34,6 @@ services:
       dockerfile: ./mltrace/server/Dockerfile
     environment:
       PYTHONPATH: /src
-      DB_URI: "postgresql://admin:admin@database:5432/sqlalchemy"
     volumes:
       - .:/src
     ports:
@@ -50,11 +47,11 @@ services:
       services-network:
         aliases:
           - api
-  
-volumes:  
+
+volumes:
   postgres_data:
 
 networks:
   services-network:
     name: services-network
-    driver: bridge
+    driver: bridge