Commit 20cd7fb43595ff24e8baae854b933f30a1fd0084
1 parent
50281eb9
Exists in
master
and in
1 other branch
Documenta dependência com o security-domain
- Lista as informações referentes ao security-domain necessário para funcionamento do broker. - Adiciona o diagrama de implantação.
Showing
2 changed files
with
17 additions
and
6 deletions
Show diff stats
README.md
| ... | ... | @@ -3,15 +3,16 @@ O SEI-Broker é uma camada de integração que foi desenvolvida para integrar os |
| 3 | 3 | |
| 4 | 4 | O Broker atualmente está na versão 2.9, essa versão é compatível com o SEI 3.0.13. É importante destacar que é necessário atualizar o SEI-Broker a cada atualização do SEI que altere os serviços web. |
| 5 | 5 | |
| 6 | -Alguns serviços adicionais foram desenvolvidos extrair dados que não são ofertados pelos serviços nativos do SEI, estes serviços fazem acesso a base de dados do SEI e realizam operações apenas de consulta. A escrita de dados continua a ser exclusividade dos serviços nativos, desta forma a integridade e coerência das inserções é mantida. | |
| 6 | +Alguns serviços adicionais foram desenvolvidos para extrair dados que não são ofertados pelos serviços nativos do SEI, estes serviços fazem acesso a base de dados do SEI e realizam operações apenas de consulta. A escrita de dados continua a ser exclusividade dos serviços nativos, desta forma a integridade e coerência das inserções é mantida. | |
| 7 | 7 | |
| 8 | 8 | ## Requisitos |
| 9 | 9 | - SEI 3.0.13 instalado/atualizado. |
| 10 | 10 | - Código-fonte do Broker pode ser baixado a partir do link a seguir, sempre utilize uma versão compatível com o SEI: [https://softwarepublico.gov.br/gitlab/ans/sei-broker/tags](https://softwarepublico.gov.br/gitlab/ans/sei-broker/tags "Clique e acesse") |
| 11 | -- Apache Maven para baixar as dependências e compilar o pacote. | |
| 12 | -- Servidor JBoss EAP 7.0.4 ou Wildfly 10. | |
| 11 | +- [Apache Maven](https://maven.apache.org/) para baixar as dependências e compilar o pacote. | |
| 12 | +- Servidor [JBoss EAP 7.0.4](https://developers.redhat.com/products/eap/download/) ou [Wildfly 10](http://wildfly.org/downloads/). | |
| 13 | 13 | - Banco relacional, o Broker foi desenvolvido usando Oracle 12g, mas com pouco esforço pode utilizar o MySQL. |
| 14 | 14 | - Conexão com a internet para que o Maven acesse os repositórios hospedeiros das dependências. |
| 15 | +- [Templates-broker](https://softwarepublico.gov.br/gitlab/ans/templates-broker) implantado e configurado. Este requisito é **opcional**, ele é necessário caso haja interesse em utilizar o [Gerenciador de Templates](https://softwarepublico.gov.br/gitlab/ans/templates-web). | |
| 15 | 16 | |
| 16 | 17 | ## Procedimentos para instalação |
| 17 | 18 | ### 1 - Configure as propriedades dos datasources no JBoss, elas são declaradas como System Properties. |
| ... | ... | @@ -39,7 +40,8 @@ Abaixo um exemplo de declaração de propriedades feita no arquivo `standalone.x |
| 39 | 40 | </system-properties> |
| 40 | 41 | ``` |
| 41 | 42 | |
| 42 | -### 2 - Arquivos de propriedades | |
| 43 | +### 2 - Criar e configurar os arquivos de propriedades no JBoss | |
| 44 | + | |
| 43 | 45 | O SEI-Broker faz uso de dois arquivos de propriedades que ficam na pasta `<JBOSS_HOME>\ans\properties`, os arquivos necessários são `services.properties` e `ws-users.properties`. |
| 44 | 46 | |
| 45 | 47 | <table> |
| ... | ... | @@ -62,7 +64,7 @@ O SEI-Broker faz uso de dois arquivos de propriedades que ficam na pasta `<JBOSS |
| 62 | 64 | <td>URL do templates-broker</td> |
| 63 | 65 | </tr> |
| 64 | 66 | <tr> |
| 65 | - <td rowspan="2">ws-users-properties</td> | |
| 67 | + <td rowspan="2">ws-users.properties</td> | |
| 66 | 68 | <td>sei.broker.user</td> |
| 67 | 69 | <td>Usuário de integração do broker</td> |
| 68 | 70 | </tr> |
| ... | ... | @@ -70,4 +72,13 @@ O SEI-Broker faz uso de dois arquivos de propriedades que ficam na pasta `<JBOSS |
| 70 | 72 | <td>sei.broker.password</td> |
| 71 | 73 | <td>Senha do usuário de integração</td> |
| 72 | 74 | </tr> |
| 73 | -</table> | |
| 74 | 75 | \ No newline at end of file |
| 76 | +</table> | |
| 77 | + | |
| 78 | +### 3 - Criar security-domain no JBoss | |
| 79 | + | |
| 80 | +É necessário que haja um security-domain registrado com o nome `ans-ws-auth`, o mesmo pode utilizar um banco de dados[^1] ou o LDAP. É importante destacar que o Broker trabalha com autorização baseada em papéis(RBAC[^2]) e que os usuários precisam ter seus papéis atribuídos. | |
| 81 | +[^1]: https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html/how_to_configure_identity_management/configuring_a_security_domain_to_use_a_database | |
| 82 | +[^2]: https://en.wikipedia.org/wiki/Role-based_access_control | |
| 83 | + | |
| 84 | +## Diagrama de implantação | |
| 85 | +[Diagrama de implantação](uploads/SEI-Broker-Diagrama-Implantacao.png) | |
| 75 | 86 | \ No newline at end of file | ... | ... |
104 KB