Skip to content

Commit

Permalink
Merge pull request #3 from serfdom/master
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
amalucelli authored Apr 2, 2017
2 parents 127303e + 58f052a commit 2c9cd72
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ Agent and deploy it's configurations automatically.
## Usage

Add this cookbook to your base recipe:

```ruby
cookbook 'aws-cloudwatchlogs', '~> 1.1.6'
```

You need to configure the following node attributes via an `environment` or `role`:

```ruby
default_attributes(
'aws_cwlogs' => {
Expand All @@ -34,6 +36,7 @@ default_attributes(
```

Or you can also configure by declaring it in another cookbook at a higher precedence level:

```ruby
default['aws_cwlogs']['region'] = 'your_aws_region'
default['aws_cwlogs']['aws_access_key_id'] = 'your_aws_access_key'
Expand All @@ -50,6 +53,7 @@ default['aws_cwlogs']['log']['syslog'] = {
**Note**: If you do not specify aws credentials, it will attempt to use the AWS IAM Role assigned to the instance instead.

Once you defined the attributes, you will need to reference `aws_cwlogs` resource in your recipe:

```ruby
include_recipe 'aws-cloudwatchlogs'

Expand Down

0 comments on commit 2c9cd72

Please sign in to comment.