Add a script generating files for OperatorHub.io (#302)

Make a few adjustements to the base CSVs.

Author: qbarrand

CONTRIBUTING.md

@@ -48,6 +48,26 @@ If several `It` sections are similar, consider refactoring them in a `DescribeTa
 - [Kubernetes Contributor Guide](https://git.k8s.io/community/contributors/guide) - Main contributor documentation, or you can just jump directly to the [contributing section](https://git.k8s.io/community/contributors/guide#contributing)
 - [Contributor Cheat Sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet) - Common resources for existing developers
 
+## Managing releases
+
+### OperatorHub.io
+
+After a new version is released, it must be added manually to the
+[k8s-operatorhub/community-operators](https://github.com/k8s-operatorhub/community-operators) repo to be available on
+OperatorHub.io.
+
+First, generate all manifests:
+
+```shell
+make operatorhub-release IMAGE_TAG=<RELEASE_TAG> VERSION=<VERSION_NUMBER>
+```
+
+This will create two directories, `kmm-operatorhub-<VERSION>` and `kmm-hub-operatorhub-<VERSION>`.
+
+Then, use the contents of those directories to create new versions in
+[k8s-operatorhub/community-operators](https://github.com/k8s-operatorhub/community-operators).
+Only one operator should be affected per pull request; create separate PRs if you want to update both KMM bundles.
+
 ## Mentorship
 
 - [Mentoring Initiatives](https://git.k8s.io/community/mentoring) - We have a diverse set of mentorship programs available that are always looking for volunteers!

Makefile

@@ -343,5 +343,8 @@ catalog-push: ## Push a catalog image.
 signimage-build: ## Build docker image with the signer.
 	docker build -f Dockerfile.signimage -t $(SIGNER_IMG) .
 
+operatorhub-release:
+	IMG=$(IMG) HUB_IMG=$(HUB_IMG) VERSION=$(VERSION) ./hack/release-operatorhub
+
 include docs.mk
 

config/manifests-hub/bases/kernel-module-management-hub.clusterserviceversion.yaml

@@ -3,8 +3,9 @@ kind: ClusterServiceVersion
 metadata:
   annotations:
     alm-examples: '[]'
-    capabilities: Basic Install
+    capabilities: Seamless Upgrades
     categories: Drivers and plugins
+    repository: https://github.com/kubernetes-sigs/kernel-module-management
   name: kernel-module-management-hub.v0.0.0
   namespace: placeholder
 spec:
@@ -42,8 +43,6 @@ spec:
   - module
   - modules
   links:
-  - name: GitHub repository
-    url: https://github.com/kubernetes-sigs/kernel-module-management
   - name: Documentation
     url: https://kmm.sigs.k8s.io
   - name: Slack
@@ -52,6 +51,7 @@ spec:
   - email: [email protected]
     name: Kernel Module Management
   maturity: stable
+  minKubeVersion: 1.24.0
   provider:
     name: Kubernetes SIG Node
     url: https://github.com/kubernetes-sigs/kernel-module-management

config/manifests/bases/kernel-module-management.clusterserviceversion.yaml

@@ -3,19 +3,15 @@ kind: ClusterServiceVersion
 metadata:
   annotations:
     alm-examples: '[]'
-    capabilities: Basic Install
+    capabilities: Seamless Upgrades
     categories: Drivers and plugins
-  name: kmm-operator.v0.0.0
+    repository: https://github.com/kubernetes-sigs/kernel-module-management
+  name: kernel-module-management.v0.0.0
   namespace: placeholder
 spec:
   apiservicedefinitions: {}
   customresourcedefinitions:
     owned:
-    - description: Module is the Schema for the modules API
-      displayName: Module
-      kind: Module
-      name: modules.kmm.sigs.x-k8s.io
-      version: v1alpha1
     - description: Module describes how to load a module on different kernel versions
       displayName: Module
       kind: Module
@@ -52,8 +48,6 @@ spec:
   - module
   - modules
   links:
-  - name: GitHub repository
-    url: https://github.com/kubernetes-sigs/kernel-module-management
   - name: Documentation
     url: https://kmm.sigs.k8s.io
   - name: Slack
@@ -62,6 +56,7 @@ spec:
   - email: [email protected]
     name: Kernel Module Management
   maturity: stable
+  minKubeVersion: 1.24.0
   provider:
     name: Kubernetes SIG Node
     url: https://github.com/kubernetes-sigs/kernel-module-management

hack/release-operatorhub

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+# This script generates bundle directories to be imported into OperatorHub.io.s
+
+set -euo pipefail
+
+make_output_dir () {
+  local -r dir=$1
+
+  if ! [ -d "$dir" ]; then
+    mkdir "$dir"
+  else
+    rm -fr "${dir:?}"/*
+  fi
+}
+
+created_at=$(date +'%Y-%m-%d %H:%M:%S')
+readonly created_at
+
+replace_csv () {
+  local -r container_image=$1
+  local -r csv_path=$2
+
+  yq -i "
+    .metadata.annotations.containerImage = \"$container_image\" |
+    .metadata.annotations.createdAt = \"$created_at\"" \
+    "$csv_path"
+}
+
+: "$IMG"
+: "$HUB_IMG"
+: "$VERSION"
+
+# KMM
+
+output_dir="kmm-operatorhub-$VERSION"
+
+echo "Generating KMM bundle files for OperatorHub in $output_dir"
+
+make bundle VERSION="$VERSION"
+
+make_output_dir "$output_dir"
+
+cp -r bundle/* "$output_dir"
+
+replace_csv "$IMG" "$output_dir/manifests/kernel-module-management.clusterserviceversion.yaml"
+
+# KMM-Hub
+
+output_dir="kmm-hub-operatorhub-$VERSION"
+
+echo "Generating KMM-Hub bundle files for OperatorHub in $output_dir"
+
+make bundle-hub VERSION="$VERSION"
+
+make_output_dir "$output_dir"
+
+cp -r bundle/* "$output_dir"
+
+replace_csv "$HUB_IMG" "$output_dir/manifests/kernel-module-management-hub.clusterserviceversion.yaml"
+
+echo 'Done.'