cadegovbr/apiprogramagestaosusep repository overview

⁠API de Envio de Planos de Trabalho do Programa de Gestão (CADE/ME)

Contêiner da API de Envio de Planos de Trabalho do Programa de Gestão (PGD). O Software tem como objetivo realizar o gerenciamento (envio/consulta) dos Planos de Trabalhos do Programa de Gestão (Projeto de Transformação Digital).

Observação: esta API foi desenvolvida com base no Sistema da SUSEP.

Sistema do Programa de Gestão - PG_ME_SUSEP⁠

Observação: é necessário criar as tables e views da API PGD. Favor, utilizar os scripts SQL abaixo:

Observação: é altamente recomendável criar um novo banco de dados para as tabelas API PGD (databaseName=APIPGD). As view são criadas na mesma estrutura do banco de dados do programa de gestão (databaseName=PGD). PGD é o nome do seu banco de dados do Programa de Gestão.

CREATE_TABLES_SQL_SERVER_SUSEP - PG_ME_SUSEP⁠

VIEWS_API_PGD_SUSEP - PG_ME_SUSEP⁠

Observação: é necessário verificar se as views da API PGD foram criadas no schema dbo.*.

DATABASE_SCHEMA_NAME: informar o nome do schema do banco de dados do programa de gestão. Para maiores detalhes, favor consultar a seção Parâmetros do contêiner.

APIPGDME_URL: informar a url de conexão com a API PGD ME sem /docs.

URL Homologação: http://hom.api.programadegestao.economia.gov.br/⁠

URL Produção: https://api-programadegestao.economia.gov.br/⁠

⁠Releases de versão da imagem

1.0: Versão inicial da aplicação

⁠Atualização de versão da imagem

Observação: caso deseje obter atualizações de novas versões da imagem, por gentileza, remova a imagem local e efetue um novo download diretamente do repositório:

docker pull cadegovbr/apiprogramagestaosusep

⁠Atualização de Segurança: Apache Log4j 2 CVE-2021-44228 vulnerability

⁠Update Dockerfile:

ADD standalone.sh with parameter -Dlog4j.formatMsgNoLookups=true

Fonte: Get the latest on Apache Log4j 2 CVE-2021-44228 vulnerability from Docker⁠

⁠Update Maven log4j2.version:

<properties>
    <log4j2.version>2.17.1</log4j2.version>
</properties>

Fonte: Log4J2 Vulnerability and Spring Boot⁠

⁠Passos Iniciais

As instruções a seguir são informações necessárias para a utilização de contêiners docker.

⁠Pré-requisitos

Para executar este contêiner, você precisará do docker instalado.

• Windows⁠
• OS X⁠
• Linux⁠

⁠Parâmetros do contêiner

Parâmetros disponíveis para o seu contêiner.

docker run -p 8080:8080 -p 9990:9990 -e WILDFLY_USERNAME="admin" -e WILDFLY_PASSWORD="4dm1n" \ 
-e DATABASE_APIPGD_USER="user" -e DATABASE_APIPGD_PASSWORD="passwd" -e DATABASE_APIPGD_URL="jdbc:sqlserver://host:1433;databaseName=APIPGD" \ 
-e DATABASE_PGD_USER="user" -e DATABASE_PGD_PASSWORD="passwd" -e DATABASE_PGD_URL="jdbc:sqlserver://host:1433;databaseName=PGD" \ 
-e DATABASE_SCHEMA_NAME="PGD" -e APIPGDME_URL="url" -e APIPGDME_AUTH_USER="user" -e APIPGDME_AUTH_PASSWORD="passwd" \
-e MAIL_RECIPIENTS_TO="[email protected],[email protected]" -e MAIL_RECIPIENTS_CC="[email protected],[email protected]" -e MAIL_HOST="smtp" -e MAIL_PORT="25" \
-e MAIL_USER="user" -e MAIL_PASSWORD="passwd" -e MAIL_SMTP_AUTH="true" -e MAIL_SMTP_STARTTLS_ENABLE="false" \ 
-e MAIL_SMTP_STARTTLS_REQUIRED="false" -e MAIL_SMTP_SSL_ENABLE="false" -e JAVA_OPTS="-Dlog4j.formatMsgNoLookups=true" -e TZ="America/Sao_Paulo" cadegovbr/apiprogramagestaosusep

⁠Variáveis de Ambiente

• WILDFLY_USERNAME - Usuário de administração do WildFly.
• WILDFLY_PASSWORD - Senha do Usuário de administração do WildFly.
• DATABASE_APIPGD_URL - URL para conexão com o banco de dados da API PGD.
• DATABASE_APIPGD_USER - Usuário do banco de dados da API PGD.
• DATABASE_APIPGD_PASSWORD - Senha do Usuário do banco de dados da API PGD.
• DATABASE_PGD_URL - URL para conexão com o banco de dados do PGD.
• DATABASE_SCHEMA_NAME - Nome do schema do banco de dados do PGD.
• DATABASE_PGD_USER - Usuário do banco de dados do PGD.
• DATABASE_PGD_PASSWORD - Senha do Usuário do banco de dados do PGD.
• APIPGDME_URL - Url de conexão com a API PGD ME.
• APIPGDME_AUTH_USER - Usuário de conexão com a API PGD ME.
• APIPGDME_AUTH_PASSWORD - Senha do Usuário de conexão com a API PGD ME.
• MAIL_RECIPIENTS_TO - E-mails dos destinatários que irão receber mensagens da API (for multiple recipients = [email protected]⁠,[email protected]⁠).
• MAIL_RECIPIENTS_CC (opcional) - E-mails dos destinatários (em cópia) que irão receber mensagens da API (for multiple recipients = [email protected]⁠,[email protected]⁠).
• MAIL_HOST - Endereço IP ou DNS do Host SMTP.
• MAIL_PORT - Porta do Host SMTP.
• MAIL_USER - E-mail do usuário.
• MAIL_PASSWORD - Senha de e-mail do usuário.
• MAIL_SMTP_AUTH - Flag indicando se há autenticação SMTP. ["true", "false"]
• MAIL_SMTP_STARTTLS_ENABLE - Flag indicando se há TLS habilitado no SMTP. ["true", "false"]
• MAIL_SMTP_STARTTLS_REQUIRED - Flag indicando se o SMTP requer TLS. ["true", "false"]
• MAIL_SMTP_SSL_ENABLE - Flag indicando se há SSL habilitado no SMTP. ["true", "false"]
• JAVA_OPTS: "-Dlog4j.formatMsgNoLookups=true"
• TZ - Timezone. Horário Brasileiro: "America/Sao_Paulo"

⁠Arquitetura da API de Envio de Planos de Trabalho do Programa de Gestão (PGD)

• SpringBoot 2.3.9.RELEASE
• JSF 2+

⁠Encontre-nos

• GitHub⁠
• Docker⁠

⁠Versionamento

Nós utilizamos o GitLab⁠ para versionamento.

⁠Autores

• Conselho Administrativo de Defesa Econômica - CADE - CADE⁠
• Ministério da Economia - ME - ME⁠

⁠Licença

Todos os softwares utilizados neste projeto possuem licença de código aberto.