Merge pull request #107 from geoCML/config-file

Configure geoCML with scripts

Author: TristanDamron

.env.example

@@ -0,0 +1,6 @@
+export GEOCML_POSTGRES_PASSWORD=XXXXXXX
+export GEOCML_POSTGRES_ADMIN_PASSWORD=XXXXXXX
+export GEOCML_DESKTOP_PASSWORD=XXXXXXX
+export DRGON_HOST=XXXXXXX  # Optional; only required if you are registering your deployment publicly on a DRGON instance
+export DRGON_API_KEY=XXXXXXX  # Optional; only required if you are registering your deployment publicly on a DRGON instance
+export GEOCML_DEPLOYMENT_HOST=XXXXXXX  # Optional; only required if you are hosting your deployment publicly

.gitignore

@@ -3,4 +3,5 @@ persistence-layer/*
 !persistence-layer/geocml-project.qgz
 !persistence-layer/portal-config.yaml
 !persistence-layer/DBBackups
-**/__pycache__/**
+**/__pycache__/**
+.env

Dockerfiles/Dockerfile.geocml-postgres

@@ -1,6 +1,8 @@
 FROM ubuntu:22.04
 USER root
 
+ARG GEOCML_POSTGRES_PASSWORD="geocml"
+ARG GEOCML_POSTGRES_ADMIN_PASSWORD="admin"
 RUN apt update
 
 # Install sudo (required by Ansible)
@@ -32,4 +34,4 @@ RUN pip uninstall -y psycopg2-binary && apt remove -y python3-pip
 # Remove install cache
 RUN apt clean autoclean && apt autoremove -y && rm -rf /var/lib/{apt,dpkg,cache,log}/
 
-CMD service postgresql start && tail -f /dev/null
+CMD service postgresql start && tail -f /dev/null

ansible-playbooks/geocml-postgres-playbook.yaml

@@ -21,13 +21,14 @@
         create: yes
     - name: Set postgres' password
       become_user: postgres
-      community.postgresql.postgresql_query:
-        query: ALTER USER postgres PASSWORD 'admin';
+      community.postgresql.postgresql_user:
+        name: postgres
+        password: "{{ lookup('env', 'GEOCML_POSTGRES_ADMIN_PASSWORD') }}"
     - name: Create new Postgres user
       become_user: postgres
       community.postgresql.postgresql_user:
         name: geocml
-        password: geocml
+        password: "{{ lookup('env', 'GEOCML_POSTGRES_PASSWORD') }}"
         role_attr_flags: "CREATEDB,NOSUPERUSER"
     - name: Create new Postgres database
       become_user: postgres

build-resources/geocml-task-scheduler/geocml-task-scheduler/backup_geocml_db.py

@@ -12,7 +12,7 @@ def backup_geocml_db():
     try:
         conn = psycopg2.connect(dbname="geocml_db",
                                 user="postgres",
-                                password="admin",
+                                password=os.environ["GEOCML_POSTGRES_ADMIN_PASSWORD"],
                                 host="geocml-postgres",
                                 port=5432)
     except psycopg2.OperationalError:
@@ -26,7 +26,7 @@ def backup_geocml_db():
 
     # Write table schemata to .tabor file
     out = subprocess.run(["tabor", "write", "--db", "geocml_db",
-                             "--username", "geocml", "--password", "geocml",
+                             "--username", "geocml", "--password", os.environ["GEOCML_POSTGRES_PASSWORD"],
                              "--host", "geocml-postgres",
                              "--file", os.path.join(path_to_backup_dir, "geocml_db.tabor")],
                              capture_output=True)

build-resources/geocml-task-scheduler/geocml-task-scheduler/restore_geocml_db_from_backups.py

@@ -10,7 +10,7 @@ def restore_geocml_db_from_backups():
     try:
         conn = psycopg2.connect(dbname="geocml_db",
                                 user="postgres",
-                                password="admin",
+                                password=os.environ["GEOCML_POSTGRES_ADMIN_PASSWORD"],
                                 host="geocml-postgres",
                                 port=5432)
     except psycopg2.OperationalError:
@@ -39,7 +39,7 @@ def restore_geocml_db_from_backups():
 
     # Rebuild tables from .tabor file
 
-    out = subprocess.run(["tabor", "load", "--file", os.path.join(most_recent_backup, "geocml_db.tabor"), "--db", "geocml_db", "--host", "geocml-postgres", "--username", "postgres", "--password", "admin"], capture_output=True)
+    out = subprocess.run(["tabor", "load", "--file", os.path.join(most_recent_backup, "geocml_db.tabor"), "--db", "geocml_db", "--host", "geocml-postgres", "--username", "postgres", "--password", os.environ["GEOCML_POSTGRES_ADMIN_PASSWORD"]], capture_output=True)
     if out.stderr:
         log("Failed to load tables from .tabor file")
         return 0

build.sh

@@ -0,0 +1,15 @@
+echo "Starting up geoCML... this should only take a few minutes."
+sh .env
+
+command -v docker | export DOCKER_INSTALLED=$?
+
+if [[ $DOCKER_INSTALLED -ne 0 ]]; then
+	echo "Error: Docker is not installed on this machine."
+	exit 1
+fi
+
+docker compose build --build-arg GEOCML_POSTGRES_PASSWORD --build-arg GEOCML_POSTGRES_ADMIN_PASSWORD
+
+echo "Done! You can start your geoCML instance by running the 'start.sh' script."
+exit 0
+

docker-compose.yml

@@ -12,6 +12,8 @@ services:
       DRGON_API_KEY: ${DRGON_API_KEY}
       DRGON_HOST: ${DRGON_HOST}
       GEOCML_DEPLOYMENT_HOST: ${GEOCML_DEPLOYMENT_HOST}
+      GEOCML_POSTGRES_PASSWORD: ${GEOCML_POSTGRES_PASSWORD}
+      GEOCML_POSTGRES_ADMIN_PASSWORD: ${GEOCML_POSTGRES_ADMIN_PASSWORD}
     networks:
       - geocml-network
     volumes:

persistence-layer/_README

@@ -4,4 +4,3 @@ DBBackups is used to store sql backup files from geocml_db
 
 geocml-project.qgz is the default project configured with this deployment. Remember that geoCML deployments, by design, only host a single project/dataset. For multiple projects, it is very strongly recommended that you deploy multiple geoCML instances.
 
-Use portal-config.yaml to configure your geoCML Server Portal.

start.sh

@@ -0,0 +1,15 @@
+echo "Starting up geoCML... this should only take a moment."
+sh .env
+
+command -v docker | export DOCKER_INSTALLED=$?
+
+if [[ $DOCKER_INSTALLED -ne 0 ]]; then
+	echo "Error: Docker is not installed on this machine."
+	exit 1
+fi
+
+docker compose up -d
+
+echo "Done! You can stop your geoCML instance at any time with 'docker compose down'."
+exit 0
+