|
1 | 1 | --- |
2 | | -title: "eoAPI Kubernetes Documentation" |
3 | | -description: "Technical documentation for deploying and operating eoAPI on Kubernetes clusters" |
| 2 | +title: "eoAPI Kubernetes" |
| 3 | +description: "Production-ready Kubernetes deployment" |
4 | 4 | external_links: |
5 | | - - name: "Main eoapi Repository" |
6 | | - url: "https://github.com/developmentseed/eoapi" |
7 | 5 | - name: "eoapi-k8s Repository" |
8 | 6 | url: "https://github.com/developmentseed/eoapi-k8s" |
9 | 7 | --- |
10 | 8 |
|
11 | | -# eoAPI Kubernetes Documentation |
| 9 | +# eoAPI Kubernetes |
12 | 10 |
|
13 | | -Technical documentation for deploying and operating eoAPI on Kubernetes clusters. |
| 11 | +Production-ready Kubernetes deployment for eoAPI. |
14 | 12 |
|
15 | | -## Architecture |
| 13 | +The source code is maintained in the [eoapi-k8s repository](https://github.com/developmentseed/eoapi-k8s). Contributions are welcome! |
16 | 14 |
|
17 | | -When deployed with default settings, eoAPI provides: |
| 15 | +## Kubernetes Architecture |
18 | 16 |
|
19 | | -- High-availability PostgreSQL cluster (via PostgreSQL Operator) |
20 | | -- Load balancer with path-based routing: |
21 | | - - `/stac` → STAC API |
22 | | - - `/raster` → TiTiler raster API |
23 | | - - `/vector` → TiPG vector API |
24 | | - - `/browser` → STAC Browser |
25 | | - - `/` → Documentation server |
26 | | -- Horizontal pod autoscaling based on CPU or request rate metrics |
27 | | -- Persistent storage with dynamic volume provisioning |
28 | | -- TLS termination and certificate management |
29 | | -- Health checks at `/stac/_mgmt/ping`, `/raster/healthz`, `/vector/healthz` |
30 | | - |
31 | | -## Quick Start |
32 | | - |
33 | | -Please refer to our [quick start guide](./quick-start.md) |
34 | | - |
35 | | -## Installation |
36 | | - |
37 | | -1. Set up a Kubernetes cluster using one of the cloud provider guides |
38 | | -2. Install the PostgreSQL Operator dependency |
39 | | -2. Configure your deployment using the [Configuration Options](./configuration.md) |
40 | | -3. Deploy using [Helm Installation](./helm-install.md) instructions |
41 | | -4. Set up monitoring with [Autoscaling & Monitoring](./autoscaling.md) |
| 17 | +This deployment provides: |
42 | 18 |
|
43 | | -## Documentation |
44 | | - |
45 | | -### Cloud Provider Guides |
46 | | -- **[AWS EKS Setup](./aws-eks.md)** - Complete EKS cluster setup with OIDC, node autoscaling, EBS CSI, and NGINX ingress |
47 | | -- **[GCP GKE Setup](./gcp-gke.md)** - GKE cluster creation with CSI driver, NGINX ingress, and cert-manager |
48 | | -- **[Azure AKS Setup](./azure.md)** - Azure configuration with managed PostgreSQL, Key Vault integration, and Workload Identity |
49 | | - |
50 | | -### Installation & Configuration |
51 | | -- **[Configuration Options](./configuration.md)** - Complete reference for Helm values, database types, ingress setup, and service configuration |
52 | | -- **[Manual Helm Installation](./helm-install.md)** - Step-by-step Helm deployment process with custom configurations |
53 | | -- **[Unified Ingress Configuration](./unified-ingress.md)** - NGINX and Traefik ingress setup with TLS and cert-manager integration |
54 | | - |
55 | | -### Database Management |
56 | | -- **[Data Management](./manage-data.md)** - Loading STAC collections and items into PostgreSQL using pypgstac |
57 | | - |
58 | | -### Operations & Monitoring |
59 | | -- **[Autoscaling & Monitoring](./autoscaling.md)** - HPA setup with custom metrics, Grafana dashboards, Prometheus configuration, and load testing |
| 19 | +- Path-based ingress routing (`/stac`, `/raster`, `/vector`, `/browser`, ..) |
| 20 | +- A PostgreSQL cluster (via PostgreSQL Operator) |
| 21 | +- TLS termination and certificate management |
| 22 | +- Persistent storage with dynamic volume provisioning |
| 23 | +- Horizontal pod autoscaling with custom metrics |
| 24 | +- Built-in health checks and monitoring at `/stac/_mgmt/ping`, `/raster/healthz`, `/vector/healthz` |
60 | 25 |
|
61 | | -### Advanced Features |
62 | | -- **[STAC Auth Proxy Integration](./stac-auth-proxy.md)** - Service-specific ingress control for authenticated STAC access |
| 26 | +## Getting Started |
63 | 27 |
|
64 | | -### Development & Release |
65 | | -- **[Release Workflow](./release.md)** - Chart versioning, GitHub releases, and Helm repository publishing process |
| 28 | +Ready to deploy? Start with our [Quick Start guide](./quick-start.md) for fast installation, or explore the full documentation below for production deployments. |
0 commit comments