VMRule v1beta1 — operator.victoriametrics.com

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object required

VMRuleSpec defines the desired state of VMRule

groups []object required

Groups list of group rules

concurrency integer

Concurrency defines how many rules execute at once.

eval_alignment boolean

Optional The evaluation timestamp will be aligned with group's interval, instead of using the actual timestamp that evaluation happens at. It is enabled by default to get more predictable results and to visually align with graphs plotted via Grafana or vmui.

eval_delay string

Optional Adjust the `time` parameter of group evaluation requests to compensate intentional query delay from the datasource.

eval_offset string

Optional Group will be evaluated at the exact offset in the range of [0...interval].

headers []string

Headers contains optional HTTP headers added to each rule request Must be in form `header-name: value` For example: headers: - "CustomHeader: foo" - "CustomHeader2: bar"

interval string

evaluation interval for group

labels object

Labels optional list of labels added to every rule within a group. It has priority over the external labels. Labels are commonly used for adding environment or tenant-specific tag.

limit integer

Limit the number of alerts an alerting rule and series a recording rule can produce

name string required

Name of group

notifier_headers []string

NotifierHeaders contains optional HTTP headers added to each alert request which will send to notifier Must be in form `header-name: value` For example: headers: - "CustomHeader: foo" - "CustomHeader2: bar"

params object

Params optional HTTP URL parameters added to each rule request

rules []object required

Rules list of alert rules

alert string

Alert is a name for alert

annotations object

Annotations will be added to rule configuration

debug boolean

Debug enables logging for rule it useful for tracking

expr string

Expr is query, that will be evaluated at dataSource

for string

For evaluation interval in time.Duration format 30s, 1m, 1h or nanoseconds

keep_firing_for string

KeepFiringFor will make alert continue firing for this long even when the alerting expression no longer has results. Use time.Duration format, 30s, 1m, 1h or nanoseconds

labels object

Labels will be added to rule configuration

record string

Record represents a query, that will be recorded to dataSource

update_entries_limit integer

UpdateEntriesLimit defines max number of rule's state updates stored in memory. Overrides `-rule.updateEntriesLimit` in vmalert.

tenant string

Tenant id for group, can be used only with enterprise version of vmalert. See more details [here](https://docs.victoriametrics.com/victoriametrics/vmalert/#multitenancy).

type string

Type defines datasource type for enterprise version of vmalert possible values - prometheus,graphite,vlogs

status object

VMRuleStatus defines the observed state of VMRule

conditions []object

Known .status.conditions.type are: "Available", "Progressing", and "Degraded"

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another.

format: date-time

lastUpdateTime string required

LastUpdateTime is the last time of given type update. This value is used for status TTL update and removal

format: date-time

message string

message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

observedGeneration integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

format: int64

minimum: 0

reason string required

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

minLength: 1

maxLength: 1024

status string required

status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

Type of condition in CamelCase or in name.namespace.resource.victoriametrics.com/CamelCase.

maxLength: 316

observedGeneration integer

ObservedGeneration defines current generation picked by operator for the reconcile

format: int64

reason string

Reason defines human readable error reason

updateStatus string

UpdateStatus defines a status for update rollout