docs: update observability-plane URLs for non-localhost defaults#719
Draft
rashadism wants to merge 1 commit into
Draft
docs: update observability-plane URLs for non-localhost defaults#719rashadism wants to merge 1 commit into
rashadism wants to merge 1 commit into
Conversation
Contributor
📝 WalkthroughSummary by CodeRabbitDocumentation
WalkthroughTwo documentation files are updated for the Observability Plane: the getting-started guide gains two new Helm ChangesObservability Plane Helm URL Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
The observability-plane chart no longer ships *.localhost defaults for the control-plane API URLs (openchoreo/openchoreo#3845) and introduces a dedicated observer.publicUrl value (openchoreo/openchoreo#3846). - Helm values reference: controlPlaneApiUrl / openchoreoApiUrl now show the .invalid placeholder default; document observer.publicUrl. - Bring-your-own-environment guide: set observer.controlPlaneApiUrl (so the initial install passes hostname validation) and observer.publicUrl. Signed-off-by: Rashad Sirajudeen <rashad@wso2.com>
rashadism
force-pushed
the
fix/observability-localhost-docs
branch
from
07ba57d to
c61f83a
Compare
![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/reference/helm/observability-plane.mdx`:
- Around line 146-147: The file observability-plane.mdx is auto-generated from
the upstream openchoreo/openchoreo repository and should not be edited directly.
Instead of modifying the observer.controlPlaneApiUrl and observer.publicUrl
entries in this MDX file, locate the upstream values.schema.json file in the
openchoreo/openchoreo repository, make the necessary changes there, and then run
the generation script scripts/generate-helm-docs.js to regenerate the
documentation. Any direct edits to this file will be overwritten on the next
generation run.
🪄 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
Run ID: 3c90f6a5-911f-4f43-9027-c6d312276344
📒 Files selected for processing (2)
docs/getting-started/try-it-out/on-your-environment.mdxdocs/reference/helm/observability-plane.mdx
Comment on lines
+146
to
+147
| | `observer.controlPlaneApiUrl` | Control plane API base URL used by observer | `string` | `http://api.openchoreo.invalid:8080` | | ||
| | `observer.publicUrl` | Observer's own external URL (sets OBSERVER_BASE_URL). Empty falls back to a localhost default. | `string` | | |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Determine whether observability-plane.mdx is generated and identify the source schema
# Check for generation markers or comments in the MDX
echo "=== Checking for generation markers in observability-plane.mdx ==="
head -20 docs/reference/helm/observability-plane.mdx | grep -i "generated\|auto-generated\|script" || echo "(No generation marker found)"
# Search for the generation script in the repo
echo ""
echo "=== Locating generation script ==="
fd -t f "generate.*helm.*docs" || echo "(No script found)"
# Check for values.schema.json files in main repo context
echo ""
echo "=== Checking for corresponding values.schema.json ==="
fd "values.schema.json" | grep -i observability || echo "(No schema file found in provided context)"
# Verify the pattern: check other generated helm reference files for markers
echo ""
echo "=== Checking other Helm reference files for generation markers ==="
fd -t f "docs/reference/helm/.*\.mdx" | head -3 | xargs -I {} sh -c 'echo "File: {}"; head -5 {} | grep -i "generated\|auto" || echo "No marker"'Repository: openchoreo/openchoreo.github.io
Length of output: 751
🏁 Script executed:
cat scripts/generate-helm-docs.jsRepository: openchoreo/openchoreo.github.io
Length of output: 8976
🏁 Script executed:
# Check for documentation about the generation process
fd -t f "(README|CONTRIBUTING|docs)" -i | head -20Repository: openchoreo/openchoreo.github.io
Length of output: 145
🏁 Script executed:
# Look for any documentation about how to update helm values
rg -i "helm.*values|values.*schema|generate.*helm" -t md -t mdx --max-count=10Repository: openchoreo/openchoreo.github.io
Length of output: 103
Apply these changes to the upstream values.schema.json instead of editing this generated file directly.
This file is auto-generated from openchoreo-observability-plane/values.schema.json in the upstream openchoreo/openchoreo repository (via scripts/generate-helm-docs.js). Changes to observer.controlPlaneApiUrl and observer.publicUrl must be made in the upstream schema file and then regenerated—direct edits to this MDX will be overwritten on the next generation run.
Update the source schema in the openchoreo/openchoreo repository, then run the generation script to update the docs.
🤖 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/reference/helm/observability-plane.mdx` around lines 146 - 147, The file
observability-plane.mdx is auto-generated from the upstream
openchoreo/openchoreo repository and should not be edited directly. Instead of
modifying the observer.controlPlaneApiUrl and observer.publicUrl entries in this
MDX file, locate the upstream values.schema.json file in the
openchoreo/openchoreo repository, make the necessary changes there, and then run
the generation script scripts/generate-helm-docs.js to regenerate the
documentation. Any direct edits to this file will be overwritten on the next
generation run.
Source: Learnings
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.
Companion to openchoreo/openchoreo#3845 and #3846, which stop the observability-plane chart from shipping
*.localhostdefaults for control-plane API URLs.observer.controlPlaneApiUrl/rca.openchoreoApiUrldefaults now showapi.openchoreo.invalid:8080(scoped to the changed values; the reference is otherwise stale and due a full regen separately).observer.controlPlaneApiUrlin the initial install so it passes the new hostname validation.