kube_cluster 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 821079f616a7cafa9d2115b32cebda37de37601d9ac116827c7fbcead48de3eb
-  data.tar.gz: bb33e6aec68bc2a83c67272d2a2fa73e38234095aefbb686e6b749bbd4add87c
+  metadata.gz: 161e8e4b158fcb49cbab16469213bb0a49fab8ff7d1669a1c974fa79b60e4d77
+  data.tar.gz: 87da0f1d7a75f18803146f1dc23bbe23bf5c188a3106751ef1ff95edfe38c9a5
 SHA512:
-  metadata.gz: 070b4bdf62bbf662bfa99eb55a464335d9666734ef3985f08949b072c78aa548cd51d0527c9cee62d26ca8839df8d2ddafa285b0fb44f0b346268174aab78ec8
-  data.tar.gz: 28f9483b8a10994f19f485c9e55b33e464541742842eff8c5791218ff294435f6ce55f59921aa9eb5c8725bd456d8a63d74be2f39c25d88c46e8601295829f13
+  metadata.gz: d41568ed4346c1429eda172bb4021c38e72a1e4cb7994c8060991df077b6fb7eebc4a9f9c58689cf0839c97ad682d546aff7ab9360c57f8c14845d8626b07252
+  data.tar.gz: 85f8c1da91dcacfedf71b19736edef620113d71d211c51aa0f303cef72d63d2110cd8a4d9adab7f2fc2ee99f2fbec55837141c49f904587fbbd07d90e101325c

data/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.0] - 2026-07-13
+
+### Added
+- `Standard::VictoriaMetrics::VMRule` — a wrapper for the VictoriaMetrics
+  operator's `VMRule` CRD (pinned to `operator.victoriametrics.com/v1beta1`).
+  Rules are built from `VMRule::Group` objects, each exposing `rule`/`alert`
+  helpers that construct `Rule`/`Alert` leaves; the rule expression is the
+  return value of a block, so multi-line PromQL reads as a heredoc.
+- `Standard::VictoriaMetrics::VMAlert` — a wrapper for the VictoriaMetrics
+  operator's `VMAlert` CRD (pinned to `operator.victoriametrics.com/v1beta1`).
+  Wires `datasource`/`remoteWrite`/`remoteRead` and defaults `selectAllByDefault`
+  to true so it evaluates every `VMRule`; `notifier_url` is optional (recording
+  rules need no notifier).
+
 ## [1.3.1] - 2026-07-13
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kube_cluster (1.3.1)
+    kube_cluster (1.4.0)
       activesupport (~> 8.0)
       kube_kubectl (~> 2.0)
       kube_schema (~> 1.9.2)

data/lib/kube/cluster/standard/victoria_metrics/vm_alert.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "kube/cluster"
+
+module Kube
+  module Cluster
+    module Standard
+      module VictoriaMetrics
+        # Evaluates VMRule recording/alerting rules (selecting all by default).
+        # Recording-rule output is written back via remote_write_url; a notifier
+        # is only needed for alerting rules, so it is optional.
+        class VMAlert < Kube::Cluster["VMAlert"]
+          def initialize(name:, datasource_url:, remote_write_url:, remote_read_url: nil,
+                         notifier_url: nil, evaluation_interval: nil, select_all: true, &block)
+            super() {
+              metadata.name           = name
+              spec.selectAllByDefault = select_all
+              spec.datasource         = { url: datasource_url }
+              spec.remoteWrite        = { url: remote_write_url }
+              spec.remoteRead         = { url: remote_read_url }      if remote_read_url
+              spec.notifiers          = [{ url: notifier_url }]       if notifier_url
+              spec.evaluationInterval = evaluation_interval           if evaluation_interval
+              instance_exec(&block) if block
+            }
+          end
+        end
+      end
+    end
+  end
+end
+
+__END__
+
+describe "VictoriaMetrics::VMAlert" do
+  it "wires datasource and remote-write for recording rules" do
+    yaml = Kube::Cluster::Standard::VictoriaMetrics::VMAlert.new(
+      name:             "vmalert",
+      datasource_url:   "http://vmsingle-vmsingle.metrics.svc:8429/prometheus",
+      remote_write_url: "http://vmsingle-vmsingle.metrics.svc:8429/api/v1/write"
+    ).to_yaml
+
+    yaml.include?("operator.victoriametrics.com/v1beta1").should == true
+    yaml.include?("selectAllByDefault").should == true
+    yaml.include?("/api/v1/write").should == true
+  end
+end

data/lib/kube/cluster/standard/victoria_metrics/vm_rule.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "kube/cluster"
+
+module Kube
+  module Cluster
+    module Standard
+      module VictoriaMetrics
+        # A recording rule. The block returns the PromQL expression, so
+        # multi-line queries read as a heredoc at the call site.
+        class Rule
+          def initialize(name, labels: nil, &block)
+            @name   = name
+            @labels = labels
+            @expr   = block.call.to_s if block
+          end
+
+          def to_h
+            h = { record: @name, expr: @expr }
+            h[:labels] = @labels if @labels
+            h
+          end
+        end
+
+        # An alerting rule. The block returns the PromQL expression.
+        class Alert
+          def initialize(name, for_: nil, keep_firing_for: nil, labels: nil, annotations: nil, &block)
+            @name            = name
+            @for             = for_
+            @keep_firing_for = keep_firing_for
+            @labels          = labels
+            @annotations     = annotations
+            @expr            = block.call.to_s if block
+          end
+
+          def to_h
+            h = { alert: @name, expr: @expr }
+            h[:for]             = @for             if @for
+            h[:keep_firing_for] = @keep_firing_for if @keep_firing_for
+            h[:labels]          = @labels          if @labels
+            h[:annotations]     = @annotations     if @annotations
+            h
+          end
+        end
+
+        # A named group of rules. `rule`/`alert` build and collect the leaves;
+        # the block is instance_eval'd so those helpers read like keywords.
+        #
+        #   Group.new("node.rules") {
+        #     rule "node:node_num_cpu:sum" do
+        #       <<~PROMQL
+        #         count by (cluster, node) (...)
+        #       PROMQL
+        #     end
+        #   }
+        class Group
+          def initialize(name, &block)
+            @name  = name
+            @rules = []
+            instance_eval(&block) if block
+          end
+
+          def rule(name, **opts, &block)  = @rules << Rule.new(name, **opts, &block)
+          def alert(name, **opts, &block) = @rules << Alert.new(name, **opts, &block)
+
+          def to_h = { name: @name, rules: @rules.map(&:to_h) }
+        end
+
+        # A VMRule CR: a set of rule Groups evaluated by VictoriaMetrics.
+        #
+        #   VMRule.new(name: "node", groups: [
+        #     Group.new("node.rules") { ... },
+        #   ])
+        class VMRule < Kube::Cluster["VMRule"]
+          def initialize(name:, groups:, &block)
+            super() {
+              metadata.name = name
+              spec.groups   = groups.map(&:to_h)
+              instance_exec(&block) if block
+            }
+          end
+        end
+      end
+    end
+  end
+end
+
+__END__
+
+describe "VictoriaMetrics::VMRule" do
+  vmrule = Kube::Cluster::Standard::VictoriaMetrics::VMRule
+  group  = Kube::Cluster::Standard::VictoriaMetrics::Group
+
+  it "emits a recording rule with the resolved v1beta1 apiVersion" do
+    yaml = vmrule.new(
+      name:   "node",
+      groups: [
+        group.new("node.rules") {
+          rule "node:node_num_cpu:sum" do
+            "count by (cluster, node) (node_cpu_seconds_total)"
+          end
+        },
+      ]
+    ).to_yaml
+
+    yaml.include?("operator.victoriametrics.com/v1beta1").should == true
+    yaml.include?("record: node:node_num_cpu:sum").should == true
+  end
+
+  it "carries labels on records" do
+    group.new("g") {
+      rule "r", labels: { quantile: "0.99" } do
+        "histogram_quantile(0.99, x)"
+      end
+    }.to_h.should == {
+      name:  "g",
+      rules: [{ record: "r", expr: "histogram_quantile(0.99, x)", labels: { quantile: "0.99" } }],
+    }
+  end
+
+  it "builds alerts with for/labels/annotations" do
+    group.new("g") {
+      alert "Down", for_: "5m", labels: { severity: "warning" }, annotations: { summary: "down" } do
+        "up == 0"
+      end
+    }.to_h.should == {
+      name:  "g",
+      rules: [{
+        alert:       "Down",
+        expr:        "up == 0",
+        for:         "5m",
+        labels:      { severity: "warning" },
+        annotations: { summary: "down" },
+      }],
+    }
+  end
+end

data/lib/kube/cluster/version.rb

@@ -2,6 +2,6 @@
 
 module Kube
   module Cluster
-    VERSION = "1.3.1"
+    VERSION = "1.4.0"
   end
 end

data/lib/kube/cluster.rb

@@ -128,7 +128,9 @@ Kube::Cluster.config do
   resolve "VLAgent",                  to: "operator.victoriametrics.com/v1/VLAgent"
   resolve "VLSingle",                 to: "operator.victoriametrics.com/v1/VLSingle"
   resolve "VMAgent",                  to: "operator.victoriametrics.com/v1beta1/VMAgent"
+  resolve "VMAlert",                  to: "operator.victoriametrics.com/v1beta1/VMAlert"
   resolve "VMNodeScrape",             to: "operator.victoriametrics.com/v1beta1/VMNodeScrape"
+  resolve "VMRule",                   to: "operator.victoriametrics.com/v1beta1/VMRule"
   resolve "VMServiceScrape",          to: "operator.victoriametrics.com/v1beta1/VMServiceScrape"
   resolve "VMSingle",                 to: "operator.victoriametrics.com/v1beta1/VMSingle"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kube_cluster
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Nathan K
@@ -246,7 +246,9 @@ files:
 - lib/kube/cluster/standard/victoria_metrics/vl_agent.rb
 - lib/kube/cluster/standard/victoria_metrics/vl_single.rb
 - lib/kube/cluster/standard/victoria_metrics/vm_agent.rb
+- lib/kube/cluster/standard/victoria_metrics/vm_alert.rb
 - lib/kube/cluster/standard/victoria_metrics/vm_node_scrape.rb
+- lib/kube/cluster/standard/victoria_metrics/vm_rule.rb
 - lib/kube/cluster/standard/victoria_metrics/vm_service_scrape.rb
 - lib/kube/cluster/standard/victoria_metrics/vm_single.rb
 - lib/kube/cluster/standard/volume_processing.rb