ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-26 14:41:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Doc directives (#22524)

Browse source 
* draft docs for directives

* updated to document directives
This commit is contained in:
Brian Coca 2017-03-15 11:29:58 -04:00 • committed by GitHub
commit b606bcec04
4 changed files with 43 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/docsite/Makefile
View file

@ -40,7 +40,7 @@ clean:
.PHONEY: docs clean
directives: $(FORMATTER) ../../hacking/templates/rst.j2
PYTHONPATH=../../lib $(DUMPER) --template-dir=../../hacking/templates --output-dir=rst/
PYTHONPATH=../../lib $(DUMPER) --template-dir=../../hacking/templates --output-dir=rst/ -d ./directive_desc.yml
modules: $(FORMATTER) ../../hacking/templates/rst.j2
PYTHONPATH=../../lib $(FORMATTER) -t rst --template-dir=../../hacking/templates --module-dir=../../lib/ansible/modules -o rst/

23
docs/docsite/directive_desc.yml Normal file
View file

@ -0,0 +1,23 @@
become: Boolean that controls if privilege escalation is used or not on Task execution.
become_flags: A string of flag(s) to pass to the privilege escalation program when ``become`` is True.
become_method: Which method of privilege escalation to use. i.e. sudo/su/etc.
become_user: User that you 'become' after using privilege escalation, the remote/login user must have permissions to become this user.
check_mode: A boolean that controls if a task is executed in 'check' mode
connection: Allows you to change the connection plugin used for tasks to execute on the target.
environment: A dictionary that gets converted into environment vars to be provided for the task upon execution.
gather_facts: A boolean that controls if the play will automatically run the 'setup' task to gather facts for the hosts.
hosts: A list of groups, hosts or host pattern that translates into a list of hosts that are the play's target.
ignore_errors: Boolean that allows you to ignore task failures and continue with play. It does not affect connection errors.
name: It's a name, works mostly for documentation, in the case of tasks/handlers it can be an identifier.
remote_user: User used to log into the target via the connection plugin. AKA login user.
no_log: Boolean that controls information disclosure.
run_once: Boolean that will bypass the host loop, forcing the task to execute on the first host available and will also apply any facts to all active hosts.
when: Conditional expression, determines if an iteration of a task is run or not.
strategy: Allows you to choose the connection plugin to use for the play.
tags: Tags applied to the task or included tasks, this allows selecting subsets of tasks from the command line.
vars: Dictionary/map of variables
always_run: DEPRECATED, forces a task to run even in check mode, use check_mode directive instead.
delegate_to: Host to execute task instead of the target (inventory_hostname), connection vars from the delegated host will also be used for the task.
delegate_facts: Boolean that allows you to apply facts to delegated host instead of inventory_hostname.
changed_when: Conditional expression that overrides the task's normal 'changed' status.
failed_when: Conditional expression that overrides the task's normal 'failed' status.