Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

ÍNDICE

  1. Visão Geral
  2. Pré-Requisitos
  3. Ambiente sem TGM
  4. Instalando o TGM (Máquina Local)
  5. Instalando o TGM (Outra Máquina)


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. PRÉ-REQUISITOS

Serão listados abaixo a lista de pré-requisitos para o correto funcionamento do TGM, são eles:


Totvs custom tabs box
tabsAsp.Net Core,.Net Core,Node.js
ids1,2,3
Totvs custom tabs box items
defaultyes
referencia1
Painel
borderColor#ddd
borderStylesolid
titleASP.NET CORE 2.2.0

Informações de Download


Site: Acesse o site https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.2.0-windows-x64-asp.net-core-runtime-installer. [1]


Passo a Passo de Instalação


Espere o download e execute o arquivo de instalação.

Marque a opção "I agree to the license terms and conditions".

Clique em Install.

Aguarde a instalação do Asp.Net Core 2.2.0.

Clique em close.

Totvs custom tabs box items
defaultno
referencia2
Painel
borderColor#ddd
borderStylesolid
title.NET CORE 2.2.0

Informações de Download


Site: https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.2.0-windows-x64-installer[2]


Passo a Passo da Instalação


Espere o download e execute o arquivo de instalação.

Clique em Install.

Espere o término da instalação do .NET CORE 2.2.0

Clique em Close

Totvs custom tabs box items
defaultno
referencia3
Painel
borderColor#ddd
borderStylesolid
titleNode.js (OPCIONAL - Destinado a publicação da solução - Somente para desenvolvedores)

Informações de Download


Site: https://nodejs.org/en/[3]


Passo a Passo da Instalação


Escolha a opção 10.16.0 LTS.

Espere o download e execute o arquivo de instalação.

Espere as contagens e diagnósticos iniciais do sistema.

Clique em "Next".

Marque a opção "I accept the terms  in the License Agreement".

Clique em "Next".

Escolha uma pasta de destino da instalação.

Ignore as configurações da pagina abaixo e clique em "Next", serão instalados as funcionalidades padrões do Node.js.

Clique em Install.

Espere a instalação do Node.js.

Clique em Finish


03. AMBIENTE SEM TGM

Um ambiente sem o TGM compreende apenas

  • Balanceamento nativo,
  • Sessões confiáveis


Exemplo de como configurar um ambiente sem TGM

  • Acessar o aplicativo "RM.Host.ServiceManager.exe" e adicionar a quantidade de serviços desejada.

Descrição das Colunas

  • Porta de WCF: Porta WCF do RM
  • Porta de WebService: Porta HTTP para utilização nos WebServices RM (por exemplo, TBC).
  • Porta de WebApi: Porta HTTP para utilização no Web API RM, Serviços Rest.


  • Em seguida será necessário a configuração do arquivo "RM.exe.Config", configurando todos os hosts e portas adicionadas no "RM.Host.ServiceManager.exe", para que haja o balanceamento nativo (distribuição das requisições entre os hosts). 

04. INSTALANDO O TGM (MÁQUINA LOCAL)

Iremos apresentar como instalar o TGM.


Totvs custom tabs box
tabsInstalador do TGM,RM.Host.ServiceManager.exe
ids4,5
Totvs custom tabs box items
defaultyes
referencia4

E contará com o instalador do A instalação do TGM pode ser feita via TOTVS Gateway Manager (TGM)que terá um instalador exclusivo onde o usuário irá informar , basta informar os campos abaixo:


Informações
titleAtençã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.

Totvs custom tabs box items
defaultno
referencia5

Na sub pasta TOTVS Gateway Manager A instalação do TGM  pode ser feita via RM.Host.ServiceManager, basta marcar o campo "Instalar TGM" virá marcadoe clicar no botão Instalar.



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.
  • Porta de WCF: Porta para disponibilização do endpoint do serviço rest para configuração do TGM.
  • 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 onde o TGM irá receber requisições TCP e redirecionar para os Hosts cadastrados para responder TCP.
  • Porta de PING:Porta onde o TGM irá realizar a resiliência do NGINX.
  • 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):

  1. Acessar o aplicativo "RM.Host.ServiceManager.exe" e adicionar a quantidade de serviços desejada.
  2. Acessar a aba "Totvs Gateway Manager" e ,marcar a opção "Instalar TGM". 
  3. Em seguida, clique para instalar  nas operações do serviço TGM.
  4. Após realizada a instalação, configure as portas WebService e WebApi e clique em "Aplicar".
  5. Verifique que o TGM foi instalado corretamente, como mostra a imagem disponível abaixo:


05. INSTALANDO O TGM (EM OUTRA MÁQUINA)

Iremos apresentar como instalar o TGM em outra máquina.


Totvs custom tabs box
tabsInstalador da Biblioteca RM,RM.Host.ServiceManager.exe
ids6,7
Totvs custom tabs box items
defaultyes
referencia6

Na instalação da Biblioteca o usuário poderá informar se usará o TGM, conforme parâmetro abaixo: 


Aviso
iconfalse

É necessário que seja feita a alteração no arquivo "RM.exe.config" quando utilizado o TGM em outra máquina (Alterar os tags "Port" e "Host").

Totvs custom tabs box items
defaultno
referencia7
  1. 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.
  2. Alterar o arquivo "RM.exe.config", apontar as tags do host e porta para maquina que está sendo utilizada.
  3. Verifique que a comunicação é feita corretamente entre as maquinas (através dos hosts ativos).

Aviso
iconfalse

É necessário que seja feita a alteração no arquivo "RM.exe.config" quando utilizado o TGM em outra máquina (Alterar os tags "Port" e "Host").

Aviso
iconfalse

Caso a sua empresa possua firewall e/ou restrições de acesso à internet, é necessário que o administrador da rede libere o acesso às portas configuradas.

Painel
borderColor#ddd
borderWidth1
borderStylesolid
titleInformações do Documento

Versionamento


Versão: v1.0

Karina Dos Santos Costa

Versão: v1.1

Carlos Philippe de Farias Marques


Links Externos


[1] https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.2.0-windows-x64-asp.net-core-runtime-installer

[2] https://dotnet.microsoft.com/download/thank-you/dotnet-runtime-2.2.0-windows-x64-installer

[3] https://nodejs.org/en/.

Painel
borderColor#ddd
borderWidth1
borderStylesolid
titleInformaçõ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)