Skip to content

Commit a7919c9

Browse files
committed
docs(deployment): say Smart Router runs on Kubernetes and whom to talk to (MAG-4723)
The site lists a local binary, Docker Compose and the wizard, and says nothing about Kubernetes. Magma Devs supports Kubernetes deployments. Add a Kubernetes page under Run Smart Router with the support line, the contact, and what a cluster needs from the router: /livez and /readyz on the metrics server (off until --metrics-listen-address is set), the health check left on, and the multi-arch GHCR image. Note it on the overview beside the managed-option note, and list it in the nav and llms.txt. Same note as smart-router#616 in the repo.
1 parent 01a54c3 commit a7919c9

4 files changed

Lines changed: 29 additions & 0 deletions

File tree

‎docs/deployment/index.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ Pick how you want to run it:
2121
These docs cover the **self-hosted** Smart Router. If you'd rather not operate it
2222
yourself, [talk to us](https://magmadevs.com/contact).
2323

24+
!!! note "Running on Kubernetes?"
25+
Smart Router runs on Kubernetes, and Magma Devs supports Kubernetes deployments.
26+
[Kubernetes](kubernetes.md) lists what a cluster needs from the router;
27+
[talk to us](https://magmadevs.com/contact) to run it on yours.
28+
2429
## Prerequisites
2530

2631
All three methods start from a clone of the repo — it carries the compose files, example

‎docs/deployment/kubernetes.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "Kubernetes"
3+
description: "Smart Router runs on Kubernetes, and Magma Devs supports Kubernetes deployments — what a cluster needs from the router, and whom to talk to."
4+
---
5+
6+
# Kubernetes
7+
8+
Smart Router runs on Kubernetes, and Magma Devs supports Kubernetes deployments. To run it on
9+
your cluster, or for help with one you already run, [talk to us](https://magmadevs.com/contact).
10+
11+
## What a cluster needs from the router
12+
13+
- **Probes.** The router serves `/livez` and `/readyz` on its metrics server, which is off until
14+
`--metrics-listen-address` is set (for example `:7779`). `/livez` answers `200` while the
15+
process serves HTTP, so it suits a liveness probe. `/readyz` answers `503` while no chain is
16+
healthy, so it suits a readiness probe: the pod leaves the Service without restarting.
17+
[When readiness changes](../reference/metrics.md#when-readiness-changes) says what makes a
18+
chain healthy.
19+
- **The health check stays on.** `--relays-health-enable` is on by default. With it off,
20+
`/readyz` answers `503` unconditionally (see [CLI flags](../reference/cli.md)).
21+
- **The image.** `ghcr.io/magma-devs/smart-router:vX.Y.Z`, for `linux/amd64` and `linux/arm64`,
22+
carries the same binary as the [release](https://github.com/Magma-Devs/smart-router/releases).

‎docs/llms.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ These docs are for the open-source core (PolyForm Noncommercial license); manage
2424
- [Local binary](https://docs.magmadevs.com/deployment/local-binary/): Build and run the Smart Router binary natively on your host.
2525
- [Docker Compose](https://docs.magmadevs.com/deployment/docker-compose/): Run Smart Router and its dependencies with the bundled Docker Compose stack.
2626
- [Config wizard](https://docs.magmadevs.com/deployment/wizard/): An interactive TUI (`make wizard`) that picks chains, collects upstreams, health-checks them, writes the config, and brings up the stack.
27+
- [Kubernetes](https://docs.magmadevs.com/deployment/kubernetes/): Smart Router runs on Kubernetes, and Magma Devs supports Kubernetes deployments — the probes, flags and image a cluster needs, and whom to talk to.
2728
- [Cache](https://docs.magmadevs.com/deployment/cache/): Deploy the standalone, block-aware, reorg-safe cache that absorbs repeat reads and can be shared across router replicas.
2829
- [Redis / Valkey backend](https://docs.magmadevs.com/deployment/cache/redis/): Run the cache against a RESP-compatible backend (Redis, Valkey, ElastiCache, MemoryDB) instead of the sidecar — persistent, shared across replicas, with Sentinel/Cluster failover and multi-region read/write split.
2930
- [Secondary cache](https://docs.magmadevs.com/deployment/cache/secondary/): An optional read-only second cache tier, consulted on a primary miss before falling through to upstream nodes — typically another zone's cache.

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ nav:
156156
- Local binary: deployment/local-binary.md
157157
- Docker Compose: deployment/docker-compose.md
158158
- Config wizard: deployment/wizard.md
159+
- Kubernetes: deployment/kubernetes.md
159160
- Cache:
160161
- deployment/cache/index.md
161162
- Redis / Valkey backend: deployment/cache/redis.md

0 commit comments

Comments
 (0)