-
Notifications
You must be signed in to change notification settings - Fork 2
Improve notification silence docs #394
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ebae9bb
docs: notification silences example and improvements
adityathebe fb141d4
docs: CRD reference
adityathebe 3481cc8
docs(silences): link to full resource selector reference instead of i…
adityathebe 899dd60
docs(silences): update resource selection docs and remove component e…
adityathebe db4588e
docs(notifications): add missing CEL template variables
adityathebe 4cadec2
chore: remove image
adityathebe File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file removed
BIN
-58 KB
mission-control/docs/guide/notifications/concepts/silence-notification-form.png
Binary file not shown.
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| <Fields withTemplates="true" rows={[ | ||
| { | ||
| field: "description", | ||
| description: "A description explaining the purpose of the silence", | ||
| scheme: "string" | ||
| }, | ||
| { | ||
| field: "from", | ||
| description: "Start time of the silence period in RFC3339 format, datetime or datemath expression (e.g., \"now\", \"now+2h\", \"2025-01-01\")", | ||
| scheme: "string" | ||
| }, | ||
| { | ||
| field: "until", | ||
| description: "End time of the silence period in RFC3339 format, datetime or datemath expression (e.g., \"now\", \"now+2d\", \"2025-02-01\")", | ||
| scheme: "string" | ||
| }, | ||
| { | ||
| field: "recursive", | ||
| description: "When true, the silence applies to all child resources of the matched resources. For example, silencing a namespace would silence all deployments, statefulsets, pods, etc. within it.", | ||
| scheme: "boolean" | ||
| }, | ||
| { | ||
| field: "filter", | ||
| description: "A CEL expression that determines whether to apply the silence. The silence is only applied if the filter evaluates to true.", | ||
| scheme: "CEL", | ||
| templateEnv: [ | ||
| {"name": "CheckEvents", "url": "/docs/reference/notifications/template_vars/checks"}, | ||
| {"name": "ConfigEvents", "url": "/docs/reference/notifications/template_vars/config"}, | ||
| ], | ||
adityathebe marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }, | ||
| { | ||
| field: "selectors", | ||
| description: "List of resource selectors to target specific resources", | ||
| scheme: "[[]ResourceSelector](/docs/reference/resource-selector)" | ||
| } | ||
| ]}/> | ||
|
|
||
| :::info | ||
| At least one of `filter` or `selectors` must be specified to target resources for the silence. When both are specified, `filter` takes precedence. | ||
| ::: | ||
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.
Uh oh!
There was an error while loading. Please reload this page.