Skip to content

GitLab

Unverified Commit c4c2cc93 authored by Nate Mailhot's avatar Nate Mailhot Committed by GitHub
Browse files

fix: broken symlinks (#5235)

parent 85e0512f
Hide whitespace changes
Inline Side-by-side
Showing with 32 additions and 32 deletions
docs/kubernetes/README.md
View file @ c4c2cc93
...@@ -25,7 +25,7 @@ High-level guide to Dynamo Kubernetes deployments. Start here, then dive into sp ...@@ -25,7 +25,7 @@ High-level guide to Dynamo Kubernetes deployments. Start here, then dive into sp
- Used for: Resource isolation, RBAC, organizing deployments - Used for: Resource isolation, RBAC, organizing deployments
- Example: `dynamo-system`, `team-a-namespace` - Example: `dynamo-system`, `team-a-namespace`
**Dynamo Namespace**: The logical namespace used by Dynamo components for [service discovery](./service_discovery.md). **Dynamo Namespace**: The logical namespace used by Dynamo components for [service discovery](/docs/kubernetes/service_discovery.md).
- Used for: Runtime component communication, service discovery - Used for: Runtime component communication, service discovery
- Specified in: `.spec.services.<ServiceName>.dynamoNamespace` field - Specified in: `.spec.services.<ServiceName>.dynamoNamespace` field
- Example: `my-llm`, `production-model`, `dynamo-dev` - Example: `my-llm`, `production-model`, `dynamo-dev`
...@@ -47,7 +47,7 @@ kubectl version --client # Should show v1.24+ ...@@ -47,7 +47,7 @@ kubectl version --client # Should show v1.24+
helm version # Should show v3.0+ helm version # Should show v3.0+
``` ```
For detailed installation instructions, see the [Prerequisites section](./installation_guide.md#prerequisites) in the Installation Guide. For detailed installation instructions, see the [Prerequisites section](/docs/kubernetes/installation_guide.md#prerequisites) in the Installation Guide.
## Pre-deployment Checks ## Pre-deployment Checks
...@@ -57,7 +57,7 @@ Before deploying the platform, run the pre-deployment checks to ensure the clust ...@@ -57,7 +57,7 @@ Before deploying the platform, run the pre-deployment checks to ensure the clust
./deploy/pre-deployment/pre-deployment-check.sh ./deploy/pre-deployment/pre-deployment-check.sh
``` ```
This validates kubectl connectivity, StorageClass configuration, and GPU availability. See [pre-deployment checks](../../deploy/pre-deployment/README.md) for more details. This validates kubectl connectivity, StorageClass configuration, and GPU availability. See [pre-deployment checks](/deploy/pre-deployment/README.md) for more details.
## 1. Install Platform First ## 1. Install Platform First
...@@ -82,7 +82,7 @@ If your cluster has namespace-restricted Dynamo operators, add this flag to step ...@@ -82,7 +82,7 @@ If your cluster has namespace-restricted Dynamo operators, add this flag to step
--set dynamo-operator.namespaceRestriction.enabled=true --set dynamo-operator.namespaceRestriction.enabled=true
``` ```
For more details or customization options (including multinode deployments), see **[Installation Guide for Dynamo Kubernetes Platform](./installation_guide.md)**. For more details or customization options (including multinode deployments), see **[Installation Guide for Dynamo Kubernetes Platform](/docs/kubernetes/installation_guide.md)**.
## 2. Choose Your Backend ## 2. Choose Your Backend
...@@ -90,9 +90,9 @@ Each backend has deployment examples and configuration options: ...@@ -90,9 +90,9 @@ Each backend has deployment examples and configuration options:
| Backend | Aggregated | Aggregated + Router | Disaggregated | Disaggregated + Router | Disaggregated + Planner | Disaggregated Multi-node | | Backend | Aggregated | Aggregated + Router | Disaggregated | Disaggregated + Router | Disaggregated + Planner | Disaggregated Multi-node |
|--------------|:----------:|:-------------------:|:-------------:|:----------------------:|:-----------------------:|:------------------------:| |--------------|:----------:|:-------------------:|:-------------:|:----------------------:|:-----------------------:|:------------------------:|
| **[SGLang](../../examples/backends/sglang/deploy/README.md)** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | **[SGLang](/examples/backends/sglang/deploy/README.md)** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **[TensorRT-LLM](../../examples/backends/trtllm/deploy/README.md)** | ✅ | ✅ | ✅ | ✅ | 🚧 | ✅ | | **[TensorRT-LLM](/examples/backends/trtllm/deploy/README.md)** | ✅ | ✅ | ✅ | ✅ | 🚧 | ✅ |
| **[vLLM](../../examples/backends/vllm/deploy/README.md)** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | **[vLLM](/examples/backends/vllm/deploy/README.md)** | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
## 3. Deploy Your First Model ## 3. Deploy Your First Model
...@@ -117,7 +117,7 @@ kubectl port-forward svc/vllm-agg-frontend 8000:8000 -n ${NAMESPACE} ...@@ -117,7 +117,7 @@ kubectl port-forward svc/vllm-agg-frontend 8000:8000 -n ${NAMESPACE}
curl http://localhost:8000/v1/models curl http://localhost:8000/v1/models
``` ```
For SLA-based autoscaling, see [SLA Planner Quick Start Guide](../planner/sla_planner_quickstart.md). For SLA-based autoscaling, see [SLA Planner Quick Start Guide](/docs/planner/sla_planner_quickstart.md).
## Understanding Dynamo's Custom Resources ## Understanding Dynamo's Custom Resources
...@@ -147,15 +147,15 @@ A lower-level interface that defines your complete inference pipeline: ...@@ -147,15 +147,15 @@ A lower-level interface that defines your complete inference pipeline:
Use this when you need fine-grained control or have already completed profiling. Use this when you need fine-grained control or have already completed profiling.
Refer to the [API Reference and Documentation](./api_reference.md) for more details. Refer to the [API Reference and Documentation](/docs/kubernetes/api_reference.md) for more details.
## 📖 API Reference & Documentation ## 📖 API Reference & Documentation
For detailed technical specifications of Dynamo's Kubernetes resources: For detailed technical specifications of Dynamo's Kubernetes resources:
- **[API Reference](./api_reference.md)** - Complete CRD field specifications for all Dynamo resources - **[API Reference](/docs/kubernetes/api_reference.md)** - Complete CRD field specifications for all Dynamo resources
- **[Create Deployment](./deployment/create_deployment.md)** - Step-by-step deployment creation with DynamoGraphDeployment - **[Create Deployment](/docs/kubernetes/deployment/create_deployment.md)** - Step-by-step deployment creation with DynamoGraphDeployment
- **[Operator Guide](./dynamo_operator.md)** - Dynamo operator configuration and management - **[Operator Guide](/docs/kubernetes/dynamo_operator.md)** - Dynamo operator configuration and management
### Choosing Your Architecture Pattern ### Choosing Your Architecture Pattern
...@@ -170,7 +170,7 @@ When creating a deployment, select the architecture pattern that best fits your ...@@ -170,7 +170,7 @@ When creating a deployment, select the architecture pattern that best fits your
You can run the Frontend on one machine (e.g., a CPU node) and workers on different machines (GPU nodes). The Frontend serves as a framework-agnostic HTTP entry point that: You can run the Frontend on one machine (e.g., a CPU node) and workers on different machines (GPU nodes). The Frontend serves as a framework-agnostic HTTP entry point that:
- Provides OpenAI-compatible `/v1/chat/completions` endpoint - Provides OpenAI-compatible `/v1/chat/completions` endpoint
- Auto-discovers backend workers via [service discovery](./service_discovery.md) (Kubernetes-native by default) - Auto-discovers backend workers via [service discovery](/docs/kubernetes/service_discovery.md) (Kubernetes-native by default)
- Routes requests and handles load balancing - Routes requests and handles load balancing
- Validates and preprocesses requests - Validates and preprocesses requests
...@@ -238,15 +238,15 @@ Key customization points include: ...@@ -238,15 +238,15 @@ Key customization points include:
## Additional Resources ## Additional Resources
- **[Examples](../examples/README.md)** - Complete working examples - **[Examples](/docs/examples/README.md)** - Complete working examples
- **[Create Custom Deployments](./deployment/create_deployment.md)** - Build your own CRDs - **[Create Custom Deployments](/docs/kubernetes/deployment/create_deployment.md)** - Build your own CRDs
- **[Managing Models with DynamoModel](./deployment/dynamomodel-guide.md)** - Deploy LoRA adapters and manage models - **[Managing Models with DynamoModel](/docs/kubernetes/deployment/dynamomodel-guide.md)** - Deploy LoRA adapters and manage models
- **[Operator Documentation](./dynamo_operator.md)** - How the platform works - **[Operator Documentation](/docs/kubernetes/dynamo_operator.md)** - How the platform works
- **[Service Discovery](./service_discovery.md)** - Discovery backends and configuration - **[Service Discovery](/docs/kubernetes/service_discovery.md)** - Discovery backends and configuration
- **[Helm Charts](../../deploy/helm/README.md)** - For advanced users - **[Helm Charts](/deploy/helm/README.md)** - For advanced users
- **[GitOps Deployment with FluxCD](./fluxcd.md)** - For advanced users - **[GitOps Deployment with FluxCD](/docs/kubernetes/fluxcd.md)** - For advanced users
- **[Logging](./observability/logging.md)** - For logging setup - **[Logging](/docs/kubernetes/observability/logging.md)** - For logging setup
- **[Multinode Deployment](./deployment/multinode-deployment.md)** - For multinode deployment - **[Multinode Deployment](/docs/kubernetes/deployment/multinode-deployment.md)** - For multinode deployment
- **[Grove](./grove.md)** - For grove details and custom installation - **[Grove](/docs/kubernetes/grove.md)** - For grove details and custom installation
- **[Monitoring](./observability/metrics.md)** - For monitoring setup - **[Monitoring](/docs/kubernetes/observability/metrics.md)** - For monitoring setup
- **[Model Caching with Fluid](./model_caching_with_fluid.md)** - For model caching with Fluid - **[Model Caching with Fluid](/docs/kubernetes/model_caching_with_fluid.md)** - For model caching with Fluid
examples/README.md
View file @ c4c2cc93
...@@ -26,9 +26,9 @@ This directory contains practical examples demonstrating how to deploy and use D ...@@ -26,9 +26,9 @@ This directory contains practical examples demonstrating how to deploy and use D
Learn fundamental Dynamo concepts through these introductory examples: Learn fundamental Dynamo concepts through these introductory examples:
- **[Quickstart](basics/quickstart/README.md)** - Simple aggregated serving example with vLLM backend - **[Quickstart](/examples/basics/quickstart/README.md)** - Simple aggregated serving example with vLLM backend
- **[Disaggregated Serving](basics/disaggregated_serving/README.md)** - Prefill/decode separation for enhanced performance and scalability - **[Disaggregated Serving](/examples/basics/disaggregated_serving/README.md)** - Prefill/decode separation for enhanced performance and scalability
- **[Multi-node](basics/multinode/README.md)** - Distributed inference across multiple nodes and GPUs - **[Multi-node](/examples/basics/multinode/README.md)** - Distributed inference across multiple nodes and GPUs
## Framework Support ## Framework Support
...@@ -53,11 +53,11 @@ Platform-specific deployment guides for production environments: ...@@ -53,11 +53,11 @@ Platform-specific deployment guides for production environments:
Low-level runtime examples for developers using Python<>Rust bindings: Low-level runtime examples for developers using Python<>Rust bindings:
- **[Hello World](custom_backend/hello_world/README.md)** - Minimal Dynamo runtime service demonstrating basic concepts - **[Hello World](/examples/custom_backend/hello_world/README.md)** - Minimal Dynamo runtime service demonstrating basic concepts
## Getting Started ## Getting Started
1. **Choose your deployment pattern**: Start with the [Quickstart](basics/quickstart/README.md) for a simple local deployment, or explore [Disaggregated Serving](basics/disaggregated_serving/README.md) for advanced architectures. 1. **Choose your deployment pattern**: Start with the [Quickstart](/examples/basics/quickstart/README.md) for a simple local deployment, or explore [Disaggregated Serving](/examples/basics/disaggregated_serving/README.md) for advanced architectures.
2. **Set up prerequisites**: Most examples require etcd and NATS services. You can start them using: 2. **Set up prerequisites**: Most examples require etcd and NATS services. You can start them using:
```bash ```bash
...@@ -83,4 +83,4 @@ If you're running Kubernetes/cloud deployment examples (EKS, AKS, GKE), you'll a ...@@ -83,4 +83,4 @@ If you're running Kubernetes/cloud deployment examples (EKS, AKS, GKE), you'll a
| **kubectl** | v1.24+ | [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) | | **kubectl** | v1.24+ | [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) |
| **Helm** | v3.0+ | [Install Helm](https://helm.sh/docs/intro/install/) | | **Helm** | v3.0+ | [Install Helm](https://helm.sh/docs/intro/install/) |
See the [Kubernetes Installation Guide](../docs/kubernetes/installation_guide.md#prerequisites) for detailed setup instructions and pre-deployment checks. See the [Kubernetes Installation Guide](/docs/kubernetes/installation_guide.md#prerequisites) for detailed setup instructions and pre-deployment checks.
examples/custom_backend/hello_world/README.md
View file @ c4c2cc93
...@@ -106,7 +106,7 @@ Hello star! ...@@ -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. 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/kubernetes/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 Then deploy to kubernetes using
```bash ```bash
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment