Update docs page to use Just The Docs Jekyll theme

.env

@@ -1,9 +1,9 @@
-OPERATOR_SDK_VERSION=v1.28.1
-REVIEWERS=smohan-splunk,sgontla,gaurav-splunk,vivekr-splunk,kumarajeet
-GO_VERSION=1.19.2
+OPERATOR_SDK_VERSION=v1.31.0
+REVIEWERS=vivekr-splunk,akondur
+GO_VERSION=1.21.5
 AWSCLI_URL=https://awscli.amazonaws.com/awscli-exe-linux-x86_64-2.8.6.zip
-KUBECTL_VERSION=v1.28.0
+KUBECTL_VERSION=v1.29.1
 AZ_CLI_VERSION=2.30.0
 EKSCTL_VERSION=v0.143.0
-EKS_CLUSTER_K8_VERSION=1.26
-SPLUNK_ENTERPRISE_RELEASE_IMAGE=splunk/splunk:9.1.1
+EKS_CLUSTER_K8_VERSION=1.27
+SPLUNK_ENTERPRISE_RELEASE_IMAGE=splunk/splunk:9.1.3

.github/workflows/docs-pages.yml

@@ -0,0 +1,70 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll site to Pages
+
+on:
+  push:
+    branches: ["main"]
+    paths:
+      - "docs/**"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+          working-directory: '${{ github.workspace }}/docs'
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v3
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: "docs/_site/"
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/int-test-workflow.yml

@@ -8,6 +8,7 @@ on:
 jobs:
   build-operator-image:
     runs-on: ubuntu-latest
+    timeout-minutes: 360
     env:
       SPLUNK_ENTERPRISE_IMAGE: ${{ secrets.SPLUNK_ENTERPRISE_IMAGE }}
       SPLUNK_OPERATOR_IMAGE_NAME: splunk/splunk-operator

.github/workflows/release.yml

@@ -21,6 +21,6 @@ jobs:
         uses: helm/chart-releaser-action@v1.4.0
         with:
           charts_dir: helm-charts
-          config: docs/cr.yaml
+          config: docs/_helm/cr.yaml
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

Makefile

@@ -3,17 +3,17 @@
 # To re-generate a bundle for another specific version without changing the standard setup, you can:
 # - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
 # - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
-VERSION ?= 2.2.1
+VERSION ?= 2.5.0
 
 # SPLUNK_ENTERPRISE_IMAGE defines the splunk docker tag that is used as default image.
 SPLUNK_ENTERPRISE_IMAGE ?= "docker.io/splunk/splunk:edge"
 
 # WATCH_NAMESPACE defines if its clusterwide operator or namespace specific
-# by default we leave it as clusterwide if it has to be namespace specific, 
+# by default we leave it as clusterwide if it has to be namespace specific,
 # add namespace to this
 WATCH_NAMESPACE ?= ""
 
-# NAMESPACE defines default namespace where operator will be installed 
+# NAMESPACE defines default namespace where operator will be installed
 NAMESPACE ?= "splunk-operator"
 
 # CHANNELS define the bundle channels used in the bundle.

README.md

@@ -18,7 +18,7 @@ This repository is used to build the Splunk
 [Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
 for Kubernetes (SOK). If you are just looking for documentation on how to
 deploy and use the latest release, please see the
-[Getting Started Documentation](docs/README.md).
+[Getting Started Documentation](https://splunk.github.io/splunk-operator/).
 
 ## Prerequisites
 

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: "2023-10-06T22:35:48Z"
+    createdAt: "2024-01-22T21:05:16Z"
     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
@@ -788,8 +788,15 @@ spec:
                     memory: 64Mi
                 securityContext:
                   allowPrivilegeEscalation: false
+                  capabilities:
+                    add:
+                    - NET_BIND_SERVICE
+                    drop:
+                    - ALL
                   readOnlyRootFilesystem: true
                   runAsNonRoot: true
+                  seccompProfile:
+                    type: RuntimeDefault
               - args:
                 - --leader-elect
                 - --pprof
@@ -801,14 +808,14 @@ spec:
                     fieldRef:
                       fieldPath: metadata.annotations['olm.targetNamespaces']
                 - name: RELATED_IMAGE_SPLUNK_ENTERPRISE
-                  value: docker.io/splunk/splunk:9.1.1
+                  value: docker.io/splunk/splunk:9.1.3
                 - name: OPERATOR_NAME
                   value: splunk-operator
                 - name: POD_NAME
                   valueFrom:
                     fieldRef:
                       fieldPath: metadata.name
-                image: docker.io/splunk/splunk-operator:2.4.0
+                image: docker.io/splunk/splunk-operator:2.5.0
                 imagePullPolicy: Always
                 livenessProbe:
                   httpGet:
@@ -832,8 +839,15 @@ spec:
                     memory: 2000Mi
                 securityContext:
                   allowPrivilegeEscalation: false
+                  capabilities:
+                    add:
+                    - NET_BIND_SERVICE
+                    drop:
+                    - ALL
                   readOnlyRootFilesystem: true
                   runAsNonRoot: true
+                  seccompProfile:
+                    type: RuntimeDefault
                 volumeMounts:
                 - mountPath: /opt/splunk/appframework/
                   name: app-staging
@@ -913,7 +927,7 @@ spec:
     name: Splunk Inc.
     url: www.splunk.com
   relatedImages:
-  - image: docker.io/splunk/splunk:9.1.1
+  - image: docker.io/splunk/splunk:9.1.3
     name: splunk-enterprise
   replaces: splunk-operator.v2.2.0
   version: 2.2.1

config/default/kustomization.yaml

@@ -124,7 +124,7 @@ patches:
       - name: WATCH_NAMESPACE
         value: WATCH_NAMESPACE_VALUE
       - name: RELATED_IMAGE_SPLUNK_ENTERPRISE
-        value: docker.io/splunk/splunk:9.1.1
+        value: docker.io/splunk/splunk:9.1.3
       - name: OPERATOR_NAME
         value: splunk-operator
       - name: POD_NAME

config/default/manager_auth_proxy_patch.yaml

@@ -18,6 +18,13 @@ spec:
           allowPrivilegeEscalation: false
           readOnlyRootFilesystem: true
           runAsNonRoot: true
+          capabilities:
+            drop:
+              - "ALL"
+            add:
+              - "NET_BIND_SERVICE"
+          seccompProfile:
+            type: "RuntimeDefault"
         image: gcr.io/kubebuilder/kube-rbac-proxy:v0.13.1
         args:
         - "--secure-listen-address=0.0.0.0:8443"

config/manager/kustomization.yaml

@@ -17,4 +17,4 @@ kind: Kustomization
 images:
 - name: controller
   newName: docker.io/splunk/splunk-operator
-  newTag: 2.4.0
+  newTag: 2.5.0

config/manager/manager.yaml

@@ -17,7 +17,7 @@ spec:
     matchLabels:
       control-plane: controller-manager
       name: splunk-operator
-  strategy: 
+  strategy:
     type: Recreate
   replicas: 1
   template:
@@ -54,6 +54,13 @@ spec:
           allowPrivilegeEscalation: false
           readOnlyRootFilesystem: true
           runAsNonRoot: true
+          capabilities:
+            drop:
+              - "ALL"
+            add:
+              - "NET_BIND_SERVICE"
+          seccompProfile:
+            type: "RuntimeDefault"
         livenessProbe:
           httpGet:
             path: /healthz

docs/.gitignore

@@ -0,0 +1,5 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor

docs/404.html

@@ -0,0 +1,25 @@
+---
+permalink: /404.html
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>