AWS prescriptive-guidance documentation change
Summary
Updated documentation for automating RabbitMQ configuration in Amazon MQ, including minor text edits, section reordering (renaming 'Tools' to 'AWS services' and vice versa), reformatting a list in the properties file section, and updating required skills in the epics table to be more generic (e.g., 'General AWS' instead of specific services).
Security assessment
The changes are purely editorial and organizational, involving text simplification, section renaming, and formatting improvements. There is no mention of security vulnerabilities, patches, or incidents. The pre-existing security recommendation to use Ansible Vault for storing passwords remains unchanged and is not a new addition.
Diff
diff --git a/prescriptive-guidance/latest/patterns/automate-rabbitmq-configuration-in-amazon-mq.md b/prescriptive-guidance/latest/patterns/automate-rabbitmq-configuration-in-amazon-mq.md index 268a5c19f..e5f7f50da 100644 --- a//prescriptive-guidance/latest/patterns/automate-rabbitmq-configuration-in-amazon-mq.md +++ b//prescriptive-guidance/latest/patterns/automate-rabbitmq-configuration-in-amazon-mq.md @@ -13 +13 @@ SummaryPrerequisites and limitationsArchitectureToolsEpicsRelated resourcesAttac -[Amazon MQ](https://docs.aws.amazon.com/amazon-mq/) is a managed message broker service that provides compatibility with many popular message brokers. Using Amazon MQ with RabbitMQ provides a robust RabbitMQ cluster managed in the Amazon Web Services (AWS) Cloud with multiple brokers and configuration options. Amazon MQ provides a highly available, secure, and scalable infrastructure, and can process a large number of messages per second with ease. Multiple applications can use the infrastructure with different virtual hosts, queues, and exchanges. However, managing these configuration options or creating the infrastructure manually can require time and effort. This pattern describes a way to manage configurations for RabbitMQ in one step, through a single file. You can embed the code provided with this pattern within any continuous integration (CI) tool such as Jenkins or Bamboo. +[Amazon MQ](https://docs.aws.amazon.com/amazon-mq/) is a managed message broker service that provides compatibility with many popular message brokers. Using Amazon MQ with RabbitMQ provides a robust RabbitMQ cluster managed in the AWS Cloud with multiple brokers and configuration options. Amazon MQ provides a highly available, secure, and scalable infrastructure, and can process a large number of messages per second with ease. Multiple applications can use the infrastructure with different virtual hosts, queues, and exchanges. However, managing these configuration options or creating the infrastructure manually can require time and effort. This pattern describes a way to manage configurations for RabbitMQ in one step, through a single file. You can embed the code provided with this pattern within any continuous integration (CI) tool such as Jenkins or Bamboo. @@ -21 +21 @@ You can use this pattern to configure any RabbitMQ cluster. All it requires is c - * AWS Command Line Interface (AWS CLI) installed and configured to point to your AWS account (for instructions, see [AWS CLI documentation](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2-linux.html)) + * AWS Command Line Interface (AWS CLI) [installed and configured](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2-linux.html) to point to your AWS account @@ -80 +80 @@ There are many ways to configure RabbitMQ. This pattern uses the import configur -**Tools** +**AWS services** @@ -82 +82 @@ There are many ways to configure RabbitMQ. This pattern uses the import configur - * [ rabbitmqadmin](https://www.rabbitmq.com/management-cli.html) is a command-line tool for the RabbitMQ HTTP-based API. It is used to manage and monitor RabbitMQ nodes and clusters. + * [Amazon MQ](https://docs.aws.amazon.com/amazon-mq/) is a managed message broker service that makes it easy to set up and operate message brokers in the cloud. @@ -84 +84 @@ There are many ways to configure RabbitMQ. This pattern uses the import configur - * [Ansible](https://www.ansible.com/) is an open-source tool for automating applications and IT infrastructure. + * [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) helps you set up your AWS infrastructure and speed up cloud provisioning with infrastructure as code. @@ -91 +91 @@ There are many ways to configure RabbitMQ. This pattern uses the import configur -**AWS services** +**Other tools** @@ -93 +93 @@ There are many ways to configure RabbitMQ. This pattern uses the import configur - * [Amazon MQ](https://docs.aws.amazon.com/amazon-mq/) is a managed message broker service that makes it easy to set up and operate message brokers in the cloud. + * [ rabbitmqadmin](https://www.rabbitmq.com/management-cli.html) is a command-line tool for the RabbitMQ HTTP-based API. It is used to manage and monitor RabbitMQ nodes and clusters. @@ -95 +95 @@ There are many ways to configure RabbitMQ. This pattern uses the import configur - * [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) helps you set up your AWS infrastructure and speed up cloud provisioning with infrastructure as code. + * [Ansible](https://www.ansible.com/) is an open-source tool for automating applications and IT infrastructure. @@ -100 +100 @@ There are many ways to configure RabbitMQ. This pattern uses the import configur -**Code** +**Code repository** @@ -108 +108 @@ Task| Description| Skills required -Create a RabbitMQ cluster on AWS.| If you don't already have a RabbitMQ cluster, you can use [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) to create the stack on AWS. Or, you can use the [Cloudformation module in Ansible](https://docs.ansible.com/ansible/latest/collections/amazon/aws/cloudformation_module.html) to create the stack. With the latter approach, you can use Ansible for both tasks: to create the RabbitMQ infrastructure and to manage configurations. | AWS CloudFormation, Ansible +Create a RabbitMQ cluster on AWS.| If you don't already have a RabbitMQ cluster, you can use [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) to create the stack on AWS. Or, you can use the [CloudFormation module in Ansible](https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/cloudformation_module.html) to create the stack. With the latter approach, you can use Ansible for both tasks: to create the RabbitMQ infrastructure and to manage configurations. | General AWS, Ansible @@ -112 +112,7 @@ Task| Description| Skills required -Create a properties file.| Download the JSON configuration file (`rabbitmqconfig.json`) in the attachment, or export it from the RabbitMQ console. Modify it to configure queues, exchanges, and bindings. This configuration file demonstrates the following:\- Creates two queues: `sample-queue1` and `sample-queue2` \- Creates two exchanges: `sample-exchange1` and `sample-exchange2`\- Implements the binding between the queues and exchangesThese configurations are performed under the root (/) virtual host, as required by **rabbitmqadmin**. | JSON +Create a properties file.| Download the JSON configuration file (`rabbitmqconfig.json`) in the attachment, or export it from the RabbitMQ console. Modify it to configure queues, exchanges, and bindings. This configuration file demonstrates the following: + + * Creates two queues: `sample-queue1` and `sample-queue2` + * Creates two exchanges: `sample-exchange1` and `sample-exchange2` + * Implements the binding between the queues and exchanges + +These configurations are performed under the root (/) virtual host, as required by **rabbitmqadmin**. | JSON @@ -124,2 +130,2 @@ You can use the AWS Management Console or the AWS CLI to retrieve this informati -The computer that runs the Ansible playbook must be able to access your AWS account, and AWS CLI must already be configured, as described in the _Prerequisites_ section.| AWS CLI, Amazon MQ -Create the hosts_var file.| Create the `hosts_var` file for Ansible and make sure that all the variables are defined in the file. Consider using Ansible Vault to store the password. You can configure the `hosts_var` file as follows (replace the asterisks with your information): +The computer that runs the Ansible playbook must be able to access your AWS account, and AWS CLI must already be configured, as described in the _Prerequisites_ section.| General AWS +Create the `hosts_var` file.| Create the `hosts_var` file for Ansible and make sure that all the variables are defined in the file. Consider using Ansible Vault to store the password. You can configure the `hosts_var` file as follows (replace the asterisks with your information): @@ -143 +149 @@ Run the playbook.| Run the Ansible playbook that you created in the previous epi -You can verify the new configurations on the RabbitMQ console.| RabbitMQ, Amazon MQ, Ansible +You can verify the new configurations on the RabbitMQ console.| General AWS, RabbitMQ, Ansible