kube_cluster 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0768b58c75b80c58ddbe6bbae20aab3e57cad3a607058d7c2ebe64662d601f14'
-  data.tar.gz: b6260994b93ce8c91c897d6e44fb771fb2df82eebab158353485a8423ba9a61a
+  metadata.gz: 161e8e4b158fcb49cbab16469213bb0a49fab8ff7d1669a1c974fa79b60e4d77
+  data.tar.gz: 87da0f1d7a75f18803146f1dc23bbe23bf5c188a3106751ef1ff95edfe38c9a5
 SHA512:
-  metadata.gz: 0d10e0cda8c7483ca5190dc2351cf12a4a9ea856a61498cc1b210c1ff431d0e20c1fbe1908520f05c799329e1304d10ec1cdb0dcc7a80cd550ad8d0fc1ea695d
-  data.tar.gz: ba7e0fcd06465f26a7d6197f41c4de71e713ebb06bde325433ac3dc41390ae7e95571e04cad35110f5cf4e17613262dae9189c8da3d35de4683b55537983ef7c
+  metadata.gz: d41568ed4346c1429eda172bb4021c38e72a1e4cb7994c8060991df077b6fb7eebc4a9f9c58689cf0839c97ad682d546aff7ab9360c57f8c14845d8626b07252
+  data.tar.gz: 85f8c1da91dcacfedf71b19736edef620113d71d211c51aa0f303cef72d63d2110cd8a4d9adab7f2fc2ee99f2fbec55837141c49f904587fbbd07d90e101325c

data/CHANGELOG.md

@@ -5,6 +5,31 @@ 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
+- `Standard::CloudNativePg::Cluster` is now the bare named `Cluster` CR subclass
+  (resolved to `postgresql.cnpg.io/v1/Cluster`); the whole spec is supplied via
+  the block.
+
+### Removed
+- `Standard::CloudNativePg::PostgresCluster` (shipped in 1.3.0) — it baked in a
+  specific deployment's config, which belongs at the call site, not the library.
+
 ## [1.3.0] - 2026-07-13
 
 ### Added

data/Gemfile.lock

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

data/lib/kube/cluster/standard/cloud_native_pg/cluster.rb

@@ -7,16 +7,9 @@ module Kube
   module Cluster
     module Standard
       module CloudNativePg
-        # A CloudNativePG Cluster CR. Thin wrapper: sets metadata, leaves the
-        # (large, deployment-specific) spec to the block.
+        # A CloudNativePG Cluster CR, resolved to postgresql.cnpg.io/v1/Cluster.
+        # The (large, deployment-specific) spec is supplied via the block.
         class Cluster < Kube::Cluster["Cluster"]
-          def initialize(name: "postgres", namespace: nil, &block)
-            super() {
-              metadata.name = name
-              metadata.namespace = namespace if namespace
-              instance_exec(&block) if block
-            }
-          end
         end
       end
     end
@@ -28,7 +21,8 @@ __END__
 describe "CloudNativePg::Cluster" do
   it "initializes without error" do
     Kube::Cluster::Standard::CloudNativePg::Cluster
-      .new(name: "postgres", namespace: "cloudnative-pg") {
+      .new {
+        metadata.name = "postgres"
         spec.instances = 1
         spec.storage = { size: "1Gi" }
       }

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.0"
+    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.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Nathan K
@@ -219,7 +219,6 @@ files:
 - lib/kube/cluster/standard/cloud_native_pg/database_with_external_secret.rb
 - lib/kube/cluster/standard/cloud_native_pg/external_secret.rb
 - lib/kube/cluster/standard/cloud_native_pg/helm.rb
-- lib/kube/cluster/standard/cloud_native_pg/postgres_cluster.rb
 - lib/kube/cluster/standard/config_map.rb
 - lib/kube/cluster/standard/cron_job.rb
 - lib/kube/cluster/standard/cron_job_with_service_account.rb
@@ -247,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

data/lib/kube/cluster/standard/cloud_native_pg/postgres_cluster.rb

@@ -1,128 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "kube/cluster"
-require "kube/cluster/standard/cloud_native_pg/cluster"
-
-module Kube
-  module Cluster
-    module Standard
-      module CloudNativePg
-        # The standard single-node PostgreSQL cluster: custom image, HA
-        # replication slots, logical WAL, and barman-cloud WAL archiving.
-        # Deployment-specific additions (managed roles, extra spec) come via the
-        # block; databases are separate Database CRs.
-        class PostgresCluster < Cluster
-          def initialize(name: "postgres", namespace: nil, &block)
-            super(name: name, namespace: namespace) {
-              spec.affinity = { podAntiAffinityType: "preferred" }
-              spec.bootstrap = {
-                initdb: {
-                  database: "app",
-                  encoding: "UTF8",
-                  localeCType: "C",
-                  localeCollate: "C",
-                  owner: "app",
-                },
-              }
-              spec.enablePDB = true
-              spec.enableSuperuserAccess = false
-              spec.failoverDelay = 0
-              spec.imageName = "ghcr.io/general-intelligence-systems/postgresql:17-custom"
-              spec.imagePullPolicy = "Always"
-              spec.instances = 1
-              spec.plugins = [{
-                name: "barman-cloud.cloudnative-pg.io",
-                isWALArchiver: true,
-                parameters: { barmanObjectName: "cnpg-backups" },
-              }]
-              spec.logLevel = "info"
-              spec.maxSyncReplicas = 0
-              spec.minSyncReplicas = 0
-              spec.monitoring = {
-                disableDefaultQueries: false,
-                enablePodMonitor: false,
-              }
-              spec.postgresGID = 26
-              spec.postgresUID = 26
-              spec.postgresql = {
-                parameters: {
-                  archive_mode: "on",
-                  archive_timeout: "5min",
-                  dynamic_shared_memory_type: "posix",
-                  full_page_writes: "on",
-                  log_destination: "csvlog",
-                  log_directory: "/controller/log",
-                  log_filename: "postgres",
-                  log_rotation_age: "0",
-                  log_rotation_size: "0",
-                  log_truncate_on_rotation: "false",
-                  logging_collector: "on",
-                  max_parallel_workers: "32",
-                  max_replication_slots: "32",
-                  max_worker_processes: "32",
-                  shared_memory_type: "mmap",
-                  shared_preload_libraries: "",
-                  ssl_max_protocol_version: "TLSv1.3",
-                  ssl_min_protocol_version: "TLSv1.3",
-                  wal_keep_size: "512MB",
-                  wal_level: "logical",
-                  wal_log_hints: "on",
-                  wal_receiver_timeout: "5s",
-                  wal_sender_timeout: "5s",
-                },
-                syncReplicaElectionConstraint: {
-                  enabled: false,
-                },
-              }
-              spec.primaryUpdateMethod = "restart"
-              spec.primaryUpdateStrategy = "unsupervised"
-              spec.probes = {
-                liveness: {
-                  isolationCheck: {
-                    connectionTimeout: 1000,
-                    enabled: true,
-                    requestTimeout: 1000,
-                  },
-                },
-              }
-              spec.replicationSlots = {
-                highAvailability: {
-                  enabled: true,
-                  slotPrefix: "_cnpg_",
-                },
-                synchronizeReplicas: {
-                  enabled: true,
-                },
-                updateInterval: 30,
-              }
-              spec.resources = {}
-              spec.smartShutdownTimeout = 180
-              spec.startDelay = 3600
-              spec.stopDelay = 1800
-              spec.storage = {
-                resizeInUseVolumes: true,
-                size: "5Gi",
-              }
-              spec.switchoverDelay = 3600
-
-              instance_exec(&block) if block
-            }
-          end
-        end
-      end
-    end
-  end
-end
-
-__END__
-
-describe "CloudNativePg::PostgresCluster" do
-  it "initializes without error" do
-    Kube::Cluster::Standard::CloudNativePg::PostgresCluster
-      .new(namespace: "cloudnative-pg")
-      .to_yaml
-      .is_a?(String)
-      .should == true
-  end
-end