Este manual fornece instruções detalhadas para a atualização de versão do sistema, abrangendo todas as etapas necessárias para garantir uma transição suave.

Para realizar a atualização, siga os passos abaixo:

Primeiro, identifique onde o sistema está instalado. Isso é crucial para acessar os componentes corretos e realizar as alterações necessárias.

Identifique as tags de imagens Docker relacionadas ao sistema, incluindo as que serão atualizadas. As versões das imagens podem ser verificadas no site oficial da documentação (https://citbot-api.centralit.com.br/docs). Consulte a seção correspondente para visualizar as versões disponíveis e compare com as atualmente em uso.

Antes de realizar qualquer atualização, é fundamental realizar um backup completo da base de dados. Isso garante que todos os dados possam ser restaurados em caso de qualquer problema durante o processo de atualização.

Altere as imagens Docker para as últimas versões disponíveis. As imagens que devem ser atualizadas são:

O processo de atualização deve começar pela Schedule-API, para verificar se as migrations foram executadas com sucesso. Essa etapa é crucial para assegurar que o esquema do banco de dados esteja atualizado antes de prosseguir com as outras partes do sistema.

Este manual fornece instruções detalhadas para a atualização de versão do sistema, abrangendo todas as etapas necessárias para garantir uma transição suave.

Para realizar a atualização, siga os passos abaixo:

Primeiro, identifique onde o sistema está instalado. Isso é crucial para acessar os componentes corretos e realizar as alterações necessárias.

Identifique as tags de imagens Docker relacionadas ao sistema, incluindo as que serão atualizadas. As versões das imagens podem ser verificadas no site oficial da documentação (https://citbot-api.centralit.com.br/docs). Consulte a versão correspondente, conforme imagem abaixo e compare com as atualmente em uso.

Antes de realizar qualquer atualização, é fundamental realizar um backup completo da base de dados. Isso garante que todos os dados possam ser restaurados em caso de qualquer problema durante o processo de atualização.

Altere as imagens Docker para as últimas versões disponíveis. As imagens que devem ser atualizadas são:

O processo de atualização deve começar pela Schedule-API, para verificar se as migrations foram executadas com sucesso. Essa etapa é crucial para assegurar que o esquema do banco de dados esteja atualizado antes de prosseguir com as outras partes do sistema.

Após atualizar a imagem da Schedule-API, verifique a execução das migrations. As migrations devem ser confirmadas como bem-sucedidas para garantir a integridade dos dados e a compatibilidade com as novas versões da aplicação.

Após todas as etapas anteriores, execute uma bateria de testes para garantir que o sistema esteja funcionando corretamente com as novas atualizações. Verifique todas as funcionalidades principais e qualquer nova funcionalidade introduzida.

Se houver necessidade de reverter a atualização, siga os passos abaixo:

Utilize o backup realizado antes da atualização para restaurar a base de dados para o estado anterior.

Retorne as tags das imagens Docker para a versão anterior, conforme necessário. Isso restaurará o sistema para o estado anterior à atualização.

Flags de Configuração

As feature flags são utilizadas para controlar funcionalidades específicas da aplicação CITBot. Abaixo estão listadas as feature flags disponíveis, juntamente com suas respectivas descrições:

TIMEOUT_ENABLE:

Controla o timeout para encerrar conversas de chatbot.

LUA_PIPELINE_ENABLED:

Ativa ou desativa o uso da pipeline desenvolvida em Lua.

MASKING_ENABLED:

Habilita ou desabilita a proteção de informações sensíveis.

FILEMANAGER_ENABLED:

Ativa ou desativa a funcionalidade de gerenciador de arquivos.

COQUINHO_ENABLE:

Controla a funcionalidade de conversão de texto para fala (TTS).

SENTIMENT_ANALYSIS:

Habilita ou desabilita a funcionalidade de análise de sentimento.

WHISPER_ENABLED:

Ativa ou desativa a funcionalidade de reconhecimento de fala (STT).

ENABLE_SCHEDULES:

Habilita ou desabilita a execução de schedules na aplicação, especialmente para o deployment de Schedule-API.

RUN_MIGRATIONS:

Controla a execução de migrations de banco de dados, especialmente para o deployment de Schedule-API.

Este manual deve ser seguido rigorosamente para garantir que a atualização ocorra sem problemas e que, em caso de necessidade, o rollback possa ser realizado de forma eficiente.

Após atualizar a imagem da Schedule-API, verifique a execução das migrations. As migrations devem ser confirmadas como bem-sucedidas para garantir a integridade dos dados e a compatibilidade com as novas versões da aplicação.