Links

Conector Local - Instalação e Atualização

Passo a passo dos Procedimentos para Instalação do Conector

1. Pré-Instalação

1.1. Solicite as credenciais para uso do serviço

a. Credenciais para uso do RAP: i. Login; ii. Senha; iii. Client ID - ID que identifica unicamente cada instituição; iv. URL do ambiente de homologação. b. Credenciais para acesso ao registro de imagens privados do Serviço: i. Login; ii. Senha;

1.2. Cadastro e Configuração de Certificados Digitais

a. Envie os certificados com chave pública que serão utilizados no teste para RNP: i. Podem ser exportados a partir dos containers A1 (arquivo.pfx) ou A3 (token criptográfico) para o formato .cer via ferramenta RAPSign; ii. Caso ainda não tenha certificado, solicite à RNP certificados exemplares. Nesse caso, eles já serão cadastrados no sistema antes do envio; iii. Recomendamos o uso de pelo menos dois certificados para simular o processo. Um para simular a pessoa jurídica da instituição e outro para simular uma pessoa física;

1.3. Requisitos para Infraestrutura recomendada para instalação do Conector

Serão executados, nesse ambiente, um par de imagens Docker (uma com o conector e outra com o banco de dados) além de um volume para armazenar o banco. A configuração mínima é uma Máquina virtual básica com uma CPU e 2Gb de RAM. É recomendado 2 vCPU e 4 Gb de RAM para um processamento mais fluido.
Apesar do Docker virtualizar também para outros sistemas operacionais é fortemente recomendado que a imagem seja utilizada no Sistema Operacional Linux, mais especificamente nas distribuições Ubuntu ou Debian. Isso é necessário para evitar problemas de configurações que diferem de um sistema para outro, principalmente, configurações de rede.

1.4. Requisitos para instalação do Container

a. Para o deploy deste projeto, é necessário ter instalado algumas ferramentas de conteinerização: i. Para instalação do Docker Engine execute os seguintes comandos:
$ curl -fsSL https://get.docker.com -o get-docker.sh
$ sudo sh get-docker.sh
ii. Para instalação do Docker Compose execute os seguintes comandos:
$ sudo curl -L
"https://github.com/docker/compose/releases/download/1.25.3/docker-compose-
$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
$ sudo chmod +x /usr/local/bin/docker-compose

2. Instalação

2.1 Edite o arquivo docker-compose.api.yml**

a. Adicione as credenciais para acesso ao Serviço de Diplomas: i. Login (RAP_API_USER_EMAIL); ii. Senha (RAP_API_USER_PASS); iii. Client ID (INSTITUTION_ID). iv. *As variáveis de configuração do RAP Sign WEB também serão configuradas no mesmo arquivo docker-compose. Verifique manual próprio da aplicação
b. Realize login no registro privado de imagens do ambiente de homologação:
$ docker login https://homolog-diploma.rnp.br/
c. Execute o script do docker-compose para: i. Download da imagem atualizada do Conector; ii. Configuração automática do banco (criação e execução dos scripts para migração de tabelas); iii. Inicialização dos daemons de processamento de documentos e APIs de Comunicação;
$ docker-compose -f docker-compose.api.yml up
iv. Opcionalmente efetue logoff do serviço de registro de imagens;
$ docker logout https://homolog-diploma.rnp.br/
Obs.: Caso o conector na primeira execução apresentar problema de conexão com o banco, reinicie o mesmo.

Vídeo demonstrativo da Instalação e Configuração dos Componentes Locais:

Instalação e Configuração dos Componentes Locais (Conector).mp4
14MB
Binary
Vídeo - Instalação e Configuração
Homologação da Instalação Local.mp4
3MB
Binary
Video - Homologação da Instalação Local

3. Atualização do Conector

Para verificar a existência de atualizações no Conector deve-se executar o seguinte comando utilizando o docker-compose*:
$ docker login https://homolog-diploma.rnp.br/
$ docker-compose -f docker-compose.api.yml pull
$ docker logout https://homolog-diploma.rnp.br/
Caso exista a versão mais recente do Conector, esta será baixada automaticamente. Após isso, basta reiniciar os containers.
$ docker-compose -f docker-compose.api.yml restart
Vide Release Note do Conector Local.
3.1 Como localizar o log completo do conector.
Para localizar o log completo do conector deve-se executar o seguinte comando:
  • sudo docker cp <container_id>:/var/log

4. Documentação da API

Toda a comunicação entre o Sistema da Instituição e o Conector Local é feito via API de Comunicação.
A documentação da API de Comunicação pode ser acessada e testada em tempo real via swagger no próprio Conector Local na URL: http://<IP-DO-CONECTOR>:<PORTAS>/docs. A porta padrão para a API de comunicação e para acesso a documentação é a 80. Ela pode ser alterada no arquivo de configuração do docker-compose. Outra forma de acessar a documentação da API de Comunicação é a partir do arquivo openapi.json**
Esse arquivo pode ser renderizado em qualquer visualizador de documentação swagger, a exemplo do Swagger Editor. Além da documentação do Swagger, também é disponibilizada às instituições documentação para uso com o Postman:
Vide arquivo Conector API Environment.postman_environment.json**
Vide arquivo RAP Conector.postman_collection.json**
**Os arquivos referenciados são disponibilizados para as Instituições que aderiram ao Serviço e que estão em processo de implantação.