rename mcgobctrigger to objectbucketsource

Author: maschmid

PLAN

@@ -2,7 +2,7 @@ Multicloud Object Gateway Adapter (NooNaa)
 ==========================================
 
 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 MCGOBCTrigger custom resources.
+It will distribute the notifications received from NooBaa to individual triggers, according to the configuration specified by OBCSource 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)
 
@@ -58,26 +58,23 @@ calls put-bucket-notification for a bucket, it uses these values so that NooBaa
 knows where to deliver notifications (HTTP endpoint or Kafka topic, depending on
 NOTIFICATIONS_MODE).
 
-Internal MCG/NooBaa trigger CRD
--------------------------------
+ObjectBucketSource CRD
+----------------------------
 
-an example CR from the MCGOBCTrigger:
+an example CR from the ObjectBucketSource:
 ```
-apiVersion: internal.functions.dev/v1alpha1
-kind: MCGOBCTrigger
+apiVersion: sources.functions.dev/v1alpha1
+kind: ObjectBucketSource
 metadata:
   namespace: foobar
   name: foo
 spec:
-  obc:
+  objectBucketClaim:
     name: foo-bucket
   events:
   - "s3:ObjectCreated:*"
-  triggers:
-  - uri: http://foo.foobar.svc.cluster.local
-  - uri: http://logger.foobar.svc.cluster.local
-  - kafka:
-      topic: foo-topic
+  sink:
+    uri: http://foo.foobar.svc.cluster.local
 status:
   conditions:
   - type: OBCCredentialsAvailable
@@ -88,7 +85,25 @@ status:
     status: "True"
 ```
 
-Where "obc" is a reference to an ObjectBucketClaim (living in the same namespace as the MCGOBCTrigger), e.g.:
+As an alternative, uri can point to a Kafka Topic:
+```
+apiVersion: sources.functions.dev/v1alpha1
+kind: ObjectBucketSource
+metadata:
+  namespace: foobar
+  name: foo
+spec:
+  objectBucketClaim:
+    name: foo-bucket
+  events:
+  - "s3:ObjectCreated:*"
+  sink:
+    uri: kafka:foo-topic
+status:
+   ...
+```
+
+Where "objectBucketClaim" is a reference to an ObjectBucketClaim (living in the same namespace as the ObjectBucketSource), e.g.:
 
 
 ```
@@ -207,13 +222,13 @@ for each record, the dispatcher will match the bucket name and eventName and fin
 (dropping the "s3:" prefix, and matching '*' at the end of the specified event name as meaning any suffix (like in this case, "ObjectCreated:Put" matching the specified "s3:ObjectCreated:*")
 To each such trigger, it will send the list of records as a cloudevent (it will keep the same JSON structure of the original, including thje Records list, but will filter out records not matching the rules.)
 
-Multiple MCGOBCTrigger resources for the same bucket
+Multiple ObjectBucketSource resources for the same bucket
 ----------------------------------------------------
 
-When multiple MCGOBCTrigger CRs reference the same OBC (same bucket), the
+When multiple ObjectBucketSource CRs reference the same OBC (same bucket), the
 operator merges them internally into a single S3 bucket notification
 configuration. The merged configuration subscribes to the superset (union) of
-all event types requested across all MCGOBCTrigger CRs for that bucket.
+all event types requested across all ObjectBucketSource CRs for that bucket.
 
 For example, if trigger A subscribes to "s3:ObjectCreated:*" and trigger B
 subscribes to "s3:ObjectRemoved:*", the operator issues a single
@@ -222,28 +237,28 @@ put-bucket-notification call with Events: ["s3:ObjectCreated:*",
 
 When the adapter receives a notification from NooBaa, it filters the event
 internally before dispatching: each trigger URI only receives events matching
-the event types specified in its own MCGOBCTrigger CR. A trigger that subscribed
+the event types specified in its own ObjectBucketSource CR. A trigger that subscribed
 only to "s3:ObjectCreated:*" will never receive "s3:ObjectRemoved:*" events,
 even though the bucket-level notification is configured for both.
 
-When a MCGOBCTrigger CR is deleted or updated, the operator recomputes the
+When a ObjectBucketSource CR is deleted or updated, the operator recomputes the
 merged event set for the affected bucket. If the superset shrinks (i.e., no
 remaining CR needs a previously included event type), the operator updates the
-S3 bucket notification configuration accordingly. If no MCGOBCTrigger CRs
+S3 bucket notification configuration accordingly. If no ObjectBucketSource CRs
 remain for a bucket, the operator removes the bucket notification entirely
 
 
 Finalizer and cleanup on deletion
 ----------------------------------
 
-The operator adds a finalizer (e.g., "internal.functions.dev/mcgobctrigger") to
-each MCGOBCTrigger CR on creation. When a MCGOBCTrigger CR is deleted, the
+The operator adds a finalizer (e.g., "sources.functions.dev/objectbucketsource") to
+each ObjectBucketSource CR on creation. When a ObjectBucketSource CR is deleted, the
 finalizer ensures the operator has a chance to clean up before the resource is
 removed from the API server. During finalization, the operator recomputes the
 merged event set for the affected bucket (excluding the CR being deleted). If
-other MCGOBCTrigger CRs still reference the same bucket, the operator updates
+other ObjectBucketSource CRs still reference the same bucket, the operator updates
 the S3 bucket notification configuration with the reduced event set. If no
-MCGOBCTrigger CRs remain for the bucket, the operator removes the bucket
+ObjectBucketSource CRs remain for the bucket, the operator removes the bucket
 notification from NooBaa entirely. Once cleanup is complete, the operator removes
 the finalizer, allowing Kubernetes to garbage-collect the CR.
 
@@ -255,10 +270,10 @@ The adapter runs under a dedicated ServiceAccount. A ClusterRole grants the
 following permissions, bound via a ClusterRoleBinding:
 
 - ConfigMaps and Secrets: cluster-wide read access (get, list, watch). This is
-  required because MCGOBCTrigger CRs can exist in any namespace and the adapter
+  required because ObjectBucketSource CRs can exist in any namespace and the adapter
   needs to read the OBC-associated ConfigMap and Secret from each CR's namespace.
 
-- MCGOBCTrigger CRs (internal.functions.dev/v1alpha1): full access (get, list,
+- ObjectBucketSource CRs (sources.functions.dev/v1alpha1): full access (get, list,
   watch, create, update, patch, delete). The operator needs to watch for changes,
   update status conditions, and manage finalizers.
 

PROJECT

@@ -16,8 +16,8 @@ resources:
     namespaced: true
   controller: true
   domain: functions.dev
-  group: internal
-  kind: MCGOBCTrigger
+  group: sources
+  kind: ObjectBucketSource
   path: github.com/functions-dev/mcg-adapter/api/v1alpha1
   version: v1alpha1
 version: "3"

README.md

@@ -1,42 +1,39 @@
 # MCG Adapter
 
-A Kubernetes operator that receives S3 bucket notifications from NooBaa (Multicloud Object Gateway) and dispatches them as CloudEvents to configured trigger endpoints.
+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 `MCGOBCTrigger` 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 triggers and dispatches CloudEvents via HTTP or Kafka to the matching endpoints.
+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.
 
-## Custom Resource: MCGOBCTrigger
+## Custom Resource: ObjectBucketSource
 
 ```yaml
-apiVersion: internal.functions.dev/v1alpha1
-kind: MCGOBCTrigger
+apiVersion: sources.functions.dev/v1alpha1
+kind: ObjectBucketSource
 metadata:
   namespace: foobar
   name: foo
 spec:
-  obc:
+  objectBucketClaim:
     name: foo-bucket          # ObjectBucketClaim in the same namespace
   events:
   - "s3:ObjectCreated:*"      # S3 event types to subscribe to
-  triggers:
-  - uri: http://foo.foobar.svc.cluster.local
-  - uri: http://logger.foobar.svc.cluster.local
-  - kafka:
-      topic: foo-topic
+  sink:
+    uri: http://foo.foobar.svc.cluster.local
 ```
 
-Triggers can target HTTP endpoints (via `uri`) or Kafka topics (via `kafka.topic`). A single trigger entry can specify either or both. The Kafka broker(s) to connect to are configured globally via the `KAFKA_BROKERS` environment variable.
+The sink URI can be an HTTP endpoint or a Kafka topic reference (e.g. `kafka:foo-topic`). The Kafka broker(s) to connect to are configured globally via the `KAFKA_BROKERS` environment variable.
 
 The controller manages three status conditions:
 
 | Condition | Meaning |
 |---|---|
-| `OBCCredentialsAvailable` | The OBC’s ConfigMap and Secret exist with the expected keys |
+| `OBCCredentialsAvailable` | The OBC's ConfigMap and Secret exist with the expected keys |
 | `BucketNotificationSet` | The S3 bucket notification was configured in NooBaa |
 | `TestEventReceived` | The test event sent by NooBaa after notification setup was received |
 
-Multiple `MCGOBCTrigger` resources referencing the same OBC are merged into a single bucket notification configuration (union of event types). Each trigger only receives events matching its own subscription.
+Multiple `ObjectBucketSource` resources referencing the same OBC are merged into a single bucket notification configuration (union of event types). Each source only receives events matching its own subscription.
 
 ## Getting Started
 
@@ -57,7 +54,7 @@ The adapter is configured via environment variables:
 | `ADAPTER_TOPIC` | `mcg-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 triggers and when `NOTIFICATIONS_MODE=kafka`. |
+| `KAFKA_BROKERS` | _(none)_ | Comma-separated list of Kafka broker addresses. Required for Kafka sinks and when `NOTIFICATIONS_MODE=kafka`. |
 | `KAFKA_SECRET` | _(none)_ | Name of a Kubernetes Secret (in the adapter's namespace) containing Kafka credentials. See `kafka-secret-format.md`. |
 | `KAFKA_NOTIFICATIONS_TOPIC` | _(none)_ | Kafka topic to consume NooBaa notifications from. Required when `NOTIFICATIONS_MODE=kafka`. |
 | `KAFKA_NOTIFICATIONS_GROUP_ID` | _(none)_ | Consumer group ID for consuming NooBaa notifications. Required when `NOTIFICATIONS_MODE=kafka`. |
@@ -86,20 +83,20 @@ EOF
 
 ```sh
 existing_connections=$(oc get noobaa noobaa -n openshift-storage -o json \
-  | jq -c ‘.spec.bucketNotifications.connections // []’)
+  | jq -c '.spec.bucketNotifications.connections // []')
 
 updated_connections=$(echo "$existing_connections" | jq -c \
   --arg name "mcg-adapter-connection" \
-  ‘[.[] | select(.name != $name)] + [{"name": $name, "namespace": "openshift-storage"}]’)
+  '[.[] | select(.name != $name)] + [{"name": $name, "namespace": "openshift-storage"}]')
 
-oc patch noobaa noobaa --type=’merge’ -n openshift-storage -p ‘{
+oc patch noobaa noobaa --type='merge' -n openshift-storage -p '{
   "spec": {
     "bucketNotifications": {
-      "connections": ‘"${updated_connections}"’,
+      "connections": '"${updated_connections}"',
       "enabled": true
     }
   }
-}’
+}'
 ```
 
 ### NooBaa Connection Setup (Kafka mode)
@@ -111,7 +108,7 @@ Summary of the one-time setup:
 1. Create a `KafkaTopic` (e.g. `mcg-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`)
+4. Create a Kubernetes Secret in the adapter's namespace with the adapter's Kafka credentials (see `kafka-secret-format.md`)
 
 ### Deploy
 
@@ -159,4 +156,3 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-

api/v1alpha1/groupversion_info.go

@@ -14,9 +14,9 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package v1alpha1 contains API Schema definitions for the internal v1alpha1 API group.
+// Package v1alpha1 contains API Schema definitions for the sources v1alpha1 API group.
 // +kubebuilder:object:generate=true
-// +groupName=internal.functions.dev
+// +groupName=sources.functions.dev
 package v1alpha1
 
 import (
@@ -26,7 +26,7 @@ import (
 
 var (
 	// GroupVersion is group version used to register these objects.
-	GroupVersion = schema.GroupVersion{Group: "internal.functions.dev", Version: "v1alpha1"}
+	GroupVersion = schema.GroupVersion{Group: "sources.functions.dev", Version: "v1alpha1"}
 
 	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
 	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

api/v1alpha1/mcgobctrigger_types.go api/v1alpha1/objectbucketsource_types.goapi/v1alpha1/mcgobctrigger_types.go renamed to api/v1alpha1/objectbucketsource_types.go

@@ -25,62 +25,59 @@ const (
 	ConditionBucketNotificationSet   = "BucketNotificationSet"
 	ConditionTestEventReceived       = "TestEventReceived"
 
-	FinalizerName = "internal.functions.dev/mcgobctrigger"
+	FinalizerName = "sources.functions.dev/objectbucketsource"
 )
 
-// MCGOBCTriggerSpec defines the desired state of MCGOBCTrigger.
-type MCGOBCTriggerSpec struct {
-	// OBC is a reference to the ObjectBucketClaim in the same namespace.
-	OBC OBCReference `json:"obc"`
+// ObjectBucketSourceSpec defines the desired state of ObjectBucketSource.
+type ObjectBucketSourceSpec struct {
+	// ObjectBucketClaim is a reference to the ObjectBucketClaim in the same namespace.
+	ObjectBucketClaim OBCReference `json:"objectBucketClaim"`
 	// Events is the list of S3 event types to subscribe to (e.g. "s3:ObjectCreated:*").
 	Events []string `json:"events"`
-	// Triggers is the list of endpoints to dispatch matching CloudEvents to.
-	Triggers []TriggerTarget `json:"triggers"`
+	// Sink is the endpoint to dispatch matching CloudEvents to.
+	Sink SinkSpec `json:"sink"`
 }
 
 type OBCReference struct {
 	// Name of the ObjectBucketClaim in the same namespace.
 	Name string `json:"name"`
 }
 
-type TriggerTarget struct {
-	// URI is the absolute URL to send CloudEvents to via HTTP.
-	URI string `json:"uri,omitempty"`
-	// Kafka identifies a Kafka topic to send CloudEvents to.
-	Kafka *KafkaTrigger `json:"kafka,omitempty"`
+// SinkSpec defines the destination for CloudEvents. URI can be an HTTP URL
+// (e.g. "http://foo.bar.svc.cluster.local") or a Kafka topic reference
+// (e.g. "kafka:my-topic").
+type SinkSpec struct {
+	// URI is the destination to send CloudEvents to. Use an HTTP URL for
+	// HTTP delivery, or "kafka:<topic>" for Kafka delivery.
+	URI string `json:"uri"`
 }
 
-type KafkaTrigger struct {
-	// Topic is the Kafka topic to produce CloudEvents to.
-	Topic string `json:"topic"`
-}
-
-// MCGOBCTriggerStatus defines the observed state of MCGOBCTrigger.
-type MCGOBCTriggerStatus struct {
+// ObjectBucketSourceStatus defines the observed state of ObjectBucketSource.
+type ObjectBucketSourceStatus struct {
 	Conditions []metav1.Condition `json:"conditions,omitempty"`
 }
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
 
-// MCGOBCTrigger is the Schema for the mcgobctriggers API.
-type MCGOBCTrigger struct {
+// ObjectBucketSource is the Schema for the objectbucketsources API.
+type ObjectBucketSource struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   MCGOBCTriggerSpec   `json:"spec,omitempty"`
-	Status MCGOBCTriggerStatus `json:"status,omitempty"`
+	Spec   ObjectBucketSourceSpec   `json:"spec,omitempty"`
+	Status ObjectBucketSourceStatus `json:"status,omitempty"`
 }
 
 // +kubebuilder:object:root=true
 
-// MCGOBCTriggerList contains a list of MCGOBCTrigger.
-type MCGOBCTriggerList struct {
+// ObjectBucketSourceList contains a list of ObjectBucketSource.
+type ObjectBucketSourceList struct {
 	metav1.TypeMeta `json:",inline"`
 	metav1.ListMeta `json:"metadata,omitempty"`
-	Items           []MCGOBCTrigger `json:"items"`
+	Items           []ObjectBucketSource `json:"items"`
 }
 
 func init() {
-	SchemeBuilder.Register(&MCGOBCTrigger{}, &MCGOBCTriggerList{})
+	SchemeBuilder.Register(&ObjectBucketSource{}, &ObjectBucketSourceList{})
 }