Skip to content

[v17] docs: Render Event Handler helm chart reference with render-helm-ref#62316

Merged
kshi36 merged 3 commits intobranch/v17from
kevin/backport-62282-branch/v17
Dec 18, 2025
Merged

[v17] docs: Render Event Handler helm chart reference with render-helm-ref#62316
kshi36 merged 3 commits intobranch/v17from
kevin/backport-62282-branch/v17

Conversation

@kshi36
Copy link
Copy Markdown
Contributor

@kshi36 kshi36 commented Dec 16, 2025

Backport #62282 to branch/v17

#62282)

* docs: Render Event Handler helm chart reference with `render-helm-ref`

* Add rendered doc

* Fix typos

* Fix spellings, change spammy to noisy
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 16, 2025

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
kevin/backport-62282-branch/v17 3e0ee0e 3 ✅SUCCEED kevin-backport-62282-branch-v17 2025-12-17 18:27:29

@kshi36 kshi36 marked this pull request as ready for review December 16, 2025 22:12
@kshi36 kshi36 added the no-changelog Indicates that a PR does not require a changelog entry label Dec 16, 2025
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I added doc comments for fields that were not backported in previous PRs.

Comment on lines +58 to +72
# Optional setting to enable debug logging
# debug: true
# Optional setting for event types to forward
# types: ["TYPE1", "TYPE2"]
# Optional setting for audit event types to skip
# skipEventTypes: ["TYPE1"]
# Optional setting for session recording event types to skip
# skipSessionTypes: ["TYPE1"]
# eventHandler.debug(bool) -- enables debug logging.
# @default -- false
# eventHandler.types(list) -- is the list of event types to forward.
# When unset, the event handler forwards all events.
# @default -- []
# eventHandler.skipEventTypes(list) -- is the list of audit event types to skip.
# @default -- []
# eventHandler.skipSessionTypes(list) -- is the list of session recording event types to skip.
# When unset, the event handler skips noisy and binary events.
#
# See the [Teleport-event-handler README](https://github.com/gravitational/teleport/blob/1d2bd5eb8fc3500deb7d7108f6835efde98b7b24/integrations/event-handler/README.md)
# for a list of default skipped events.
# @default -- []
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

To match existing behavior, only updated documentation comments here.

Comment thread examples/chart/event-handler/values.yaml Outdated
@kshi36 kshi36 added this pull request to the merge queue Dec 18, 2025
Merged via the queue into branch/v17 with commit 2b31059 Dec 18, 2025
39 checks passed
@kshi36 kshi36 deleted the kevin/backport-62282-branch/v17 branch December 18, 2025 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport documentation helm no-changelog Indicates that a PR does not require a changelog entry size/md

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants