ifupdown-ng/README.md

34 lines
1.2 KiB
Markdown

# ifupdown-ng
ifupdown-ng is a network device manager that is largely compatible with Debian
ifupdown, BusyBox ifupdown and Cumulus Networks' ifupdown2.
## Dependency Resolution
![Dependency resolution example](doc/img/dependency-resolution.png)
ifupdown-ng uses a dependency resolver to determine interface bring-up order
in a deterministic way. To use this feature, you must declare relationships
between interfaces with the `requires` keyword. This keeps the implementation
efficient. For convenience, the `requires` keyword is exported to executors
as the `IF_REQUIRES` environment variable.
For compatibility with some legacy ifupdown executors, we also provide the
`requires` keyword under other environment variables in some cases.
## Caveats
* ifupdown2 python plugins are not supported at this time. An executor could be
written to handle them.
* ifupdown-ng retains compatibility with /etc/network/if-X.d scripts, but will
prefer using executors in /usr/libexec/ifupdown-ng where appropriate.
## Building
Simply do `make` and `make install` to build and install.
To run the tests, do `make check`.
To build the documentation, do `make docs` and `make install_docs`. Building
the documentation requires scdoc (`apk add scdoc`).