ansible-doctor/example/demo-role/README.md

246 lines
4.1 KiB
Markdown
Raw Normal View History

2019-10-09 21:25:33 +00:00
# demo-role-custom-header
2023-08-24 22:02:01 +00:00
[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/ansible-doctor/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/ansible-doctor)
2020-12-31 14:06:20 +00:00
[![License: GPL-3.0](https://img.shields.io/github/license/thegeeklab/ansible-doctor)](https://github.com/thegeeklab/ansible-doctor/blob/main/LICENSE)
2019-10-08 11:03:45 +00:00
Role to demonstrate ansible-doctor. It is also possible to overwrite
the default description with an annotation.
2019-10-08 11:03:45 +00:00
2019-10-08 11:43:41 +00:00
## Table of content
- [Requirements](#requirements)
2021-01-17 14:10:33 +00:00
- [Default Variables](#default-variables)
2024-10-03 12:52:30 +00:00
- [demo_bool](#demo_bool)
- [demo_bool_up](#demo_bool_up)
- [demo_role_deprecated](#demo_role_deprecated)
- [demo_role_deprecated_info](#demo_role_deprecated_info)
2021-01-17 14:10:33 +00:00
- [demo_role_dict](#demo_role_dict)
- [demo_role_empty](#demo_role_empty)
- [demo_role_empty_dict](#demo_role_empty_dict)
- [demo_role_other_tags](#demo_role_other_tags)
- [demo_role_override](#demo_role_override)
- [demo_role_override_complex](#demo_role_override_complex)
2021-01-17 14:10:33 +00:00
- [demo_role_single](#demo_role_single)
- [demo_role_undefined_var](#demo_role_undefined_var)
- [demo_role_unset](#demo_role_unset)
- [Discovered Tags](#discovered-tags)
- [Open Tasks](#open-tasks)
2021-01-17 14:10:33 +00:00
- [Dependencies](#dependencies)
- [License](#license)
- [Author](#author)
2019-10-08 11:43:41 +00:00
2019-10-08 11:28:58 +00:00
---
## Requirements
- Minimum Ansible version: `2.10`
2019-10-08 11:43:41 +00:00
## Default Variables
2019-10-08 11:03:45 +00:00
2024-10-03 12:52:30 +00:00
### demo_bool
#### Default value
```YAML
demo_bool: true
```
#### Example usage
```YAML
demo_bool: false
```
### demo_bool_up
#### Default value
```YAML
demo_bool_up: true
```
#### Example usage
```YAML
demo_bool_up: 'False'
```
### demo_role_deprecated
**_Deprecated_**<br />
#### Default value
```YAML
demo_role_deprecated: b
```
### demo_role_deprecated_info
**_Deprecated:_** This variable is deprected since `v2.0.0` and will be removed in a future release.<br />
**_Type:_** string<br />
#### Default value
```YAML
demo_role_deprecated_info: a
```
### demo_role_dict
2019-10-08 11:03:45 +00:00
#### Default value
```YAML
demo_role_dict:
key1:
sub: some value
2019-10-08 11:03:45 +00:00
```
#### Example usage
```YAML
demo_role_dict:
key1:
sub: some value
# Inline description
key2:
sublist:
- subval1
- subval2
2019-10-08 11:03:45 +00:00
```
### demo_role_empty
#### Default value
```YAML
demo_role_empty: ''
```
### demo_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 `$`.
2019-10-08 11:03:45 +00:00
#### Default value
```YAML
demo_role_empty_dict: {}
```
#### Example usage
```YAML
demo_role_empty_dict:
key1:
sub: some value
key2:
sublist:
- subval1
- subval2
```
### demo_role_other_tags
If a variable need some more explanation, this is a good place to do so.
2019-10-08 11:03:45 +00:00
#### Default value
```YAML
demo_role_other_tags: []
```
#### Example usage
```YAML
2019-10-11 06:59:38 +00:00
demo_role_other_tags:
2019-10-08 11:03:45 +00:00
- package1
- package2
```
### demo_role_override
#### Default value
```YAML
demo_role_override: test
```
### demo_role_override_complex
#### Default value
```YAML
demo_role_override_complex:
foo: bar
second: value
```
### demo_role_single
#### Default value
```YAML
demo_role_single: b
```
2019-10-08 11:03:45 +00:00
### demo_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 demo_role_undefined_var: $ "_unset_"`
| Attribute | Description |
| --- | --- |
| value1 | desc1 |
2019-10-08 11:03:45 +00:00
#### Default value
```YAML
demo_role_undefined_var: _unset_
2019-10-08 11:03:45 +00:00
```
### demo_role_unset
Values can be plain strings, but there is no magic or autoformatting...
#### Default value
```YAML
demo_role_unset:
```
#### Example usage
```YAML
demo_role_unset: some_value
```
## Discovered Tags
**_role-tag1_**
**_role-tag2_**
**_single-tag_**\
&emsp;Example description of tag `single-tag`
## 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.
2019-10-08 11:03:45 +00:00
## Dependencies
- role2
2019-10-08 11:03:45 +00:00
## License
MIT
## Author
[John Doe](https://blog.example.com)