add example
This commit is contained in:
parent
8fba231dce
commit
14671d51fa
|
@ -0,0 +1,139 @@
|
||||||
|
# demo-role
|
||||||
|
|
||||||
|
Role to demonstrate ansible-doctor
|
||||||
|
|
||||||
|
## Default Variables
|
||||||
|
|
||||||
|
### demo_role_unset
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
demo_role_unset:
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Example usage
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
demo_role_unset: some value
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### demo_role_empty
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
demo_role_empty: ''
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### demo_role_single
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
demo_role_single: b
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### demo_role_empty_dict
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
demo_role_empty_dict: {}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Example usage
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
demo_role_empty_dict:
|
||||||
|
key1:
|
||||||
|
sub: some value
|
||||||
|
key2:
|
||||||
|
sublist:
|
||||||
|
- subval1
|
||||||
|
- subval2
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### demo_role_dict
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
demo_role_dict:
|
||||||
|
key1:
|
||||||
|
sub: some value
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Example usage
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
demo_role_dict:
|
||||||
|
key1:
|
||||||
|
sub: some value
|
||||||
|
key2:
|
||||||
|
sublist:
|
||||||
|
- subval1
|
||||||
|
- subval2
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### demo_role_other_tags
|
||||||
|
|
||||||
|
The role requires epel repository and pip to work.
|
||||||
|
You can use dockerengine_packages_extra to install these dependencys.
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
demo_role_other_tags: []
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### dockerengine_packages_extra
|
||||||
|
|
||||||
|
#### Example usage
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
dockerengine_packages_extra:
|
||||||
|
- package1
|
||||||
|
- package2
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### demo_role_undefined_var
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
demo_role_undefined_var: _undefined_
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
None.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT
|
||||||
|
|
||||||
|
## Author
|
||||||
|
|
||||||
|
Robert Kaussow <mail@example.com>
|
||||||
|
|
|
@ -0,0 +1,30 @@
|
||||||
|
---
|
||||||
|
demo_role_unset:
|
||||||
|
# @var demo_role_unset:example: "some value"
|
||||||
|
demo_role_empty: ""
|
||||||
|
demo_role_single: 'b'
|
||||||
|
# @var demo_role_empty_dict:example: {"key1": {"sub": "some value"}, "key2": {"sublist": ["subval1", "subval2"]}}
|
||||||
|
demo_role_empty_dict: {}
|
||||||
|
|
||||||
|
# @var demo_role_dict:example: >
|
||||||
|
# demo_role_dict:
|
||||||
|
# key1:
|
||||||
|
# sub: some value
|
||||||
|
# key2:
|
||||||
|
# sublist:
|
||||||
|
# - subval1
|
||||||
|
# - subval2
|
||||||
|
# @end
|
||||||
|
demo_role_dict:
|
||||||
|
key1:
|
||||||
|
sub: some value
|
||||||
|
|
||||||
|
# @var demo_role_other_tags:description: >
|
||||||
|
# The role requires epel repository and pip to work.
|
||||||
|
# You can use dockerengine_packages_extra to install these dependencys.
|
||||||
|
# @end
|
||||||
|
|
||||||
|
# @var dockerengine_packages_extra:example: ["package1", "package2"]
|
||||||
|
demo_role_other_tags: []
|
||||||
|
|
||||||
|
# @var demo_role_undefined_var: _undefined_
|
|
@ -0,0 +1,15 @@
|
||||||
|
---
|
||||||
|
# @meta name: demo-role
|
||||||
|
galaxy_info:
|
||||||
|
description: Role to demonstrate ansible-doctor
|
||||||
|
author: Robert Kaussow <mail@example.com>
|
||||||
|
license: MIT
|
||||||
|
min_ansible_version: 2.4
|
||||||
|
platforms:
|
||||||
|
- name: EL
|
||||||
|
versions:
|
||||||
|
- 7
|
||||||
|
galaxy_tags:
|
||||||
|
- demo
|
||||||
|
- documentation
|
||||||
|
dependencies: []
|
|
@ -0,0 +1 @@
|
||||||
|
---
|
Loading…
Reference in New Issue