diff --git a/README.md b/README.md index aaf4596..34c3af6 100644 --- a/README.md +++ b/README.md @@ -4,54 +4,83 @@ Módulo Puppet SEI AIO (All-in-One). #### Tabela de conteudo -1. [Overview](#overview) -2. [Compatibilidade](#compatibilidade) -3. [Setup](#setup) -4. [Uso](#uso) -5. [Limites](#limites) -6. [Pendende](#pendente) -7. [Referencias](#referencias) - -## Overview +1. [Sobre](#sobre) +2. [Autores](#autores) +3. [Colaboradores](#colaboradores) +4. [Coordenadores](#coordenadores) +5. [Projeto](#projeto) +6. [Requisitos](#requisitos) +7. [Classes](#classes) +8. [GIT](#git) +9. [Setup](#setup) +10. [Acesso](#acesso) +11. [Pendente](#pendente) +8. [Referencias](#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. -## Autores e desenvolvedores do módulo +## Autores + +Desenvolvedores e criadores do módulo * Guto Carvalho (gutocarvalho@instruct.com.br) * Miguel Filho (gutocarvalho@instruct.com.br) -## Colaboradores e revisores +## Colaboradores + +Profissionais que deram apoio na revisão e testes do módulo * Thiago Ferreira * Jeimerson Chaves -## Coordenadores do projeto SEI +## Coordenadores + +Coordenadores do projeto SEI na CGTI-MINC + * Diego Aguilera + * Rogério Pereira * Christian Miranda * Francisco Morais - * Rogério Pereira - * Diego Aguilera - -## Projeto e Parceria + +## Projeto O desenvolvimento deste módulo ocorreu através de uma iniciativa do Ministério da Cultura e Instruct durante o projeto de implantação de SEI no MINC em 2015. -## Compatibilidade +## Requisitos - * Esse módulo é compatível com CentOS 6. - * Esse módulo foi escrito usando recursos do Puppet 4. +Do sistema operacional -## Requisitos + * Esse módulo deve ser utilizado em CentOS 6 + +Da versão do puppet + + * Esse módulo deve ser executado com Puppet 4 + +Do módulo puppet + + * Este módulo depende do módulo puppetlabs-apache + * Este módulo depende do módulo puppetlabs-mysql + * Este módulo depende do módulo puppetlabs-stdlib + * Este módulo depende do módulo puppetlabs-vcsrepo + * Este módulo depende do módulo puppetlabs-staging + * Este módulo depende do módulo puppetlabs-concat + * Este módulo depende do módulo puppetlabs-inifile + +Do hypervisor * Hypervisor Virtualbox ou VMWARE Workstation * Pelo menos 4 gigas de RAM para subir a VM * Pelo menos 10 gigas de disco para subir a VM * VM com CentOS 6 instalado * Acesso a internet para instalação de pacotes - * Código fonte do SEI em algum repositório GIT -## Setup +Do código fonte + + * Código fonte do SEI disponível em algum repositório GIT + +## Classes ### O que esse modulo gerencia? @@ -276,7 +305,7 @@ class { 'seiaio::cron': include seiaio::jodc -## Repositório GIT do SEI +## Git O código do sei tem que estar em um repositório GIT com a seguinte estrutura na raiz do repositório: @@ -289,7 +318,7 @@ O código do sei tem que estar em um repositório GIT com a seguinte estrutura n Se a estrutura não for essa, o módulo não irá funcionar. -## Instalação para iniciantes +## Setup Em seu CentOS 7 instale o repositório do puppet @@ -331,15 +360,10 @@ 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. -## Acesso pós-instalação +## Acesso -## Limites - - 1. Só funciona em CentOS 6 - 2. Só funciona com Puppet 4 - ## Pendente 1. Inserir manual de acesso ao sei pós-instalação @@ -349,3 +373,12 @@ Aguarde a instalação do SEI, após a instalação use o manual do SEI para ace ## Referências +Sobre o SEI/PEN + +* https://processoeletronico.gov.br/projects/sei/wiki/PEN +* https://softwarepublico.gov.br/social/sei + +Sobre o módulo + +* https://bitbucket.org/culturagovbr/puppet-sei-aio + -- libgit2 0.21.2