Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Sep 6, 2023. It is now read-only.

Commit 7d99db8

Browse files
WeltraumschafZero3141
authored andcommitted
#942 Incorporate glossary from main repo
Signed-off-by: Sven Strittmatter <[email protected]>
1 parent 5bb216e commit 7d99db8

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/architecture/12_glossary.md

+10
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,20 @@ sidebar_position: 12
99
---
1010
# Glossary {#section-glossary}
1111

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+
1214
_Charts_: Template files for [Helm][] to configure the deployment on [Kubernetes][k82].
1315

1416
_CI_: [Continuous Integration][wiki-Continuous-integration].
1517

1618
_Container_: Concept for [OS-level virtualization][wiki-container].
1719

20+
_CRD_: Acronym for [Custom Ressource Definition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
21+
1822
_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.
1923

24+
_GUID_: Acronym for [Globally Unique Identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier).
25+
2026
_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.
2127

2228
_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
2531

2632
_Finding_: This is one single possible security issue found by a _scanner_ which is stored as [well-defined format](/docs/api/finding).
2733

34+
_K8S_: Acronym for [Kubernetes](https://kubernetes.io/docs/home/).
35+
2836
_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.
2937

3038
_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
3341

3442
_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.
3543

44+
_SCB_: Acronym for [secureCodeBox (This Project)](https://www.secureCodeBox.io).
45+
3646
_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_.
3747

3848
_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

Comments
 (0)