decorator

package
v2.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 10, 2024 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package decorator defines the plugin interface for Gostwire decorators that post-process the discovered Gostwire information model and add usefully information. Gostwire decorators differ from lxkns decorators in that Gostwire decorators get specific detail information about the discovered network namespaces (such as network interfaces and their relationships, network addresses, and much more) in addition to the containers discovered.

Please note that not all sub-packages are Gostwire decorators; for instance, the “ieappicon” decorator is a plain lxkns decorator instead.

The plugin architecture allows to add more decorators easily, either to the Gostwire code or in applications leveraging the Gostwire discovery engine.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Decorate

type Decorate func(
	ctx context.Context,
	allnetns network.NetworkNamespaces,
	allprocs model.ProcessTable,
	engines []*model.ContainerEngine,
)

Decorate is called after the core discovery of network namespaces as well as network interfaces configuration and relations has finished, so decorators can post-process the information model. As at least some decorators might need to run engine queries any decoration post-processing can be time-boxed by passing a suitable Context.

Directories

Path Synopsis
Package all pulls in all Gostwire decorators (plugins).
Package all pulls in all Gostwire decorators (plugins).
Package dockernet implements a Gostwire decorator that discovers Docker-managed networks and then decorates their corresponding Linux-kernel network interfaces.
Package dockernet implements a Gostwire decorator that discovers Docker-managed networks and then decorates their corresponding Linux-kernel network interfaces.
Package dockerproxy implements port forwarding detection based on Docker's docker-proxy processes.
Package dockerproxy implements port forwarding detection based on Docker's docker-proxy processes.
Package ieappicon implements a Gostwire decorator for adorning containers belonging to Industrial Edge app composer projects with their app icons.
Package ieappicon implements a Gostwire decorator for adorning containers belonging to Industrial Edge app composer projects with their app icons.
Package nerdctlnet implements a Gostwire decorator that discovers nerdctl-managed CNI networks and then decorates their corresponding network interfaces.
Package nerdctlnet implements a Gostwire decorator that discovers nerdctl-managed CNI networks and then decorates their corresponding network interfaces.
Package podmannet implements a Gostwire decorator that discovers podman (v4+) managed networks and then decorates their corresponding Linux-kernel network interfaces.
Package podmannet implements a Gostwire decorator that discovers podman (v4+) managed networks and then decorates their corresponding Linux-kernel network interfaces.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL