1 package v1
2
3
4
5
6
7
8
9
10
11
12
13
14 var map_AlertRelabelConfig = map[string]string{
15 "": "AlertRelabelConfig defines a set of relabel configs for alerts.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
16 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
17 "spec": "spec describes the desired state of this AlertRelabelConfig object.",
18 "status": "status describes the current state of this AlertRelabelConfig object.",
19 }
20
21 func (AlertRelabelConfig) SwaggerDoc() map[string]string {
22 return map_AlertRelabelConfig
23 }
24
25 var map_AlertRelabelConfigList = map[string]string{
26 "": "AlertRelabelConfigList is a list of AlertRelabelConfigs.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
27 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
28 "items": "items is a list of AlertRelabelConfigs.",
29 }
30
31 func (AlertRelabelConfigList) SwaggerDoc() map[string]string {
32 return map_AlertRelabelConfigList
33 }
34
35 var map_AlertRelabelConfigSpec = map[string]string{
36 "": "AlertRelabelConfigsSpec is the desired state of an AlertRelabelConfig resource.",
37 "configs": "configs is a list of sequentially evaluated alert relabel configs.",
38 }
39
40 func (AlertRelabelConfigSpec) SwaggerDoc() map[string]string {
41 return map_AlertRelabelConfigSpec
42 }
43
44 var map_AlertRelabelConfigStatus = map[string]string{
45 "": "AlertRelabelConfigStatus is the status of an AlertRelabelConfig resource.",
46 "conditions": "conditions contains details on the state of the AlertRelabelConfig, may be empty.",
47 }
48
49 func (AlertRelabelConfigStatus) SwaggerDoc() map[string]string {
50 return map_AlertRelabelConfigStatus
51 }
52
53 var map_AlertingRule = map[string]string{
54 "": "AlertingRule represents a set of user-defined Prometheus rule groups containing alerting rules. This resource is the supported method for cluster admins to create alerts based on metrics recorded by the platform monitoring stack in OpenShift, i.e. the Prometheus instance deployed to the openshift-monitoring namespace. You might use this to create custom alerting rules not shipped with OpenShift based on metrics from components such as the node_exporter, which provides machine-level metrics such as CPU usage, or kube-state-metrics, which provides metrics on Kubernetes usage.\n\nThe API is mostly compatible with the upstream PrometheusRule type from the prometheus-operator. The primary difference being that recording rules are not allowed here -- only alerting rules. For each AlertingRule resource created, a corresponding PrometheusRule will be created in the openshift-monitoring namespace. OpenShift requires admins to use the AlertingRule resource rather than the upstream type in order to allow better OpenShift specific defaulting and validation, while not modifying the upstream APIs directly.\n\nYou can find upstream API documentation for PrometheusRule resources here:\n\nhttps://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
55 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
56 "spec": "spec describes the desired state of this AlertingRule object.",
57 "status": "status describes the current state of this AlertOverrides object.",
58 }
59
60 func (AlertingRule) SwaggerDoc() map[string]string {
61 return map_AlertingRule
62 }
63
64 var map_AlertingRuleList = map[string]string{
65 "": "AlertingRuleList is a list of AlertingRule objects.\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",
66 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
67 "items": "items is a list of AlertingRule objects.",
68 }
69
70 func (AlertingRuleList) SwaggerDoc() map[string]string {
71 return map_AlertingRuleList
72 }
73
74 var map_AlertingRuleSpec = map[string]string{
75 "": "AlertingRuleSpec is the desired state of an AlertingRule resource.",
76 "groups": "groups is a list of grouped alerting rules. Rule groups are the unit at which Prometheus parallelizes rule processing. All rules in a single group share a configured evaluation interval. All rules in the group will be processed together on this interval, sequentially, and all rules will be processed.\n\nIt's common to group related alerting rules into a single AlertingRule resources, and within that resource, closely related alerts, or simply alerts with the same interval, into individual groups. You are also free to create AlertingRule resources with only a single rule group, but be aware that this can have a performance impact on Prometheus if the group is extremely large or has very complex query expressions to evaluate. Spreading very complex rules across multiple groups to allow them to be processed in parallel is also a common use-case.",
77 }
78
79 func (AlertingRuleSpec) SwaggerDoc() map[string]string {
80 return map_AlertingRuleSpec
81 }
82
83 var map_AlertingRuleStatus = map[string]string{
84 "": "AlertingRuleStatus is the status of an AlertingRule resource.",
85 "observedGeneration": "observedGeneration is the last generation change you've dealt with.",
86 "prometheusRule": "prometheusRule is the generated PrometheusRule for this AlertingRule. Each AlertingRule instance results in a generated PrometheusRule object in the same namespace, which is always the openshift-monitoring namespace.",
87 }
88
89 func (AlertingRuleStatus) SwaggerDoc() map[string]string {
90 return map_AlertingRuleStatus
91 }
92
93 var map_PrometheusRuleRef = map[string]string{
94 "": "PrometheusRuleRef is a reference to an existing PrometheusRule object. Each AlertingRule instance results in a generated PrometheusRule object in the same namespace, which is always the openshift-monitoring namespace. This is used to point to the generated PrometheusRule object in the AlertingRule status.",
95 "name": "name of the referenced PrometheusRule.",
96 }
97
98 func (PrometheusRuleRef) SwaggerDoc() map[string]string {
99 return map_PrometheusRuleRef
100 }
101
102 var map_RelabelConfig = map[string]string{
103 "": "RelabelConfig allows dynamic rewriting of label sets for alerts. See Prometheus documentation: - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config",
104 "sourceLabels": "sourceLabels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the 'Replace', 'Keep', and 'Drop' actions. Not allowed for actions 'LabelKeep' and 'LabelDrop'.",
105 "separator": "separator placed between concatenated source label values. When omitted, Prometheus will use its default value of ';'.",
106 "targetLabel": "targetLabel to which the resulting value is written in a 'Replace' action. It is required for 'Replace' and 'HashMod' actions and forbidden for actions 'LabelKeep' and 'LabelDrop'. Regex capture groups are available.",
107 "regex": "regex against which the extracted value is matched. Default is: '(.*)' regex is required for all actions except 'HashMod'",
108 "modulus": "modulus to take of the hash of the source label values. This can be combined with the 'HashMod' action to set 'target_label' to the 'modulus' of a hash of the concatenated 'source_labels'. This is only valid if sourceLabels is not empty and action is not 'LabelKeep' or 'LabelDrop'.",
109 "replacement": "replacement value against which a regex replace is performed if the regular expression matches. This is required if the action is 'Replace' or 'LabelMap' and forbidden for actions 'LabelKeep' and 'LabelDrop'. Regex capture groups are available. Default is: '$1'",
110 "action": "action to perform based on regex matching. Must be one of: 'Replace', 'Keep', 'Drop', 'HashMod', 'LabelMap', 'LabelDrop', or 'LabelKeep'. Default is: 'Replace'",
111 }
112
113 func (RelabelConfig) SwaggerDoc() map[string]string {
114 return map_RelabelConfig
115 }
116
117 var map_Rule = map[string]string{
118 "": "Rule describes an alerting rule. See Prometheus documentation: - https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules",
119 "alert": "alert is the name of the alert. Must be a valid label value, i.e. may contain any Unicode character.",
120 "expr": "expr is the PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending or firing alerts. This is most often a string representing a PromQL expression, e.g.: mapi_current_pending_csr > mapi_max_pending_csr In rare cases this could be a simple integer, e.g. a simple \"1\" if the intent is to create an alert that is always firing. This is sometimes used to create an always-firing \"Watchdog\" alert in order to ensure the alerting pipeline is functional.",
121 "for": "for is the time period after which alerts are considered firing after first returning results. Alerts which have not yet fired for long enough are considered pending.",
122 "labels": "labels to add or overwrite for each alert. The results of the PromQL expression for the alert will result in an existing set of labels for the alert, after evaluating the expression, for any label specified here with the same name as a label in that set, the label here wins and overwrites the previous value. These should typically be short identifying values that may be useful to query against. A common example is the alert severity, where one sets `severity: warning` under the `labels` key:",
123 "annotations": "annotations to add to each alert. These are values that can be used to store longer additional information that you won't query on, such as alert descriptions or runbook links.",
124 }
125
126 func (Rule) SwaggerDoc() map[string]string {
127 return map_Rule
128 }
129
130 var map_RuleGroup = map[string]string{
131 "": "RuleGroup is a list of sequentially evaluated alerting rules.",
132 "name": "name is the name of the group.",
133 "interval": "interval is how often rules in the group are evaluated. If not specified, it defaults to the global.evaluation_interval configured in Prometheus, which itself defaults to 30 seconds. You can check if this value has been modified from the default on your cluster by inspecting the platform Prometheus configuration: The relevant field in that resource is: spec.evaluationInterval",
134 "rules": "rules is a list of sequentially evaluated alerting rules. Prometheus may process rule groups in parallel, but rules within a single group are always processed sequentially, and all rules are processed.",
135 }
136
137 func (RuleGroup) SwaggerDoc() map[string]string {
138 return map_RuleGroup
139 }
140
141
142
View as plain text