Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit bbf9973

Browse files
committed
#30 Simplify name ofphase three as sugested
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
1 parent fd54f57 commit bbf9973

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/adr/adr_0001.adoc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -181,17 +181,16 @@ Analog to kubernetes webhooks: HTTP server receiving findings and returning resu
181181

182182
== Decision
183183

184-
Regarding question 1 it seems that both solution approaches are resulting in the same execution model. We decided to implement solution approach 1 and unify both concepts into a more general concept with the name _hook concept_. Therefore we exchange the existing name _PersistenceProvider_ for phase 3 in the execution model with a more general term _DataProcessing_:
184+
Regarding question 1 it seems that both solution approaches are resulting in the same execution model. We decided to implement solution approach 1 and unify both concepts into a more general concept with the name _hook concept_. Therefore we exchange the existing name _PersistenceProvider_ for phase 3 in the execution model with a more general term _processing_:
185185

186-
// #30 I suggest the term "processing" instead of data processing/
187186
....
188187
┌──────────────────┐ ┌──────────────────┐ ┌──────────────────┐
189-
│ scanning ├─────────▶│ parsing ├─────────▶│ data processing │
188+
│ scanning ├─────────▶│ parsing ├─────────▶│ processing
190189
│ (Phase 1) │ │ (Phase 2) │ │ (Phase 3) │
191190
└──────────────────┘ └──────────────────┘ └──────────────────┘
192191
....
193192

194-
Regarding question 2 we decided to implement the solution approach 1 with a job-based approach (no active service component needed). Therefore the phase 3 _data processing_ will be split into two separate phases named _ReadAndWriteHooks_ (3.1) and _ReadOnlyHooks_ (3.2)
193+
Regarding question 2 we decided to implement the solution approach 1 with a job-based approach (no active service component needed). Therefore the phase 3 _processing_ will be split into two separate phases named _ReadAndWriteHooks_ (3.1) and _ReadOnlyHooks_ (3.2)
195194
// #30 to what refers 3.1 and 3.2?
196195

197196
....
@@ -207,9 +206,9 @@ Regarding question 2 we decided to implement the solution approach 1 with a job-
207206

208207
== Consequences
209208

210-
With the new _hook concept_ we open the _phase 3 data processing_ to a more intuitive and flexible architecture. It is easier to understand because _WebHooks_ are already a well known concept. It is possible to keep the existing implementation of the _PersistenceProvider_ and integrate them with a lot of other possible data processing components in a more general fashion. In the end, this step will result in a lot of additional feature possibilities, which go far beyond the existing ones proposed here. Therefore we only need to implement this concept once in the _secureCodeBox operator_ and new ideas for extending the _DataProcessing_ will not enforce conceptual or architectural changes.
209+
With the new _hook concept_ we open the _phase 3 processing_ to a more intuitive and flexible architecture. It is easier to understand because _WebHooks_ are already a well known concept. It is possible to keep the existing implementation of the _PersistenceProvider_ and integrate them with a lot of other possible processing components in a more general fashion. In the end, this step will result in a lot of additional feature possibilities, which go far beyond the existing ones proposed here. Therefore we only need to implement this concept once in the _secureCodeBox operator_ and new ideas for extending the _DataProcessing_ will not enforce conceptual or architectural changes.
211210

212-
Ideas for additional data processing hooks:
211+
Ideas for additional processing hooks:
213212

214213
* Notifier hooks (_ReadOnlyHook_) e.g., for chat (slack, teams etc.), metric, alerting systems
215214
* MetaData enrichment hooks (_ReadAndWriteHook_)

0 commit comments

Comments
 (0)