01. VISÃO GERAL
O TOTVS Gateway Manager é um centralizador de requisições (ponto único de acesso), que realiza a análise, a filtragem e redirecionamento do tráfego de terceiros entre os hosts ativos.
As funções presentes no API Gateway permitem as mais diversas vantagens para quem o utiliza. Um único ponto de acesso, por exemplo, significa uma redução de esforço em administrar as "portas de entradas" dos serviços utilizados, podendo focar seus esforços em um único local.
As funções presentes no API Manager fornecem uma camada de gestão para o API Gateway. Além de definir o comportamento do API Gateway, o API Manager lida com a análise de cada requisição.
02. VANTAGENS E POSSIBILIDADES DO TGM
Haverá um ponto central de comunicação com os Serviços para requisições de portais web, sem que seja necessário implementar uma regra de balanceamento e descoberta em cada portal.
Não é necessário mais re-configurar todas as aplicações clientes ao incrementar ou modificar o parque de Servers.
Será possível visualizar todos os Servers disponíveis no parque, além de poder testar a saúde de comunicação dos mesmos, é até reconfigurar cada server para que ele atenda a determinados tipos de serviços.
Principais características de destaque do TGM:
- A solução é de fácil implantação, tanto para novas instalações quanto para instalações já existentes.
- O sistema é modularizável e servirá à qualquer linha de produto da TOTVS.
- Será possível que o administrador do ERP tenha uma visão completa de todo o parque de servidores.
03. REQUISITOS
A partir da versão 12.1.2406 do RM, não há pré-requisitos para a instalação do TGM.
Para versões anteriores, consultar: Dependências de execução do TGM na versão 12.1.2402 e anteriores - Linha RM - TDN (totvs.com.br)
04. INSTALANDO O TGM
04.01 (MÁQUINA LOCAL)
Abaixo iremos apresentar como instalar o TGM.
A instalação do TGM pode ser feita via TOTVS Gateway Manager (TGM), basta informar os campos abaixo:
Atenção
As configurações dos serviços serão inseridas no arquivo "appServerList.json" onde o mesmo será lido ao subir o serviço do TGM, adicionando as informações dos Serviços de Proxy na configuração do TGM.
Ao instalar o TGM via instalador, ao final verificar se o serviço do TGM está online.
O serviço do TGM pode ser feita via RM.Host.ServiceManager, basta marcar o campo "Instalar TGM" e clicar no botão Instalar após informar o diretório onde o TGM foi instalado.
Atenção
Caso o serviço do TGM não inicie, verifique na documentação TGM Troubleshooting.
Descrição dos Campos:
- Instalar TGM: Opção para que o serviço do Totvs Gateway Manager seja instalado na maquina que está sendo utilizada.
- Caminho completo do arquivo: Caminho onde está instalado o executável do Totvs Gateway Manager.
- Portas de eonfiguração do TGM
- Porta de serviço: Porta onde o TGM irá realizar o serviço de configuração.
- Porta de resiliência: Porta onde o TGM irá realizar a resiliência do provider (NGINX).
- Portas de escuta do TGM
- Porta de WCF: Porta onde o TGM irá receber requisições TCP e redirecionar para os Hosts cadastrados para responder TCP.
- Porta de WebService: Porta onde o TGM irá receber requisições HTTP e redirecionar para os Hosts cadastrados para responder HTTP.
- Porta de WebApi: Porta para disponibilização do endpoint do serviço rest para configuração do TGM.
- Connect (s): Valor em segundos para aguardar a conexão com o Proxy.
- Time-out (s): Valor em segundos para aguardar a resposta da requisição.
- Utilizar TGM em outra maquina: Opção dada ao usuário para que o Totvs Gateway Manager seja instalado em outra maquina (informando Host:Porta).
Passo a passo para configuração do TGM (Totvs Gateway Manager):
- Acessar o aplicativo "RM.Host.ServiceManager.exe" e adicionar a quantidade de serviços desejada.
- Acessar a aba "Totvs Gateway Manager" e ,marcar a opção "Instalar TGM".
- Informe o caminho onde o TGM foi instalado anteriormente.
- Em seguida, clique para instalar o serviço do TGM em Operações no serviço TGM.
- Após realizada a instalação, configure as portas WebService e WebApi e clique em "Aplicar".
- Verifique que o TGM foi instalado corretamente, como mostra a imagem disponível abaixo:
Veja mais sobre a Configuração Plug and Play ou como configurar o TGM com Config Global
04.02 EM OUTRA MÁQUINA
Iremos apresentar como instalar o TGM em outra máquina.
Na instalação da Biblioteca o usuário poderá informar se usará o TGM, conforme parâmetro abaixo:
- Marcar a opção "Utilizar TGM em outra maquina" e preencher o campo com "Host:Porta" da maquina que será utilizada para a instalação do TGM.
- Alterar o arquivo "RM.exe.config", apontar as tags do host e porta para maquina que está sendo utilizada.
- Verifique que a comunicação é feita corretamente entre as maquinas (através dos hosts ativos).
05. LOG DE ERROS
Erros podem ocorrer no RM.Host ou no RM.Host.ServiceManager
TGM
O log do TGM está centralizado no EventViewer (Visualizador de Eventos) do Windows.
RM.Host / RM.Host.Service
Caso hajam erros nos serviços relacionados ao TGM no RM.Host, os mesmos serão apresentados no TraceFile.
obs.: é necessário habilitar a Tag Tracefile no config (https://tdn.totvs.com/display/LRM/Habilitar+Tag+Tracefile)
RM.Host.ServiceManager
Caso hajam erros nos serviços relacionados ao TGM no RM.Host.ServiceManager, os mesmos serão apresentados na tela.
Informações do Documento
Versionamento
Versão: v1.0
Versão: v1.1
Carlos Philippe de Farias Marques
Links Externos
[2] https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.2.0-windows-x64-installer
Informações Gerais do TGM
Informações do instalador
Nome: TOTVS Gateway Manager - {versao}.exe
Versão: 12.1.25+
Tamanho: ~ 4mb
Pré-requisitos
- ASP.NET Core 2.2.0
- .NET Core 2.2.0
- NODE.js (Publicação - somente desenvolvedores)
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas