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

Commit 2005d07

Browse files
committed
#30 Only use one style for lists
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
1 parent 926004c commit 2005d07

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

docs/adr/adr_0001.adoc

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ The are two variants:
6464

6565
We could do a similar thing and introduce CRD which allows to execute "custom code" (generally speaking, depends on the second question) after a scan has completed (meaning both scan and parser phases are done). Some name ideas:
6666

67-
- `ScanHooks`
68-
- `ScanCompletionHooks`
69-
- `FindingProcessors`
67+
* `ScanHooks`
68+
* `ScanCompletionHooks`
69+
* `FindingProcessors`
7070

7171
These could be implemented with a `type` attribute, which declares if they are `ReadOnly` or `ReadAndWrite`.
7272

@@ -99,14 +99,14 @@ The Execution Flow would then look something like this:
9999

100100
**Pros:**
101101

102-
- Only one Implementation
103-
- Pretty Generic to expand and test out new ideas without having to modify the secureCodeBox Operator
102+
* Only one Implementation
103+
* Pretty Generic to expand and test out new ideas without having to modify the secureCodeBox Operator
104104

105105
**Cons:**
106106

107-
- Possible "over-abstraction"?
108-
- Need to refactor the ElasticSearch PersistenceProvider
109-
- The "General Implementation" will be harder than the individual ones
107+
* Possible "over-abstraction"?
108+
* Need to refactor the ElasticSearch PersistenceProvider
109+
* The "General Implementation" will be harder than the individual ones
110110

111111
==== Solution approach 1: Keep Split between Persistence Provider and MetaData Provider
112112

@@ -125,12 +125,12 @@ Keep PersistenceProvider as they are and introduce new "MetaDataProvider" CRD wh
125125

126126
**Pros:**
127127

128-
- Quicker to implement
129-
- Might be worth it to have a seperate concept for it
128+
* Quicker to implement
129+
* Might be worth it to have a seperate concept for it
130130

131131
**Cons:**
132132

133-
- Really worth introducing a new CRD for everything, especially when the are conceptually pretty close?
133+
* Really worth introducing a new CRD for everything, especially when the are conceptually pretty close?
134134

135135
=== Question 2: How should the execution model look like for each?
136136

@@ -211,6 +211,7 @@ The Phase 3 `DataProcessing` will be therefore splitt into to seperate phases na
211211
With the new `Hook Concept` we open the `DataProcessing` Phase 3 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 `persistenceProviders` and to 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 fare beyond the existing ones. 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.
212212

213213
Ideas for additional data processing hooks:
214+
214215
* Notifier-Hooks (ReadOnlyHook) e.g. for chat systems (slack, teams...) or metric / alerting systems
215216
* MetaData Enrichment Hooks (ReadAndWriteHook)
216217
* FilterData Hooks (e.g. false/positive Handling) (ReadAndWriteHook)

0 commit comments

Comments
 (0)