Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
feat: revamp kubernetes doc
  • Loading branch information
julienmancuso committed Sep 23, 2025
commit e305ea6e32441888925ac58412fb0eeefa59915d
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Rerun with `curl -N` and change `stream` in the request to `true` to get the res

### Deploying Dynamo

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

Expand Down
10 changes: 5 additions & 5 deletions components/backends/sglang/deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ extraPodSpec:

Before using these templates, ensure you have:

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

## Further Reading

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

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

For additional support, refer to the [deployment guide](../../../../docs/guides/dynamo_deploy/README.md).
For additional support, refer to the [deployment guide](../../../../docs/kubernetes/README.md).
12 changes: 6 additions & 6 deletions components/backends/trtllm/deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ extraPodSpec:

Before using these templates, ensure you have:

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

### 3. Deploy

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

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

## Further Reading

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

For additional support, refer to the [deployment troubleshooting guide](../../../../docs/guides/dynamo_deploy/README.md).
For additional support, refer to the [deployment troubleshooting guide](../../../../docs/kubernetes/README.md).
12 changes: 6 additions & 6 deletions components/backends/vllm/deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ extraPodSpec:

Before using these templates, ensure you have:

1. **Dynamo Cloud Platform installed** - See [Quickstart Guide](../../../../docs/guides/dynamo_deploy/README.md)
1. **Dynamo Cloud Platform installed** - See [Quickstart Guide](../../../../docs/kubernetes/README.md)
2. **Kubernetes cluster with GPU support**
3. **Container registry access** for vLLM runtime images
4. **HuggingFace token secret** (referenced as `envFromSecret: hf-token-secret`)
Expand Down Expand Up @@ -234,10 +234,10 @@ args:

## Further Reading

- **Deployment Guide**: [Creating Kubernetes Deployments](../../../../docs/guides/dynamo_deploy/create_deployment.md)
- **Quickstart**: [Deployment Quickstart](../../../../docs/guides/dynamo_deploy/README.md)
- **Platform Setup**: [Dynamo Cloud Installation](../../../../docs/guides/dynamo_deploy/installation_guide.md)
- **SLA Planner**: [SLA Planner Deployment Guide](../../../../docs/guides/dynamo_deploy/sla_planner_deployment.md)
- **Deployment Guide**: [Creating Kubernetes Deployments](../../../../docs/kubernetes/create_deployment.md)
- **Quickstart**: [Deployment Quickstart](../../../../docs/kubernetes/README.md)
- **Platform Setup**: [Dynamo Cloud Installation](../../../../docs/kubernetes/installation_guide.md)
- **SLA Planner**: [SLA Planner Deployment Guide](../../../../docs/kubernetes/sla_planner_deployment.md)
- **Examples**: [Deployment Examples](../../../../docs/examples/README.md)
- **Architecture Docs**: [Disaggregated Serving](../../../../docs/architecture/disagg_serving.md), [KV-Aware Routing](../../../../docs/architecture/kv_cache_routing.md)

Expand All @@ -251,4 +251,4 @@ Common issues and solutions:
4. **Out of memory**: Increase memory limits or reduce model batch size
5. **Port forwarding issues**: Ensure correct pod UUID in port-forward command

For additional support, refer to the [deployment troubleshooting guide](../../../../docs/guides/dynamo_deploy/README.md).
For additional support, refer to the [deployment troubleshooting guide](../../../../docs/kubernetes/README.md).
2 changes: 1 addition & 1 deletion deploy/cloud/helm/crds/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ limitations under the License.

# Dynamo Kubernetes Platform CRDs Helm Chart

This chart installs the [CRDs](../../../../docs/guides/dynamo_deploy/api_reference.md) for the Dynamo Kubernetes Platform.
This chart installs the [CRDs](../../../../docs/kubernetes/api_reference.md) for the Dynamo Kubernetes Platform.
2 changes: 1 addition & 1 deletion deploy/cloud/helm/platform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ For detailed etcd configuration options beyond `etcd.enabled`, please refer to t

## 📚 Additional Resources

- [Dynamo Cloud Deployment Installation Guide](../../../../docs/guides/dynamo_deploy/installation_guide.md)
- [Dynamo Cloud Deployment Installation Guide](../../../../docs/kubernetes/installation_guide.md)
- [NATS Documentation](https://docs.nats.io/)
- [etcd Documentation](https://etcd.io/docs/)
- [Kubernetes Operator Pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
Expand Down
2 changes: 1 addition & 1 deletion deploy/cloud/helm/platform/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ For detailed etcd configuration options beyond `etcd.enabled`, please refer to t

## 📚 Additional Resources

- [Dynamo Cloud Deployment Installation Guide](../../../../docs/guides/dynamo_deploy/installation_guide.md)
- [Dynamo Cloud Deployment Installation Guide](../../../../docs/kubernetes/installation_guide.md)
- [NATS Documentation](https://docs.nats.io/)
- [etcd Documentation](https://etcd.io/docs/)
- [Kubernetes Operator Pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
Expand Down
2 changes: 1 addition & 1 deletion deploy/cloud/operator/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ generate-api-docs: crd-ref-docs ## Generate API reference documentation from CRD
--output-path=./docs/api_reference.md
@echo "✅ Generated API reference at ./docs/api_reference.md"
# concatenate header.md and api_reference.md
cat docs/header.md ./docs/api_reference.md > ../../../docs/guides/dynamo_deploy/api_reference.md
cat docs/header.md ./docs/api_reference.md > ../../../docs/kubernetes/api_reference.md
rm ./docs/api_reference.md
@echo "✅ Concatenated header.md and api_reference.md"

Expand Down
2 changes: 1 addition & 1 deletion deploy/cloud/operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ make

### Install

See [Dynamo Kubernetes Platform Installation Guide](/docs/guides/dynamo_deploy/installation_guide.md) for installation instructions.
See [Dynamo Kubernetes Platform Installation Guide](/docs/kubernetes/installation_guide.md) for installation instructions.
2 changes: 1 addition & 1 deletion deploy/inference-gateway/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Currently, these setups are only supported with the kGateway based Inference Gat

### 1. Install Dynamo Platform ###

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


### 2. Deploy Inference Gateway ###
Expand Down
2 changes: 1 addition & 1 deletion deploy/logging/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Dynamo Logging on Kubernetes

For detailed documentation on collecting and visualizing logs on Kubernetes, see [docs/guides/dynamo_deploy/logging.md](../../docs/guides/dynamo_deploy/logging.md).
For detailed documentation on collecting and visualizing logs on Kubernetes, see [docs/kubernetes/logging.md](../../docs/kubernetes/logging.md).
2 changes: 1 addition & 1 deletion deploy/metrics/k8s/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Dynamo Metrics Collection on Kubernetes

For detailed documentation on collecting and visualizing metrics on Kubernetes, see [docs/guides/dynamo_deploy/metrics.md](../../../docs/guides/dynamo_deploy/metrics.md).
For detailed documentation on collecting and visualizing metrics on Kubernetes, see [docs/kubernetes/metrics.md](../../../docs/kubernetes/metrics.md).
2 changes: 1 addition & 1 deletion deploy/utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This directory contains utilities and manifests for Dynamo benchmarking and prof

**Before using these utilities, you must first set up Dynamo Cloud following the main installation guide:**

👉 **[Follow the Dynamo Cloud installation guide](/docs/guides/dynamo_deploy/installation_guide.md) to install the Dynamo Kubernetes Platform first.**
👉 **[Follow the Dynamo Cloud installation guide](/docs/kubernetes/installation_guide.md) to install the Dynamo Kubernetes Platform first.**

This includes:
1. Installing the Dynamo CRDs
Expand Down
2 changes: 1 addition & 1 deletion deploy/utils/setup_benchmarking_resources.sh
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ fi
if ! kubectl get pods -n "$NAMESPACE" | grep -q "dynamo-platform"; then
warn "Dynamo platform pods not found in namespace $NAMESPACE"
warn "Please ensure Dynamo Cloud platform is installed first:"
warn " See: docs/guides/dynamo_deploy/installation_guide.md"
warn " See: docs/kubernetes/installation_guide.md"
if [[ -z "${FORCE:-}" && -z "${YES:-}" ]]; then
read -p "Continue anyway? [y/N]: " -r ans
[[ "$ans" =~ ^[Yy]$ ]] || exit 1
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/sla_planner.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Finally, SLA planner applies the change by scaling up/down the number of prefill

### K8s Deployment

For detailed deployment instructions including setup, configuration, troubleshooting, and architecture overview, see the [SLA Planner Deployment Guide](../guides/dynamo_deploy/sla_planner_deployment.md).
For detailed deployment instructions including setup, configuration, troubleshooting, and architecture overview, see the [SLA Planner Deployment Guide](../kubernetes/sla_planner_deployment.md).

**To deploy SLA Planner:**
```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/benchmarks/benchmarking.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The framework is a Python-based wrapper around `genai-perf` that:
Follow these steps to benchmark Dynamo deployments:

### Step 1: Establish Kubernetes Cluster and Install Dynamo
Set up your Kubernetes cluster with NVIDIA GPUs and install the Dynamo Cloud platform. First follow the [installation guide](/docs/guides/dynamo_deploy/installation_guide.md) to install Dynamo Cloud, then use [deploy/utils/README](../../deploy/utils/README.md) to set up benchmarking resources.
Set up your Kubernetes cluster with NVIDIA GPUs and install the Dynamo Cloud platform. First follow the [installation guide](/docs/kubernetes/installation_guide.md) to install Dynamo Cloud, then use [deploy/utils/README](../../deploy/utils/README.md) to set up benchmarking resources.

### Step 2: Deploy DynamoGraphDeployments
Deploy your DynamoGraphDeployments separately using the [deployment documentation](../../components/backends/). Each deployment should have a frontend service exposed.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,4 @@ curl -d '{"model": "Qwen/Qwen3-0.6B", "max_completion_tokens": 2049, "messages":
- [Distributed Runtime Architecture](../architecture/distributed_runtime.md)
- [Dynamo Architecture Overview](../architecture/architecture.md)
- [Backend Guide](backend.md)
- [Log Aggregation in Kubernetes](dynamo_deploy/logging.md)
- [Log Aggregation in Kubernetes](../kubernetes/logging.md)
2 changes: 1 addition & 1 deletion docs/guides/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Dynamo automatically exposes metrics with the `dynamo_` name prefixes. It also a

**Specialized Component Metrics**: Components can also expose additional metrics specific to their functionality. For example, a `preprocessor` component exposes metrics with the `dynamo_preprocessor_*` prefix. See the [Available Metrics section](../../deploy/metrics/README.md#available-metrics) for details on specialized component metrics.

**Kubernetes Integration**: For comprehensive Kubernetes deployment and monitoring setup, see the [Kubernetes Metrics Guide](dynamo_deploy/metrics.md). This includes Prometheus Operator setup, metrics collection configuration, and visualization in Grafana.
**Kubernetes Integration**: For comprehensive Kubernetes deployment and monitoring setup, see the [Kubernetes Metrics Guide](../kubernetes/metrics.md). This includes Prometheus Operator setup, metrics collection configuration, and visualization in Grafana.

## Metrics Hierarchy

Expand Down
18 changes: 9 additions & 9 deletions docs/hidden_toctree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,16 @@
API/nixl_connect/write_operation.md
API/nixl_connect/README.md

guides/dynamo_deploy/api_reference.md
guides/dynamo_deploy/create_deployment.md

guides/dynamo_deploy/fluxcd.md
guides/dynamo_deploy/gke_setup.md
guides/dynamo_deploy/grove.md
guides/dynamo_deploy/model_caching_with_fluid.md
guides/dynamo_deploy/README.md
kubernetes/api_reference.md
kubernetes/create_deployment.md

kubernetes/fluxcd.md
kubernetes/gke_setup.md
kubernetes/grove.md
kubernetes/model_caching_with_fluid.md
kubernetes/README.md
guides/dynamo_run.md
guides/dynamo_deploy/sla_planner_deployment.md
kubernetes/sla_planner_deployment.md
guides/metrics.md
guides/run_kvbm_in_vllm.md
guides/run_kvbm_in_trtllm.md
Expand Down
14 changes: 7 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,13 @@ Quickstart
:hidden:
:caption: Kubernetes Deployment

Quickstart (K8s) <../guides/dynamo_deploy/README.md>
Detailed Installation Guide <../guides/dynamo_deploy/installation_guide.md>
Dynamo Operator <../guides/dynamo_deploy/dynamo_operator.md>
Metrics <../guides/dynamo_deploy/metrics.md>
Logging <../guides/dynamo_deploy/logging.md>
Multinode <../guides/dynamo_deploy/multinode-deployment.md>
Minikube Setup <../guides/dynamo_deploy/minikube.md>
Quickstart (K8s) <../kubernetes/README.md>
Detailed Installation Guide <../kubernetes/installation_guide.md>
Dynamo Operator <../kubernetes/dynamo_operator.md>
Metrics <../kubernetes/metrics.md>
Logging <../kubernetes/logging.md>
Multinode <../kubernetes/multinode-deployment.md>
Minikube Setup <../kubernetes/minikube.md>

.. toctree::
:hidden:
Expand Down
3 changes: 1 addition & 2 deletions docs/kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,8 @@
helm install dynamo-crds dynamo-crds-${RELEASE_VERSION}.tgz --namespace default

# 3. Install Platform
kubectl create namespace ${NAMESPACE}
helm fetch https://helm.ngc.nvidia.com/nvidia/ai-dynamo/charts/dynamo-platform-${RELEASE_VERSION}.tgz
helm install dynamo-platform dynamo-platform-${RELEASE_VERSION}.tgz --namespace ${NAMESPACE}
helm install dynamo-platform dynamo-platform-${RELEASE_VERSION}.tgz --namespace ${NAMESPACE} --create-namespace
```

For more details or customization options (including multinode deployments), see **[Installation Guide for Dynamo Kubernetes Platform](/docs/kubernetes/installation_guide.md)**.
Expand Down Expand Up @@ -172,4 +171,4 @@
- **[Logging](/docs/kubernetes/logging.md)** - For logging setup
- **[Multinode Deployment](/docs/kubernetes/multinode-deployment.md)** - For multinode deployment
- **[Grove](/docs/kubernetes/grove.md)** - For grove details and custom installation
- **[Monitoring](/docs/kubernetes/monitoring.md)** - For monitoring setup

Check failure on line 174 in docs/kubernetes/README.md

View workflow job for this annotation

GitHub Actions / Check for broken markdown links

Broken link: [Monitoring](/docs/kubernetes/monitoring.md) - View: https://github.com/ai-dynamo/dynamo/blob/HEAD/docs/kubernetes/README.md?plain=1#L174
Expand Down
3 changes: 1 addition & 2 deletions docs/kubernetes/installation_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

## Quick Start Paths

Platform is installed using Dynamo Kubernetes Platform [helm chart](../../../deploy/cloud/helm/platform/README.md).

Check failure on line 24 in docs/kubernetes/installation_guide.md

View workflow job for this annotation

GitHub Actions / Check for broken markdown links

Broken link: [helm chart](../../../deploy/cloud/helm/platform/README.md) - View: https://github.com/ai-dynamo/dynamo/blob/HEAD/docs/kubernetes/installation_guide.md?plain=1#L24

**Path A: Production Install**
Install from published artifacts on your existing cluster → [Jump to Path A](#path-a-production-install)
Expand Down Expand Up @@ -127,7 +127,7 @@

cd -

# 3. Create namespace and secrets to be able to pull the operator image
# 3. Create namespace and secrets to be able to pull the operator image (only needed if you pushed the operator image to a private registry)
kubectl create namespace ${NAMESPACE}
kubectl create secret docker-registry docker-imagepullsecret \
--docker-server=${DOCKER_SERVER} \
Expand All @@ -139,7 +139,6 @@
helm upgrade --install dynamo-crds ./crds/ --namespace default

# 5. Install Platform
helm repo add bitnami https://charts.bitnami.com/bitnami
helm dep build ./platform/
helm install dynamo-platform ./platform/ \
--namespace ${NAMESPACE} \
Expand Down Expand Up @@ -174,9 +173,9 @@
```

2. **Explore Backend Guides**
- [vLLM Deployments](../../../components/backends/vllm/deploy/README.md)

Check failure on line 176 in docs/kubernetes/installation_guide.md

View workflow job for this annotation

GitHub Actions / Check for broken markdown links

Broken link: [vLLM Deployments](../../../components/backends/vllm/deploy/README.md) - View: https://github.com/ai-dynamo/dynamo/blob/HEAD/docs/kubernetes/installation_guide.md?plain=1#L176
- [SGLang Deployments](../../../components/backends/sglang/deploy/README.md)

Check failure on line 177 in docs/kubernetes/installation_guide.md

View workflow job for this annotation

GitHub Actions / Check for broken markdown links

Broken link: [SGLang Deployments](../../../components/backends/sglang/deploy/README.md) - View: https://github.com/ai-dynamo/dynamo/blob/HEAD/docs/kubernetes/installation_guide.md?plain=1#L177
- [TensorRT-LLM Deployments](../../../components/backends/trtllm/deploy/README.md)

Check failure on line 178 in docs/kubernetes/installation_guide.md

View workflow job for this annotation

GitHub Actions / Check for broken markdown links

Broken link: [TensorRT-LLM Deployments](../../../components/backends/trtllm/deploy/README.md) - View: https://github.com/ai-dynamo/dynamo/blob/HEAD/docs/kubernetes/installation_guide.md?plain=1#L178

3. **Optional:**
- [Set up Prometheus & Grafana](metrics.md)
Expand Down Expand Up @@ -216,7 +215,7 @@

## Advanced Options

- [Helm Chart Configuration](../../../deploy/cloud/helm/platform/README.md)

Check failure on line 218 in docs/kubernetes/installation_guide.md

View workflow job for this annotation

GitHub Actions / Check for broken markdown links

Broken link: [Helm Chart Configuration](../../../deploy/cloud/helm/platform/README.md) - View: https://github.com/ai-dynamo/dynamo/blob/HEAD/docs/kubernetes/installation_guide.md?plain=1#L218
- [GKE-specific setup](gke_setup.md)
- [Create custom deployments](create_deployment.md)
- [Dynamo Operator details](dynamo_operator.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/kubernetes/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
> The commands enumerated below assume you have installed the kube-prometheus-stack with the installation method listed above. Depending on your installation configuration of the monitoring stack, you may need to modify the `kubectl` commands that follow in this document accordingly (e.g modifying Namespace or Service names accordingly).

### Install Dynamo Operator
Before setting up metrics collection, you'll need to have the Dynamo operator installed in your cluster. Follow our [Installation Guide](../dynamo_deploy/installation_guide.md) for detailed instructions on deploying the Dynamo operator.
Before setting up metrics collection, you'll need to have the Dynamo operator installed in your cluster. Follow our [Installation Guide](/docs/kubernetes/installation_guide.md) for detailed instructions on deploying the Dynamo operator.
Make sure to set the `prometheusEndpoint` to the Prometheus endpoint you installed in the previous step.

```bash
Expand Down Expand Up @@ -65,7 +65,7 @@

Both components expose a `/metrics` endpoint following the OpenMetrics format, but with different metrics appropriate to their roles. For details about:
- Deployment configuration: See the [vLLM README](../../components/backends/vllm/README.md)
- Available metrics: See the [metrics guide](../metrics.md)

Check failure on line 68 in docs/kubernetes/metrics.md

View workflow job for this annotation

GitHub Actions / Check for broken markdown links


### Validate the Deployment

Expand Down
2 changes: 1 addition & 1 deletion examples/custom_backend/hello_world/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Hello star!
Note that this a very simple degenerate example which does not demonstrate the standard Dynamo FrontEnd-Backend deployment. The hello-world client is not a web server, it is a one-off function which sends the predefined text "world,sun,moon,star" to the backend. The example is meant to show the HelloWorldWorker. As such you will only see the HelloWorldWorker pod in deployment. The client will run and exit and the pod will not be operational.


Follow the [Quickstart Guide](../../../docs/guides/dynamo_deploy/README.md) to install Dynamo Kubernetes Platform.
Follow the [Quickstart Guide](../../../docs/kubernetes/README.md) to install Dynamo Kubernetes Platform.
Then deploy to kubernetes using

```bash
Expand Down
4 changes: 2 additions & 2 deletions examples/deployments/AKS/AKS-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ git clone https://github.com/ai-dynamo/dynamo.git
cd dynamo
```

2. Install Dynamo from Published Artifacts on NGC (see the [Dynamo Cloud guide](../../../docs/guides/dynamo_deploy/installation_guide.md)):
2. Install Dynamo from Published Artifacts on NGC (see the [Dynamo Cloud guide](../../../docs/kubernetes/installation_guide.md)):
```bash
export NAMESPACE=dynamo-cloud
export RELEASE_VERSION=0.3.2
Expand Down Expand Up @@ -124,7 +124,7 @@ dynamo-platform-nats-0 2/2 Runnin
dynamo-platform-nats-box-5dbf45c748-kln82 1/1 Running 0 2m51s
```

There are other ways to install Dynamo, you can find them [here](../../../docs/guides/dynamo_deploy/installation_guide.md).
There are other ways to install Dynamo, you can find them [here](../../../docs/kubernetes/installation_guide.md).

### Task 4. Deploy a model

Expand Down
Loading