-
Notifications
You must be signed in to change notification settings - Fork 693
docs: Fix inconsistent namespace naming in deployment documentation #3177
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
👋 Hi yankay! Thank you for contributing to ai-dynamo/dynamo. Just a reminder: The 🚀 |
WalkthroughDocumentation updates change the Kubernetes namespace in deployment examples from dynamo-cloud to dynamo-kubernetes across two guides, adjusting environment variable setup and kubectl command paths. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
Pre-merge checks✅ Passed checks (3 passed)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/guides/dynamo_deploy/installation_guide.md (1)
101-125: Update chart paths in installation guide (docs/guides/dynamo_deploy/installation_guide.md:101-125)
The helm commands reference ./crds/ and ./platform/, but the charts are at deploy/cloud/helm/crds and deploy/cloud/helm/platform — update the docs to use ./deploy/cloud/helm/crds and ./deploy/cloud/helm/platform or add cd deploy/cloud/helm before running the helm commands.
🧹 Nitpick comments (2)
docs/guides/dynamo_deploy/installation_guide.md (2)
106-113: Optional: normalize namespace creation approach.
Path A uses--create-namespace; Path C useskubectl create namespace. Either is fine—consider standardizing to one for consistency.Also applies to: 118-125
93-101: Small UX nit: ensure RELEASE_VERSION is set in this block.
Path C relies onRELEASE_VERSION(used forIMAGE_TAG) set earlier. Add a reminder/export here to help users who jump directly to Path C.# 1. Set environment +export RELEASE_VERSION=0.x.x # any Dynamo 0.3.2+; if already set, skip export NAMESPACE=dynamo-kubernetes
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/guides/dynamo_deploy/README.md(1 hunks)docs/guides/dynamo_deploy/installation_guide.md(1 hunks)
⏰ 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). (1)
- GitHub Check: Build and Test - dynamo
🔇 Additional comments (2)
docs/guides/dynamo_deploy/installation_guide.md (1)
95-95: Namespace fix aligns Path C with Path A — good catch.
This removes a footgun where following Path C would deploy into a different namespace.docs/guides/dynamo_deploy/README.md (1)
55-55: Namespace value standardized — looks good.
Keeps deployment examples consistent with the installation guide.
Signed-off-by: Kay Yan <kay.yan@daocloud.io>
|
@hhzhang16 could you please take a look at this when you get the chance? |
|
@yankay please resolve the conflicts then it lgtm! (keep the optional line |
|
This issue has already been resolved by #3199. |
Overview:
This PR addresses an issue where two different namespace names were used in the deployment documentation, causing confusion and potential execution errors during Kubernetes deployments.
Details:
The documentation contained inconsistent namespace references:
dynamo-cloudanddynamo-kubernetesUsing the incorrect namespace (dynamo-cloud) would lead to execution failures when following the deployment guides
Summary by CodeRabbit