feat(actions): Add cloudnativepg reload, restart, promote, suspend and resume actions (#24192)

Signed-off-by: Rouke Broersma <mobrockers@gmail.com>
Signed-off-by: Rouke Broersma <rouke.broersma@infosupport.com>

Author: rouke-broersma

docs/operator-manual/resource_actions_builtin.md

@@ -0,0 +1,33 @@
+actionTests:
+  - action: promote
+    inputPath: testdata/cluster_healthy.yaml
+    expectedOutputPath: testdata/cluster_promoting.yaml
+    parameters:
+      instance: 'any'
+  - action: promote
+    inputPath: testdata/cluster_healthy.yaml
+    expectedOutputPath: testdata/cluster_promoting.yaml
+    parameters:
+      instance: '2'
+  - action: promote
+    inputPath: testdata/cluster_healthy.yaml
+    expectedOutputPath: testdata/cluster_promoting.yaml
+    parameters:
+      instance: 'cluster-example-2'
+  - action: promote
+    inputPath: testdata/cluster_healthy.yaml
+    expectedErrorMessage: 'Could not find a healthy instance matching the criteria: nonexistent-instance'
+    parameters:
+      instance: 'nonexistent-instance'
+  - action: reload
+    inputPath: testdata/cluster_healthy.yaml
+    expectedOutputPath: testdata/cluster_reload.yaml
+  - action: restart
+    inputPath: testdata/cluster_healthy.yaml
+    expectedOutputPath: testdata/cluster_restart.yaml
+  - action: suspend
+    inputPath: testdata/cluster_healthy.yaml
+    expectedOutputPath: testdata/cluster_reconcile_suspended.yaml
+  - action: resume
+    inputPath: testdata/cluster_reconcile_suspended.yaml
+    expectedOutputPath: testdata/cluster_healthy.yaml

resource_customizations/postgresql.cnpg.io/Cluster/actions/action_test.yaml

@@ -0,0 +1,41 @@
+local actions = {}
+actions["restart"] = {
+    ["iconClass"] = "fa fa-fw fa-recycle",
+    ["displayName"] = "Rollout restart Cluster"
+}
+actions["reload"] = {
+    ["iconClass"] = "fa fa-fw fa-rotate-right",
+    ["displayName"] = "Reload all Configuration"
+}
+actions["promote"] = {
+    ["iconClass"] = "fa fa-fw fa-angles-up",
+    ["displayName"] = "Promote Replica to Primary",
+    ["disabled"] = (not obj.status.instancesStatus or not obj.status.instancesStatus.healthy or #obj.status.instancesStatus.healthy < 2),
+    ["params"] = {
+        {
+            ["name"] = "instance",
+            ["default"] = "any"
+        }
+    }
+}
+
+-- Check if reconciliation is currently suspended
+local isSuspended = false
+if obj.metadata and obj.metadata.annotations and obj.metadata.annotations["cnpg.io/reconciliation"] == "disabled" then
+    isSuspended = true
+end
+
+-- Add suspend/resume actions based on current state
+if isSuspended then
+    actions["resume"] = {
+        ["iconClass"] = "fa fa-fw fa-play",
+        ["displayName"] = "Resume Reconciliation"
+    }
+else
+    actions["suspend"] = {
+        ["iconClass"] = "fa fa-fw fa-pause",
+        ["displayName"] = "Suspend Reconciliation"
+    }
+end
+
+return actions

resource_customizations/postgresql.cnpg.io/Cluster/actions/discovery.lua

@@ -0,0 +1,50 @@
+local os = require("os")
+local instance = actionParams["instance"]
+local healthy = obj.status.instancesStatus.healthy
+local selected = nil
+
+if instance == "any" then
+    -- Select next healthy instance after currentPrimary
+    local nextIndex = 0
+    for index, node in ipairs(healthy) do
+        if node == obj.status.currentPrimary then
+            nextIndex = index + 1
+            if nextIndex > #healthy then
+                nextIndex = 1
+            end
+            break
+        end
+    end
+    if nextIndex > 0 then
+        selected = healthy[nextIndex]
+    elseif #healthy > 0 then
+        selected = healthy[1]  -- fallback to first healthy if current primary not healthy
+    end
+elseif type(instance) == "string" and tonumber(instance) then
+    -- Select by instance number
+    local wanted = (obj.metadata and obj.metadata.name or "") .. "-" .. instance
+    for _, node in ipairs(healthy or {}) do
+        if node == wanted then
+            selected = node
+            break
+        end
+    end
+elseif type(instance) == "string" then
+    -- Select by full name
+    for _, node in ipairs(healthy) do
+        if node == instance then
+            selected = node
+            break
+        end
+    end
+end
+
+if selected then
+    obj.status.targetPrimary = selected
+    obj.status.targetPrimaryTimestamp = os.date("!%Y-%m-%dT%XZ")
+    obj.status.phase = "Switchover in progress"
+    obj.status.phaseReason = "Switching over to " .. selected
+else
+    error("Could not find a healthy instance matching the criteria: " .. instance, 0)
+end
+return obj

resource_customizations/postgresql.cnpg.io/Cluster/actions/promote/action.lua

@@ -0,0 +1,10 @@
+local os = require("os")
+if obj.metadata == nil then
+    obj.metadata = {}
+end
+if obj.metadata.annotations == nil then
+    obj.metadata.annotations = {}
+end
+
+obj.metadata.annotations["cnpg.io/reloadedAt"] = os.date("!%Y-%m-%dT%XZ")
+return obj

resource_customizations/postgresql.cnpg.io/Cluster/actions/reload/action.lua

@@ -0,0 +1,10 @@
+local os = require("os")
+if obj.metadata == nil then
+    obj.metadata = {}
+end
+if obj.metadata.annotations == nil then
+    obj.metadata.annotations = {}
+end
+
+obj.metadata.annotations["kubectl.kubernetes.io/restartedAt"] = os.date("!%Y-%m-%dT%XZ")
+return obj

resource_customizations/postgresql.cnpg.io/Cluster/actions/restart/action.lua

@@ -0,0 +1,10 @@
+if obj.metadata == nil then
+    obj.metadata = {}
+end
+
+if obj.metadata.annotations == nil then
+    obj.metadata.annotations = {}
+end
+
+obj.metadata.annotations["cnpg.io/reconciliation"] = nil
+return obj

resource_customizations/postgresql.cnpg.io/Cluster/actions/resume/action.lua

@@ -0,0 +1,10 @@
+if obj.metadata == nil then
+    obj.metadata = {}
+end
+
+if obj.metadata.annotations == nil then
+    obj.metadata.annotations = {}
+end
+
+obj.metadata.annotations["cnpg.io/reconciliation"] = "disabled"
+return obj

resource_customizations/postgresql.cnpg.io/Cluster/actions/suspend/action.lua

@@ -0,0 +1,23 @@
+apiVersion: postgresql.cnpg.io/v1
+kind: Cluster
+metadata:
+  creationTimestamp: "2025-04-25T20:44:24Z"
+  generation: 1
+  name: cluster-example
+  namespace: default
+  resourceVersion: "20230"
+  uid: 987fe1ba-bba7-4021-9d25-f06ca9a8c0d2
+spec:
+  imageName: ghcr.io/cloudnative-pg/postgresql:13
+  instances: 3
+status:
+  currentPrimary: cluster-example-1
+  currentPrimaryTimestamp: "2025-04-25T20:44:38.190232Z"
+  instancesStatus:
+    healthy:
+    - cluster-example-1
+    - cluster-example-2
+    - cluster-example-3
+  phase: Cluster in healthy state
+  targetPrimary: cluster-example-1
+  targetPrimaryTimestamp: "2025-04-25T20:44:26.214164Z"

resource_customizations/postgresql.cnpg.io/Cluster/actions/testdata/cluster_healthy.yaml

@@ -0,0 +1,24 @@
+apiVersion: postgresql.cnpg.io/v1
+kind: Cluster
+metadata:
+  creationTimestamp: "2025-04-25T20:44:24Z"
+  generation: 1
+  name: cluster-example
+  namespace: default
+  resourceVersion: "20230"
+  uid: 987fe1ba-bba7-4021-9d25-f06ca9a8c0d2
+spec:
+  imageName: ghcr.io/cloudnative-pg/postgresql:13
+  instances: 3
+status:
+  currentPrimary: cluster-example-1
+  currentPrimaryTimestamp: "2025-04-25T20:44:38.190232Z"
+  instancesStatus:
+    healthy:
+    - cluster-example-1
+    - cluster-example-2
+    - cluster-example-3
+  phase: Switchover in progress
+  phaseReason: Switching over to cluster-example-2
+  targetPrimary: cluster-example-2
+  targetPrimaryTimestamp: "0001-01-01T00:00:00Z"