CSPL-1728: documentation changes for 2.0.0 release

vivekr-splunk · vivekr-splunk · commit 7bb6cb33f064 · 2022-05-27T08:59:16.000-07:00
Signed-off-by: vivekr-splunk &lt;94569031+vivekr-splunk@users.noreply.github.com&gt;
diff --git a/docs/ChangeLog.md b/docs/ChangeLog.md
@@ -1,5 +1,20 @@
 # Splunk Operator for Kubernetes Change Log
 
+## 2.0.0 (2022-05-27)
+
+* This is the 2.0.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/master/docs/README.md#prerequisites-for-the-splunk-operator)
+
+* Operator SDK upgraded to version 1.21.0. Operator upgrade steps with necessary script updated [here](https://github.com/splunk/splunk-operator/blob/master/docs/SplunkOperatorUpgrade.md)
+
+* Introducing Monitoring Console CRD
+
+* Functional QA automation enhancements
+
+* Documentation Updates
+  
+* Changed to App Framework
+
+  
 ## 1.1.0 (2022-04-12)
 
 * This is the 1.1.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/master/docs/README.md#prerequisites-for-the-splunk-operator)
diff --git a/docs/Images.md b/docs/Images.md
@@ -2,7 +2,7 @@
 
 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) (1.1.0 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) (2.0.0 or later)
 * `splunk/splunk:<version>`: The [Splunk Enterprise image](https://github.com/splunk/docker-splunk) (8.2.6 or later)
 
 All of these images are publicly available, and published on [Docker Hub](https://hub.docker.com/).
diff --git a/docs/Install.md b/docs/Install.md
@@ -7,59 +7,45 @@
 If you want to customize the installation of the Splunk Operator, download a copy of the installation YAML locally, and open it in your favorite editor.
 
 ```
-wget -O splunk-operator-cluster.yaml https://github.com/splunk/splunk-operator/releases/download/1.1.0/splunk-operator-cluster.yaml
+wget -O splunk-operator-cluster.yaml https://github.com/splunk/splunk-operator/releases/download/2.0.0/splunk-operator-cluster.yaml
 ```
 
 ## Default Installation
 
-By default operator will be installed in `splunk-operator` namespace and will watch all the namespaces of your cluster for splunk enterprise custom resources
+By default operator will be installed in `splunk-operator` namespace and based on the file used it can be installed cluster-wide or namespace scoped. By installing `splunk-operator-cluster.yaml` Operator will watch all the namespaces of your cluster for splunk enterprise custom resources
 
 ```
-wget -O splunk-operator-cluster.yaml https://github.com/splunk/splunk-operator/releases/download/1.1.0/splunk-operator-cluster.yaml
+wget -O splunk-operator-cluster.yaml https://github.com/splunk/splunk-operator/releases/download/2.0.0/splunk-operator-cluster.yaml
 kubectl apply -f splunk-operator-cluster.yaml
 ```
 
-## Install operator to watch single namespace
-
-By default operator will be installed in `splunk-operator` namespace and will watch all the namespaces of your cluster for splunk enterprise custom resources. If user wants to watch only one namespace then edit `config-map` `splunk-operator-config` in `splunk-operator` namespace, set `WATCH_NAMESPACE` field to the namespace operator should watch
-
-```
-apiVersion: v1
-data:
-  OPERATOR_NAME: '"splunk-operator"'
-  RELATED_IMAGE_SPLUNK_ENTERPRISE: splunk/splunk:latest
-  WATCH_NAMESPACE: "namespace1"
-kind: ConfigMap
-metadata:
-  labels:
-    name: splunk-operator
-  name: splunk-operator-config
-  namespace: splunk-operator
-```
-
 ## Install operator to watch multiple namespaces
 
-If user wants to manage multiple namespaces, they must add the namespaces to the WATCH_NAMESPACE field, with each namespace separated by a comma (,). example
+If Splunk Operator is installed clusterwide  and user wants to manage multiple namespaces, they must add the namespaces to the WATCH_NAMESPACE field with each namespace separated by a comma (,).  Edit `deployment` `splunk-operator-controller-manager-<podid>` in `splunk-operator` namespace, set `WATCH_NAMESPACE` field to the namespace that needs to be monitored by Splunk Operator
 
+```yaml
+...
+        env:
+        - name: WATCH_NAMESPACE
+          value: "namespace1,namespace2"
+        - name: RELATED_IMAGE_SPLUNK_ENTERPRISE
+          value: splunk/splunk:8.2.6
+        - name: OPERATOR_NAME
+          value: splunk-operator
+        - name: POD_NAME
+          valueFrom:
+            fieldRef:
+              apiVersion: v1
+              fieldPath: metadata.name
+...
 ```
-apiVersion: v1
-data:
-  OPERATOR_NAME: '"splunk-operator"'
-  RELATED_IMAGE_SPLUNK_ENTERPRISE: splunk/splunk:latest
-  WATCH_NAMESPACE: "namespace1,namespace2"
-kind: ConfigMap
-metadata:
-  labels:
-    name: splunk-operator
-  name: splunk-operator-config
-  namespace: splunk-operator
-```
+
 ## Install operator to watch single namespace with restrictive permission
 
-In order to install operator with restrictive permission to watch only single namespace use [splunk-operator-namespace.yaml](https://github.com/splunk/splunk-operator/releases/download/1.1.0/splunk-operator-namespace.yaml). This will create Role and Role-Binding to only watch single namespace. By default operator will be installed in `splunk-operator` namespace, user can edit the file to change the namespace
+In order to install operator with restrictive permission to watch only single namespace use [splunk-operator-namespace.yaml](https://github.com/splunk/splunk-operator/releases/download/2.0.0/splunk-operator-namespace.yaml). This will create Role and Role-Binding to only watch single namespace. By default operator will be installed in `splunk-operator` namespace, user can edit the file to change the namespace
 
 ```
-wget -O splunk-operator-namespace.yaml https://github.com/splunk/splunk-operator/releases/download/1.1.0/splunk-operator-namespace.yaml
+wget -O splunk-operator-namespace.yaml https://github.com/splunk/splunk-operator/releases/download/2.0.0/splunk-operator-namespace.yaml
 kubectl apply -f splunk-operator-namespace.yaml
 ```
 
@@ -72,20 +58,23 @@ If you plan to retag the container images as part of pushing it to a private reg
 image: splunk/splunk-operator
 ```
 
-If you are using a private registry for the Docker images, edit `config-map` `splunk-operator-config` in `splunk-operator` namespace, set `RELATED_IMAGE_SPLUNK_ENTERPRISE` field splunk docker image path
+If you are using a private registry for the Docker images, edit `deployment` `splunk-operator-controller-manager-xxxx` in `splunk-operator` namespace, set `RELATED_IMAGE_SPLUNK_ENTERPRISE` field splunk docker image path
 
-```
-apiVersion: v1
-data:
-  OPERATOR_NAME: '"splunk-operator"'
-  RELATED_IMAGE_SPLUNK_ENTERPRISE: splunk/splunk:latest
-  WATCH_NAMESPACE: ""
-kind: ConfigMap
-metadata:
-  labels:
-    name: splunk-operator
-  name: splunk-operator-config
-  namespace: splunk-operator
+```yaml
+...
+        env:
+        - name: WATCH_NAMESPACE
+          value: "namespace1,namespace2"
+        - name: RELATED_IMAGE_SPLUNK_ENTERPRISE
+          value: splunk/splunk:8.2.6
+        - name: OPERATOR_NAME
+          value: splunk-operator
+        - name: POD_NAME
+          valueFrom:
+            fieldRef:
+              apiVersion: v1
+              fieldPath: metadata.name
+...
 ```
 
 ## Cluster Domain
diff --git a/docs/README.md b/docs/README.md
@@ -59,7 +59,7 @@ 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) (1.1.0 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) (2.0.0 or later)
 * `splunk/splunk:<version>`: The [Splunk Enterprise image](https://github.com/splunk/docker-splunk) (8.2.6 or later)
 
 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.
@@ -106,11 +106,18 @@ For production environments, we are requiring the use of Splunk SmartStore. As a
  
 ## Installing the Splunk Operator
 
-A Kubernetes cluster administrator can install and start the Splunk Operator by running:
+A Kubernetes cluster administrator can install and start the Splunk Operator for specific namespace by running:
 ```
-kubectl apply -f https://github.com/splunk/splunk-operator/releases/download/1.1.0/splunk-operator-install.yaml
+kubectl apply -f https://github.com/splunk/splunk-operator/releases/download/2.0.0/splunk-operator-namespace.yaml
 ```
 
+A Kubernetes cluster administrator can install and start the Splunk Operator for cluster-wide by running:
+```
+kubectl apply -f https://github.com/splunk/splunk-operator/releases/download/2.0.0/splunk-operator-cluster.yaml
+```
+
+The [Advanced Installation Instructions](Install.md) page offers guidance for advanced configurations, including the use of private image registries, installation at cluster scope, and installing the Splunk Operator as a user who is not a Kubernetes administrator. Users of Red Hat OpenShift should review the [Red Hat OpenShift](OpenShift.md) page.
+
 The [Advanced Installation Instructions](Install.md) page offers guidance for advanced configurations, including the use of private image registries, installation at cluster scope, and installing the Splunk Operator as a user who is not a Kubernetes administrator. Users of Red Hat OpenShift should review the [Red Hat OpenShift](OpenShift.md) page.
 
 *Note: We recommended that the Splunk Enterprise Docker image is copied to a private registry, or directly onto your Kubernetes workers before creating large Splunk Enterprise deployments. See the [Required Images Documentation](Images.md) page, and the [Advanced Installation Instructions](Install.md) page for guidance on working with copies of the Docker images.*
diff --git a/docs/SplunkOperatorUpgrade.md b/docs/SplunkOperatorUpgrade.md
@@ -1,6 +1,6 @@
 # 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-install.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.
 ​
@@ -16,7 +16,48 @@ A Splunk Operator for Kubernetes upgrade might include support for a later versi
 ​
 * If you use forwarders, verify the Splunk Enterprise version compatibility with the forwarders in the [Compatibility between forwarders and Splunk Enterprise indexers](https://docs.splunk.com/Documentation/Forwarder/latest/Forwarder/Compatibilitybetweenforwardersandindexers) documentation.
 ​
-## Upgrading Splunk Operator and Splunk Operator Deployment
+
+
+# Splunk Operator Upgrade
+
+## Steps for upgrade from 1.1.0 to 2.0.0
+
+1. Download the latest Splunk Operator installation yaml file.
+​
+```
+wget -O splunk-operator-namespace.yaml https://github.com/splunk/splunk-operator/releases/download/1.0.5/splunk-operator-namespace.yaml
+```
+​
+2. (Optional) Review the file and update it with your specific customizations used during your install. 
+​
+3. Upgrade the Splunk Operator.
+​
+```
+kubectl apply -f splunk-operator-namespace.yaml
+```
+​
+After applying the yaml, a new operator pod will be created and the existing operator pod will be terminated. Example:
+​
+```
+kubectl get pods
+NAME                                                  READY   STATUS    RESTARTS   AGE
+splunk-operator--controller-manager-75f5d4d85b-8pshn   1/1     Running   0          5s
+​
+```
+​
+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.  
+​
+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.
+
+## Steps for upgrade from 1.0.5 to 2.0.0
+
+Upgrading the Splunk Operator from 1.0.5 or older version to Version 2.0.0 is a new installation rather than an upgrade from the current operator. The older Splunk Operator must be cleaned up before installing the new version. Script [upgrade-to-1.1.0.sh](https://github.com/splunk/splunk-operator/releases/download/2.0.0/upgrade-to-1.1.0.sh) helps you to do the cleanup. The script expects the current namespace where the operator is installed and the path to the 2.0.0 manifest file. The script performs the following steps
+
+* Backup of all the operator resources within the namespace like
+** service-account, deployment, role, role-binding, cluster-role, cluster-role-binding
+* Deletes all the old Splunk Operator resources and deployment
+* Installs the operator 1.1.0 in Splunk-operator namespace.
+### Upgrading Splunk Operator and Splunk Operator Deployment
 
 1. Download the upgrade script.
 
@@ -34,19 +75,6 @@ wget -O splunk-operator-install.yaml https://github.com/splunk/splunk-operator/r
 
 4. Upgrade the Splunk Operator.
 
-# Splunk Operator Upgrade
-
-Upgrading the Splunk Operator to Version 1.1.0 is a new installation rather than an upgrade from the current operator. The older Splunk Operator must be cleaned up before installing the new version. Script [upgrade-to-1.1.0.sh](https://github.com/splunk/splunk-operator/releases/download/1.1.0/upgrade-to-1.1.0.sh) helps you to do the cleanup. The script expects the current namespace where the operator is installed and the path to the 1.1.0 manifest file. The script performs the following steps
-
-* Backup of all the operator resources within the namespace like
-** service-account, deployment, role, role-binding, cluster-role, cluster-role-binding
-* Deletes all the old Splunk Operator resources and deployment
-* Installs the operator 1.1.0 in Splunk-operator namespace.
-
-By default Splunk Operator 1.1.0 will be installed to watch cluster-wide
-
-## Steps for upgrade from 1.0.5 to 1.1.0
-
 Set KUBECONFIG and run [upgrade-to-1.1.0.sh](https://github.com/splunk/splunk-operator/releases/download/1.1.0/upgrade-to-1.1.0.sh) script with the following mandatory arguments
 
 * `current_namespace` current namespace where operator is installed
@@ -62,24 +90,26 @@ Note: This script can be run from `Mac` or `Linux` system. To run this script on
 
 ## Configuring Operator to watch specific namespace
 
-Edit `configmap` `splunk-operator-config` in `splunk-operator` namespace, set `WATCH_NAMESPACE` field to the namespace that needs to be monitored by Splunk Operator
+If Splunk Operator is installed clusterwide then
+Edit `deployment` `splunk-operator-controller-manager-<podid>` in `splunk-operator` namespace, set `WATCH_NAMESPACE` field to the namespace that needs to be monitored by Splunk Operator
 
 ```yaml
-apiVersion: v1
-data:
-  OPERATOR_NAME: "splunk-operator"
-  RELATED_IMAGE_SPLUNK_ENTERPRISE: splunk/splunk:8.2.6
-  WATCH_NAMESPACE: "add namespace here"
-kind: ConfigMap
-metadata:
-  labels:
-    name: splunk-operator
-  name: splunk-operator-config
-  namespace: splunk-operator
+...
+        env:
+        - name: WATCH_NAMESPACE
+          value: "splunk-operator"
+        - name: RELATED_IMAGE_SPLUNK_ENTERPRISE
+          value: splunk/splunk:8.2.6
+        - name: OPERATOR_NAME
+          value: splunk-operator
+        - name: POD_NAME
+          valueFrom:
+            fieldRef:
+              apiVersion: v1
+              fieldPath: metadata.name
+...
 ```
 ​
-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.  
-​
 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.
 
 ## Verify Upgrade is Successful
