Merge pull request #32 from liquidweb/plan-sys-vars

expand plan template variables

Author: dwburke

README.md

@@ -58,3 +58,77 @@ If you end up wanting to modify an auth context later on, you can do so with `au
 
 ## LiquidWeb Cloud
 The Cloud features you can use in manage.liquidweb.com on your Cloud Servers you can do with this command line tool. See `help cloud` for a full list of features and capabilities.
+
+## Plans
+
+A plan is a pre-defined yaml with optional template variables that can be used to
+repeate specific tasks.
+
+Currently only "lw cloud server create" is implemented.
+
+Example:
+
+`lw plan --file plan.yaml`
+
+```
+---
+cloud:
+   server:
+      create:
+         - type: "SS.VPS"
+           password: "{{- generatePassword 25 -}}"
+           template: "UBUNTU_1804_UNMANAGED"
+           zone: 27
+           hostname: "web1.somehost.org"
+           ips: 1
+           public-ssh-key: "your public ssh key here
+           config-id: 88
+           backup-plan: "None"
+           bandwidth: "SS.5000"
+```
+
+### Plan Variables
+
+Plan yaml can make use of golang's template variables.  Allows variables to be passed on the
+command line and it can access environment variables.
+
+#### Environment Variables
+Envonrment variables are defined as `.Env.VARNAME`.  On most linux systems and shells you can
+get the logged in user with `{{ .Env.USER }}`.
+
+#### User Defined Variables
+If you wanted to pass user defined variables on the command line you would use the `--var` flag
+(multiple `--var` flags can be passed).  For example, if you wanted to generate the hostname of
+`web3.somehost.org` you would use the following command and yaml:
+
+`lw plan --file play.yaml --var node=3 --var role=web`
+
+```
+    hostname: "{{- .Var.role -}}{{- .Var.node -}}.somehost.org"
+```
+
+
+#### Functions
+
+The following functions are defined to be called from a plan template:
+
+- generatePassword <length>
+
+For example, to generate a random 25 character password: 
+
+```password: "{{- generatePassword 25 -}}"```
+
+- now
+
+Gives access to a Golang `time` object using your local machine's clock.
+
+Simple example:
+
+```
+    hostname: "web1.{{- now.Year -}}{{- now.Month -}}{{- now.Day -}}.somehost.org"
+```
+
+- hex
+
+Convert a number to hexidecimal.
+

cmd/plan.go

@@ -22,11 +22,13 @@ import (
 	"io/ioutil"
 	"os"
 	"strings"
+	"time"
 
 	"github.com/spf13/cobra"
 	"gopkg.in/yaml.v2"
 
 	"github.com/liquidweb/liquidweb-cli/instance"
+	"github.com/liquidweb/liquidweb-cli/utils"
 )
 
 var planCmd = &cobra.Command{
@@ -135,7 +137,16 @@ func processTemplate(varSliceFlag []string, planYaml []byte) ([]byte, error) {
 	}
 
 	var tmplBytes bytes.Buffer
-	tmpl, err := template.New("plan.yaml").Parse(string(planYaml))
+	tmpl, err := template.New("plan.yaml").Funcs(template.FuncMap{
+		"generatePassword": func(length int) string {
+			return utils.RandomString(length)
+		},
+		"now": time.Now,
+		"hex": func(number int64) string {
+			return fmt.Sprintf("%X", number)
+		},
+	}).
+		Parse(string(planYaml))
 	if err != nil {
 		return nil, err
 	}