From 06b21cb1de8fa0bbe381bca6407abf5a5bf8b899 Mon Sep 17 00:00:00 2001
From: Alexandra Hobbs <ahobbs@contractor.usgs.gov>
Date: Mon, 2 Dec 2024 10:52:33 -0700
Subject: [PATCH] added cleanup script and cleaned up docs
---
localdev/cleanup-docker.sh | 12 ++++++++++++
localdev/docker-compose.yml | 4 ++--
localdev/local_development.md | 15 ++++-----------
3 files changed, 18 insertions(+), 13 deletions(-)
create mode 100755 localdev/cleanup-docker.sh
diff --git a/localdev/cleanup-docker.sh b/localdev/cleanup-docker.sh
new file mode 100755
index 00000000..1c245406
--- /dev/null
+++ b/localdev/cleanup-docker.sh
@@ -0,0 +1,12 @@
+#!/bin/sh -e
+
+# script to completely clean up all docker resources
+docker stop $(docker ps -aq)
+
+docker rm -vf $(docker ps -aq)
+
+docker rmi -f $(docker images -aq)
+
+# this command will ask if you are sure if you want to continue. the benefit of this command is to free up space by removing cached objects,
+# but it does mean that the next time you run docker-compose up, it will take longer.
+docker system prune --volumes
diff --git a/localdev/docker-compose.yml b/localdev/docker-compose.yml
index 9d936edf..d68cee8c 100644
--- a/localdev/docker-compose.yml
+++ b/localdev/docker-compose.yml
@@ -32,10 +32,10 @@ services:
- host.docker.internal:host-gateway
environment:
- DATA_HOST=host.docker.internal
- - DATABASE_URL=$DATABASE_URL
- OPENID_CLIENT_ID=$OPENID_CLIENT_ID
- OPENID_CLIENT_SECRET=$OPENID_CLIENT_SECRET
- - OPENID_METADATA_URL=$OPENID_METADATA_URL
+ - DATABASE_URL=mysql://root:password@host.docker.internal:3306/geomag_operations
+ - OPENID_METADATA_URL=https://code.usgs.gov/.well-known/openid-configuration
- SECRET_KEY=$SECRET_KEY
- SECRET_SALT=$SECRET_SALT
- WEBSERVICE=false
diff --git a/localdev/local_development.md b/localdev/local_development.md
index ec84029c..ae659a92 100644
--- a/localdev/local_development.md
+++ b/localdev/local_development.md
@@ -1,22 +1,16 @@
# Local Development
## Background
-This workflow can replace the docker-compose in geomag-stacks. This docker-compose uses the existing Dockerfile to create a `localdev-web-1` container, instead of pulling down the latest geomag-algorithms image. However, it is initializing the mysql database the same way it is done in geomag-stacks. This docker-compose is also creating a mysql container called `localdev-database-1` an edge container called `localdev-edge-1` using the geomag-edge Dockerfile in geomag-stacks. The geomag-edge folder was not moved out of geomag-stacks out of an abudance of caution to prevent internal information from being revealed.
+This docker-compose uses the main Dockerfile to create a `localdev-web-1` container and creates a mysql container called `localdev-database-1` and an edge container called `localdev-edge-1`.
## Prerequisites
For mac development:
1. Download colima using homebrew.
2. Start colima and edit virtual machine sizes using `colima start --edit`. Increase the number of CPUs to 16 and the memory to 16.
-3. Add the following env vars to your .bashrc or .zshrc. Replace the EDGE_PATH and
-EDGE_DATA_PATH with the absolute path to your geomag-stack. See the instructions in metadata_webservice.md for instructions on creating the OPENID_CLIENT_ID and
-OPENID_CLIENT_SECRET. The rest of the values can be found in the geomag-stack docker-compose. Run the source command to pick up the new values (ex `source ~/.bashrc`).
+3. Add the following env vars to your .bashrc or .zshrc or an .env file. See the instructions [here](../docs/metadata_webservice.md) for instructions on creating the OPENID_CLIENT_ID and OPENID_CLIENT_SECRET. The rest of the values can be set to strings of your choice. If you set the values in your .bashrc or .zshrc, run the source command to pick up the new values (ex `source ~/.bashrc`).
```
-export EDGE_PATH="/Users/{user}/geomag-stack/geomag-edge"
-export EDGE_DATA_PATH="/Users/{user}/geomag-stack/edge-data"
export OPENID_CLIENT_ID=""
export OPENID_CLIENT_SECRET=""
-export DATABASE_URL=""
-export OPENID_METADATA_URL=""
export SECRET_KEY=""
export SECRET_SALT=""
export MYSQL_ROOT_PASSWORD=""
@@ -38,8 +32,7 @@ docker-compmose up -d
`docker ps -a` shows all the containers, even ones that have exited. This is helpful to see logs for containers that have unexpectedly exited.
-`docker exec -it {CONTAINER ID} /bin/bash` execs into the container. This can be helpful for exploring the mysql db. After you exec into the mysql container, run `mysql -u root -p` in the container. Input the password you set to MYSQL_ROOT_PASSWORD. Now
-you can use SQL to explore the db.
+`docker exec -it {CONTAINER ID} /bin/bash` execs into the container. This can be helpful for exploring the mysql db. After you exec into the mysql container, run `mysql -u root -p` in the container. Input the password you set to MYSQL_ROOT_PASSWORD. Now you can use SQL to explore the db.
## Helpful Tips
-Sometimes the mysql container exits immediately with code 139 due to insufficient memory. Restarting colima resolves this issue.
+Sometimes the mysql container exits immediately with code 139 due to insufficient memory. You can clean up your docker resources using the `cleanup-docker.sh` script in this folder. Restarting colima can also resolve this issue.
--
GitLab