From 4201865bba6a2dbc4d50bd0b8dd4dec27d59d433 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Mon, 27 Feb 2012 23:18:53 -0500 Subject: [PATCH] Add note about facter/ohai integration into module docs. --- docs/man/man5/ansible-modules.5 | 2 ++ docs/man/man5/ansible-modules.5.asciidoc | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/docs/man/man5/ansible-modules.5 b/docs/man/man5/ansible-modules.5 index 7baf69b4693..ff87caede8e 100644 --- a/docs/man/man5/ansible-modules.5 +++ b/docs/man/man5/ansible-modules.5 @@ -125,6 +125,8 @@ The name of the service .SH "SETUP" .sp Writes a JSON file containing key/value data, for use in templating\&. Call this once before using the template modules, usually as the very first step in your playbook\&. +.sp +If facter or ohai are installed, variables from these programs will also be snapshotted into the JSON file for usage in templating\&. These variables are prefixed with \fIfacter_\fR and \'ohai_" so it\(cqs easy to tell their source\&. .PP \fBmetadata=\fR .RS 4 diff --git a/docs/man/man5/ansible-modules.5.asciidoc b/docs/man/man5/ansible-modules.5.asciidoc index ef146cea78d..ee3c62f5869 100644 --- a/docs/man/man5/ansible-modules.5.asciidoc +++ b/docs/man/man5/ansible-modules.5.asciidoc @@ -150,6 +150,10 @@ Writes a JSON file containing key/value data, for use in templating. Call this once before using the template modules, usually as the very first step in your playbook. +If facter or ohai are installed, variables from these programs will also +be snapshotted into the JSON file for usage in templating. These variables +are prefixed with 'facter_' and 'ohai_" so it's easy to tell their source. + *metadata=*:: Optionally overrides the default JSON file location of /etc/ansible/setup.