From 641d738453d728d3ff4071bcc387dab014f64323 Mon Sep 17 00:00:00 2001 From: TJ Hoplock Date: Mon, 21 Oct 2024 00:00:12 -0400 Subject: [PATCH] docs: update inventory role file doc table --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6abecce..b856df0 100644 --- a/README.md +++ b/README.md @@ -208,14 +208,18 @@ whatever other idempotent scripts/configs written in other languages. | `modules` | `requires` | Newline delimited list | List of other modules that are required to apply before this module can apply (dependency ordering) | No | No | | `modules` | `templates/` | Directory | Contains Go text templates as `.tpl` files | No | No | | `roles` | `modules` | Newline delimited list | List of modules that are included in/executed as part of this role | No | No | +| `roles` | `variables` | Bash script | script containing variables to set for the role's execution context for `apply` and `test` scripts | No | Yes | +| `roles` | `templates/` | Directory | Contains Go text templates as `.tpl` files | No | No | | `hosts` | `modules` | Newline delimited list | List of modules that are included in/executed as part of the defined host | No | No | | `hosts` | `roles` | Newline delimited list | List of roles that are included in/executed as part of the defined host | No | No | | `hosts` | `variables` | Bash script | script containing variables to set for the host's execution context for `apply` and `test` scripts | No | Yes | +| `hosts` | `templates/` | Directory | Contains Go text templates as `.tpl` files | No | No | | `groups` | `glob` | Newline delimited list | List of glob patterns that are members of this group. Glob patterns are matched against the hostname of the system | No | No | | `groups` | `regex` | Newline delimited list | List of regular expression patterns that are members of this group. Regular expression patterns are matched against the hostname of the system | No | No | | `groups` | `roles` | Newline delimited list | List of roles assigned to members of this group | No | No | | `groups` | `modules` | Newline delimited list | List of modules assigned to members of this group | No | No | -| `groups` | `variables` | Bash script | script containing variables to set for the host's execution context for `apply` and `test` scripts | No | Yes | +| `groups` | `variables` | Bash script | script containing variables to set for the group's execution context for `apply` and `test` scripts | No | Yes | +| `groups` | `templates/` | Directory | Contains Go text templates as `.tpl` files | No | No | ## Monitoring and Alerting