Skip to content

Commit 9d27abd

Browse files
committed
docs: update README — add helm-charts/proto repos, helm install instructions
1 parent fa64095 commit 9d27abd

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ Nantian Gateway provides a split-plane architecture for Kubernetes Gateway API.
1212
The project is organized across three sibling repositories:
1313

1414
| Repository | Description |
15-
|---|---|
16-
| **nantian-gw/nantian-gw** (this repo) | Go control plane, proto contract, deploy configs, tests, docs |
15+
|---|---|---|
16+
| **nantian-gw/nantian-gw** (this repo) | Go control plane, deploy configs, tests, docs |
1717
| **nantian-gw/dataplane** | Rust data plane (HTTP/stream proxy runtime, xDS client, AI gateway, Wasm plugins) |
1818
| **nantian-gw/dashboard** | Next.js/React admin console and Node proxy server |
1919
| **nantian-gw/website** | Project website and documentation site |
20+
| **nantian-gw/helm-charts** | Helm charts for Kubernetes deployment |
21+
| **nantian-gw/proto** | Shared protobuf contract between control plane and data plane |
2022

2123
## Architecture
2224

@@ -72,7 +74,12 @@ For a quick trial with Kind:
7274
For longer-running environments:
7375

7476
```bash
77+
# Kustomize
7578
kubectl apply -k deploy/kubernetes/overlays/production
79+
80+
# Helm
81+
helm repo add nantian-gw https://nantian-gw.github.io/helm-charts
82+
helm install nantian-gw nantian-gw/nantian-gw --namespace nantian-gw --create-namespace
7683
```
7784

7885
See `docs/user/getting-started.md` and `deploy/README.md` for detailed setup instructions.

0 commit comments

Comments
 (0)