Sobre a substituição de nós no cluster do GitHub Enterprise Server
Em um cluster do GitHub Enterprise Server, é possível substituir um nó funcional ou um que falhou inesperadamente.
Depois que ocorre a substituição do nó, o sua instância do GitHub Enterprise Server não distribui automaticamente trabalhos para o novo nó. É possível forçar a instância a equilibrar trabalhos entre os nós. Para saber mais, confira Rebalancear as cargas de trabalho do cluster.
Warning
Para evitar conflitos, não reutilize um nome do host atribuído anteriormente a um nó no cluster.
Substituir um nó funcional
É possível substituir um nó funcional existente no cluster. Por exemplo, talvez você queira fornecer uma VM (máquina virtual) com recursos adicionais de CPU, memória ou armazenamento.
Para substituir um nó funcional, instale o dispositivo do GitHub Enterprise Server em uma nova VM, configure um endereço IP, adicione o novo nó ao arquivo de configuração do cluster, inicialize o cluster, aplique a configuração e coloque o nó substituído offline.
Note
Se você estiver substituindo o nó do banco de dados primário, confira Como substituir o nó do banco de dados primário.
-
Provisione e instale GitHub Enterprise Server com um nome de host exclusivo no nó de substituição.
-
Usando o shell administrativo ou o DHCP, configure apenas o endereço IP do nó de substituição. Não altere nenhuma outra configuração.
-
Para adicionar o nó de substituição recém-provisionado, em qualquer nó, modifique o arquivo
cluster.conf
para remover o nó com falha e adicione o nó de substituição. Por exemplo, este arquivocluster.conf
modificado substituighe-data-node-3
pelo nó recém-provisionado,ghe-replacement-data-node-3
:[cluster "ghe-replacement-data-node-3"] hostname = ghe-replacement-data-node-3 ipv4 = 192.168.0.7 # ipv6 = fd12:3456:789a:1::7 consul-datacenter = PRIMARY-DATACENTER git-server = true pages-server = true mysql-server = true elasticsearch-server = true redis-server = true memcache-server = true metrics-server = true storage-server = true
Você pode optar por adiar a propagação do banco de dados de um novo nó de réplica do MySQL, resultando na capacidade de abrir seu dispositivo ao tráfego mais cedo. Para saber mais, confira Adiar a propagação do banco de dados.
-
No shell administrativo do nó com o
cluster.conf
modificado, executeghe-cluster-config-init
. Isto irá inicializar o nó recém-adicionado no cluster. -
No mesmo nó, execute
ghe-cluster-config-apply
. Isso vai validar o arquivo de configuração, copiá-lo para cada nó no cluster e configurar cada nó de acordo com o arquivocluster.conf
modificado. -
Para colocar o nó que você está substituindo offline, no nó MySQL principal do seu cluster, execute o seguinte comando.
ghe-remove-node NODE-HOSTNAME
Esse comando evacuará os dados de qualquer serviço de dados em execução no nó, marcará o nó como offline em sua configuração e interromperá o tráfego que está sendo roteado para o nó. Para saber mais, confira Utilitários de linha de comando.
Substituir um nó em caso de emergência
É possível substituir um nó com falha no cluster. Por exemplo, um problema de software ou hardware pode afetar a disponibilidade de um nó.
Note
Se você estiver substituindo o nó do banco de dados primário, confira Como substituir o nó do banco de dados primário.
Para substituir um nó em uma emergência, você colocará o nó com falha offline, adicionará o nó de substituição ao cluster e vai executar comandos para remover referências a serviços de dados no nó removido.
-
Para remover o nó que está enfrentando problemas do cluster, do nó MySQL primário do cluster, execute o seguinte comando. Substitua NODE-HOSTNAME pelo nome do host do nó que você está colocando offline.
ghe-remove-node --no-evacuate NODE-HOSTNAME
Esse comando irá marcar o nó como offline em sua configuração e interromperá o tráfego que está sendo roteado para o nó. Você pode executar esse comando no modo
no-evacuate
agora porque, mais adiante neste procedimento, você vai executar comandos que instruem os serviços de dados no nó a copiar quaisquer réplicas para os outros nós disponíveis no cluster. Para saber mais, confira Utilitários de linha de comando. -
Adicione o nó de substituição ao cluster.
- Provisione e instale GitHub Enterprise Server com um nome de host exclusivo no nó de substituição.
-
Usando o shell administrativo ou o DHCP, configure apenas o endereço IP do nó de substituição. Não altere nenhuma outra configuração.
-
Para adicionar o nó de substituição recém-provisionado, em qualquer nó, modifique o arquivo
cluster.conf
para adicione o nó de substituição. Por exemplo, este arquivocluster.conf
modificado adiciona pelo nó recém-provisionadoghe-replacement-data-node-3
:[cluster "ghe-replacement-data-node-3"] hostname = ghe-replacement-data-node-3 ipv4 = 192.168.0.7 # ipv6 = fd12:3456:789a:1::7 git-server = true pages-server = true mysql-server = true elasticsearch-server = true redis-server = true memcache-server = true metrics-server = true storage-server = true
-
No shell administrativo do nó com o
cluster.conf
modificado, executeghe-cluster-config-init
. Isto irá inicializar o nó recém-adicionado no cluster.
-
-
No mesmo nó, execute
ghe-cluster-config-apply
. Isso vai validar o arquivo de configuração, copiá-lo para cada nó no cluster e configurar cada nó de acordo com o arquivocluster.conf
modificado. -
Remova referências a serviços de dados no nó que você removeu.
-
Encontre o UUID do nó que você removeu. Para localizar o UUID, execute o seguinte comando, substituindo
HOSTNAME
pelo nome do host do nó. Você usará este UUID na próxima etapa.ghe-config cluster.HOSTNAME.uuid
-
Para remover referências a serviços de dados, execute os comandos a seguir. Substitua
UUID
pelo UUID do nó.Esses comandos indicam a cada serviço que o nó é removido permanentemente. Os serviços recriarão todas as réplicas contidas no nó nos nós disponíveis no cluster.
Note
Esses comandos podem causar um aumento de carga no servidor enquanto os dados são rebalanceados entre as réplicas.
Para o serviço
git-server
(usado para dados do repositório):ghe-spokesctl server destroy git-server-UUID
Para o serviço
pages-server
(usado para criações de site GitHub Pages):ghe-dpages remove pages-server-UUID
Para o serviço
storage-server
(usado para dados Git LFS, arquivos de imagem de avatar, anexos de arquivos e arquivos de lançamento):ghe-storage destroy-host storage-server-UUID --force
-
-
Opcionalmente, exclua a entrada do nó removido no arquivo
cluster.conf
. Isso irá manter seu arquivocluster.conf
organizado e economizará tempo durante execuções futurasconfig-apply
.-
Para remover a entrada do arquivo, execute o seguinte comando, substituindo
HOSTNAME
pelo nome do host do nó removido.ghe-config --remove-section "cluster.HOSTNAME"
-
Para copiar a configuração para outros nós no cluster, a partir do shell administrativo do nó onde você modificou
cluster.conf
, executeghe-cluster-config-apply
.
-
Substituindo o nó do banco de dados primário (MySQL ou MySQL e MSSQL)
Para fornecer serviços de banco de dados, seu cluster requer um nó MySQL primário e, pelo menos, um nó MySQL de réplica. Para saber mais, confira Sobre nós de cluster.
Se o cluster tem o GitHub Actions habilitado, você também precisará considerar o MSSQL nas etapas a seguir.
Se você precisar alocar mais recursos ao nó mySQL primário (ou MySQL e MSSQL) ou substituir um nó com falha, poderá adicionar um novo nó ao cluster. Para minimizar o tempo de inatividade, adicione o novo nó, replique os dados MySQL (ou MySQL e MSSQL) e promova-os para o nó primário. É necessário algum tempo de inatividade durante o processo de promoção.
-
Provisione e instale GitHub Enterprise Server com um nome de host exclusivo no nó de substituição.
-
Usando o shell administrativo ou o DHCP, configure apenas o endereço IP do nó de substituição. Não altere nenhuma outra configuração.
-
Para se conectar ao sua instância do GitHub Enterprise Server, acesse via SSH qualquer um dos nós do cluster. Na estação de trabalho, execute o comando a seguir. Substituir HOSTNAME pelo nome do host do nó. Para saber mais, confira Acesar o shell administrativo (SSH).
Shell ssh -p 122 admin@HOSTNAME
ssh -p 122 admin@HOSTNAME
-
Em um editor de texto, abra o arquivo de configuração do cluster em
/data/user/common/cluster.conf
. Por exemplo, você pode usar o Vim. Crie um backup do arquivocluster.conf
antes de editá-lo.Shell sudo vim /data/user/common/cluster.conf
sudo vim /data/user/common/cluster.conf
-
O arquivo de configuração do cluster lista cada nó sob um título
[cluster "HOSTNAME"]
. Adicione um novo título para o nó e insira os pares de valores-chave para configuração, substituindo os espaços reservados por valores reais.- Inclua o par de valores-chave
mysql-server = true
. - Se o GitHub Actions estiver habilitado no cluster, você também precisará incluir o par chave-valor
mssql-server = true
. - A seção a seguir é um exemplo, e a configuração do nó pode ser diferente.
... [cluster "HOSTNAME"] hostname = HOSTNAME ipv4 = IPV4-ADDRESS # ipv6 = IPV6-ADDRESS consul-datacenter = PRIMARY-DATACENTER datacenter = DATACENTER mysql-server = true redis-server = true ... ...
- Inclua o par de valores-chave
-
No shell administrativo do nó com o
cluster.conf
modificado, executeghe-cluster-config-init
. Isto irá inicializar o nó recém-adicionado no cluster. -
No shell administrativo do nó em que você modificou
cluster.conf
, executeghe-cluster-config-apply
. O nó adicionado recentemente se transformará em um nó MySQL de réplica e outros serviços configurados serão executados nesse nó.Note
O snippet anterior não pressupõe que o GitHub Actions esteja habilitado no cluster.
-
Aguarde a conclusão da replicação do MySQL. Para monitorar a replicação do MySQL por meio de qualquer nó do cluster, execute
ghe-cluster-status -v
.Se o GitHub Actions estiver habilitado no cluster, você precisará aguardar a conclusão da replicação de MSSQL.
Pouco após adicionar o nó ao cluster, você poderá ver um erro no status da replicação enquanto a replicação é atualizada. O processo de duplicação pode demorar horas, dependendo da carga da instância, da quantidade de dados do banco de dados e da última vez em que a instância gerou uma posição inicial de banco de dados.
-
Durante a janela de manutenção agendada, habilite o modo de manutenção. Para saber mais, confira Habilitar e programar o modo de manutenção.
-
Verifique se a replicação de MySQL (ou MySQL e MSSQL) foi concluída em qualquer nó do cluster executando
ghe-cluster-status -v
.Warning
Se você não aguardar a replicação de MySQL (ou MySQL e MSSQL) terminar, correrá o risco de perder dados na instância.
-
Para definir o nó primário atual do MySQL como o modo somente leitura, execute o comando a seguir no nó primário do MySQL.
Shell echo "SET GLOBAL super_read_only = 1;" | sudo mysql
echo "SET GLOBAL super_read_only = 1;" | sudo mysql
-
Aguarde até que os Identificadores de Transação Global (GTIDs) definidos nos nós MySQL primário e de réplica sejam idênticos. Para verificar os GTIDs, execute o comando a seguir em qualquer nó de cluster.
Shell ghe-cluster-each -r mysql -- 'echo "SELECT @@global.gtid_executed;" | sudo mysql'
ghe-cluster-each -r mysql -- 'echo "SELECT @@global.gtid_executed;" | sudo mysql'
- Para verificar se a variável MySQL global foi definida com êxito, execute o comando a seguir.
Shell echo "SHOW GLOBAL VARIABLES LIKE 'super_read_only';" | sudo mysql
echo "SHOW GLOBAL VARIABLES LIKE 'super_read_only';" | sudo mysql
-
Se o GitHub Actions estiver habilitado no cluster, acesse por SSH o nó que se tornará o novo nó MSSQL primário.
Shell ssh -p 122 admin@NEW_MSSQL_NODE_HOSTNAME
ssh -p 122 admin@NEW_MSSQL_NODE_HOSTNAME
- Em uma sessão de
screen
, execute o comando a seguir para promover o MSSQL para o novo nó.
Shell /usr/local/share/enterprise/ghe-mssql-repl-promote
/usr/local/share/enterprise/ghe-mssql-repl-promote
Isso tentará acessar o nó MSSQL primário atual e executar um failover normal
- Em uma sessão de
-
Depois que os GTIDs nos nós MySQL primário e de réplica estiverem iguais, atualize a configuração do cluster ao abrir o arquivo de configuração do cluster em
/data/user/common/cluster.conf
com um editor de texto.- Crie um backup do arquivo
cluster.conf
antes de editá-lo. - Na seção
[cluster]
de nível superior, remova o nome do host do nó que você substituiu do par de valores-chavemysql-master
e atribua o novo nó. Se o novo nó também for um nó Redis primário, ajuste o par de valores-chaveredis-master
. - Se o GitHub Actions estiver habilitado no cluster, você também precisará incluir o par chave-valor
mssql-server = true
.
[cluster] mysql-master = NEW-NODE-HOSTNAME redis-master = NEW-NODE-HOSTNAME primary-datacenter = primary ...
- Crie um backup do arquivo
-
No shell administrativo do nó em que você modificou
cluster.conf
, inicie uma sessãoscreen
e executeghe-cluster-config-apply
. Esse comando reconfigura o cluster, promovendo o nó recém-adicionado ao nó MySQL primário e convertendo o nó MySQL primário original em uma réplica.Note
O snippet anterior não pressupõe que o GitHub Actions esteja habilitado no cluster.
-
Verifique o status da replicação MySQL (ou MySQL e MSSQL) em qualquer nó do cluster executando
ghe-cluster-status -v
. -
Se o GitHub Actions estiver habilitado no cluster, execute o comando a seguir no novo nó MySQL e MSSQL.
Shell /usr/local/share/enterprise/ghe-repl-post-failover-mssql
/usr/local/share/enterprise/ghe-repl-post-failover-mssql
-
Quando a replicação MySQL (ou MySQL e MSSQL) for concluída, em qualquer nó do cluster, desabilite o modo de manutenção. Confira Habilitar e programar o modo de manutenção.