From eaeab956c126306712f710169fcc51a2c9637cd0 Mon Sep 17 00:00:00 2001 From: uumas Date: Fri, 8 Nov 2024 03:50:06 +0200 Subject: [PATCH] Generate readmes --- roles/container/README.md | 1 + roles/container/meta/argument_specs.yaml | 2 +- roles/network/README.md | 1 + roles/network/meta/argument_specs.yaml | 2 +- roles/podman/README.md | 1 + roles/podman/meta/argument_specs.yaml | 2 +- roles/service/README.md | 1 + roles/service/meta/argument_specs.yaml | 2 +- 8 files changed, 8 insertions(+), 4 deletions(-) create mode 100644 roles/container/README.md create mode 100644 roles/network/README.md create mode 100644 roles/podman/README.md create mode 100644 roles/service/README.md diff --git a/roles/container/README.md b/roles/container/README.md new file mode 100644 index 0000000..52633ec --- /dev/null +++ b/roles/container/README.md @@ -0,0 +1 @@ +Sets up podman container with systemd units (quadlet) diff --git a/roles/container/meta/argument_specs.yaml b/roles/container/meta/argument_specs.yaml index 1d6dc81..7be4e42 100644 --- a/roles/container/meta/argument_specs.yaml +++ b/roles/container/meta/argument_specs.yaml @@ -1,7 +1,7 @@ --- argument_specs: main: - short_description: Sets up podman container with systemd units (quadlet) + description: Sets up podman container with systemd units (quadlet) options: container_name: description: Name of the container. Must be unique within a host. diff --git a/roles/network/README.md b/roles/network/README.md new file mode 100644 index 0000000..7adb4a1 --- /dev/null +++ b/roles/network/README.md @@ -0,0 +1 @@ +Sets up podman network with systemd unit (quadlet) diff --git a/roles/network/meta/argument_specs.yaml b/roles/network/meta/argument_specs.yaml index 66aea6c..d828eb9 100644 --- a/roles/network/meta/argument_specs.yaml +++ b/roles/network/meta/argument_specs.yaml @@ -1,7 +1,7 @@ --- argument_specs: main: - short_description: Sets up podman network with systemd unit (quadlet) + description: Sets up podman network with systemd unit (quadlet) options: network_name: description: Name of the network. Must be unique within a host. diff --git a/roles/podman/README.md b/roles/podman/README.md new file mode 100644 index 0000000..92c29c3 --- /dev/null +++ b/roles/podman/README.md @@ -0,0 +1 @@ +Installs podman diff --git a/roles/podman/meta/argument_specs.yaml b/roles/podman/meta/argument_specs.yaml index 35143b3..9002728 100644 --- a/roles/podman/meta/argument_specs.yaml +++ b/roles/podman/meta/argument_specs.yaml @@ -1,5 +1,5 @@ --- argument_specs: main: - short_description: Installs podman + description: Installs podman options: {} diff --git a/roles/service/README.md b/roles/service/README.md new file mode 100644 index 0000000..08b2beb --- /dev/null +++ b/roles/service/README.md @@ -0,0 +1 @@ +Sets up a service in podman container(s) diff --git a/roles/service/meta/argument_specs.yaml b/roles/service/meta/argument_specs.yaml index 1ccf11b..a0134cb 100644 --- a/roles/service/meta/argument_specs.yaml +++ b/roles/service/meta/argument_specs.yaml @@ -1,7 +1,7 @@ --- argument_specs: main: - short_description: Sets up a service in podman container(s) + description: Sets up a service in podman container(s) options: service_name: description: Name of the service.