Helm Chart API Boletos QaS

Informações e Pré-requisitos


Bem-vindo à página de informações do Helm Charts da API de Boletos QaS.

Aqui você encontrará tudo o que precisa saber para começar a utilizar esse Chart de forma eficiente.


Informações


  • Helm

    Certifique-se de que o Helm está instalado na sua máquina. Você pode baixá-lo e instalá-lo através do comando (snap install helm –classic). Após a instalação, digite (helm version) para conferir se a instalação foi bem sucedida.

  • Kubernetes

    Uma versão compatível do Kubernetes deve estar configurada e rodando. Consulte a documentação do Kubernetes.

  • Permissões

    As permissões adequadas para criar e gerenciar recursos no cluster Kubernetes. Caso seja necessário, entre em contato com a equipe de Infraestrutura.

  • Acesso à Internet

    Necessário para baixar imagens e dependências do Chart.

Pré-Requisitos


Para que a instalação desse Chart seja bem-sucedida, os pré-requisitos abaixo devem ser contemplados ANTES da instalação do chart.

  • Namespace

    Para fins de padronização utilizamos para o namespace sempre o nome da aplicação em si, mas, esse nome não precisa ser igual ao da aplicação necessariamente. Crie ou selecione um namespace coerente com a aplicação que será instalada.

  • Secret

    A api de boletos possui criptografia inclusive dentro da aplicação, portanto, é necessária a criação do secret apontando para o arquivo do certificado SSL. Aplicações Java usam certificados SSL em formato exclusivo .JKS. Esse arquivo pode ser fornecido pela equipe de Tecnologia de Negócios. É necessário copiar esse arquivo para dentro de qualquer pasta entre os nodes do Kubernetes e executar o comando kubectl create secret generic certificado-ov –from-file=certificado.jks. O Chart espera que o nome do secret seja certificado-ov. Você pode criar o secret com outro nome, mas terá de alterar o arquivo values do Helm para utilizar o nome do secret criado.

  • Database Storage

    O Chart instala como dependência o Postgres automaticamente, os dados encontram-se no armazenamento de blocos gerenciado pela OCI e montado exclusivamente no servidor zumbi-2 no endereço físico /mnt/Volumes-Block/postgres.

Instalação

Através de abordagem gráfica confortável

A partir de agora faremos a instalação de nosso chart através do Rancher. O Rancher é uma ferramenta OpenSource gráfica capaz de criar e gerenciar clusters Kubernetes de todas as espécies. Em nosso caso o Rancher é utilizado somente para o gerenciamento de clusters pré-existentes.

Siga os passos descritos abaixo para acessar o Rancher do TACC e instalar o Chart da API de Boletos no ambiente de Homologação.

1 – Acesse o Rancher clicando aqui, guarde o link em seus favoritos para acesso facilitado posterior. Utilize seu usuário e senha de costume.
Caso você não possua credencial e acredite que deveria possuir, entre em contato com a equipe de Infraestrutura e Segurança da TN para que possamos avaliar a sua necessidade.
2 – Na tela a seguir temos as listas dos clusters gerenciados pelo Rancher dos quais o seu usuário possui permissões. No nosso caso estamos visualizando apenas o cluster Zumbi onde rodam nossas aplicações em Homologação. Clique no cluster Zumbi.
3 – Ao clicar no cluster desejado você será direcionado para a página que contém as configurações do cluster. É importante ressaltar que se deve ter muito cuidado na operação dentro do Rancher pois ele consegue modificar o cluster e alguma modificação inadequada pode paralisar as operações. Para a instalação do Chart da API de Boletos, clique em Apps do lado esquerdo da tela.
4 – Ao clicar em Apps o menu se abrirá na opção Charts. Essa opção mostrará todos os Charts existentes por padrão no Rancher para a instalação de componentes adicionais. Filtre os Charts conforme a imagem abaixo para selecionar apenas os Charts do repositório referente ao ambiente de Homologação repo-qas.
5 – Mantenha apenas a caixinha repo-qas marcada para que possamos visualizar todos os Charts de Homologação. Clique no Chart correspondente à sua instalação. No nosso caso clicaremos em chart-boletos-homol.
6 – Ao clicar no Chart você verá a descrição da instalação e algumas informações adicionais sobre o Chart em questão. No canto superior direito clique no botão Install.
7 – Ao clicar em Install você precisará definir um nome amigável para identificar o deploy dentro do cluster. Em nosso exemplo concedemos o nome como api-boletos-qas, mas você pode nomear o deploy como preferir. Seja coerente com a nomenclatura para que a mesma expresse o sentido do que está sendo executado pelo deploy. Da mesma forma deve ser selecionado o namespace. Só aparecerão os namespaces do projeto do qual seu usuário possui permissionamento.
9 – Após selecionar o namespace e conceder um nome à aplicação, clique em Next no canto inferior direito da tela. Será exibida a tela para a manipulação do values do Chart que será instalado. Veja na imagem que todo o arquivo values está sendo exibido e pode ser manipulado nesta tela. Caso queira modificar algo do deploy original, esse é o momento certo.
10 – Após manipular o values, caso tenha havido a necessidade, clique em Install no canto inferior direito da tela. Ao clicar em Install você poderá ver o log em tempo real da tentativa de instalação. Perceba na parte em destaque da imagem que o Helm está aguardando o armazenamento antes de continuar levantando o restante dos recursos.
11 – Ainda dentro do log exemplificado no passo anterior teremos a informação de sucesso ou falha da instalação. Assim como manda a observação lógica, teremos: SUCESS para sucesso e qualquer informação de erro para informar a falha na instalação. Em caso de falha na instalação, o próprio erro informará o motivo.
Não é necessário se apegar à mensagem de saudação exibida no log após o sucesso da instalação. Essa saudação poderá ser alterada de tempos em tempos e não fornecerá informações cruciais para a utilização da aplicação deployada.

Através deste breve tutorial, aprendemos como instalar uma aplicação no Kubernetes através do Rancher utilizando o Helm. Esperamos que as explicações aqui oferecidas possam enriquecer o seu aprendizado e facilitar o seu trabalho no dia a dia.

Ótimo Trabalho e até a próxima!


Aprenda mais sobre o Helm acessando a documentação oficial.