https://github.com/massdriver-cloud/aws-mq-rabbitmq
https://github.com/massdriver-cloud/aws-mq-rabbitmq
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/massdriver-cloud/aws-mq-rabbitmq
- Owner: massdriver-cloud
- Created: 2023-05-21T06:16:10.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T19:13:55.000Z (9 months ago)
- Last Synced: 2025-01-23T03:13:37.328Z (5 months ago)
- Language: HCL
- Homepage: https://massdriver.cloud
- Size: 33.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Massdriver][logo]][website]
# aws-mq-rabbitmq
[![Release][release_shield]][release_url]
[![Contributors][contributors_shield]][contributors_url]
[![Forks][forks_shield]][forks_url]
[![Stargazers][stars_shield]][stars_url]
[![Issues][issues_shield]][issues_url]
[![MIT License][license_shield]][license_url]
AWS MQ Broker for RabbitMQ is a managed message broker service that simplifies the deployment and maintenance of RabbitMQ in the AWS cloud.
---
## Design
For detailed information, check out our [Operator Guide](operator.md) for this bundle.
## Usage
Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the [Massdriver][website] platform.
### What are Bundles?
Bundles are the basic building blocks of infrastructure, applications, and architectures in [Massdriver][website]. Read more [here](https://docs.massdriver.cloud/concepts/bundles).
## Bundle
### Params
Form input parameters for configuring a bundle for deployment.
View
## Properties
- **`broker`** *(object)*
- **`apply_immediately`** *(boolean)*: Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default: `False`.
- **`deployment_mode`** *(string)*: [Single instance](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/rabbitmq-broker-architecture-single-instance.html) will provision a cost-effective single broker suitable for development, while a [highly available cluster](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/rabbitmq-broker-architecture-cluster.html) will create multiple brokers spread accross availability zones providing massive scalability and high availability even in the event of zonal outage. **NOTE** this setting cannot be changed after creation. Default: `SINGLE_INSTANCE`.
- **One of**
- Single Instance
- Highly Available Cluster
- **`engine_version`** *(string)*: RabbitMQ engine version. Must be one of: `['3.10', '3.9', '3.8']`. Default: `3.10`.
- **`instance_type`** *(string)*: **Note:** You cannot downgrade a broker from any `mq.m5.*` instance type to the `mq.t3.micro` instance type.
- **`monitoring`** *(object)*
- **`general_logging`** *(boolean)*: Enables cluster logging to AWS Cloudwatch. Default: `False`.
- **`mode`** *(string)*: Enable and customize CloudWatch metric alarms. Default: `AUTOMATED`.
- **One of**
- Automated
- Custom
- Disabled
## Examples
```json
{
"__name": "Single-Broker (Development)",
"broker": {
"apply_immediately": false,
"deployment_mode": "SINGLE_INSTANCE",
"engine_version": "3.10",
"instance_type": "mq.t3.micro"
},
"monitoring": {
"general_logging": false,
"mode": "AUTOMATED"
}
}
```
```json
{
"__name": "Multi-Broker Cluster (Production)",
"broker": {
"apply_immediately": false,
"deployment_mode": "CLUSTER_MULTI_AZ",
"engine_version": "3.10",
"instance_type": "mq.m5.large"
},
"monitoring": {
"general_logging": true,
"mode": "AUTOMATED"
}
}
```
### Connections
Connections from other bundles that this bundle depends on.
View
## Properties
- **`aws_authentication`** *(object)*: . Cannot contain additional properties.
- **`data`** *(object)*
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`external_id`** *(string)*: An external ID is a piece of data that can be passed to the AssumeRole API of the Security Token Service (STS). You can then use the external ID in the condition element in a role's trust policy, allowing the role to be assumed only when a certain value is present in the external ID.
- **`specs`** *(object)*
- **`aws`** *(object)*: .
- **`region`** *(string)*: AWS Region to provision in.
Examples:
```json
"us-west-2"
```
- **`vpc`** *(object)*: . Cannot contain additional properties.
- **`data`** *(object)*
- **`infrastructure`** *(object)*
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`cidr`** *(string)*
Examples:
```json
"10.100.0.0/16"
```
```json
"192.24.12.0/22"
```
- **`internal_subnets`** *(array)*
- **Items** *(object)*: AWS VCP Subnet.
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
Examples:
- **`private_subnets`** *(array)*
- **Items** *(object)*: AWS VCP Subnet.
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
Examples:
- **`public_subnets`** *(array)*
- **Items** *(object)*: AWS VCP Subnet.
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
Examples:
- **`specs`** *(object)*
- **`aws`** *(object)*: .
- **`region`** *(string)*: AWS Region to provision in.
Examples:
```json
"us-west-2"
```
### Artifacts
Resources created by this bundle that can be connected to other bundles.
View
## Properties
- **`rabbitmq`** *(object)*: RabbitMQ cluster authentication.
- **`data`** *(object)*
- **`authentication`**: RabbitMQ Authentication.
- **`hostname`** *(string)*
- **`password`** *(string)*
- **`port`** *(integer)*: Port number. Minimum: `0`. Maximum: `65535`.
- **`username`** *(string)*
- **`infrastructure`** *(object)*: Cloud specific RabbitMQ infrastructure configuration.
- **One of**
- AWS Infrastructure ARN*object*: Minimal AWS Infrastructure Config. Cannot contain additional properties.
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- Kuberenetes infrastructure config*object*: . Cannot contain additional properties.
- **`kubernetes_namespace`** *(string)*
- **`kubernetes_service`** *(string)*
- **`security`** *(object)*
- **Any of**
- AWS Security information*object*: Informs downstream services of network and/or IAM policies. Cannot contain additional properties.
- **`iam`** *(object)*: IAM Policies. Cannot contain additional properties.
- **`^[a-z]+[a-z_]*[a-z]+$`** *(object)*
- **`policy_arn`** *(string)*: AWS IAM policy ARN.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`identity`** *(object)*: For instances where IAM policies must be attached to a role attached to an AWS resource, for instance AWS Eventbridge to Firehose, this attribute should be used to allow the downstream to attach it's policies (Firehose) directly to the IAM role created by the upstream (Eventbridge). It is important to remember that connections in massdriver are one way, this scheme perserves the dependency relationship while allowing bundles to control the lifecycles of resources under it's management. Cannot contain additional properties.
- **`role_arn`** *(string)*: ARN for this resources IAM Role.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`network`** *(object)*: AWS security group rules to inform downstream services of ports to open for communication. Cannot contain additional properties.
- **`^[a-z-]+$`** *(object)*
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`port`** *(integer)*: Port number. Minimum: `0`. Maximum: `65535`.
- **`protocol`** *(string)*: Must be one of: `['tcp', 'udp']`.
- **`specs`** *(object)*
- **`aws`** *(object)*: .
- **`region`** *(string)*: AWS Region to provision in.
Examples:
```json
"us-west-2"
```
- **`azure`** *(object)*: .
- **`region`** *(string)*: Select the Azure region you'd like to provision your resources in.
- **`gcp`** *(object)*: .
- **`project`** *(string)*
- **`region`** *(string)*: The GCP region to provision resources in.
Examples:
```json
"us-east1"
```
```json
"us-east4"
```
```json
"us-west1"
```
```json
"us-west2"
```
```json
"us-west3"
```
```json
"us-west4"
```
```json
"us-central1"
```
- **`rabbitmq`** *(object)*: RabbitMQ specific public information.
- **`version`** *(string)*: Currently deployed RabbitMQ version.
## Contributing
### Bug Reports & Feature Requests
Did we miss something? Please [submit an issue](https://github.com/massdriver-cloud/aws-mq-rabbitmq/issues) to report any bugs or request additional features.
### Developing
**Note**: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the [Massdriver][website] platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.
Still want to get involved? First check out our [contribution guidelines](https://docs.massdriver.cloud/bundles/contributing).
### Fix or Fork
If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or [create your own bundle from scratch](https://docs.massdriver.cloud/bundles/development)!
## Connect
Questions? Concerns? Adulations? We'd love to hear from you!
Please connect with us!
[![Email][email_shield]][email_url]
[![GitHub][github_shield]][github_url]
[![LinkedIn][linkedin_shield]][linkedin_url]
[![Twitter][twitter_shield]][twitter_url]
[![YouTube][youtube_shield]][youtube_url]
[![Reddit][reddit_shield]][reddit_url]
[logo]: https://raw.githubusercontent.com/massdriver-cloud/docs/main/static/img/logo-with-logotype-horizontal-400x110.svg
[docs]: https://docs.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=aws-mq-rabbitmq&utm_content=docs
[website]: https://www.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=aws-mq-rabbitmq&utm_content=website
[github]: https://github.com/massdriver-cloud?utm_source=github&utm_medium=readme&utm_campaign=aws-mq-rabbitmq&utm_content=github
[slack]: https://massdriverworkspace.slack.com/?utm_source=github&utm_medium=readme&utm_campaign=aws-mq-rabbitmq&utm_content=slack
[linkedin]: https://www.linkedin.com/company/massdriver/?utm_source=github&utm_medium=readme&utm_campaign=aws-mq-rabbitmq&utm_content=linkedin
[contributors_shield]: https://img.shields.io/github/contributors/massdriver-cloud/aws-mq-rabbitmq.svg?style=for-the-badge
[contributors_url]: https://github.com/massdriver-cloud/aws-mq-rabbitmq/graphs/contributors
[forks_shield]: https://img.shields.io/github/forks/massdriver-cloud/aws-mq-rabbitmq.svg?style=for-the-badge
[forks_url]: https://github.com/massdriver-cloud/aws-mq-rabbitmq/network/members
[stars_shield]: https://img.shields.io/github/stars/massdriver-cloud/aws-mq-rabbitmq.svg?style=for-the-badge
[stars_url]: https://github.com/massdriver-cloud/aws-mq-rabbitmq/stargazers
[issues_shield]: https://img.shields.io/github/issues/massdriver-cloud/aws-mq-rabbitmq.svg?style=for-the-badge
[issues_url]: https://github.com/massdriver-cloud/aws-mq-rabbitmq/issues
[release_url]: https://github.com/massdriver-cloud/aws-mq-rabbitmq/releases/latest
[release_shield]: https://img.shields.io/github/release/massdriver-cloud/aws-mq-rabbitmq.svg?style=for-the-badge
[license_shield]: https://img.shields.io/github/license/massdriver-cloud/aws-mq-rabbitmq.svg?style=for-the-badge
[license_url]: https://github.com/massdriver-cloud/aws-mq-rabbitmq/blob/main/LICENSE
[email_url]: mailto:[email protected]
[email_shield]: https://img.shields.io/badge/email-Massdriver-black.svg?style=for-the-badge&logo=mail.ru&color=000000
[github_url]: mailto:[email protected]
[github_shield]: https://img.shields.io/badge/follow-Github-black.svg?style=for-the-badge&logo=github&color=181717
[linkedin_url]: https://linkedin.com/in/massdriver-cloud
[linkedin_shield]: https://img.shields.io/badge/follow-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&color=0A66C2
[twitter_url]: https://twitter.com/massdriver?utm_source=github&utm_medium=readme&utm_campaign=aws-mq-rabbitmq&utm_content=twitter
[twitter_shield]: https://img.shields.io/badge/follow-Twitter-black.svg?style=for-the-badge&logo=twitter&color=1DA1F2
[discourse_url]: https://community.massdriver.cloud?utm_source=github&utm_medium=readme&utm_campaign=aws-mq-rabbitmq&utm_content=discourse
[discourse_shield]: https://img.shields.io/badge/join-Discourse-black.svg?style=for-the-badge&logo=discourse&color=000000
[youtube_url]: https://www.youtube.com/channel/UCfj8P7MJcdlem2DJpvymtaQ
[youtube_shield]: https://img.shields.io/badge/subscribe-Youtube-black.svg?style=for-the-badge&logo=youtube&color=FF0000
[reddit_url]: https://www.reddit.com/r/massdriver
[reddit_shield]: https://img.shields.io/badge/subscribe-Reddit-black.svg?style=for-the-badge&logo=reddit&color=FF4500