1. Docs
  2. Reference
  3. API
  4. Rancher 2
  5. ClusterAlertRule

ClusterAlertRule

Create a ClusterAlertRule Resource

new ClusterAlertRule(name: string, args: ClusterAlertRuleArgs, opts?: CustomResourceOptions);
def ClusterAlertRule(resource_name, opts=None, annotations=None, cluster_id=None, event_rule=None, group_id=None, group_interval_seconds=None, group_wait_seconds=None, inherited=None, labels=None, metric_rule=None, name=None, node_rule=None, repeat_interval_seconds=None, severity=None, system_service_rule=None, __props__=None);
func NewClusterAlertRule(ctx *Context, name string, args ClusterAlertRuleArgs, opts ...ResourceOption) (*ClusterAlertRule, error)
public ClusterAlertRule(string name, ClusterAlertRuleArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ClusterAlertRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ClusterAlertRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterAlertRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ClusterAlertRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ClusterAlertRule resource accepts the following input properties:

ClusterId string

The cluster id where create cluster alert rule (string)

GroupId string

The cluster alert rule alert group ID (string)

Annotations Dictionary<string, object>

The cluster alert rule annotations (map)

EventRule ClusterAlertRuleEventRuleArgs

The cluster alert rule event rule. ConflictsWith: "metric_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

GroupIntervalSeconds int

The cluster alert rule group interval seconds. Default: 180 (int)

GroupWaitSeconds int

The cluster alert rule group wait seconds. Default: 180 (int)

Inherited bool

The cluster alert rule inherited. Default: true (bool)

Labels Dictionary<string, object>

The cluster alert rule labels (map)

MetricRule ClusterAlertRuleMetricRuleArgs

The cluster alert rule metric rule. ConflictsWith: "event_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

Name string

The cluster alert rule name (string)

NodeRule ClusterAlertRuleNodeRuleArgs

The cluster alert rule node rule. ConflictsWith: "event_rule", "metric_rule", "system_service_rule"` (list Maxitems:1)

RepeatIntervalSeconds int

The cluster alert rule wait seconds. Default: 3600 (int)

Severity string

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

SystemServiceRule ClusterAlertRuleSystemServiceRuleArgs

The cluster alert rule system service rule. ConflictsWith: "event_rule", "metric_rule", "node_rule"` (list Maxitems:1)

ClusterId string

The cluster id where create cluster alert rule (string)

GroupId string

The cluster alert rule alert group ID (string)

Annotations map[string]interface{}

The cluster alert rule annotations (map)

EventRule ClusterAlertRuleEventRule

The cluster alert rule event rule. ConflictsWith: "metric_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

GroupIntervalSeconds int

The cluster alert rule group interval seconds. Default: 180 (int)

GroupWaitSeconds int

The cluster alert rule group wait seconds. Default: 180 (int)

Inherited bool

The cluster alert rule inherited. Default: true (bool)

Labels map[string]interface{}

The cluster alert rule labels (map)

MetricRule ClusterAlertRuleMetricRule

The cluster alert rule metric rule. ConflictsWith: "event_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

Name string

The cluster alert rule name (string)

NodeRule ClusterAlertRuleNodeRule

The cluster alert rule node rule. ConflictsWith: "event_rule", "metric_rule", "system_service_rule"` (list Maxitems:1)

RepeatIntervalSeconds int

The cluster alert rule wait seconds. Default: 3600 (int)

Severity string

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

SystemServiceRule ClusterAlertRuleSystemServiceRule

The cluster alert rule system service rule. ConflictsWith: "event_rule", "metric_rule", "node_rule"` (list Maxitems:1)

clusterId string

The cluster id where create cluster alert rule (string)

groupId string

The cluster alert rule alert group ID (string)

annotations {[key: string]: any}

The cluster alert rule annotations (map)

eventRule ClusterAlertRuleEventRule

The cluster alert rule event rule. ConflictsWith: "metric_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

groupIntervalSeconds number

The cluster alert rule group interval seconds. Default: 180 (int)

groupWaitSeconds number

The cluster alert rule group wait seconds. Default: 180 (int)

inherited boolean

The cluster alert rule inherited. Default: true (bool)

labels {[key: string]: any}

The cluster alert rule labels (map)

metricRule ClusterAlertRuleMetricRule

The cluster alert rule metric rule. ConflictsWith: "event_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

name string

The cluster alert rule name (string)

nodeRule ClusterAlertRuleNodeRule

The cluster alert rule node rule. ConflictsWith: "event_rule", "metric_rule", "system_service_rule"` (list Maxitems:1)

repeatIntervalSeconds number

The cluster alert rule wait seconds. Default: 3600 (int)

severity string

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

systemServiceRule ClusterAlertRuleSystemServiceRule

The cluster alert rule system service rule. ConflictsWith: "event_rule", "metric_rule", "node_rule"` (list Maxitems:1)

cluster_id str

The cluster id where create cluster alert rule (string)

group_id str

The cluster alert rule alert group ID (string)

annotations Dict[str, Any]

The cluster alert rule annotations (map)

event_rule Dict[ClusterAlertRuleEventRule]

The cluster alert rule event rule. ConflictsWith: "metric_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

group_interval_seconds float

The cluster alert rule group interval seconds. Default: 180 (int)

group_wait_seconds float

The cluster alert rule group wait seconds. Default: 180 (int)

inherited bool

The cluster alert rule inherited. Default: true (bool)

labels Dict[str, Any]

The cluster alert rule labels (map)

metric_rule Dict[ClusterAlertRuleMetricRule]

The cluster alert rule metric rule. ConflictsWith: "event_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

name str

The cluster alert rule name (string)

node_rule Dict[ClusterAlertRuleNodeRule]

The cluster alert rule node rule. ConflictsWith: "event_rule", "metric_rule", "system_service_rule"` (list Maxitems:1)

repeat_interval_seconds float

The cluster alert rule wait seconds. Default: 3600 (int)

severity str

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

system_service_rule Dict[ClusterAlertRuleSystemServiceRule]

The cluster alert rule system service rule. ConflictsWith: "event_rule", "metric_rule", "node_rule"` (list Maxitems:1)

Outputs

All input properties are implicitly available as output properties. Additionally, the ClusterAlertRule resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing ClusterAlertRule Resource

Get an existing ClusterAlertRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterAlertRuleState, opts?: CustomResourceOptions): ClusterAlertRule
static get(resource_name, id, opts=None, annotations=None, cluster_id=None, event_rule=None, group_id=None, group_interval_seconds=None, group_wait_seconds=None, inherited=None, labels=None, metric_rule=None, name=None, node_rule=None, repeat_interval_seconds=None, severity=None, system_service_rule=None, __props__=None);
func GetClusterAlertRule(ctx *Context, name string, id IDInput, state *ClusterAlertRuleState, opts ...ResourceOption) (*ClusterAlertRule, error)
public static ClusterAlertRule Get(string name, Input<string> id, ClusterAlertRuleState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Annotations Dictionary<string, object>

The cluster alert rule annotations (map)

ClusterId string

The cluster id where create cluster alert rule (string)

EventRule ClusterAlertRuleEventRuleArgs

The cluster alert rule event rule. ConflictsWith: "metric_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

GroupId string

The cluster alert rule alert group ID (string)

GroupIntervalSeconds int

The cluster alert rule group interval seconds. Default: 180 (int)

GroupWaitSeconds int

The cluster alert rule group wait seconds. Default: 180 (int)

Inherited bool

The cluster alert rule inherited. Default: true (bool)

Labels Dictionary<string, object>

The cluster alert rule labels (map)

MetricRule ClusterAlertRuleMetricRuleArgs

The cluster alert rule metric rule. ConflictsWith: "event_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

Name string

The cluster alert rule name (string)

NodeRule ClusterAlertRuleNodeRuleArgs

The cluster alert rule node rule. ConflictsWith: "event_rule", "metric_rule", "system_service_rule"` (list Maxitems:1)

RepeatIntervalSeconds int

The cluster alert rule wait seconds. Default: 3600 (int)

Severity string

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

SystemServiceRule ClusterAlertRuleSystemServiceRuleArgs

The cluster alert rule system service rule. ConflictsWith: "event_rule", "metric_rule", "node_rule"` (list Maxitems:1)

Annotations map[string]interface{}

The cluster alert rule annotations (map)

ClusterId string

The cluster id where create cluster alert rule (string)

EventRule ClusterAlertRuleEventRule

The cluster alert rule event rule. ConflictsWith: "metric_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

GroupId string

The cluster alert rule alert group ID (string)

GroupIntervalSeconds int

The cluster alert rule group interval seconds. Default: 180 (int)

GroupWaitSeconds int

The cluster alert rule group wait seconds. Default: 180 (int)

Inherited bool

The cluster alert rule inherited. Default: true (bool)

Labels map[string]interface{}

The cluster alert rule labels (map)

MetricRule ClusterAlertRuleMetricRule

The cluster alert rule metric rule. ConflictsWith: "event_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

Name string

The cluster alert rule name (string)

NodeRule ClusterAlertRuleNodeRule

The cluster alert rule node rule. ConflictsWith: "event_rule", "metric_rule", "system_service_rule"` (list Maxitems:1)

RepeatIntervalSeconds int

The cluster alert rule wait seconds. Default: 3600 (int)

Severity string

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

SystemServiceRule ClusterAlertRuleSystemServiceRule

The cluster alert rule system service rule. ConflictsWith: "event_rule", "metric_rule", "node_rule"` (list Maxitems:1)

annotations {[key: string]: any}

The cluster alert rule annotations (map)

clusterId string

The cluster id where create cluster alert rule (string)

eventRule ClusterAlertRuleEventRule

The cluster alert rule event rule. ConflictsWith: "metric_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

groupId string

The cluster alert rule alert group ID (string)

groupIntervalSeconds number

The cluster alert rule group interval seconds. Default: 180 (int)

groupWaitSeconds number

The cluster alert rule group wait seconds. Default: 180 (int)

inherited boolean

The cluster alert rule inherited. Default: true (bool)

labels {[key: string]: any}

The cluster alert rule labels (map)

metricRule ClusterAlertRuleMetricRule

The cluster alert rule metric rule. ConflictsWith: "event_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

name string

The cluster alert rule name (string)

nodeRule ClusterAlertRuleNodeRule

The cluster alert rule node rule. ConflictsWith: "event_rule", "metric_rule", "system_service_rule"` (list Maxitems:1)

repeatIntervalSeconds number

The cluster alert rule wait seconds. Default: 3600 (int)

severity string

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

systemServiceRule ClusterAlertRuleSystemServiceRule

The cluster alert rule system service rule. ConflictsWith: "event_rule", "metric_rule", "node_rule"` (list Maxitems:1)

annotations Dict[str, Any]

The cluster alert rule annotations (map)

cluster_id str

The cluster id where create cluster alert rule (string)

event_rule Dict[ClusterAlertRuleEventRule]

The cluster alert rule event rule. ConflictsWith: "metric_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

group_id str

The cluster alert rule alert group ID (string)

group_interval_seconds float

The cluster alert rule group interval seconds. Default: 180 (int)

group_wait_seconds float

The cluster alert rule group wait seconds. Default: 180 (int)

inherited bool

The cluster alert rule inherited. Default: true (bool)

labels Dict[str, Any]

The cluster alert rule labels (map)

metric_rule Dict[ClusterAlertRuleMetricRule]

The cluster alert rule metric rule. ConflictsWith: "event_rule", "node_rule", "system_service_rule"` (list Maxitems:1)

name str

The cluster alert rule name (string)

node_rule Dict[ClusterAlertRuleNodeRule]

The cluster alert rule node rule. ConflictsWith: "event_rule", "metric_rule", "system_service_rule"` (list Maxitems:1)

repeat_interval_seconds float

The cluster alert rule wait seconds. Default: 3600 (int)

severity str

The cluster alert rule severity. Supported values : "critical" | "info" | "warning". Default: critical (string)

system_service_rule Dict[ClusterAlertRuleSystemServiceRule]

The cluster alert rule system service rule. ConflictsWith: "event_rule", "metric_rule", "node_rule"` (list Maxitems:1)

Supporting Types

ClusterAlertRuleEventRule

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ResourceKind string

Resource kind. Supported values : "DaemonSet" | "Deployment" | "Node" | "Pod" | "StatefulSet" (string)

EventType string

Event type. Supported values : "Warning" | "Normal". Default: Warning (string)

ResourceKind string

Resource kind. Supported values : "DaemonSet" | "Deployment" | "Node" | "Pod" | "StatefulSet" (string)

EventType string

Event type. Supported values : "Warning" | "Normal". Default: Warning (string)

resourceKind string

Resource kind. Supported values : "DaemonSet" | "Deployment" | "Node" | "Pod" | "StatefulSet" (string)

eventType string

Event type. Supported values : "Warning" | "Normal". Default: Warning (string)

resourceKind str

Resource kind. Supported values : "DaemonSet" | "Deployment" | "Node" | "Pod" | "StatefulSet" (string)

eventType str

Event type. Supported values : "Warning" | "Normal". Default: Warning (string)

ClusterAlertRuleMetricRule

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Duration string

Metric rule duration (string)

Expression string

Metric rule expression (string)

ThresholdValue double

Metric rule threshold value (float64)

Comparison string

Metric rule comparison. Supported values : "equal" | "greater-or-equal" | "greater-than" | "less-or-equal" | "less-than" | "not-equal" | "has-value". Default: equal (string)

Description string

Metric rule description (string)

Duration string

Metric rule duration (string)

Expression string

Metric rule expression (string)

ThresholdValue float64

Metric rule threshold value (float64)

Comparison string

Metric rule comparison. Supported values : "equal" | "greater-or-equal" | "greater-than" | "less-or-equal" | "less-than" | "not-equal" | "has-value". Default: equal (string)

Description string

Metric rule description (string)

duration string

Metric rule duration (string)

expression string

Metric rule expression (string)

thresholdValue number

Metric rule threshold value (float64)

comparison string

Metric rule comparison. Supported values : "equal" | "greater-or-equal" | "greater-than" | "less-or-equal" | "less-than" | "not-equal" | "has-value". Default: equal (string)

description string

Metric rule description (string)

duration str

Metric rule duration (string)

expression str

Metric rule expression (string)

thresholdValue float

Metric rule threshold value (float64)

comparison str

Metric rule comparison. Supported values : "equal" | "greater-or-equal" | "greater-than" | "less-or-equal" | "less-than" | "not-equal" | "has-value". Default: equal (string)

description str

Metric rule description (string)

ClusterAlertRuleNodeRule

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Condition string

System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

CpuThreshold int

Node rule cpu threshold. Default: 70 (int)

MemThreshold int

Node rule mem threshold. Default: 70 (int)

NodeId string

Node ID (string)

Selector Dictionary<string, object>

Node rule selector (map)

Condition string

System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

CpuThreshold int

Node rule cpu threshold. Default: 70 (int)

MemThreshold int

Node rule mem threshold. Default: 70 (int)

NodeId string

Node ID (string)

Selector map[string]interface{}

Node rule selector (map)

condition string

System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

cpuThreshold number

Node rule cpu threshold. Default: 70 (int)

memThreshold number

Node rule mem threshold. Default: 70 (int)

nodeId string

Node ID (string)

selector {[key: string]: any}

Node rule selector (map)

condition str

System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

cpuThreshold float

Node rule cpu threshold. Default: 70 (int)

memThreshold float

Node rule mem threshold. Default: 70 (int)

nodeId str

Node ID (string)

selector Dict[str, Any]

Node rule selector (map)

ClusterAlertRuleSystemServiceRule

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Condition string

System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

Condition string

System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

condition string

System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

condition str

System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

Package Details

Repository
https://github.com/pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.