CSPL 1180 - CRD apiVersioning change from V2 to V3

build/make_bundle.sh

@@ -5,7 +5,7 @@
 set -e
 
 VERSION=`grep "Version.*=.*\".*\"" version/version.go | sed "s,.*Version.*=.*\"\(.*\)\".*,\1,"`
-OLD_VERSIONS="v1 v1beta1 v1alpha3 v1alpha2"
+OLD_VERSIONS="v2 v1 v1beta1 v1alpha3 v1alpha2"
 DOCKER_IO_PATH="docker.io/splunk"
 REDHAT_REGISTRY_PATH="registry.connect.redhat.com/splunk"
 OPERATOR_IMAGE="$DOCKER_IO_PATH/splunk-operator:${VERSION}"
@@ -92,7 +92,7 @@ cat << EOF >$YAML_SCRIPT_FILE
   path: metadata.annotations.alm-examples
   value: |-
     [{
-      "apiVersion": "enterprise.splunk.com/v2",
+      "apiVersion": "enterprise.splunk.com/v3",
       "kind": "IndexerCluster",
       "metadata": {
         "name": "example",
@@ -103,7 +103,7 @@ cat << EOF >$YAML_SCRIPT_FILE
       }
     },
     {
-      "apiVersion": "enterprise.splunk.com/v2",
+      "apiVersion": "enterprise.splunk.com/v3",
       "kind": "LicenseMaster",
       "metadata": {
         "name": "example",
@@ -112,7 +112,7 @@ cat << EOF >$YAML_SCRIPT_FILE
       "spec": {}
     },
     {
-      "apiVersion": "enterprise.splunk.com/v2",
+      "apiVersion": "enterprise.splunk.com/v3",
       "kind": "SearchHeadCluster",
       "metadata": {
         "name": "example",
@@ -123,7 +123,7 @@ cat << EOF >$YAML_SCRIPT_FILE
       }
     },
     {
-      "apiVersion": "enterprise.splunk.com/v2",
+      "apiVersion": "enterprise.splunk.com/v3",
       "kind": "Standalone",
       "metadata": {
         "name": "example",

deploy/crds/enterprise.splunk.com_clustermasters_crd.yaml

@@ -18,7 +18,7 @@ spec:
       jsonPath: .status.phase
       name: Phase
       type: string
-    name: v2
+    name: v3
     schema:
       openAPIV3Schema:
         description: ClusterMaster is the Schema for the clustermasters API
@@ -2949,6 +2949,16 @@ spec:
     storage: true
     subresources:
       status: {}
+  - name: v2
+    served: true
+    storage: false
+    schema:
+      openAPIV3Schema:
+        type: object
+        x-kubernetes-preserve-unknown-fields: true
+        properties:
+          apiVersion:
+            type: string
   - name: v1
     served: true
     storage: false

deploy/crds/enterprise.splunk.com_indexerclusters_crd.yaml

@@ -35,7 +35,7 @@ spec:
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
-    name: v2
+    name: v3
     schema:
       openAPIV3Schema:
         description: IndexerCluster is the Schema for a Splunk Enterprise indexer
@@ -2606,6 +2606,16 @@ spec:
         specReplicasPath: .spec.replicas
         statusReplicasPath: .status.replicas
       status: {}
+  - name: v2
+    served: true
+    storage: false
+    schema:
+      openAPIV3Schema:
+        type: object
+        x-kubernetes-preserve-unknown-fields: true
+        properties:
+          apiVersion:
+            type: string
   - name: v1
     served: true
     storage: false

deploy/crds/enterprise.splunk.com_licensemasters_crd.yaml

@@ -22,7 +22,7 @@ spec:
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
-    name: v2
+    name: v3
     schema:
       openAPIV3Schema:
         description: LicenseMaster is the Schema for a Splunk Enterprise license master.
@@ -2718,6 +2718,16 @@ spec:
     storage: true
     subresources:
       status: {}
+  - name: v2
+    served: true
+    storage: false
+    schema:
+      openAPIV3Schema:
+        type: object
+        x-kubernetes-preserve-unknown-fields: true
+        properties:
+          apiVersion:
+            type: string
   - name: v1
     served: true
     storage: false

deploy/crds/enterprise.splunk.com_monitoringconsoles_crd.yaml

@@ -18,7 +18,7 @@ spec:
       jsonPath: .status.phase
       name: Phase
       type: string
-    name: v2
+    name: v3
     schema:
       openAPIV3Schema:
         description: MonitoringConsole is the Schema for the monitoringconsole API
@@ -2729,12 +2729,23 @@ spec:
     storage: true
     subresources:
       status: {}
+  - name: v2
+    served: true
+    storage: false
+    schema:
+      openAPIV3Schema:
+        type: object
+        x-kubernetes-preserve-unknown-fields: true
+        properties:
+          apiVersion:
+            type: string
   - name: v1
     served: true
     storage: false
     schema:
       openAPIV3Schema:
         type: object
+        x-kubernetes-preserve-unknown-fields: true
         properties:
           apiVersion:
             type: string
@@ -2744,6 +2755,7 @@ spec:
     schema:
       openAPIV3Schema:
         type: object
+        x-kubernetes-preserve-unknown-fields: true
         properties:
           apiVersion:
             type: string
@@ -2753,6 +2765,7 @@ spec:
     schema:
       openAPIV3Schema:
         type: object
+        x-kubernetes-preserve-unknown-fields: true
         properties:
           apiVersion:
             type: string
@@ -2762,6 +2775,7 @@ spec:
     schema:
       openAPIV3Schema:
         type: object
+        x-kubernetes-preserve-unknown-fields: true
         properties:
           apiVersion:
             type: string

deploy/crds/enterprise.splunk.com_searchheadclusters_crd.yaml

@@ -34,7 +34,7 @@ spec:
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
-    name: v2
+    name: v3
     schema:
       openAPIV3Schema:
         description: SearchHeadCluster is the Schema for a Splunk Enterprise search
@@ -2827,6 +2827,16 @@ spec:
         specReplicasPath: .spec.replicas
         statusReplicasPath: .status.replicas
       status: {}
+  - name: v2
+    served: true
+    storage: false
+    schema:
+      openAPIV3Schema:
+        type: object
+        x-kubernetes-preserve-unknown-fields: true
+        properties:
+          apiVersion:
+            type: string
   - name: v1
     served: true
     storage: false

deploy/crds/enterprise.splunk.com_standalones_crd.yaml

@@ -30,7 +30,7 @@ spec:
       jsonPath: .metadata.creationTimestamp
       name: Age
       type: date
-    name: v2
+    name: v3
     schema:
       openAPIV3Schema:
         description: Standalone is the Schema for a Splunk Enterprise standalone instances.
@@ -2970,6 +2970,16 @@ spec:
         specReplicasPath: .spec.replicas
         statusReplicasPath: .status.replicas
       status: {}
+  - name: v2
+    served: true
+    storage: false
+    schema:
+      openAPIV3Schema:
+        type: object
+        x-kubernetes-preserve-unknown-fields: true
+        properties:
+          apiVersion:
+            type: string
   - name: v1
     served: true
     storage: false

deploy/examples/advanced/c1.yaml

@@ -1,4 +1,4 @@
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: LicenseMaster
 metadata:
   name: lm-example
@@ -11,7 +11,7 @@ spec:
         name: splunk-licenses
   licenseUrl: /mnt/licenses/enterprise.lic
 ---
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: ClusterMaster
 metadata:
   name: cm-example
@@ -42,7 +42,7 @@ spec:
       apps_location:
         - "/mnt/apps/<my_index_config>.tgz"
 ---
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: IndexerCluster
 metadata:
   name: idxc-example
@@ -55,7 +55,7 @@ spec:
   licenseMasterRef:
     name: lm-example
 ---
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: Standalone
 metadata:
   name: sh-example

deploy/examples/clustermaster/default.yaml

@@ -1,4 +1,4 @@
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: ClusterMaster
 metadata:
   name: test

deploy/examples/indexercluster/default.yaml

@@ -1,4 +1,4 @@
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: IndexerCluster
 metadata:
   name: test

deploy/examples/licensemaster/default.yaml

@@ -1,4 +1,4 @@
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: LicenseMaster
 metadata:
   name: test

deploy/examples/monitoringconsole/default.yaml

@@ -0,0 +1,5 @@
+apiVersion: enterprise.splunk.com/v3
+kind: MonitoringConsole
+metadata:
+  name: test
+spec: {}

deploy/examples/searchheadcluster/default.yaml

@@ -1,4 +1,4 @@
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: SearchHeadCluster
 metadata:
   name: test

deploy/examples/standalone/default.yaml

@@ -1,4 +1,4 @@
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: Standalone
 metadata:
   name: test

docs/AppFramework.md

@@ -26,12 +26,12 @@ In this example, you'll deploy a Standalone CR with a remote storage volume, the
    * In this example, the Splunk Apps are located at `bucket-app-framework-us-west-2/Standalone-us/networkAppsLoc/` and `bucket-app-framework-us-west-2/Standalone-us/authAppsLoc/`, and are both accessible through the end point `https://s3-us-west-2.amazonaws.com`.
 
 5. Update the standalone CR specification and append the volume, App Source configuration, and scope.
-   * The scope determines where the apps and add-ons are placed into the Splunk Enterprise instance. For CRs where the Splunk Enterprise instance will run the apps locally, set the `scope: local ` The Standalone and License Master CRs always use a local scope.
+   * The scope determines where the apps and add-ons are placed into the Splunk Enterprise instance. For CRs where the Splunk Enterprise instance will run the apps locally, set the `scope: local ` The Standalone, Monitoring Console and License Master CRs always use a local scope.
 
 Example: Standalone.yaml
 
 ```yaml
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: Standalone
 metadata:
   name: stdln
@@ -88,7 +88,7 @@ This example describes the installation of apps on Indexer Cluster as well as Cl
 Example: ClusterMaster.yaml
 
 ```yaml
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: ClusterMaster
 metadata:
   name: cm
@@ -149,7 +149,7 @@ This example describes the installation of apps on Search Head Cluster as well a
 Example: SearchHeadCluster.yaml
 
 ```yaml
-apiVersion: enterprise.splunk.com/v2
+apiVersion: enterprise.splunk.com/v3
 kind: SearchHeadCluster
 metadata:
   name: shc 
@@ -192,11 +192,11 @@ For more information, see the [Description of App Framework Specification fields
 
 
 ## Description of App Framework Specification fields
-App Framework configuration is supported on the following Custom Resources: Standalone, ClusterMaster, SearchHeadCluster, and LicenseMaster. Configuring the App framework involves the following steps:
+App Framework configuration is supported on the following Custom Resources: Standalone, ClusterMaster, SearchHeadCluster, MonitoringConsole and LicenseMaster. Configuring the App framework involves the following steps:
 
 * Remote Source of Apps: Define the remote location including the bucket(s) and path for each bucket
 * Destination of Apps: Define where the Apps need to be installed (in other words, which Custom resources need to be configured)
-* Scope of Apps: Define if the Apps need to be installed locally (such as Standalone) or cluster-wide (such as Indexer cluster, Search Head Cluster)
+* Scope of Apps: Define if the Apps need to be installed locally (such as Standalone, Monitoring Console and License Master) or cluster-wide (such as Indexer cluster, Search Head Cluster)
 
 Here is a typical App framework configuration in a Custom resource definition:
 
@@ -307,6 +307,7 @@ Here is a typical App framework configuration in a Custom resource definition:
     | SearchHeadCluster | cluster, clusterWithPreConfig, local   | Yes                   |
     | Standalone        | local                                  | Yes                   |
     | LicenceMaster     | local                                  | Yes                   |
+    | MonitoringConsole | local                                  | Yes                   |
     | IndexerCluster    | N/A                                    | No                    |
 
 * `volume` refers to the remote storage volume name configured under the `volumes` stanza (see previous section)
@@ -320,7 +321,7 @@ Here is a typical App framework configuration in a Custom resource definition:
 
 * Splunk Operator CRDs support the configuration of [initialDelaySeconds](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/) for both Liveliness (livenessInitialDelaySeconds) and Readiness (readinessInitialDelaySeconds) probes
 * When App Framework is NOT configured, default values are 300 seconds for livenessInitialDelaySeconds and 10 seconds for readinessInitialDelaySeconds (for all CRs)
-* When App Framework is configured, default values are 1800 seconds for livenessInitialDelaySeconds and 10 seconds for readinessInitialDelaySeconds (only for Deployer, Cluster Master, Standalone and License Master CRs). The higher value of livenessInitialDelaySeconds is to ensure sufficient time is allocated for installing most apps. This configuration can further be managed depending on the number & size of Apps to be installed
+* When App Framework is configured, default values are 1800 seconds for livenessInitialDelaySeconds and 10 seconds for readinessInitialDelaySeconds (only for Deployer, Cluster Master, Standalone, Monitoring Console and License Master CRs). The higher value of livenessInitialDelaySeconds is to ensure sufficient time is allocated for installing most apps. This configuration can further be managed depending on the number & size of Apps to be installed
 
 ## App Framework Limitations