Templates de Projetos

Introdução

Para manter um padrão e um nível mínimo de qualidade temos requisitos mínimos que um projeto deve seguir. Todos os padrões abaixo são de uso obrigatório.

Frontend

Neste documento temos padrões de frontend para garantir o mínimo de UX para nossos usuários.

Backend

Docker

Todas as nossas aplicações devem rodar em docker, inclusive no ambiente de desenvolvimento. Isso garante que não haverá divergências na execução local e no servidor de publicação.

APM

Para ter toda a rastreabilidade que um APM pode oferecer precisamos colocar nossas aplicações em nosso APM.

É importante que o padrão de nomenclatura do serviço seja Nome Do Servico para aplicações comuns e Nome Do Servico Api para APIs, o nome pode conter espaços mas evite acentos ou símbolos.

NOTA: Para ver a documentação do agente para sua linguagem consulte a documentação oficial do elastic. Caso a linguagem seja C# utilize nossa biblioteca com todas as configurações prontas.

Consentimento de Cookies

Para atender algumas normas da LGPD precisamos ter em todos os nossos sistemas a popup de consentimento de cookies.

Autenticação e Autorização

Todas as aplicações devem possuir autenticação e autorização, seja ela pelo Sauron ou gov.br

Autorização de APIs

Todas as APIs devem estar cadastradas em nosso API Management para garantir segurança e integração.

Análise de Acesso

Para que todos os sistemas possuam dados analíticos de acessos precisamos configurar nossas aplicações no sistema de análise.

Health Check

Health Checks são mecanismos de validação, para identificar uma instabilidade ou inoperação de um determinado sistema ou ferramenta. Normalmente funcionais a partir de um endpoint HTTP, que retornam um resultado entre Healthy (operante), Degrated (Degradado) ou Unhealthy (inoperante). Em resumo, um middleware fornecido através de um endpoint para comunicação do estado atual da aplicação. Usamos o health check atualmente para auxílio no orquestrador de contêiners, load balancer, API management entre outros.

A implementação pode ser simples, ficando a cargo da necessidade incrementar os dados usados para verificação de integridade.

É importante que a rota padrão do health check seja /health

Documentação de APIs

Para que todas as APIs possuam uma documentação padrão precisamos documentá-las.

Openshift (apenas em projetos .NET)

Para que um projeto .NET funcione no Openshift é necessário algumas configurações.

E-mail (caso possua)

Para envio de e-mail deve ser usado o Hermes, nosso serviço de e-mails. Ele é disponibilizado por meio de API ou biblioteca (.NET).

PDF (caso possua)

Para geração de PDFs deve ser usado o PDFacil, nosso serviço de PDFs. Ele é disponibilizado por meio de API. Em casos de projetos com PDFs de grande conteúdo, o desuso dessa API pode ser desconsiderado mas deve ser alinhado com a liderança técnica.

Armazenamento de Arquivos (caso possua)

Para o armazenamento de arquivos deve ser usado o CEPH Storage. A solicitação de um bucket deve ser atráves de chamado no GLPI.