Skip to main content

Guia de recuperação do host do Server

Este guia destina-se a ajudar um administrador do Server a recuperar uma instância do Server em caso de falha de um ou mais hosts originais. Isso pode acontecer ao fazer um upgrade para um novo Server, passar de um servidor local para um na nuvem e em outros casos em que a infraestrutura é alterada.

  • Failure of the original host*

  • Migration to a new Server machine

  • Transition from an on-premises to a cloud Server

  • Other infrastructure changes

Uma recuperação permite que você obtenha um novo Server em funcionamento com seus usuários, fluxos de trabalho, agendamentos e outras configurações originais, com base na disponibilidade dos seguintes elementos do seu Server original:

  • Token do controlador

  • RuntimeSettings.xml do nó do controlador

  • Backup do MongoDB

* To fully recover a Server instance in a disaster recovery scenario where the original host is no longer accessible, the RuntimeSettings.xml must be prepared in advance, while the original host is in a fully functioning state. For more details refer to the Disaster Recovery Preparation help page.

Abaixo estão os detalhes para cada etapa do processo:

1 - Preparar

2 - Install Alteryx Server

2 - Recuperar RuntimeSettings.xml

3 - Recuperar MongoDB

4 - Restaurar outros arquivos e configurações

5 - Iniciar o Alteryx Server

6 - Realizar teste

Dentro do escopo

  • Recuperação de falha em uma instalação única e padrão do Server usando o MongoDB incorporado.

  • Backup disponível com as informações necessárias intactas.

  • A máquina ou máquinas de destino podem ser substituídas.

Fora do escopo

  • Ambiente do Server com múltiplos nós, MongoDB gerenciado pelo usuário ou SQL Server gerenciado pelo usuário. Entre em contato com o Suporte ao Cliente para obter ajuda.

  • Backup ou restauração de drivers ODBC.

  • Backup ou restauração de DSNs de usuário ou do sistema.

  • Backup ou restauração de outros aliases armazenados no Windows existentes fora do Alteryx.

Prerequisites

  • Version Compatibility:

Original Host

Compatible Target Hosts

2021.4.2.47792 (Patch 5) or newer patch

2021.4.2.47884 (Patch 11) or newer patch of 2021.4 version

2022.1.1.42590 (Patch 3) or newer patch

2022.1.1.42691 (Patch 9) or newer patch of 2022.1 version

2022.3.1.430 (Server GA) or newer patch

2022.3.1.553 (Patch 6) or newer patch of 2022.3 version

2023.1.1.123 (Server GA) or newer patch

2023.1.1.247 (Patch 2) or newer patch of 2023.1 version

All newer and future versions of Alteryx Server

Any GA or patch release as long as the original host and target host are on the same version and patch.

  • Install all database drivers and necessary software for workflow operation before completing the steps outlined in this guide to ensure minimal downtime.

  • Administrator rights on the target host.

  • Access to all credentials used for impersonation including, the service account (if not Local System), the Run As user, and any defined/used workflow credentials.

  • Controller Token from the original host.

  • A direct line of sight is needed to restore your encryption key as part of the recovery. Your new Server will need access to the AlteryxService running on your original Server Controller node over your network. Contact Customer Support if you are unable to meet this prerequisite.

  • Backup of MongoDB from the original host. Learn how to perform a backup.

    For more information on Server Backup & Recovery, please see the Server Backup & Restore Best Practices: Part 1 and Part 2.

  • Verify the target host is set to the same time zone as the original host in Windows time zone settings. If not set to the same time zone, errors might occur in schedule views.

Fora do escopo

The following items might not have been leveraged in the original Server. Check if the functionality is being used on your original Server and if so, complete the corresponding steps marked (Optional) in this guide.

  • Ambiente do Server com múltiplos nós, MongoDB gerenciado pelo usuário ou SQL Server gerenciado pelo usuário. Entre em contato com o Suporte ao Cliente para obter ajuda.

  • Combinação de bancos de dados de arquivos de conexão.

    • Domain

    • Username

    • Password

  • Backup ou restauração de drivers ODBC.

  • Backup ou restauração de DSNs de usuário ou do sistema.

  • Backup ou restauração de outros aliases armazenados no Windows existentes fora do Alteryx.

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

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

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

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

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

  • Alteryx Predictive Tools and any R libraries used by workflows in the original Server.

    Predictive Tools should be installed as part of the initial Alteryx Server installation (Step 2) to ensure proper version is installed.

Etapa 1: preparar

#

Etapa

Detalhes

1.1

Definir o fuso horário da máquina

O fuso horário do Windows da nova máquina deve ser definido para corresponder à máquina original.

1.2

Garantir o acesso ao Alteryx

Certifique-se de que a máquina possa acessar whitelist.alteryx.com utilizado pelo sistema de licenciamento da Alteryx.

Step 2: Install Alteryx Server

#

Step

Details

2.1

Is the version of Alteryx Server on your original host any of the following versions?

  • 2022.1.1.40869 (Patch 2) or any earlier patch

  • 2021.4.2.47792 (Patch 4) or any earlier patch

  • 2021.3 and all earlier versions

YES: Install or upgrade the target host to the exact same major and patch version that exists on the original host. Use the full install file opposed to the patch install.

If needed, please contact fulfillment@alteryx.com to request the needed install file.

Go to step 2.4.

NO: Continue to step 2.2.

2.2

Is the version of Alteryx Server on your original host listed in the Compatible Target Hosts columns of the Version Compatibility table in the Prerequisites section?

YES: Install or upgrade the target host to the exact same major and patch version that exists on the original host. Use the full install file opposed to the patch install.

If needed, please contact fulfillment@alteryx.com to request the needed install file.

Go to step 2.4.

NO: Continue to step 2.3.

2.3

Install the newest patch version of Alteryx Server on target host

Install or upgrade the target host to the newest patch available for the major version the original host is on (for example, if original host is on 2022.3 Patch 3, install the newest patch of 2022.3 on the target host).

2.4

Configure Alteryx Server

Configure Alteryx Server using default settings and confirm the Server UI appears in a browser.  You do not need to log in.

2.5

Troubleshoot

License key "in use" error

If your license key is still tied to your old server, you will need to deactivate it on that machine. If that machine is inaccessible, contact your License Administrator to release the license.

Etapa 2: recuperar RuntimeSettings.xml

#

Etapa

Detalhes

3.1

Abrir o prompt de comando 1 na pasta bin

Abra um prompt de comando como administrador, navegue até a pasta Alteryx/bin, e insira os comandos abaixo (ajuste com base no local de instalação).

c: cd \Program Files\Alteryx\bin

c: cd \Program Files\Alteryx\bin

3.2

Parar o Serviço

Insira o comando

net stop alteryxservice

Em caso de sucesso, você verá "The Alteryx Service service was stopped successfully".

3.3

Fazer backup do RuntimeSettings.xml existente

Insira o comando

c: cd \ProgramData\Alteryx ren RuntimeSettings.xml RuntimeSettings_BACKUP.xml

c: cd \ProgramData\Alteryx ren RuntimeSettings.xml RuntimeSettings_BACKUP.xml

3.4

Restaurar RuntimeSettings.xml

YES: Your RuntimeSettings.xml from the Disaster Recovery Process should already be located in your target host’s %ProgramData%\Alteryx\ directory. If not, copy the prepared RuntimeSettings.xml to %ProgramData%\Alteryx\.

Go to step 3.13.

Copie o arquivo RuntimeSettings.xml do Server original para o diretório atual %ProgramData%\Alteryx\.

Continue to step 3.5.

3.5

Limpar o Token do controlador

Edite o RuntimeSettings.xml que você acabou de copiar e exclua tudo entre as tags <ServerSecretEncrypted>, deixando apenas as tags conforme mostrado abaixo:

64ae505fe2c2c.png

Salve e feche o arquivo.

3.6

Restaurar o Token do controlador

Insira o comando usando o token do controlador do Server original

AlteryxService.exe setserversecret=TOKEN_DO_CONTROLADOR_DO_SERVER_ORIGINAL

Solução de problemas:

A versão 2021.3 e mais recentes podem indicar erro nesta etapa com a mensagem: "Set server secret failed: Error in CryptImportKey(3): Bad Data. (-2146893819)". Para corrigir isso, consulte a etapa anterior para garantir que o valor entre as tags foi removido.

3.7

Restaurar as Chaves de armazenamento criptografadas

O valor <StorageKeysEncrypted> pode ter sido alterado quando o token do controlador foi redefinido na etapa 2.6. Se for o caso, ele deve ser substituído pelo valor correspondente do arquivo original "RuntimeSettings.xml", ou seja, o arquivo "RuntimeSettings_BACKUP.xml" criado anteriormente na etapa 2.3. É mais fácil copiar as tags também para garantir que todo o valor entre elas seja copiado do arquivo RuntimeSettings.xml original. Você pode deixar o RuntimeSettings.xml aberto em um editor de texto à medida que faz outras alterações na etapa 3.

Step 2.7 Restore Encryption Keys

3.8

Restaurar 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.9

Restaurar 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.10

Salvar RuntimeSettings.xml

Salve o arquivo RuntimeSettings.xml.

3.11

Is the version of Alteryx Server on your original host any of the following versions?

  • 2022.1.1.40869 (Patch 2) or any earlier patch

  • 2021.4.2.47792 (Patch 4) or any earlier patch

  • 2021.3 and all earlier versions

YES: Go to step 3.13.

NO: Continue to step 3.12.

3.12

Transferir a Chave de criptografia

Esta funcionalidade só está disponível nas seguintes versões:

  • 2021.4.2 patch 11 e mais recentes

  • 2022.1 patch 9 e mais recentes

  • 2022.3 patch 6 e mais recentes

  • 2023.1 patch 2 e mais recentes

  • 2023.2 de disponibilidade geral e mais recentes

Important: Please note that this requires the AlteryxService to be running on your original host and your target host will need to be able to access it over the network.

As etapas em Processo de transferência de chaves de criptografia permitirão que você transfira a chave de criptografia do seu controlador existente para o novo.

3.13

Permanecer na linha de comando

A etapa 3 assume que você está em uma linha de comando como administrador na pasta \Alteryx\bin.

Etapa 3: recuperar MongoDB

#

Etapa

4.1

Obter o backup do MongoDB

Copie o backup do Mongo do Server original para uma pasta MONGO_BACKUP no seu novo Server.

4.2

Restaurar para uma nova pasta

Restaure o banco de dados do Mongo da pasta de backup para uma nova pasta de restauração. Revise o mongoRestore.log conforme descrito abaixo para garantir que a restauração foi bem-sucedida.

Consulte a seção Restaurar a partir de um backup do MongoDB no documento Backups do MongoDB para encontrar o comando de restauração apropriado para a sua versão do Server.

4.3

Confirmar se a restauração foi bem-sucedida

Confirme se a restauração foi bem-sucedida.

Cuidado

Esse é um passo necessário, pois uma falha da restauração não será relatada no passo anterior e pode levar a dados faltantes no Server. Para fazer isso, revise o arquivo mongoRestore.log na pasta do MongoDB onde os dados foram restaurados. Abra o mongoRestore.log e siga estas etapas:

  • Confirme se ele relata a mensagem #### document(s) restored successfully, 0 document(s) failed to restore (#### documentos restaurados com êxito, 0 documentos com falha ao restaurar) na última linha.

  • Procure pelas palavras error, critical, fatal e failed. Se estiver procurando por failed, verifique se o resultado difere da frase no ponto anterior, que contém 0 document(s) failed (0 documentos com falha).

Se a recuperação falhou, ou se você encontrar algum resultado ao pesquisar as palavras-chave listadas acima, entre em contato com o Suporte com todas as informações que você reuniu.

Não prossiga caso a restauração do MongoDB tenha falhado.

4.4

Definir o caminho Mongo em RuntimeSettings.xml

Edite o RuntimeSettings.xml e digite o caminho para a PASTA_RESTAURAÇÃO_MONGO na tag <EmbeddedMongoDBRootPath>.

Exemplo:

Set Mongo path in RuntimeSettings.XML

Salve e feche o editor de texto.

4.5

Iniciar o MongoDB

Insira o comando

mongod ––dbpath "PASTA_RESTAURAÇÃO_MONGO" ––auth ––port 27018

Exemplo

mongod ––dbpath "%ProgramData%\Alteryx\Service\Persistence\Mongo_Restore" ––auth ––port 27018

Não feche a janela do prompt de comando.

Se fechar a janela a partir da etapa 3.5, nenhuma das etapas seguintes funcionará.

<< Iniciar a segunda seção do prompt de comando >>

4.6

Abrir o segundo prompt de comando na pasta bin

Abra um SEGUNDO prompt de comando como administrador, navegue até a pasta Alteryx\bin e insira os comandos abaixo (ajuste com base no local de instalação).

c: cd \Program Files\Alteryx\bin

c: cd \Program Files\Alteryx\bin

4.7

Obter senha de não administrador do Mongo

Insira o comando e copie sua SENHA_NÃO_ADMINISTRADOR_MONGO no bloco de notas

AlteryxService.exe getemongopassword

4.8

Iniciar a linha de comando do Mongo

Insira o comando

mongosh mongodb://SERVER:PORT/AlteryxGallery -u user -p SENHA_NÃO_ADMINISTRADOR_MONGO

Exemplo

mongosh mongodb://localhost:27018/AlteryxGallery -u user -p CCEC***33C0

Em caso de sucesso, você deve ver um prompt ">".

4.9

Excluir bloqueios definidos pelo Server original

Insira o comando do Mongo

db.locks.remove({})

Em caso de sucesso, você verá: "writeResult({ “nRemoved” : N })", onde N é um número entre 0 e 3.

4.10

Switch to AlteryxService database

Enter the Mongo command

use AlteryxService

4.11

Delete AlteryxService locks set by original Server

Enter the Mongo command

db.locks.remove({})

On success you should see: "writeResult({ “nRemoved” : N })", where N is a number between 0 and 3.

4.12

Sair da linha de comando do Mongo e do prompt de comando 2

Insira o comando

exit

Feche Command_Prompt_2

<< Encerrar a segunda seção do prompt de comando >>

4.13

Parar banco de dados do Mongo

No prompt de comando original, digite o comando do teclado

ctrl-c

uma ou mais vezes até sair do MongoDB e retornar a um prompt de comando normal.

Feche o prompt de comando.

Etapa 4: restaurar outros arquivos e configurações

#

Etapa

Detalhes

5.1

Você tinha um Usuário de logon de serviço no Server original?

Defina um Usuário de logon de serviço no novo Server.

No aplicativo Serviços do Windows, clique com o botão direito do mouse em AlteryxService > Propriedades > Logon

5.2

Adicione drivers de dados e DSNs do sistema.

Adicione drivers com a mesma versão e DSNs do sistema com o mesmo nome para corresponder ao Server Original; https://downloads.alteryx.com/.

Problemas avançados que podem não se aplicar à sua recuperação:

5.3

Em ambientes mais seguros, configure as permissões de usuário run-as necessárias.

Certifique-se de que todas as credenciais utilizadas para executar fluxos de trabalho (run-as, logon de serviço ou credencial definida ao salvar o fluxo de trabalho) tenham acesso suficiente e adequado; configure as permissões de usuário de execução necessárias.

5.4

Restaurar aliases de conexão in-DB e com base no sistema

Conexões de dados do sistema:

%ProgramData%\Alteryx\Engine\SystemAlias.xml

Conexões de dados in-DB do sistema:

%ProgramData%\Alteryx\Engine\SystemConnections.xml

5.5

Restaurar aliases de conexão In-DB e com base no usuário

Conexões de dados do usuário:

C:\Users\[username]\AppData\Roaming\Alteryx\Engine\UserConnections.xml

Conexões de dados in-DB do usuário:

C:\Users\[username]\AppData\Roaming\Alteryx\Engine\UserAlias.xml

5.6

Os fluxos de trabalho usam conectores?

Copie as pastas de conectores do Server original para

%ProgramData%\Alteryx\Tools

Entre em contato com o Suporte ao Cliente para habilitar conectores no seu novo Server.

5.7

Os fluxos de trabalho usam a ferramenta Python?

Reinstale quaisquer pacotes Python que os fluxos de trabalho tinham instalado. Consulte Server Upgrade Python Tool Environment Checklist.

5.8

Você usa SSL?

Se você estiver realizando a recuperação para um Server de sandbox para fins de teste, use HTTP para teste.

Se você estiver migrando para um novo Server, restabeleça seu SSL:

Configurar SSL/TLS no Server

Configurar o Alteryx Server para SSL: obtenção e instalação de certificados (15577)

Etapa 5: iniciar o Alteryx Server

#

Etapa

Detalhes

6.1

Reveja as configurações de sistema do Alteryx e suspenda os agendamentos, se desejar.

Execute as Configurações de sistema do Alteryx e passe por cada página para confirmar que as definições (como o token do controlador) contêm os valores que você espera.

Se você não quiser que os agendamentos sejam executados quando o serviço for iniciado, desmarque:

Worker > General > Allow machine to run scheduled Alteryx workflows

Quando você selecionar Finish, o Alteryx Service deve ser iniciado e o Server deve ficar disponível em um navegador.

Importante

Preste especial atenção à Configuração da IU do Server, pois um novo Server pode ter um URL diferente ou pode não ter um certificado SSL.

System Settings, the Server UI configuration section.

Etapa 6: realizar teste

#

Etapa

Detalhes

7.1

Testes básicos

O AlteryxService está em execução?

Você pode:

  • Acessar o URL da IU do Server?

  • Mover-se pelas páginas de administrador e visualizar usuários, coleções etc.?

  • Publicar um fluxo de trabalho do Designer para o Server?

  • Executar o fluxo de trabalho?

  • Se sua configuração permitir, salve e execute um fluxo de trabalho especificando suas credenciais.

7.2

Testes específicos de fluxos de trabalho

É possível executar fluxos de trabalho que contenham extensões ou conexões externas? Exemplos:

  • Entrada/saída para um caminho UNC de rede

  • Conexões de bancos de dados

  • Ferramentas conectoras

  • Conjuntos de dados de localização ou insights de negócios

  • Ferramenta Python

  • Ferramenta R