Skip to content

Conversation

@julienmancuso
Copy link
Contributor

@julienmancuso julienmancuso commented Jul 15, 2025

Overview:

add possibility to use grove in dynamo graph helm chart

Summary by CodeRabbit

  • New Features

    • Added support for deploying using Grove PodGangSet resources via a new deployment type option.
    • Users can now select between "basic" Kubernetes Deployment and "grove" deployment types using a configurable parameter.
  • Documentation

    • Updated Helm deployment README to document Grove deployment support, prerequisites, and configuration options.
    • Clarified installation instructions and added details for the new deployment type option.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 15, 2025

Walkthrough

The changes introduce support for deploying using Grove's PodGangSet custom resource in addition to the standard Kubernetes Deployment. Documentation is updated to describe the new option, and Helm templates are modified or added to conditionally render either Deployment or PodGangSet resources based on the deploymentType value.

Changes

File(s) Change Summary
deploy/helm/README.md Updated documentation to describe Grove deployment, prerequisites, usage, and new deploymentType parameter.
deploy/helm/chart/templates/deployment.yaml Wrapped deployment resource rendering in a conditional, only including it for basic or unset deploymentType.
deploy/helm/chart/templates/grove-podgangset.yaml Added new Helm template to render a Grove PodGangSet resource when deploymentType is set to grove.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Helm
    participant Kubernetes API
    participant Grove Controller

    User->>Helm: Install chart with deploymentType = "grove"
    Helm->>Kubernetes API: Apply PodGangSet manifest
    Kubernetes API->>Grove Controller: Notify of new PodGangSet
    Grove Controller->>Kubernetes API: Create/Manage pods as per PodGangSet spec
Loading
sequenceDiagram
    participant User
    participant Helm
    participant Kubernetes API

    User->>Helm: Install chart with deploymentType = "basic" or unset
    Helm->>Kubernetes API: Apply Deployment manifest(s)
    Kubernetes API->>Kubernetes API: Schedule and run pods as per Deployment spec
Loading

Possibly related PRs

Poem

🐇
A chart now grows two ways to show,
With Grove or basic, you may go!
PodGangSets join the Kubernetes throng,
Health checks keep them hopping strong.
Deployments or cliques, your choice anew—
Helm charts are ready, just for you!
🌱✨


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 (5)
deploy/helm/README.md (3)

29-30: Spell-out Grove’s optional nature more explicitly

Consider tightening the wording so that the line reads naturally and does not imply Grove is always required:

- - Grove v0.1.0+ (optional if deploying using Grove)
+ - Grove v0.1.0+ (only needed when `deploymentType=grove`)

39-45: Quote the value passed to --set for shell-safety

Shells treat = as a word-breaking operator when it appears inside double-quoted arguments preceded by --set. Wrapping the whole assignment avoids edge-cases when deploymentType is later templated or set via env-vars:

-helm upgrade --install dynamo-graph ./deploy/helm/chart -n dynamo-cloud -f ./examples/vllm_v1/deploy/agg.yaml --set deploymentType=grove
+helm upgrade --install dynamo-graph ./deploy/helm/chart -n dynamo-cloud \
+  -f ./examples/vllm_v1/deploy/agg.yaml \
+  --set "deploymentType=grove"

66-66: Grammar tweak for the description column

Minor language polish to make the sentence complete:

-| `deploymentType` | Type of deployment to use. Can be `basic` or `grove`. If not specified, `basic` is used. | `deploymentType=grove` |
+| `deploymentType` | Deployment strategy: `basic` (default) or `grove`. | `deploymentType=grove` |
deploy/helm/chart/templates/deployment.yaml (2)

15-16: Fix misleading comment & keep terminology consistent

The in-file comment still refers to “dynamo” instead of “basic”, which can be confusing now that two deployment modes exist.

-# if deploymentType is empty, or explicitly set to dynamo, use dynamo as default
+# If `.Values.deploymentType` is unset or set to `basic`, render the standard Deployment manifests

116-116: Add a trailing newline

Some linters (including yamllint) complain when the file lacks a final newline. Adding one avoids noisy CI warnings.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1c03404 and 70d54b8.

📒 Files selected for processing (3)
  • deploy/helm/README.md (2 hunks)
  • deploy/helm/chart/templates/deployment.yaml (2 hunks)
  • deploy/helm/chart/templates/grove-podgangset.yaml (1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: julienmancuso
PR: ai-dynamo/dynamo#1474
File: deploy/cloud/operator/internal/controller/dynamocomponent_controller.go:1308-1312
Timestamp: 2025-06-11T21:29:28.650Z
Learning: User julienmancuso expects replies in English; avoid switching languages unless explicitly requested.
deploy/helm/README.md (1)
Learnt from: julienmancuso
PR: ai-dynamo/dynamo#1365
File: deploy/cloud/operator/api/v1alpha1/dynamocomponentdeployment_types.go:171-178
Timestamp: 2025-06-04T13:09:53.416Z
Learning: The `DYN_DEPLOYMENT_CONFIG` environment variable (commonconsts.DynamoDeploymentConfigEnvVar) in the Dynamo operator will never be set via ValueFrom (secrets/config maps), only via direct Value assignment. The GetDynamoDeploymentConfig method correctly only checks env.Value for this specific environment variable.
deploy/helm/chart/templates/deployment.yaml (1)
Learnt from: julienmancuso
PR: ai-dynamo/dynamo#1365
File: deploy/cloud/operator/api/v1alpha1/dynamocomponentdeployment_types.go:171-178
Timestamp: 2025-06-04T13:09:53.416Z
Learning: The `DYN_DEPLOYMENT_CONFIG` environment variable (commonconsts.DynamoDeploymentConfigEnvVar) in the Dynamo operator will never be set via ValueFrom (secrets/config maps), only via direct Value assignment. The GetDynamoDeploymentConfig method correctly only checks env.Value for this specific environment variable.
🪛 LanguageTool
deploy/helm/README.md

[style] ~66-~66: To form a complete sentence, be sure to include a subject.
Context: ...ymentType| Type of deployment to use. Can bebasicorgrove`. If not specified...

(MISSING_IT_THERE)

🪛 YAMLlint (1.37.1)
deploy/helm/chart/templates/deployment.yaml

[error] 16-16: syntax error: expected the node content, but found '-'

(syntax)


[error] 116-116: no new line character at the end of file

(new-line-at-end-of-file)

deploy/helm/chart/templates/grove-podgangset.yaml

[error] 15-15: syntax error: expected the node content, but found '-'

(syntax)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Mirror Repository to GitLab
  • GitHub Check: Build and Test - vllm
🔇 Additional comments (1)
deploy/helm/chart/templates/grove-podgangset.yaml (1)

15-110: Double-check PodGangSet schema & indentation

Grove’s CRD is still evolving and the current manifest assumes the following structure:

spec:
  replicas: 1
  template:
    cliques:
      - name: …
        spec:
          roleName: …
          replicas: …
          podSpec: …

Please verify against the installed CRD:

  1. Some versions expect template.cliques[].podTemplate, not podSpec.
  2. replicas at the root of spec may be deprecated in favour of minReplicas/maxReplicas.
  3. Indentation under args: relies on nindent 14; if args is empty, Helm will emit an invalid args: key with no value. A guard such as {{- if $serviceSpec.extraPodSpec.mainContainer.args }} may be safer.

If any of these discrepancies exist, deployment will fail at install time.

@saturley-hall
Copy link
Member

@dmitry-tokarev-nv to review for OSRB implications to dynamo-graph

@julienmancuso julienmancuso merged commit a2874fd into main Jul 24, 2025
12 of 14 checks passed
@julienmancuso julienmancuso deleted the jsm/grove branch July 24, 2025 16:18
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.

5 participants