Skip to main content

Preparação para recuperação de desastres

Importante

Throughout this document, 2 hosts will be referenced:

  • Original: The current host running Alteryx Server.

  • Target: The backup host to be used for disaster recovery. This host does not require an Alteryx Server license to be used as a backup host.

Scope

This document covers the procedures needed to prepare for a Disaster Recovery scenario where the original Alteryx Server Controller node is no longer accessible. The items in this guide can be used in conjunction with the Server Host Recovery Guide to restore a Server host in a Disaster Recovery scenario.

This document is not intended for High Availability environments. For more details, refer to the High-Availability Best Practices page.

Prerequisites

  • Backup of the Alteryx Server Persistence layer (MongoDB or SQL Server) stored independently from the current Alteryx Server environment.

    Nota

    This guide does not cover creating a backup of the Persistence layer required for disaster recovery. For more information on Server backup and recovery for embedded MongoDB, see Server Backup & Restore Best Practices: Part 1 and Part 2. For user-managed MongoDB or SQL Server instances, please contact your MongoDB or SQL Server administrator.

  • Prepared RuntimeSettings.xml located. See Prepare RuntimeSettings.xml.

Optional

The following items might be leveraged on the original Server. Check if the functionality is being used on your original Server. If applicable, make sure copies of the following files and resources are available independent of your current Server environment.

  • AlteryxService Log On user credentials

  • Run-As User credentials

  • SMTP server credential

  • Connector Tools found in %ProgramData%\Alteryx\Tools.

  • Alteryx System-Based and In-DB Connection aliases:

    • System Data Connections: %ProgramData%\Alteryx\Engine\SystemAlias.xml

    • In-DB Data Connections: %ProgramData%\Alteryx\Engine\SystemConnections.xml

  • Alteryx User-Based and In-DB Connection Aliases from the original Server – the items below might be relevant for each Run-As or workflow credential user account:

    • User Data Connections: C:\Users\[username]\AppData\Roaming\Alteryx\Engine\UserConnections.xml

    • User In-DB Data Connections: C:\Users\[username]\AppData\Roaming\Alteryx\Engine\UserAlias.xml

Importante

Se você estiver executando uma versão do Server listada na tabela abaixo, o processo neste guia não será necessário e você poderá seguir o Guia de recuperação do host do Server para recuperação de desastres caso uma cópia do banco de dados e do "RuntimeSettings.xml" do seu host estiverem disponíveis.Guia de recuperação do host do Server

Versões do Alteryx Server para usar o Guia de recuperação do host do Server

2021.4.2.47792 (patch 4) ou versões e patches anteriores

2022.1.1.42590 (patches 1 e 2)

Preparação para recuperação de desastres – RuntimeSettings.xml

Devido a alterações recentes nos métodos de criptografia (TGAL-6764), os usuários agora devem se preparar proativamente para um cenário de recuperação de desastres em que o nó do controlador do Alteryx Server original não esteja mais disponível. Este guia irá orientar você através do procedimento para preparar o arquivo "RuntimeSettings.xml" em um nó de controlador de backup para ser usado para recuperação de desastres.

Pré-requisitos

  • Acesso de administrador aos hosts original e de destino.

  • O host original deve estar operacional e o Alteryx Service deve estar em execução.

Host original

Hosts de destino compatíveis

2021.4.2.47792 (patch 5) ou patch mais recente

2021.4.2.47884 (patch 11) ou patch mais recente da versão 2021.4

2022.1.1.42590 (patch 3) ou patch mais recente

2022.1.1.42691 (patch 9) ou patch mais recente da versão 2022.1

2022.3.1.430 (Server de disponibilidade geral) ou patch mais recente

2022.3.1.553 (patch 6) ou patch mais recente da versão 2022.3

2023.1.1.123 (Server de disponibilidade geral) ou patch mais recente

2023.1.1.247 (patch 2) ou patch mais recente da versão 2023.1

Todas as versões mais recentes e futuras do Alteryx Server

Qualquer versão de disponibilidade geral ou de patch, desde que o host original e o host de destino estejam na mesma versão e patch.

Etapa 1: instalar o Alteryx Server

#

Etapa

Detalhes

1.1

Você pode atualizar ou instalar a versão e patch mais recentes do Alteryx Server em seus hosts original e de destino?

SIM: atualize ou instale a versão e o patch mais recentes do Alteryx Server em seus hosts original e de destino. Configure o seu host original normalmente.

Vá para a etapa 2.1.

Note: You do not need to configure Alteryx Server post installation on your target host as this process does not require it to be licensed.

NÃO: vá para a etapa 1.2.

1.2

Você pode atualizar seus hosts original e de destino para o patch mais recente da respectiva versão?

SIM: aplique um patch no seu host original usando o patch mais recente para a respectiva versão principal e instale a versão e o patch mais recentes correspondentes em seu host de destino. Por exemplo, se você estiver no patch 3 da versão 2022.3, instale o patch mais recente disponível para a versão 2022.3. 

Vá para a etapa 2.1.

Note: You do not need to configure Alteryx Server post installation as this process does not require it to be licensed.

NÃO: vá para a etapa 1.3.

1.3

A versão do Alteryx Server em seu host original está listada em Hosts de destino compatíveis na seção Pré-requisitos?

SIM: instale ou atualize o host de destino para a mesma versão principal e de patch que existe no host original. Use o arquivo de instalação completo em oposição à instalação do patch.

Se necessário, entre em contato com fulfillment@alteryx.com para solicitar o arquivo de instalação necessário.

Vá para a etapa 2.1.

Note: You do not need to configure Alteryx Server post installation as this process does not require it to be licensed.

NÃO: vá para a etapa 1.4

1.4

Instale a versão de patch mais recente do Alteryx Server no host de destino.

Instale ou atualize o host de destino para o patch mais recente disponível para a versão principal do host original (por exemplo, se o host original estiver no patch 3 da versão 2022.3, instale o patch mais recente da versão 2022.3 no host de destino).

Vá para a etapa 2.1.

Note: You do not need to configure Alteryx Server post installation as this process does not require it to be licensed.

Etapa 2: preparar e copiar o token do controlador e RuntimeSettings.xml

#

Etapa

Detalhes

2.1

Encontre o comprimento do token do controlador no host original.

Em Configurações de sistema do Alteryx > Controller > General, clique em View. Registre o comprimento do token do controlador.

Note: In some versions, the Controller Token is partially obscured. Double-click on the Token to highlight it in its entirety, then copy and paste into a text document to determine its length.

2.2

O seu token do controlador tem 40 caracteres?

SIM: vá para Configurações de sistema do Alteryx > Controller > General > e clique em Regenerate.

NÃO: vá para a etapa 2.5.

2.3

Reinicie o AlteryxService.

Navegue pelo restante das Configurações de sistema do Alteryx e clique em Finish. Isso reiniciará o AlteryxService.

2.4

Reconecte os nós adicionais (se aplicável).

Se você tiver uma configuração de múltiplos nós, use o token do controlador recém-regenerado para reconectar todos os nós ao nó do controlador.

2.5

Salve e copie o Token do controlador do host original.

Para o token do controlador, vá para Configurações de sistema do Alteryx > Controller > General > Token > View.

Copie e salve o token do controlador em um documento de texto. Em seguida, copie o documento de texto para um local de sua escolha no host de destino.

Note: In some versions, the Controller Token is partially obscured. Double-click on the Token to highlight it in its entirety, then copy and paste into a text document.

2.6

Copie RuntimeSettings.xml do host original.

Copie o arquivo RuntimeSettings.xml de %ProgramData%\Alteryx em seu host original para um local de sua escolha em seu host de destino.

Important: Do not copy the file to %ProgramData%\Alteryx on the target host and do not modify the file.

Etapa 3: recuperar RuntimeSettings.xml

#

Etapa

Detalhes

3.1

Abra o prompt de comando para a pasta "bin" no host de destino.

Abra um prompt de comando como administrador e navegue até a pasta de instalação Alteryx\bin. Todos os comandos nesta seção devem ser executados a partir dessa pasta.

Note: If you’re unsure of the location of this folder, check the properties of the ‘Alteryx System Settings’ shortcut, as the file it points to is in the desired folder. Default location: C:\Program Files\Alteryx\bin.

3.2

Pare o AlteryxService.

Insira o comando:

net stop alteryxservice

Se o serviço AlteryxService estava em execução, em caso de sucesso você verá "The AlteryxService service was stopped successfully".

Se o serviço AlteryxService estava parado, você verá "The AlteryxService service is not started".

Deixe essa janela aberta.

3.3

Faça backup do RuntimeSettings.xml existente no host de destino.

Renomeie o host de destino de %ProgramData%\Alteryx\RuntimeSettings.xml para RuntimeSettings_BACKUP.xml como um backup.  

Se o "RuntimeSettings.xml" não existir, vá para a etapa 3.4.

3.4

Restaure o RuntimeSettings.xml.

Copie/cole o arquivo RuntimeSettings.xml copiado do seu host original na etapa 2.6 em %ProgramData%\Alteryx no seu host de destino.

Note: Make sure to copy file. Do not move and cut it as the file will be needed in its original state throughout this guide.

3.5

Limpe o Token do controlador.

Edite %ProgramData%\Alteryx\RuntimeSettings.xml no seu host de destino.

Exclua tudo entre as tags <ServerSecretEncrypted>, deixando apenas as tags como mostrado abaixo:

DR_best_practices_01.png

3.6

Salve o RuntimeSettings.xml.

Salve o RuntimeSettings.xml em seu host de destino.

3.7

Restaure o Token do controlador.

De volta ao prompt de comando aberto na etapa 3.1, digite o seguinte comando usando o token do controlador de seu host original obtido na etapa 2.5:

AlteryxService.exe setserversecret=TOKEN_DO_CONTROLADOR_DO_SERVER_ORIGINAL

Solução de problemas: a versão 2021.3 e versões posteriores podem indicar erro nesta etapa com a mensagem: "Set server secret failed: Error in CryptImportKey(3): Bad Data. (-2146893819)". Para corrigir isso, consulte as etapas 3.5 – 3.6 para garantir que você removeu o valor entre as tags.

3.8

Limpe as Chaves de armazenamento.

Edite %ProgramData%\Alteryx\RuntimeSettings.xml localizado no seu host de destino novamente.

Exclua tudo entre as tags <StorageKeysEncrypted>, deixando apenas as tags como mostrado abaixo:

DR_best_practices_02.png

3.9

Restaure as Chaves de armazenamento.

Copie o valor <StorageKeysEncrypted> do RuntimeSettings.xml da etapa 2.6 e cole-o entre as tags <StorageKeysEncrypted> no RuntimeSettings.xml em seu host de destino. O comprimento desse valor varia de acordo com a versão. Veja exemplos abaixo:

DR_best_practices_03.png

3.10

Salve o RuntimeSettings.xml.

Salve o RuntimeSettings.xml em seu host de destino.

3.11

Restaure o Usuário run-as.

Se você tinha um usuário run-as no Server original, insira o seguinte comando; caso contrário, ignore esta etapa:

AlteryxService.exe setexecuteuser=NOME,DOMÍNIO,SENHA

3.12

Restaure a Senha SMTP.

Se você havia preenchido Configurações de sistema do Alteryx > Server UI > SMTP > Password (mesmo que a caixa de seleção para SMTP esteja desmarcada), insira o seguinte comando; caso contrário, ignore esta etapa:

AlteryxService.exe setsmtppassword=SENHA

3.13

Restaure as Chaves de criptografia.

As etapas em Processo de transferência de chaves de criptografia permitirão que você transfira a chave de criptografia do seu host original para o host de destino. Observe que a última etapa do Processo de transferência de chaves de criptografia exige que você reinicie o serviço, o que não é possível em alguns casos em que o host de destino não está licenciado.

As etapas em Processo de transferência de chaves de criptografia permitirão que você transfira a chave de criptografia do seu host original para o host de destino. Observe que a última etapa do Processo de transferência de chaves de criptografia exige que você reinicie o serviço, o que não é possível em alguns casos em que o host de destino não está licenciado.

Feito! O arquivo "RuntimeSettings.xml" no host de destino agora pode ser usado em um cenário de recuperação de desastres em que o host original não esteja mais disponível. Tenha em mente que o RuntimeSettings.xml que foi preparado na etapa 3 só funcionará em seu host de destino usando um MongoDB ou SQL DB que foi usado em seu host original.

Considerações futuras

Após esse processo, à medida que você atualiza seu host original para versões mais recentes do Server, você também precisará atualizar seu host de destino para a mesma versão e patch para garantir os melhores resultados em um cenário de recuperação de desastres.

Se você alterar o token do controlador em seu host original, precisará refazer as etapas 2 e posteriores para garantir que os tokens do controlador do host de destino e do host original sejam correspondentes.