Merge branch 'main' into main-to-dev-2.5.1

Signed-off-by: vivekr-splunk <[email protected]>

bundle/manifests/splunk-operator.clusterserviceversion.yaml

@@ -111,7 +111,7 @@ metadata:
     capabilities: Seamless Upgrades
     categories: Big Data, Logging & Tracing, Monitoring, Security, AI/Machine Learning
     containerImage: splunk/splunk-operator@sha256:c4e0d314622699496f675760aad314520d050a66627fdf33e1e21fa28ca85d50
-    createdAt: "2024-02-15T00:49:53Z"
+    createdAt: "2024-02-20T18:45:06Z"
     description: The Splunk Operator for Kubernetes enables you to quickly and easily
       deploy Splunk Enterprise on your choice of private or public cloud provider.
       The Operator simplifies scaling and management of Splunk Enterprise by automating
@@ -120,7 +120,7 @@ metadata:
     operators.operatorframework.io/builder: operator-sdk-v1.31.0
     operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
     repository: https://github.com/splunk/splunk-operator
-  name: splunk-operator.v2.2.1
+  name: splunk-operator.v2.5.1
   namespace: placeholder
 spec:
   apiservicedefinitions: {}
@@ -929,5 +929,5 @@ spec:
   relatedImages:
   - image: docker.io/splunk/splunk:9.1.3
     name: splunk-enterprise
-  replaces: splunk-operator.v2.2.0
-  version: 2.2.1
+  replaces: splunk-operator.v2.5.0
+  version: 2.5.1

config/manifests/bases/splunk-operator.clusterserviceversion.yaml

@@ -12,7 +12,7 @@ metadata:
       administrative workflows using Kubernetes best practices.
     olm.properties: '[{"type": "olm.maxOpenShiftVersion", "value": "4.9"}]'
     repository: https://github.com/splunk/splunk-operator
-  name: splunk-operator.v2.2.1
+  name: splunk-operator.v2.5.1
   namespace: placeholder
 spec:
   apiservicedefinitions: {}
@@ -274,5 +274,5 @@ spec:
   provider:
     name: Splunk Inc.
     url: www.splunk.com
-  replaces: splunk-operator.v2.2.0
-  version: 2.2.1
+  replaces: splunk-operator.v2.5.0
+  version: 2.5.1

docs/ChangeLog.md

@@ -1,6 +1,6 @@
 # Splunk Operator for Kubernetes Change Log
 
-## 2.5.1 (2024-02-16)
+## 2.5.1 (2024-02-20)
 
 CSPL-2532: fix for leader election lost issue (#1281)
 

docs/SplunkOperatorUpgrade.md

@@ -1,5 +1,7 @@
 # How to upgrade Splunk Operator and Splunk Enterprise Deployments
 
+To upgrade the Splunk Operator for Kubernetes, you will overwrite the prior Operator release with the latest version. Once the lastest version of `splunk-operator-namespace.yaml` ([see below](#upgrading-splunk-operator-and-splunk-operator-deployment)) is applied the CRD's are updated and Operator deployment is updated with newer version of Splunk Operator image. Any new spec defined by the operator will be applied to the pods managed by Splunk Operator for Kubernetes.
+To upgrade the Splunk Operator for Kubernetes, you will overwrite the prior Operator release with the latest version. Once the lastest version of `splunk-operator-namespace.yaml` ([see below](#upgrading-splunk-operator-and-splunk-operator-deployment)) is applied the CRD's are updated and Operator deployment is updated with newer version of Splunk Operator image. Any new spec defined by the operator will be applied to the pods managed by Splunk Operator for Kubernetes.
 To upgrade the Splunk Operator for Kubernetes, you will overwrite the prior Operator release with the latest version. Once the lastest version of `splunk-operator-namespace.yaml` ([see below](#upgrading-splunk-operator-and-splunk-operator-deployment)) is applied the CRD's are updated and Operator deployment is updated with newer version of Splunk Operator image. Any new spec defined by the operator will be applied to the pods managed by Splunk Operator for Kubernetes.
 ​
 A Splunk Operator for Kubernetes upgrade might include support for a later version of the Splunk Enterprise Docker image. In that scenario, after the Splunk Operator completes its upgrade, the pods managed by Splunk Operator for Kubernetes will be restarted using the latest Splunk Enterprise Docker image.
@@ -11,6 +13,8 @@ A Splunk Operator for Kubernetes upgrade might include support for a later versi
 * Before you upgrade, review the Splunk Operator [change log](https://github.com/splunk/splunk-operator/releases) page for information on changes made in the latest release. The Splunk Enterprise Docker image compatibility is noted in each release version.
 ​
 * If the Splunk Enterprise Docker image changes, review the Splunk Enterprise [Upgrade Readme](https://docs.splunk.com/Documentation/Splunk/latest/Installation/AboutupgradingREADTHISFIRST) page before upgrading.
+* If the Splunk Enterprise Docker image changes, review the Splunk Enterprise [Upgrade Readme](https://docs.splunk.com/Documentation/Splunk/latest/Installation/AboutupgradingREADTHISFIRST) page before upgrading.
+* If the Splunk Enterprise Docker image changes, review the Splunk Enterprise [Upgrade Readme](https://docs.splunk.com/Documentation/Splunk/latest/Installation/AboutupgradingREADTHISFIRST) page before upgrading.
 ​
 * For general information about Splunk Enterprise compatibility and the upgrade process, see [How to upgrade Splunk Enterprise](https://docs.splunk.com/Documentation/Splunk/latest/Installation/HowtoupgradeSplunk).
 ​
@@ -48,8 +52,9 @@ If a Splunk Operator release changes the custom resource (CRD) API version, the
 
 ### Upgrading Splunk Enterprise Docker Image with the Operator Upgrade
 
-Splunk Operator follows the upgrade path steps mentioned in [Splunk documentation](https://docs.splunk.com/Documentation/Splunk/9.1.2/Installation/HowtoupgradeSplunk). If a Splunk Operator release includes an updated Splunk Enterprise Docker image, the operator upgrade will also initiate pod restart using the latest Splunk Enterprise Docker image. To follow the best practices described under the [General Process to Upgrade the Splunk Enterprise], a recommeded upgrade path is followed while initiating pod restarts of different Splunk Instances. At each step, if a particular CR instance exists, a certain flow is imposed to ensure that each instance is updated in the correct order. After an instance is upgraded, the Operator verifies if the upgrade was successful and all the components are working as expected. If any unexpected behaviour is detected, the process is terminated.
+Splunk Operator follows the upgrade path steps mentioned in [Splunk documentation](https://docs.splunk.com/Documentation/Splunk/9.1.3/Installation/HowtoupgradeSplunk). If a Splunk Operator release includes an updated Splunk Enterprise Docker image, the operator upgrade will also initiate pod restart using the latest Splunk Enterprise Docker image. To follow the best practices described under the [General Process to Upgrade the Splunk Enterprise], a recommeded upgrade path is followed while initiating pod restarts of different Splunk Instances. At each step, if a particular CR instance exists, a certain flow is imposed to ensure that each instance is updated in the correct order. After an instance is upgraded, the Operator verifies if the upgrade was successful and all the components are working as expected. If any unexpected behaviour is detected, the process is terminated.
 
+If a Splunk Operator release changes the custom resource (CRD) API version, the administrator is responsible for updating their Custom Resource specification to reference the latest CRD API version.
 
 ## Steps to Upgrade from 1.0.5 or older version to latest
 
@@ -145,11 +150,14 @@ imagePullPolicy: IfNotPresent
 
 This is an example of the process followed by the Splunk Operator if the operator version is upgraded and a later Splunk Enterprise Docker image is available:
 ​
-1. A new Splunk Operator pod will be created, and the existing operator pod will be terminated.
-3. Any existing License Manager, Standalone, Monitoring console, Cluster manager, Search Head, ClusterManager, Indexer pods will be terminated to be redeployed with the upgraded spec.
-4. Splunk Operator follows the upgrade path steps mentioned in Splunk documentation. The termination and redeployment of the pods happen in a particular order based on a recommended upgrade path.
-5. After a ClusterManager pod is restarted, the Indexer Cluster pods which are connected to it are terminated and redeployed.
-6. After all pods in the Indexer cluster and Search head cluster are redeployed, the Monitoring Console pod is terminated and redeployed.
-7. Each pod upgrade is verified to ensure the process was successful and everything is working as expected.
+
+1. Initiation of a new Splunk Operator pod will lead to the termination of the existing operator pod.
+2. All existing License Manager, Standalone, Monitoring Console, Cluster Manager, Search Head, ClusterManager, and Indexer pods will undergo termination for subsequent redeployment with upgraded specifications.
+3. The Splunk Operator adheres to the upgrade path steps delineated in the Splunk documentation. Pod termination and redeployment occur in a specific order based on the recommended upgrade path.
+4. Standalone or License manager will be the first to be redeployed
+5. Next ClusterManager pod will be redeployed, next the Monitoring Console pod undergoes termination and redeployment.
+6. Subsequently, the Search Head cluster pods connected to it are terminated and redeployed.
+7. Afterwards, all pods in the Indexer cluster are redeployed sequentially. In cases where multi-zone Indexer clusters are utilized, they undergo redeployment zone by zone.
+8. Each pod upgrade is meticulously verified to ensure a successful process, with thorough checks conducted to confirm that everything is functioning as expected.
 
 * Note: If there are multiple pods per Custom Resource, the pods are terminated and re-deployed in a descending order with the highest numbered pod going first

docs/index.yaml

@@ -3,14 +3,14 @@ entries:
   splunk-enterprise:
   - apiVersion: v2
     appVersion: 2.5.1
-    created: "2024-02-15T00:49:58.004382924Z"
+    created: "2024-02-20T23:37:00.411185-08:00"
     dependencies:
     - condition: splunk-operator.enabled
       name: splunk-operator
       repository: file://splunk-operator/helm-chart/splunk-operator
       version: 2.5.1
     description: A Helm chart for Splunk Enterprise managed by the Splunk Operator
-    digest: 1918814e15b5f53cba29de0f741c9508033531c2886461a4dcef276bded83c8d
+    digest: 481adaeaf4891252de9a76c80bd2c1e4d409b550e1f5c923c91ab1329878042f
     maintainers:
     - email: [email protected]
       name: Vivek Reddy
@@ -23,7 +23,7 @@ entries:
     version: 2.5.1
   - apiVersion: v2
     appVersion: 2.5.0
-    created: "2024-02-15T00:49:57.961076538Z"
+    created: "2024-02-20T23:37:00.350497-08:00"
     dependencies:
     - condition: splunk-operator.enabled
       name: splunk-operator
@@ -43,7 +43,7 @@ entries:
     version: 2.5.0
   - apiVersion: v2
     appVersion: 2.4.0
-    created: "2024-02-15T00:49:57.9205067Z"
+    created: "2024-02-20T23:37:00.298337-08:00"
     dependencies:
     - condition: splunk-operator.enabled
       name: splunk-operator
@@ -65,7 +65,7 @@ entries:
     version: 2.4.0
   - apiVersion: v2
     appVersion: 2.3.0
-    created: "2024-02-15T00:49:57.89845803Z"
+    created: "2024-02-20T23:37:00.260683-08:00"
     dependencies:
     - condition: splunk-operator.enabled
       name: splunk-operator
@@ -87,7 +87,7 @@ entries:
     version: 2.3.0
   - apiVersion: v2
     appVersion: 2.2.1
-    created: "2024-02-15T00:49:57.887093898Z"
+    created: "2024-02-20T23:37:00.245715-08:00"
     dependencies:
     - condition: splunk-operator.enabled
       name: splunk-operator
@@ -102,7 +102,7 @@ entries:
     version: 2.2.1
   - apiVersion: v2
     appVersion: 2.2.0
-    created: "2024-02-15T00:49:57.869604046Z"
+    created: "2024-02-20T23:37:00.230197-08:00"
     dependencies:
     - condition: splunk-operator.enabled
       name: splunk-operator
@@ -117,7 +117,7 @@ entries:
     version: 2.2.0
   - apiVersion: v2
     appVersion: 2.1.0
-    created: "2024-02-15T00:49:57.84930347Z"
+    created: "2024-02-20T23:37:00.202125-08:00"
     dependencies:
     - condition: splunk-operator.enabled
       name: splunk-operator
@@ -133,9 +133,9 @@ entries:
   splunk-operator:
   - apiVersion: v2
     appVersion: 2.5.1
-    created: "2024-02-15T00:49:58.081321028Z"
+    created: "2024-02-20T23:37:00.520295-08:00"
     description: A Helm chart for the Splunk Operator for Kubernetes
-    digest: ad9075ff85f7f8ab2a2e0e9ddf6db8af71637b88fbe1d84e9df16d1533ce2999
+    digest: 02e6a28c2daaaed160277b10c64174d2235e571ca1fc5f93e8cf3c80493c60f9
     maintainers:
     - email: [email protected]
       name: Vivek Reddy
@@ -148,7 +148,7 @@ entries:
     version: 2.5.1
   - apiVersion: v2
     appVersion: 2.5.0
-    created: "2024-02-15T00:49:58.069975222Z"
+    created: "2024-02-20T23:37:00.505356-08:00"
     description: A Helm chart for the Splunk Operator for Kubernetes
     digest: ed93f8fac421f92cfdbfd043ec27911a07ec7db2c05b4efc3137cef4f2bfca4a
     maintainers:
@@ -163,7 +163,7 @@ entries:
     version: 2.5.0
   - apiVersion: v2
     appVersion: 2.4.0
-    created: "2024-02-15T00:49:58.057745192Z"
+    created: "2024-02-20T23:37:00.491724-08:00"
     description: A Helm chart for the Splunk Operator for Kubernetes
     digest: 9d0377747e46df4bf4b9dbd447c9ff46c926bfe2c66fd07d6d27a61abb31cb42
     maintainers:
@@ -180,7 +180,7 @@ entries:
     version: 2.4.0
   - apiVersion: v2
     appVersion: 2.3.0
-    created: "2024-02-15T00:49:58.046113855Z"
+    created: "2024-02-20T23:37:00.476627-08:00"
     description: A Helm chart for the Splunk Operator for Kubernetes
     digest: 23e70ec4059bc92920d7d3adce3bff6b8aba0d5eb5d4c0efe225bf3b88d5b274
     maintainers:
@@ -197,7 +197,7 @@ entries:
     version: 2.3.0
   - apiVersion: v2
     appVersion: 2.2.1
-    created: "2024-02-15T00:49:58.033519131Z"
+    created: "2024-02-20T23:37:00.46003-08:00"
     description: A Helm chart for the Splunk Operator for Kubernetes
     digest: 8868b9ae2ebde0c667b13c97d71d904a31b5a9f2c803b199bc77324f1727e1fd
     name: splunk-operator
@@ -207,7 +207,7 @@ entries:
     version: 2.2.1
   - apiVersion: v2
     appVersion: 2.2.0
-    created: "2024-02-15T00:49:58.023571528Z"
+    created: "2024-02-20T23:37:00.443857-08:00"
     description: A Helm chart for the Splunk Operator for Kubernetes
     digest: 49c72276bd7ff93465b0545d8b0814f684cade7d2cd191b6d73d4c3660bd1fb4
     name: splunk-operator
@@ -217,12 +217,12 @@ entries:
     version: 2.2.0
   - apiVersion: v2
     appVersion: 2.1.0
-    created: "2024-02-15T00:49:58.013173539Z"
+    created: "2024-02-20T23:37:00.426958-08:00"
     description: A Helm chart for the Splunk Operator for Kubernetes
     digest: 34e5463f8f5442655d05cb616b50391b738a0827b30d8440b4c7fce99a291d9a
     name: splunk-operator
     type: application
     urls:
     - https://splunk.github.io/splunk-operator/splunk-operator-1.0.0.tgz
     version: 1.0.0
-generated: "2024-02-15T00:49:57.837629522Z"
+generated: "2024-02-20T23:37:00.187591-08:00"