You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 6, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: docs/architecture/12_glossary.md
+10
Original file line number
Diff line number
Diff line change
@@ -9,14 +9,20 @@ sidebar_position: 12
9
9
---
10
10
# Glossary {#section-glossary}
11
11
12
+
_API_: An [Application Programming Interface](https://en.wikipedia.org/wiki/Application_programming_interface) (API) is a computing interface which defines interactions between multiple software intermediaries.
13
+
12
14
_Charts_: Template files for [Helm][] to configure the deployment on [Kubernetes][k82].
_Container_: Concept for [OS-level virtualization][wiki-container].
17
19
20
+
_CRD_: Acronym for [Custom Ressource Definition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
21
+
18
22
_Custom Resource Definition (CRD)_: This is a [concept from Kubernetes][k8s-custom-resources] to define custom resource types additionally to the provided ones from Kubernetes.
19
23
24
+
_GUID_: Acronym for [Globally Unique Identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier).
25
+
20
26
_Hook_: A _hook_ is a concept in _secureCodeBox_ to give the opportunity to react on detected findings. _Hooks_ are invoked after parsing and storing the _Findings_. There are two kinds of _Hooks_: _ReadHooks_ and _ReadWriteHooks_. See the [_hooks_ documentation](/docs/hooks) for more details.
21
27
22
28
_Job_: A Job creates one or more Pods and will continue to retry execution of the Pods until a specified number of them successfully terminate. (see [official Kubernetes documentation][k82-job-doc].)
@@ -25,6 +31,8 @@ _Engine_: This is the central component of the _secureCodeBox_ which controls th
25
31
26
32
_Finding_: This is one single possible security issue found by a _scanner_ which is stored as [well-defined format](/docs/api/finding).
27
33
34
+
_K8S_: Acronym for [Kubernetes](https://kubernetes.io/docs/home/).
35
+
28
36
_Lurker_: This _sidecar_ is a generic component responsible to "lurk" the results spit out by _scanners_ and stores it into the _storage_ for further processing by the parser.
29
37
30
38
_Operator_: The [operator pattern][k82-operator] is a common pattern in Kubernetes to extend Kubernetes.
@@ -33,6 +41,8 @@ _Parser_: This _job_ is a _scanner_ specific component which reads the raw store
33
41
34
42
_Raw finding_: In contrast to _findings_ these are the raw results from the scanner before they were converted into the [well-defined format](/docs/api/finding) for findings.
35
43
44
+
_SCB_: Acronym for [secureCodeBox (This Project)](https://www.secureCodeBox.io).
45
+
36
46
_Scanner_: This is the main component to actually perform a scan. This is simply a container which encapsulates a scanner tool (e.g. nmap, nuclei etc.) and invokes it, parameterized by the _custom resource definition_ for this _scan type_.
37
47
38
48
_Scanner tool_: These are the command line tools we integrate into _secureCodeBox_ to perform the actual scan (e.g. Nmpa, Nuclei, Nikto, ZAP etc.).
0 commit comments