Document Changes to support 2.4.0 release (#1239)

* removed operator and splunk version Signed-off-by: vivekr-splunk <[email protected]> * testing develop branch with 9.0.6 branch Signed-off-by: vivekr-splunk <[email protected]> * adding support matrix to release notes Signed-off-by: vivekr-splunk <[email protected]> * adding support matrix to release notes fixed Signed-off-by: vivekr-splunk <[email protected]> * adding support matrix to release notes fixed Signed-off-by: vivekr-splunk <[email protected]> * added link to release notes Signed-off-by: vivekr-splunk <[email protected]> * fixed readme Signed-off-by: vivekr-splunk <[email protected]> * indent table Signed-off-by: vivekr-splunk <[email protected]> --------- Signed-off-by: vivekr-splunk <[email protected]> Co-authored-by: gaurav-splunk <[email protected]>
splunk · Oct 6, 2023 · b13db63 · b13db63
1 parent e7606aa
commit b13db63
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 15 deletions.
diff --git a/docs/ChangeLog.md b/docs/ChangeLog.md
@@ -1,5 +1,22 @@
 # Splunk Operator for Kubernetes Change Log
 
+## 2.4.0 (2023-10-13)
+
+* This is the 2.4.0 release. The Splunk Operator for Kubernetes is a supported platform for deploying Splunk Enterprise with the prerequisites and constraints laid out [here](https://github.com/splunk/splunk-operator/blob/main/docs/README.md#prerequisites-for-the-splunk-operator)
+
+### Supported Splunk Version
+>| Splunk Version|
+>| --- |
+>| 9.0.6 |
+>| 9.1.1 |
+
+### Supported Kubernetes Version
+>| Kubernetes Version|
+>| --- |
+>| 1.25+ |
+
+
+
 ## 2.3.0 (2023-06-28)
 
 * This is the 2.3.0 release. The Splunk Operator for Kubernetes is a supported platform for deploying Splunk Enterprise with the prerequisites and constraints laid out [here](https://github.com/splunk/splunk-operator/blob/main/docs/README.md#prerequisites-for-the-splunk-operator)

diff --git a/docs/Images.md b/docs/Images.md
@@ -2,15 +2,15 @@
 
 The Splunk Operator requires these docker images to be present or available to your Kubernetes cluster:
 
-* `splunk/splunk-operator`: The Splunk Operator image built by this repository or the [official release](https://hub.docker.com/r/splunk/splunk-operator) (2.3.0 or later)
-* `splunk/splunk:<version>`: The [Splunk Enterprise image](https://github.com/splunk/docker-splunk) (9.0.5 or later)
+* `splunk/splunk-operator`: The Splunk Operator image built by this repository or the [official release](https://hub.docker.com/r/splunk/splunk-operator)
+* `splunk/splunk:<version>`: The [Splunk Enterprise image](https://github.com/splunk/docker-splunk)
 
 All of these images are publicly available, and published on [Docker Hub](https://hub.docker.com/).
 
-If your cluster does not have access to pull directly from Docker Hub, you will need to manually download and push these images to an accessible registry. You will also need to specify the location of these images by using an environment variable passed to the Operator, or by adding additional `spec` parameters to your 
+If your cluster does not have access to pull directly from Docker Hub, you will need to manually download and push these images to an accessible registry. You will also need to specify the location of these images by using an environment variable passed to the Operator, or by adding additional `spec` parameters to your
 custom resource definition.
 
-Use the `RELATED_IMAGE_SPLUNK_ENTERPRISE` environment variable or the `image` custom resource parameter to change the location of your Splunk Enterprise image. 
+Use the `RELATED_IMAGE_SPLUNK_ENTERPRISE` environment variable or the `image` custom resource parameter to change the location of your Splunk Enterprise image.
 
 For additional detail, see the [Advanced Installation Instructions](Install.md) page, and the [Custom Resource Guide](CustomResources.md) page.
 
@@ -19,7 +19,7 @@ For additional detail, see the [Advanced Installation Instructions](Install.md)
 
 If your Kubernetes workers have access to pull from a private registry, it is easy to retag and push the required images to directly to your private registry.
 
-An example of tagging with an Amazon Elastic Container Registry: 
+An example of tagging with an Amazon Elastic Container Registry:
 
 ```
 $(aws ecr get-login --no-include-email --region us-west-2)
@@ -63,7 +63,7 @@ docker load -i splunk-operator.tar.gz
 
 ## A simple script to push images
 
-The script `build/push_images.sh`  is included to push Docker images to multiple remote hosts using SSH. The script takes the name of a container and an image path, and pushes the image to all the entries in `push_targets`. 
+The script `build/push_images.sh`  is included to push Docker images to multiple remote hosts using SSH. The script takes the name of a container and an image path, and pushes the image to all the entries in `push_targets`.
 
 To use the script:
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
 # Getting Started with the Splunk Operator for Kubernetes
 
-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 administrative workflows using Kubernetes best practices. 
+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 administrative workflows using Kubernetes best practices.
 
 The Splunk Operator runs as a container, and uses the Kubernetes [operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) and [custom resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) objects to create and manage a scalable and sustainable Splunk Enterprise environment.
 
@@ -35,9 +35,10 @@ Review the [Change Log](ChangeLog.md) page for a history of changes in each rele
 
 ## Prerequisites for the Splunk Operator
 
-### Supported Kubernetes Versions
+Please check [release notes](https://github.com/splunk/splunk-operator/releases) for support matrix
+
+## Platform recommendations
 
-- Kubernetes, version 1.20+ and later (x86 64-bit only).
 
 The Splunk Operator should work with any [CNCF certified distribution](https://www.cncf.io/certification/software-conformance/) of Kubernetes. We do not have platform recommendations, but this is a table of platforms that our developers, customers, and partners have used successfully with the Splunk Operator.
 
@@ -58,8 +59,8 @@ Apps and add-ons can be installed using the Splunk Operator by following the ins
 ### Docker requirements
 The Splunk Operator requires these docker images to be present or available to your Kubernetes cluster:
 
-* `splunk/splunk-operator`: The Splunk Operator image built by this repository or the [official release](https://hub.docker.com/r/splunk/splunk-operator) (2.3.0 or later)
-* `splunk/splunk:<version>`: The [Splunk Enterprise image](https://github.com/splunk/docker-splunk) (9.0.5 or later)
+* `splunk/splunk-operator`: The Splunk Operator image built by this repository or the [official release](https://hub.docker.com/r/splunk/splunk-operator)
+* `splunk/splunk:<version>`: The [Splunk Enterprise image](https://github.com/splunk/docker-splunk)
 
 
 All of the Splunk Enterprise images are publicly available on [Docker Hub](https://hub.docker.com/). If your cluster does not have access to pull from Docker Hub, see the [Required Images Documentation](Images.md) page.
@@ -92,7 +93,7 @@ Examples on how to implement these QoS are given at [Examples of Guaranteed and
 
 
 ### Storage guidelines
-The Splunk Operator uses Kubernetes [Persistent Volume Claims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) to store all of your Splunk Enterprise configuration ("$SPLUNK_HOME/etc" path) and event ("$SPLUNK_HOME/var" path) data. If one of the underlying machines fail, Kubernetes will automatically try to recover by restarting the Splunk Enterprise pods on another machine that is able to reuse the same data volumes. This minimizes the maintenance burden on your operations team by reducing the impact of common hardware failures to the equivalent of a service restart. 
+The Splunk Operator uses Kubernetes [Persistent Volume Claims](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims) to store all of your Splunk Enterprise configuration ("$SPLUNK_HOME/etc" path) and event ("$SPLUNK_HOME/var" path) data. If one of the underlying machines fail, Kubernetes will automatically try to recover by restarting the Splunk Enterprise pods on another machine that is able to reuse the same data volumes. This minimizes the maintenance burden on your operations team by reducing the impact of common hardware failures to the equivalent of a service restart.
 The use of Persistent Volume Claims requires that your cluster is configured to support one or more Kubernetes persistent [Storage Classes](https://kubernetes.io/docs/concepts/storage/storage-classes/). See the [Setting Up a Persistent Storage for Splunk](StorageClass.md) page for more
 information.
 
@@ -103,7 +104,7 @@ The Kubernetes infrastructure must have access to storage that meets or exceeds
 
 ### Splunk SmartStore Required
 For production environments, we are requiring the use of Splunk SmartStore. As a Splunk Enterprise deployment's data volume increases, demand for storage typically outpaces demand for compute resources. [Splunk's SmartStore Feature](https://docs.splunk.com/Documentation/Splunk/latest/Indexer/AboutSmartStore) allows you to manage your indexer storage and compute resources in a ___cost-effective___ manner by scaling those resources separately. SmartStore utilizes a fast storage cache on each indexer node to keep recent data locally available for search and keep other data in a remote object store. Look into the [SmartStore Resource Guide](SmartStore.md) document for configuring and using SmartStore through operator.
- 
+
 ## Installing the Splunk Operator
 
 A Kubernetes cluster administrator can install and start the Splunk Operator for specific namespace by running:
@@ -181,11 +182,11 @@ kubectl port-forward splunk-s1-standalone-0 8000
 
 ```
 kubectl delete standalone s1
-``` 
+```
 
 The `Standalone` custom resource is just one of the resources the Splunk Operator provides. You can find more custom resources and the parameters they support on the [Custom Resource Guide](CustomResources.md) page.
 
-For additional deployment examples, including Splunk Enterprise clusters, see the 
+For additional deployment examples, including Splunk Enterprise clusters, see the
 [Configuring Splunk Enterprise Deployments](Examples.md) page.
 
 For additional guidance on making Splunk Enterprise ports accessible outside of Kubernetes, see the [Configuring Ingress](Ingress.md) page.