Skip to content

update(docs): update container readme #892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
poiana merged 2 commits into from
Jul 23, 2025
Merged

update(docs): update container readme #892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df98f5d
update(docs): updated container plugin readme.
FedeDP Jul 23, 2025
6521460
chore(plugins/container): properly cleanup fetchCh in test.
FedeDP Jul 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions plugins/container/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Container metadata enrichment Plugin

## Experimental

Consider this plugin as experimental until it reaches version `1.0.0`. By 'experimental' we mean that, although the plugin is functional and tested, it is currently in active development and may undergo changes in behavior as necessary, without prioritizing backward compatibility.

## Introduction

The `container` plugin enhances the Falco syscall source by providing additional information about container resources involved. You can find the comprehensive list of supported fields [here](#supported-fields).
Expand Down Expand Up @@ -124,6 +120,12 @@ Given that there is no "listener" SDK to attach to, for these engines the `async

### Configuration

By default, all engines are enabled on **default sockets**:
* Docker: [`/var/run/docker.sock`]
* Podman: [`/run/podman/podman.sock` for root, + `/run/user/$uid/podman/podman.sock` for each user in the system]
* Containerd: [`/run/host-containerd/containerd.sock`]
* Cri: [`/run/containerd/containerd.sock`, `/run/crio/crio.sock`, `/run/k3s/containerd/containerd.sock`, `/run/host-containerd/containerd.sock`]

Here's an example of configuration of `falco.yaml`:

```yaml
Expand Down Expand Up @@ -158,12 +160,6 @@ plugins:
load_plugins: [container]
```

By default, all engines are enabled on **default sockets**:
* Docker: `/var/run/docker.sock`
* Podman: `/run/podman/podman.sock` for root, + `/run/user/$uid/podman/podman.sock` for each user in the system
* Containerd: [`/run/containerd/containerd.sock`, `/run/k3s/containerd/containerd.sock`, `/run/host-containerd/containerd.sock`]
* Cri: `/run/crio/crio.sock`

### Rules

This plugin doesn't provide any custom rule, you can use the default Falco ruleset and add the necessary `container` fields.
Expand Down
4 changes: 4 additions & 0 deletions plugins/container/go-worker/pkg/container/fetcher_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ func testFetcher(t *testing.T, containerEngine Engine, containerId string, expec
containerEngines := []Engine{containerEngine}
fetchCh := make(chan string)
assert.NotNil(t, fetchCh)
t.Cleanup(func() {
close(fetchCh)
})

f := NewFetcherEngine(context.Background(), fetchCh, containerEngines)
assert.NotNil(t, f)

Expand Down
Loading