Skip to content

Commit

Permalink
Switch to antsibull-docs for docs generation.
Browse files Browse the repository at this point in the history
  • Loading branch information
kpfleming committed Jun 25, 2023
1 parent 0f206f0 commit 98a9ae2
Show file tree
Hide file tree
Showing 25 changed files with 173 additions and 1,314 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.tox
*.tar.gz
src/galaxy.yml
src/roles/*/README.md
src/roles/*/vars/main.yml
docs
docs-build
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,8 +224,6 @@ Guide](https://docs.ansible.com/ansible/latest/community/index.html).

## More information

Role documentation generated using [ansible-role-docs](https://gitlab.com/kpfleming/ansible-role-docs).

- [Ansible Collection overview](https://github.com/ansible-collections/overview)
- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)
Expand Down
41 changes: 0 additions & 41 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
## Included content

* Roles:
- [kpfleming.systemd_networkd.bond](https://github.com/kpfleming/ansible-systemd-networkd/blob/main/src/roles/bond/README.md): manage bond virtual devices
- [kpfleming.systemd_networkd.dummy](https://github.com/kpfleming/ansible-systemd-networkd/blob/main/src/roles/dummy/README.md): manage dummy virtual devices
- [kpfleming.systemd_networkd.link](https://github.com/kpfleming/ansible-systemd-networkd/blob/main/src/roles/link/README.md): manage links
- [kpfleming.systemd_networkd.network](https://github.com/kpfleming/ansible-systemd-networkd/blob/main/src/roles/network/README.md): manage network devices
- [kpfleming.systemd_networkd.tunnel](https://github.com/kpfleming/ansible-systemd-networkd/blob/main/src/roles/tunnel/README.md): manage generic tunnel virtual devices
- [kpfleming.systemd_networkd.vlan](https://github.com/kpfleming/ansible-systemd-networkd/blob/main/src/roles/vlan/README.md): manage vlan virtual devices
- [kpfleming.systemd_networkd.wireguard](https://github.com/kpfleming/ansible-systemd-networkd/blob/main/src/roles/wireguard/README.md): manage WireGuard virtual devices

## Features of this collection

* Ansible-style arguments with extensive validation
Expand All @@ -35,23 +24,6 @@
In order to avoid multiple roles attempting to manage content in the same files, all of the roles make
use of the systemd-networkd 'drop-in directory' feature where it is applicable.

## Using this collection

In order to use this collection, you need to install it using the
`ansible-galaxy` CLI:

ansible-galaxy collection install kpfleming.systemd_networkd

You can also include it in a `requirements.yml` file and install it
via `ansible-galaxy collection install -r requirements.yml` using the
format:

```yaml
collections:
- name: kpfleming.systemd_networkd
```
See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
## Examples

This playbook example combines six of the roles in this collection. It features:
Expand Down Expand Up @@ -192,16 +164,3 @@ This playbook example combines six of the roles in this collection. It features:
routes:
- gateway: 2001:470:1f06:fab::1
```
## Contributing to this collection, or reporting issues
This collection is developed in
[this](https://github.com/kpfleming/ansible-systemd-networkd)
repository on GitHub. Issues can be reported in the [issue
tracker](https://github.com/kpfleming/ansible-systemd-networkd/issues).
## More information
Open Source software: [Apache License 2.0](https://spdx.org/licenses/Apache-2.0.html)
Role documentation generated using [ansible-role-docs](https://gitlab.com/kpfleming/ansible-role-docs).
156 changes: 0 additions & 156 deletions src/roles/bond/README.md

This file was deleted.

42 changes: 23 additions & 19 deletions src/roles/bond/meta/argument_specs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,32 @@
argument_specs:
main:
short_description: Manages systemd-networkd bonded network devices.
description: |
This role will create (or update) a number of items in /etc/systemd/network for
each specified bonded device:
1) A .netdev file for the bond device
2) .network files for each link that is a member of the bond; files will be named
with the bond device's name and a numeric suffix
3) .link files for each interface that is a member of the bond; files will be named
with the bond device's name and a numeric suffix
description:
- |
This role will create (or update) a number of items in /etc/systemd/network for
each specified bonded device:
1) A .netdev file for the bond device
2) .network files for each link that is a member of the bond; files will be named
with the bond device's name and a numeric suffix
3) .link files for each interface that is a member of the bond; files will be named
with the bond device's name and a numeric suffix
On Debian and Debian-derivative systems the .link files are
copied into the initramfs by the `update-initramfs` tool, which
means that the system must be rebooted for changes in those
files to take effect. In this situation the role will set a fact
named 'systemd_networkd_link_reboot_required' and the system
should be rebooted before any additional configuration of the
bonded network links is attempted.
- |
On Debian and Debian-derivative systems the .link files are
copied into the initramfs by the `update-initramfs` tool, which
means that the system must be rebooted for changes in those
files to take effect. In this situation the role will set a fact
named 'systemd_networkd_link_reboot_required' and the system
should be rebooted before any additional configuration of the
bonded network links is attempted.
Detailed descriptions of parameters and their behavior can be found in 'man systemd.netdev'
and 'man systemd.link'.
- |
Detailed descriptions of parameters and their behavior can be found in 'man systemd.netdev'
and 'man systemd.link'.
Sets fact named 'systemd_networkd_bond_changed' to either true or false to indicate whether
any changes were made.
- |
Sets fact named 'systemd_networkd_bond_changed' to either true or false to indicate whether
any changes were made.
options:
suppress_reload:
description: Suppress the reloading of systemd-networkd if changes are made.
Expand Down
79 changes: 0 additions & 79 deletions src/roles/dummy/README.md

This file was deleted.

12 changes: 7 additions & 5 deletions src/roles/dummy/meta/argument_specs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@
argument_specs:
main:
short_description: Manages systemd-networkd dummy virtual network devices.
description: |
This role will create (or update) one item in /etc/systemd/network for
each specified dummy: a .netdev file for the dummy device
description:
- |
This role will create (or update) one item in /etc/systemd/network for
each specified dummy: a .netdev file for the dummy device
Sets fact named 'systemd_networkd_dummy_changed' to either true or false to indicate whether
any changes were made.
- |
Sets fact named 'systemd_networkd_dummy_changed' to either true or false to indicate whether
any changes were made.
options:
suppress_reload:
description: Suppress the reloading of systemd-networkd if changes are made.
Expand Down
Loading

0 comments on commit 98a9ae2

Please sign in to comment.