feat(operator-chart): add post-install NOTES.txt (#4615)#5656
Conversation
Add Helm post-install notes for the operator chart with copy-pasteable commands to verify the deployment, inspect logs, apply a minimal MCPServer, and links to operator documentation. Includes helm-unittest coverage for the rendered NOTES content. Fixes stacklok#4615
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5656 +/- ##
==========================================
- Coverage 70.37% 70.33% -0.05%
==========================================
Files 649 649
Lines 66170 66170
==========================================
- Hits 46568 46541 -27
- Misses 16231 16277 +46
+ Partials 3371 3352 -19 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
ChrisJBurns
left a comment
There was a problem hiding this comment.
Thanks for the PR @syf2211 a single comment
| The ToolHive Operator is being deployed. It watches ToolHive custom resources | ||
| and reconciles MCP server workloads in your cluster. | ||
|
|
||
| 1. Verify the operator pod is running |
There was a problem hiding this comment.
Normally I'd be ok with this, but I've seen this commands (and the CR snippets below) become outdated quickly. We should probably remove section 1, 2 and 3. We can keep 4. Learn more though
Per maintainer feedback, remove kubectl verification commands and the MCPServer example snippet that can go stale quickly. Keep release context and documentation links.
|
Thanks for the review @ChrisJBurns — updated in 9e0e215. Removed sections 1–3 (kubectl verification, logs, and the MCPServer example) and kept the release context plus documentation links. Updated the helm-unittest suite accordingly (60/60 passing). |
Summary
Adds Helm post-install notes to
deploy/charts/operatorsohelm installprints actionable next steps: verify the operator deployment, check logs, apply a minimal MCPServer example, and find documentation.Motivation
After
helm install, users currently receive no post-installation guidance about verifying the operator, creating their first MCPServer, or where to find docs. Most production Helm charts includeNOTES.txtfor this first-run experience.Changes
templates/NOTES.txt— release metadata, kubectl verification commands, embeddedfetchMCPServer manifest (aligned withexamples/operator/mcp-servers/mcpserver_fetch.yaml), doc links, and optional namespace RBAC guidancetests/notes_test.yaml— helm-unittest coverage for release context, kubectl commands, MCPServer example, and key documentation linksTests
helm unittest deploy/charts/operator— 14 suites, 61 tests passed (including 3 new NOTES tests)Notes
operator.rbac.allowedNamespaces.Fixes #4615