Skip to content

Latest commit

 

History

History
303 lines (226 loc) · 20.8 KB

README.md

File metadata and controls

303 lines (226 loc) · 20.8 KB
Raw

Project Banner

Latest ReleaseLast UpdatedSlack Community

Terraform module for enabling flow logs for vpc and subnets.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform
Example of running atmos to manage infrastructure from our Quick Start tutorial.

Usage

module "flow_logs" {
  source    = "git::https://github.com/cloudposse/terraform-aws-cloudwatch-flow-logs.git?ref=master"
  vpc_id    = "${var.vpc_id}"
  namespace = "${var.namespace}"
  stage     = "${var.stage}"
}

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Makefile Targets

Available targets:

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

Requirements

No requirements.

Providers

Name Version
aws n/a

Modules

Name Source Version
kinesis_label git::https://github.com/cloudposse/terraform-null-label.git tags/0.3.1
log_group_label git::https://github.com/cloudposse/terraform-null-label.git tags/0.3.1
subnet_label git::https://github.com/cloudposse/terraform-null-label.git tags/0.3.1
subscription_filter_label git::https://github.com/cloudposse/terraform-null-label.git tags/0.3.1
vpc_label git::https://github.com/cloudposse/terraform-null-label.git tags/0.3.1

Resources

Name Type
aws_cloudwatch_log_group.default resource
aws_cloudwatch_log_subscription_filter.default resource
aws_flow_log.eni resource
aws_flow_log.subnets resource
aws_flow_log.vpc resource
aws_iam_role.kinesis resource
aws_iam_role.log resource
aws_iam_role_policy.kinesis resource
aws_iam_role_policy.log resource
aws_kinesis_stream.default resource
aws_iam_policy_document.kinesis data source
aws_iam_policy_document.kinesis_assume data source
aws_iam_policy_document.log data source
aws_iam_policy_document.log_assume data source
aws_region.default data source

Inputs

Name Description Type Default Required
attributes Additional attributes (e.g. policy or role) list(string) [] no
delimiter Delimiter to be used between name, namespace, stage, etc. string "-" no
enabled Set to false to prevent the module from creating anything string "true" no
encryption_type GUID for the customer-managed KMS key to use for encryption. The only acceptable values are NONE or KMS string "NONE" no
eni_ids IDs of ENIs list(string) [] no
filter_pattern Valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events string "[version, account, eni, source, destination, srcport, destport, protocol, packets, bytes, windowstart, windowend, action, flowlogstatus]" no
kms_key_id ID of KMS key string "" no
name Name (e.g. bastion or db) string "" no
namespace Namespace (e.g. cp or cloudposse) string n/a yes
region AWS region string "" no
retention_in_days Number of days you want to retain log events in the log group string "30" no
retention_period Length of time data records are accessible after they are added to the stream string "48" no
shard_count Number of shards that the stream will use string "1" no
shard_level_metrics List of shard-level CloudWatch metrics which can be enabled for the stream list 
[
  "IncomingBytes",
  "OutgoingBytes"
]
 no
stage Stage (e.g. prod, dev, staging) string n/a yes
subnet_ids IDs of subnets list(string) [] no
tags Additional tags (e.g. map(BusinessUnit,XYZ) map(string) {} no
traffic_type Type of traffic to capture. Valid values: ACCEPT,REJECT, ALL string "ALL" no
vpc_id ID of VPC any n/a yes

Outputs

Name Description
eni_flow_ids Flow Log IDs of ENIs
kinesis_arn Kinesis Stream ARN
kinesis_id Kinesis Stream ID
kinesis_name Kinesis Stream name
kinesis_shard_count Kinesis Stream Shard count
log_group_arn ARN of the log group
subnet_flow_ids Flow Log IDs of subnets
vpc_flow_id VPC Flow Log ID

Related Projects

Check out these related projects.

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.

Request Quote

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
  • Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
  • Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
  • GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Request Quote

Day-2: Your Operational Mastery

  • Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
  • Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
  • Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
  • Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
  • Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
  • Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
  • Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

Request Quote

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

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

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. 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!

🌎 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

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

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.

Copyright © 2017-2024 Cloud Posse, LLC

README footer

Beacon