Merge branch 'master' into master

Author: amock

.isort.cfg

@@ -1,2 +1,2 @@
 [settings]
-known_third_party = boto3,click,jinja2,pytest,pytest_lazyfixture,setuptools,tenacity,tfworker,yaml
+known_third_party = boto3,click,jinja2,moto,pkg_resources,pytest,pytest_lazyfixture,tenacity,tfworker,yaml

README.md

@@ -13,7 +13,7 @@ terraform:
 
   # global level variables
   terraform_vars:
-    region: //aws-region//
+    region: {{ aws_region }}
     environment: dev
 
   definitions:
@@ -28,7 +28,6 @@ terraform:
 ```sh
 % worker --aws-profile default --backend s3 terraform --show-output example1
 ```
-
 **NOTE:** When adding a provider from a non-hashicorp source, use a `source` field, as follows
 (_the `source` field is only valid for terraform 13+ and is not emitted when using 12_):
 
@@ -64,7 +63,7 @@ Build and publish the package to PYPI:
 
 ## Configuration
 
-A project is configured through a worker config, a yaml file that specifies the definitions, inputs, outputs, providers and all other necessary configuration. The worker config is what specifies how state is shared among your definitions. The config support jinja templating that can be used to conditionally pass state or pass in env variables through the command line via the `--config-var` option.
+A project is configured through a worker config, a yaml, json, or hcl2 file that specifies the definitions, inputs, outputs, providers and all other necessary configuration. The worker config is what specifies how state is shared among your definitions. The config support jinja templating that can be used to conditionally pass state or pass in env variables through the command line via the `--config-var` option.
 
 *./worker.yaml*
 ```yaml
@@ -91,6 +90,68 @@ terraform:
         subnet: network.outputs.subnet_id
 ```
 
+```json
+{
+    "terraform": {
+        "providers": {
+            "aws": {
+                "vars": {
+                    "region": "{{ aws_region }}",
+                    "version": "~> 2.61"
+                }
+            }
+        },
+        "terraform_vars": {
+            "region": "{{ aws_region }}",
+            "environment": "dev"
+        },
+        "definitions": {
+            "network": {
+                "path": "/definitions/aws/network-existing"
+            },
+            "database": {
+                "path": "/definitions/aws/rds",
+                "remote_vars": {
+                    "subnet": "network.outputs.subnet_id"
+                }
+            }
+        }
+    }
+}
+```
+
+```hcl
+terraform {
+  providers {
+    aws = {
+      vars = {
+        region = "{{ aws_region }}"
+        version = "2.63.0"
+      }
+    }
+  }
+
+  terraform_vars {
+    environment = "dev"
+    region = "{{ aws_region }}"
+  }
+
+  definitions {
+    network = {
+      path = "/definitions/aws/network-existing"
+    }
+
+    database = {
+      path = "/definitions/aws/rds"
+
+      remote_vars = {
+        subnet = "network.outputs.subnet_id"
+      }
+    }
+  }
+}
+```
+
 In this config, the worker manages two separate terraform modules, a `network` and a `database` definition, and shares an output from the network definition with the database definition. This is made available inside of the `database` definition through the `local.subnet` value.
 
 `aws_region` is substituted at runtime for the value of `--aws-region` passed through the command line.
@@ -111,3 +172,16 @@ In order to troubleshoot this definition, you would cd /tmp/tmpew44uopp/definiti
 ## Background
 
 The terraform worker was a weekend project to run terraform against a series of definitions (modules). The idea was the configuration vars, provider configuration, remote state, and variables from remote state would all be dynamically generated. The purpose was for building kubernetes deployments, and allowing all of the configuration information to be stored as either yamnl files in github, or have the worker configuration generated by an API which stored all of the deployment configurations in a database.
+
+## Documentation
+
+Documentation uses the [Sphinx](https://www.sphinx-doc.org/en/master/index.html) documentation fromework.
+
+To build HTML documentation:
+
+```bash
+% cd docs
+% make clean && make html
+```
+
+The documentation can be viewed locally by open `./docs/build/index.html` in a browser.

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_static/main.tf

@@ -0,0 +1 @@
+# This is a terraform configuration file.