Commit 7288abb2d47dabec05982224e59ffc3c0813db52

Authored by Guto Carvalho
1 parent 420d6af3
Exists in master

Diversas melhorias e atualizaçÕes no README

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).
15 15 9. [Setup](#setup)
16 16 10. [Acesso](#acesso)
17 17 11. [Pendente](#pendente)
18   -8. [Referencias](#referencias)
  18 +8. [Referências](#referencias)
19 19  
20 20 ## Sobre
21 21  
22 22 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.
23 23  
  24 +Para usar este módulo é necessário ter acesso ao código fonte do SEI préviamente.
  25 +
24 26 ## Autores
25 27  
26 28 Desenvolvedores e criadores do módulo
... ... @@ -33,7 +35,6 @@ Desenvolvedores e criadores do módulo
33 35 Profissionais que deram apoio na revisão e testes do módulo
34 36  
35 37 * Thiago Ferreira
36   - * Jeimerson Chaves
37 38  
38 39 ## Coordenadores
39 40  
... ... @@ -208,6 +209,11 @@ Do código fonte
208 209 * Cria diretório e configura indices "publicacao"
209 210 * Executa script para criação de indices no solrd
210 211  
  212 +#### classe seiaio::seiconf
  213 +
  214 + * Criação dinâmica do arquivo ConfiguracaoSEI.php
  215 + * Criação dinâmica do arquivo ConfiguracaoSip.php
  216 +
211 217 ## Uso das classes
212 218  
213 219 ### classe principal
... ... @@ -224,10 +230,10 @@ Neste módulo temos uma classe pública, basta chamá-la que o sei será instala
224 230 sei_mysql_pass => 'mA8357mHmsJszBl',
225 231 sip_mysql_pass => 'mA8357mHmsJszBl',
226 232 mysql_ipaddr => 'localhost',
227   - dominio => 'sei.funai.gov.br',
  233 + dominio => 'sei.organizacao.gov.br',
228 234 git_repo => 'git@bitbucket.org:instruct/seiaio.git',
229   - sigla_organizacao => 'FUNAI',
230   - nome_organizacao => 'Fundacao Nacional do Indio',
  235 + sigla_organizacao => 'ORG',
  236 + nome_organizacao => 'Organizacao Federal',
231 237 }
232 238 ```
233 239 ### classes privadas
... ... @@ -238,8 +244,8 @@ As classes privadas normalmente não são chamadas diretamente, a classe princip
238 244  
239 245 ```puppet
240 246 class { 'seiaio::seifontes':
241   - docroot => 'git@bitbucket.org:instruct/seiaio.git',
242   - sei_git_repo => $git_repo,
  247 + docroot => '/var/www/html/appsei',
  248 + sei_git_repo => 'git@bitbucket.org:instruct/seiaio.git',
243 249 }
244 250 ```
245 251  
... ... @@ -247,11 +253,11 @@ class { 'seiaio::seifontes':
247 253  
248 254 ```puppet
249 255 class { 'seiaio::httpd':
250   - docroot => $docroot,
251   - owner => $owner,
252   - group => $group,
253   - dominio => $dominio,
254   - seidados => $diretorio_seidados,
  256 + docroot => '/var/www/html/appsei',
  257 + owner => 'apache',
  258 + group => 'apache',
  259 + dominio => 'sei.dominio.gov.br',
  260 + seidados => '/var/www/seidados',
255 261 }
256 262 ```
257 263  
... ... @@ -259,13 +265,13 @@ class { 'seiaio::seifontes':
259 265  
260 266 ```puppet
261 267 class { 'seiaio::database':
262   - root_mysql => $root_mysql,
263   - sei_mysql_pass => $sei_mysql_pass,
264   - sip_mysql_pass => $sip_mysql_pass,
265   - dominio => $dominio,
266   - mysql_ipaddr => $mysql_ipaddr,
267   - sigla_organizacao => $sigla_organizacao,
268   - nome_organizacao => $nome_organizacao,
  268 + root_mysql => 'senha',
  269 + sei_mysql_pass => 'senha',
  270 + sip_mysql_pass => 'senha',
  271 + dominio => 'sei.dominio.gov.br',
  272 + mysql_ipaddr => 'ip',
  273 + sigla_organizacao => 'ORG',
  274 + nome_organizacao => 'ORGANIZACAO',
269 275 }
270 276 ```
271 277  
... ... @@ -285,7 +291,7 @@ class { 'seiaio::database':
285 291  
286 292 ```puppet
287 293 class { 'seiaio::php':
288   - docroot => '/var/www/html/seiapp',
  294 + docroot => '/var/www/html/appsei',
289 295 }
290 296 ```
291 297  
... ... @@ -299,12 +305,33 @@ class { 'seiaio::cron':
299 305  
300 306 #### delcarando classe sei::solr (classe privada)
301 307  
302   - include seiaio::solr
  308 +```puppet
  309 +class { 'seiaio::solr':
  310 + dominio => 'sei.organizacao.gov.br',
  311 +}
  312 +```
303 313  
304 314 #### delcarando classe sei::jodc (classe privada)
305 315  
306 316 include seiaio::jodc
307 317  
  318 +#### delcarando classe sei::seiconf (classe privada)
  319 +
  320 + ```puppet
  321 + class { 'seiaio::seiconf':
  322 + docroot => '/var/www/html/appsei',
  323 + owner => 'apache',
  324 + group => 'apache',
  325 + dominio => 'sei.organizacao.gov.br',
  326 + seidados => '/var/www/seidados',
  327 + mysql_ipaddr => '127.0.0.1',
  328 + sei_mysql_pass => 'senha',
  329 + sip_mysql_pass => 'senha',
  330 + sigla_organizacao => 'GOV',
  331 + nome_organizacao => 'Organizacao',
  332 + }
  333 + ```
  334 +
308 335 ## Git
309 336  
310 337 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.
320 347  
321 348 ## Setup
322 349  
323   -Em seu CentOS 7 instale o repositório do puppet
  350 +Em seu CentOS 6 instale o repositório do puppet
324 351  
325   - # yum install http://yum.puppetlabs.com/el/7/PC1/x86_64/puppetlabs-release-pc1-0.9.2-1.el7.noarch.rpm -y
  352 + # yum install http://yum.puppetlabs.com/el/6/PC1/x86_64/puppetlabs-release-pc1-0.9.2-1.el6.noarch.rpm -y
326 353  
327 354 Depois instale o puppet
328 355  
... ... @@ -331,9 +358,16 @@ Depois instale o puppet
331 358 Você precisa instalar o módulo no diretório de módulos.
332 359  
333 360 # cd /etc/puppetlabs/code/environment/production/modules
334   - # git clone https://bitbucket.org/culturagovbr/puppet-sei-aio.git seiaio
  361 + # git clone https://bitbucket.org/culturagovbr/puppet-sei-aio.git seiaio
  362 +
  363 +Instale os modulos que são dependencia direta
335 364  
336   -Depois de instalado crie um manifest para chamar o módulo
  365 + # puppet module install puppetlabs-apache
  366 + # puppet module install puppetlabs-vcsrepo
  367 + # puppet module install puppetlabs-inifile
  368 + # puppet module install puppetlabs-mysql
  369 +
  370 +Depois de instalar os módulos crie um manifest para chamar o módulo
337 371  
338 372 # vim /root/seiaio.pp
339 373  
... ... @@ -347,10 +381,10 @@ class { seiaio:
347 381 sei_mysql_pass => 'mA8357mHmsJszBl',
348 382 sip_mysql_pass => 'mA8357mHmsJszBl',
349 383 mysql_ipaddr => 'localhost',
350   - dominio => 'sei.funai.gov.br',
  384 + dominio => 'sei.organizacao.gov.br',
351 385 git_repo => 'git@bitbucket.org:instruct/seiaio.git',
352   - sigla_organizacao => 'FUNAI',
353   - nome_organizacao => 'Fundacao Nacional do Indio',
  386 + sigla_organizacao => 'ORG',
  387 + nome_organizacao => 'Organizacao Federal',
354 388 }
355 389 ```
356 390  
... ... @@ -360,16 +394,25 @@ Após criar o manifest execute o puppet contra o manifest
360 394  
361 395 Aguarde a instalação do SEI, após a instalação use o manual do SEI para acessá-lo e configurá-lo.
362 396  
  397 +Devido ao download do openjdk e do LibreOffice a instalação pode levar bastante tempo dependendo da sua conexão de internet.
  398 +
  399 +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.
  400 +
  401 +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.
  402 +
363 403 ## Acesso
364 404  
  405 +Após instalar o SEI será necessário configurar no /etc/host do seu desktop linux/unix/mac em que está rodando o hypervisor.
  406 +
  407 + ip_da_vm_rodando_sei sei.organizacao.gov.br
365 408  
  409 +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.
366 410  
367 411 ## Pendente
368 412  
369   - 1. Inserir manual de acesso ao sei pós-instalação
370   - 2. Inserir informações para configuração de DNS/Hosts
  413 + 1. Criar smoking testes para classes puppet
371 414 2. Criar testes unitários para classes puppet
372   - 3. Criar testes de aceitação para classes puppet
  415 + 3. Criar arquivo com metadados para o módulo
373 416  
374 417 ## Referências
375 418  
... ... @@ -381,4 +424,5 @@ Sobre o SEI/PEN
381 424 Sobre o módulo
382 425  
383 426 * https://bitbucket.org/culturagovbr/puppet-sei-aio
  427 +* https://bitbucket.org/instruct/puppet-sei-aio
384 428  
... ...