mirror of
https://github.com/thegeeklab/ansible-doctor.git
synced 2024-11-24 22:00:40 +00:00
4.1 KiB
4.1 KiB
other-role-custom-header
Role to demonstrate ansible-doctor.
Table of content
Requirements
- Minimum Ansible version:
2.10
Default Variables
other_role_bool
Default value
other_role_bool: true
Example usage
other_role_bool: false
other_role_deprecated
Deprecated
Default value
other_role_deprecated: b
other_role_deprecated_info
Deprecated: This variable is deprected since v2.0.0 and will be removed in a future release.
Type: string
Default value
other_role_deprecated_info: a
other_role_dict
Default value
other_role_dict:
key1:
sub: some value
Example usage
other_role_dict:
key1:
sub: some value
# Inline description
key2:
sublist:
- subval1
- subval2
other_role_empty
Default value
other_role_empty: ''
other_role_empty_dict
... or valid json can be used. In this case, the json will be automatically prefixed with the annotation key
and filters like to_nice_yaml can be used in templates. To get it working, the json need to be prefixed with a $.
Default value
other_role_empty_dict: {}
Example usage
other_role_empty_dict:
key1:
sub: some value
key2:
sublist:
- subval1
- subval2
other_role_multiline_type
Type: string
list
dict
Default value
other_role_multiline_type: a
other_role_other_tags
If a variable need some more explanation, this is a good place to do so.
Default value
other_role_other_tags:
- package1
- package2
Example usage
other_role_other_tags:
- package1
- package2
other_role_override
Default value
other_role_override: test
other_role_override_complex
Default value
other_role_override_complex:
foo: bar
second: value
other_role_single
Default value
other_role_single: b
other_role_undefined_var
To highlight a variable that has not set a value by default, this is one way to achieve it.
Make sure to flag it as json value: @var other_role_undefined_var: $ "_unset_"
| Attribute | Description |
|---|---|
| value1 | desc1 |
Default value
other_role_undefined_var: _unset_
other_role_unset
Values can be plain strings, but there is no magic or autoformatting...
Default value
other_role_unset:
Example usage
other_role_unset: some_value
Discovered Tags
role-tag1
role-tag2
Open Tasks
- Unscoped general todo.
- (bug): Some bug that is known and need to be fixed.
- (bug): Multi line description are possible as well. Some bug that is known and need to be fixed.
- (improvement): Some things that need to be improved.
Dependencies
- role1
- role2
License
MIT