Skip to content

Conversation

@nealvaidya
Copy link
Contributor

@nealvaidya nealvaidya commented Jul 21, 2025

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions to use new Helm chart repository paths and filenames for Dynamo Cloud deployment.

Signed-off-by: Neal Vaidya <[email protected]>
@nealvaidya nealvaidya requested a review from atchernych July 21, 2025 18:19
@nealvaidya nealvaidya changed the title fix helm chart urls docs: fix helm chart urls Jul 21, 2025
@github-actions github-actions bot added the docs label Jul 21, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 21, 2025

Walkthrough

The documentation for installing Dynamo Cloud was updated to use new Helm chart repository paths and filenames, reflecting a change in the storage location and naming convention for the CRDs and platform charts. No installation logic or parameters were altered.

Changes

File(s) Change Summary
docs/guides/dynamo_deploy/quickstart.md Updated Helm chart URLs and filenames to new repository path and naming convention for installation

Estimated code review effort

1 (~2 minutes)

Possibly related PRs

Poem

In the meadow of docs, a path was redrawn,
Helm charts now wander where old links are gone.
With "ai-dynamo" trails and CRDs in tow,
The quickstart grows clearer, as bunnies well know.
🐰✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/guides/dynamo_deploy/quickstart.md (3)

27-31: Use helm pull, not the deprecated helm fetch, and quote the entire URL.

helm fetch was deprecated in Helm v3.7 and removed in v3.12. Replacing it with helm pull avoids future breakage.
Additionally, wrapping the full URL in quotes protects the $RELEASE_VERSION expansion from word-splitting and makes copy-pasting safer.

-# Fetch the CRDs helm chart
-helm fetch https://helm.ngc.nvidia.com/nvidia/ai-dynamo/charts/dynamo-crds-${RELEASE_VERSION}.tgz
+# Fetch the CRDs helm chart
+helm pull "https://helm.ngc.nvidia.com/nvidia/ai-dynamo/charts/dynamo-crds-${RELEASE_VERSION}.tgz"
-
-# Fetch the platform helm chart
-helm fetch https://helm.ngc.nvidia.com/nvidia/ai-dynamo/charts/dynamo-platform-${RELEASE_VERSION}.tgz
+# Fetch the platform helm chart
+helm pull "https://helm.ngc.nvidia.com/nvidia/ai-dynamo/charts/dynamo-platform-${RELEASE_VERSION}.tgz"

39-43: Add an integrity check to fail fast if the chart download is corrupted.

Immediately verifying the chart’s SHA256 after download (or using --verify with a provenance file, if published) prevents cryptic Helm errors later in the install step.

Example:

echo "EXPECTED_SHA256  dynamo-crds-${RELEASE_VERSION}.tgz" | sha256sum -c -

50-51: Consider re-using the Helm repository instead of local .tgz files.

Since you already added the nvidia repo, installing straight from the repo keeps commands shorter and avoids keeping the tarballs around:

helm install dynamo-platform nvidia/ai-dynamo/dynamo-platform \
  --version ${RELEASE_VERSION} \
  --namespace ${NAMESPACE}

Not mandatory, but it reduces manual steps and potential version drift between download and install.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cb6de94 and 916dba2.

📒 Files selected for processing (1)
  • docs/guides/dynamo_deploy/quickstart.md (2 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: julienmancuso
PR: ai-dynamo/dynamo#2012
File: deploy/cloud/helm/crds/templates/nvidia.com_dynamocomponentdeployments.yaml:92-98
Timestamp: 2025-07-18T16:04:31.743Z
Learning: CRD schemas in files like deploy/cloud/helm/crds/templates/*.yaml are auto-generated from Kubernetes library upgrades and should not be manually modified as changes would be overwritten during regeneration.
docs/guides/dynamo_deploy/quickstart.md (2)

Learnt from: julienmancuso
PR: #2012
File: deploy/cloud/helm/crds/templates/nvidia.com_dynamocomponentdeployments.yaml:92-98
Timestamp: 2025-07-18T16:04:31.743Z
Learning: CRD schemas in files like deploy/cloud/helm/crds/templates/*.yaml are auto-generated from Kubernetes library upgrades and should not be manually modified as changes would be overwritten during regeneration.

Learnt from: julienmancuso
PR: #2012
File: deploy/cloud/helm/crds/templates/nvidia.com_dynamocomponentdeployments.yaml:1178-1180
Timestamp: 2025-07-18T16:05:05.482Z
Learning: The stopSignal field under lifecycle in DynamoComponentDeployment CRDs is autogenerated due to Kubernetes library upgrades (k8s.io/api and k8s.io/apimachinery from v0.32.3 to v0.33.1), not a manual design decision by the user.

🪛 markdownlint-cli2 (0.17.2)
docs/guides/dynamo_deploy/quickstart.md

36-36: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

@nealvaidya nealvaidya merged commit ac7e888 into main Jul 21, 2025
12 of 15 checks passed
@nealvaidya nealvaidya deleted the nealvaidya-patch-1 branch July 21, 2025 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants