From c3e1b37d0ed2ecf48170d7b2f101a910c9b3887a Mon Sep 17 00:00:00 2001
From: Alex Britton <alex@ahbritton.com>
Date: Wed, 18 Aug 2021 13:21:49 +0100
Subject: [PATCH] add inital readme

---
 README.md                 | 39 +++++++++++++++++++++++++++++++++++++++
 terraform.tfvars.template |  2 ++
 2 files changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f636223
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Azure Firewall with Terraform
+
+Building a test environment in azure to try out Azure firewall.
+
+## Description
+
+This code was written to create the environement described in [John Savill](https://twitter.com/NTFAQGuy)'s excellent video tutorial [Azure Firewall Deep Dive](https://www.youtube.com/watch?v=JiUerkqyW0g)
+
+## Getting Started
+
+### Dependencies
+
+Written using:
++ Terraform v0.15.1 on windows_amd64
++ provider registry.terraform.io/hashicorp/azurerm v2.72.0
+
+### Installing
+
+It is assumed that you already have Terraform installed and have an Azure account.\
+See [here](https://docs.microsoft.com/en-us/azure/developer/terraform/get-started-windows-powershell?tabs=bash) for instructions on how to deploy to Azure with Terraform.
+
+### Executing program
+
+Rename `terraform.tfvars.template` to `terraform.tfvars`\
+Make the required changes for your environment\
+\
+Run `terraform init`
+Run `terrafrom plan`
+Run `terraform apply`
+
+## Help
+
+## Authors
+
++ Alex Britton (alex@ahbritton.com)
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://choosealicense.com/licenses/mit/) for more information.
\ No newline at end of file
diff --git a/terraform.tfvars.template b/terraform.tfvars.template
index 8009c3d..3561bde 100644
--- a/terraform.tfvars.template
+++ b/terraform.tfvars.template
@@ -2,5 +2,7 @@ subscriptionID = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
 
 resourceGroupName = "AzureFirewallRG"
 
+# Trusted IP addresses used to connect to the environment
+# These will be added to the firewall to allow RDP/SSH to the test VMs
 homebaseIPs = ["xx.xx.xx.xx/32"]