fix hardcoded localhost:5000

Author: yejiyang

README.md

@@ -5,34 +5,65 @@ This repository contains a minimal Docker Compose setup for running
 [MapLibre](https://maplibre.org/) and [Chart.js](https://www.chartjs.org/).
 
 ## Prerequisites
+
 - Docker Desktop with Docker Compose v2+
 - (Optional) GDAL >= 3.0 for converting data to other formats
 
 ## Usage
+
 1. Build and start the services:
    ```bash
    docker compose up --build
    ```
 2. Access pygeoapi at [http://localhost:5000](http://localhost:5000)
 3. Access the frontend at [http://localhost:8080](http://localhost:8080)
 
+## Deployment
+
+### Environment Variables
+
+When deploying pygeoapi in different environments (local, Kubernetes, etc.), the following environment variables should be set:
+
+- `PYGEOAPI_SERVER_URL`: The external URL where pygeoapi will be accessible. This is used to generate correct links in the API responses.
+  - For local development: `http://localhost:5000`
+  - For Kubernetes/production: Your domain, e.g., `https://your-domain.com`
+
+### Kubernetes Deployment
+
+To deploy to Kubernetes:
+
+1. Edit the `k8s-pygeoapi.yaml` file to set the correct `PYGEOAPI_SERVER_URL` for your environment
+2. Apply the Kubernetes configuration:
+   ```bash
+   kubectl apply -f k8s-pygeoapi.yaml
+   ```
+
+The Kubernetes deployment includes:
+
+- A Deployment for pygeoapi
+- A Service to expose pygeoapi within the cluster
+- An Ingress resource (optional) to expose pygeoapi externally
+
 The backend Docker image now generates the OpenAPI document at build
 time and exposes it via the `PYGEOAPI_OPENAPI` environment variable.
 
 The frontend fetches features from pygeoapi and displays them on a
 MapLibre map and Chart.js chart.
 
 ## Data
+
 The sample dataset resides in `data/norway/norway-hazard-points.geojson`. You can replace
 this file with your own dataset. Update `pygeoapi-config.yml`
 if you change the path or dataset name.
 
 ## Development
+
 This repository uses **Black**, **isort**, and **Ruff** for Python code. The frontend is formatted with **Prettier**. Recommended VS Code settings are provided in the `.vscode` folder.
 Run `pip install -r requirements-dev.txt` to install Python tooling. Frontend formatting tools can be installed by running `npm install` inside the `frontend` directory.
 Use `npm run format` to format frontend code.
 
 ## CI/CD
+
 A GitHub Actions workflow builds and publishes the frontend Docker image whenever
 changes are pushed to the `frontend/` directory on the `main` branch. The image
 is pushed to the GitHub Container Registry under the tag

docker-compose.yml

@@ -13,6 +13,7 @@ services:
       - CONTAINER_NAME=pygeoapi
       - CONTAINER_HOST=0.0.0.0
       - CONTAINER_PORT=5000
+      - PYGEOAPI_SERVER_URL=${PYGEOAPI_SERVER_URL:-http://localhost:5000}
 
   frontend:
     image: ${FRONTEND_IMAGE:-ghcr.io/yejiyang/global-tsunami-risk-map-frontend:latest}
@@ -37,6 +38,7 @@ services:
       - CONTAINER_NAME=pygeoapi
       - CONTAINER_HOST=0.0.0.0
       - CONTAINER_PORT=5000
+      - PYGEOAPI_SERVER_URL=http://localhost:5000
     profiles:
       - local
 

k8s-pygeoapi.yaml

@@ -0,0 +1,71 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: pygeoapi
+  labels:
+    app: pygeoapi
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: pygeoapi
+  template:
+    metadata:
+      labels:
+        app: pygeoapi
+    spec:
+      containers:
+        - name: pygeoapi
+          image: ghcr.io/yejiyang/pygeoapi-w-global-tsunami-data:latest
+          ports:
+            - containerPort: 5000
+          env:
+            - name: PYGEOAPI_CONFIG
+              value: /pygeoapi/local.config.yml
+            - name: PYGEOAPI_OPENAPI
+              value: /tmp/openapi.yml
+            - name: CONTAINER_NAME
+              value: pygeoapi
+            - name: CONTAINER_HOST
+              value: 0.0.0.0
+            - name: CONTAINER_PORT
+              value: "5000"
+            - name: PYGEOAPI_SERVER_URL
+              # The URL that users will access your service through - adjust based on your Kubernetes setup
+              # This could be your ingress URL or load balancer address
+              value: "https://your-domain.com" # Replace with your actual domain
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: pygeoapi
+spec:
+  selector:
+    app: pygeoapi
+  ports:
+    - port: 80
+      targetPort: 5000
+  type: ClusterIP
+---
+# Optional: If you're using an Ingress controller
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: pygeoapi-ingress
+  annotations:
+    # Add appropriate annotations for your ingress controller
+    # For example, for nginx:
+    # kubernetes.io/ingress.class: nginx
+    # nginx.ingress.kubernetes.io/rewrite-target: /
+spec:
+  rules:
+    - host: your-domain.com # Replace with your actual domain
+      http:
+        paths:
+          - path: /
+            pathType: Prefix
+            backend:
+              service:
+                name: pygeoapi
+                port:
+                  number: 80

pygeoapi/pygeoapi-config.yml

@@ -2,7 +2,7 @@ server:
   bind:
     host: 0.0.0.0
     port: 5000
-  url: http://localhost:5000/
+  url: ${PYGEOAPI_SERVER_URL:-http://localhost:5000/}
   mimetype: application/json; charset=UTF-8
   encoding: utf-8
   language: en-US
@@ -29,13 +29,13 @@ metadata:
       - api
     keywords_type: theme
     terms_of_service: https://creativecommons.org/licenses/by/4.0/
-    url: http://localhost:5000
+    url: ${PYGEOAPI_SERVER_URL:-http://localhost:5000}
   license:
     name: CC-BY 4.0 license
     url: https://creativecommons.org/licenses/by/4.0/
   provider:
     name: Organization Name
-    url: http://localhost:5000
+    url: ${PYGEOAPI_SERVER_URL:-http://localhost:5000}
   contact:
     name: Admin
     position: Admin
@@ -54,7 +54,7 @@ resources:
       - type: application/geo+json
         rel: items
         title: Norway Hazard Points (GeoJSON)
-        href: http://localhost:5000/collections/points/items
+        href: "${PYGEOAPI_SERVER_URL:-http://localhost:5000}/collections/points/items"
     extents:
       spatial:
         bbox: [3, 56, 32, 72] # Norway with 100km buffer
@@ -90,11 +90,11 @@ resources:
       - type: application/geo+json
         rel: items
         title: Global Hazard Points (GeoJSON)
-        href: http://localhost:5000/collections/hazardglobal/items
+        href: "${PYGEOAPI_SERVER_URL:-http://localhost:5000}/collections/hazardglobal/items"
       - type: application/vnd.mapbox-vector-tile
         rel: tiles
         title: Global Hazard Points (Vector Tiles)
-        href: http://localhost:5000/collections/hazardglobal/tiles
+        href: "${PYGEOAPI_SERVER_URL:-http://localhost:5000}/collections/hazardglobal/tiles"
     extents:
       spatial:
         bbox: [-180, -90, 180, 90]