Linha RM

Atalhos

Páginas filhas
  • TGM com Config Global

Versões comparadas

Versão antiga 1

changes.mady.by.user Stella Gleyse Macedo Vilaca

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Guilherme Caram Meireles

Gravado em

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)
  6. Vantagens e Possibilidades do TGM
  7. Logs
  8. Exemplo de utilização


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:

...

tabsAsp.Net Core,.Net Core,Node.js
ids1,2,3

...

defaultyes
referencia1

...

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.

Image Removed

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

Clique em Install.

Image Removed

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

Image Removed

Clique em close.

Image Removed

...

defaultno
referencia2

...

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.

Image Removed

Clique em Install.

Image Removed

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

Image Removed

Clique em Close

Image Removed

...

defaultno
referencia3

...

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.

Image Removed

Espere as contagens e diagnósticos iniciais do sistema.

Image Removed

Clique em "Next".

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

Clique em "Next".

Image Removed

Escolha uma pasta de destino da instalação.

Image Removed

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

Image Removed

Clique em Install.

Image Removed

Espere a instalação do Node.js.

Image Removed

Clique em Finish

Image Removed

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

...

Aviso
titleAtenção

Caso o serviço do TGM não inicie, verifique na documentação TGM Troubleshooting.

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). 
Image Removed
04. INSTALANDO O TGM (MÁQUINA LOCAL)
Abaixo iremos apresentar como instalar o TGM.

...

tabsInstalador do TGM,RM.Host.ServiceManager.exe
ids4,5

...

defaultyes
referencia4

A instalação do TGM pode ser feita via TOTVS Gateway Manager (TGM), basta informar os campos abaixo:

Image Removed

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.

...

Image Removed

...

defaultno
referencia5

A instalação do TGM  pode ser feita via RM.Host.ServiceManager, basta marcar o campo "Instalar TGM" e clicar no botão Instalar.

Image Removed

Descrição dos Campos:

...

  • Caminho completo do arquivo: Caminho onde está instalado o executável do Totvs Gateway Manager.

...

  • 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).

...

  • 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.
  • 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.

...

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:

Image Removed

pode ser utilizado com o arquivo de configuração global. Para entender mais sobre esse formato e funcionamento da configuração, acesse Novo Config Global - formato .json 

Veja nos próximos tópicos como ficam os principais arquivos de configuração global para utilizar o TGM.


02. EXEMPLO DE UTILIZAÇÃO

Abaixo estão os principais pontos que devem ser alterados após configurar o Novo Config Global - formato .json para ser utilizado com o TGM.

1) Para utilizar essa configuração é necessário ter o arquivo de configuração global (Global.config.json) dentro da pasta do TGM. 


2) Nos arquivos de configuração do Host (service ou .exe) e RM, de cada estação, dentro de <appSettings>:

       • A tag CONFIGGLOBALADDRESS deve apontar para o endpoint do TGM, no seguinte padrão: "http://NomeServer:8040/api/globalconfig", onde o NomeServer deve ser preenchido com o nome do servidor do TGM e a porta deve ser a porta do serviço do TGM.

Onde localizar a porta de configuração:

Image Added

      Exemplos dos arquivos de configuração:

View file
nameRM.Host.Service.exe.config
height150
 
View file
nameRM.exe.config
height150
View file
nameRM.AliasManager.exe.config
height150
View file
nameGlobal.config.json
height150

API para consulta de algum AppKey do config global com TGM: http://servidor:porta/api/globalconfig/appconfig/AppKeyNome.

Onde o servidor e a porta são do serviço do TGM e o AppKeyNome deve ser o nome da chave dada no Config Global.  Exemplo: http://bhd050101853:8040/api/globalconfig/appconfig/RM_TGM


Para mais informações sobre o TGM, como funcionamento, configuração, log de erros e outros, consulte: TOTVS Gateway Manager (TGM

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

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

...

tabsInstalador da Biblioteca RM,RM.Host.ServiceManager.exe
ids6,7

...

defaultyes
referencia6

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

Image Removed

...

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).

Image Removed

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.

06. 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.

Image Removed

07. LOG DE ERROS

      

      Erros podem ocorrer no RM.Host ou no RM.Host.ServiceManager

...

tabsTGM,RM.Host/RM.Host.Service,RM.Host.ServiceManager
ids8,9,10

...

defaultyes
referencia8

...

borderColor#ddd
borderStylesolid
titleTGM

O log do TGM está centralizado no EventViewer (Visualizador de Eventos) do Windows.

Image Removed

...

defaultno
referencia9

...

borderColor#ddd
borderStylesolid
titleRM.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)

Image Removed

...

defaultno
referencia10

...

borderColor#ddd
borderStylesolid
titleRM.Host.ServiceManager

Caso hajam erros nos serviços relacionados ao TGM no RM.Host.ServiceManager, os mesmos serão apresentados na tela.

...

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/.

...

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

...

)