Skip to content

feat(operator-chart): add post-install NOTES.txt (#4615)#5656

Open
syf2211 wants to merge 2 commits into
stacklok:mainfrom
syf2211:docs/4615-helm-notes-txt
Open

feat(operator-chart): add post-install NOTES.txt (#4615)#5656
syf2211 wants to merge 2 commits into
stacklok:mainfrom
syf2211:docs/4615-helm-notes-txt

Conversation

@syf2211

@syf2211 syf2211 commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds Helm post-install notes to deploy/charts/operator so helm install prints 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 include NOTES.txt for this first-run experience.

Changes

  • templates/NOTES.txt — release metadata, kubectl verification commands, embedded fetch MCPServer manifest (aligned with examples/operator/mcp-servers/mcpserver_fetch.yaml), doc links, and optional namespace RBAC guidance
  • tests/notes_test.yaml — helm-unittest coverage for release context, kubectl commands, MCPServer example, and key documentation links

Tests

  • helm unittest deploy/charts/operator — 14 suites, 61 tests passed (including 3 new NOTES tests)

Notes

  • Default cluster-scoped RBAC is unchanged; namespace-scoped installs get an extra note listing operator.rbac.allowedNamespaces.
  • composer-2.5 review: APPROVE

Fixes #4615

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
@github-actions github-actions Bot added the size/S Small PR: 100-299 lines changed label Jun 26, 2026
@codecov

codecov Bot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.33%. Comparing base (7c574e2) to head (9e0e215).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ChrisJBurns ChrisJBurns left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@syf2211

syf2211 commented Jun 26, 2026

Copy link
Copy Markdown
Contributor Author

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).

@github-actions github-actions Bot added size/XS Extra small PR: < 100 lines changed and removed size/S Small PR: 100-299 lines changed labels Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Extra small PR: < 100 lines changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add NOTES.txt for Helm chart post-install guidance

3 participants