Rename folders and update README

Author: qtangs

CODE_OF_CONDUCT.md

@@ -1,6 +1,48 @@
 ## Fraud Detection Using Machine Learning
 
-Setup end to end demo architecture for predicting fraud events with Machine Learning using Amazon SageMaker
+Setup end to end demo architecture for predicting fraud events with Machine Learning using `Amazon SageMaker` and `Terraform`.
+This repo supports the original article posted on Medium (links to be shared).
+
+## Terraform version
+
+Ensure your `Terraform` version is as follows (some modifications would be required if you run other `Terraform` versions):
+```sh
+$ terraform --version
+Terraform v0.11.14
++ provider.archive v1.2.2
++ provider.aws v2.21.1
++ provider.template v2.1.2
+```
+To download `Terraform`, visit https://releases.hashicorp.com/terraform/
+
+## Setup steps
+
+From `terraform` folder:
+1. Copy `terraform_backend.tf.template` to `terraform_backend.tf` and modify values accordingly. You need to manually create an S3 bucket or use an existing one to store the Terraform state file.
+2. Copy `terraform.tfvars.template` to `terraform.tfvars` and modify values accordingly. You don't need to create any buckets specified in here, they're to be created by terraform apply.
+3. Run the followings:
+```sh
+export AWS_PROFILE=<your desired profile>
+
+terraform init
+terraform validate
+terraform plan -out=tfplan
+terraform apply --auto-approve tfplan
+```
+
+
+## Clean up
+
+```
+terraform plan -destroy -out=tfplan
+terraform apply tfplan
+```
+
+## Original source
+https://github.com/awslabs/fraud-detection-using-machine-learning
+
+Original CloudFormation script can be found at `cloudformation` folder (renamed from `deployment`).
+
 
 ## License
 

CONTRIBUTING.md

@@ -29,8 +29,8 @@ resource "aws_iam_role_policy_attachment" "fraud_detection_firehose" {
 
 resource "aws_iam_policy" "fraud_detection_firehose_policy" {
   name        = "fraud-detection-firehose-policy"
+  description = "Policy for the Amazon Kinesis Data Firehose to save data to S3 bucket"
   path        = "/"
-  description = "FirehoseDeliveryIAMPolicy"
 
   policy = <<EOF
 {

NOTICE

@@ -28,8 +28,9 @@ resource "aws_iam_role_policy_attachment" "fraud_detection_lambda" {
 }
 
 resource "aws_iam_policy" "fraud_detection_lambda_policy" {
-  name = "fraud-detection-lambda-policy"
-  path = "/"
+  name        = "fraud-detection-lambda-policy"
+  description = "Policy for the fraud detection function to put records into the Amazon Kinesis Data Firehose"
+  path        = "/"
 
   policy = <<EOF
 {

README.md

@@ -34,8 +34,8 @@ resource "aws_iam_role_policy_attachment" "sm_notebook_instance" {
 
 resource "aws_iam_policy" "sm_notebook_instance_policy" {
   name        = "sm-notebook-instance-policy"
+  description = "Policy for the Notebook Instance to manage training jobs, models and endpoints"
   path        = "/"
-  description = "NotebookInstanceIAMPolicy"
 
   policy = <<EOF
 {

deployment/build-s3-dist.sh renamed to cloudformation/build-s3-dist.sh

@@ -0,0 +1,19 @@
+resource "aws_s3_bucket" "s3_bucket_2" {
+  bucket        = "${var.s3_bucket_name_2}-${var.aws_region}"
+  acl           = "private"
+  force_destroy = true                                        # delete all data from this bucket before destroy
+
+  server_side_encryption_configuration {
+    rule {
+      apply_server_side_encryption_by_default {
+        sse_algorithm = "AES256"
+      }
+    }
+  }
+
+  tags = {
+    Description = "Bucket for storing processed events for visualization features."
+    Group       = "${var.default_resource_group}"
+    CreatedBy   = "${var.default_created_by}"
+  }
+}

deployment/fraud-detection-using-machine-learning.template renamed to cloudformation/fraud-detection-using-machine-learning.template

@@ -1,7 +1,7 @@
 resource "aws_s3_bucket" "s3_bucket_1" {
   bucket        = "${var.s3_bucket_name_1}-${var.aws_region}"
   acl           = "private"
-  force_destroy = true  # delete all data from this bucket before destroy
+  force_destroy = true                                        # delete all data from this bucket before destroy
 
   server_side_encryption_configuration {
     rule {
@@ -18,26 +18,6 @@ resource "aws_s3_bucket" "s3_bucket_1" {
   }
 }
 
-resource "aws_s3_bucket" "s3_bucket_2" {
-  bucket        = "${var.s3_bucket_name_2}-${var.aws_region}"
-  acl           = "private"
-  force_destroy = true  # delete all data from this bucket before destroy
-
-  server_side_encryption_configuration {
-    rule {
-      apply_server_side_encryption_by_default {
-        sse_algorithm = "AES256"
-      }
-    }
-  }
-
-  tags = {
-    Description = "Bucket for storing processed events for visualization features."
-    Group       = "${var.default_resource_group}"
-    CreatedBy   = "${var.default_created_by}"
-  }
-}
-
 resource "aws_s3_bucket_object" "s3_fraud_detection_notebook" {
   bucket = "${aws_s3_bucket.fraud_detection_function_bucket.id}"
   key    = "fraud-detection-using-machine-learning/${var.function_version}/notebooks/sagemaker_fraud_detection.ipynb"

deployment/resources.txt renamed to cloudformation/resources.txt

@@ -0,0 +1,15 @@
+
+terraform_backend.tf.template -> terraform_backend.tf
+terraform.tfvars.template -> terraform.tfvars
+
+export AWS_PROFILE=<your desired profile>
+
+terraform init
+terraform validate
+terraform plan -out=tfplan
+terraform apply --auto-approve tfplan
+
+
+
+terraform plan -destroy -out=tfplan
+terraform apply tfplan

deployment/run-unit-tests.sh renamed to cloudformation/run-unit-tests.sh

@@ -0,0 +1,6 @@
+aws_region="<region>"
+aws_profile="<profile>"
+function_bucket_name="<bucket-for-lambda-function>"
+function_version="<version>"
+s3_bucket_name_1="<bucket-1>"
+s3_bucket_name_2="<bucket-2>"