Skip to content

Latest commit

 

History

History
315 lines (234 loc) · 27.2 KB

README.md

File metadata and controls

315 lines (234 loc) · 27.2 KB
Raw

Project Banner

Latest ReleaseSlack Community

This component is responsible for provisioning an AmazonMQ broker and corresponding security group.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component.

components:
  terraform:
    mq-broker:
      vars:
        enabled: true
        apply_immediately: true
        auto_minor_version_upgrade: true
        deployment_mode: "ACTIVE_STANDBY_MULTI_AZ"
        engine_type: "ActiveMQ"
        engine_version: "5.15.14"
        host_instance_type: "mq.t3.micro"
        publicly_accessible: false
        general_log_enabled: true
        audit_log_enabled: true
        encryption_enabled: true
        use_aws_owned_key: true

Requirements

Name Version
terraform >= 1.0.0
aws >= 4.0
local >= 2.4
template >= 2.2
utils >= 1.10.0

Providers

No providers.

Modules

Name Source Version
eks cloudposse/stack-config/yaml//modules/remote-state 1.5.0
iam_roles ../account-map/modules/iam-roles n/a
mq_broker cloudposse/mq-broker/aws 3.0.0
this cloudposse/label/null 0.25.0
vpc cloudposse/stack-config/yaml//modules/remote-state 1.5.0

Resources

No resources.

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
allowed_cidr_blocks List of CIDR blocks that are allowed ingress to the broker's Security Group created in the module list(string) [] no
allowed_security_groups List of security groups to be allowed to connect to the broker instance list(string) [] no
apply_immediately Specifies whether any cluster modifications are applied immediately, or during the next maintenance window bool false 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
audit_log_enabled Enables audit logging. User management action made using JMX or the ActiveMQ Web Console is logged bool true no
auto_minor_version_upgrade Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions bool false 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
deployment_mode The deployment mode of the broker. Supported: SINGLE_INSTANCE and ACTIVE_STANDBY_MULTI_AZ string "ACTIVE_STANDBY_MULTI_AZ" 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
enabled Set to false to prevent the module from creating any resources bool null no
encryption_enabled Flag to enable/disable Amazon MQ encryption at rest bool true no
engine_type Type of broker engine, ActiveMQ or RabbitMQ string "ActiveMQ" no
engine_version The version of the broker engine. See https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html for more details string "5.15.14" no
environment ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' string null no
existing_security_groups List of existing Security Group IDs to place the broker into. Set use_existing_security_groups to true to enable using existing_security_groups as Security Groups for the broker list(string) [] no
general_log_enabled Enables general logging via CloudWatch bool true no
host_instance_type The broker's instance type. e.g. mq.t2.micro or mq.m4.large string "mq.t3.micro" 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
kms_mq_key_arn ARN of the AWS KMS key used for Amazon MQ encryption string null no
kms_ssm_key_arn ARN of the AWS KMS key used for SSM encryption string "alias/aws/ssm" 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
maintenance_day_of_week The maintenance day of the week. e.g. MONDAY, TUESDAY, or WEDNESDAY string "SUNDAY" no
maintenance_time_of_day The maintenance time, in 24-hour format. e.g. 02:00 string "03:00" no
maintenance_time_zone The maintenance time zone, in either the Country/City format, or the UTC offset format. e.g. CET string "UTC" no
mq_admin_password Admin password string null no
mq_admin_password_ssm_parameter_name SSM parameter name for Admin password string "mq_admin_password" no
mq_admin_user Admin username string null no
mq_admin_user_ssm_parameter_name SSM parameter name for Admin username string "mq_admin_username" no
mq_application_password Application password string null no
mq_application_password_ssm_parameter_name SSM parameter name for Application password string "mq_application_password" no
mq_application_user Application username string null no
mq_application_user_ssm_parameter_name SSM parameter name for Application username string "mq_application_username" 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
overwrite_ssm_parameter Whether to overwrite an existing SSM parameter bool true no
publicly_accessible Whether to enable connections from applications outside of the VPC that hosts the broker's subnets bool false 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
region AWS Region string n/a yes
ssm_parameter_name_format SSM parameter name format string "/%s/%s" no
ssm_path SSM path string "mq" 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
use_aws_owned_key Boolean to enable an AWS owned Key Management Service (KMS) Customer Master Key (CMK) for Amazon MQ encryption that is not in your account bool true no
use_existing_security_groups Flag to enable/disable creation of Security Group in the module. Set to true to disable Security Group creation and provide a list of existing security Group IDs in existing_security_groups to place the broker into bool false no

Outputs

Name Description
admin_username AmazonMQ admin username
application_username AmazonMQ application username
broker_arn AmazonMQ broker ARN
broker_id AmazonMQ broker ID
primary_amqp_ssl_endpoint AmazonMQ primary AMQP+SSL endpoint
primary_console_url AmazonMQ active web console URL
primary_ip_address AmazonMQ primary IP address
primary_mqtt_ssl_endpoint AmazonMQ primary MQTT+SSL endpoint
primary_ssl_endpoint AmazonMQ primary SSL endpoint
primary_stomp_ssl_endpoint AmazonMQ primary STOMP+SSL endpoint
primary_wss_endpoint AmazonMQ primary WSS endpoint
secondary_amqp_ssl_endpoint AmazonMQ secondary AMQP+SSL endpoint
secondary_console_url AmazonMQ secondary web console URL
secondary_ip_address AmazonMQ secondary IP address
secondary_mqtt_ssl_endpoint AmazonMQ secondary MQTT+SSL endpoint
secondary_ssl_endpoint AmazonMQ secondary SSL endpoint
secondary_stomp_ssl_endpoint AmazonMQ secondary STOMP+SSL endpoint
secondary_wss_endpoint AmazonMQ secondary WSS endpoint
security_group_arn The ARN of the created security group
security_group_id AmazonMQ security group id
security_group_name The name of the created security group

References

Note

This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.

Learn More

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

Related Projects

Check out these related projects.

  • Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
  • Atmos - Atmos is like docker-compose but for your infrastructure

✨ Contributing

This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:

🐛 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 Cloud Posse's other projects, we would love to hear from you! Hit us up in Slack, in the #cloudposse channel.

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!

About

This project is maintained by Cloud Posse, LLC.

We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.

Learn More

Your team can operate like a pro today.

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

📚 See What's Included
  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
  • Site Reliability Engineering. You'll have total visibility into your apps and microservices.
  • Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
  • GitOps. You'll be able to operate your infrastructure via Pull Requests.
  • Training. You'll receive hands-on training so your team can operate what we build.
  • Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
  • Troubleshooting. You'll get help to triage when things aren't working.
  • Code Reviews. You'll receive constructive feedback on Pull Requests.
  • Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

License

License

Preamble to the Apache License, Version 2.0 

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