Skip to content
This repository has been archived by the owner on Jun 15, 2023. It is now read-only.

Commit

Permalink
Updated the documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Khmelnitsky committed Dec 16, 2019
1 parent 78a916b commit 6c41a75
Show file tree
Hide file tree
Showing 20 changed files with 105 additions and 55 deletions.
8 changes: 4 additions & 4 deletions doc_source/active-standby-broker-deployment.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Amazon MQ Active/Standby Broker for High Availability<a name="active-standby-broker-deployment"></a>

An *active/standby broker* is comprised of two brokers in two different Availability Zones, configured in a *redundant pair*\. These brokers communicate synchronously with your application, and with a shared storage location\.
An *active/standby broker* is comprised of two brokers in two different Availability Zones, configured in a *redundant pair*\. These brokers communicate synchronously with your application, and with Amazon EFS\. For more information, see [Storage](broker-storage.md)\.

Normally, only one of the broker instances is active at any time, while the other broker instance is on standby\. If one of the broker instances malfunctions or undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service, allowing the healthy standby instance to become active and to begin accepting incoming communications\. When you reboot a broker, the failover takes only a few seconds\.
Usually, only one of the broker instances is active at any time, while the other broker instance is on standby\. If one of the broker instances malfunctions or undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service\. This allows the healthy standby instance to become active and to begin accepting incoming communications\. When you reboot a broker, the failover takes only a few seconds\.

For an active/standby broker, Amazon MQ provides two ActiveMQ Web Console URLs, but only one URL is active at a time\. Likewise, Amazon MQ provides two endpoints for each wire\-level protocol, but only one endpoint is active in each pair at a time\. The `-1` and `-2` suffixes denote a redundant pair\. For wire\-level protocol endpoints, you can allow your application to connect to either endpoint by using the [Failover Transport](http://activemq.apache.org/failover-transport-reference.html)\.

The following diagram illustrates an active/standby broker\.
The following diagram illustrates an active/standby broker with Amazon EFS storage\.

![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-architecture-active-standby-deployment.png)
![\[Image NOT FOUND\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/images/amazon-mq-architecture-active-standby-deployment-efs.png)
1 change: 1 addition & 0 deletions doc_source/amazon-mq-basic-elements.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ This section introduces key concepts essential to understanding Amazon MQ\.
+ [Broker](broker.md)
+ [Configuration](configuration.md)
+ [Broker Engine](broker-engine.md)
+ [Broker Storage](broker-storage.md)
+ [User](user.md)
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-broker-architecture.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Amazon MQ Broker Architecture<a name="amazon-mq-broker-architecture"></a>

Amazon MQ brokers can be created as *single\-instance brokers* or *active/standby brokers*\. For both deployment modes, Amazon MQ provides high durability by storing its data redundantly, across multiple Availability Zones \(multi\-AZs\) within an AWS Region\. Amazon MQ ensures high availability by providing failover to a standby instance in a second Availability Zone\.
Amazon MQ brokers can be created as *single\-instance brokers* or *active/standby brokers*\. For both deployment modes, Amazon MQ provides high durability by storing its data redundantly\.

**Note**
Amazon MQ uses [Apache KahaDB](http://activemq.apache.org/kahadb.html) as its data store\. Other data stores, such as JDBC and LevelDB, aren't supported\.
Expand Down
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-creating-applying-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
A *configuration* contains all of the settings for your ActiveMQ broker, in XML format \(similar to ActiveMQ's `activemq.xml` file\)\. You can create a configuration before creating any brokers\. You can then apply the configuration to one or more brokers\. You can apply a configuration immediately or during a *maintenance window*\.

**Note**
For an active/standby broker, if one of the broker instances undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service, allowing the healthy standby instance to become active and to begin accepting incoming communications\.
For an active/standby broker, if one of the broker instances undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service\. This allows the healthy standby instance to become active and to begin accepting incoming communications\.

For more information, see the following:
+ [Configuration](configuration.md)
Expand Down
30 changes: 16 additions & 14 deletions doc_source/amazon-mq-creating-configuring-broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,24 @@ The first and most common Amazon MQ task is creating a broker\. The following ex

1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\.

1. Do one of the following:
+ If this is your first time using Amazon MQ, in the **Create a broker** section, type `MyBroker` for **Broker name** and then choose **Next step**\.
+ If you have created a broker before, on the **Create a broker** page, in the **Details** section, type `MyBroker` for **Broker name**\.
1. One the **Select deployment and storage** page, in the **Deployment mode and storage type** section, do the following:

This comment has been minimized.

Copy link
@Redhunt2013

Redhunt2013 Jan 10, 2020

Typo. This should read as "In the ... page..." or anything more appropriately.

This comment has been minimized.

Copy link
@mig281

mig281 Jan 14, 2020

Sounds good. Fixing.


1. In the **Details** section, choose a **Broker instance type** \(for example, **mq\.m5\.large**\)\. For more information, see [Instance Types](broker.md#broker-instance-types)\.
1. Choose the **Deployment mode** \(for example, **Active/standby broker**\)\. For more information, see [Amazon MQ Broker Architecture](amazon-mq-broker-architecture.md)\.
+ A **Single\-instance broker** is comprised of one broker in one Availability Zone\. The broker communicates with your application and with Amazon EFS \(by default\) or with Amazon EBS\. For more information, see [Amazon MQ Single\-Instance Broker](single-broker-deployment.md)\.
+ An **Active/standby broker for high availability** is comprised of two brokers in two different Availability Zones, configured in a *redundant pair*\. These brokers communicate synchronously with your application, and with Amazon EFS\. For more information, see [Amazon MQ Active/Standby Broker for High Availability](active-standby-broker-deployment.md)\.
+ For more information on the sample blueprints for a network of brokers, see [Sample Blueprints](network-of-brokers.md#sample-deployments)\.

1. Choose a **Deployment mode**:
+ A **Single\-instance broker** is comprised of one broker in one Availability Zone\. The broker communicates with your application and with an AWS storage location\. For more information, see [Amazon MQ Single\-Instance Broker](single-broker-deployment.md)\.
+ An **Active/standby broker for high availability** is comprised of two brokers in two different Availability Zones, configured in a *redundant pair*\. These brokers communicate synchronously with your application, and with a shared storage location\. For more information, see [Amazon MQ Active/Standby Broker for High Availability](active-standby-broker-deployment.md)\.
+ For more information on the sample blueprints for a network of brokers, see [Sample Blueprints](network-of-brokers.md#sample-deployments)\.
1. Choose the **Storage type** \(for example, **EBS**\)\. For more information, see [Storage](broker-storage.md)\.
**Note**
Currently, Amazon MQ supports only `ActiveMQ` broker engine versions `5.15.8`, `5.15.6` and `5.15.0`\.
Amazon EBS replicates data within a single Availability Zone and doesn't support the [active/standby](active-standby-broker-deployment.md) deployment mode\.

1. Choose a **Broker engine** version\.
**Note**
Currently, Amazon MQ supports only `ActiveMQ` broker engine versions `5.15.8`, `5.15.6` and `5.15.0`\.
1. Choose **Next**\.

1. On the **Configure settings** page, in the **Details** section, do the following:

1. Enter the **Broker name**\.

1. Choose the **Broker instance type** \(for example, **mq\.m5\.large**\)\. For more information, see [Instance Types](broker.md#broker-instance-types)\.

1. In the **ActiveMQ Web Console access** section, type a **Username** and **Password**\.

Expand Down Expand Up @@ -71,15 +73,15 @@ If you don't [configure a resource\-based policy for Amazon MQ](amazon-mq-config

1. To upgrade the broker to new versions as Apache releases them, choose **Enable automatic minor version upgrades**\. Automatic upgrades occur during the *maintenance window* defined by the day of the week, the time of day \(in 24\-hour format\), and the time zone \(UTC by default\)\.
**Note**
For an active/standby broker, if one of the broker instances undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service, allowing the healthy standby instance to become active and to begin accepting incoming communications\.
For an active/standby broker, if one of the broker instances undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service\. This allows the healthy standby instance to become active and to begin accepting incoming communications\.

1. Do one of the following:
+ To allow Amazon MQ to select the maintenance window automatically, choose **No preference**\.
+ To set a custom maintenance window, choose **Select maintenance window** and then specify the **Start day** and **Start time** of the upgrades\.

## Step 3: Finish Creating the Broker<a name="finish-creating-broker-console"></a>

1. Choose **Create broker**\.
1. Choose **Deploy**\.

While Amazon MQ creates your broker, it displays the **Creation in progress** status\.

Expand Down
3 changes: 2 additions & 1 deletion doc_source/amazon-mq-documentation-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The following table lists changes to the *Amazon MQ Developer Guide*\. For Amazo

| Date | Documentation Update |
| --- | --- |
| December 16, 2019 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-documentation-history.html) |
| July 19, 2019 | Modified and added content on encryption management in the following sections: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-documentation-history.html) |
| April 22, 2019 | Added the following sections for tag\-based policies and resource\-level permissions: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-documentation-history.html) |
| March 4, 2019 | Improved the documentation for configuring dynamic failover and the rebalancing of clients for a network of brokers\. Enable dynamic failover by configuring transportConnectors along with networkConnectors configuration options\. [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-documentation-history.html) |
Expand Down Expand Up @@ -45,7 +46,7 @@ The following table lists changes to the *Amazon MQ Developer Guide*\. For Amazo
| April 2, 2018 | Moved the Concurrent Store and Dispatch for Queues in Amazon MQ section to the [Disable Concurrent Store and Dispatch for Queues with Slow Consumers](ensuring-effective-amazon-mq-performance.md#disable-concurrent-store-and-dispatch-queues-flag-slow-consumers) section\. |
| March 27, 2018 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-documentation-history.html) |
| March 22, 2018 | Clarified the following statement throughout this guide: Amazon MQ encrypts messages at rest and in transit using encryption keys that it manages and stores securely\. For additional security, we highly recommend designing your application to use client\-side encryption\. For more information, see the [AWS Encryption SDK Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/)\. |
| March 19, 2018 | Clarified the following statement throughout this guide: An Active/standby broker is comprised of two brokers in two different Availability Zones, configured in a redundant pair\. These brokers communicate synchronously with your application, and with a shared storage location\. |
| March 19, 2018 | Clarified the following statement throughout this guide: An Active/standby broker is comprised of two brokers in two different Availability Zones, configured in a redundant pair\. These brokers communicate synchronously with your application, and with Amazon EFS\. |
| March 15, 2018 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-documentation-history.html) |
| March 12, 2018 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-documentation-history.html) |
| March 9, 2018 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-documentation-history.html) |
Expand Down
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-editing-broker-preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you don't [configure a resource\-based policy for Amazon MQ](amazon-mq-config

To upgrade the broker to new versions as AWS releases them, choose **Enable automatic minor version upgrades**\. Automatic upgrades occur during the *maintenance window* defined by the day of the week, the time of day \(in 24\-hour format\), and the time zone \(UTC by default\)\.
**Note**
For an active/standby broker, if one of the broker instances undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service, allowing the healthy standby instance to become active and to begin accepting incoming communications\.
For an active/standby broker, if one of the broker instances undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service\. This allows the healthy standby instance to become active and to begin accepting incoming communications\.

1. Choose **Schedule modifications**\.
**Note**
Expand Down
2 changes: 1 addition & 1 deletion doc_source/amazon-mq-editing-managing-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
A *configuration* contains all of the settings for your ActiveMQ broker, in XML format \(similar to ActiveMQ's `activemq.xml` file\)\. You can apply a configuration immediately or during a *maintenance window*\.

**Note**
For an active/standby broker, if one of the broker instances undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service, allowing the healthy standby instance to become active and to begin accepting incoming communications\.
For an active/standby broker, if one of the broker instances undergoes maintenance, it takes Amazon MQ a short while to take the inactive instance out of service\. This allows the healthy standby instance to become active and to begin accepting incoming communications\.

To keep track of the changes you make to your configuration, you can create *configuration revisions*\.

Expand Down
27 changes: 16 additions & 11 deletions doc_source/amazon-mq-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,23 +25,28 @@ The first and most common Amazon MQ task is creating a broker\. The following ex

1. Sign in to the [Amazon MQ console](https://console.aws.amazon.com/amazon-mq/)\.

1. Do one of the following:
+ If this is your first time using Amazon MQ, in the **Create a broker** section, type `MyBroker` for **Broker name** and then choose **Next step**\.
+ If you have created a broker before, on the **Create a broker** page, in the **Details** section, type `MyBroker` for **Broker name**\.
1. One the **Select deployment and storage** page, in the **Deployment mode and storage type** section, do the following:

1. In the **Details** section, choose a **Broker instance type** \(for example, **mq\.m5\.large**\)\. For more information, see [Instance Types](broker.md#broker-instance-types)\.
1. Choose the **Deployment mode** \(for example, **Active/standby broker**\)\. For more information, see [Amazon MQ Broker Architecture](amazon-mq-broker-architecture.md)\.
+ A **Single\-instance broker** is comprised of one broker in one Availability Zone\. The broker communicates with your application and with Amazon EFS \(by default\) or with Amazon EBS\. For more information, see [Amazon MQ Single\-Instance Broker](single-broker-deployment.md)\.
+ An **Active/standby broker for high availability** is comprised of two brokers in two different Availability Zones, configured in a *redundant pair*\. These brokers communicate synchronously with your application, and with Amazon EFS\. For more information, see [Amazon MQ Active/Standby Broker for High Availability](active-standby-broker-deployment.md)\.
+ For more information on the sample blueprints for a network of brokers, see [Sample Blueprints](network-of-brokers.md#sample-deployments)\.

1. Choose a **Deployment mode**\. In this example, **Single\-instance broker** is selected\.
+ A **Single\-instance broker** is comprised of one broker in one Availability Zone\. The broker communicates with your application and with an AWS storage location\. For more information, see [Amazon MQ Single\-Instance Broker](single-broker-deployment.md)\.
+ An **Active/standby broker for high availability** is comprised of two brokers in two different Availability Zones, configured in a *redundant pair*\. These brokers communicate synchronously with your application, and with a shared storage location\. For more information, see [Amazon MQ Active/Standby Broker for High Availability](active-standby-broker-deployment.md)\.

1. Choose a **Broker engine** version\.
1. Choose the **Storage type** \(for example, **EBS**\)\. For more information, see [Storage](broker-storage.md)\.
**Note**
Currently, Amazon MQ supports only `ActiveMQ` broker engine versions `5.15.8`, `5.15.6` and `5.15.0`\.
Amazon EBS replicates data within a single Availability Zone and doesn't support the [active/standby](active-standby-broker-deployment.md) deployment mode\.

1. Choose **Next**\.

1. On the **Configure settings** page, in the **Details** section, do the following:

1. Enter the **Broker name**\.

1. Choose the **Broker instance type** \(for example, **mq\.m5\.large**\)\. For more information, see [Instance Types](broker.md#broker-instance-types)\.

1. In the **ActiveMQ Web Console access** section, type a **Username** and **Password**\.

1. Choose **Create broker**\.
1. Choose **Deploy**\.

While Amazon MQ creates your broker, it displays the **Creation in progress** status\.

Expand Down
Loading

0 comments on commit 6c41a75

Please sign in to comment.