Pipeline and documentation fixes (#1575)

* fix doc links and distroless build

* remove extra quote

* remove make tidy, update operator sdk version in bundle

Author: rlieberman-splunk

.github/workflows/distroless-build-test-push-workflow.yml

@@ -94,7 +94,9 @@ jobs:
         uses: aws-actions/amazon-ecr-login@v1
       - name: Build and push Splunk Operator Image
         run: |
-          make docker-buildx IMG=${{ secrets.ECR_REPOSITORY }}/${{ env.SPLUNK_OPERATOR_IMAGE_NAME }}:$GITHUB_SHA-distroless
+          export BASE_IMAGE=gcr.io/distroless/static-debian12
+          export BASE_IMAGE_VERSION=latest
+          make docker-buildx BASE_IMAGE=$BASE_IMAGE BASE_IMAGE_VERSION=$BASE_IMAGE_VERSION IMG=${{ secrets.ECR_REPOSITORY }}/${{ env.SPLUNK_OPERATOR_IMAGE_NAME }}:$GITHUB_SHA-distroless
       - name: Sign Splunk Operator image with a key
         run: |
           cosign sign --yes --key env://COSIGN_PRIVATE_KEY  ${{ secrets.ECR_REPOSITORY }}/${{ env.SPLUNK_OPERATOR_IMAGE_NAME }}:${{ github.sha }}-distroless

.github/workflows/merge-develop-to-main-workflow.yml

@@ -100,7 +100,7 @@ jobs:
       # Build and push Distroless image
       - name: Build and push Distroless Image
         run: |
-          make docker-buildx IMG=${{ secrets.PUBLIC_ECR_REPOSITORY }}/${{ env.SPLUNK_OPERATOR_RC_IMAGE_NAME }}:${{ github.event.inputs.release_version }}-RC${{ github.event.inputs.release_candiate_version }} BASE_IMAGE=gcr.io/distroless/static BASE_IMAGE_VERSION=latest
+          make docker-buildx IMG=${{ secrets.PUBLIC_ECR_REPOSITORY }}/${{ env.SPLUNK_OPERATOR_RC_IMAGE_NAME }}:${{ github.event.inputs.release_version }}-RC${{ github.event.inputs.release_candiate_version }}-distroless BASE_IMAGE=gcr.io/distroless/static BASE_IMAGE_VERSION=latest
 
       - name: Tag and Push Default UBI RC Image
         run: |

Makefile

@@ -174,15 +174,13 @@ docker-buildx:
         	docker buildx use project-v3-builder; \
         if echo "${BASE_IMAGE}" | grep -q "distroless"; then \
             DOCKERFILE="Dockerfile.distroless"; \
-            BUILD_TAG="${IMG}-distroless"; \
         else \
             DOCKERFILE="Dockerfile"; \
-            BUILD_TAG="${IMG}"; \
         fi; \
         docker buildx build --push --platform="${PLATFORMS}" \
             --build-arg BASE_IMAGE="${BASE_IMAGE}" \
             --build-arg BASE_IMAGE_VERSION="${BASE_IMAGE_VERSION}" \
-            --tag "$$BUILD_TAG" -f "$$DOCKERFILE" .; \
+            --tag "${IMG}" -f "$$DOCKERFILE" .; \
         - docker buildx rm project-v3-builder || true
 
 

README.md

@@ -50,9 +50,8 @@ The [Kubernetes Operator SDK](https://github.com/operator-framework/operator-sdk
 must also be installed to build this project.
 
 ```
-git clone -b v1.31.0 https://github.com/operator-framework/operator-sdk
+git clone -b v1.39.0 https://github.com/operator-framework/operator-sdk
 cd operator-sdk
-make tidy
 make install
 ```
 

bundle.Dockerfile

@@ -7,7 +7,7 @@ LABEL operators.operatorframework.io.bundle.metadata.v1=metadata/
 LABEL operators.operatorframework.io.bundle.package.v1=splunk-operator
 LABEL operators.operatorframework.io.bundle.channels.v1=stable
 LABEL operators.operatorframework.io.bundle.channel.default.v1: stable
-LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.31.0
+LABEL operators.operatorframework.io.metrics.builder=operator-sdk-v1.39.0
 LABEL operators.operatorframework.io.metrics.mediatype.v1=metrics+v1
 LABEL operators.operatorframework.io.metrics.project_layout=go.kubebuilder.io/v3
 

docs/AppFramework.md

@@ -22,7 +22,7 @@ Utilizing the App Framework requires one of the following remote storage provide
 
 ### Prerequisites for Azure Blob remote object storage
 * The remote object storage credentials provided as a kubernetes secret.
-* OR, Use "Managed Indentity" role assigment to the Azure blob container. See [Setup Azure bob access with Managed Indentity](#setup-azure-bob-access-with-managed-indentity)
+* OR, Use "Managed Identity" role assigment to the Azure blob container. See [Setup Azure blob access with Managed Identity](#setup-azure-blob-access-with-managed-identity)
 
 ### Prerequisites for GCP bucket based remote object storage
 To use GCP storage in the App Framework, follow these setup requirements:
@@ -63,7 +63,7 @@ In this example, you'll deploy a Standalone CR with a remote storage volume, the
        * Or, create a Kubernetes Secret Object with the static storage credentials.
            * Example: `kubectl create secret generic s3-secret --from-literal=s3_access_key=AKIAIOSFODNN7EXAMPLE --from-literal=s3_secret_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLE_S3_SECRET_KEY`
    * azure blob:
-       * Configuring an IAM through  "Managed Indentity" role assigment to give read access for your bucket (azure blob container). For more details see [Setup Azure bob access with Managed Indentity](#setup-azure-bob-access-with-managed-indentity)
+       * Configuring an IAM through  "Managed Identity" role assigment to give read access for your bucket (azure blob container). For more details see [Setup Azure blob access with Managed Identity](#setup-azure-blob-access-with-managed-identity)
        * Or, create a Kubernetes Secret Object with the static storage credentials.
            * Example: `kubectl create secret generic azureblob-secret --from-literal=azure_sa_name=mystorageaccount --from-literal=azure_sa_secret_key=wJalrXUtnFEMI/K7MDENG/EXAMPLE_AZURE_SHARED_ACCESS_KEY`
    * GCP bucket:
@@ -195,7 +195,7 @@ This example describes the installation of apps on an Indexer Cluster and Cluste
        * Or, create a Kubernetes Secret Object with the static storage credentials.
            * Example: `kubectl create secret generic s3-secret --from-literal=s3_access_key=AKIAIOSFODNN7EXAMPLE --from-literal=s3_secret_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLE_S3_SECRET_KEY`
    * azure blob:
-       * Configuring an IAM through  "Managed Indentity" role assigment to give read access for your bucket (azure blob container). For more details see [Setup Azure bob access with Managed Indentity](#setup-azure-bob-access-with-managed-indentity)
+       * Configuring an IAM through  "Managed Identity" role assigment to give read access for your bucket (azure blob container). For more details see [Setup Azure blob access with Managed Identity](#setup-azure-blob-access-with-managed-identity)
        * Or, create a Kubernetes Secret Object with the static storage credentials.
            * Example: `kubectl create secret generic azureblob-secret --from-literal=azure_sa_name=mystorageaccount --from-literal=azure_sa_secret_key=wJalrXUtnFEMI/K7MDENG/EXAMPLE_AZURE_SHARED_ACCESS_KEY`
    * GCP bucket:
@@ -342,7 +342,7 @@ This example describes the installation of apps on the Deployer and the Search H
        * Or, create a Kubernetes Secret Object with the static storage credentials.
            * Example: `kubectl create secret generic s3-secret --from-literal=s3_access_key=AKIAIOSFODNN7EXAMPLE --from-literal=s3_secret_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLE_S3_SECRET_KEY`
    * azure blob:
-       * Configuring an IAM through  "Managed Indentity" role assigment to give read access for your bucket (azure blob container). For more details see [Setup Azure bob access with Managed Indentity](#setup-azure-bob-access-with-managed-indentity)
+       * Configuring an IAM through  "Managed Identity" role assigment to give read access for your bucket (azure blob container). For more details see [Setup Azure blob access with Managed Identity](#setup-azure-blob-access-with-managed-identity)
        * Or, create a Kubernetes Secret Object with the static storage credentials.
            * Example: `kubectl create secret generic azureblob-secret --from-literal=azure_sa_name=mystorageaccount --from-literal=azure_sa_secret_key=wJalrXUtnFEMI/K7MDENG/EXAMPLE_AZURE_SHARED_ACCESS_KEY`
    * GCP bucket:

docs/Examples.md

@@ -699,6 +699,8 @@ spec:
   defaultsUrl: /mnt/license-manager/default.yml
 ```
 
+In the case of an indexer cluster, default.yml will need configuration on the cluster manager custom resource and all indexer cluster custom resource(s).
+
 ## Using an External Indexer Cluster
 
 *Note that this requires using the Splunk Enterprise container version 8.1.0 or later*

docs/Ingress.md

@@ -23,7 +23,7 @@ We provide some examples below for configuring a few of the most popular Ingress
 
 * [Configuring Ingress Using Istio](#Configuring-Ingress-Using-Istio)
 * [Configuring Ingress Using NGINX](#Configuring-Ingress-Using-NGINX)
-* [Using Let's Encrypt to manage TLS certificates ](#installing-the-splunk-operator)
+* [Using Let's Encrypt to manage TLS certificates](#using-lets-encrypt-to-manage-tls-certificates)
 
 
 Before deploying an example, you will need to review the yaml and replace “example.com” with the domain name you would like to use and replace “example” in the service names with the name of your custom resource object. You will also need to point your DNS for all the desired hostnames to the IP addresses of your ingress load balancer.