From 5de6bed193791cea8bc6e99e3d91c43b67e6ff07 Mon Sep 17 00:00:00 2001
From: adamkenihan <adam.kenihan@est.tech>
Date: Fri, 28 Jun 2024 11:11:43 +0100
Subject: [PATCH] Removal of user-defined mapping mentions

Signed-off-by: adamkenihan <adam.kenihan@est.tech>
---
 rfcs/NNNN-cdevents-provider/README.md | 16 ++++++----------
 1 file changed, 6 insertions(+), 10 deletions(-)

diff --git a/rfcs/NNNN-cdevents-provider/README.md b/rfcs/NNNN-cdevents-provider/README.md
index 28b60920..5f56e929 100644
--- a/rfcs/NNNN-cdevents-provider/README.md
+++ b/rfcs/NNNN-cdevents-provider/README.md
@@ -19,7 +19,7 @@ Must be one of `provisional`, `implementable`, `implemented`, `deferred`, `rejec
 
 This RFC proposes to add a `Provider` type to the Flux notification-controller API for sending [CDEvents](https://github.com/cdevents).
 
-When `Provider` objects configured to send CDEvents are alerted by a Flux event, they will utilise a user defined mapping of Flux and CDEvents events to send an appropriate CDEvent payload to a defined URL.
+When `Provider` objects configured to send CDEvents are alerted by a Flux event, they will utilise an already defined mapping of Flux and CDEvents events to send an appropriate CDEvent payload to a defined URL.
 <!--
 One paragraph explanation of the proposed feature or enhancement.
 -->
@@ -34,7 +34,7 @@ this RFC. Describe why the change is important and the benefits to users.
 
 ### Goals
 
-Integrate [CDEvents](https://github.com/cdevents) into Flux with a CDEvents Provider that supports user mapping of flux to CDEvent events.
+Integrate [CDEvents](https://github.com/cdevents) into Flux with a CDEvents Provider that supports sending CDEvent events.
 
 <!--
 List the specific goals of this RFC. What is it trying to achieve? How will we
@@ -52,7 +52,7 @@ and make progress.
 
 ## Proposal
 
-Add CDEvents to the list of available `Providers` in Flux Notification controller. The user should be able to create mappings within the configuration of the `Provider` that dictates the CDEvent payload to send depending on the Flux event that triggered the alert. These CDEvent payloads should have meaningful data from the source event. There will be an initial focus on HelmRelease and related events as the format within Flux for those events is much more consistent.
+Add CDEvents to the list of available `Providers` in Flux Notification controller. The relevant CDEvent sent by the `Provider` will be determined by a pre-defined mapping of Flux events and relevant CDEvents. These CDEvent payloads should have meaningful data from the source event. There will be an initial focus on HelmRelease and related events as the format within Flux for those events is much more consistent.
 <!--
 This is where we get down to the specifics of what the proposal actually is.
 This should have enough detail that reviewers can understand exactly what
@@ -67,7 +67,7 @@ then this section can be replaced with the actual documentation.
 
 Users of multiple CI/CD tools such as Tekton and Flux could use CDEvents as a way to enable interoperability.
 
-For example, a user may want a Tekton `pipeline` to run once a HelmRelease flux resource has succeeded in a Helm install. On successful helm install, Flux will emit an event with reason `InstallSucceeded` which the user will have mapped in their `Provider` configuration to correspond to an `Environment.Modified` CDEvent. The CDEvent `Provider` will then send a payload with that CDEvent, which will also contain data from the Flux event, to a CloudEvents broker that Tekton is subscribed to, and trigger a Pipeline Run within Tekton. 
+For example, a user may want a Tekton `pipeline` to run once a HelmRelease flux resource has succeeded in a Helm install. On successful helm install, Flux will emit an event with reason `InstallSucceeded` which will be mapped to an `Environment.Modified` CDEvent. The CDEvent `Provider` will then send a payload with that CDEvent, which will also contain data from the Flux event, to a CloudEvents broker that Tekton is subscribed to, and trigger a Pipeline Run within Tekton. 
 
 ![User Stories Tekton](user-stories-provider.drawio.png)
 
@@ -89,7 +89,7 @@ This is a good place to incorporate suggestions made during discussion of the RF
 
 Adding a Flux `Provider` for CDEvents that will send a CDEvent payload upon receiving a flux event from an alert. 
 
-The user will be able to define a Flux `Provider` custom resource and deploy it to their cluster. This provider configuration will allow the user to define a mapping of which Flux events correspond to which CDEvent to send. Once an alert is triggered for this provider, it will send the corresponding CDEvent, based on the Flux event that caused the alert. This CDEvent will be created using the [CDEvents Go SDK](https://github.com/cdevents/sdk-go). As well as the user-defined mapping, the provider will include some default mappings for Flux-Helm events in the case that the user does not provide a custom mapping.
+Once an alert is triggered for this provider, it will send a CDEvent that corresponds to the Flux event that caused the alert. This CDEvent will be created using the [CDEvents Go SDK](https://github.com/cdevents/sdk-go). The implementation will include a defined mapping of which Flux events trigger a corresponding CDEvent.
 
 The CDEvents broker is not a part of this design and is left to the users to set up however they wish.
 
@@ -102,14 +102,10 @@ metadata:
   name: cdevents-provider
   namespace: flux-system
 spec:
-  type: cdeventss
+  type: cdevents
   secretRef:
     name: generic-token
   address: http://10.100.0.17:5000
-  mapping: 
-    ReconciliationFinished: dev.cdevents.pipelinerun.finished
-    GitOperationFailed: dev.cdevents.incident.reported
-
 ```
 
 Example Default Mappings (Please note these are not final and will be open to discussion):