fix: removed some unnecessary escape characters, added title for installation section, added links to Gitea Wiki
This commit is contained in:
36
README.md
36
README.md
@@ -7,29 +7,33 @@ This repository is for automating the management of the configuration of, and th
|
||||
To be able to make use of the Ansible playbooks, it is necessary to specify some variables in or at relevant scopes, though some may have some defaults. The relevant scopes variables are defined in, for our purposes, are:
|
||||
|
||||
- Ansible **inventory scope**: corresponds to variables inside per-hostname files in `group_vars` or `host_vars` directories, or the inventory file itself, i.e. `hosts.ini` or `hosts.yml`. The inventory file has some enforced naming conventions to be covered later or elsewhere.
|
||||
- Ansible **role scope**: corresponds to variables found in files inside the `defaults` / `vars` directory in a role directory, or variables found in files inside subdirectory `main` in either `defaults` or `vars` directory of that role directory. There are favored conventional directory structure within which these variables are specified in the aforementioned directories, to be covered later or elsewhere.
|
||||
- Ansible **role scope**: corresponds to variables found in files inside the `defaults` / `vars` directory in a role directory, or variables found in files inside subdirectory `main` in either `defaults` or `vars` directory of that role directory. There are favored conventional directory structures within which these variables are specified in the aforementioned directories, to be covered later or elsewhere.
|
||||
|
||||
Other variables that tend to have default definitions as is but that may be of interest are those found in Jinja templates of roles, in this case of the role `bootstrap`. Look through the `bootstrap` role's `templates` directory and you will discover them--most of them defined in role tasks or handlers that make reference to them. However, more information may be found elsewhere.
|
||||
|
||||
### Inventory Scope
|
||||
|
||||
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 to be valid. To save space, there will be more detail on what keys are required or optional for such dictionaries elsewhere and not here.
|
||||
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 to be valid. To save space, there will be more detail on what keys are required or optional for such dictionaries [elsewhere](https://git.sukaato.moe/admin/skato-ansible/wiki/Inventory-Scope) and not here.
|
||||
|
||||
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
|
||||
### 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 to be valid. To save space, there will be more detail on what keys are required or optional for such dictionaries elsewhere and not here.
|
||||
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 to be valid. To save space, there will be more detail on what keys are required or optional for such dictionaries [elsewhere](https://git.sukaato.moe/admin/skato-ansible/wiki/Role-Scope) and not here.
|
||||
|
||||
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
|
||||
|
||||
## Installation
|
||||
|
||||
> **TBC**
|
||||
> This README is yet unfinished and unverified. Check back later.
|
||||
|
||||
Reference in New Issue
Block a user