Skip to content

Commit 4a71802

Browse files
feat: revamp kubernetes doc (#3173)
Signed-off-by: Julien Mancuso <161955438+julienmancuso@users.noreply.github.com> Co-authored-by: hhzhang16 <54051230+hhzhang16@users.noreply.github.com>
1 parent 13a5d61 commit 4a71802

File tree

38 files changed

+108
-89
lines changed

38 files changed

+108
-89
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Rerun with `curl -N` and change `stream` in the request to `true` to get the res
148148

149149
### Deploying Dynamo
150150

151-
- Follow the [Quickstart Guide](docs/guides/dynamo_deploy/README.md) to deploy on Kubernetes.
151+
- Follow the [Quickstart Guide](docs/kubernetes/README.md) to deploy on Kubernetes.
152152
- Check out [Backends](components/backends) to deploy various workflow configurations (e.g. SGLang with router, vLLM with disaggregated serving, etc.)
153153
- Run some [Examples](examples) to learn about building components in Dynamo and exploring various integrations.
154154

components/backends/sglang/deploy/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ extraPodSpec:
7474

7575
Before using these templates, ensure you have:
7676

77-
1. **Dynamo Cloud Platform installed** - See [Installing Dynamo Cloud](../../../../docs/guides/dynamo_deploy/installation_guide.md)
77+
1. **Dynamo Cloud Platform installed** - See [Installing Dynamo Cloud](../../../../docs/kubernetes/installation_guide.md)
7878
2. **Kubernetes cluster with GPU support**
7979
3. **Container registry access** for SGLang runtime images
8080
4. **HuggingFace token secret** (referenced as `envFromSecret: hf-token-secret`)
@@ -144,9 +144,9 @@ All templates use **DeepSeek-R1-Distill-Llama-8B** as the default model. But you
144144

145145
## Further Reading
146146

147-
- **Deployment Guide**: [Creating Kubernetes Deployments](../../../../docs/guides/dynamo_deploy/create_deployment.md)
148-
- **Quickstart**: [Deployment Quickstart](../../../../docs/guides/dynamo_deploy/README.md)
149-
- **Platform Setup**: [Dynamo Cloud Installation](../../../../docs/guides/dynamo_deploy/installation_guide.md)
147+
- **Deployment Guide**: [Creating Kubernetes Deployments](../../../../docs/kubernetes/create_deployment.md)
148+
- **Quickstart**: [Deployment Quickstart](../../../../docs/kubernetes/README.md)
149+
- **Platform Setup**: [Dynamo Cloud Installation](../../../../docs/kubernetes/installation_guide.md)
150150
- **Examples**: [Deployment Examples](../../../../docs/examples/README.md)
151151
- **Kubernetes CRDs**: [Custom Resources Documentation](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)
152152

@@ -159,4 +159,4 @@ Common issues and solutions:
159159
3. **Health check failures**: Review model loading logs and increase `initialDelaySeconds`
160160
4. **Out of memory**: Increase memory limits or reduce model batch size
161161

162-
For additional support, refer to the [deployment guide](../../../../docs/guides/dynamo_deploy/README.md).
162+
For additional support, refer to the [deployment guide](../../../../docs/kubernetes/README.md).

components/backends/trtllm/deploy/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ extraPodSpec:
102102

103103
Before using these templates, ensure you have:
104104

105-
1. **Dynamo Cloud Platform installed** - See [Quickstart Guide](../../../../docs/guides/dynamo_deploy/README.md)
105+
1. **Dynamo Cloud Platform installed** - See [Quickstart Guide](../../../../docs/kubernetes/README.md)
106106
2. **Kubernetes cluster with GPU support**
107107
3. **Container registry access** for TensorRT-LLM runtime images
108108
4. **HuggingFace token secret** (referenced as `envFromSecret: hf-token-secret`)
@@ -153,7 +153,7 @@ args:
153153

154154
### 3. Deploy
155155

156-
See the [Create Deployment Guide](../../../../docs/guides/dynamo_deploy/create_deployment.md) to learn how to deploy the deployment file.
156+
See the [Create Deployment Guide](../../../../docs/kubernetes/create_deployment.md) to learn how to deploy the deployment file.
157157

158158
First, create a secret for the HuggingFace token.
159159
```bash
@@ -277,9 +277,9 @@ Configure the `model` name and `host` based on your deployment.
277277

278278
## Further Reading
279279

280-
- **Deployment Guide**: [Creating Kubernetes Deployments](../../../../docs/guides/dynamo_deploy/create_deployment.md)
281-
- **Quickstart**: [Deployment Quickstart](../../../../docs/guides/dynamo_deploy/README.md)
282-
- **Platform Setup**: [Dynamo Cloud Installation](../../../../docs/guides/dynamo_deploy/installation_guide.md)
280+
- **Deployment Guide**: [Creating Kubernetes Deployments](../../../../docs/kubernetes/create_deployment.md)
281+
- **Quickstart**: [Deployment Quickstart](../../../../docs/kubernetes/README.md)
282+
- **Platform Setup**: [Dynamo Cloud Installation](../../../../docs/kubernetes/installation_guide.md)
283283
- **Examples**: [Deployment Examples](../../../../docs/examples/README.md)
284284
- **Architecture Docs**: [Disaggregated Serving](../../../../docs/architecture/disagg_serving.md), [KV-Aware Routing](../../../../docs/architecture/kv_cache_routing.md)
285285
- **Multinode Deployment**: [Multinode Examples](../multinode/multinode-examples.md)
@@ -298,4 +298,4 @@ Common issues and solutions:
298298
6. **Git LFS issues**: Ensure git-lfs is installed before building containers
299299
7. **ARM deployment**: Use `--platform linux/arm64` when building on ARM machines
300300

301-
For additional support, refer to the [deployment troubleshooting guide](../../../../docs/guides/dynamo_deploy/README.md).
301+
For additional support, refer to the [deployment troubleshooting guide](../../../../docs/kubernetes/README.md).

components/backends/vllm/deploy/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ extraPodSpec:
8282

8383
Before using these templates, ensure you have:
8484

85-
1. **Dynamo Cloud Platform installed** - See [Quickstart Guide](../../../../docs/guides/dynamo_deploy/README.md)
85+
1. **Dynamo Cloud Platform installed** - See [Quickstart Guide](../../../../docs/kubernetes/README.md)
8686
2. **Kubernetes cluster with GPU support**
8787
3. **Container registry access** for vLLM runtime images
8888
4. **HuggingFace token secret** (referenced as `envFromSecret: hf-token-secret`)
@@ -234,10 +234,10 @@ args:
234234
235235
## Further Reading
236236
237-
- **Deployment Guide**: [Creating Kubernetes Deployments](../../../../docs/guides/dynamo_deploy/create_deployment.md)
238-
- **Quickstart**: [Deployment Quickstart](../../../../docs/guides/dynamo_deploy/README.md)
239-
- **Platform Setup**: [Dynamo Cloud Installation](../../../../docs/guides/dynamo_deploy/installation_guide.md)
240-
- **SLA Planner**: [SLA Planner Deployment Guide](../../../../docs/guides/dynamo_deploy/sla_planner_deployment.md)
237+
- **Deployment Guide**: [Creating Kubernetes Deployments](../../../../docs/kubernetes/create_deployment.md)
238+
- **Quickstart**: [Deployment Quickstart](../../../../docs/kubernetes/README.md)
239+
- **Platform Setup**: [Dynamo Cloud Installation](../../../../docs/kubernetes/installation_guide.md)
240+
- **SLA Planner**: [SLA Planner Deployment Guide](../../../../docs/kubernetes/sla_planner_deployment.md)
241241
- **Examples**: [Deployment Examples](../../../../docs/examples/README.md)
242242
- **Architecture Docs**: [Disaggregated Serving](../../../../docs/architecture/disagg_serving.md), [KV-Aware Routing](../../../../docs/architecture/kv_cache_routing.md)
243243
@@ -251,4 +251,4 @@ Common issues and solutions:
251251
4. **Out of memory**: Increase memory limits or reduce model batch size
252252
5. **Port forwarding issues**: Ensure correct pod UUID in port-forward command
253253

254-
For additional support, refer to the [deployment troubleshooting guide](../../../../docs/guides/dynamo_deploy/README.md).
254+
For additional support, refer to the [deployment troubleshooting guide](../../../../docs/kubernetes/README.md).

deploy/cloud/helm/crds/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ limitations under the License.
1717

1818
# Dynamo Kubernetes Platform CRDs Helm Chart
1919

20-
This chart installs the [CRDs](../../../../docs/guides/dynamo_deploy/api_reference.md) for the Dynamo Kubernetes Platform.
20+
This chart installs the [CRDs](../../../../docs/kubernetes/api_reference.md) for the Dynamo Kubernetes Platform.

deploy/cloud/helm/platform/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ For detailed etcd configuration options beyond `etcd.enabled`, please refer to t
103103

104104
## 📚 Additional Resources
105105

106-
- [Dynamo Cloud Deployment Installation Guide](../../../../docs/guides/dynamo_deploy/installation_guide.md)
106+
- [Dynamo Cloud Deployment Installation Guide](../../../../docs/kubernetes/installation_guide.md)
107107
- [NATS Documentation](https://docs.nats.io/)
108108
- [etcd Documentation](https://etcd.io/docs/)
109109
- [Kubernetes Operator Pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)

deploy/cloud/helm/platform/README.md.gotmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ For detailed etcd configuration options beyond `etcd.enabled`, please refer to t
5757

5858
## 📚 Additional Resources
5959

60-
- [Dynamo Cloud Deployment Installation Guide](../../../../docs/guides/dynamo_deploy/installation_guide.md)
60+
- [Dynamo Cloud Deployment Installation Guide](../../../../docs/kubernetes/installation_guide.md)
6161
- [NATS Documentation](https://docs.nats.io/)
6262
- [etcd Documentation](https://etcd.io/docs/)
6363
- [Kubernetes Operator Pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)

deploy/cloud/operator/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ generate-api-docs: crd-ref-docs ## Generate API reference documentation from CRD
288288
--output-path=./docs/api_reference.md
289289
@echo "✅ Generated API reference at ./docs/api_reference.md"
290290
# concatenate header.md and api_reference.md
291-
cat docs/header.md ./docs/api_reference.md > ../../../docs/guides/dynamo_deploy/api_reference.md
291+
cat docs/header.md ./docs/api_reference.md > ../../../docs/kubernetes/api_reference.md
292292
rm ./docs/api_reference.md
293293
@echo "✅ Concatenated header.md and api_reference.md"
294294

deploy/cloud/operator/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ make
2424

2525
### Install
2626

27-
See [Dynamo Kubernetes Platform Installation Guide](/docs/guides/dynamo_deploy/installation_guide.md) for installation instructions.
27+
See [Dynamo Kubernetes Platform Installation Guide](/docs/kubernetes/installation_guide.md) for installation instructions.

deploy/inference-gateway/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Currently, these setups are only supported with the kGateway based Inference Gat
2424

2525
### 1. Install Dynamo Platform ###
2626

27-
[See Quickstart Guide](../../docs/guides/dynamo_deploy/README.md) to install Dynamo Cloud.
27+
[See Quickstart Guide](../../docs/kubernetes/README.md) to install Dynamo Cloud.
2828

2929

3030
### 2. Deploy Inference Gateway ###

0 commit comments

Comments
 (0)