Skip to content

Commit d7584d9

Browse files
doc: contd documentation
1 parent 4b6652c commit d7584d9

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

docs/cmds/contd.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Contd
2+
3+
Container module is reponsible for handling starting, stoppping and inspecting of containers.
4+
5+
Contd provides the entrypoint of the contd module, exposing it as a service over the message bus (zbus) so that other modules can handle the containers.
6+
7+
## How it works
8+
9+
- Ensure that `shim-logs` binary is available, backoff until it's found.
10+
- Creates module root dirctory.
11+
- Connects to `Redis` message broker over `zbus`.
12+
- Register itself as a `containerd` module.
13+
- Starts watching for events coming from `containerd`.
14+
15+
16+
## Usage
17+
18+
```sh
19+
contd --root /var/cache/modules/contd \
20+
> --broker unix:///var/run/redis.sock \
21+
> --congainerd /run/containerd/containerd.sock \
22+
> --workers 2
23+
```
24+
25+
### Command-line flags
26+
27+
| Flag | Description | Default |
28+
| ----------- | ------------------------------------------------| ---------------------------- |
29+
| `--root` | `ROOT` working directory of the module | `/var/cache/modules/contd` |
30+
| `--broker` | Connection string to the message BROKER | `unix:///var/run/redis.sock` |
31+
| `--congainerd` | connection string to containerd `CONTAINERD` | `/run/containerd/containerd.sock` |
32+
| `--workers` | Number of workers N | `1` |

0 commit comments

Comments
 (0)