From 04a72f84910a0410b1b1be404bc59b6b83f66d62 Mon Sep 17 00:00:00 2001
From: Alexey Khivin <akhivin@gmail.com>
Date: Thu, 23 Jun 2016 16:36:20 +0300
Subject: [PATCH] [Puppet] Methods description added

Change-Id: Ib4f3e202e15100888707c79cc47c5aaeafc408ff
---
 .../Puppet/package/Classes/PuppetInstance.yaml    | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/murano-apps/Puppet/package/Classes/PuppetInstance.yaml b/murano-apps/Puppet/package/Classes/PuppetInstance.yaml
index 9292fdc..7613e1d 100644
--- a/murano-apps/Puppet/package/Classes/PuppetInstance.yaml
+++ b/murano-apps/Puppet/package/Classes/PuppetInstance.yaml
@@ -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)
\ No newline at end of file
+      - Return: $this.agent.call($template, $resources, $timeout)