Skip to content

Commit 304dbb2

Browse files
feat: Cleanup dynamo cloud installation documentation (#2807) (#2818)
Signed-off-by: Julien Mancuso <jmancuso@nvidia.com>
1 parent 39175cb commit 304dbb2

21 files changed

+98
-718
lines changed

deploy/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

deploy/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../docs/guides/dynamo_deploy/README.md

deploy/cloud/helm/README.md

Lines changed: 4 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -15,76 +15,9 @@ See the License for the specific language governing permissions and
1515
limitations under the License.
1616
-->
1717

18-
# 🚀 Deploy Dynamo Cloud to Kubernetes
19-
20-
Dynamo Cloud acts as an orchestration layer between the end user and Kubernetes, handling the complexity of deploying your graphs for you.
21-
Before you can deploy your graphs, you need to deploy the Dynamo Runtime and Dynamo Cloud images. This is a one-time action, only necessary the first time you deploy a DynamoGraph.
22-
23-
[See Dynamo Cloud Guide](../../../docs/guides/dynamo_deploy/dynamo_cloud.md) for advanced cases and details on how to install and use Dynamo Cloud. For a quick start follow the steps below.
24-
25-
26-
## 🏗️ Building Docker images for Dynamo Cloud components
27-
28-
You can build and push Docker images for the Dynamo cloud components to any container registry of your choice.
29-
30-
**Important** Make sure you're logged in to your container registry before pushing images. For example:
31-
32-
```bash
33-
docker login <CONTAINER_REGISTRY>
34-
```
35-
36-
#### 🛠️ Build and push images for the Dynamo Cloud platform components
37-
38-
[One-time Action]
39-
You should build the image(s) for the Dynamo Cloud Platform.
40-
If you are a **👤 Dynamo User** you would do this step once.
41-
42-
```bash
43-
export DOCKER_SERVER=<your-docker-server>
44-
export IMAGE_TAG=<TAG>
45-
cd deploy/cloud/operator
46-
earthly --push +docker --DOCKER_SERVER=$DOCKER_SERVER --IMAGE_TAG=$IMAGE_TAG
47-
```
48-
49-
If you are a **🧑‍💻 Dynamo Contributor** you would have to rebuild the dynamo platform images as the code evolves. To do so please look at the [Cloud Guide](../../../docs/guides/dynamo_deploy/dynamo_cloud.md).
50-
51-
52-
### 🚀 Deploying the Dynamo Cloud Platform
53-
54-
1. Set the required environment variables:
55-
```bash
56-
export PROJECT_ROOT=$(pwd)
57-
export DOCKER_USERNAME=<your-docker-username>
58-
export DOCKER_PASSWORD=<your-docker-password>
59-
export DOCKER_SERVER=<your-docker-server>
60-
export IMAGE_TAG=<TAG> # Use the same tag you used when building the images
61-
export NAMESPACE=dynamo-cloud # change this to whatever you want!
62-
export DYNAMO_INGRESS_SUFFIX=dynamo-cloud.com # change this to whatever you want!
63-
```
64-
65-
2. [One-time Action] Create a new kubernetes namespace and set it as your default. Create image pull secrets if needed.
66-
67-
```bash
68-
cd $PROJECT_ROOT/deploy/cloud/helm
69-
kubectl create namespace $NAMESPACE
70-
kubectl config set-context --current --namespace=$NAMESPACE
71-
```
72-
73-
3. Deploy Dynamo Cloud using the Helm chart via the provided deploy script:
74-
To deploy the Dynamo Cloud Platform on Kubernetes, run:
75-
76-
```bash
77-
./deploy.sh --crds
78-
```
79-
80-
if you want guidance during the process, run the deployment script with the `--interactive` flag:
81-
82-
```bash
83-
./deploy.sh --crds --interactive
84-
```
85-
86-
omitting `--crds` will skip the CRDs installation/upgrade. This is useful when installing on a shared cluster as CRDs are cluster-scoped resources.
87-
88-
18+
# Dynamo Kubernetes Platform Helm Charts
8919

20+
There are two Helm charts available for the Dynamo Kubernetes Platform:
9021

22+
- [platform](platform/README.md) - This chart installs the complete Dynamo Kubernetes Platform, including the Dynamo Operator, NATS, etcd, Grove, and Kai Scheduler.
23+
- [crds](crds/README.md) - This chart installs the CRDs for the Dynamo Kubernetes Platform.

docs/guides/dynamo_deploy/api-reference.md renamed to deploy/cloud/helm/crds/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ See the License for the specific language governing permissions and
1515
limitations under the License.
1616
-->
1717

18-
# Dynamo CRD API Reference
18+
# Dynamo Kubernetes Platform CRDs Helm Chart
1919

20-
For the complete technical API reference for Dynamo Custom Resource Definitions, see:
21-
22-
**📖 [Dynamo CRD API Reference](../../../deploy/cloud/operator/docs/api_reference.md)**
20+
This chart installs the [CRDs](../../../../docs/guides/dynamo_deploy/api_reference.md) for the Dynamo Kubernetes Platform.

deploy/cloud/helm/deploy.sh

Lines changed: 0 additions & 204 deletions
This file was deleted.

deploy/cloud/helm/dynamo-platform-values.yaml

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)