From 0f175b1c093e2f2a77e4c0d8ffc33ff8d2c1ff0e Mon Sep 17 00:00:00 2001
From: Michael Chouinard <46358556+chouinar@users.noreply.github.com>
Date: Mon, 9 Sep 2024 15:27:12 -0400
Subject: [PATCH] [Issue #191] Cleanup makefile commands around OpenSearch
 (#192)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

## Summary
Fixes #191

### Time to review: __5 mins__

## Changes proposed
Adjusted a few makefile commands / added some additional docs

Renamed `db-recreate` to `volume-recreate` as the command also recreates
the OpenSearch volume.

Added a command for populating your OpenSearch index locally for
opportunities rather than needing to build the full command yourself.

## Context for reviewers
As we've added more commands to the Makefile, we haven't kept ontop of
how they all interact. This should add some level of clarity to the
commands.

The new `make populate-search-opportunities` command is a much easier
way of writing out the full command of `docker compose run --rm
grants-api poetry run flask load-search-data load-opportunity-data`.

## Additional information
Note that we have a `make help` command which prints out any command
with a `## help text` on the target definition in the makefile:
<img width="1353" alt="Screenshot 2024-09-06 at 4 38 02 PM"
src="https://github.com/user-attachments/assets/d21f25c4-031f-4028-bf6b-d73908215b01">
---
 api/Makefile                                  | 19 ++++++++++---------
 .../api/database/database-management.md       |  2 +-
 2 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/api/Makefile b/api/Makefile
index dcdbf23c9..717de89b9 100644
--- a/api/Makefile
+++ b/api/Makefile
@@ -91,20 +91,22 @@ setup-local:
 build:
 	docker compose build
 
-start:
+start: ## Start the API
 	docker compose up --detach
 
 start-debug:
 	docker compose -f docker-compose.yml -f docker-compose.debug.yml up --detach
 
-run-logs: start
+run-logs: start ## Start the API and follow the logs
 	docker compose logs --follow --no-color $(APP_NAME)
 
 init: build init-db init-opensearch init-localstack
 
-clean-volumes: ## Remove project docker volumes (which includes the DB state)
+clean-volumes: ## Remove project docker volumes - which includes the DB, and OpenSearch state
 	docker compose down --volumes
 
+volume-recreate:  clean-volumes init ## Destroy current volumes, setup new ones - will remove all existing data
+
 stop:
 	docker compose down
 
@@ -126,9 +128,6 @@ start-db:
 	docker compose up --detach grants-db
 	./bin/wait-for-local-db.sh
 
-## Destroy current DB, setup new one
-db-recreate: clean-volumes init-db
-
 #########################
 # DB Migrations
 #########################
@@ -166,7 +165,7 @@ db-migrate-history: ## Show migration history
 db-migrate-heads: ## Show migrations marked as a head
 	$(alembic_cmd) heads $(args)
 
-db-seed-local:
+db-seed-local: ## Generate records into your local database
 	$(PY_RUN_CMD) db-seed-local $(args)
 
 db-check-migrations: ## Verify the DB schema matches the DB migrations generated
@@ -183,8 +182,7 @@ setup-postgres-db: ## Does any initial setup necessary for our local database to
 # Opensearch
 ##################################################
 
-init-opensearch: start-opensearch
-# TODO - in subsequent PRs, we'll add more to this command to setup the search index locally
+init-opensearch: start-opensearch ## Start the opensearch service locally
 
 start-opensearch:
 	docker compose up --detach opensearch-node
@@ -275,6 +273,9 @@ setup-foreign-tables:
 seed-local-legacy-tables:
 	$(PY_RUN_CMD) python3 -m tests.lib.seed_local_legacy_tables
 
+populate-search-opportunities: ## Load opportunities from the DB into the search index, run "make db-seed-local" first to populate your database
+	$(FLASK_CMD) load-search-data load-opportunity-data $(args)
+
 ##################################################
 # Miscellaneous Utilities
 ##################################################
diff --git a/documentation/api/database/database-management.md b/documentation/api/database/database-management.md
index 4431c20ac..ef439b37e 100644
--- a/documentation/api/database/database-management.md
+++ b/documentation/api/database/database-management.md
@@ -30,7 +30,7 @@ This command is not needed when starting the application with `make start`
 To clean the database, use the following command:
 
 ```sh
-make db-recreate
+make volume-recreate
 ```
 
 This will remove _all_ docker project volumes, rebuild the database volume, and