GEODE-3111 GatewayReceiver - DEFAULT_MANUAL_START value is ambiguous This closes #705
Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/08154dd7 Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/08154dd7 Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/08154dd7 Branch: refs/heads/feature/GEODE-3304 Commit: 08154dd7731910803aa5eb2caf0e284b3a239755 Parents: 06b839c Author: Dave Barnes <dbar...@pivotal.io> Authored: Wed Aug 9 16:17:14 2017 -0700 Committer: Dave Barnes <dbar...@pivotal.io> Committed: Thu Aug 10 09:42:39 2017 -0700 ---------------------------------------------------------------------- .../apache/geode/cache/wan/GatewayReceiver.java | 2 +- .../gfsh/command-pages/create.html.md.erb | 4 +-- .../setting_up_a_multisite_system.html.md.erb | 32 ++++++-------------- .../multisite_overview.html.md.erb | 3 +- 4 files changed, 15 insertions(+), 26 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/08154dd7/geode-core/src/main/java/org/apache/geode/cache/wan/GatewayReceiver.java ---------------------------------------------------------------------- diff --git a/geode-core/src/main/java/org/apache/geode/cache/wan/GatewayReceiver.java b/geode-core/src/main/java/org/apache/geode/cache/wan/GatewayReceiver.java index 8c02af1..fd6f039 100644 --- a/geode-core/src/main/java/org/apache/geode/cache/wan/GatewayReceiver.java +++ b/geode-core/src/main/java/org/apache/geode/cache/wan/GatewayReceiver.java @@ -64,7 +64,7 @@ public interface GatewayReceiver { public static final String DEFAULT_HOSTNAME_FOR_SENDERS = ""; /** - * The default value (true) for manually starting a <code>GatewayReceiver</code>. + * The default value for manually starting a <code>GatewayReceiver</code>. * * @since GemFire 8.1 */ http://git-wip-us.apache.org/repos/asf/geode/blob/08154dd7/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb index b23ca56..01efcd8 100644 --- a/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb +++ b/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb @@ -392,7 +392,7 @@ create gateway-receiver [--group=value(,value)*] [--member=value(,value)*] </tr> <tr class="odd"> <td><span class="keyword parmname">\-\-manual-start</span></td> -<td>Boolean value that specifies whether you need to manually start the gateway receiver. If you supply a null value, the default is "true" and you will need to start the gateway receiver manually.</td> +<td>Boolean value that specifies whether you need to manually start the gateway receiver. If you supply a null value, the default is "false" the gateway receiver starts automatically.</td> <td>true</td> </tr> <tr class="even"> @@ -517,7 +517,7 @@ create gateway-sender --id=value --remote-distributed-system-id=value </tr> <tr class="odd"> <td><span class="keyword parmname">\-\-manual-start</span></td> -<td>Boolean value that specifies whether you need to manually start the gateway sender. If you supply a null value, the default is "false" and the gateway sender attempts to start automatically.</td> +<td>Boolean value that specifies whether you need to manually start the gateway sender. If you supply a null value, the default is "false" and the gateway sender starts automatically.</td> <td>false</td> </tr> <tr class="even"> http://git-wip-us.apache.org/repos/asf/geode/blob/08154dd7/geode-docs/topologies_and_comm/multi_site_configuration/setting_up_a_multisite_system.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/topologies_and_comm/multi_site_configuration/setting_up_a_multisite_system.html.md.erb b/geode-docs/topologies_and_comm/multi_site_configuration/setting_up_a_multisite_system.html.md.erb index 0b5091d..dd2bc3a 100644 --- a/geode-docs/topologies_and_comm/multi_site_configuration/setting_up_a_multisite_system.html.md.erb +++ b/geode-docs/topologies_and_comm/multi_site_configuration/setting_up_a_multisite_system.html.md.erb @@ -167,7 +167,7 @@ See [WAN Configuration](../../reference/topics/elements_ref.html#topic_7B1CABCAD dispatcher-threads="2" order-policy="partition" manual-start="true" /> ``` - By default, this is set to false on gateway senders and the senders are started automatically. + By default, `manual-start` is set to false on gateway senders and the senders are started automatically. 4. If you have configured the gateway sender with `manual-start` equal to true, then start the gateway sender when appropriate. For persistent gateway senders, the appropriate time to start them is when all other members hosting persistent regions are started. In gfsh: @@ -238,7 +238,8 @@ A gateway receiver configuration specifies a range of possible port numbers on w You can optionally configure gateway receivers to provide a specific IP address or host name for gateway sender connections. If you configure hostname-for-senders, locators will use the provided host name or IP address when instructing gateway senders on how to connect to gateway receivers. If you provide "" or null as the value, by default the gateway receiver's bind-address will be sent to clients. -In addition, you can configure gateway receivers to start automatically or to require a manual start. By default, gateway receivers must be started manually. +In addition, you can configure gateway receivers to start automatically or, by setting `manual-start` to true, to require a manual start. +By default, gateway receivers start automatically. **Note:** To configure a gateway receiver, you can use gfsh, cache.xml or Java API configurations as described below. For more information on configuring gateway receivers in gfsh, see [create gateway-receiver](../../tools_modules/gfsh/command-pages/create.html#topic_a4x_pb1_dk). @@ -255,7 +256,7 @@ To configure a gateway receiver, you can use gfsh, cache.xml or Java API configu ``` pre <cache> - <gateway-receiver start-port="1530" end-port="1551" hostname-for-senders="gateway1.mycompany.com" manual-start="false" /> + <gateway-receiver start-port="1530" end-port="1551" hostname-for-senders="gateway1.mycompany.com" /> ... </cache> ``` @@ -272,33 +273,20 @@ To configure a gateway receiver, you can use gfsh, cache.xml or Java API configu gateway.setEndPort(1551); gateway.setHostnameForSenders("gateway1.mycompany.com"); GatewayReceiver receiver = gateway.create(); - receiver.start(); ``` **Note:** - When using the Java API, you must create any region that might receive events from a remote site before you start the gateway receiver. Otherwise, batches of events could arrive from remote sites before the regions for those events have been created. If this occurs, the local site will throw exceptions because the receiving region does not exist yet. If you define regions in `cache.xml`, the correct startup order is handled automatically. + When using the Java API, you must create any region that might receive events from a remote site before you create the gateway receiver. Otherwise, batches of events could arrive from remote sites before the regions for those events have been created. If this occurs, the local site will throw exceptions because the receiving region does not yet exist. If you define regions in `cache.xml`, the correct startup order is handled automatically. -- By default, `manual-start` is configured to **true** on gateway receivers. If you have not changed this configuration (either in gfsh or cache.xml), you must start your gateway receiver manually. For example, in gfsh: +After starting new gateway receivers, you can execute the [load-balance gateway-sender](../../tools_modules/gfsh/command-pages/load-balance.html) command in `gfsh` so that a specific gateway sender will be able to rebalance its connections and connect new remote gateway receivers. Invoking this command redistributes gateway sender connections more evenly among all the gateway receivers. - ``` pre - gfsh>create gateway-receiver --manual-start=false - ``` - -- In gfsh, if you have not disabled manual-start, execute the following command to start the gateway receiver: - - ``` pre - gfsh>start gateway-receiver - ``` - -- After starting new gateway receivers, you can execute the [load-balance gateway-sender](../../tools_modules/gfsh/command-pages/load-balance.html) command in `gfsh` so that a specific gateway sender will be able to rebalance its connections and connect new remote gateway receivers. Invoking this command redistributes gateway sender connections more evenly among all the gateway receivers. - - Another option is to use the `GatewaySender.rebalance` Java API. +Another option is to use the `GatewaySender.rebalance` Java API. As an example, assume the following scenario: -1. start 1 receiver in site ny -2. start 4 senders in site ln -3. start 3 additional receiver in NY +1. Create 1 receiver in site NY. +2. Create 4 senders in site LN. +3. Create 3 additional receivers in NY. You can then execute the following in gfsh to see the effects of rebalancing: http://git-wip-us.apache.org/repos/asf/geode/blob/08154dd7/geode-docs/topologies_and_comm/topology_concepts/multisite_overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/topologies_and_comm/topology_concepts/multisite_overview.html.md.erb b/geode-docs/topologies_and_comm/topology_concepts/multisite_overview.html.md.erb index f250f80..e7bb61d 100644 --- a/geode-docs/topologies_and_comm/topology_concepts/multisite_overview.html.md.erb +++ b/geode-docs/topologies_and_comm/topology_concepts/multisite_overview.html.md.erb @@ -108,7 +108,8 @@ A gateway receiver applies each region event to the same region or partition tha Gateway senders use any available gateway receiver in the target cluster to send region events. You can deploy gateway receiver configurations to multiple Geode members as needed for high availability and load balancing, however you can only host one gateway receiver per member. -After you create a gateway receiver, you can configure the gateway receiver to start automatically or to require a manual start. The current default is to require a manual start for the gateway receiver (`manual-start` is set to true). +After you create a gateway receiver, you can configure the gateway receiver to start automatically or to require a manual start. +By default, the gateway receiver starts automatically (`manual-start` is set to false). After you create and start a new gateway receiver at one WAN site, you can execute the [load-balance gateway-sender](../../tools_modules/gfsh/command-pages/load-balance.html#concept_fn2_qls_5q) command in `gfsh` for existing remote gateway senders so that the new receiver can pick up connections to gateway senders at different sites. You invoke this command on the gateway senders to redistribute connections more evenly among all the gateway receivers. Another option is to use the `GatewaySender.rebalance` Java API.
