chore( prerelease ): [main] 1.2.3-rc.0

.github/workflows/__release-workflow.yaml

@@ -1,5 +1,5 @@
 name: Reusable release
-run-name: "Release ${{ format('{0} (type: {1})', inputs.tag, inputs.release-type) }} "
+run-name: "Release ${{ format('{0} (type: {1}) (branch: {2})', inputs.tag, inputs.release-type, inputs.base) }} "
 
 on:
   workflow_call:
@@ -28,6 +28,11 @@ on:
         description: The version to release (e.g. v1.2.3)
         type: string
         required: true
+      base:
+        description: The base branch from which to release and against which to create a release PR.
+        type: string
+        default: 'main'
+        required: false
       latest:
         description: Whether to mark this release latest
         type: boolean
@@ -107,7 +112,6 @@ jobs:
 
   test-integration-current-kubernetes:
     runs-on: ubuntu-latest
-    needs: build-push-images
     strategy:
       fail-fast: true
       matrix:
@@ -132,6 +136,10 @@ jobs:
         with:
           go-version-file: go.mod
 
+      - uses: jdx/mise-action@v2
+        with:
+          install: false
+
       - name: integration tests
         run: make test.integration
         env:
@@ -160,82 +168,118 @@ jobs:
         with:
           go-version-file: go.mod
 
+      - uses: jdx/mise-action@v2
+        with:
+          install: false
+
       - name: E2E Tests
         run: make test.e2e
         env:
           KONG_LICENSE_DATA: ${{ secrets.kong-license-data }}
           KONG_TEST_GATEWAY_OPERATOR_IMAGE_OVERRIDE: ${{ needs.build-push-images.outputs.full_tag }}
 
+  # NOTE: This job's steps are run when:
+  # - input.base is 'main': then 1 PR is created targeting 'main'
+  # - input.base is not 'main': then 2 PRs will be created:
+  #   - 1 PR targeting 'main' to update VERSION and config/
+  #   - 1 PR targeting the release branch to update VERSION and config/ and trigger the release workflow
   create-release-pr:
     runs-on: ubuntu-latest
     needs:
       - semver
       - build-push-images
       - test-integration-current-kubernetes
       - test-e2e-current-kubernetes
+    strategy:
+      matrix:
+        base:
+          - ${{ inputs.base }}
+          - main
     steps:
-      # Use the main branch as a base for the release.
-      # Any changes made on the branch that the workflow was triggered on will not be included
-      # in the release PR. If anything needs to be fixed before a release, it should be
-      # done on the main branch.
+      # Use the branch set via inputs as a base for the release.
+      # If anything needs to be fixed before the release, it should be done on the base branch
+      # before the release workflow is triggered.
       - name: Checkout repository
+        if: ${{ (inputs.base == 'main' && matrix.base == 'main') || (inputs.base != 'main') }}
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          ref: main
+          ref: ${{ matrix.base }}
 
-      - name: Configure Git for private repositories (temporary until making KGO public)
+      - name: Configure Git for private repositories (this is needed by repositories that include this workflow and have other private dependencies)
+        if: ${{ (inputs.base == 'main' && matrix.base == 'main') || (inputs.base != 'main') }}
         run: git config --global url."https://${{ secrets.gh-pat }}@github.com".insteadOf "https://github.com"
 
       - name: Checkout KGO submodule
+        if: ${{ (inputs.base == 'main' && matrix.base == 'main') || (inputs.base != 'main') }}
         run: git submodule update --init
 
       - name: Setup golang
+        if: ${{ (inputs.base == 'main' && matrix.base == 'main') || (inputs.base != 'main') }}
         uses: actions/setup-go@v5
         with:
           go-version-file: go.mod
 
       # The bumped version file is included in the release PR.
       - name: Ensure version is set
+        if: ${{ (inputs.base == 'main' && matrix.base == 'main') || (inputs.base != 'main') }}
         env:
           VERSION: ${{ needs.semver.outputs.fullversion }}
         run: |
           echo "VERSION=${VERSION}" >> $GITHUB_ENV
           echo ${VERSION} > VERSION
 
+      - uses: jdx/mise-action@v2
+        with:
+          install: false
+
       # Generated manifests are part of the release PR.
       - name: Generate manifests
-        if: ${{ inputs.regenerate-manifests }}
+        if: ${{ inputs.regenerate-manifests && ((inputs.base == 'main' && matrix.base == 'main') || (inputs.base != 'main')) }}
         run: make manifests
 
       # The generated bundle is part of the release PR.
       # This is done locally in this job, to avoid including unintended changes.
-      # If anything needs to be fixed before a release, it should be done on the main branch.
+      # If anything needs to be fixed before the release, it should be done on the base branch
+      # before the release workflow is triggered.
       - name: Generate bundle
-        if: ${{ inputs.regenerate-bundle }}
+        if: ${{ inputs.regenerate-bundle && ((inputs.base == 'main' && matrix.base == 'main') || (inputs.base != 'main')) }}
         run: make bundle
 
       - name: GPG sign the commits
+        if: ${{ (inputs.base == 'main' && matrix.base == 'main') || (inputs.base != 'main') }}
         uses: crazy-max/ghaction-import-gpg@01dd5d3ca463c7f10f7f4f7b4f177225ac661ee4
         with:
           gpg_private_key: ${{ secrets.gpg-private-key }}
           passphrase: ${{ secrets.gpg-passphrase }}
           git_user_signingkey: true
           git_commit_gpgsign: true
 
-      # PRs to the main branch will update the version file and manifests
+      - name: Commit message
+        if: ${{ (inputs.base == 'main' && matrix.base == 'main') || (inputs.base != 'main') }}
+        env:
+          # NOTE: If the base branch set for workflow is not main (it's a release branch)
+          # then create a commit message which will not trigger the release workflow
+          # (via release-bot.yaml) but which will only update VERSION and config/.
+          MSG: "${{ inputs.base != 'main' && matrix.base == 'main' && format('chore( {0} ): [main] {1}', inputs.release-type, env.VERSION) || format('chore( {0} ): [bot] {1}', inputs.release-type, env.VERSION) }}"
+        run: |
+          echo "MSG=${MSG}" >> $GITHUB_ENV
+
+      # PRs to the base branch will update the version file and manifests
       - name: Create a release PR
-        uses: peter-evans/create-pull-request@70a41aba780001da0a30141984ae2a0c95d8704e
+        uses: peter-evans/create-pull-request@9153d834b60caba6d51c9b9510b087acf9f33f83
+        if: ${{ (inputs.base == 'main' && matrix.base == 'main') || (inputs.base != 'main') }}
         with:
           token: ${{ secrets.gh-pat }}
           path: .
+          base: ${{ matrix.base }}
           add-paths: |
             VERSION
             config
-          commit-message: "chore(${{ inputs.release-type }}): [bot] ${{ env.VERSION }}"
+          commit-message: "${{ env.MSG }}"
           committer: Kong's Team k8s bot <[email protected]>
           author: Kong's Team k8s bot <[email protected]>
           signoff: true
           delete-branch: true
-          title: "chore(${{ inputs.release-type }}): [bot] ${{ env.VERSION }}"
-          body: "chore(${{ inputs.release-type }}): [bot] ${{ env.VERSION }}"
+          title: "${{ env.MSG }}"
+          body: "${{ env.MSG }}"

.github/workflows/release-bot.yaml

@@ -7,6 +7,7 @@ on:
   push:
     branches:
       - 'main'
+      - 'release/*'
 
 jobs:
   look_for_release:

.github/workflows/release.yaml

@@ -1,12 +1,17 @@
 name: release
-run-name: "Release ${{ format('{0} (type: {1})', inputs.tag, inputs.release_type) }} "
+run-name: "Release ${{ format('{0} (type: {1}) (branch: {2})', inputs.tag, inputs.release_type, inputs.base) }} "
 
 on:
   workflow_dispatch:
     inputs:
       tag:
         description: The version to release (e.g. v1.2.3)
         required: true
+      base:
+        description: The base branch from which to release and against which to create a release PR.
+        type: string
+        default: 'main'
+        required: false
       latest:
         description: Whether to tag this build latest
         type: boolean
@@ -33,5 +38,6 @@ jobs:
       image-name: ${{ vars.DOCKERHUB_IMAGE_NAME }}
       latest: ${{ inputs.latest }}
       tag: ${{ inputs.tag }}
+      base: ${{ inputs.base }}
       release-type: ${{ inputs.release_type }}
       regenerate-manifests: true

CHANGELOG.md

@@ -31,6 +31,10 @@
   autoscaling with `GatewayConfiguration` as the generated `DataPlane` deployment
   will no longer be rejected.
   [#79](https://github.com/Kong/gateway-operator/pull/79)
+- Make creating a `DataPlane` index conditional based on enabling the `ControlPlane`
+  controller. This allows running KGO without `ControlPlane` CRD with its controller
+  disabled.
+  [#103](https://github.com/Kong/gateway-operator/pull/103)
 
 ## [v1.2.1]
 

VERSION

@@ -1 +1 @@
-1.2.1
+1.2.3-rc.0

config/components/manager-image/kustomization.yaml

@@ -4,4 +4,4 @@ kind: Component
 images:
 - name: docker.io/kong/gateway-operator-oss
   newName: docker.io/kong/gateway-operator-oss
-  newTag: 1.2.1
+  newTag: 1.2.3-rc.0

go.mod

@@ -4,6 +4,12 @@ go 1.22
 
 toolchain go1.22.0
 
+// 1.2.2 was released on main branch with a breaking change that was not
+// intended to be released in 1.2.x:
+// https://github.com/Kong/gateway-operator/commit/3876430e09e61edce58bd8464989e33236bd1872
+// This retraction is to prevent it from being used and from breaking builds of dependent projects.
+retract v1.2.2
+
 require (
 	github.com/Masterminds/semver v1.5.0
 	github.com/cert-manager/cert-manager v1.14.4

internal/utils/index/index.go

@@ -2,7 +2,9 @@ package index
 
 import (
 	"context"
+	"fmt"
 
+	"k8s.io/apimachinery/pkg/api/meta"
 	"sigs.k8s.io/controller-runtime/pkg/cache"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
@@ -14,10 +16,17 @@ const (
 	DataPlaneNameIndex = "dataplane"
 )
 
-// IndexDataPlaneNameOnControlPlane indexes the ControlPlane .spec.dataplaneName field
+// DataPlaneNameOnControlPlane indexes the ControlPlane .spec.dataplaneName field
 // on the "dataplane" key.
-func IndexDataPlaneNameOnControlPlane(c cache.Cache) error {
-	return c.IndexField(context.Background(), &operatorv1beta1.ControlPlane{}, DataPlaneNameIndex, func(o client.Object) []string {
+func DataPlaneNameOnControlPlane(ctx context.Context, c cache.Cache) error {
+	if _, err := c.GetInformer(ctx, &operatorv1beta1.ControlPlane{}); err != nil {
+		if meta.IsNoMatchError(err) {
+			return nil
+		}
+		return fmt.Errorf("failed to get informer for v1beta1 ControlPlane: %w, disabling indexing DataPlanes for ControlPlanes' .spec.dataplaneName", err)
+	}
+
+	return c.IndexField(ctx, &operatorv1beta1.ControlPlane{}, DataPlaneNameIndex, func(o client.Object) []string {
 		controlPlane, ok := o.(*operatorv1beta1.ControlPlane)
 		if !ok {
 			return []string{}

modules/manager/controller_setup.go

@@ -1,6 +1,7 @@
 package manager
 
 import (
+	"context"
 	"errors"
 	"fmt"
 	"net/url"
@@ -93,8 +94,13 @@ func (c *ControllerDef) MaybeSetupWithManager(mgr ctrl.Manager) error {
 	return c.Controller.SetupWithManager(mgr)
 }
 
-func setupIndexes(mgr manager.Manager) error {
-	return index.IndexDataPlaneNameOnControlPlane(mgr.GetCache())
+func setupIndexes(ctx context.Context, mgr manager.Manager, cfg Config) error {
+	if cfg.ControlPlaneControllerEnabled || cfg.GatewayControllerEnabled {
+		if err := index.DataPlaneNameOnControlPlane(ctx, mgr.GetCache()); err != nil {
+			return fmt.Errorf("failed to setup index for DataPlane names on ControlPlane: %w", err)
+		}
+	}
+	return nil
 }
 
 // SetupControllers returns a list of ControllerDefs based on config.

modules/manager/run.go

@@ -186,7 +186,7 @@ func Run(
 		return fmt.Errorf("unable to start manager: %w", err)
 	}
 
-	if err := setupIndexes(mgr); err != nil {
+	if err := setupIndexes(context.Background(), mgr, cfg); err != nil {
 		return err
 	}