Update Home
24
Home.md
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.
|
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?
|
name | type | value validity rule
|
||||||
---|---|---|---|---
|
---|---|---
|
||||||
`fqdn` | `\<str>` | fully qualified domain name | none | true
|
`fqdn` | `\<str>` | fully qualified domain name
|
||||||
`vps_service` | `\<dict{\<str>:\<str\|bool\|list>}>` | valid fields providing data for spinning up new VPS | none | true
|
`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 | none | true
|
`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 | none | true
|
`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 | none | false
|
`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 | none | true (hence the reserved variable names)
|
`custom_vars` | `\<dict{\<str>:\<any>}>` | your own custom variables, though there are some reserved variable names for this namespace
|
||||||
|
|
||||||
### Role Scope
|
### 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.
|
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?
|
name | type | value validity rule
|
||||||
---|---|---|---|---
|
---|---|---
|
||||||
`software` | `\<dict{\<str>:\<dict>}>` | valid fields providing data for software installations | none | false
|
`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 | none | false
|
`config` | `\<dict{$software_name:\<dict>}>` | software name fields providing data for configuring that software
|
||||||
Reference in New Issue
Block a user