Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linkdd/procfusion
Very simple process manager written in Rust for your Docker images
https://github.com/linkdd/procfusion
devops docker process-manager rust
Last synced: 3 days ago
JSON representation
Very simple process manager written in Rust for your Docker images
- Host: GitHub
- URL: https://github.com/linkdd/procfusion
- Owner: linkdd
- License: mit
- Created: 2024-05-15T12:58:40.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-14T17:05:42.000Z (4 months ago)
- Last Synced: 2025-02-03T15:52:38.889Z (10 days ago)
- Topics: devops, docker, process-manager, rust
- Language: Rust
- Homepage:
- Size: 32.2 KB
- Stars: 147
- Watchers: 6
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# ProcFusion
Very simple process manager for your Docker images.
## Introduction
One container, one application. That is the mantra we should follow when
designing a container based application.
However, one application can sometimes be split into multiple processes.
When that is the case, it can become challenging to manage those processes
within a Docker image.
Solutions like [supervisord](https://supervisord.org) can help, but they come
with their own quirks, for example:
- supervisord restart the child processes by default
- supervisord logs the child process's stdout/stderr to a file by default
- when redirected to stdout/stderr instead, the logs are mixed and not easily
filterable
Also, requiring Python in your Docker container can be a huge overhead,
especially if your application is not written in Python.
*ProcFusion* aims to solve this.
## Features
- start each child process in a process group
- if SIGINT/SIGTERM/SIGHUP is sent to *ProcFusion*, it forwards it to each
child process
- if a process exits (normally or not), *ProcFusion* sends SIGTERM to every
other child process, and exits with the exited process's exit code
- prefix stdout/stderr of each process with a deterministic label
## Comparison
| Feature | ProcFusion | [Supervisord](https://supervisord.org) | [s6-overlay](https://github.com/just-containers/s6-overlay) | [dumb-init](https://github.com/Yelp/dumb-init) |
| --- | --- | --- | --- | --- |
| Process Groups | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Forward signals | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Multiple children | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: |
| Dependency management | :x: | :x: | :white_check_mark: | :x: |
| Logs prefixing | :white_check_mark: | :x: | :x: | :x: |
| Configuration | TOML | INI-like | Service files | Command-line or as shebang |
| Language (not that it matters) | Rust | Python | Shell | C |
## Installation
```
$ cargo install --git https://github.com/linkdd/procfusion
```
Or download the archive from the
[latest release](https://github.com/linkdd/procfusion/releases/latest).
## Usage
*ProcFusion* expects its configuration as a TOML file:
```toml
[processes.foo]
command = "while true; do echo foo; sleep 1; done"
shell = "/bin/sh" # Wraps command in '/bin/sh -c'
directory = "/tmp" # Optional, defaults to $PWD
[processes.bar]
command = "while true; do echo bar; sleep 2; done"
shell = "/bin/sh"
[processes.baz]
command = "for i in 1 2; do echo baz; sleep 3; done; exit 1"
shell = "/bin/sh"
```
Then run:
```
$ procfusion path/to/config.toml
```
The example above will have the following output:
```
proc.foo[stdout] | foo: hello
proc.bar[stdout] | bar
proc.baz[stdout] | baz
proc.foo[stdout] | foo: hello
proc.bar[stdout] | bar
proc.foo[stdout] | foo: hello
proc.baz[stdout] | baz
proc.foo[stdout] | foo: hello
proc.bar[stdout] | bar
proc.foo[stdout] | foo: hello
proc.foo[stdout] | foo: hello
controller[stdout] | time=2024-05-15T12:18:50.247868783Z message="baz exited with exit status: 1"
controller[stdout] | time=2024-05-15T12:18:50.248983822Z message="bar exited with signal: 15 (SIGTERM)"
controller[stdout] | time=2024-05-15T12:18:50.249275312Z message="foo exited with signal: 15 (SIGTERM)"
```
> **NB:** Environment variables are inherited from the *ProcFusion* process.
## License
This software is distributed under the terms of the
[MIT License](./LICENSE.txt).