Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions deploy/charts/operator/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Thank you for installing {{ .Chart.Name }}!

Release: {{ .Release.Name }}
Namespace: {{ .Release.Namespace }}
Chart version: {{ .Chart.Version }}
Operator version: {{ .Chart.AppVersion }}

The ToolHive Operator is being deployed. It watches ToolHive custom resources
and reconciles MCP server workloads in your cluster.

Learn more

Operator guide:
https://github.com/stacklok/toolhive/blob/main/docs/kind/deploying-mcp-server-with-operator.md

Example manifests:
https://github.com/stacklok/toolhive/tree/main/examples/operator

Documentation:
https://docs.stacklok.com/toolhive/

{{- if eq .Values.operator.rbac.scope "namespace" }}

Note: RBAC scope is set to "namespace". The operator only manages resources in:
{{- range .Values.operator.rbac.allowedNamespaces }}
- {{ . }}
{{- end }}
{{- if not .Values.operator.rbac.allowedNamespaces }}
(no namespaces configured — set operator.rbac.allowedNamespaces)
{{- end }}
{{- end }}
23 changes: 23 additions & 0 deletions deploy/charts/operator/tests/notes_test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
suite: post-install notes
# NOTES.txt is the only user-facing output after `helm install`. Pin the
# release context and documentation links so template refactors don't silently
# drop post-install guidance.
release:
name: toolhive-operator
namespace: toolhive-system
templates:
- NOTES.txt
tests:
- it: renders release and namespace context
asserts:
- matchRegexRaw:
pattern: 'Release: toolhive-operator'
- matchRegexRaw:
pattern: 'Namespace: toolhive-system'

- it: includes documentation links
asserts:
- matchRegexRaw:
pattern: 'deploying-mcp-server-with-operator\.md'
- matchRegexRaw:
pattern: 'docs\.stacklok\.com/toolhive/'
Loading