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.

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.
andre.guimaraes
1 parent 50281eb9
Showing 2 changed files with 17 additions and 6 deletions Show diff stats
README.md
uploads/SEI-Broker-Diagrama-Implantacao.png
@@ -3,15 +3,16 @@ O SEI-Broker é uma camada de integração que foi desenvolvida para integrar os
 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.
-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.
+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.
 ## Requisitos
 - SEI 3.0.13 instalado/atualizado.
 - 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")
-- Apache Maven para baixar as dependências e compilar o pacote.
-- Servidor JBoss EAP 7.0.4 ou Wildfly 10.
+- [Apache Maven](https://maven.apache.org/) para baixar as dependências e compilar o pacote.
+- Servidor [JBoss EAP 7.0.4](https://developers.redhat.com/products/eap/download/) ou [Wildfly 10](http://wildfly.org/downloads/).
 - Banco relacional, o Broker foi desenvolvido usando Oracle 12g, mas com pouco esforço pode utilizar o MySQL.
 - Conexão com a internet para que o Maven acesse os repositórios hospedeiros das dependências.
+- [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).
 ## Procedimentos para instalação
 ### 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
 </system-properties>
 ```
-### 2 - Arquivos de propriedades
+### 2 - Criar e configurar os arquivos de propriedades no JBoss
+
 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`.
 <table>
@@ -62,7 +64,7 @@ O SEI-Broker faz uso de dois arquivos de propriedades que ficam na pasta `&lt;JBOSS
     <td>URL do templates-broker</td>
   </tr>
   <tr>
-    <td rowspan="2">ws-users-properties</td>
+    <td rowspan="2">ws-users.properties</td>
     <td>sei.broker.user</td>
     <td>Usuário de integração do broker</td>
   </tr>
@@ -70,4 +72,13 @@ O SEI-Broker faz uso de dois arquivos de propriedades que ficam na pasta `&lt;JBOSS
     <td>sei.broker.password</td>
     <td>Senha do usuário de integração</td>
   </tr>
-</table>
 \ No newline at end of file
+</table>
+
+### 3 - Criar security-domain no JBoss
+
+É 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.
+[^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
+[^2]: https://en.wikipedia.org/wiki/Role-based_access_control
+
+## Diagrama de implantação
+[Diagrama de implantação](uploads/SEI-Broker-Diagrama-Implantacao.png)
 \ No newline at end of file