From 18521b95a3d162067a0af4220defe0daaae1f6fb Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Tue, 16 Jul 2024 17:00:18 -0700 Subject: [PATCH 01/14] Added info from ADR-RSMQ-005. --- modules/ROOT/pages/mq-failover.adoc | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/modules/ROOT/pages/mq-failover.adoc b/modules/ROOT/pages/mq-failover.adoc index 66119b69..244f6c4a 100644 --- a/modules/ROOT/pages/mq-failover.adoc +++ b/modules/ROOT/pages/mq-failover.adoc @@ -1,8 +1,11 @@ = Configuring Cross-Region Failover for Standard Queues -Anypoint Connector for Anypoint MQ (Anypoint MQ Connector) for Mule 4 version 4.0.7 provides failover capability for standard queues. +You can configure failover by specifying a fallback region for standard queues using Anypoint Connector for Anypoint MQ (Anypoint MQ Connector) for Mule 4 version 4.0.9 and later. -When you enable failover for a queue, Anypoint MQ automatically creates a fallback queue in a <>. +* To use the failover feature with the default region, use connector version 4.0.7 or later. +* To configure a specific failover region, use connector version 4.0.9 or later. + +When you enable failover for a queue, Anypoint MQ automatically creates a fallback queue in a default or custom <>. If a Mule app can't reach an Anypoint MQ server in a region, it switches to the fallback queue to publish and consume messages. For information about situations that can cause a region to be considered unavailable, see <>. @@ -36,6 +39,7 @@ When you disable failover for a queue, apps can still consume any messages that For information about enabling this feature in your app, see xref:anypoint-mq-connector::anypoint-mq-failover.adoc#enable-failover-feature[Enable Failover in Your App]. ** Failover support requires Anypoint MQ Connector 4.0.7 or later. +** Custom fallback region support requires Anypoint MQ Connector 4.0.9 or later. // + // xref to upgrade steps? ** Failover is supported for standard queues only. @@ -48,9 +52,10 @@ xref:anypoint-mq-connector::anypoint-mq-failover.adoc#enable-failover-feature[En + If failover is enabled for queues in those regions and the primary region goes down, data resides in a region outside the country until the primary region is available. +To change the fallback region, upgrade to Anypoint MQ Connector 4.0.9 or later. -- + -For the list of fallback regions, see <>. +For the list of default fallback regions, see <>. * Authentication + If access management is unavailable when the connector switches to the fallback region, @@ -77,7 +82,7 @@ You can configure how frequently the connector checks the fallback queue. See xr To use failover, you must first: -* Upgrade Anypoint MQ Connector to 4.0.7 or later. +* Upgrade Anypoint MQ Connector to 4.0.7 or later (default fallback region) or 4.0.9 or later (custom fallback region). + For information, see xref:anypoint-mq-connector::anypoint-mq-connector-upgrade-migrate.adoc[]. * Enable the failover feature in your app. @@ -210,7 +215,14 @@ image::mq-queue-details-primary-queue-fallback-disabled.png["Details pane for th [[primary-fallback-regions]] -== Primary-Fallback Regions +== Default Primary-Fallback Regions + +By default, Anypoint MQ Connector uses the default primary-fallback region pairings. + +With version 4.0.9 and later of the connector, you can specify the fallback region, for example, +to prevent data from residing in a different country for compliance reasons. + +IMPORTANT: To minimize latency, use the default fallback region. [%header,cols="8,12,12,12,12"] |=== From 6b13a39082a9a72439a9b101bd921b19bddac873 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Wed, 17 Jul 2024 16:27:15 -0700 Subject: [PATCH 02/14] glossary changes --- modules/ROOT/pages/_partials/mq-failover.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/_partials/mq-failover.adoc b/modules/ROOT/pages/_partials/mq-failover.adoc index 4159502c..2e9f2de5 100644 --- a/modules/ROOT/pages/_partials/mq-failover.adoc +++ b/modules/ROOT/pages/_partials/mq-failover.adoc @@ -6,8 +6,8 @@ For example, if the primary queue name is `myDemoQueue`, the fallback queue name // Fallback queues aren't configurable by end users // tag::fallbackQnotConfig[] -The Anypoint MQ server manages fallback queues and regions; -end users can't configure them. +The Anypoint MQ server manages fallback queues; end users can't configure them. +With Anypoint MQ Connector version 4.0.9, you can specify a custom fallback region for a queue. // end::fallbackQnotConfig[] // Fallback queues inherit settings from primary queue From 5317bfa1aaa8939222a9cd6a8266d7482f0edd3f Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Fri, 19 Jul 2024 13:04:51 -0700 Subject: [PATCH 03/14] can't change fallback region after queue creation --- modules/ROOT/pages/_partials/mq-failover.adoc | 8 +++++++- modules/ROOT/pages/mq-failover.adoc | 17 +++++++++++++++-- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/pages/_partials/mq-failover.adoc b/modules/ROOT/pages/_partials/mq-failover.adoc index 2e9f2de5..4964d523 100644 --- a/modules/ROOT/pages/_partials/mq-failover.adoc +++ b/modules/ROOT/pages/_partials/mq-failover.adoc @@ -22,4 +22,10 @@ syncing the queue configuration. // tag::fallbackDLQ[] If the primary queue has an assigned dead-letter queue (DLQ), you must enable failover for the DLQ before enabling failover for the primary queue. -// end::fallbackDLQ[] \ No newline at end of file +// end::fallbackDLQ[] + +// Change fallback region +// tag::changeFallbackRegion[] +You can't change a custom fallback region after you create the queue. +To change the region, delete the queue and select a new region. +// end::changeFallbackRegion[] diff --git a/modules/ROOT/pages/mq-failover.adoc b/modules/ROOT/pages/mq-failover.adoc index 244f6c4a..e86d1d9d 100644 --- a/modules/ROOT/pages/mq-failover.adoc +++ b/modules/ROOT/pages/mq-failover.adoc @@ -5,6 +5,7 @@ You can configure failover by specifying a fallback region for standard queues u * To use the failover feature with the default region, use connector version 4.0.7 or later. * To configure a specific failover region, use connector version 4.0.9 or later. + When you enable failover for a queue, Anypoint MQ automatically creates a fallback queue in a default or custom <>. If a Mule app can't reach an Anypoint MQ server in a region, it switches to the fallback queue to publish and consume messages. @@ -40,6 +41,8 @@ For information about enabling this feature in your app, see xref:anypoint-mq-connector::anypoint-mq-failover.adoc#enable-failover-feature[Enable Failover in Your App]. ** Failover support requires Anypoint MQ Connector 4.0.7 or later. ** Custom fallback region support requires Anypoint MQ Connector 4.0.9 or later. ++ +include::partial$mq-failover.adoc[tag=changeFallbackRegion] // + // xref to upgrade steps? ** Failover is supported for standard queues only. @@ -123,6 +126,13 @@ For information about queue settings, see xref:mq-queues.adoc#create-a-queue[Cre + image::mq-create-queues-failover.png["Create Queue popup dialog box with failover option selected"] // added screenshot +.. Select the fallback region. ++ +If you are using an Anypoint MQ Connector version earlier 4.0.9, +leave the fallback region set at the default. ++ +[NOTE] +include::partial$mq-failover.adoc[tag=changeFallbackRegion] .. Click *Create Queue*. + Anypoint MQ creates the queue and also creates a fallback queue in the fallback region. @@ -142,6 +152,9 @@ Anypoint MQ supports failover for standard queues only. + image::mq-queue-settings-failover.png["Queue Settings page with failover option selected"] // added screenshot ++ +[NOTE] +include::partial$mq-failover.adoc[tag=changeFallbackRegion] .. Click *Save Changes*. + @@ -245,11 +258,11 @@ IMPORTANT: To minimize latency, use the default fallback region. [[region-note-unavailable]] ^***^ {empty} Because Anypoint MQ is available in only one region in this country, -the fallback region is not in the same country as the primary region. +the default fallback region is not in the same country as the primary region. [[region-note]] ^****^ {empty} -The fallback region for this region is not in the same country as the primary region. +The default fallback region for this region is not in the same country as the primary region. [[region-unavailability]] == Region Unavailability From 89b6fdacb92a89cefa597fe050b21cb3ff163879 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Mon, 22 Jul 2024 17:27:27 -0700 Subject: [PATCH 04/14] No UI changes per Jash --- modules/ROOT/pages/mq-failover.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/mq-failover.adoc b/modules/ROOT/pages/mq-failover.adoc index e86d1d9d..72924a5c 100644 --- a/modules/ROOT/pages/mq-failover.adoc +++ b/modules/ROOT/pages/mq-failover.adoc @@ -126,6 +126,7 @@ For information about queue settings, see xref:mq-queues.adoc#create-a-queue[Cre + image::mq-create-queues-failover.png["Create Queue popup dialog box with failover option selected"] // added screenshot +//// .. Select the fallback region. + If you are using an Anypoint MQ Connector version earlier 4.0.9, @@ -133,6 +134,7 @@ leave the fallback region set at the default. + [NOTE] include::partial$mq-failover.adoc[tag=changeFallbackRegion] +//// .. Click *Create Queue*. + Anypoint MQ creates the queue and also creates a fallback queue in the fallback region. @@ -163,7 +165,7 @@ Anypoint MQ updates the queue settings and creates a fallback queue in the fallb include::partial$mq-failover.adoc[tag=fallbackQname] + // Fallback queue/region not configurable -include::partial$mq-failover.adoc[tag=fallbackQnotConfig] +// include::partial$mq-failover.adoc[tag=fallbackQnotConfig] + If you previously enabled failover for the queue, the fallback queue already exists and is reinstated. .. Restart all applications consuming from or publishing to the queue. From e3d88d78f9578b040a12b545ce59761499273647 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Wed, 24 Jul 2024 15:43:14 -0700 Subject: [PATCH 05/14] Jash feedback --- modules/ROOT/pages/_partials/mq-failover.adoc | 18 +++++++---- modules/ROOT/pages/mq-failover.adoc | 32 ++++++++++--------- modules/ROOT/pages/mq-glossary.adoc | 10 ++++++ 3 files changed, 39 insertions(+), 21 deletions(-) diff --git a/modules/ROOT/pages/_partials/mq-failover.adoc b/modules/ROOT/pages/_partials/mq-failover.adoc index 4964d523..4f91a223 100644 --- a/modules/ROOT/pages/_partials/mq-failover.adoc +++ b/modules/ROOT/pages/_partials/mq-failover.adoc @@ -7,9 +7,19 @@ For example, if the primary queue name is `myDemoQueue`, the fallback queue name // Fallback queues aren't configurable by end users // tag::fallbackQnotConfig[] The Anypoint MQ server manages fallback queues; end users can't configure them. -With Anypoint MQ Connector version 4.0.9, you can specify a custom fallback region for a queue. // end::fallbackQnotConfig[] +// Specify custom fallback region +// tag::fallbackRegionCustom[] +With Anypoint MQ Connector version 4.0.9, you can specify a custom fallback region for a queue. +// end::fallbackRegionCustom[] + +// Change fallback region +// tag::changeFallbackRegion[] +You can't change a custom fallback region after you create the queue. +To change the region, delete the queue and select a new region. +// end::changeFallbackRegion[] + // Fallback queues inherit settings from primary queue // tag::fallbackQsync[] When you update the configuration of the primary queue, @@ -24,8 +34,4 @@ If the primary queue has an assigned dead-letter queue (DLQ), you must enable failover for the DLQ before enabling failover for the primary queue. // end::fallbackDLQ[] -// Change fallback region -// tag::changeFallbackRegion[] -You can't change a custom fallback region after you create the queue. -To change the region, delete the queue and select a new region. -// end::changeFallbackRegion[] + diff --git a/modules/ROOT/pages/mq-failover.adoc b/modules/ROOT/pages/mq-failover.adoc index 72924a5c..9adfbcb4 100644 --- a/modules/ROOT/pages/mq-failover.adoc +++ b/modules/ROOT/pages/mq-failover.adoc @@ -42,6 +42,7 @@ xref:anypoint-mq-connector::anypoint-mq-failover.adoc#enable-failover-feature[En ** Failover support requires Anypoint MQ Connector 4.0.7 or later. ** Custom fallback region support requires Anypoint MQ Connector 4.0.9 or later. + +// Can't change fallback region include::partial$mq-failover.adoc[tag=changeFallbackRegion] // + // xref to upgrade steps? @@ -126,23 +127,21 @@ For information about queue settings, see xref:mq-queues.adoc#create-a-queue[Cre + image::mq-create-queues-failover.png["Create Queue popup dialog box with failover option selected"] // added screenshot -//// -.. Select the fallback region. -+ -If you are using an Anypoint MQ Connector version earlier 4.0.9, -leave the fallback region set at the default. -+ -[NOTE] -include::partial$mq-failover.adoc[tag=changeFallbackRegion] -//// +// .. Select the fallback region. +// + +// If you are using an Anypoint MQ Connector version earlier 4.0.9, +// leave the fallback region set at the default. +// + +// [NOTE] +// include::partial$mq-failover.adoc[tag=changeFallbackRegion] .. Click *Create Queue*. + Anypoint MQ creates the queue and also creates a fallback queue in the fallback region. // Fallback queue naming include::partial$mq-failover.adoc[tag=fallbackQname] -+ -// Fallback queue/region not configurable -include::partial$mq-failover.adoc[tag=fallbackQnotConfig] +// + +// Fallback queues aren't configurable by end users +// include::partial$mq-failover.adoc[tag=fallbackQnotConfig] Modify an existing queue:: + -- @@ -153,7 +152,6 @@ Anypoint MQ supports failover for standard queues only. .. In the *Queue Settings* page, select *Enable Cross-Region Failover*: + image::mq-queue-settings-failover.png["Queue Settings page with failover option selected"] -// added screenshot + [NOTE] include::partial$mq-failover.adoc[tag=changeFallbackRegion] @@ -163,9 +161,13 @@ include::partial$mq-failover.adoc[tag=changeFallbackRegion] Anypoint MQ updates the queue settings and creates a fallback queue in the fallback region. // Fallback queue naming include::partial$mq-failover.adoc[tag=fallbackQname] -+ -// Fallback queue/region not configurable +// + +// Fallback queues aren't configurable by end users // include::partial$mq-failover.adoc[tag=fallbackQnotConfig] +// Specify custom fallback region +// include::partial$mq-failover.adoc[tag=fallbackRegionCustom] +// Can't change fallback region +// include::partial$mq-failover.adoc[tag=changeFallbackRegion] + If you previously enabled failover for the queue, the fallback queue already exists and is reinstated. .. Restart all applications consuming from or publishing to the queue. diff --git a/modules/ROOT/pages/mq-glossary.adoc b/modules/ROOT/pages/mq-glossary.adoc index 78aef83d..22550bbb 100644 --- a/modules/ROOT/pages/mq-glossary.adoc +++ b/modules/ROOT/pages/mq-glossary.adoc @@ -84,6 +84,11 @@ A queue that Anypoint MQ automatically creates in a fallback region when failove // Fallback queues aren't configurable by end users include::partial$mq-failover.adoc[tag=fallbackQnotConfig] + +// Specify custom fallback region +include::partial$mq-failover.adoc[tag=fallbackRegionCustom] +// Can't change fallback region +include::partial$mq-failover.adoc[tag=changeFallbackRegion] ++ For information, see xref:mq-failover.adoc[]. [[fallback-region]] @@ -92,6 +97,11 @@ A region that Anypoint MQ automatically assigns to a fallback queue when failove // Fallback queues aren't configurable by end users include::partial$mq-failover.adoc[tag=fallbackQnotConfig] + +// Specify custom fallback region +include::partial$mq-failover.adoc[tag=fallbackRegionCustom] +// Can't change fallback region +include::partial$mq-failover.adoc[tag=changeFallbackRegion] ++ For information, see xref:mq-failover.adoc[]. [[fifo-queues]] From 53ee039eff76b3a0e3d4d8545963584e49afe04a Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Tue, 13 Aug 2024 11:25:34 -0700 Subject: [PATCH 06/14] version number --- modules/ROOT/pages/_partials/mq-failover.adoc | 2 +- modules/ROOT/pages/mq-failover.adoc | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/modules/ROOT/pages/_partials/mq-failover.adoc b/modules/ROOT/pages/_partials/mq-failover.adoc index 4f91a223..3378bb76 100644 --- a/modules/ROOT/pages/_partials/mq-failover.adoc +++ b/modules/ROOT/pages/_partials/mq-failover.adoc @@ -11,7 +11,7 @@ The Anypoint MQ server manages fallback queues; end users can't configure them. // Specify custom fallback region // tag::fallbackRegionCustom[] -With Anypoint MQ Connector version 4.0.9, you can specify a custom fallback region for a queue. +With Anypoint MQ Connector version 4.0.10, you can specify a custom fallback region for a queue. // end::fallbackRegionCustom[] // Change fallback region diff --git a/modules/ROOT/pages/mq-failover.adoc b/modules/ROOT/pages/mq-failover.adoc index 9adfbcb4..563cf2e1 100644 --- a/modules/ROOT/pages/mq-failover.adoc +++ b/modules/ROOT/pages/mq-failover.adoc @@ -1,9 +1,9 @@ = Configuring Cross-Region Failover for Standard Queues -You can configure failover by specifying a fallback region for standard queues using Anypoint Connector for Anypoint MQ (Anypoint MQ Connector) for Mule 4 version 4.0.9 and later. +You can configure failover by specifying a fallback region for standard queues using Anypoint Connector for Anypoint MQ (Anypoint MQ Connector) for Mule 4 version 4.0.10 and later. * To use the failover feature with the default region, use connector version 4.0.7 or later. -* To configure a specific failover region, use connector version 4.0.9 or later. +* To configure a specific failover region, use connector version 4.0.10 or later. When you enable failover for a queue, Anypoint MQ automatically creates a fallback queue in a default or custom <>. @@ -40,7 +40,7 @@ When you disable failover for a queue, apps can still consume any messages that For information about enabling this feature in your app, see xref:anypoint-mq-connector::anypoint-mq-failover.adoc#enable-failover-feature[Enable Failover in Your App]. ** Failover support requires Anypoint MQ Connector 4.0.7 or later. -** Custom fallback region support requires Anypoint MQ Connector 4.0.9 or later. +** Custom fallback region support requires Anypoint MQ Connector 4.0.10 or later. + // Can't change fallback region include::partial$mq-failover.adoc[tag=changeFallbackRegion] @@ -56,7 +56,7 @@ include::partial$mq-failover.adoc[tag=changeFallbackRegion] + If failover is enabled for queues in those regions and the primary region goes down, data resides in a region outside the country until the primary region is available. -To change the fallback region, upgrade to Anypoint MQ Connector 4.0.9 or later. +To change the fallback region, upgrade to Anypoint MQ Connector 4.0.10 or later. -- + For the list of default fallback regions, see <>. @@ -86,7 +86,7 @@ You can configure how frequently the connector checks the fallback queue. See xr To use failover, you must first: -* Upgrade Anypoint MQ Connector to 4.0.7 or later (default fallback region) or 4.0.9 or later (custom fallback region). +* Upgrade Anypoint MQ Connector to 4.0.7 or later (default fallback region) or 4.0.10 or later (custom fallback region). + For information, see xref:anypoint-mq-connector::anypoint-mq-connector-upgrade-migrate.adoc[]. * Enable the failover feature in your app. @@ -129,7 +129,7 @@ image::mq-create-queues-failover.png["Create Queue popup dialog box with failove // added screenshot // .. Select the fallback region. // + -// If you are using an Anypoint MQ Connector version earlier 4.0.9, +// If you are using an Anypoint MQ Connector version earlier 4.0.10, // leave the fallback region set at the default. // + // [NOTE] @@ -236,7 +236,7 @@ image::mq-queue-details-primary-queue-fallback-disabled.png["Details pane for th By default, Anypoint MQ Connector uses the default primary-fallback region pairings. -With version 4.0.9 and later of the connector, you can specify the fallback region, for example, +With version 4.0.10 and later of the connector, you can specify the fallback region, for example, to prevent data from residing in a different country for compliance reasons. IMPORTANT: To minimize latency, use the default fallback region. From 012d0722afbd0b70ead9a2f6c492dca6da4924d1 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Fri, 16 Aug 2024 12:44:43 -0700 Subject: [PATCH 07/14] New section for API/custom region selection --- modules/ROOT/pages/mq-failover.adoc | 49 +++++++++++++++++++++++++++-- 1 file changed, 46 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/pages/mq-failover.adoc b/modules/ROOT/pages/mq-failover.adoc index 563cf2e1..6d94b30d 100644 --- a/modules/ROOT/pages/mq-failover.adoc +++ b/modules/ROOT/pages/mq-failover.adoc @@ -230,15 +230,58 @@ The primary queue details shows that failover is disabled: image::mq-queue-details-primary-queue-fallback-disabled.png["Details pane for the primary queue with the fallback queue and failover status"] . Restart all applications consuming from or publishing to the queue. +[[assign-custom-fb-region-api]] +== Assign a Custom Fallback Region Using the API + +With version 4.0.10 and later of the connector, +you can specify the fallback region when you enable failover, for example, to prevent data from residing in a different country for compliance reasons. + +Use the Anypoint MQ Admin API to specify one of the following custom fallback regions for the `us-west-2` region: `us-east-1`, `us-east-2`, or `ca-central-1` (default). + +To specify the custom fallback region when enabling failover, +use a `curl` command like the following: + +[source,bash] +---- +curl --location --request PUT 'https://anypoint.mulesoft.com/mq/admin/api/v1/organizations/\ +{organization-id}/environments/{environment-id}/regions/{region-id}/destinations/queues/\ +{destination-id}/fallback' \ +--header 'Authorization: Bearer {auth-token}' \ +--header 'Content-Type: application/json' \ +--data '{ + "fallbackEnabled": true, + "fallbackRegion": "us-east-1" +}' +---- + +* The value of `fallbackRegion` can be the default region or a custom region. +* The custom `fallbackRegion` option is available for the `us-west-2` region only. +* You can set `fallbackRegion` to any of the following: +** `us-east-1` +** `us-east-2` +** `ca-central-1` (default) + +=== Custom Fallback Regions and Fallback Queue Names + +When using custom fallback regions, keep in mind the following: + +* If the fallback region is not specified or set to the default, the name of the fallback queue is the primary queue name with the `_fb` suffix. ++ +For example, if the primary queue name is `myDemoQueue`, the fallback queue name is `myDemoQueue_fb`. +* If the fallback region is set to a region other than the default, the fallback queue name includes an additional identifier to indicate the primary region: ++ +** `us-east-1`: ue1 +** `us-east-2`: ue2 +** `ca-central-1`: cc1 ++ +For example, if the primary queue name is `myDemoQueue` and the fallback region is set to `us-east-1`, the fallback queue name is `myDemoQueue_ue1_fb`. + [[primary-fallback-regions]] == Default Primary-Fallback Regions By default, Anypoint MQ Connector uses the default primary-fallback region pairings. -With version 4.0.10 and later of the connector, you can specify the fallback region, for example, -to prevent data from residing in a different country for compliance reasons. - IMPORTANT: To minimize latency, use the default fallback region. [%header,cols="8,12,12,12,12"] From 95425504a37a56a708a12c777fab5f4fa8f9d35e Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Fri, 16 Aug 2024 13:08:38 -0700 Subject: [PATCH 08/14] added link to API --- modules/ROOT/pages/mq-failover.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/mq-failover.adoc b/modules/ROOT/pages/mq-failover.adoc index 6d94b30d..1954f230 100644 --- a/modules/ROOT/pages/mq-failover.adoc +++ b/modules/ROOT/pages/mq-failover.adoc @@ -236,7 +236,7 @@ image::mq-queue-details-primary-queue-fallback-disabled.png["Details pane for th With version 4.0.10 and later of the connector, you can specify the fallback region when you enable failover, for example, to prevent data from residing in a different country for compliance reasons. -Use the Anypoint MQ Admin API to specify one of the following custom fallback regions for the `us-west-2` region: `us-east-1`, `us-east-2`, or `ca-central-1` (default). +Use the `fallbackRegion` property in the Anypoint MQ Admin API to specify one of the following custom fallback regions for the `us-west-2` region: `us-east-1`, `us-east-2`, or `ca-central-1` (default). To specify the custom fallback region when enabling failover, use a `curl` command like the following: @@ -261,6 +261,8 @@ curl --location --request PUT 'https://anypoint.mulesoft.com/mq/admin/api/v1/org ** `us-east-2` ** `ca-central-1` (default) +For more information, see https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/anypoint-mq-admin/minor/1.0/console/method/%23599/[Anypoint MQ Admin API]. + === Custom Fallback Regions and Fallback Queue Names When using custom fallback regions, keep in mind the following: From a58c190367621d1bd91cb369c85d388cb4f3ad64 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Fri, 16 Aug 2024 13:13:33 -0700 Subject: [PATCH 09/14] more little changes --- modules/ROOT/pages/mq-failover.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/mq-failover.adoc b/modules/ROOT/pages/mq-failover.adoc index 1954f230..0e7e0596 100644 --- a/modules/ROOT/pages/mq-failover.adoc +++ b/modules/ROOT/pages/mq-failover.adoc @@ -255,8 +255,8 @@ curl --location --request PUT 'https://anypoint.mulesoft.com/mq/admin/api/v1/org ---- * The value of `fallbackRegion` can be the default region or a custom region. -* The custom `fallbackRegion` option is available for the `us-west-2` region only. -* You can set `fallbackRegion` to any of the following: +* The `fallbackRegion` property is available for the `us-west-2` region only. +* You can set `fallbackRegion` to any of the following values: ** `us-east-1` ** `us-east-2` ** `ca-central-1` (default) From 5c02e67c8e140a95ff3f3e0e90cebdc9625197db Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Fri, 16 Aug 2024 13:40:43 -0700 Subject: [PATCH 10/14] Kimaya comments --- modules/ROOT/pages/_partials/mq-failover.adoc | 5 +++-- modules/ROOT/pages/mq-failover.adoc | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/modules/ROOT/pages/_partials/mq-failover.adoc b/modules/ROOT/pages/_partials/mq-failover.adoc index 3378bb76..8a2394de 100644 --- a/modules/ROOT/pages/_partials/mq-failover.adoc +++ b/modules/ROOT/pages/_partials/mq-failover.adoc @@ -16,8 +16,9 @@ With Anypoint MQ Connector version 4.0.10, you can specify a custom fallback reg // Change fallback region // tag::changeFallbackRegion[] -You can't change a custom fallback region after you create the queue. -To change the region, delete the queue and select a new region. +After you assign a fallback queue, you can't change the fallback region for the fallback queue. +To specify a different region for the fallback queue, delete the primary queue +Then create a new primary queue and choose a new fallback region. // end::changeFallbackRegion[] // Fallback queues inherit settings from primary queue diff --git a/modules/ROOT/pages/mq-failover.adoc b/modules/ROOT/pages/mq-failover.adoc index 0e7e0596..a79eee32 100644 --- a/modules/ROOT/pages/mq-failover.adoc +++ b/modules/ROOT/pages/mq-failover.adoc @@ -56,7 +56,8 @@ include::partial$mq-failover.adoc[tag=changeFallbackRegion] + If failover is enabled for queues in those regions and the primary region goes down, data resides in a region outside the country until the primary region is available. -To change the fallback region, upgrade to Anypoint MQ Connector 4.0.10 or later. ++ +To specify a custom fallback region when enabling failover, upgrade to Anypoint MQ Connector 4.0.10 or later. -- + For the list of default fallback regions, see <>. From 80d367aceefc03dbf3ef6d958990f0fd3038a982 Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Fri, 16 Aug 2024 13:44:39 -0700 Subject: [PATCH 11/14] punctuation --- modules/ROOT/pages/_partials/mq-failover.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/_partials/mq-failover.adoc b/modules/ROOT/pages/_partials/mq-failover.adoc index 8a2394de..a62b3687 100644 --- a/modules/ROOT/pages/_partials/mq-failover.adoc +++ b/modules/ROOT/pages/_partials/mq-failover.adoc @@ -17,8 +17,8 @@ With Anypoint MQ Connector version 4.0.10, you can specify a custom fallback reg // Change fallback region // tag::changeFallbackRegion[] After you assign a fallback queue, you can't change the fallback region for the fallback queue. -To specify a different region for the fallback queue, delete the primary queue -Then create a new primary queue and choose a new fallback region. +To specify a different region for the fallback queue, delete the primary queue. +Then, create a new primary queue and choose a new fallback region. // end::changeFallbackRegion[] // Fallback queues inherit settings from primary queue From 5c1b4d79c3577a23ff04b7560a52fe6c530acb9d Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Fri, 16 Aug 2024 13:55:15 -0700 Subject: [PATCH 12/14] Jash comment --- modules/ROOT/pages/mq-failover.adoc | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/modules/ROOT/pages/mq-failover.adoc b/modules/ROOT/pages/mq-failover.adoc index a79eee32..3c150c2b 100644 --- a/modules/ROOT/pages/mq-failover.adoc +++ b/modules/ROOT/pages/mq-failover.adoc @@ -270,14 +270,10 @@ When using custom fallback regions, keep in mind the following: * If the fallback region is not specified or set to the default, the name of the fallback queue is the primary queue name with the `_fb` suffix. + -For example, if the primary queue name is `myDemoQueue`, the fallback queue name is `myDemoQueue_fb`. -* If the fallback region is set to a region other than the default, the fallback queue name includes an additional identifier to indicate the primary region: +For example, if the primary queue name is `myDemoQueue` in `us-west-2` and the fallback region is set to the default, the fallback queue name is `myDemoQueue_fb`. +* If the fallback region is set to a region other than the default, the fallback queue name includes an additional identifier to indicate the primary region (`us-west-2): `uw2`. + -** `us-east-1`: ue1 -** `us-east-2`: ue2 -** `ca-central-1`: cc1 -+ -For example, if the primary queue name is `myDemoQueue` and the fallback region is set to `us-east-1`, the fallback queue name is `myDemoQueue_ue1_fb`. +For example, if the primary queue name is `myDemoQueue` in `us-west-2` and the fallback region is set to `us-east-1`, the fallback queue name is `myDemoQueue_uw2_fb` to indicate that the primary queue is in `us-west-2`. [[primary-fallback-regions]] From a4d80f1c60b24d201ffca2dab84675d1b9496b7a Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Fri, 16 Aug 2024 14:25:37 -0700 Subject: [PATCH 13/14] Kimaya comment --- modules/ROOT/pages/_partials/mq-failover.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/_partials/mq-failover.adoc b/modules/ROOT/pages/_partials/mq-failover.adoc index a62b3687..1f631cc6 100644 --- a/modules/ROOT/pages/_partials/mq-failover.adoc +++ b/modules/ROOT/pages/_partials/mq-failover.adoc @@ -16,7 +16,7 @@ With Anypoint MQ Connector version 4.0.10, you can specify a custom fallback reg // Change fallback region // tag::changeFallbackRegion[] -After you assign a fallback queue, you can't change the fallback region for the fallback queue. +After Anypoint MQ assigns a fallback queue to a primary queue, you can't change the fallback region for the fallback queue. To specify a different region for the fallback queue, delete the primary queue. Then, create a new primary queue and choose a new fallback region. // end::changeFallbackRegion[] From 93323a9c55faab8f7a758b0bbbb95343feb45d4e Mon Sep 17 00:00:00 2001 From: Hanna Nelson Date: Fri, 16 Aug 2024 16:06:09 -0700 Subject: [PATCH 14/14] format fix --- modules/ROOT/pages/mq-failover.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/mq-failover.adoc b/modules/ROOT/pages/mq-failover.adoc index 3c150c2b..a72459c3 100644 --- a/modules/ROOT/pages/mq-failover.adoc +++ b/modules/ROOT/pages/mq-failover.adoc @@ -271,7 +271,7 @@ When using custom fallback regions, keep in mind the following: * If the fallback region is not specified or set to the default, the name of the fallback queue is the primary queue name with the `_fb` suffix. + For example, if the primary queue name is `myDemoQueue` in `us-west-2` and the fallback region is set to the default, the fallback queue name is `myDemoQueue_fb`. -* If the fallback region is set to a region other than the default, the fallback queue name includes an additional identifier to indicate the primary region (`us-west-2): `uw2`. +* If the fallback region is set to a region other than the default, the fallback queue name includes an additional identifier to indicate the primary region (`us-west-2`): `uw2`. + For example, if the primary queue name is `myDemoQueue` in `us-west-2` and the fallback region is set to `us-east-1`, the fallback queue name is `myDemoQueue_uw2_fb` to indicate that the primary queue is in `us-west-2`.