feat: Split ngrok-operators CRDs into their own chart (#732)

Signed-off-by: Jonathan Stacks <[email protected]>

Author: jonstacks

.gitattributes

@@ -7,7 +7,7 @@ PROJECT                                      linguist-generated=true
 api/**/zz_generated*go                       linguist-generated=true
 
 # These files are generated by kubebuilder. See Makefile for details.
-helm/ngrok-operator/templates/crds/**        linguist-generated=true
+helm/ngrok-crds/templates/*.yaml             linguist-generated=true
 helm/ngrok-operator/templates/rbac/role.yaml linguist-generated=true
 manifest-bundle.yaml                         linguist-generated=true
 

.github/actions/changes/action.yaml

@@ -37,8 +37,10 @@ runs:
             - '.github/actions/**'
           chartyaml:
             - 'helm/ngrok-operator/Chart.yaml'
+            - 'helm/ngrok-crds/Chart.yaml'
           charts:
             - 'helm/ngrok-operator/**'
+            - 'helm/ngrok-crds/**'
             - 'scripts/e2e.sh'
           go:
             - '**.go'

.github/workflows/helm_release.yaml

@@ -5,6 +5,7 @@ on:
     branches:
       - main
     paths:
+      - 'helm/ngrok-crds/Chart.yaml'
       - 'helm/ngrok-operator/Chart.yaml'
 
 jobs:
@@ -13,7 +14,8 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 10
     outputs:
-      charts: ${{ steps.filter.outputs.charts }}
+      ngrok-operator: ${{ steps.filter.outputs.ngrok-operator }}
+      ngrok-crds: ${{ steps.filter.outputs.ngrok-crds }}
     permissions:
       contents: read
       pull-requests: read
@@ -26,19 +28,24 @@ jobs:
         uses: dorny/[email protected]
         with:
           filters: |
-            charts:
+            ngrok-operator:
               - 'helm/ngrok-operator/Chart.yaml'
+            ngrok-crds:
+              - 'helm/ngrok-crds/Chart.yaml'
 
   chart:
-    name: Release Chart
+    name: Release Charts
     runs-on: ubuntu-latest
     timeout-minutes: 15
     permissions:
       contents: write # need to write releases
     needs: [changes]
     if: |
       (github.repository == 'ngrok/ngrok-operator') &&
-      (needs.changes.outputs.charts == 'true')
+      (
+        (needs.changes.outputs.ngrok-operator == 'true') ||
+        (needs.changes.outputs.ngrok-crds == 'true')
+      )
     steps:
       - name: Checkout repo
         uses: actions/checkout@v6
@@ -69,7 +76,7 @@ jobs:
         uses: helm/[email protected]
         env:
           CR_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          CR_RELEASE_NAME_TEMPLATE: "helm-chart-{{ .Version }}" # Publishes a new release. Ex: helm-chart-0.1.0
+          CR_RELEASE_NAME_TEMPLATE: "helm-chart-{{ .Name }}-{{ .Version }}" # Publishes a new release. Ex: helm-chart-ngrok-operator-0.1.0
           CR_SKIP_EXISTING: "true"
           CR_KEY: "Team Eng Infra (ngrok.com) (Key for signing ngrok-operator Helm chart) <[email protected]>" # full key name
           CR_KEYRING: keyring.gpg
@@ -80,9 +87,25 @@ jobs:
 
       - run: ls -alth .
         working-directory: ./.cr-release-packages
-        shell: bash
 
-      - name: Push to charts.ngrok.com
+      - name: Push ngrok-crds to charts.ngrok.com
+        if: needs.changes.outputs.ngrok-crds == 'true'
+        working-directory: ./.cr-release-packages
+        env:
+          CHART_PUSH_AUTH: ${{ secrets.CHART_PUSH_AUTH }}
+        run: |
+          for chart in ngrok-crds-*.tgz; do
+            if [ -f "${chart}.prov" ]; then
+              echo "Uploading ${chart} and ${chart}.prov"
+              curl -H "Authorization: Basic ${CHART_PUSH_AUTH}" -F "chart=@${chart}" -F "prov=@${chart}.prov" "https://charts.ngrok.com/api/charts"
+            else
+              echo "Uploading ${chart}"
+              curl -H "Authorization: Basic ${CHART_PUSH_AUTH}" -F "chart=@${chart}" "https://charts.ngrok.com/api/charts"
+            fi
+          done
+
+      - name: Push ngrok-operator to charts.ngrok.com
+        if: needs.changes.outputs.ngrok-operator == 'true'
         working-directory: ./.cr-release-packages
         env:
           CHART_PUSH_AUTH: ${{ secrets.CHART_PUSH_AUTH }}

.github/workflows/pr-comments.yaml

@@ -28,8 +28,10 @@ jobs:
         filters: |
           chartyaml:
             - 'helm/ngrok-operator/Chart.yaml'
+            - 'helm/ngrok-crds/Chart.yaml'
           charts:
             - 'helm/ngrok-operator/**'
+            - 'helm/ngrok-crds/**'
             - 'scripts/e2e.sh'
           go:
             - '**.go'
@@ -63,7 +65,7 @@ jobs:
             issue_number: context.issue.number,
             owner: context.repo.owner,
             repo: context.repo.repo,
-            body: ":wave: Looks like there are changes in the Helm Chart's Chart.yaml file. Upon merge, a new release of the helm chart will be created if the Chart's version was changed."
+            body: ":wave: Looks like there are changes in a Helm Chart's Chart.yaml file. Upon merge, a new release of the helm chart will be created if the Chart's version was changed."
           })
     - if: needs.changes.outputs.tag == 'true'
       name: Notify about version change

docs/developer-guide/releasing.md

@@ -3,10 +3,12 @@
 - [Artifacts](#artifacts)
   - [Docker Image](#docker-image)
   - [Helm Chart](#helm-chart)
+  - [CRDs Helm Chart](#crds-helm-chart)
 - [Semantic Versioning](#semantic-versioning)
 - [Release Process](#release-process)
   - [Tagging](#tagging)
     - [Helm Chart](#helm-chart-1)
+    - [CRDs Helm Chart](#crds-helm-chart-1)
     - [Controller](#controller)
 
 # Release Steps
@@ -55,6 +57,13 @@ support `amd64` and `arm64` architectures, with future plans to build for other
 The helm chart is packaged and published to its own [helm repository](https://charts.ngrok.com/index.yaml)
 and can be installed by following the instructions in the chart's [README](../helm/ingress-operator/README.md).
 
+### CRDs Helm Chart
+
+The `ngrok-crds` helm chart contains the Custom Resource Definitions (CRDs) for the ngrok operator.
+This chart is published to the same [helm repository](https://charts.ngrok.com/index.yaml) as the
+main operator chart. It allows users to manage CRD lifecycle separately from the operator, which
+is useful for GitOps workflows and when multiple operators share the same CRDs.
+
 ## Semantic Versioning
 
 This project uses [semantic versioning](https://semver.org/) for both the the docker image
@@ -79,8 +88,8 @@ There is a different git tag pattern for each artifact.
 #### Helm Chart
 
 Releases of the helm chart will be tagged with a prefix of `helm-chart-`. For example, version `1.2.0`
-of the helm chart will have a git tag of `helm-chart-1.2.0` which contains the code used to package
-and publish version `1.2.0` of the helm chart.
+of the helm chart will have a git tag of `helm-chart-1.2.0` or `helm-chart-ngrok-operator-1.2.0` which
+contains the code used to package and publish version `1.2.0` of the helm chart.
 
 When changes are made to the helm chart's `Chart.yaml` file, a github workflow will trigger upon
 merging the PR to the `main` branch. The workflow will package and publish the helm chart for
@@ -89,6 +98,16 @@ consumption. The workflow will also create a git tag as described above.
 When changing `version` in the helm chart's `Chart.yaml` file, the version should be bumped according
 to the semantic versioning spec as described above.
 
+#### CRDs Helm Chart
+
+Releases of the CRDs helm chart will be tagged with a prefix of `helm-chart-`. For example, version `0.1.0`
+of the CRDs helm chart will have a git tag of `helm-chart-ngrok-crds-0.1.0` which contains the code used to package
+and publish version `0.1.0` of the CRDs helm chart.
+
+When changes are made to the CRDs helm chart's `Chart.yaml` file in `helm/ngrok-crds/`, a github workflow
+will trigger upon merging the PR to the `main` branch. The workflow will package and publish the CRDs
+helm chart for consumption. The workflow will also create a git tag as described above.
+
 #### Controller
 
 Releases of the controller will be tagged with a prefix of `ngrok-operator-`. For example,

helm/ngrok-crds/.helmignore

@@ -0,0 +1,28 @@
+# Source: https://github.com/helm/helm/blob/main/pkg/repo/repotest/testdata/examplechart/.helmignore
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+
+# helmtest plugin tests
+tests
+
+# Makefile used in development
+Makefile

helm/ngrok-crds/Chart.yaml

@@ -0,0 +1,15 @@
+apiVersion: v2
+name: ngrok-crds
+description: ngrok Custom Resource Definitions for Kubernetes.
+version: 0.1.0
+appVersion: 0.1.0
+keywords:
+  - ngrok
+  - networking
+  - ingress
+  - edge
+  - api gateway
+home: https://ngrok.com
+sources:
+  - https://github.com/ngrok/ngrok-operator
+icon: https://charts.ngrok.com/assets/ngrok-favicon.svg

helm/ngrok-crds/README.md

@@ -0,0 +1,36 @@
+# ngrok Custom Resource Definitions
+
+This Helm chart installs the ngrok Custom Resource Definitions (CRDs) for Kubernetes.
+
+## Usage
+
+### Prerequisites
+
+[Helm](https://helm.sh) must be installed to use the charts.
+Please refer to Helm's [documentation](https://helm.sh/docs) to get started.
+
+### Installation
+
+Once Helm has been set up correctly, add the repo as follows:
+
+`helm repo add ngrok https://charts.ngrok.com`
+
+If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions of the packages.
+You can then run `helm search repo ngrok` to see the charts.
+
+To install the ngrok-crds chart:
+
+`helm install ngrok-crds ngrok/ngrok-crds`
+
+To uninstall the chart:
+
+`helm delete ngrok-crds`
+
+### Using with ngrok-operator
+
+The `ngrok-operator` chart can install these CRDs automatically via the `installCRDs` value (enabled by default).
+You only need to install this chart separately if you want to manage CRD lifecycle independently from the operator.
+
+## More Information
+
+For more information about the ngrok Kubernetes Operator, see https://github.com/ngrok/ngrok-operator