Skip to content

Commit

Permalink
doc: maintenance
Browse files Browse the repository at this point in the history
Signed-off-by: thediveo <[email protected]>
  • Loading branch information
thediveo committed Apr 22, 2024
1 parent ea86007 commit 20d9311
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 11 deletions.
11 changes: 6 additions & 5 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,11 +159,12 @@ container engine, such as the engine's `ID`, `Type` and `API` endpoint path.
## Turtle Finder

Gostwire's unique `turtlefinder.TurtleFinder` auto-detects container engines in
the process tree and then continously watches their container workload in the
background. Additionally, the hierarchy of container engines is detected, such
as when operating a container engine inside a container in case of [Kubernetes
in Docker (KinD)](https://github.com/kubernetes-sigs/kind).
Gostwire leverages the [turtlefinder](https://github.com/siemens/turtlefinder)
package to auto-detect container engines in the process tree and then
continously watching their container workload in the background. Additionally,
the hierarchy of container engines is detected, such as when operating a
container engine inside a container in case of [Kubernetes in Docker
(KinD)](https://github.com/kubernetes-sigs/kind).

The `TurtleFinder` implements the lxkns interface `containerizer.Containerizer`
with the logic to auto-detect container engine processes and then querying their
Expand Down
9 changes: 6 additions & 3 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ highly recommend at least kernel version 5.6 or later.
## Name and Mascot

The name "G(h)ostwire" sprang from the view of virtual (VETH) wires somehow
belonging to the (\*cough\*, _ethereal_) world of ghosts. As a nod to the
implementation language our mascot is a Go Gopher under a fake Ghost (Specte)
blanket.
belonging to the (&#42;_cough_&#42;,
[ethereal](https://www.wireshark.org/news/20060607.html)) world of ghosts. As a
nod to the implementation language our mascot is a Go Gopher under a fake Ghost
(Specte) blanket. [Spectre
v1](https://en.wikipedia.org/wiki/Spectre_(security_vulnerability)) might have
been influential, too.
7 changes: 4 additions & 3 deletions docs/terminology.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ The engine detection bases on daemon process names.

#### Detector

A Gostwire plugin that detects if a given process is a particular container
engine and then contacts its API for discovering the containers this particular
engine manages. The Detector plugin group name is `"turtlefinders"`.
A [turtlefinder](https://github.com/siemens/turtlefinder) plugin that detects if
a given process is a particular container engine and then contacts its API for
discovering the containers this particular engine manages. The Detector plugin
group name is `"turtlefinders"`.

0 comments on commit 20d9311

Please sign in to comment.