docs: add workflow template update steps to upgrade guides - #799
Open
RashmikaMadaela wants to merge 2 commits into
Open
docs: add workflow template update steps to upgrade guides#799RashmikaMadaela wants to merge 2 commits into
RashmikaMadaela wants to merge 2 commits into
Conversation
Contributor
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe documentation now requires workflow templates to be reapplied after OpenChoreo upgrades, explains their independent lifecycle from Helm charts, and provides commands and guidance for customized templates. ChangesWorkflow template upgrade documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related issues
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/platform-engineer-guide/upgrades/overview.mdx`:
- Around line 85-91: Update the workflow-template installation command to
validate that CP_BASE_DOMAIN is set before running curl, sed, or kubectl, and
fail immediately with a clear error when it is missing. Preserve the existing
URL substitutions and apply behavior when the variable is provided.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 82c352ef-32f5-490e-97b5-31772d7c6062
⛔ Files ignored due to path filters (4)
versioned_docs/version-v1.2.x/getting-started/try-it-out/on-your-environment.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.2.x/platform-engineer-guide/upgrades/overview.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.2.x/platform-engineer-guide/upgrades/v1.0-to-v1.1.mdxis excluded by!versioned_docs/**versioned_docs/version-v1.2.x/platform-engineer-guide/upgrades/v1.1-to-v1.2.mdxis excluded by!versioned_docs/**
📒 Files selected for processing (5)
docs/getting-started/try-it-out/on-your-environment.mdxdocs/platform-engineer-guide/upgrades/overview.mdxdocs/platform-engineer-guide/upgrades/v1.0-to-v1.1.mdxdocs/platform-engineer-guide/upgrades/v1.1-to-v1.2.mdxdocs/platform-engineer-guide/upgrades/v1.2-to-v1.3.mdx
Comment on lines
+85
to
+91
| curl -fsSL https://raw.githubusercontent.com/openchoreo/openchoreo/<github-ref>/samples/getting-started/workflow-templates/generate-workload.yaml \ | ||
| | sed "s#https://host.k3d.internal:8080/oauth2/token#https://thunder.${CP_BASE_DOMAIN}/oauth2/token#g" \ | ||
| | sed "s#http://host.k3d.internal:8080#https://api.${CP_BASE_DOMAIN}#g" \ | ||
| | kubectl apply -f - | ||
| ``` | ||
|
|
||
| `CP_BASE_DOMAIN` is the same control-plane base domain you set at install time (see [Install Workflow Templates](../../getting-started/try-it-out/on-your-environment.mdx#install-workflow-templates)). |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Fail fast when CP_BASE_DOMAIN is missing.
In a fresh shell, ${CP_BASE_DOMAIN} expands to an empty value, so the applied manifest contains https://thunder./... and https://api./..., leaving future builds unable to reach the control plane.
Proposed fix
+ : "${CP_BASE_DOMAIN:?Set CP_BASE_DOMAIN to the control-plane base domain before running this command}"
curl -fsSL https://raw.githubusercontent.com/openchoreo/openchoreo/<github-ref>/samples/getting-started/workflow-templates/generate-workload.yaml \📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| curl -fsSL https://raw.githubusercontent.com/openchoreo/openchoreo/<github-ref>/samples/getting-started/workflow-templates/generate-workload.yaml \ | |
| | sed "s#https://host.k3d.internal:8080/oauth2/token#https://thunder.${CP_BASE_DOMAIN}/oauth2/token#g" \ | |
| | sed "s#http://host.k3d.internal:8080#https://api.${CP_BASE_DOMAIN}#g" \ | |
| | kubectl apply -f - | |
| ``` | |
| `CP_BASE_DOMAIN` is the same control-plane base domain you set at install time (see [Install Workflow Templates](../../getting-started/try-it-out/on-your-environment.mdx#install-workflow-templates)). | |
| : "${CP_BASE_DOMAIN:?Set CP_BASE_DOMAIN to the control-plane base domain before running this command}" | |
| curl -fsSL https://raw.githubusercontent.com/openchoreo/openchoreo/<github-ref>/samples/getting-started/workflow-templates/generate-workload.yaml \ | |
| | sed "s#https://host.k3d.internal:8080/oauth2/token#https://thunder.${CP_BASE_DOMAIN}/oauth2/token#g" \ | |
| | sed "s#http://host.k3d.internal:8080#https://api.${CP_BASE_DOMAIN}`#g`" \ | |
| | kubectl apply -f - |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/platform-engineer-guide/upgrades/overview.mdx` around lines 85 - 91,
Update the workflow-template installation command to validate that
CP_BASE_DOMAIN is set before running curl, sed, or kubectl, and fail immediately
with a clear error when it is missing. Preserve the existing URL substitutions
and apply behavior when the variable is provided.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
The current upgrade documentation leaves build
ClusterWorkflowTemplatesuntouched, causing a silent version skew where the platform upgrades but build templates remain pinned to older images.This PR resolves that by adding explicit manual update instructions (
kubectl applycommands mirroring the installation guide) todocs/overview.mdxand the transition summaries. It also adds an admonition advising operators to usedifffor custom templates instead of blindly overwriting them. These fixes have been applied to the unreleased docs and backported toversioned_docs/version-v1.2.x/.(Note to maintainers: I held off on backporting to
v1.1.xbecause it uses the olderupgrades.mdxformat, but let me know if you would like me to adapt the fix for that version as well!)Related Issues
Fixes openchoreo/openchoreo#3659
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors