Implantação de APIs
Instruções
Para darmos inicio, na implantação de uma API primeiramente precisamos ter o Docker instalado, caso não tenha instalado para acessar o manual de instalação. Será utilizado o Putty e o WinSCP para gerenciar o Docker.
Putty: é um software para se conectar com servidores remotos através de protocolos de rede SSH
WinSCP: é um cliente de FTP, para Windows, utilizado para transferências de arquivos com protocolo de segurança SSL
SSH: é um protocolo de rede com criptografia para operação de serviços de rede
FTP: é um protocolo padrão independente de hardware sobre um modo de transferir arquivos.
SSL: é um protocolo que assegura que os dados transferidos entre um cliente e um servidor permaneçam privados.
Logar no WinSCP, inserindo suas credenciais, no host colocar o ip do servidor Linux, na porta devemos inserir a porta configurada, e inserir o usuário e senha
No WinSCP vamos acessar o diretório do docker e criar a pasta backend
Dentro do diretório backend, inserir a pasta config, disponível para baixar no link www.solus.inf.br/SolusUpdate/docker/config.rar
Criar o arquivo .env, no diretório /backend. Dentro do arquivo inserir a variável de ambiente COMPOSE_PROJECT_NAME=, podendo colocar o nome que desejar, exemplo 202208. Dessa forma podemos realizar a busca por containers de homologação ou produção. Esse arquivo tem como objetivo setar um nome para os containers, possibilitando realizar a busca por todos os containers que possuam o mesmo nome.
Comando para pesquisar pelo nome que foi inserido no arquivo;
docker ps -f name=202208
O arquivo solus.ini ficará dentro do diretório config, sendo necessário configurá-lo
Usuário/senha: Indicar a conexão do banco de dados
Server: Indicar o ip, porta e service_name do banco de dados
Algumas versões de Linux reconhecem a conexão do server apenas utilizando a string de conexão completa, podendo ser copiada do tns_names
Para baixar o docker-compose, acesse esse link. Devemos incluir no arquivo docker-compose, todas as API's que serão executadas. O arquivo deve ficar dentro do diretório backend.
Cada API possui sua pré-configuração no arquivo docker-compose baixado, sendo necessário alterar:
container_name: nome do container
image: colocar qual a versão da api será utilizada. Exemplo 2021.11
porta: cada api já possui sua porta padrão.
Por padrão, a Solus fornecerá o arquivo docker-compose pré-configurado com as API's. Tendo a necessidade de subir uma nova API que não está no arquivo docker-compose, será necessário incluí-la manualmente no arquivo. Para realizar essa inclusão, basta copiar uma API já existente dentro do arquivo e alterar o nome. No arquivo docker-compose.override ficará a porta da API.
No arquivo docker-compose.override ficará as portas das API's
Logar no Putty, inserindo no host o ip do servidor Linux, na porta devemos inserir a porta configurada e clicar em open.
Sempre acessar como root, caso não esteja logado como root, utilizar o comando “sudo su” e digitar a senha
Após logar, o usuário ficará como root, conforme a imagem abaixo
Navegar até o diretório onde foi criado o docker pelo comando abaixo:
cd /docker
Containers:
Para verificar quais estão em execução, utilize o comando: “docker ps”. Assim irá listar todos os containers que contenham as APIs. Para filtrar a busca pode-se usar o comando:
docker ps -f name=202208. Retornará todos os containers que possuem esse nome.
Podemos recuperar logs de execução de uma API, para verificar, executar o comando abaixo. O id do container é indicado na primeira coluna, pelo nome 'CONTAINER ID'
docker logs IdDoContainer
Dentro do diretório do docker, acessar o diretório onde esta a API através do caminho abaixo:
cd backend
Subir todas as APIs que estão dentro do docker-compose, (recomendado utilizar apenas se todas as APIs que estão no docker-compose não estiverem sendo executadas, ou no caso de parar todos os containers) utilizando o comando abaixo:
docker-compose up --build -d
Parar todas as APIs que estão no docker-compose, utilizamos o comando abaixo:
docker-compose stop
Iniciar apenas um único container(api) que está dentro do docker-compose utilizamos o comando abaixo:
docker-compose up --build -d ‘nomeDaApi’Parar a execução de apenas um container(api), utilizamos os comandos abaixo:
docker ps (para visualizar o id do container)
docker stop ‘IdDoContainer’As images para atualização ficam disponíveis no repositório Docker Registry UI
O padrão utilizado para identificar uma imagem gerada pela Qualidade segue o formato:
ano.versão (exemplo: 2025.02).
Para alteramos uma única API ou todas, seguir os passos.
Acessar o diretório backend, onde está o docker-compose das API's.
Alterando uma única API:
Listar os containers com o comando: 'docker ps', ou com o filtro name 'docker ps -f name=NomeDaApi', para encontrar o idContainer.
Parar o container da API e removê-lo, com o comando:
docker stop 'idContainer' && docker rm -f 'idContainer'
Segundo passo será remover a image, para listar as images utilizadas, usar o comando:
docker images -a | grep "VERSÃO"
Remover a image com o comando:
docker rmi 'idImage'
Agora subir a nova API com o comando:
docker-compose up --build -d ‘nomeDaApi’
Alterando todas as API's:
Parar todos os containers e removê-los, com o comando:
docker-compose stop && docker-compose rm -fRemover todas as images, nesse exemplo estamos removendo todas as images da versão 2020.11. Alterar a variável "VERSÃO" para a versão das API's utilizadas.
docker images -a | grep "VERSÃO" | awk '{print $3}' | xargs docker rmi -f
Agora subir todas as novas API's, com o comando:
docker-compose up --build -dApós atualização da API, é interessante realizar o reload do serviço nginx
docker ps | grepVerificar qual o id_container e executar o comando.
docker restart <id_container>
As APIs possuem seu cadastro no módulo ADM, podendo ser acessado pelo seguinte caminho ADM> configurações > cadastro de APIs.
Incluir na URL o IP do servidor que está rodando a API.
A partir da versão 02/2022 no cadastro de API's, possui a coluna Situação, permitindo Ativar ou Inativar a API.
Deixando a api como Inativo, o docker apresentará a mensagem "Api não localizada ativa na base de dados."
Verificar se a api está ativa, utilize a rota statusapi http://127.0.0.1:15212/v1/statusapi .Irá retornar a Versão, revisão e o modo de compilação Release ou Debug
Para saber as rotas que a api possui, acessar o Swagger da api, no exemplo abaixo é a api_beneficiario, substituir o ip ‘127.0.0.1’ pelo ip do servidor onde a API se encontra e sua porta:
http://127.0.0.1:15010/swagger/doc/html#/
No postman, substituir o ip pelo do servidor, e os parâmetros informando os que serão usados
