From 20d931105cdf36ba3c693587aa9fee509e75c66e Mon Sep 17 00:00:00 2001 From: thediveo Date: Mon, 22 Apr 2024 20:21:11 +0200 Subject: [PATCH] doc: maintenance Signed-off-by: thediveo --- docs/architecture.md | 11 ++++++----- docs/introduction.md | 9 ++++++--- docs/terminology.md | 7 ++++--- 3 files changed, 16 insertions(+), 11 deletions(-) diff --git a/docs/architecture.md b/docs/architecture.md index dbc2d24..93a42b9 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -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 diff --git a/docs/introduction.md b/docs/introduction.md index 6e30e62..afd99a4 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -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 (*_cough_*, +[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. diff --git a/docs/terminology.md b/docs/terminology.md index 02e3e38..f4cd2fc 100644 --- a/docs/terminology.md +++ b/docs/terminology.md @@ -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"`.