Este documento objetiva detalhar processo de instalação da aplicação Portal Big Retail através do Docker.


Pré-requisitos


  • Acesso ao Registro de Contêineres Azure da Linx para ter acesso as imagens da aplicação
  • Docker (https://www.docker.com/) instalado no servidor onde será feito deploy da imagem da aplicação



Para conseguir dar prosseguimento no processo de configuração do Portal Big Retail é imprescindível que na maquina onde esse processo será executado tenha a aplicação Docker instalado, caso não tenha essa aplicação instalada na maquina acesse os seguintes documentos:


  • Após instalação do Docker, realizar processo da habilitação rede interna do Conteiner. 

    docker network create netlinx



Etapa 1 - Preparação ambiente para instalação da imagem da aplicação 


Esta etapa objetiva preparar um diretório no servidor onde será instalada e executada a imagem do Portal Big Retail.


Caso já tenha havido processo de preparação de ambiente para o servidor, os passos abaixo podem ser ignorados. Se as recomendações desta foram seguidas, basta verificar se existe diretório com nomenclatura containers-linx no diretório /home (caso, Linux) ou na unidade "C:", caso Windows.



Passo a PassoDetalhamento e exemplos

1 - Criação de diretório

Sugerimos a criação de um diretório exclusivo para receber a imagem da aplicação.

Dessa forma, sugerimos que seja criado diretório containers-linx, no /home (caso, sistema operacional linux) ou na unidade "c:", caso Windows.

Na coluna ao lado estão os exemplos de comandos a serem executados o sistema operacional linux



user@group /home: mkdir containers-linx


C:\: mkdir containers-linx



2 - Concessão de Permissões

Conceder permissão completa para diretório acima definido, a fim de habilitar as ações de leitura, escrita e execução da aplicação.

Na coluna ao lado está detalhado comando CHMOD.





user@group /home: chmod 777 -R containers-linx



Em geral, no sistema operacional Windows, esse tipo de permissão não é necessária. Todo caso, caso haja alguma restrição no processo de instalação, deve ser verificado com o administrador do sistema.



Etapa 2 - Download da Imagem do Portal Big Retail

Esta etapa objetiva explicar processo de download da release do Portal Big Retail que está disponível no RCA Azure Linx.


Para a sequencia dessa etapa é mandatório que usuário tenha o acesso mencionado na seção pré-requisitos.




Passo a PassoDetalhamento e exemplos


1- Iniciar um novo TERMINAL e executar comando para processo de autenticação no Azure.


docker login acrbigretail.azurecr.io


user@group /home/containers-linx: docker login acrbigretail.azurecr.io


C:\containers-linx : docker login acrbigretail.azurecr.io



2 - Realizar download da imagem da aplicação.

Neste passo, deve ser informada a versão do release desejado no formato XX.XX.XX.

No exemplo ao lado está sendo considerada a versão 02.11.00 do Portal Big Retail. Após execução do comando, download será iniciado.


user@group /home/containers-linx: docker pull acrbigretail.azurecr.io/portal-big-retail:XX.XX.XX
// substitua o XX.XX.XX pela numeração correta EX: 02.11.00


C:\containers-linx : docker pull acrbigretail.azurecr.io/portal-big-retail::XX.XX.XX
// substitua o XX.XX.XX pela numeração correta EX: 02.11.00


root@aa-VirtualBox:/home# docker pull acrbigretail.azurecr.io/portal-big-retail:3.3.0
3.3.0: Pulling from portal-big-retail
75f829a71a1c: Already exists
7b11f246b3d3: Already exists
b765648c2a58: Already exists
506aff4a9c5a: Already exists
b5b922707580: Already exists
d2bb040705ab: Pull complete
d805ec4d9dd7: Pull complete
42cbf59b928c: Pull complete
797a05ad3155: Pull complete
d48bd8701faf: Pull complete
887c49218327: Pull complete
1956f87a564b: Pull complete
a80382e3b72b: Pull complete
813a0eb45864: Pull complete
51bee593eaf0: Pull complete
6506e0465315: Pull complete
92b3c4968071: Pull complete
Digest: sha256:013aafbcd3ad244f79c105f301d70278d78123ef4dd94e54e2b3ea03b2bbcc58
Status: Downloaded newer image for acrbigretail.azurecr.io/portal-big-retail:3.3.0
acrbigretail.azurecr.io/portal-big-retail:3.3.0






Etapa 3 - Configurando o Container para Execução  


Nesse passo vamos detalhar processo de configuração para execução do container (Docker) contendo a aplicação do Portal Big Retail.

Principal objetivo é detalhar as instruções para prover as configurações necessárias para funcionamento da aplicação como:

  • Apontamentos e credenciais de banco de dados
  • Definições de tunning de memória da JVM
  • Configurações de volume externo ao contêiner onde haverá uma visibilidade para informações necessárias do cotidiano como: acesso aos logs e arquivos de configuração da aplicação.


Passo a PassoDetalhamento e exemplos


1- Criação de diretório para armazenar as configurações

Sugerimos a criação do diretório container-portal-big-retail, no /home/conatiner-linx (caso, sistema operacional linux) ou na unidade "c:/container-linx", (caso Windows).


Caso tenha sido escolhido um outro diretório na Etapa 01 deste documento, a instrução acima deve considerar este diretório como a raiz para criação do container-portal-big-retail.



user@group /home/containers-linx: mkdir container-portal-big-retail


C:\containers-linx : mkdir container-portal-big-retail



2 - Concessão de Permissões

Conceder permissão completa para diretório completo a fim de habilitar as ações de leitura, escrita e execução da aplicação.

Na coluna ao lado está detalhado comando CHMOD.








user@group /home/containers-linx: chmod 777 -R container-portal-big-retail


Em geral, no sistema operacional Windows, esse tipo de permissão não é necessária. Todo caso, caso haja alguma restrição no processo de instalação, deve ser verificado com o administrador do sistema.



3- Definir as configurações por linha de comando

Uma vez realizados os processos acima, deve ser executado comando abaixo para configuração da base de dados, necessário para funcionamento do Portal Big Retail.


docker run --name portal-big-retail-web -dit --network=netlinx --restart=unless-stopped  -p 8444:8443 -p 8080:8080 -p 4058:4058 -e DB_CONNINFO=<string conexao banco> -e DB_USER=<usuario banco> -e DB_PASS=<password usuario banco> -e DB_DRIVER=oracle -v /home/containers-linx/container-portal-big-retail:/opt/jboss/wildfly/standalone/data/portal-big-retail/ -v /home/containers-linx/container-portal-big-retail:/opt/jboss/wildfly/standalone/log/ acrbigretail.azurecr.io/portal-big-retail:<versao> 


Os itens marcados em vermelho precisam ser substituídos pelos valores definidos do ambiente onde o servidor será executado.

Abaixo uma tabela com o detalhamentos desses parâmetros:


PropriedadeDetalhamentoExemplo
string conexao bancoURL de conexão com banco de dados DB_CONNINFO=jdbc:oracle:thin:@10.155.229.31:1521/ora12c
usuario bancoUsuário de acesso ao banco de dados DB_USER=storex_storex
password usuario bancoSenha de acesso ao banco de dadosDB_PASS=aakqw@!
versaoVersão do Portal Big Retailacrbigretail.azurecr.io/portal-big-retail:3.3.0 


Adicionalmente, para uma melhor compreensão do comando, segue abaixo uma tabela com detalhamento das informações


PropriedadeDetalhamentoValor recomendado
--name

Nome da Contêiner que receberá imagem da aplicação.


linx-servidor-configuracao
--networkDefine nome da rede interna necessário para funcionamento do Containernetlinx
--restart

Define comportamento do Container para que seja iniciado juntamente com o Sistema Operacional.

Atenção: Feature exclusiva para LINUX. Para sistema operacional Windows, clique aqui.

unless-stopped
-p

Define as portas que serão utilizadas pela imagem da aplicação no formato <Porta 1><Porta 2>, onde:

<Porta 1> - Porta que será definida pelo cliente, como visível para acessar a aplicação no Contêiner.

<Porta 2> - Porta definida pela Linx que é usada pela imagem da aplicação internamente no Contêiner.

Atenção: A Porta 2 não PODE ser ser modificada, pois afetará funcionamento da aplicação.

-p 8444:8443 -p 8080:8080 -p 4058:4058
acrbigretail.azurecr.io/portal-big-retail:3.3.0 Informação da Imagem do Contêiner

:





user@group /home/containers-linx/container-portal-big-retail: docker run --name portal-big-retail-web -dit --network=netlinx --restart=unless-stopped  -p 8444:8443 -p 8080:8080 -p 4058:4058 -e DB_CONNINFO=<string conexao banco>-e DB_USER=<usuario banco> -e DB_PASS=<password usuario banco> -e DB_DRIVER=oracle -v /home/containers-linx/container-portal-big-retail:/opt/jboss/wildfly/standalone/data/portal-big-retail/ -v /home/containers-linx/container-portal-big-retail:/opt/jboss/wildfly/standalone/log/  acrbigretail.azurecr.io/portal-big-retail:<versao> 


C:\containers-linx\container-portal-big-retail: docker run --name portal-big-retail-web -dit --network=netlinx --restart=unless-stopped  -p 8444:8443 -p 8080:8080 -p 4058:4058 -e DB_CONNINFO=<string conexao banco>-e DB_USER=<usuario banco> -e DB_PASS=<password usuario banco> -e DB_DRIVER=oracle -v C:\containers-linx\container-portal-big-retail:/opt/jboss/wildfly/standalone/data/portal-big-retail/ -v C:\containers-linx\container-portal-big-retail:/opt/jboss/wildfly/standalone/log/ portal-big-retail:<versao>



Etapa 4 - Configuração para Inicialização Automática no Sistema Operacional Windows

Se faz necessário efetuar a configuração para o Start automático da aplicação, essa configuração é extremamente importante para que não haja necessidade de toda a vez em que a maquina onde esta o contêiner for iniciada seja preciso executar manualmente os comandos citados.


Passo a passoDetalhamento e exemplos
1- No menu Iniciar do Windows efetue a busca por Windows Administrative Tools

2- Será aberta a tela de Administrative Tools. Na sequencia, selecionar a opção Task Scheduler

3- Na tela do Task Sheduler, clicar no menu Task Scheduler (Local) no canto esquerdo da tela.

4- Expandir a seleção até que seja exibido diretório Microsoft.

5- Clicar com botão direito na pasta Microsoft e selecione New Folder.

6- Será aberta uma caixa de diálogo. Informar nome desejado e depois confirmar pelo botão 'OK'

No nosso exemplo consideramos nome DOCKER


7 - Seleciona diretório criado anteriormente, clicar com botão direto e selecionar opção CREATE TASK.

Na aba General (Geral), definir o nome da Task e marque as mesmas opções da imagem ao lado.

  • Run whether user logged on or not (Executar estando o usuário conectado ou não)
  • Run with highest privileges (Executar com privilégios mais altos)

No campo Configure for (Configurar para), selecionar a opção de Sistema Operacional igual a da maquina servidora.

EX: se a maquina onde esse processo esta sendo executado é Windows 10 selecione Windows 10

8- Ainda na mesma tela, proceder passos abaixo.

Na aba Triggers (Disparadores) clicar no botão NEW (NOVO). Será aberta uma nova tela. No campo Bigin the Tesk (Iniciar a Tarefa) selecione a opção At log on (Ao inicializar)

  • Marque o check box Delay task for (Atrasar a tarefa em) informe 1 minuto
  • Clique no botão OK

11- Na aba Actions (Ações) clique no botão NEW (NOVO)

  • Será aberta uma nova tela, clique no botão Browser (Pesquisar) 
  • Busque o .exe responsável por iniciar o docker (esse processo foi descrito no pré-requisito)
  • Ao terminar o preenchimento clique no botão OK

12- Ao termino desse processo clique no botão de OK presente na tela de Create Task, assim que clicar em ok será solicitada a senha de usuário administrador