You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Robert Kaussow b6a2813114
fix: get role name from dependencies in case of a dictionary (#300)
1 month ago
..
demo-role fix: get role name from dependencies in case of a dictionary (#300) 1 month ago
README.md fix: get role name from dependencies in case of a dictionary (#300) 1 month ago

README.md

demo-role-custom-header

Build Status License: GPL-3.0

Role to demonstrate ansible-doctor. It is also possible to overwrite the default description with an annotation.

Table of content


Default Variables

demo_role_dict

Default value

demo_role_dict:
  key1:
    sub: some value

Example usage

demo_role_dict:
  key1:
    sub: some value

  # Inline description
  key2:
    sublist:
      - subval1
      - subval2

demo_role_empty

Default value

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 $.

Default value

demo_role_empty_dict: {}

Example usage

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.

Default value

demo_role_other_tags: []

Example usage

demo_role_other_tags:
  - package1
  - package2

demo_role_override

Default value

demo_role_override: test

demo_role_override_complex

Default value

demo_role_override_complex:
  foo: bar
  second: value

demo_role_single

Default value

demo_role_single: b

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_"

Default value

demo_role_undefined_var: _unset_

demo_role_unset

Values can be plain strings, but there is no magic or autoformatting...

Default value

demo_role_unset:

Example usage

demo_role_unset: some_value

Discovered Tags

role-tag1

role-tag2

single-tag
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.

Dependencies

  • role1
  • role2

License

MIT

Author

John Doe