docs(docker): Add OpenSearch backend stack to docker-compose (#71)

This PR adds the OpenSearch backend as an option in the docker-compose file

---------

Co-authored-by: Anthony Lukach <[email protected]>

Author: jamesfisher-geo

.dockerignore

@@ -0,0 +1 @@
+.pgdata

README.md

@@ -8,6 +8,7 @@
 STAC Auth Proxy is a proxy API that mediates between the client and your internally accessible STAC API to provide flexible authentication, authorization, and content-filtering mechanisms.
 
 > [!IMPORTANT]
+>
 > **We would :heart: to hear from you!**
 > Please [join the discussion](https://github.com/developmentseed/eoAPI/discussions/209) and let us know how you're using eoAPI! This helps us improve the project for you and others.
 > If you prefer to remain anonymous, you can email us at [email protected], and we'll be happy to post a summary on your behalf.
@@ -25,7 +26,9 @@ STAC Auth Proxy is a proxy API that mediates between the client and your interna
 
 ### Running
 
-The simplest way to run the project is by invoking the application via Docker:
+#### Docker
+
+The simplest way to run the project is via Docker:
 
 ```sh
 docker run \
@@ -36,16 +39,42 @@ docker run \
   ghcr.io/developmentseed/stac-auth-proxy:latest
 ```
 
-Alternatively, the module can be invoked directly or the application's factory can be passed to Uvicorn:
+#### Python
+
+The installed Python module can be invoked directly:
 
 ```sh
 python -m stac_auth_proxy
 ```
 
+#### Uvicorn
+
+The application's factory can be passed to Uvicorn:
+
 ```sh
 uvicorn --factory stac_auth_proxy:create_app
 ```
 
+#### Docker Compose
+
+The codebase ships with a `docker-compose.yaml` file, allowing the proxy to be run locally alongside various supporting services: the database, the STAC API, and a Mock OIDC provider.
+
+##### pgSTAC Backend
+
+Run the application stack with a pgSTAC backend using [stac-fastapi-pgstac](https://github.com/stac-utils/stac-fastapi-pgstac):
+
+```sh
+docker compose up
+```
+
+##### OpenSearch Backend
+
+Run the application stack with an OpenSearch backend using [stac-fastapi-elasticsearch-opensearch](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch):
+
+```sh
+docker compose --profile os up
+```
+
 ### Installation
 
 The application can be installed as a standard Python module:
@@ -65,6 +94,7 @@ uv sync
 The application is configurable via environment variables.
 
 #### Core
+
 - **`UPSTREAM_URL`**, STAC API URL
   - **Type:** HTTP(S) URL
   - **Required:** Yes
@@ -96,6 +126,7 @@ The application is configurable via environment variables.
   - **Note:** This is independent of the upstream API's path. The proxy will handle removing this prefix from incoming requests and adding it to outgoing links.
 
 #### Authentication
+
 - **`OIDC_DISCOVERY_URL`**, OpenID Connect discovery document URL
   - **Type:** HTTP(S) URL
   - **Required:** Yes
@@ -137,6 +168,7 @@ The application is configurable via environment variables.
   - **Example:** `false`, `1`, `True`
 
 #### OpenAPI / Swagger UI
+
 - **`OPENAPI_SPEC_ENDPOINT`**, path of OpenAPI specification, used for augmenting spec response with auth configuration
   - **Type:** string or null
   - **Required:** No, defaults to `null` (disabled)
@@ -159,6 +191,7 @@ The application is configurable via environment variables.
   - **Example:** `{"clientId": "stac-auth-proxy", "usePkceWithAuthorizationCodeGrant": true}`
 
 #### Filtering
+
 - **`ITEMS_FILTER_CLS`**, CQL2 expression generator for item-level filtering
   - **Type:** JSON object with class configuration
   - **Required:** No, defaults to `null` (disabled)

docker-compose.yaml

@@ -1,31 +1,57 @@
 services:
-  stac:
+  stac-pg:
+    profiles: [""] # default profile
     image: ghcr.io/stac-utils/stac-fastapi-pgstac:5.0.2
     environment:
       APP_HOST: 0.0.0.0
       APP_PORT: 8001
       RELOAD: true
-      ENVIRONMENT: local
       POSTGRES_USER: username
       POSTGRES_PASS: password
       POSTGRES_DBNAME: postgis
-      POSTGRES_HOST_READER: database
-      POSTGRES_HOST_WRITER: database
+      POSTGRES_HOST_READER: database-pg
+      POSTGRES_HOST_WRITER: database-pg
       POSTGRES_PORT: 5432
-      WEB_CONCURRENCY: 10
-      VSI_CACHE: TRUE
-      GDAL_HTTP_MERGE_CONSECUTIVE_RANGES: YES
-      GDAL_DISABLE_READDIR_ON_OPEN: EMPTY_DIR
       DB_MIN_CONN_SIZE: 1
       DB_MAX_CONN_SIZE: 1
       USE_API_HYDRATE: ${USE_API_HYDRATE:-false}
+    hostname: stac
+    ports:
+      - "8001:8001"
+    depends_on:
+      - database-pg
+    command: bash -c "./scripts/wait-for-it.sh database-pg:5432 && python -m stac_fastapi.pgstac.app"
+
+  stac-os:
+    profiles: ["os"]
+    container_name: stac-fastapi-os
+    image: ghcr.io/stac-utils/stac-fastapi-os:v6.1.0
+    environment:
+      STAC_FASTAPI_TITLE: stac-fastapi-opensearch
+      STAC_FASTAPI_DESCRIPTION: A STAC FastAPI with an Opensearch backend
+      STAC_FASTAPI_VERSION: 6.0.0
+      STAC_FASTAPI_LANDING_PAGE_ID: stac-fastapi-opensearch
+      APP_HOST: 0.0.0.0
+      APP_PORT: 8001
+      RELOAD: true
+      ENVIRONMENT: local
+      ES_HOST: database-os
+      ES_PORT: 9200
+      ES_USE_SSL: false
+      ES_VERIFY_CERTS: false
+      BACKEND: opensearch
+      STAC_FASTAPI_RATE_LIMIT: 200/minute
+    hostname: stac
     ports:
       - "8001:8001"
     depends_on:
-      - database
-    command: bash -c "./scripts/wait-for-it.sh database:5432 && python -m stac_fastapi.pgstac.app"
+      - database-os
+    command: |
+      bash -c "./scripts/wait-for-it-es.sh database-os:9200 && python -m stac_fastapi.opensearch.app"
 
-  database:
+  database-pg:
+    profiles: [""] # default profile
+    container_name: database-pg
     image: ghcr.io/stac-utils/pgstac:v0.9.5
     environment:
       POSTGRES_USER: username
@@ -40,9 +66,25 @@ services:
     volumes:
       - ./.pgdata:/var/lib/postgresql/data
 
+  database-os:
+    profiles: ["os"]
+    container_name: database-os
+    image: opensearchproject/opensearch:${OPENSEARCH_VERSION:-2.11.1}
+    hostname: database-os
+    environment:
+      cluster.name: stac-cluster
+      node.name: os01
+      http.port: 9200
+      http.cors.allow-headers: X-Requested-With,Content-Type,Content-Length,Accept,Authorization
+      discovery.type: single-node
+      plugins.security.disabled: true
+      OPENSEARCH_JAVA_OPTS: -Xms512m -Xmx512m
+    ports:
+      - "9200:9200"
+
   proxy:
     depends_on:
-      - stac
+      - oidc
     build:
       context: .
     environment:
@@ -65,7 +107,3 @@ services:
       PORT: 8888
     ports:
       - "8888:8888"
-
-networks:
-  default:
-    name: eoapi-network