admin/skato-ansible
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects 3 Releases Wiki Activity

Update Home

xenobyte
2025-12-16 01:39:08 +00:00
parent 330ce10703
commit b714437a74
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
Home.md

@@ -15,20 +15,20 @@ Other variables that tend to have default definitions as is but that may be of i
Herein are listed the relevant variables at or in the *inventory* scope. These must be specified for a specific inventory host or group, typically in their corresponding files under `group_vars` or `host_vars`. Some variables must take in a dictionary type with specific fields or keys to be valid.
name | type | value validity rule | default value | required?
---|---|---|---|---
`fqdn` | `\<str>` | fully qualified domain name | none | true
`vps_service` | `\<dict{\<str>:\<str\|bool\|list>}>` | valid fields providing data for spinning up new VPS | none | true
`groups` | `\<dict{$group_name:\<dict>}>` | fields/keys that are group names with data configuring that group | none | true
`users` | `\<dict{$user_name:\<dict>}>` | fields/keys that are user names with data configuring that user | none | true
`keywords` | `\<list[\<str>]>` | strings that describe the VPS, useful for applying tags if allowed by API | none | false
`custom_vars` | `\<dict{\<str>:\<any>}>` | your own custom variables, though there are some reserved variable names for this namespace | none | true (hence the reserved variable names)
name | type | value validity rule
---|---|---
`fqdn` | `\<str>` | fully qualified domain name
`vps_service` | `\<dict{\<str>:\<str\|bool\|list>}>` | valid fields providing data for spinning up new VPS
`groups` | `\<dict{$group_name:\<dict>}>` | fields/keys that are group names with data configuring that group
`users` | `\<dict{$user_name:\<dict>}>` | fields/keys that are user names with data configuring that user
`keywords` | `\<list[\<str>]>` | strings that describe the VPS, useful for applying tags if allowed by API
`custom_vars` | `\<dict{\<str>:\<any>}>` | your own custom variables, though there are some reserved variable names for this namespace
### Role Scope
Herein are listed the relevant variables at or in the *role* scope. These must be specified for a set of role tasks expected to run in a playbook for the host specified for its play. Some variables must take in a dictionary type with specific keys or fields to be valid.
name | type | value validity rule | default value | required?
---|---|---|---|---
`software` | `\<dict{\<str>:\<dict>}>` | valid fields providing data for software installations | none | false
`config` | `\<dict{$software_name:\<dict>}>` | software name fields providing data for configuring that software | none | false
name | type | value validity rule
---|---|---
`software` | `\<dict{\<str>:\<dict>}>` | valid fields providing data for software installations
`config` | `\<dict{$software_name:\<dict>}>` | software name fields providing data for configuring that software