feat: Enable restart controller (#97)

* feat: Enable restart controller

* changelog

* fix tests

Author: sbernauer

CHANGELOG.md

@@ -11,6 +11,7 @@ All notable changes to this project will be documented in this file.
 - Allow adding entries to the OpenSearch keystore ([#76]).
 - Support objectOverrides using `.spec.objectOverrides`.
   See [objectOverrides concepts page](https://docs.stackable.tech/home/nightly/concepts/overrides/#object-overrides) for details ([#93]).
+- Enable the [restart-controller](https://docs.stackable.tech/home/nightly/commons-operator/restarter/), so that the Pods are automatically restarted on config changes ([#97]).
 
 ### Changed
 
@@ -21,6 +22,7 @@ All notable changes to this project will be documented in this file.
 [#76]: https://github.com/stackabletech/opensearch-operator/pull/76
 [#91]: https://github.com/stackabletech/opensearch-operator/pull/91
 [#93]: https://github.com/stackabletech/opensearch-operator/pull/93
+[#97]: https://github.com/stackabletech/opensearch-operator/pull/97
 
 ## [25.11.0] - 2025-11-07
 

Cargo.lock

@@ -10,7 +10,7 @@ edition = "2024"
 repository = "https://github.com/stackabletech/opensearch-operator"
 
 [workspace.dependencies]
-stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "stackable-operator-0.101.2", features = ["telemetry", "versioned"] }
+stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "stackable-operator-0.102.0", features = ["telemetry", "versioned"] }
 
 built = { version = "0.8.0", features = ["chrono", "git2"] }
 clap = "4.5"

Cargo.nix

@@ -76,8 +76,6 @@ impl<'a> Applier<'a> {
         mut self,
         resources: KubernetesResources<Prepared>,
     ) -> Result<KubernetesResources<Applied>> {
-        let stateful_sets = self.add_resources(resources.stateful_sets).await?;
-
         let services = self.add_resources(resources.services).await?;
 
         let listeners = self.add_resources(resources.listeners).await?;
@@ -90,6 +88,11 @@ impl<'a> Applier<'a> {
 
         let pod_disruption_budgets = self.add_resources(resources.pod_disruption_budgets).await?;
 
+        // Note: The StatefulSet needs to be applied after all ConfigMaps and Secrets it mounts
+        // to prevent unnecessary Pod restarts.
+        // See https://github.com/stackabletech/commons-operator/issues/111 for details.
+        let stateful_sets = self.add_resources(resources.stateful_sets).await?;
+
         self.cluster_resources
             .delete_orphaned_resources(self.client)
             .await

Cargo.toml

@@ -7,6 +7,7 @@ use stackable_operator::{
         meta::ObjectMetaBuilder,
         pod::volume::{SecretFormat, SecretOperatorVolumeSourceBuilder, VolumeBuilder},
     },
+    constants::RESTART_CONTROLLER_ENABLED_LABEL,
     crd::listener::{self},
     k8s_openapi::{
         DeepMerge,
@@ -178,6 +179,7 @@ impl<'a> RoleGroupBuilder<'a> {
     pub fn build_stateful_set(&self) -> StatefulSet {
         let metadata = self
             .common_metadata(self.resource_names.stateful_set_name())
+            .with_label(RESTART_CONTROLLER_ENABLED_LABEL.to_owned())
             .build();
 
         let template = self.build_pod_template();
@@ -1028,7 +1030,8 @@ mod tests {
                         "app.kubernetes.io/name": "opensearch",
                         "app.kubernetes.io/role-group": "default",
                         "app.kubernetes.io/version": "3.1.0",
-                        "stackable.tech/vendor": "Stackable"
+                        "stackable.tech/vendor": "Stackable",
+                        "restarter.stackable.tech/enabled": "true"
                     },
                     "name": "my-opensearch-cluster-nodes-default",
                     "namespace": "default",
@@ -1633,6 +1636,7 @@ mod tests {
                 "spec": {
                     "className": "cluster-internal",
                     "extraPodSelectorLabels": {},
+                    "objectOverrides": [],
                     "ports": [
                         {
                             "name": "http",

crate-hashes.json

@@ -9,6 +9,7 @@ timeout: 600
 apiVersion: apps/v1
 kind: StatefulSet
 metadata:
+  name: opensearch-nodes-cluster-manager
   labels:
     app.kubernetes.io/component: nodes
     app.kubernetes.io/instance: opensearch
@@ -17,7 +18,8 @@ metadata:
     app.kubernetes.io/role-group: cluster-manager
     app.kubernetes.io/version: {{ test_scenario['values']['opensearch'].split(',')[0] }}
     stackable.tech/vendor: Stackable
-  name: opensearch-nodes-cluster-manager
+    restarter.stackable.tech/enabled: "true"
+  generation: 1 # There should be no unneeded Pod restarts
   ownerReferences:
   - apiVersion: opensearch.stackable.tech/v1alpha1
     controller: true
@@ -341,6 +343,7 @@ status:
 apiVersion: apps/v1
 kind: StatefulSet
 metadata:
+  name: opensearch-nodes-data
   labels:
     app.kubernetes.io/component: nodes
     app.kubernetes.io/instance: opensearch
@@ -349,7 +352,8 @@ metadata:
     app.kubernetes.io/role-group: data
     app.kubernetes.io/version: {{ test_scenario['values']['opensearch'].split(',')[0] }}
     stackable.tech/vendor: Stackable
-  name: opensearch-nodes-data
+    restarter.stackable.tech/enabled: "true"
+  generation: 1 # There should be no unneeded Pod restarts
   ownerReferences:
   - apiVersion: opensearch.stackable.tech/v1alpha1
     controller: true