Creating a high availability replica

In an active/passive configuration, the replica appliance is a redundant copy of the primary appliance. If the primary appliance fails, high availability mode allows the replica to act as the primary appliance, allowing minimal service disruption.

Observação: Há um máximo de 8 réplicas de disponibilidade alta (passiva e ativas/georreplicas) permitidos em GitHub Enterprise Server.

Creating a high availability replica

  1. Set up a new GitHub Enterprise Server appliance on your desired platform. The replica appliance should mirror the primary appliance's CPU, RAM, and storage settings. We recommend that you install the replica appliance in an independent environment. The underlying hardware, software, and network components should be isolated from those of the primary appliance. If you are a using a cloud provider, use a separate region or zone. For more information, see "Setting up a GitHub Enterprise Server instance".

  2. Ensure that both the primary appliance and the new replica appliance can communicate with each other over ports 122/TCP and 1194/UDP. For more information, see "Network ports."

  3. In a browser, navigate to the new replica appliance's IP address and upload your GitHub Enterprise license.

  4. Defina uma senha de administrador correspondente à senha no appliance primário e continue.

  5. Clique em Configure as Replica (Configurar como réplica). Opções de instalação com link para configurar a nova instância como réplica

  6. Em "Add new SSH key" (Adicionar nova chave SSH), digite a chave SSH. Adicionar chave SSH

  7. Clique em Adicionar chave.

  8. Connect to the replica appliance's IP address using SSH.

    $ ssh -p 122 admin@REPLICA IP
  9. Para gerar um par de chaves para replicação, use o comando ghe-repl-setup com o endereço IP do appliance primário e copie a chave pública que ele retorna.

    $ ghe-repl-setup PRIMARY IP
  10. Para adicionar a chave pública à lista de chaves autorizadas no appliance primário, navegue para o https://PRIMARY-HOSTNAME/setup/settings e adicione a chave que você copiou da réplica à lista.

  11. To verify the connection to the primary and enable replica mode for the new replica, run ghe-repl-setup again.

    $ ghe-repl-setup PRIMARY IP
  12. Para iniciar a replicação dos datastores, use o comando ghe-repl-start.

    $ ghe-repl-start

    Aviso: ghe-repl-start causa uma breve interrupção no servidor principal, durante o qual os usuários podem ver erros internos do servidor. Para fornecer uma mensagem mais amigável, execute ghe-maintenance -s no nó principal antes de executar ghe-repl-start no nó de réplica para colocar o appliance no modo de manutenção. Uma vez iniciada a réplica, desabilite o modo de manutenção com ghe-maintenance -u. Git replication will not progress while the primary node is in maintenance mode.

  13. Para verificar o status do canal de replicação de cada armazenamento de dados, use o comando ghe-repl-status.

    $ ghe-repl-status

Creating geo-replication replicas

This example configuration uses a primary and two replicas, which are located in three different geographic regions. While the three nodes can be in different networks, all nodes are required to be reachable from all the other nodes. At the minimum, the required administrative ports should be open to all the other nodes. For more information about the port requirements, see "Network Ports."

  1. Create the first replica the same way you would for a standard two node configuration by running ghe-repl-setup on the first replica.

    (replica1)$ ghe-repl-setup PRIMARY IP
    (replica1)$ ghe-repl-start
  2. Create a second replica and use the ghe-repl-setup --add command. The --add flag prevents it from overwriting the existing replication configuration and adds the new replica to the configuration.

    (replica2)$ ghe-repl-setup --add PRIMARY IP
    (replica2)$ ghe-repl-start
  3. By default, replicas are configured to the same datacenter, and will now attempt to seed from an existing node in the same datacenter. Configure the replicas for different datacenters by setting a different value for the datacenter option. The specific values can be anything you would like as long as they are different from each other. Run the ghe-repl-node command on each node and specify the datacenter.

    On the primary:

    (primary)$ ghe-repl-node --datacenter [PRIMARY DC NAME]

    On the first replica:

    (replica1)$ ghe-repl-node --datacenter [FIRST REPLICA DC NAME]

    On the second replica:

    (replica2)$ ghe-repl-node --datacenter [SECOND REPLICA DC NAME]

    Tip: You can set the --datacenter and --active options at the same time.

  4. An active replica node will store copies of the appliance data and service end user requests. An inactive node will store copies of the appliance data but will be unable to service end user requests. Enable active mode using the --active flag or inactive mode using the --inactive flag.

    On the first replica:

    (replica1)$ ghe-repl-node --active

    On the second replica:

    (replica2)$ ghe-repl-node --active
  5. To apply the configuration, use the ghe-config-apply command on the primary.

    (primary)$ ghe-config-apply

Configuring DNS for geo-replication

Configure Geo DNS using the IP addresses of the primary and replica nodes. You can also create a DNS CNAME for the primary node (e.g. primary.github.example.com) to access the primary node via SSH or to back it up via backup-utils.

For testing, you can add entries to the local workstation's hosts file (for example, /etc/hosts). These example entries will resolve requests for HOSTNAME to replica2. You can target specific hosts by commenting out different lines.

# <primary IP>     <em>HOSTNAME</em>
# <replica1 IP>    <em>HOSTNAME</em>
<replica2 IP>    <em>HOSTNAME</em>

Further reading

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.