Skip to content

Commit

Permalink
Update docs/README.md
Browse files Browse the repository at this point in the history
Co-authored-by: Aaron Kuehler <[email protected]>
  • Loading branch information
rurkss and indiebrain authored Jan 9, 2024
1 parent faf0a93 commit 3c6bb79
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ This `bootstrapNode` can be configured as follows:
| host | **required** | The IP of the target Redis address or the ClusterIP of a pre-existing Kubernetes Service targeting Redis pods | [bootstrapping.yaml](example/redisfailover/bootstrapping.yaml) |
| port | _optional_ | The Port that the target Redis address is listening to. Defaults to `6379`. | [bootstrapping-with-port.yaml](example/redisfailover/bootstrapping-with-port.yaml) |
| allowSentinels | _optional_ | Allow the Operator to also create the specified Sentinel resources and point them to the target Node/Port. By default, the Sentinel resources will **not** be created when bootstrapping. | [bootstrapping-with-sentinels.yaml](example/redisfailover/bootstrapping-with-sentinels.yaml) |
| enabled | _optional_ | By default, Bootstrap mode is activated, prompting Redis nodes to attempt a connection with the source host. However, if this parameter is set to `false', Redis will instead establish a cluster among the local nodes. In this scenario, a master node will be designated, to which the replica nodes will connect | [bootstrapping-disabled.yaml](example/redisfailover/bootstrapping-disabled.yaml) |
| enabled | _optional_ | Allow the Operator to toggle the bootstrapping status of a RedisFailover. By default, Bootstrap mode is enabled, prompting Redis nodes to attempt a connection with the source host. When set to `false`, the Operator disables bootstrapping mode on the Redisfailover. | [bootstrapping-disabled.yaml](example/redisfailover/bootstrapping-disabled.yaml) |

#### What is Bootstrapping?
When a `bootstrapNode` is provided, the Operator will always set all of the defined Redis instances to replicate from the provided `bootstrapNode` host value.
Expand Down

0 comments on commit 3c6bb79

Please sign in to comment.