Skip to content

Commit

Permalink
Add useAddressTranslator info in the docs
Browse files Browse the repository at this point in the history
Add useAddressTranslator in the provided resource files
  • Loading branch information
adejanovski committed Oct 3, 2017
1 parent 26bc722 commit aff6d33
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/docs/configuration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,11 @@ <h3 id="reaper-specific-configuration-settings">Reaper Specific Configuration Se
the database client parameters in a database/cassandra section in the configuration file. See the example
settings in provided testing configuration in <em>src/test/resources/cassandra-reaper.yaml</em>.</p>

<p><code>useAddressTranslator</code>:</p>

<p>When running multi region clusters in AWS, turn this setting to <code>true</code> in order to use the EC2MultiRegionAddressTranslator from the Datastax Java Driver. This will allow translating the public address that the nodes broadcast to the private IP address that is used to expose JMX.<br />
Defaults to <code>false</code>.</p>

<p><code>jmxPorts</code>:</p>

<p>Optional mapping of custom JMX ports to use for individual hosts. The used default JMX port
Expand Down
5 changes: 5 additions & 0 deletions src/docs/content/docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ If you are using the recommended (persistent) storage type "database" or "cassan
the database client parameters in a database/cassandra section in the configuration file. See the example
settings in provided testing configuration in *src/test/resources/cassandra-reaper.yaml*.

`useAddressTranslator`:

When running multi region clusters in AWS, turn this setting to `true` in order to use the EC2MultiRegionAddressTranslator from the Datastax Java Driver. This will allow translating the public address that the nodes broadcast to the private IP address that is used to expose JMX.
Defaults to `false`.

`jmxPorts`:

Optional mapping of custom JMX ports to use for individual hosts. The used default JMX port
Expand Down
1 change: 1 addition & 0 deletions src/packaging/resource/cassandra-reaper-cassandra-ssl.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ incrementalRepair: false
repairManagerSchedulingIntervalSeconds: 10
activateQueryLogger: false
jmxConnectionTimeoutInSeconds: 5
useAddressTranslator: false

# datacenterAvailability has three possible values: ALL | LOCAL | EACH
# the correct value to use depends on whether jmx ports to C* nodes in remote datacenters are accessible
Expand Down
3 changes: 2 additions & 1 deletion src/packaging/resource/cassandra-reaper-cassandra.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ enableDynamicSeedList: true
repairManagerSchedulingIntervalSeconds: 10
activateQueryLogger: false
jmxConnectionTimeoutInSeconds: 5
useAddressTranslator: false

# datacenterAvailability has three possible values: ALL | LOCAL | EACH
# the correct value to use depends on whether jmx ports to C* nodes in remote datacenters are accessible
Expand Down Expand Up @@ -101,4 +102,4 @@ autoScheduling:
# frequency: 1 minute
# reporters:
# - type: log
# logger: metrics
# logger: metrics
1 change: 1 addition & 0 deletions src/packaging/resource/cassandra-reaper-h2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ incrementalRepair: false
enableDynamicSeedList: true
repairManagerSchedulingIntervalSeconds: 10
jmxConnectionTimeoutInSeconds: 5
useAddressTranslator: false

# datacenterAvailability has three possible values: ALL | LOCAL | EACH
# the correct value to use depends on whether jmx ports to C* nodes in remote datacenters are accessible
Expand Down
1 change: 1 addition & 0 deletions src/packaging/resource/cassandra-reaper-memory.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ incrementalRepair: false
enableDynamicSeedList: true
repairManagerSchedulingIntervalSeconds: 10
jmxConnectionTimeoutInSeconds: 5
useAddressTranslator: false

# datacenterAvailability has three possible values: ALL | LOCAL | EACH
# the correct value to use depends on whether jmx ports to C* nodes in remote datacenters are accessible
Expand Down
1 change: 1 addition & 0 deletions src/packaging/resource/cassandra-reaper-postgres.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ incrementalRepair: false
enableDynamicSeedList: true
repairManagerSchedulingIntervalSeconds: 10
jmxConnectionTimeoutInSeconds: 5
useAddressTranslator: false

# datacenterAvailability has three possible values: ALL | LOCAL | EACH
# the correct value to use depends on whether jmx ports to C* nodes in remote datacenters are accessible
Expand Down
1 change: 1 addition & 0 deletions src/packaging/resource/cassandra-reaper.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ enableDynamicSeedList: true
repairManagerSchedulingIntervalSeconds: 10
activateQueryLogger: false
jmxConnectionTimeoutInSeconds: 5
useAddressTranslator: false

# datacenterAvailability has three possible values: ALL | LOCAL | EACH
# the correct value to use depends on whether jmx ports to C* nodes in remote datacenters are accessible
Expand Down

0 comments on commit aff6d33

Please sign in to comment.