https://github.com/canonical/netplan
Declarative network configuration for various backends
https://github.com/canonical/netplan
abstraction configuration declarative network yaml
Last synced: 1 day ago
JSON representation
Declarative network configuration for various backends
- Host: GitHub
- URL: https://github.com/canonical/netplan
- Owner: canonical
- License: gpl-3.0
- Created: 2018-01-24T22:22:14.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T09:54:32.000Z (about 1 month ago)
- Last Synced: 2025-04-25T14:12:37.236Z (20 days ago)
- Topics: abstraction, configuration, declarative, network, yaml
- Language: Python
- Homepage: https://netplan.io
- Size: 3.99 MB
- Stars: 767
- Watchers: 28
- Forks: 214
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING
- License: COPYING
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Netplan - Declarative network configuration for various backends
[](https://github.com/canonical/netplan/actions/workflows/build-abi.yml?query=branch%3Amain)
[](https://github.com/canonical/netplan/actions/workflows/check-coverage.yml?query=branch%3Amain)
[](https://github.com/canonical/netplan/actions/workflows/autopkgtest.yml?query=branch%3Amain)
# Website
http://netplan.io
# Documentation
An overview of the architecture can be found at [netplan.io/design](https://netplan.io/design)
Find the full [documentation for Netplan](https://netplan.readthedocs.io) on "Read the Docs".
To contribute documentation, these steps should get you started:
1. Fork and clone the repo:
```
git clone [email protected]:your_user_name/netplan.git
```
2. Create a new branch:
```
git checkout -b
```
3. Navigate to the `doc/` directory and make your contribution:
```
cd doc
```
4. View your documentation in the browser by running the `make` command from within the `doc/` directory:
```
make run
```
5. Test your contribution to ensure good quality.
6. Push your contribution to GitHub and create a pull request.
If you face issues, refer to our [comprehensive contribution guide](https://netplan.readthedocs.io/en/stable/contribute-docs/).
# Build using Meson
Steps to build Netplan using the [Meson](https://mesonbuild.com) build system inside the `build/` directory:
* meson setup build --prefix=/usr [-Db_coverage=true]
* meson compile -C build
* meson test -C build --verbose [TEST_NAME]
* meson install -C build --destdir ../tmproot
# Bug reports
Please file bug reports in [Launchpad](https://bugs.launchpad.net/netplan/+filebug).
# Contact us
Please join us on [IRC in #netplan](https://web.libera.chat/gamja/?channels=%23netplan) at Libera.Chat.
Our mailing list is [here](https://lists.launchpad.net/netplan-developers/).
Email the list at [[email protected]](mailto:[email protected]).