Skip to content

Commit bb8448b

Browse files
committed
Wrapping text on readme for readability
Signed-off-by: adamkenihan <[email protected]>
1 parent 5de6bed commit bb8448b

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

rfcs/NNNN-cdevents-provider/README.md

+21-7
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,29 @@ Must be one of `provisional`, `implementable`, `implemented`, `deferred`, `rejec
1717

1818
## Summary
1919

20-
This RFC proposes to add a `Provider` type to the Flux notification-controller API for sending [CDEvents](https://github.com/cdevents).
20+
This RFC proposes to add a `Provider` type to the Flux notification-controller API for sending
21+
[CDEvents](https://github.com/cdevents).
2122

22-
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.
23+
When `Provider` objects configured to send CDEvents are alerted by a Flux event, they will utilise an already defined
24+
mapping of Flux and CDEvents events to send an appropriate CDEvent payload to a defined URL.
2325
<!--
2426
One paragraph explanation of the proposed feature or enhancement.
2527
-->
2628

2729
## Motivation
2830

29-
CDEvents enables interoperability between supported tools in a workflow, and flux is a very popular continuous delivery tool, as such we have received many questions about implementing CDEvents into the tool. The receiver part of this integration is already implemented in flux 2.3.0
31+
CDEvents enables interoperability between supporte tools in a workflow, and flux is a very popular continuous delivery
32+
tool, as such we have received many questions about implementing CDEvents into the tool. The receiver part of this
33+
integration is already implemented in flux 2.3.0
3034
<!--
3135
This section is for explicitly listing the motivation, goals, and non-goals of
3236
this RFC. Describe why the change is important and the benefits to users.
3337
-->
3438

3539
### Goals
3640

37-
Integrate [CDEvents](https://github.com/cdevents) into Flux with a CDEvents Provider that supports sending CDEvent events.
41+
Integrate [CDEvents](https://github.com/cdevents) into Flux with a CDEvents Provider that supports sending CDEvent
42+
events.
3843

3944
<!--
4045
List the specific goals of this RFC. What is it trying to achieve? How will we
@@ -52,7 +57,10 @@ and make progress.
5257

5358
## Proposal
5459

55-
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.
60+
Add CDEvents to the list of available `Providers` in Flux Notification controller. The relevant CDEvent sent by the
61+
`Provider` will be determined by a pre-defined mapping of Flux events and relevant CDEvents. These CDEvent payloads
62+
should have meaningful data from the source event. There will be an initial focus on HelmRelease and related events as
63+
the format within Flux for those events is much more consistent.
5664
<!--
5765
This is where we get down to the specifics of what the proposal actually is.
5866
This should have enough detail that reviewers can understand exactly what
@@ -67,7 +75,11 @@ then this section can be replaced with the actual documentation.
6775

6876
Users of multiple CI/CD tools such as Tekton and Flux could use CDEvents as a way to enable interoperability.
6977

70-
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.
78+
For example, a user may want a Tekton `pipeline` to run once a HelmRelease flux resource has succeeded in a Helm
79+
install. On successful helm install, Flux will emit an event with reason `InstallSucceeded` which will be mapped to an
80+
`Environment.Modified` CDEvent. The CDEvent `Provider` will then send a payload with that CDEvent, which will also
81+
contain data from the Flux event, to a CloudEvents broker that Tekton is subscribed to, and trigger a Pipeline Run
82+
within Tekton.
7183

7284
![User Stories Tekton](user-stories-provider.drawio.png)
7385

@@ -89,7 +101,9 @@ This is a good place to incorporate suggestions made during discussion of the RF
89101

90102
Adding a Flux `Provider` for CDEvents that will send a CDEvent payload upon receiving a flux event from an alert.
91103

92-
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.
104+
Once an alert is triggered for this provider, it will send a CDEvent that corresponds to the Flux event that caused the
105+
alert. This CDEvent will be created using the [CDEvents Go SDK](https://github.com/cdevents/sdk-go). The implementation
106+
will include a defined mapping of which Flux events trigger a corresponding CDEvent.
93107

94108
The CDEvents broker is not a part of this design and is left to the users to set up however they wish.
95109

0 commit comments

Comments
 (0)