fluent-plugin-cloudwatch-logs 0.3.7.pre → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6eef6d581a07f4cf72870caa240aefbab4ffa445
-  data.tar.gz: f1df31f0a1da9e94730dca49906cf10bb6f75869
+  metadata.gz: ecc88d81a0eac8a7998557fdd380081c9f39d9ad
+  data.tar.gz: 315a53cdfdd9adadbb7a79a35d1c3ac73d424815
 SHA512:
-  metadata.gz: 94836cacb6ae5d53d960d175c579ef58ec1a5bd1c8aa62ed321f783209442ce65a6d66108afbbf2d970b9798fdd9c6826e88e1db37684d59c5644f42c25947c6
-  data.tar.gz: ab1730baec1e1200623de2c503ffbb90dee42d9df244bfee1ef5b561d4991e65ac13d7bf0b88b9bfcfaac8115c13d4f869fd903696e6c258287a684a39569d95
+  metadata.gz: 6c8b60e1d0b52b200d018dc0b0b4fcb3aa180cdf70b3b852317e0163e70e1c6da7bf4b03d572d8acc4130029b2ab17af526de0e934e19ff7c79f081d750d39e9
+  data.tar.gz: d3465bb052e2d526770cc2b7245f13ce51f0fe04141462b4767002c065f7adf17a14485d5c02b60b21f761fdba499e4264fc05bde20dafc28bcf994d8ddcee3e

data/README.md

@@ -121,6 +121,9 @@ Fetch sample log from CloudWatch Logs:
 * `log_stream_name`: name of log stream to fetch logs
 * `use_log_stream_name_prefix`: to use `log_stream_name` as log stream name prefix (default false)
 * `state_file`: file to store current state (e.g. next\_forward\_token)
+* `aws_use_sts`: use [AssumeRoleCredentials](http://docs.aws.amazon.com/sdkforruby/api/Aws/AssumeRoleCredentials.html) to authenticate, rather than the [default credential hierarchy](http://docs.aws.amazon.com/sdkforruby/api/Aws/CloudWatchLogs/Client.html#initialize-instance_method). See 'Cross-Account Operation' below for more detail.
+* `aws_sts_role_arn`: the role ARN to assume when using cross-account sts authentication
+* `aws_sts_session_name`: the session name to use with sts authentication (default: `fluentd`)
 
 This plugin uses [fluent-mixin-config-placeholders](https://github.com/tagomoris/fluent-mixin-config-placeholders) and you can use addtional variables such as %{hostname}, %{uuid}, etc. These variables are useful to put hostname in `log_stream_name`.
 
@@ -150,6 +153,100 @@ $ rake aws_key_id=YOUR_ACCESS_KEY aws_sec_key=YOUR_SECRET_KEY region=us-east-1 t
 
 - If an event message exceeds API limit (256KB), the event will be discarded.
 
+## Cross-Account Operation
+In order to have an instance of this plugin running in one AWS account to fetch logs from another account cross-account IAM authentication is required. Whilst this can be accomplished by configuring specific instances of the plugin manually with credentials for the source account in question this is not desirable for a number of reasons.
+
+In this case IAM can be used to allow the fluentd instance in one account ("A") to ingest Cloudwatch logs from another ("B") via the following mechanic:
+
+* plugin instance running in account "A" has an IAM instance role assigned to the underlying EC2 instance
+* The IAM instance role and associated policies permit the EC2 instance to assume a role in another account
+* An IAM role in account "B" and associated policies allow read access to the Cloudwatch Logs service, as appropriate.
+
+### IAM Detail: Consuming Account "A"
+
+* Create an IAM role `cloudwatch`
+* Attach a policy to allow the role holder to assume another role (where `ACCOUNT-B` is substituted for the appropriate account number):
+
+```
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Action": [
+                "sts:*"
+            ],
+            "Resource": [
+                "arn:aws:iam::ACCOUNT-B:role/fluentd"
+            ]
+        }
+    ]
+}
+```
+
+* Ensure the EC2 instance on which this plugin is executing as role `cloudwatch` as its assigned IAM instance role.
+
+### IAM Detail: Log Source Account "B"
+
+* Create an IAM role `fluentd`
+* Ensure the `fluentd` role as account "A" as a trusted entity:
+
+```
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Principal": {
+        "AWS": "arn:aws:iam::ACCOUNT-A:root"
+      },
+      "Action": "sts:AssumeRole"
+    }
+  ]
+}
+```
+
+* Attach a policy:
+
+```
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Action": [
+                "logs:DescribeDestinations",
+                "logs:DescribeExportTasks",
+                "logs:DescribeLogGroups",
+                "logs:DescribeLogStreams",
+                "logs:DescribeMetricFilters",
+                "logs:DescribeSubscriptionFilters",
+                "logs:FilterLogEvents",
+                "logs:GetLogEvents"
+            ],
+            "Resource": [
+                "arn:aws:logs:eu-west-1:ACCOUNT-B:log-group:LOG_GROUP_NAME_FOR_CONSUMPTION:*"
+            ]
+        }
+    ]
+}
+```
+
+### Configuring the plugin for STS authentication
+```
+<source>
+  type cloudwatch_logs
+  region us-east-1      # You must supply a region
+  aws_use_sts true
+  aws_sts_role_arn arn:aws:iam::ACCOUNT-B:role/fluentd
+  log_group_name LOG_GROUP_NAME_FOR_CONSUMPTION
+  log_stream_name SOME_PREFIX
+  use_log_stream_name_prefix true
+  state_file /path/to/state_file
+  format /(?<message>.+)/
+</source>
+```
+
 ## TODO
 
 * out_cloudwatch_logs

data/lib/fluent/plugin/cloudwatch/logs/version.rb

@@ -2,7 +2,7 @@ module Fluent
   module Plugin
     module Cloudwatch
       module Logs
-        VERSION = "0.3.7.pre"
+        VERSION = "0.3.8"
       end
     end
   end

data/lib/fluent/plugin/in_cloudwatch_logs.rb

@@ -13,6 +13,9 @@ module Fluent
 
     config_param :aws_key_id, :string, :default => nil, :secret => true
     config_param :aws_sec_key, :string, :default => nil, :secret => true
+    config_param :aws_use_sts, :bool, default: false
+    config_param :aws_sts_role_arn, :string, default: nil
+    config_param :aws_sts_session_name, :string, default: 'fluentd'
     config_param :region, :string, :default => nil
     config_param :tag, :string
     config_param :log_group_name, :string
@@ -39,9 +42,19 @@ module Fluent
 
     def start
       options = {}
-      options[:credentials] = Aws::Credentials.new(@aws_key_id, @aws_sec_key) if @aws_key_id && @aws_sec_key
       options[:region] = @region if @region
       options[:http_proxy] = @http_proxy if @http_proxy
+
+      if @aws_use_sts
+        Aws.config[:region] = options[:region]
+        options[:credentials] = Aws::AssumeRoleCredentials.new(
+          role_arn: @aws_sts_role_arn,
+          role_session_name: @aws_sts_session_name
+        )
+      else
+        options[:credentials] = Aws::Credentials.new(@aws_key_id, @aws_sec_key) if @aws_key_id && @aws_sec_key
+      end
+
       @logs = Aws::CloudWatchLogs::Client.new(options)
 
       @finished = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-cloudwatch-logs
 version: !ruby/object:Gem::Version
-  version: 0.3.7.pre
+  version: 0.3.8
 platform: ruby
 authors:
 - Ryota Arai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-10 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -144,12 +144,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: CloudWatch Logs Plugin for Fluentd