forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revive articles about configuring high availability for a cluster (#4…
…1265) Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
- Loading branch information
1 parent
e4cf532
commit 82843ab
Showing
13 changed files
with
408 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
336 changes: 336 additions & 0 deletions
336
...nfiguring-clustering/configuring-high-availability-replication-for-a-cluster.md
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
...nstance/configuring-clustering/initiating-a-failover-to-your-replica-cluster.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: Initiating a failover to your replica cluster | ||
intro: 'If your {% data variables.product.prodname_ghe_server %} cluster fails, you can fail over to the replica.' | ||
redirect_from: | ||
- /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster | ||
- /admin/enterprise-management/initiating-a-failover-to-your-replica-cluster | ||
versions: | ||
ghes: '>= 3.9' | ||
type: how_to | ||
topics: | ||
- Clustering | ||
- Enterprise | ||
- High availability | ||
- Infrastructure | ||
shortTitle: Initiate a failover to replica | ||
--- | ||
|
||
## About failover to your replica cluster | ||
|
||
If the datacenter for your active cluster experiences a failure and you've configured high availability, you can fail over to your replica cluster. | ||
|
||
Failing over to your replica cluster promotes it to be your new active cluster, and decouples the new active cluster from the old active cluster. After failover, you will have two standalone clusters without high availability configured. You can reconfigure replication from the new active cluster. For more information, see "[AUTOTITLE](/enterprise/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster#reconfiguring-high-availability-replication-after-a-failover)." | ||
|
||
## Prerequisites | ||
|
||
To fail over to replica nodes, you must have configured high availability replication for your cluster. For more information, see "[AUTOTITLE](/enterprise/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster)." | ||
|
||
{% data reusables.enterprise_clustering.high-availability-requires-391 %} | ||
|
||
## Initiating a failover to your replica cluster | ||
|
||
1. SSH into the primary MySQL node in the replica cluster. For more information, see "[AUTOTITLE](/enterprise/admin/configuration/accessing-the-administrative-shell-ssh#enabling-access-to-the-administrative-shell-via-ssh)." | ||
1. To begin the failover to the secondary cluster and configure the nodes to respond to requests, run the following command. | ||
|
||
```shell | ||
ghe-cluster-failover | ||
``` | ||
|
||
{% data reusables.enterprise_clustering.configuration-finished %} | ||
1. Update the DNS record to point to the IP address of the load balancer for your replica cluster. After the TTL period expires, requests will be directed to the replica cluster. | ||
|
||
After {% data variables.product.prodname_ghe_server %} returns you to the prompt and your DNS updates propagate, you've finished failing over. Users can access {% data variables.product.prodname_ghe_server %} using the usual hostname for your cluster. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
This command can take some time to finish, so we recommend running the command in a terminal multiplexer like `screen` or `tmux`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
1. Apply the new configuration. {% data reusables.enterprise.use-a-multiplexer %} | ||
|
||
ghe-cluster-config-apply |
1 change: 1 addition & 0 deletions
1
data/reusables/enterprise_clustering/configuration-file-heading.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
The cluster configuration file lists each node under a <code>[cluster "<em>HOSTNAME</em>"]</code> heading. |
5 changes: 5 additions & 0 deletions
5
data/reusables/enterprise_clustering/configuration-finished.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
1. After the configuration run finishes, {% data variables.product.prodname_ghe_server %} displays the following message. | ||
|
||
```shell | ||
Finished cluster configuration | ||
``` |
9 changes: 9 additions & 0 deletions
9
data/reusables/enterprise_clustering/high-availability-requires-391.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
{% ifversion ghes = 3.9 %} | ||
|
||
{% note %} | ||
|
||
**Note:** High availability replication is available on {% data variables.product.prodname_ghe_server %} version 3.9.1 and later. | ||
|
||
{% endnote %} | ||
|
||
{% endif %} |
1 change: 1 addition & 0 deletions
1
data/reusables/enterprise_clustering/key-value-pair-order-irrelevant.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
The order of the key-value pairs doesn't matter. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
For high availability, the latency between the network with the active nodes and the network with the passive nodes must be less than 70 milliseconds. We don't recommend configuring a firewall between the two networks. | ||
For high availability, the latency between the network with the active nodes and the network with the replica nodes must be less than 70 milliseconds. We don't recommend configuring a firewall between the two networks. |
5 changes: 5 additions & 0 deletions
5
data/reusables/enterprise_clustering/open-configuration-file.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
1. Open the cluster configuration file at `/data/user/common/cluster.conf` in a text editor. For example, you can use Vim. Create a backup of the `cluster.conf` file before you edit the file. | ||
|
||
```shell copy | ||
sudo vim /data/user/common/cluster.conf | ||
``` |