Commit 02a65fe477564d8e25d773519f85b5dc30d798cb
1 parent
8ba19d23
Exists in
master
Atualizando repositório de instalação do Puppet.
Showing
1 changed file
with
158 additions
and
151 deletions
Show diff stats
README.md
1 | -# Simec - Sistema Integrado de Monitoramento, Execução e Controle | |
1 | +imec - Sistema Integrado de Monitoramento, Execução e Controle | |
2 | 2 | |
3 | 3 | #### Tabela de Conteúdo |
4 | 4 | |
... | ... | @@ -26,257 +26,264 @@ o banco de dados PostgresSQL localmente ou configurar o acesso a um banco remoto |
26 | 26 | ## Compatibilidade |
27 | 27 | |
28 | 28 | * Compatível com CentOS 7 e Debian >= 7 |
29 | - * Escrito com recursos do Puppet 3. | |
30 | - * O Simec utiliza APACHE 2 e PostgreSQL 8.4 ou superior. | |
31 | - * Este módulo usa **PostgreSQL 9.3.** | |
29 | + * Escrito com recursos do Puppet 3. | |
30 | + * O Simec utiliza APACHE 2 e PostgreSQL 8.4 ou superior. | |
31 | + * Este módulo usa **PostgreSQL 9.3.** | |
32 | 32 | |
33 | -## Requisitos | |
33 | + ## Requisitos | |
34 | 34 | |
35 | - * Pelo menos 2 gigas de RAM | |
36 | - * Pelo menos 10 gigas de disco | |
37 | - * Acesso a internet para instalação de pacotes | |
35 | + * Pelo menos 2 gigas de RAM | |
36 | + * Pelo menos 10 gigas de disco | |
37 | + * Acesso a internet para instalação de pacotes | |
38 | 38 | |
39 | -## Setup **Install Puppet** | |
39 | + ## Setup **Install Puppet** | |
40 | + | |
41 | + Instale o repositório do puppet para o seu Sistema Operacional. | |
42 | + | |
43 | + Debian 7 | |
44 | + $ wget https://apt.puppetlabs.com/puppetlabs-release-wheezy.deb | |
45 | + $ sudo dpkg -i puppetlabs-release-wheezy.deb | |
46 | + | |
47 | + Debian 8 | |
48 | + $ wget https://apt.puppetlabs.com/puppetlabs-release-jessie.deb | |
49 | + $ sudo dpkg -i puppetlabs-release-jessie.deb | |
50 | + | |
51 | + Pós instalação do repositório puppet para o Debian | |
52 | + $ sudo apt-get update | |
53 | + $ sudo apt-get install puppet-agent | |
40 | 54 | |
41 | -Instale o repositório do puppet para o seu Sistema Operacional. | |
55 | + CentOS | |
56 | + $ sudo rpm -Uvh https://yum.puppetlabs.com/puppetlabs-release-pc1-el-7.noarch.rpm | |
57 | + # yum install puppet-agent | |
42 | 58 | |
43 | - Debian | |
44 | - $ wget https://apt.puppetlabs.com/puppetlabs-release-stable.deb | |
45 | - $ sudo dpkg -i puppetlabs-release-stable.deb | |
46 | - $ sudo apt-get update | |
47 | - $ sudo apt-get install puppet-agent | |
59 | + Em caso de instalações ServerLess, será preciso instalar o módulo no diretório de módulos de acordo com o S.O. | |
48 | 60 | |
49 | - CentOS | |
50 | - $ sudo rpm -Uvh https://yum.puppetlabs.com/puppetlabs-release-pc1-el-7.noarch.rpm | |
51 | - # yum install puppet-agent | |
61 | + Gerelamente no Debian: | |
52 | 62 | |
53 | -Em caso de instalações ServerLess, será preciso instalar o módulo no diretório de módulos de acordo com o S.O. | |
63 | + obs.: PASTADOMODULO deve ter o nome de **"simec"** | |
64 | + Ex: /etc/puppet/modules/simec | |
54 | 65 | |
55 | -Gerelamente no Debian: | |
66 | + # cp -av PASTADOMODULO /etc/puppetlabs/code/environment/production/modules/PASTADOMODULO | |
56 | 67 | |
57 | -obs.: PASTADOMODULO deve ter o nome de **"simec"** | |
58 | -Ex: /etc/puppet/modules/simec | |
68 | + ou | |
59 | 69 | |
60 | - # cp -av PASTADOMODULO /etc/puppetlabs/code/environment/production/modules/PASTADOMODULO | |
70 | + Geralmente no CentOS | |
61 | 71 | |
62 | -ou | |
72 | + # cp -av PASTADOMODULO /etc/puppet/modules/PASTADOMODULO | |
63 | 73 | |
64 | -Geralmente no CentOS | |
74 | + Dependendo do Sistema Operacional. | |
65 | 75 | |
66 | - # cp -av PASTADOMODULO /etc/puppet/modules/PASTADOMODULO | |
67 | 76 | |
68 | -Dependendo do Sistema Operacional. | |
77 | + ## ServerLess | |
69 | 78 | |
79 | + Após criar o manifest, execute o puppet em modo serverless. (obs.: é necessário | |
80 | + instalar os módulos de dependência.) | |
70 | 81 | |
71 | -## ServerLess | |
82 | + # puppet module install puppetlabs-vcsrepo | |
83 | + # puppet module install puppetlabs-apache | |
84 | + # puppet module install herculesteam-augeasproviders_postgresql | |
85 | + # puppet apply /tmp/meusimec.pp | |
72 | 86 | |
73 | -Após criar o manifest, execute o puppet em modo serverless. (obs.: é necessário | |
74 | -instalar os módulos de dependência.) | |
87 | + obs.: /tmp/meusimec.pp é o arquivo com a declaração da classe (Veja mais em [Uso](#uso)). | |
75 | 88 | |
76 | - # puppet module install puppetlabs-vcsrepo | |
77 | - # puppet module install puppetlabs-apache | |
78 | - # puppet module install herculesteam-augeasproviders_postgresql | |
79 | - # puppet apply /tmp/meusimec.pp | |
80 | 89 | |
81 | -obs.: /tmp/meusimec.pp é o arquivo com a declaração da classe (Veja mais em [Uso](#uso)). | |
90 | + ## Uso | |
82 | 91 | |
92 | + Para instalar o SIMEC com banco local (o padrão é banco remoto) e parâmetros padrões: | |
83 | 93 | |
84 | -## Uso | |
94 | + ```puppet | |
95 | + class { '::simec': | |
96 | + vhost => 'meusimec.dominio', | |
97 | + install_db => true | |
98 | + } | |
99 | + ``` | |
100 | + Para instalar o SIMEC com banco remoto: | |
85 | 101 | |
86 | -Para instalar o SIMEC com banco local (o padrão é banco remoto) e parâmetros padrões: | |
102 | + ```puppet | |
103 | + class {'::simec': | |
104 | + vhost => 'meusimec.dominio', | |
105 | + install_db => false, | |
106 | + db_name => 'nomedabase', | |
107 | + db_username => 'usuariodeconexao', | |
108 | + db_password => 'SenhaSuperForte', | |
109 | + db_host => 'HostRemotodoBanco', #Ex: '192.168.1.1' | |
110 | + } | |
111 | + ``` | |
87 | 112 | |
88 | -```puppet | |
89 | -class { '::simec': | |
90 | - vhost => 'meusimec.dominio', | |
91 | - install_db => true | |
92 | -} | |
93 | -``` | |
94 | -Para instalar o SIMEC com banco remoto: | |
113 | + Para especificar um repositório, DocumentRoot e um sistema de controle de versão diferente do git, use: | |
114 | + (obs.: é necessário um repositório com permissão de clone (git) ou chekout (svn) sem exigir autenticação.) | |
95 | 115 | |
96 | -```puppet | |
97 | -class {'::simec': | |
98 | - vhost => 'meusimec.dominio', | |
99 | - install_db => false, | |
100 | - db_name => 'nomedabase', | |
101 | - db_username => 'usuariodeconexao', | |
102 | - db_password => 'SenhaSuperForte', | |
103 | - db_host => 'HostRemotodoBanco', #Ex: '192.168.1.1' | |
104 | -} | |
105 | -``` | |
116 | + ```puppet | |
117 | + class {'::simec': | |
118 | + vhost => 'meusimec.dominio', | |
119 | + source => 'http://repositorioSVNdosimec', | |
120 | + datadir => '/var/www/simec', | |
121 | + vcsprovider => 'svn' | |
122 | + } | |
123 | + ``` | |
124 | + Exemplo de uma declaração com TODOS os parâmetros: | |
106 | 125 | |
107 | -Para especificar um repositório, DocumentRoot e um sistema de controle de versão diferente do git, use: | |
108 | -(obs.: é necessário um repositório com permissão de clone (git) ou chekout (svn) sem exigir autenticação.) | |
126 | + ```puppet | |
127 | + class {'::simec': | |
128 | + vhost => 'meusimec.dominio', | |
129 | + source => 'http://repositoriodosimec', | |
130 | + datadir => '/var/www/simec', | |
131 | + install_db => true, | |
132 | + db_name => 'dbsimec', | |
133 | + db_username => 'usrsimec', | |
134 | + db_password => 'MinhaSenhaForte', | |
135 | + db_host => '192.168.1.1', | |
136 | + db_port => '5432', | |
137 | + emails => 'meuemail@meudominio ; outroemail@outrodominio', | |
138 | + vcsprovider => 'git', | |
139 | + apacheuser => 'apache', | |
140 | + repoensure => 'present' | |
141 | + } | |
142 | + ``` | |
109 | 143 | |
110 | -```puppet | |
111 | -class {'::simec': | |
112 | - vhost => 'meusimec.dominio', | |
113 | - source => 'http://repositorioSVNdosimec', | |
114 | - datadir => '/var/www/simec', | |
115 | - vcsprovider => 'svn' | |
116 | -} | |
117 | -``` | |
118 | -Exemplo de uma declaração com TODOS os parâmetros: | |
144 | + ## Classes | |
119 | 145 | |
120 | -```puppet | |
121 | -class {'::simec': | |
122 | - vhost => 'meusimec.dominio', | |
123 | - source => 'http://repositoriodosimec', | |
124 | - datadir => '/var/www/simec', | |
125 | - install_db => true, | |
126 | - db_name => 'dbsimec', | |
127 | - db_username => 'usrsimec', | |
128 | - db_password => 'MinhaSenhaForte', | |
129 | - db_host => '192.168.1.1', | |
130 | - db_port => '5432', | |
131 | - emails => 'meuemail@meudominio ; outroemail@outrodominio', | |
132 | - vcsprovider => 'git', | |
133 | - apacheuser => 'apache', | |
134 | - repoensure => 'present' | |
135 | -} | |
136 | -``` | |
146 | + ### Resumo das Classes | |
137 | 147 | |
138 | -## Classes | |
148 | + #### Classe simec::apache | |
139 | 149 | |
140 | -### Resumo das Classes | |
150 | + * Instalação e configuração do Apache | |
151 | + * Módulos do Apache | |
152 | + * Configuração do Vhost com Aliases, etc. | |
153 | + * Configuração do Parâmetros do PHP no Vhost via php_value e php_admin. | |
141 | 154 | |
142 | -#### Classe simec::apache | |
155 | + #### Classe simec::postgresql | |
143 | 156 | |
144 | - * Instalação e configuração do Apache | |
145 | - * Módulos do Apache | |
146 | - * Configuração do Vhost com Aliases, etc. | |
147 | - * Configuração do Parâmetros do PHP no Vhost via php_value e php_admin. | |
157 | + * Instalação do Servidor PostgreSQL. | |
158 | + * Configuração do Repositório oficial do PostgreSQL. | |
159 | + * Instalação dos pacotes do PostGis (GeoProcessamento). | |
160 | + * Criação da Base de Dados. | |
161 | + * Configuração do pg_hba.conf. | |
162 | + * Restore do Dump da Base de Dados. | |
148 | 163 | |
149 | -#### Classe simec::postgresql | |
164 | + #### Classe simec::install | |
150 | 165 | |
151 | - * Instalação do Servidor PostgreSQL. | |
152 | - * Configuração do Repositório oficial do PostgreSQL. | |
153 | - * Instalação dos pacotes do PostGis (GeoProcessamento). | |
154 | - * Criação da Base de Dados. | |
155 | - * Configuração do pg_hba.conf. | |
156 | - * Restore do Dump da Base de Dados. | |
166 | + * Instalação dos Pacotes php. | |
167 | + * Instalação do Pacote do Provider para o VCSREPO (Controle de versionamento, git, svn, etc.). | |
168 | + * Clone, etc. do Repositório com o código do SIMEC para o $datadir definido. | |
157 | 169 | |
158 | -#### Classe simec::install | |
170 | + #### Classe simec::config | |
159 | 171 | |
160 | - * Instalação dos Pacotes php. | |
161 | - * Instalação do Pacote do Provider para o VCSREPO (Controle de versionamento, git, svn, etc.). | |
162 | - * Clone, etc. do Repositório com o código do SIMEC para o $datadir definido. | |
172 | + * Configuração dos arquivos do SIMEC via Template ERB. | |
173 | + * Arquivo principal do simec (config.inc). | |
174 | + * Arquivo de Configuração para conexão com o Banco (database.php). | |
163 | 175 | |
164 | -#### Classe simec::config | |
176 | + #### Classe simec::params | |
165 | 177 | |
166 | - * Configuração dos arquivos do SIMEC via Template ERB. | |
167 | - * Arquivo principal do simec (config.inc). | |
168 | - * Arquivo de Configuração para conexão com o Banco (database.php). | |
178 | + * Configuração dos parâmetros padrões. | |
179 | + * Definição do $apacheuser de acordo com o facter osfamily (RedHat e Debian). | |
180 | + * Definição dos pacotes a serem instalados. | |
169 | 181 | |
170 | -#### Classe simec::params | |
182 | + #### Classe simec:init | |
171 | 183 | |
172 | - * Configuração dos parâmetros padrões. | |
173 | - * Definição do $apacheuser de acordo com o facter osfamily (RedHat e Debian). | |
174 | - * Definição dos pacotes a serem instalados. | |
184 | + * Classe principal para saber como chamar (Veja mais em [Uso](#uso)). | |
185 | + * Verificação do valor da variável $instal_db para decidir se há necessidade de instalação do banco localmente ou não. | |
175 | 186 | |
176 | -#### Classe simec:init | |
187 | + ## Parâmetros | |
177 | 188 | |
178 | - * Classe principal para saber como chamar (Veja mais em [Uso](#uso)). | |
179 | - * Verificação do valor da variável $instal_db para decidir se há necessidade de instalação do banco localmente ou não. | |
189 | + ### Informações do Parâmetros | |
180 | 190 | |
181 | -## Parâmetros | |
191 | + [**vhost**] | |
182 | 192 | |
183 | -### Informações do Parâmetros | |
193 | + Domínio que será configurado no vhost ex.: simec.seudominio.gov. **Valor Padrão: simec.dominio.gov.br** | |
184 | 194 | |
185 | - [**vhost**] | |
186 | 195 | |
187 | -Domínio que será configurado no vhost ex.: simec.seudominio.gov. **Valor Padrão: simec.dominio.gov.br** | |
188 | 196 | |
197 | + [**datadir**] | |
189 | 198 | |
199 | + Local em que o código será baixado e serão feitos os apontamentos no vhost. **Valor Padrão: /var/www/html/simec** | |
190 | 200 | |
191 | - [**datadir**] | |
192 | 201 | |
193 | -Local em que o código será baixado e serão feitos os apontamentos no vhost. **Valor Padrão: /var/www/html/simec** | |
194 | 202 | |
203 | + [**apacheuser**] | |
195 | 204 | |
205 | + Usuário do serviço apache, definido automaticamente pelo facter osfamily caso seja RedHat ou Debian | |
196 | 206 | |
197 | - [**apacheuser**] | |
198 | 207 | |
199 | -Usuário do serviço apache, definido automaticamente pelo facter osfamily caso seja RedHat ou Debian | |
200 | 208 | |
209 | + [**db_username**] | |
201 | 210 | |
211 | + Nome do usuário de conexão com o banco de dados. **Valor Padrão: user_simec** | |
202 | 212 | |
203 | - [**db_username**] | |
204 | 213 | |
205 | -Nome do usuário de conexão com o banco de dados. **Valor Padrão: user_simec** | |
206 | 214 | |
215 | + [**db_password**] | |
207 | 216 | |
217 | + Senha de conexão com o banco de dados. **Valor Padrão: 841j8K9J67p788x** | |
208 | 218 | |
209 | - [**db_password**] | |
210 | 219 | |
211 | -Senha de conexão com o banco de dados. **Valor Padrão: 841j8K9J67p788x** | |
212 | 220 | |
221 | + [**db_name**] | |
213 | 222 | |
223 | + Nome da base de dados. **Valor Padrão: db_simec** | |
214 | 224 | |
215 | - [**db_name**] | |
216 | 225 | |
217 | -Nome da base de dados. **Valor Padrão: db_simec** | |
218 | 226 | |
227 | + [**db_host**] | |
219 | 228 | |
229 | + IP ou nome do servidor de banco de dados. **Valor Padrão: $::ipaddress** | |
220 | 230 | |
221 | - [**db_host**] | |
222 | 231 | |
223 | -IP ou nome do servidor de banco de dados. **Valor Padrão: $::ipaddress** | |
224 | 232 | |
233 | + [**db_port**] | |
225 | 234 | |
235 | + Porta de Conexão com o servidor de banco de dados. **Valor Padrão: 5432** | |
226 | 236 | |
227 | - [**db_port**] | |
228 | 237 | |
229 | -Porta de Conexão com o servidor de banco de dados. **Valor Padrão: 5432** | |
230 | 238 | |
239 | + [**vcsprovider**] | |
231 | 240 | |
241 | + Pacote do Sistema de Controle de Versionamento. **Valor Padrão: git** | |
232 | 242 | |
233 | - [**vcsprovider**] | |
234 | 243 | |
235 | -Pacote do Sistema de Controle de Versionamento. **Valor Padrão: git** | |
236 | 244 | |
245 | + [**repoensure**] | |
237 | 246 | |
247 | + Definição se será realizado o download do código via VCSREPO. **Valor Padrão: present** (Fazer Download) | |
238 | 248 | |
239 | - [**repoensure**] | |
240 | 249 | |
241 | -Definição se será realizado o download do código via VCSREPO. **Valor Padrão: present** (Fazer Download) | |
242 | 250 | |
251 | + [**source**] | |
243 | 252 | |
253 | + URL do Repositório do código. **Valor padrão: https://softwarepublico.gov.br/gitlab/simec/simec.git** | |
244 | 254 | |
245 | - [**source**] | |
246 | 255 | |
247 | -URL do Repositório do código. **Valor padrão: https://softwarepublico.gov.br/gitlab/simec/simec.git** | |
248 | 256 | |
257 | + [**emails**] | |
249 | 258 | |
259 | + Emails configurados no arquivo de configuração principal do SIMEC config.inc para receber informações do sistema. | |
250 | 260 | |
251 | - [**emails**] | |
252 | 261 | |
253 | -Emails configurados no arquivo de configuração principal do SIMEC config.inc para receber informações do sistema. | |
254 | 262 | |
263 | + [**install_db**] | |
255 | 264 | |
265 | + Variável booleana para definir se será instalado o banco de dados localmente. **Valor Padrão: false** | |
256 | 266 | |
257 | - [**install_db**] | |
267 | + | |
268 | + ### Acesso | |
258 | 269 | |
259 | -Variável booleana para definir se será instalado o banco de dados localmente. **Valor Padrão: false** | |
270 | + Sistema instalado e o apontamento no DNS para o domínio escolhido ($vhost) ao menos na máquina com o navegador. | |
260 | 271 | |
261 | - | |
262 | -### Acesso | |
272 | + Acesso ao endereço no navegador Ex:"http://simec.dominio.gov.br". Carregada a página de login, o sistema solicitará o CPF e a SENHA para acesso. | |
263 | 273 | |
264 | -Sistema instalado e o apontamento no DNS para o domínio escolhido ($vhost) ao menos na máquina com o navegador. | |
265 | 274 | |
266 | -Acesso ao endereço no navegador Ex:"http://simec.dominio.gov.br". Carregada a página de login, o sistema solicitará o CPF e a SENHA para acesso. | |
267 | 275 | |
276 | + Acesso administrativo: | |
268 | 277 | |
278 | + **CPF: 86274565426** | |
269 | 279 | |
270 | -Acesso administrativo: | |
280 | + **Senha: 123456** | |
271 | 281 | |
272 | -**CPF: 86274565426** | |
282 | + ### Pendente | |
273 | 283 | |
274 | -**Senha: 123456** | |
284 | + Configuração do módulo para outros Sistemas Operacionais. | |
275 | 285 | |
276 | -### Pendente | |
286 | + ### Referências | |
287 | + * https://softwarepublico.gov.br/social/simec/ | |
277 | 288 | |
278 | -Configuração do módulo para outros Sistemas Operacionais. | |
279 | - | |
280 | -### Referências | |
281 | - * https://softwarepublico.gov.br/social/simec/ | |
282 | 289 | ... | ... |