rename to objectbucket-notifications-adapter

Author: maschmid

Makefile

@@ -28,8 +28,8 @@ BUNDLE_METADATA_OPTS ?= $(BUNDLE_CHANNELS) $(BUNDLE_DEFAULT_CHANNEL)
 # This variable is used to construct full image tags for bundle and catalog images.
 #
 # For example, running 'make bundle-build bundle-push catalog-build catalog-push' will build and push both
-# functions.dev/mcg-adapter-bundle:$VERSION and functions.dev/mcg-adapter-catalog:$VERSION.
-IMAGE_TAG_BASE ?= functions.dev/mcg-adapter
+# functions.dev/objectbucket-notifications-adapter-bundle:$VERSION and functions.dev/objectbucket-notifications-adapter-catalog:$VERSION.
+IMAGE_TAG_BASE ?= functions.dev/objectbucket-notifications-adapter
 
 # BUNDLE_IMG defines the image:tag used for the bundle.
 # You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
@@ -116,7 +116,7 @@ test: manifests generate fmt vet setup-envtest ## Run tests.
 # The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
 # CertManager is installed by default; skip with:
 # - CERT_MANAGER_INSTALL_SKIP=true
-KIND_CLUSTER ?= mcg-adapter-test-e2e
+KIND_CLUSTER ?= objectbucket-notifications-adapter-test-e2e
 
 .PHONY: setup-test-e2e
 setup-test-e2e: ## Set up a Kind cluster for e2e tests if it does not exist
@@ -185,10 +185,10 @@ PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
 docker-buildx: ## Build and push docker image for the manager for cross-platform support
 	# copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile
 	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
-	- $(CONTAINER_TOOL) buildx create --name mcg-adapter-builder
-	$(CONTAINER_TOOL) buildx use mcg-adapter-builder
+	- $(CONTAINER_TOOL) buildx create --name objectbucket-notifications-adapter-builder
+	$(CONTAINER_TOOL) buildx use objectbucket-notifications-adapter-builder
 	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
-	- $(CONTAINER_TOOL) buildx rm mcg-adapter-builder
+	- $(CONTAINER_TOOL) buildx rm objectbucket-notifications-adapter-builder
 	rm Dockerfile.cross
 
 .PHONY: build-installer

PLAN

@@ -1,8 +1,8 @@
-Multicloud Object Gateway Adapter (NooNaa)
-==========================================
+ObjectBucket Notifications Adapter
+==================================
 
 The adapter will be an HTTP server and/or Kafka consumer running in a pod inside a k8s cluster, configured in noobaa as "bucketNotifications" connection (either as HTTP notifications, or Kafka notifications)
-It will distribute the notifications received from NooBaa to individual triggers, according to the configuration specified by OBCSource custom resources.
+It will distribute the notifications received from NooBaa to individual triggers, according to the configuration specified by ObjectBucketSource custom resources.
 The notifications to individual triggers will be sent as cloudevents via HTTP or Kafka
 It will be implemented in go, using k8s client libraries, the cloudevents k8s libraries, aws s3 client library, https://github.com/IBM/sarama, and the operator sdk (https://sdk.operatorframework.io)
 

README.md

@@ -1,10 +1,10 @@
-# MCG Adapter
+# ObjectBucket Notifications Adapter
 
 A Kubernetes operator that receives S3 bucket notifications from NooBaa (Multicloud Object Gateway) and dispatches them as CloudEvents to configured sink endpoints.
 
 ## Description
 
-The MCG Adapter runs inside a Kubernetes cluster, registered as a `bucketNotifications` connection in NooBaa. It can receive notifications via HTTP (default) or by consuming from a Kafka topic. It watches `ObjectBucketSource` custom resources to determine which S3 events from which buckets should be forwarded to which endpoints. When NooBaa delivers a notification, the adapter matches the event against all configured sources and dispatches CloudEvents via HTTP or Kafka to the matching sinks.
+The ObjectBucket Notifications Adapter runs inside a Kubernetes cluster, registered as a `bucketNotifications` connection in NooBaa. It can receive notifications via HTTP (default) or by consuming from a Kafka topic. It watches `ObjectBucketSource` custom resources to determine which S3 events from which buckets should be forwarded to which endpoints. When NooBaa delivers a notification, the adapter matches the event against all configured sources and dispatches CloudEvents via HTTP or Kafka to the matching sinks.
 
 ## Custom Resource: ObjectBucketSource
 
@@ -50,8 +50,8 @@ The adapter is configured via environment variables:
 
 | Variable | Default | Description |
 |---|---|---|
-| `ADAPTER_ID` | `mcg-adapter` | Identifier used in the S3 bucket notification configuration |
-| `ADAPTER_TOPIC` | `mcg-adapter-connection/connect.json` | NooBaa connection secret reference used as TopicArn in put-bucket-notification calls |
+| `ADAPTER_ID` | `objectbucket-notifications-adapter` | Identifier used in the S3 bucket notification configuration |
+| `ADAPTER_TOPIC` | `objectbucket-notifications-adapter-connection/connect.json` | NooBaa connection secret reference used as TopicArn in put-bucket-notification calls |
 | `ADAPTER_PORT` | `8888` | Port the notification HTTP server listens on (HTTP mode only) |
 | `NOTIFICATIONS_MODE` | `http` | `http` or `kafka` — selects how the adapter receives NooBaa notifications |
 | `KAFKA_BROKERS` | _(none)_ | Comma-separated list of Kafka broker addresses. Required for Kafka sinks and when `NOTIFICATIONS_MODE=kafka`. |
@@ -66,10 +66,10 @@ Before the adapter can receive notifications via HTTP, register it as an HTTP co
 1. Create the connection secret:
 
 ```sh
-oc create secret generic mcg-adapter-connection \
+oc create secret generic objectbucket-notifications-adapter-connection \
   --from-file=connect.json=/dev/stdin -n openshift-storage <<EOF
 {
-  "name": "mcg-adapter-connection",
+  "name": "objectbucket-notifications-adapter-connection",
   "notification_protocol": "http",
   "agent_request_object": {
     "host": "<adapter-service>.<adapter-namespace>.svc.cluster.local",
@@ -86,7 +86,7 @@ existing_connections=$(oc get noobaa noobaa -n openshift-storage -o json \
   | jq -c '.spec.bucketNotifications.connections // []')
 
 updated_connections=$(echo "$existing_connections" | jq -c \
-  --arg name "mcg-adapter-connection" \
+  --arg name "objectbucket-notifications-adapter-connection" \
   '[.[] | select(.name != $name)] + [{"name": $name, "namespace": "openshift-storage"}]')
 
 oc patch noobaa noobaa --type='merge' -n openshift-storage -p '{
@@ -105,23 +105,23 @@ As an alternative to HTTP, the adapter can consume NooBaa notifications from a K
 
 Summary of the one-time setup:
 
-1. Create a `KafkaTopic` (e.g. `mcg-adapter-notifications`) and `KafkaUser` resources in Strimzi
+1. Create a `KafkaTopic` (e.g. `objectbucket-notifications-adapter-notifications`) and `KafkaUser` resources in Strimzi
 2. Create a NooBaa connection secret with `notification_protocol: kafka` pointing to the Kafka bootstrap and topic
 3. Patch the NooBaa CR to register the Kafka connection
 4. Create a Kubernetes Secret in the adapter's namespace with the adapter's Kafka credentials (see `kafka-secret-format.md`)
 
 ### Deploy
 
 ```sh
-make docker-build docker-push IMG=<some-registry>/mcg-adapter:tag
+make docker-build docker-push IMG=<some-registry>/objectbucket-notifications-adapter:tag
 make install
-make deploy IMG=<some-registry>/mcg-adapter:tag
+make deploy IMG=<some-registry>/objectbucket-notifications-adapter:tag
 ```
 
 To deploy in Kafka notifications mode (using default values from the PLAN):
 
 ```sh
-make deploy-kafka IMG=<some-registry>/mcg-adapter:tag
+make deploy-kafka IMG=<some-registry>/objectbucket-notifications-adapter:tag
 ```
 
 The `deploy-kafka` target uses the kustomize overlay in `config/kafka/` which sets `NOTIFICATIONS_MODE=kafka` along with default Kafka broker, topic, and secret values. Edit `config/kafka/kafka_env_patch.yaml` to customize these for your cluster.

cmd/main.go

@@ -45,10 +45,10 @@ import (
 
 	"github.com/IBM/sarama"
 
-	sourcesv1alpha1 "github.com/functions-dev/mcg-adapter/api/v1alpha1"
-	"github.com/functions-dev/mcg-adapter/internal/controller"
-	kafkaconfig "github.com/functions-dev/mcg-adapter/internal/kafka"
-	"github.com/functions-dev/mcg-adapter/internal/notificationserver"
+	sourcesv1alpha1 "github.com/functions-dev/objectbucket-notifications-adapter/api/v1alpha1"
+	"github.com/functions-dev/objectbucket-notifications-adapter/internal/controller"
+	kafkaconfig "github.com/functions-dev/objectbucket-notifications-adapter/internal/kafka"
+	"github.com/functions-dev/objectbucket-notifications-adapter/internal/notificationserver"
 	// +kubebuilder:scaffold:imports
 )
 
@@ -214,11 +214,11 @@ func main() {
 
 	adapterID := os.Getenv("ADAPTER_ID")
 	if adapterID == "" {
-		adapterID = "mcg-adapter"
+		adapterID = "objectbucket-notifications-adapter"
 	}
 	adapterTopic := os.Getenv("ADAPTER_TOPIC")
 	if adapterTopic == "" {
-		adapterTopic = "mcg-adapter-connection/connect.json"
+		adapterTopic = "objectbucket-notifications-adapter-connection/connect.json"
 	}
 	adapterPort := 8888
 	if portStr := os.Getenv("ADAPTER_PORT"); portStr != "" {

config/default/kustomization.yaml

@@ -1,12 +1,12 @@
 # Adds namespace to all resources.
-namespace: mcg-adapter-system
+namespace: objectbucket-notifications-adapter-system
 
 # Value of this field is prepended to the
 # names of all resources, e.g. a deployment named
 # "wordpress" becomes "alices-wordpress".
 # Note that it should also match with the prefix (text before '-') of the namespace
 # field above.
-namePrefix: mcg-adapter-
+namePrefix: objectbucket-notifications-adapter-
 
 # Labels to add to all resources and selectors.
 #labels:

config/default/metrics_service.yaml

@@ -3,7 +3,7 @@ kind: Service
 metadata:
   labels:
     control-plane: controller-manager
-    app.kubernetes.io/name: mcg-adapter
+    app.kubernetes.io/name: objectbucket-notifications-adapter
     app.kubernetes.io/managed-by: kustomize
   name: controller-manager-metrics-service
   namespace: system
@@ -15,4 +15,4 @@ spec:
     targetPort: 8443
   selector:
     control-plane: controller-manager
-    app.kubernetes.io/name: mcg-adapter
+    app.kubernetes.io/name: objectbucket-notifications-adapter

config/kafka/kafka_env_patch.yaml

@@ -13,8 +13,8 @@ spec:
         - name: KAFKA_BROKERS
           value: "my-cluster-kafka-bootstrap.kafka.svc:9095"
         - name: KAFKA_SECRET
-          value: "mcg-adapter-user"
+          value: "objectbucket-notifications-adapter-user"
         - name: KAFKA_NOTIFICATIONS_TOPIC
-          value: "mcg-adapter-notifications"
+          value: "objectbucket-notifications-adapter-notifications"
         - name: KAFKA_NOTIFICATIONS_GROUP_ID
-          value: "mcg-adapter-notifications"
+          value: "objectbucket-notifications-adapter-notifications"

config/manager/kustomization.yaml

@@ -5,5 +5,5 @@ apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 images:
 - name: controller
-  newName: example.com/mcg-adapter
+  newName: example.com/objectbucket-notifications-adapter
   newTag: v0.0.1

config/manager/manager.yaml

@@ -3,7 +3,7 @@ kind: Namespace
 metadata:
   labels:
     control-plane: controller-manager
-    app.kubernetes.io/name: mcg-adapter
+    app.kubernetes.io/name: objectbucket-notifications-adapter
     app.kubernetes.io/managed-by: kustomize
   name: system
 ---
@@ -14,21 +14,21 @@ metadata:
   namespace: system
   labels:
     control-plane: controller-manager
-    app.kubernetes.io/name: mcg-adapter
+    app.kubernetes.io/name: objectbucket-notifications-adapter
     app.kubernetes.io/managed-by: kustomize
 spec:
   selector:
     matchLabels:
       control-plane: controller-manager
-      app.kubernetes.io/name: mcg-adapter
+      app.kubernetes.io/name: objectbucket-notifications-adapter
   replicas: 1
   template:
     metadata:
       annotations:
         kubectl.kubernetes.io/default-container: manager
       labels:
         control-plane: controller-manager
-        app.kubernetes.io/name: mcg-adapter
+        app.kubernetes.io/name: objectbucket-notifications-adapter
     spec:
       # TODO(user): Uncomment the following code to configure the nodeAffinity expression
       # according to the platforms which are supported by your solution.
@@ -67,9 +67,9 @@ spec:
         name: manager
         env:
         - name: ADAPTER_ID
-          value: "mcg-adapter"
+          value: "objectbucket-notifications-adapter"
         - name: ADAPTER_TOPIC
-          value: "mcg-adapter-connection/connect.json"
+          value: "objectbucket-notifications-adapter-connection/connect.json"
         - name: ADAPTER_PORT
           value: "8888"
         - name: NOTIFICATIONS_MODE

config/manager/service.yaml

@@ -3,12 +3,12 @@ kind: Service
 metadata:
   name: controller-manager-notifications
   labels:
-    app.kubernetes.io/name: mcg-adapter
+    app.kubernetes.io/name: objectbucket-notifications-adapter
     app.kubernetes.io/managed-by: kustomize
 spec:
   selector:
     control-plane: controller-manager
-    app.kubernetes.io/name: mcg-adapter
+    app.kubernetes.io/name: objectbucket-notifications-adapter
   ports:
   - port: 8888
     targetPort: 8888