Skip to content

Commit e3a36a7

Browse files
committed
docs: CRD reference
1 parent 9abe837 commit e3a36a7

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

mission-control/docs/guide/notifications/concepts/silences.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ sidebar_custom_props:
44
icon: mage:notification-bell-muted
55
---
66

7+
import Silence from "@site/docs/reference/notifications/_silence.mdx"
8+
79
A silence is a way to temporarily suppress notifications. Each silence has:
810

911
- A description - explaining why the silence was created
@@ -32,6 +34,8 @@ Silences can be created in multiple ways:
3234
2. Using the silence button on Slack notifications (when using default templates)
3335
3. By applying a NotificationSilence custom resource
3436

37+
<Silence />
38+
3539
### Resource Selection
3640

3741
Silences can target resources in two ways:
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<Fields withTemplates="true" rows={[
2+
{
3+
field: "description",
4+
description: "A description explaining the purpose of the silence",
5+
scheme: "string"
6+
},
7+
{
8+
field: "from",
9+
description: "Start time of the silence period in RFC3339 format or datetime",
10+
scheme: "string"
11+
},
12+
{
13+
field: "until",
14+
description: "End time of the silence period in RFC3339 format or datetime",
15+
scheme: "string"
16+
},
17+
{
18+
field: "recursive",
19+
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.",
20+
scheme: "boolean"
21+
},
22+
{
23+
field: "filter",
24+
description: "A CEL expression that determines whether to apply the silence. The silence is only applied if the filter evaluates to true.",
25+
scheme: "CEL",
26+
templateEnv: [
27+
{"name": "CheckEvents", "url": "/reference/notifications/template_vars/checks"},
28+
{"name": "ConfigEvents", "url": "/reference/notifications/template_vars/config"},
29+
{"name": "ComponentEvents", "url": "/reference/notifications/template_vars/components"},
30+
],
31+
},
32+
{
33+
field: "selectors",
34+
description: "List of resource selectors to target specific resources by their kind and name",
35+
scheme: "[[]ResourceSelector](#resource-selector)"
36+
}
37+
]}/>
38+
39+
### Resource Selector
40+
41+
<Fields rows={[
42+
{
43+
field: "kind",
44+
description: "The kind of resource to select (e.g., 'Kubernetes::StatefulSet', 'Kubernetes::Pod')",
45+
scheme: "string"
46+
},
47+
{
48+
field: "name",
49+
description: "The name of the resource to select",
50+
scheme: "string"
51+
}
52+
]}/>

0 commit comments

Comments
 (0)