From 9ca89854ec4e416a30d09c087a7143a64bcc1bbb Mon Sep 17 00:00:00 2001 From: Sarah Allen Date: Wed, 18 Apr 2018 09:34:01 -0700 Subject: [PATCH 1/7] add link to CloudEvents repo --- roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roadmap.md b/roadmap.md index 8345030482a..c2b427d3876 100644 --- a/roadmap.md +++ b/roadmap.md @@ -6,7 +6,7 @@ A. Ability to register an event sources and specify which events may be generate B. kubctl command to set up a trigger where a specific event will cause a specific action C. Example source generating an event D. Example action -E. Events conform to CloudEvent 0.1 specification +E. Events conform to [CloudEvents](https://github.com/cloudevents/spec) 0.1 specification # 0.2 From 48f0f6a0efdf9bdb0fb8601671eb86cc59c485b9 Mon Sep 17 00:00:00 2001 From: Sarah Allen Date: Thu, 26 Apr 2018 07:51:29 -0700 Subject: [PATCH 2/7] integrated feedback from PR comments --- roadmap.md | 46 ++++++++++++++++++++++++++++++++++++---------- 1 file changed, 36 insertions(+), 10 deletions(-) diff --git a/roadmap.md b/roadmap.md index c2b427d3876..3949739a476 100644 --- a/roadmap.md +++ b/roadmap.md @@ -1,22 +1,48 @@ Eventing Roadmap -# 0.1 +At the end of each milestone, there should be a new or updated demo in +the samples directory. -A. Ability to register an event sources and specify which events may be generated from that source [Proposal](https://github.com/elafros/eventing/issues/39) -B. kubctl command to set up a trigger where a specific event will cause a specific action +# 0.1 CloudEvents Demo + +A. Ability to register an event sources and specify which events may be + generated from that source + [Proposal](https://github.com/elafros/eventing/issues/39) +B. kubctl command to set up a trigger where a specific event will cause a + specific action powered by a specific processor C. Example source generating an event D. Example action -E. Events conform to [CloudEvents](https://github.com/cloudevents/spec) 0.1 specification +E. Events conform to [CloudEvents](https://github.com/cloudevents/spec) + 0.1 specification + +# 0.2 Friendly Repo + +A. Easy installation [issue#51](https://github.com/elafros/eventing/issues/51) +B. We have clear guidelines for how we use Prow +C. All the contributing info is tested and someone new to the repo has made a + PR by following the directions + +# 0.3 Functions + +A. An event can trigger an Elafros function [issue#52](https://github.com/elafros/eventing/issues/52) +B. A local event can trigger a Google Cloud Function +C. A Google source can trigger a local action. Likely this will use some + scaffolding on the Google side to validate the interaction between systems, + such as deploying a Cloud Function that forwards the Google Event to the + Elafros cluster. -# 0.2 +# 0.4 Event Persistence -A. A local event can trigger a Google Cloud Function -B. A Google source can trigger a local action +A. Failed event handling can be retried +B. An Event Source can be added to a cluster without recompile +C. There is a well-defined interface that allows the use of popular event + brokers for persistence, such as Kafka and Rabbit Mq -# 0.3 +# 0.5 Piplelines A. Pipeline the output of one action into the input of another -# 0.4 +# 0.6 Streams -A. an action may accept a stream interface to process many events at once \ No newline at end of file +A. an action may accept a stream interface to process many events at once +B. Events are delivered in order From 330294d5c36409167e8e5d222e5460e651098499 Mon Sep 17 00:00:00 2001 From: Sarah Allen Date: Fri, 27 Apr 2018 18:49:26 -0700 Subject: [PATCH 3/7] fix formatting --- roadmap.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/roadmap.md b/roadmap.md index 3949739a476..e270c52c29a 100644 --- a/roadmap.md +++ b/roadmap.md @@ -5,44 +5,44 @@ the samples directory. # 0.1 CloudEvents Demo -A. Ability to register an event sources and specify which events may be +* A. Ability to register an event sources and specify which events may be generated from that source [Proposal](https://github.com/elafros/eventing/issues/39) -B. kubctl command to set up a trigger where a specific event will cause a +* B. kubctl command to set up a trigger where a specific event will cause a specific action powered by a specific processor -C. Example source generating an event -D. Example action -E. Events conform to [CloudEvents](https://github.com/cloudevents/spec) +* C. Example source generating an event +* D. Example action +* E. Events conform to [CloudEvents](https://github.com/cloudevents/spec) 0.1 specification # 0.2 Friendly Repo -A. Easy installation [issue#51](https://github.com/elafros/eventing/issues/51) -B. We have clear guidelines for how we use Prow -C. All the contributing info is tested and someone new to the repo has made a +* A. Easy installation [issue#51](https://github.com/elafros/eventing/issues/51) +* B. We have clear guidelines for how we use Prow +* C. All the contributing info is tested and someone new to the repo has made a PR by following the directions # 0.3 Functions -A. An event can trigger an Elafros function [issue#52](https://github.com/elafros/eventing/issues/52) -B. A local event can trigger a Google Cloud Function -C. A Google source can trigger a local action. Likely this will use some +* A. An event can trigger an Elafros function [issue#52](https://github.com/elafros/eventing/issues/52) +* B. A local event can trigger a Google Cloud Function +* C. A Google source can trigger a local action. Likely this will use some scaffolding on the Google side to validate the interaction between systems, such as deploying a Cloud Function that forwards the Google Event to the Elafros cluster. # 0.4 Event Persistence -A. Failed event handling can be retried -B. An Event Source can be added to a cluster without recompile -C. There is a well-defined interface that allows the use of popular event +* A. Failed event handling can be retried +* B. An Event Source can be added to a cluster without recompile +* C. There is a well-defined interface that allows the use of popular event brokers for persistence, such as Kafka and Rabbit Mq # 0.5 Piplelines -A. Pipeline the output of one action into the input of another +* A. Pipeline the output of one action into the input of another # 0.6 Streams -A. an action may accept a stream interface to process many events at once -B. Events are delivered in order +* A. an action may accept a stream interface to process many events at once +* B. Events are delivered in order From 88fbf3684dfeb41bbeda9ec60caf5f98cd8684a2 Mon Sep 17 00:00:00 2001 From: Rachel Myers Date: Tue, 1 May 2018 12:59:07 +0100 Subject: [PATCH 4/7] Bullets and letters to auto incremented numbers --- roadmap.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/roadmap.md b/roadmap.md index e270c52c29a..6a3e339aa64 100644 --- a/roadmap.md +++ b/roadmap.md @@ -5,44 +5,44 @@ the samples directory. # 0.1 CloudEvents Demo -* A. Ability to register an event sources and specify which events may be +1. Ability to register an event sources and specify which events may be generated from that source [Proposal](https://github.com/elafros/eventing/issues/39) -* B. kubctl command to set up a trigger where a specific event will cause a +1. kubctl command to set up a trigger where a specific event will cause a specific action powered by a specific processor -* C. Example source generating an event -* D. Example action -* E. Events conform to [CloudEvents](https://github.com/cloudevents/spec) +1. Example source generating an event +1. Example action +1. Events conform to [CloudEvents](https://github.com/cloudevents/spec) 0.1 specification # 0.2 Friendly Repo -* A. Easy installation [issue#51](https://github.com/elafros/eventing/issues/51) -* B. We have clear guidelines for how we use Prow -* C. All the contributing info is tested and someone new to the repo has made a +1. Easy installation [issue#51](https://github.com/elafros/eventing/issues/51) +1. We have clear guidelines for how we use Prow +1. All the contributing info is tested and someone new to the repo has made a PR by following the directions # 0.3 Functions -* A. An event can trigger an Elafros function [issue#52](https://github.com/elafros/eventing/issues/52) -* B. A local event can trigger a Google Cloud Function -* C. A Google source can trigger a local action. Likely this will use some +1. An event can trigger an Elafros function [issue#52](https://github.com/elafros/eventing/issues/52) +1. A local event can trigger a Google Cloud Function +1. A Google source can trigger a local action. Likely this will use some scaffolding on the Google side to validate the interaction between systems, such as deploying a Cloud Function that forwards the Google Event to the Elafros cluster. # 0.4 Event Persistence -* A. Failed event handling can be retried -* B. An Event Source can be added to a cluster without recompile -* C. There is a well-defined interface that allows the use of popular event +1. Failed event handling can be retried +1. An Event Source can be added to a cluster without recompile +1. There is a well-defined interface that allows the use of popular event brokers for persistence, such as Kafka and Rabbit Mq # 0.5 Piplelines -* A. Pipeline the output of one action into the input of another +1. Pipeline the output of one action into the input of another # 0.6 Streams -* A. an action may accept a stream interface to process many events at once -* B. Events are delivered in order +1. an action may accept a stream interface to process many events at once +1. Events are delivered in order From 113a57dc86d8017ff2a206c695d46afbba4db4ae Mon Sep 17 00:00:00 2001 From: Rachel Myers Date: Tue, 1 May 2018 13:00:16 +0100 Subject: [PATCH 5/7] s/kubctl/kubectl --- roadmap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roadmap.md b/roadmap.md index 6a3e339aa64..cdd6128f7fe 100644 --- a/roadmap.md +++ b/roadmap.md @@ -8,7 +8,7 @@ the samples directory. 1. Ability to register an event sources and specify which events may be generated from that source [Proposal](https://github.com/elafros/eventing/issues/39) -1. kubctl command to set up a trigger where a specific event will cause a +1. kubectl command to set up a trigger where a specific event will cause a specific action powered by a specific processor 1. Example source generating an event 1. Example action From 4a52472cd2ae4287fb6066edcf9c5480037ced3a Mon Sep 17 00:00:00 2001 From: Rachel Myers Date: Tue, 1 May 2018 13:02:43 +0100 Subject: [PATCH 6/7] Specify that local is within the Elafros cluster --- roadmap.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/roadmap.md b/roadmap.md index cdd6128f7fe..9655e986340 100644 --- a/roadmap.md +++ b/roadmap.md @@ -26,10 +26,10 @@ the samples directory. 1. An event can trigger an Elafros function [issue#52](https://github.com/elafros/eventing/issues/52) 1. A local event can trigger a Google Cloud Function -1. A Google source can trigger a local action. Likely this will use some - scaffolding on the Google side to validate the interaction between systems, - such as deploying a Cloud Function that forwards the Google Event to the - Elafros cluster. +1. A Google source can trigger an action local within the Elafros cluster. + Likely this will use some scaffolding on the Google side to validate the + interaction between systems, such as deploying a Cloud Function that + forwards the Google Event to the Elafros cluster. # 0.4 Event Persistence From 5b66d11f850f2dcdbcee56ea80f6ee175fd7494c Mon Sep 17 00:00:00 2001 From: Sarah Allen Date: Tue, 15 May 2018 17:57:48 -0700 Subject: [PATCH 7/7] address feedback, clarifying roadmap language + typos --- roadmap.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/roadmap.md b/roadmap.md index 9655e986340..6b1f8e1bc36 100644 --- a/roadmap.md +++ b/roadmap.md @@ -1,48 +1,50 @@ -Eventing Roadmap +# Eventing Roadmap -At the end of each milestone, there should be a new or updated demo in -the samples directory. +At the end of each milestone, there should be a new or updated demo linked from +the [README](README.md). -# 0.1 CloudEvents Demo +## 0.1 CloudEvents Demo 1. Ability to register an event sources and specify which events may be generated from that source [Proposal](https://github.com/elafros/eventing/issues/39) 1. kubectl command to set up a trigger where a specific event will cause a - specific action powered by a specific processor + specific action 1. Example source generating an event 1. Example action 1. Events conform to [CloudEvents](https://github.com/cloudevents/spec) 0.1 specification -# 0.2 Friendly Repo +## 0.2 Friendly Repo 1. Easy installation [issue#51](https://github.com/elafros/eventing/issues/51) 1. We have clear guidelines for how we use Prow 1. All the contributing info is tested and someone new to the repo has made a PR by following the directions -# 0.3 Functions +## 0.3 Functions 1. An event can trigger an Elafros function [issue#52](https://github.com/elafros/eventing/issues/52) 1. A local event can trigger a Google Cloud Function -1. A Google source can trigger an action local within the Elafros cluster. +1. A Google source can trigger an action local within the Elafros cluster. Likely this will use some scaffolding on the Google side to validate the - interaction between systems, such as deploying a Cloud Function that + interaction between systems, such as deploying a Cloud Function that forwards the Google Event to the Elafros cluster. -# 0.4 Event Persistence +## 0.4 Event Persistence +1. Events can be stored in a buffer / queue 1. Failed event handling can be retried 1. An Event Source can be added to a cluster without recompile 1. There is a well-defined interface that allows the use of popular event brokers for persistence, such as Kafka and Rabbit Mq -# 0.5 Piplelines +## 0.5 Pipelines 1. Pipeline the output of one action into the input of another +1. Pipelines can be a series of Functions -# 0.6 Streams +## 0.6 Streams 1. an action may accept a stream interface to process many events at once 1. Events are delivered in order