Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
parabolic and aknysh Export the role policy document (#3)
* Add the iam_policy_document output in case we are already using a role.

* append cloudwatch_agent to the name so that those resources do not
collide with existing ones

* update the readme with a another example and add the new output

* fix the example names

* Update outputs.tf

Co-Authored-By: parabolic <parabolic@users.noreply.github.com>

* Update README.md

Co-Authored-By: parabolic <parabolic@users.noreply.github.com>

* Update README.yaml

Co-Authored-By: parabolic <parabolic@users.noreply.github.com>

* Update README.yaml

Co-Authored-By: parabolic <parabolic@users.noreply.github.com>

* Update outputs.tf

Co-Authored-By: parabolic <parabolic@users.noreply.github.com>

* Fix the output description and add a real data resource for the AMI.

* add the `cloudwatch-agent` attribute

* fix a typo in the readme

* Add the attributes as a list variable with a default value
Latest commit da1213e May 17, 2019

README.md

README Header

Cloud Posse

terraform-aws-cloudwatch-agent Build Status Latest Release Slack Community

Terraform module to install the CloudWatch agent on EC2 instances using cloud-init.


This project is part of our comprehensive "SweetOps" approach towards DevOps.

Terraform Open Source Modules

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

Example with launch configuration:

module "cloudwatch_agent" {
  source = "git::https://github.com/cloudposse/terraform-aws-cloudwatch-agent?ref=master"

  name = "cloudwatch_agent"
}

resource "aws_launch_configuration" "multipart" {
  name_prefix          = "cloudwatch_agent"
  image_id             = "${data.aws_ami.ecs_optimized.id}"
  iam_instance_profile = "${aws_iam_instance_profile.cloudwatch_agent.name}"
  instance_type        = "t2.micro"
  user_data_base64     = "${module.cloudwatch_agent.user_data}"
  security_groups      = ["${aws_security_group.ecs.id}"]
  key_name             = "${var.ssh_key_pair}"

  lifecycle {
    create_before_destroy = true
  }
}

data "aws_ami" "ecs_optimized" {
  most_recent = true

  filter {
    name   = "name"
    values = ["amzn2-ami-ecs-hvm-*-x86_64-*"]
  }

  owners = [
    "amazon",
  ]
}

Example with using the iam_policy_document and aws_iam_role:

locals {
  application {
    name      = "cloudwatch_agent"
    stage     = "dev"
    namespace = "eg"
  }
}

module "label" {
  source      = "git::https://github.com/cloudposse/terraform-null-label.git?ref=master"
  stage       = "${local.application["stage"]}"
  name        = "${local.application["name"]}"
  namespace   = "${local.application["namespace"]}"
}

module "cloudwatch_agent" {
  source = "git::https://github.com/cloudposse/terraform-aws-cloudwatch-agent?ref=master"

  name      = "${module.label.name}"
  stage     = "${module.label.stage}"
  namespace = "${module.label.namespace}"
}

resource "aws_launch_configuration" "multipart" {
  name_prefix          = "${module.label.name}"
  image_id             = "${data.aws_ami.ecs_optimized.id}"
  iam_instance_profile = "${aws_iam_instance_profile.cloudwatch_agent.name}"
  instance_type        = "t2.micro"
  user_data_base64     = "${module.cloudwatch_agent.user_data}"
  security_groups      = ["${aws_security_group.ecs.id}"]
  key_name             = "${var.ssh_key_pair}"

  lifecycle {
    create_before_destroy = true
  }
}

data "aws_ami" "ecs_optimized" {
  most_recent = true

  filter {
    name   = "name"
    values = ["amzn2-ami-ecs-hvm-*-x86_64-*"]
  }

  owners = [
    "amazon",
  ]
}

data "aws_iam_policy_document" "ec2_cloudwatch" {
  statement {
    effect  = "Allow"
    actions = ["sts:AssumeRole"]

    principals = {
      type        = "Service"
      identifiers = ["ec2.amazonaws.com"]
    }
  }
}

resource "aws_iam_role" "ec2" {
  name = "${module.label.id}"

  assume_role_policy = "${data.aws_iam_policy_document.ec2_cloudwatch.json}"

  tags = {
    Name = "${module.label.id}"
  }
}

resource "aws_iam_role_policy" "cloudwatch_agent" {
  name   = "${module.label.id}"
  policy = "${module.cloudwatch_agent.iam_policy_document}"
  role   = "${aws_iam_role.ec2.id}"
}

resource "aws_iam_instance_profile" "cloudwatch_agent" {
  name_prefix = "${module.label.name}"
  role        = "${aws_iam_role.ec2.name}"
}

Example with passing user-data and using the role from the module using advanced metrics configuration:

module "cloudwatch_agent" {
  source = "git::https://github.com/cloudposse/terraform-aws-cloudwatch-agent?ref=master"

  name      = "cloudwatch_agent"
  stage     = "dev"
  namespace = "eg"

  metrics_config        = "advanced"
  userdata_part_content = "${data.template_file.cloud-init.rendered}"
}

data "template_file" "cloud-init" {
  template = "${file("${path.module}/cloud-init.yml")}"
}

resource "aws_launch_configuration" "multipart" {
  name_prefix          = "cloudwatch_agent"
  image_id             = "${data.aws_ami.ecs_optimized.id}"
  iam_instance_profile = "${aws_iam_instance_profile.cloudwatch_agent.name}"
  instance_type        = "t2.micro"
  user_data_base64     = "${module.cloudwatch_agent.user_data}"
  security_groups      = ["${aws_security_group.ecs.id}"]
  key_name             = "${var.ssh_key_pair}"

  lifecycle {
    create_before_destroy = true
  }
}

data "aws_ami" "ecs_optimized" {
  most_recent = true

  filter {
    name   = "name"
    values = ["amzn2-ami-ecs-hvm-*-x86_64-*"]
  }

  owners = [
    "amazon",
  ]
}

resource "aws_iam_instance_profile" "cloudwatch_agent" {
  name_prefix = "cloudwatch_agent"
  role        = "${module.cloudwatch_agent.role_name}"
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Inputs

Name Description Type Default Required
aggregation_dimensions Specifies the dimensions that collected metrics are to be aggregated on. list <list> no
attributes Add a suffix to the resource names. list <list> no
cpu_resources Specifies that per-cpu metrics are to be collected. The only allowed value is *. If you include this field and value, per-cpu metrics are collected. string "resources": ["*"], no
disk_resources Specifies an array of disk mount points. This field limits CloudWatch to collect metrics from only the listed mount points. You can specify * as the value to collect metrics from all mount points. Defaults to the root / mountpount. list <list> no
metrics_collection_interval Specifies how often to collect the cpu metrics, overriding the global metrics_collection_interval specified in the agent section of the configuration file. If you set this value below 60 seconds, each metric is collected as a high-resolution metric. string 60 no
metrics_config "Which metrics should we send to cloudwatch, the default is standard. Setting this variable to advanced will send all the available metrics that are provided by the agent. You can find more information here https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/create-cloudwatch-agent-configuration-file-wizard.html." string standard no
name Solution name, e.g. 'app'. string - yes
namespace Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'. string - yes
stage Stage, e.g. 'prod', 'staging', 'dev', or 'test'. string `` no
userdata_part_content The user data that should be passed along from the caller of the module. string `` no
userdata_part_content_type What format is userdata_part_content in - eg 'text/cloud-config' or 'text/x-shellscript'. string text/cloud-config no
userdata_part_merge_type Control how cloud-init merges user-data sections. string list(append)+dict(recurse_array)+str() no

Outputs

Name Description
iam_policy_document The IAM policy document that can be attached to a role policy
role_name The name of the created IAM role that can be assumed by the instance
user_data The user_data with the cloudwatch_agent configuration in base64 and gzipped

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

README Commercial Support

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

E-Mail

  • Questions. We'll use a Shared Slack channel between your team and ours.
  • Troubleshooting. We'll help you triage why things aren't working.
  • Code Reviews. We'll review your Pull Requests and provide constructive feedback.
  • Bug Fixes. We'll rapidly work to fix any bugs in our projects.
  • Build New Terraform Modules. We'll develop original modules to provision infrastructure.
  • Cloud Architecture. We'll assist with your cloud strategy and design.
  • Implementation. We'll provide hands-on support to implement our reference architectures.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Newsletter

Signup for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2019 Cloud Posse, LLC

License

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Nikola Velkovski
Nikola Velkovski

README Footer Beacon

You can’t perform that action at this time.