Skip to content

cloudposse/terraform-aws-firewall-manager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

44 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Project Banner

Latest ReleaseLast UpdatedSlack Community

Terraform module to create and manage AWS Firewall Manager policies.

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

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

module "label" {
  source = "cloudposse/label/null"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  namespace = "eg"
  stage     = "prod"
  name      = "fms"
  delimiter = "-"

  tags = {
    "BusinessUnit" = "XYZ",
  }
}

module "vpc" {
  source  = "cloudposse/vpc/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  cidr_block = "10.0.0.0/16"

  context = module.label.context
}

provider "aws" {
  region = "us-east-2"
}

provider "aws" {
  region = "us-east-2"
  alias  = "admin"
  assume_role {
    role_arn = "arn:aws:xyz"
  }
}

module "fms" {
  source = "cloudposse/firewall-manager/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  providers = {
    aws.admin = aws.admin
    aws       = aws
  }

  security_groups_usage_audit_policies = [
    {
      name               = "unused-sg"
      resource_type_list = ["AWS::EC2::SecurityGroup"]

      policy_data = {
        delete_unused_security_groups      = false
        coalesce_redundant_security_groups = false
      }
    }
  ]

  security_groups_content_audit_policies = [
    {
      name               = "maxmimum-allowed"
      resource_type_list = ["AWS::EC2::SecurityGroup"]

      policy_data = {
        security_group_action = "allow"
        security_groups       = [module.vpc.security_group_id]
      }
    }
  ]

  security_groups_common_policies = [
    {
      name               = "disabled-all"
      resource_type_list = ["AWS::EC2::SecurityGroup"]

      policy_data = {
        revert_manual_security_group_changes         = false
        exclusive_resource_security_group_management = false
        apply_to_all_ec2_instance_enis               = false
        security_groups                              = [module.vpc.security_group_id]
      }
    }
  ]

  waf_v2_policies = [
    {
      name               = "linux-policy"
      resource_type_list = ["AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::ApiGateway::Stage"]

      policy_data = {
        default_action                        = "allow"
        override_customer_web_acl_association = false
        pre_process_rule_groups = [
          {
            "managedRuleGroupIdentifier" : {
              "vendorName" : "AWS",
              "managedRuleGroupName" : "AWSManagedRulesLinuxRuleSet",
              "version" : null
            },
            "overrideAction" : { "type" : "NONE" },
            "ruleGroupArn" : null,
            "excludeRules" : [],
            "ruleGroupType" : "ManagedRuleGroup"
          }
        ]
      }
    }
  ]

  context = module.label.context
}

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.

Examples

Here is an example of using this module:

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code
  test/%                              Run Terraform commands in the examples/complete folder; e.g. make test/plan

Requirements

Name Version
terraform >= 1.0
aws >= 4.9.0

Providers

Name Version
aws >= 4.9.0
aws.admin >= 4.9.0

Modules

Name Source Version
dns_firewall_label cloudposse/label/null 0.25.0
firehose_label cloudposse/label/null 0.25.0
firehose_s3_bucket cloudposse/s3-bucket/aws 4.3.0
network_firewall_label cloudposse/label/null 0.25.0
security_groups_common_label cloudposse/label/null 0.25.0
security_groups_content_audit_label cloudposse/label/null 0.25.0
security_groups_usage_audit_label cloudposse/label/null 0.25.0
shield_advanced_label cloudposse/label/null 0.25.0
this cloudposse/label/null 0.25.0
waf_label cloudposse/label/null 0.25.0
waf_v2_label cloudposse/label/null 0.25.0

Resources

Name Type
aws_fms_admin_account.default resource
aws_fms_policy.dns_firewall resource
aws_fms_policy.network_firewall resource
aws_fms_policy.security_groups_common resource
aws_fms_policy.security_groups_content_audit resource
aws_fms_policy.security_groups_usage_audit resource
aws_fms_policy.shield_advanced resource
aws_fms_policy.waf resource
aws_fms_policy.waf_v2 resource
aws_iam_role.firehose_role resource
aws_kinesis_firehose_delivery_stream.firehose_stream resource
aws_iam_policy_document.assume_role data source

Inputs

Name Description Type Default Required
additional_tag_map Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
map(string) {} no
admin_account_enabled Resource for aws_fms_admin_account is enabled and will be created or destroyed bool true no
admin_account_id The AWS account ID to associate to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. Defaults to the current account. string null no
attributes ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
list(string) [] no
context Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
any
{
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"unset"
],
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
}
no
delimiter Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
string null no
descriptor_formats Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
any {} no
dns_firewall_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
pre_process_rule_groups:
A list of maps of pre-proccess rule groups in the format { "ruleGroupId": "rslvr-frg-1", "priority": 10 }.
post_process_rule_groups:
A list of maps post-proccess rule groups in the format { "ruleGroupId": "rslvr-frg-1", "priority": 10 }.
list(any) [] no
enabled Set to false to prevent the module from creating any resources bool null no
environment ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' string null no
firehose_arn Kinesis Firehose ARN used to create a Kinesis Firehose destination for WAF_V2 Rules. Conflicts with firehose_enabled string null no
firehose_enabled Create a Kinesis Firehose destination for WAF_V2 Rules. Conflicts with firehose_arn bool false no
id_length_limit Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
number null no
label_key_case Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
string null no
label_order The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
list(string) null no
label_value_case Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
string null no
labels_as_tags Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
set(string)
[
"default"
]
no
name ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
string null no
namespace ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique string null no
network_firewall_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
stateless_rule_group_references:
A list of maps of configuration blocks containing references to the stateful rule groups that are used in the policy.
Format: { "resourceARN": "arn:aws:network-firewall:us-west-1:1234567891011:stateless-rulegroup/rulegroup2", "priority": 10 }
stateless_default_actions:
A list of actions to take on a packet if it does not match any of the stateless rules in the policy.
You must specify one of the standard actions including: aws:drop, aws:pass, or aws:forward_to_sfe.
In addition, you can specify custom actions that are compatible with your standard action choice.
If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
stateless_fragment_default_actions:
A list of actions to take on a fragmented packet if it does not match any of the stateless rules in the policy.
You must specify one of the standard actions including: aws:drop, aws:pass, or aws:forward_to_sfe.
In addition, you can specify custom actions that are compatible with your standard action choice.
If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
stateless_custom_actions:
A list of maps describing the custom action definitions that are available for use in the firewall policy's stateless_default_actions.
Format: { "actionName": "custom1", "actionDefinition": { "publishMetricAction": { "dimensions": [ { "value": "dimension1" } ] } } }
stateful_rule_group_references_arns:
A list of ARNs of the stateful rule groups.
orchestration_config:
single_firewall_endpoint_per_vpc:
Whether to use single Firewall Endpoint per VPC.
Defaults to false.
allowed_ipv4_cidrs:
A list of allowed ipv4 cidrs.
list(any) [] no
regex_replace_chars Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
string null no
security_groups_common_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
revert_manual_security_group_changes:
Whether to revert manual Security Group changes.
Defaults to false.
exclusive_resource_security_group_management:
Wheter to exclusive resource Security Group management.
Defaults to false.
apply_to_all_ec2_instance_enis:
Whether to apply to all EC2 instance ENIs.
Defaults to false.
security_groups:
A list of Security Group IDs.
list(any) [] no
security_groups_content_audit_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
security_group_action:
For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules.
For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.
Possible values: ALLOW, DENY.
security_groups:
A list of Security Group IDs.
list(any) [] no
security_groups_usage_audit_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
delete_unused_security_groups:
Whether to delete unused Security Groups.
Defaults to false.
coalesce_redundant_security_groups:
Whether to coalesce redundant Security Groups.
Defaults to false.
list(any) n/a yes
shield_advanced_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
delete_unused_fm_managed_resources:
If true, Firewall Manager will automatically remove protections from resources that leave the policy scope.
Defaults to false.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
automatic_response_status:
Status of shield automatic response.
Possible values: ENABLED|IGNORED|DISABLED.
Default is IGNORED.
automatic_response_action:
The automatic response action.
Possible values: BLOCK|COUNT.
Default is null.
override_customer_webacl_classic:
Whether to replace AWS WAF Classic web ACLs with this policy's AWS WAF v2 web ACLs where possible.
Possible values: true|false
Default is false.
list(any) [] no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
tags Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string) {} no
tenant ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for string null no
waf_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
default_action:
The action that you want AWS WAF to take.
Possible values: ALLOW, BLOCK or COUNT.
rule_groups:
A list of rule groups.
list(any) [] no
waf_v2_policies name:
The friendly name of the AWS Firewall Manager Policy.
delete_all_policy_resources:
Whether to perform a clean-up process.
Defaults to true.
exclude_resource_tags:
A boolean value, if true the tags that are specified in the resource_tags are not protected by this policy.
If set to false and resource_tags are populated, resources that contain tags will be protected by this policy.
Defaults to false.
remediation_enabled:
A boolean value, indicates if the policy should automatically applied to resources that already exist in the account.
Defaults to false.
resource_type_list:
A list of resource types to protect. Conflicts with resource_type.
resource_type:
A resource type to protect. Conflicts with resource_type_list.
resource_tags:
A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags.
exclude_account_ids:
A list of AWS Organization member Accounts that you want to exclude from this AWS FMS Policy.
include_account_ids:
A list of AWS Organization member Accounts that you want to include for this AWS FMS Policy.
policy_data:
default_action:
The action that you want AWS WAF to take.
Possible values: ALLOW, BLOCK or COUNT.
override_customer_web_acl_association:
Wheter to override customer Web ACL association
logging_configuration:
The WAFv2 Web ACL logging configuration.
pre_process_rule_groups:
A list of pre-proccess rule groups.
post_process_rule_groups:
A list of post-proccess rule groups.
custom_request_handling:
A custom header for custom request and response handling.
Defaults to null.
custom_response:
A custom response for the web request.
Defaults to null.
sampled_requests_enabled_for_default_actions:
Whether WAF should store a sampling of the web requests that match the rules.
Possible values: true or false.
list(any) [] no

Outputs

Name Description
admin_account AWS Account ID of the designated admin account.

Related Projects

Check out these related projects.

  • terraform-null-label - Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention.

References

For additional context, refer to some of these links.

  • Terraform Standard Module Structure - HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories.
  • Terraform Module Requirements - HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy.
  • Terraform random_integer Resource - The resource random_integer generates random values from a given range, described by the min and max attributes of a given resource.
  • Terraform Version Pinning - The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration

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.

Copyrights

Copyright Β© 2021-2024 Cloud Posse, LLC

README footer

Beacon