Fleshed out README.md, removed backend.tf, removed commented parts of main.tf, and added comment for netbox.sh

Author: phillhocking

README.md

@@ -1,4 +1,32 @@
 # netbox-aws
-This repository is intended to allow for installing the popular netbox DCIM/IPAM on an AWS EC2 instance
+## This repository is intended to facilitate installation of the popular NetBox DCIM/IPAM on an AWS EC2 instance using Terraform. 
 
-You should be able to instantiate netbox with this repo. Nice!
+
+This repo is pinned to Ubuntu 18.04-amd64-server-20201211.1 and verified to work with Terraform 0.14.3. The [netbox-docker](https://github.com/netbox-community/netbox-docker) image is pinned to [1.0.2](https://github.com/netbox-community/netbox-docker/releases/tag/1.0.2) which was the latest release as of this writing. 
+
+To summarize, this instantiates the Ubuntu EC2 instance, installs all the Docker dependencies (which all are pinned), pulls the [netbox-docker](https://github.com/netbox-community/netbox-docker) release via git, creates a `docker-compose.override.yml` file which exposes the Docker internal port `8080` on the worker container to port `80` to the internet, and then execute `docker-compose` resulting in a functioning NetBox IPAM  after several minutes of fetching the depends and setting up the various images called by `docker-compose`.
+
+
+Variables to define in your Terraform workspace are: 
+
+```hcl 
+variable "access_key" {}
+variable "secret_key" {}
+variable "management_cidr_block" {}
+variable "key_name" {
+  default = "terraform"
+}
+
+variable "aws_region" {
+  default = "us-west-2"
+}
+```
+The `management_cidr_block` is just an IP address range to allow SSH connections from either your premise location, bastion host, VPC subnet, etc. Obviously you would want to be utilizing SSL and have a Security Group and/or NACL and probably have it behind an ALB or CloudFront deployment to provide more limited access, however, that is beyond the scope of this project.
+
+The default login is `admin/admin`, and the default API key is:
+
+`0123456789abcdef0123456789abcdef01234567`
+
+Please, dear God, don't just run this public on the internet without SSL/firewall and change these defaults!
+
+Pull requests are welcome, shoot me a message with any questions, complaints, or thanks! 

backend.tf

@@ -35,31 +35,4 @@ resource "aws_instance" "netbox_dev" {
   tags = {
     Name = "netbox-dev"
   }  
-}
-
-#resource "null_resource" "netbox_config" {
-#  triggers = {
-#    public_ip = aws_instance.netbox_dev.public_ip
-#  }
-#  depends_on = [aws_instance.netbox_dev]
-#  connection {
-#    type        = "ssh"
-#    private_key = var.terraform_ssh_key
-#    host        = aws_instance.netbox_dev.public_ip
-#    user        = "ubuntu"
-#    timeout     = "4m"
-#  }
-#  provisioner "file" {
-#    source      = "netbox.sh"
-#    destination = "/tmp/netbox.sh"
-#
-# }
-#  provisioner "remote-exec" {
-#    inline = [
-#      "chmod +x /tmp/netbox.sh",
-#      "/tmp/netbox.sh",
-#    ]
-#
-#  }
-
-#}
+}

main.tf

@@ -1,5 +1,5 @@
 #!/bin/bash
-
+# This shell script is just for reference to ensure it works outside of the cloud-init process and so it can be formatted into the cloudinit.yml
 sudo apt update
 sudo apt-get install apt-transport-https ca-certificates curl gnupg-agent software-properties-common -y
 curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -