Diversas melhorias e atualizaçÕes no README

Guto Carvalho
1 parent 420d6af3
Showing 1 changed file with 75 additions and 31 deletions Show diff stats
README.md
@@ -15,12 +15,14 @@ Módulo Puppet SEI AIO (All-in-One).
 9. [Setup](#setup)
 10. [Acesso](#acesso)
 11. [Pendente](#pendente)
-8. [Referencias](#referencias)
+8. [Referências](#referencias)
 ## Sobre
 Este módulo puppet foi desenvolvimento com o objetivo de facilitar a instalação do SEI em ambiente virtualizado para fins de teste, treinamento ou mesmo para produção em pequenos ambientes.
+Para usar este módulo é necessário ter acesso ao código fonte do SEI préviamente.
+
 ## Autores
 Desenvolvedores e criadores do módulo
@@ -33,7 +35,6 @@ Desenvolvedores e criadores do módulo
 Profissionais que deram apoio na revisão e testes do módulo
   * Thiago Ferreira
-  * Jeimerson Chaves
 ## Coordenadores
@@ -208,6 +209,11 @@ Do código fonte
   * Cria diretório e configura indices "publicacao"
   * Executa script para criação de indices no solrd
+#### classe seiaio::seiconf
+
+  * Criação dinâmica do arquivo ConfiguracaoSEI.php
+  * Criação dinâmica do arquivo ConfiguracaoSip.php
+
 ## Uso das classes
 ### classe principal
@@ -224,10 +230,10 @@ Neste módulo temos uma classe pública, basta chamá-la que o sei será instala
     sei_mysql_pass     => 'mA8357mHmsJszBl',
     sip_mysql_pass     => 'mA8357mHmsJszBl',
     mysql_ipaddr       => 'localhost',
-    dominio            => 'sei.funai.gov.br',
+    dominio            => 'sei.organizacao.gov.br',
     git_repo           => 'git@bitbucket.org:instruct/seiaio.git',
-    sigla_organizacao  => 'FUNAI',
-    nome_organizacao   => 'Fundacao Nacional do Indio',
+    sigla_organizacao  => 'ORG',
+    nome_organizacao   => 'Organizacao Federal',
 }
 ```
 ### classes privadas
@@ -238,8 +244,8 @@ As classes privadas normalmente não são chamadas diretamente, a classe princip
 ```puppet
 class { 'seiaio::seifontes':
-  docroot      => 'git@bitbucket.org:instruct/seiaio.git',
-  sei_git_repo => $git_repo,
+  docroot      => '/var/www/html/appsei',
+  sei_git_repo => 'git@bitbucket.org:instruct/seiaio.git',
 }
 ```
@@ -247,11 +253,11 @@ class { &#39;seiaio::seifontes&#39;:
 ```puppet
  class { 'seiaio::httpd':
-   docroot  => $docroot,
-   owner    => $owner,
-   group    => $group,
-   dominio  => $dominio,
-   seidados => $diretorio_seidados,
+   docroot  => '/var/www/html/appsei',
+   owner    => 'apache',
+   group    => 'apache',
+   dominio  => 'sei.dominio.gov.br',
+   seidados => '/var/www/seidados',
  }
 ```
@@ -259,13 +265,13 @@ class { &#39;seiaio::seifontes&#39;:
 ```puppet
 class { 'seiaio::database':
-  root_mysql        => $root_mysql,
-  sei_mysql_pass    => $sei_mysql_pass,
-  sip_mysql_pass    => $sip_mysql_pass,
-  dominio           => $dominio,
-  mysql_ipaddr      => $mysql_ipaddr,
-  sigla_organizacao => $sigla_organizacao,
-  nome_organizacao  => $nome_organizacao,
+  root_mysql        => 'senha',
+  sei_mysql_pass    => 'senha',
+  sip_mysql_pass    => 'senha',
+  dominio           => 'sei.dominio.gov.br',
+  mysql_ipaddr      => 'ip',
+  sigla_organizacao => 'ORG',
+  nome_organizacao  => 'ORGANIZACAO',
 }
 ```
@@ -285,7 +291,7 @@ class { &#39;seiaio::database&#39;:
 ```puppet
 class { 'seiaio::php':
-  docroot => '/var/www/html/seiapp',
+  docroot => '/var/www/html/appsei',
 }
 ```  
@@ -299,12 +305,33 @@ class { &#39;seiaio::cron&#39;:
 #### delcarando classe sei::solr (classe privada) 
-    include seiaio::solr
+```puppet
+class { 'seiaio::solr':
+  dominio => 'sei.organizacao.gov.br',
+}
+```
 #### delcarando classe sei::jodc (classe privada)
     include seiaio::jodc
+#### delcarando classe sei::seiconf (classe privada)
+  
+ ```puppet 
+ class { 'seiaio::seiconf':
+   docroot           => '/var/www/html/appsei',
+   owner             => 'apache',
+   group             => 'apache',
+   dominio           => 'sei.organizacao.gov.br',
+   seidados          => '/var/www/seidados',
+   mysql_ipaddr      => '127.0.0.1',
+   sei_mysql_pass    => 'senha',
+   sip_mysql_pass    => 'senha',
+   sigla_organizacao => 'GOV',
+   nome_organizacao  => 'Organizacao',
+ }
+ ```
+
 ## Git
 O código do sei tem que estar em um repositório GIT com a seguinte estrutura na raiz do repositório:
@@ -320,9 +347,9 @@ Se a estrutura não for essa, o módulo não irá funcionar.
 ## Setup
-Em seu CentOS 7 instale o repositório do puppet
+Em seu CentOS 6 instale o repositório do puppet
-    # yum install http://yum.puppetlabs.com/el/7/PC1/x86_64/puppetlabs-release-pc1-0.9.2-1.el7.noarch.rpm -y
+    # yum install http://yum.puppetlabs.com/el/6/PC1/x86_64/puppetlabs-release-pc1-0.9.2-1.el6.noarch.rpm -y
 Depois instale o puppet
@@ -331,9 +358,16 @@ Depois instale o puppet
 Você precisa instalar o módulo no diretório de módulos.
     # cd /etc/puppetlabs/code/environment/production/modules
-    # git clone https://bitbucket.org/culturagovbr/puppet-sei-aio.git seiaio    
+    # git clone https://bitbucket.org/culturagovbr/puppet-sei-aio.git seiaio
+    
+Instale os modulos que são dependencia direta
-Depois de instalado crie um manifest para chamar o módulo
+    # puppet module install puppetlabs-apache
+    # puppet module install puppetlabs-vcsrepo
+    # puppet module install puppetlabs-inifile
+    # puppet module install puppetlabs-mysql
+    
+Depois de instalar os módulos crie um manifest para chamar o módulo
     # vim /root/seiaio.pp
@@ -347,10 +381,10 @@ class { seiaio:
   sei_mysql_pass     => 'mA8357mHmsJszBl',
   sip_mysql_pass     => 'mA8357mHmsJszBl',
   mysql_ipaddr       => 'localhost',
-  dominio            => 'sei.funai.gov.br',
+  dominio            => 'sei.organizacao.gov.br',
   git_repo           => 'git@bitbucket.org:instruct/seiaio.git',
-  sigla_organizacao  => 'FUNAI',
-  nome_organizacao   => 'Fundacao Nacional do Indio',
+  sigla_organizacao  => 'ORG',
+  nome_organizacao   => 'Organizacao Federal',
 }
 ```
@@ -360,16 +394,25 @@ Após criar o manifest execute o puppet contra o manifest
 Aguarde a instalação do SEI, após a instalação use o manual do SEI para acessá-lo e configurá-lo.
+Devido ao download do openjdk e do LibreOffice a instalação pode levar bastante tempo dependendo da sua conexão de internet. 
+
+Em testes feitos em um link de 120 Mbits o puppet levou 21 minutos para finalizar a instalação do SEI, 18 minutos praticamente fazendo download.
+
+Em testes com repositório local de pacotes RPM (sem necessidade de download da internet) a instalação toda pode variar entre 120 e 360 segundos. 
+
 ## Acesso
+Após instalar o SEI será necessário configurar no /etc/host do seu desktop linux/unix/mac em que está rodando o hypervisor.
+
+     ip_da_vm_rodando_sei sei.organizacao.gov.br
+Isso é necessário para resolver o nome no navegador, depois de configurar o arquivo hosts, feche e abra o navegado e entre no sei. O usuário para acesso inicial é teste/teste. Siga o manual do SEI depois disto.
 ## Pendente
-  1. Inserir manual de acesso ao sei pós-instalação
-  2. Inserir informações para configuração de DNS/Hosts 
+  1. Criar smoking testes para classes puppet
   2. Criar testes unitários para classes puppet
-  3. Criar testes de aceitação para classes puppet
+  3. Criar arquivo com metadados para o módulo
 ## Referências
@@ -381,4 +424,5 @@ Sobre o SEI/PEN
 Sobre o módulo
 * https://bitbucket.org/culturagovbr/puppet-sei-aio
+* https://bitbucket.org/instruct/puppet-sei-aio