Skip to content

Commit

Permalink
BIG-216: beefing up the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
em0ney committed Sep 18, 2015
1 parent 3437d75 commit e8ff850
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Expand Up @@ -2,9 +2,30 @@

This is an open-source tagging solution for AWS. Deploy autotag to lambda and set up CloudTrail and have each of your resources tagged with the resource who created it. It was written by GorillaStack.

## Setup

### 1. Turn on CloudTrail for your region

## Setup
1. Turn on CloudTrail.
2. Create a new Amazon S3 bucket for storing your log files, or specify an existing bucket where you want the log files delivered.
3. (Optional and NOT REQUIRED for Autotag) Create a new Amazon SNS topic in order to receive notifications when new log files are delivered.

More [documentation on creating a Trail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html)

### 2. Create a lambda function

1. Within lambda, press the 'Create a Lambda Function' button
2. Press the 'Skip' button to bypass the suggested blueprints
3. Enter the lambda function name (e.g. 'autotag')
4. Select 'Node.js' as the Runtime
5. Upload the latest release's zip file
6. Under 'Handler' add 'autotag.handler'

More [documentation on Lambda](https://docs.aws.amazon.com/lambda/latest/dg/getting-started.html)

### 3. Configure the access policy for your lambda role

For the complete role's policy, scroll down for the master policy. Read on for finer details on the access permissions required below.

#### Baseline policies for your lambda IAM role

Expand Down Expand Up @@ -127,3 +148,9 @@ To assist you in packaging and deploying your code to your lambda function, I ha
```bash
$ bash deploy_lambda_code.sh
```

To assist with running during development without having to deploy to lambda, use the `main.js` and `sample_data.js` files we have provided.

```bash
$ bash sample_data.sh
```

0 comments on commit e8ff850

Please sign in to comment.