Skip to content

Commit 9f537ab

Browse files
committed
Added basic README.md and tests.
1 parent 78525b1 commit 9f537ab

File tree

1 file changed

+82
-0
lines changed

1 file changed

+82
-0
lines changed

helm/README.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# STAC Auth Proxy Helm Chart
2+
3+
A Helm chart for deploying [STAC Auth Proxy](https://developmentseed.org/stac-auth-proxy) on Kubernetes.
4+
5+
## Overview
6+
7+
This chart deploys a reverse proxy that adds authentication and authorization capabilities to your STAC API using OpenID Connect (OIDC).
8+
9+
## Prerequisites
10+
11+
- Kubernetes 1.19+
12+
- Helm 3.0+
13+
- An OIDC provider (e.g., Keycloak, Auth0, Google, etc.)
14+
- A STAC API backend
15+
16+
## Installation
17+
18+
```bash
19+
helm install stac-auth-proxy ./stac-auth-proxy \
20+
--set env.UPSTREAM_URL=https://your-stac-api.example.com \
21+
--set env.OIDC_DISCOVERY_URL=https://your-oidc-provider.example.com/.well-known/openid-configuration \
22+
--set ingress.host=stac-proxy.example.com
23+
```
24+
25+
## Configuration
26+
27+
### Required Values
28+
29+
| Parameter | Description |
30+
|-----------|-------------|
31+
| `env.UPSTREAM_URL` | URL of the upstream STAC API |
32+
| `env.OIDC_DISCOVERY_URL` | OpenID Connect discovery URL |
33+
| `ingress.host` | Hostname for the ingress |
34+
35+
### Common Configurations
36+
37+
See [`values.yaml`](./values.yaml) for all available configuration options, including:
38+
39+
- **Authentication**: Configure OIDC settings and endpoint protection
40+
- **Resources**: Set CPU/memory limits and requests
41+
- **Ingress**: Configure TLS, annotations, and hostname
42+
- **Security**: Pod and container security contexts
43+
44+
### Example: Custom Values File
45+
46+
```yaml
47+
# custom-values.yaml
48+
image:
49+
tag: "v1.0.0"
50+
51+
ingress:
52+
host: "my-stac-api.example.com"
53+
54+
env:
55+
UPSTREAM_URL: "https://stac-api.internal:8080"
56+
OIDC_DISCOVERY_URL: "https://my-auth.example.com/.well-known/openid-configuration"
57+
DEFAULT_PUBLIC: false
58+
```
59+
60+
Install with custom values:
61+
62+
```bash
63+
helm install stac-auth-proxy ./stac-auth-proxy -f custom-values.yaml
64+
```
65+
66+
## Upgrading
67+
68+
```bash
69+
helm upgrade stac-auth-proxy ./stac-auth-proxy -f custom-values.yaml
70+
```
71+
72+
## Uninstalling
73+
74+
```bash
75+
helm uninstall stac-auth-proxy
76+
```
77+
78+
## Documentation
79+
80+
For more information about STAC Auth Proxy features and configuration:
81+
- [Project Documentation](https://developmentseed.org/stac-auth-proxy)
82+
- [GitHub Repository](https://github.com/developmentseed/stac-auth-proxy)

0 commit comments

Comments
 (0)