brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [2/3] brooklyn-docs git commit: Addressed review comments
Date Mon, 25 Jul 2016 08:52:47 GMT
Addressed review comments


Branch: refs/heads/master
Commit: dd4b35d06b8b37f4f53e3b0c6bb86724c037de99
Parents: a9bbc22
Author: Duncan Godwin <>
Authored: Fri Jul 22 11:31:33 2016 +0100
Committer: Duncan Godwin <>
Committed: Fri Jul 22 11:31:33 2016 +0100

 guide/ops/locations/ | 26 ++++++++++++++++++++++----
 1 file changed, 22 insertions(+), 4 deletions(-)
diff --git a/guide/ops/locations/ b/guide/ops/locations/
index 72352b7..9aee611 100644
--- a/guide/ops/locations/
+++ b/guide/ops/locations/
@@ -175,17 +175,35 @@ For more keys and more detail on the keys below, see
   without creating any other user.
 - A post-provisioning `setup.script` can be specified to run an additional script, before
making the `Location` 
-  available to entities. This may take the form of a URL of the script or a [base64](

-  encoded script with the prefix `data:text/plain;base64,` to denote this. 
+  available to entities. This may take the form of a URL of a script or a [data URI](
+  Note that if using a data URI it is usually a good idea to [base64](
this string to escape problem characters
+  in more complex scripts. The base64 encoded script should then be prefixed with `data:text/plain;base64,`
to denote this. 
   For example if you wanted to disable a yum repository called `reponame` prior to using
the machine, you could use the following command:
   `sudo yum-config-manager --disable reponame`
-  Once base64 encoded (with a tool such as [this](, plus the
prefix, this property would be:
+  Base64 encoding can be done with a with a tool such as [this](
or a linux command such as:
+  `echo "sudo yum-config-manager --disable reponame" | base64`
+  With the base64 prefix this would then look like this:
   `setup.script: data:text/plain;base64,c3VkbyB5dW0tY29uZmlnLW1hbmFnZXIgLS1kaXNhYmxlIHJlcG9uYW1l`
-  Optionally `setup.script.vars` can also be used to set variables (set as `key1:value1,key2:value2`)
+  The `setup.script` can also take [FreeMarker]( variables in a `setup.script.vars`
+  property. Variables are set in the format `key1:value1,key2:value2` and used in the form
`${key1}`. So for the above example:
+  `setup.script.vars: repository:reponame`
+  then
+  `setup.script: data:sudo yum-config-manager --disable ${repository}`
+  or encoded in base64:
+  `setup.script: data:text/plain;base64,c3VkbyB5dW0tY29uZmlnLW1hbmFnZXIgLS1kaXNhYmxlICR7cmVwb3NpdG9yeX0=`
+  This enables the name of the repository to be passed in to the script.
 - Use `openIptables: true` to automatically configure `iptables`, to open the TCP ports required
   the software process. One can alternatively use `stopIptables: true` to entirely stop the

View raw message