Merge pull request #158 from IBM/update-docs-testing

Update docs testing

Author: crivetimihai

.github/workflows/ibm-cloud-code-engine.yml

@@ -35,6 +35,10 @@
 #         not the secret value.
 # Triggers:
 #   • Every push to `main`
+#   • Expects a secret called `mcpgateway-dev` in Code Engine. Ex:
+#      ibmcloud ce secret create \
+#        --name mcpgateway-dev \
+#        --from-env-file .env
 # ---------------------------------------------------------------
 
 name: Deploy to IBM Code Engine
@@ -156,6 +160,7 @@ jobs:
               --name  "$CODE_ENGINE_APP_NAME" \
               --image "$REGISTRY_HOSTNAME/$ICR_NAMESPACE/$IMAGE_NAME:$IMAGE_TAG" \
               --registry-secret "$CODE_ENGINE_REGISTRY_SECRET" \
+              --env-from-secret mcpgateway-dev \
               --cpu 1 --memory 2G
           else
             echo "🆕 Creating new application…"
@@ -164,6 +169,7 @@ jobs:
               --image "$REGISTRY_HOSTNAME/$ICR_NAMESPACE/$IMAGE_NAME:$IMAGE_TAG" \
               --registry-secret "$CODE_ENGINE_REGISTRY_SECRET" \
               --port  "$PORT" \
+              --env-from-secret mcpgateway-dev \
               --cpu 1 --memory 2G
           fi
 

docker-compose.yml

@@ -24,7 +24,8 @@ services:
   # MCP Gateway - the main API server for the MCP stack
   # ──────────────────────────────────────────────────────────────────────
   gateway:
-    image: ghcr.io/ibm/mcp-context-forge:0.1.1
+    image: ghcr.io/ibm/mcp-context-forge:0.1.1 # Use the release MCP Context Forge image
+    # image: mcpgateway/mcpgateway:latest # Use the local latest image. Run `make docker-prod` to build it.
     build:
       context: .
       dockerfile: Containerfile     # Same one the Makefile builds
@@ -45,7 +46,7 @@ services:
       # - DATABASE_URL=mongodb://admin:${MONGO_PASSWORD:-changeme}@mongodb:27017/mcp
       - CACHE_TYPE=redis # backend for caching (memory, redis, database, or none)
       - REDIS_URL=redis://redis:6379/0
-      - JWT_SECRET_KEY=changeme
+      - JWT_SECRET_KEY=my-test-key
       - BASIC_AUTH_USER=admin
       - BASIC_AUTH_PASSWORD=changeme
       # - SSL=true

docs/docs/development/review.md

@@ -49,17 +49,26 @@ Before you read code or leave comments, **always** verify the PR builds and test
 make venv install install-dev serve   # Install into a fresh venv, and test it runs locally
 ```
 
-### 3.2 Container Build (if applicable)
+### 3.2 Container Build and testing with Postgres and Redis (compose)
 
 ```bash
 make docker-prod    # Build a new image
+# Change: image: mcpgateway/mcpgateway:latest in docker-compose.yml to use the local image
 make compose-up     # spins up the Docker Compose stack
+
+# Test the basics
+curl -k https://localhost:4444/health` # {"status":"healthy"}
+export MCPGATEWAY_BEARER_TOKEN=$(python3 -m mcpgateway.utils.create_jwt_token --username admin --exp 0 --secret my-test-key)
+curl -sk -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" http://localhost:4444/version  | jq -c '.database, .redis'
+
+# Add an MCP server to http://localhost:4444 then check logs:
+make compose-logs
 ```
 
 ### 3.3 Automated Tests
 
 ```bash
-make test           # or `pytest`, `npm test`, etc.
+make test           # or `pytest`
 ```
 
 ### 3.4 Lint & Static Analysis