[Puppet] Methods description added

Change-Id: Ib4f3e202e15100888707c79cc47c5aaeafc408ff
This commit is contained in:
Alexey Khivin 2016-06-23 16:36:20 +03:00
parent 281290340e
commit 04a72f8491

View File

@ -63,7 +63,10 @@ Methods:
- $.agent.call($template, $resources)
- $._environment.reporter.report($this,
'Puppet installed on instance {0}'.format($.openstackId))
#
# Equals to
# puppet install '<module>'
#
installPuppetModule:
Arguments:
- module:
@ -126,6 +129,13 @@ Methods:
#
# Apply puppet manifest to the particular instance
#
# Usage example:
# - $instance.executeInline("create_resources('host', hiera('hosts'))")
#
# The code above is equal to:
# puppet apply --execute "create_resources('host', hiera('hosts'))"
#
# Known issues:
# * do not use " inside the code parameter
#
@ -139,6 +149,7 @@ Methods:
code => $code
))
- Return: $.agent.call($template, $resources)
#
# Apply manifest
#
@ -162,4 +173,4 @@ Methods:
manifestContent: base64encode($manifest)
- $template: $resources.yaml('ApplyManifest.template').bind($parameters)
- Return: $this.agent.call($template, $resources, $timeout)
- Return: $this.agent.call($template, $resources, $timeout)