-
Notifications
You must be signed in to change notification settings - Fork 201
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add a new section about the generator
Add a new section to "Explanation" about the generator behavior. Update netplan-generate(8) to mention the new generator behavior.
- Loading branch information
1 parent
2f848ac
commit 11fe6f2
Showing
3 changed files
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,12 @@ | |
structure-id | ||
``` | ||
|
||
## Netplan Generator | ||
|
||
```{toctree} | ||
generator | ||
``` | ||
|
||
## NetworkManager | ||
|
||
```{toctree} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
title: "Netplan Generator" | ||
--- | ||
|
||
Netplan uses a [systemd-generator](https://www.freedesktop.org/software/systemd/man/latest/systemd.generator.html) | ||
to emit network configuration at boot time. This generator is called very early during the boot | ||
process to ensure that all the configuration needed will be available for the back end | ||
the user chose to use. | ||
|
||
The generator executes the same tool used by the command `netplan generate`. One of the | ||
differences is that, when called as a systemd generator, parsing errors will be ignored by default. | ||
That means that errors in the configuration will not prevent Netplan to emit network configuration. | ||
When executed via the CLI, via `netplan generate` or `netplan apply` for example, errors will not | ||
be ignored and the user is encouraged to fix them, otherwise the commands will fail. | ||
|
||
When an error is ignored, Netplan might end up with network definitions that are not | ||
fully valid and incomplete. Users are advised to fix any issues present in their | ||
configuration to avoid having network connectivity problems. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters