Portal do Software Pblico Brasileiro

Modelo de Manual de Instalao,

Administrao e Uso do <nome do
software>
Verso !"
Autores
#ome dos inte$rantes
%ocal, &&&& de &&&&&
Modelo de Manual de Instalao, Administrao e Uso do <nome do software> 1
Logotipo
do
Sistema
Portal do Software Pblico Brasileiro
Sumrio
Licena deste Documento ....................................................................................................................3
Introduo ao Sistema XYZ.................................................................................................................4
Caractersticas e principais funcionalidades....................................................................................4
Aruitetura............................................................................................................................................!
Instalao do Sistema..........................................................................................................................."
#euisitos $erais para instalao....................................................................................................."
%ard&are mnimo necess'rio..........................................................................................................."
(r)*reuisitos..................................................................................................................................."
(asso*a*passo da Instalao no Sistema +peracional Linu,...........................................................-
Atuali.ao do Sistema /Se necess'rio0..........................................................................................1
Administrao e 2so do Sistema..........................................................................................................3
Lin4 da Licena 56ridica Creati7e Commons.....................................................................................89
Modelo de Manual de Instalao, Administrao e Uso do <nome do software> 2
Logotipo
do
Sistema
Portal do Software Pblico Brasileiro
Licena deste Documento
Para a utili'ao deste documento ( necess)rio se$uir as re$ras da licena *reati+e
*ommons ,ela mesma %icena -!. Brasil /0tt,122creati+ecommons!or$2licenses2b34nc4
sa2-!.2br2deed!,t5B67!
Voc tem a liberdade de:
Compartilhar 8 co,iar, distribuir e transmitir a obra!
Remixar 8 criar obras deri+adas!
Sob as se$uintes condi9es1
Atribuio 8 Voc: de+e creditar a obra da forma es,ecificada ,elo autor ou
licenciante /mas no de maneira ;ue su$ira ;ue estes concedem ;ual;uer a+al a
+oc: ou ao seu uso da obra7!
Compartilhamento pela mesma licena 8 Se +oc: alterar, transformar ou criar
em cima desta obra, +oc: ,oder) distribuir a obra resultante a,enas sob a
mesma licena, ou sob uma licena similar < ,resente!
=icando claro ;ue1
Renncia 8 >ual;uer das condi9es acima ,ode ser renunciada se +oc: obti+er
,ermisso do titular dos direitos autorais!
Dom!nio "blico 8 ?nde a obra ou ;ual;uer de seus elementos esti+er em dom@nio
,blico sob o direito a,lic)+el, esta condio no (, de maneira al$uma, afetada ,ela
licena!
#utros Direitos 8 ?s se$uintes direitos no so, de maneira al$uma, afetados ,ela
licena1
%imita9es e e&ce9es aos direitos autorais ou ;uais;uer usos li+res a,lic)+eisA
?s direitos morais do autorA
Bireitos ;ue outras ,essoas ,odem ter sobre a obra ou sobre a utili'ao da obra,
tais como direitos de ima$em ou ,ri+acidade!
A$iso 8 Para ;ual;uer reutili'ao ou distribuio, +oc: de+e dei&ar claro a terceiros os
termos da licena a ;ue se encontra submetida esta obra! A mel0or maneira de fa'er isso
( com um linC ,ara esta ,)$ina!
Modelo de Manual de Instalao, Administrao e Uso do <nome do software> 3
Logotipo
do
Sistema
Portal do Software Pblico Brasileiro
%ntroduo ao Sistema &'(
Be+er) conter um te&to introdutDrio sobre o sistema em ;uesto, sua mantenedora, etc!
E&em,lo1
O CACIC um sistema de inventrio de hardware e software que tem a Dataprev como a
mantenedora raiz e, atravs do Portal do SP, rece!e cola!ora"#es das mais
diversificadas formas e de diversas institui"#es$ O sistema !aseado em a%entes sendo
capaz de o!ter um dia%n&stico do parque computacional e fornecer informa"#es de
diversos tipos de dispositivos e softwares presentes em um computador 'esta"(o ou
servidor)$ Como e*emplo de levantamento de dados computacionais cite+se unidades de
cdrom, mem&ria ,A-, placas de rede, discos r.%idos, softwares instalados entre outras
funcionalidades$
Caracter!sticas e principais )uncionalidades
Be+er) ser informado as caracter@sticas e funcionalidades do sistema como1 ar;uitetura
desen+ol+ida, banco de dados, etc!
E&em,lo1
O c&di%o fonte 'que livre e a!erto) est dispon.vel para ser !ai*ado livremente no Portal
do SP e sua implementa"(o em P/P0-, P1thon0- e Delphi0- tendo como camada
de armazenamento o sistema %erenciador de !anco de dados -1S230-$
O sistema possui variadas funcionalidades entre as quais destacam+se4
Suporte a inventrio em plataforma 5indows0- 67!its e a 3inu*0- 8
O!ten"(o automatizada de dados de hardware e software 8
9acilita o processo de levantamento patrimonial 8
Suporte a m:ltiplos idiomas, sendo ; e*istente o portu%u<s !rasileiro e espanhol
'=>?) e iniciada a tradu"(o para o in%l<s, mas podendo ser facilmente
traduzido para outros8
Suporte ao controle de aquisi"#es 'licen"as) de softwares adquiridos @
inventariados8
Inte%ra"(o A tecnolo%ia IntelB A-0CvPro0-D E plu%in desenvolvido e
disponi!ilizado pela Intel para %erenciamento remoto de esta"#es de tra!alho
corporativas que contenham essa tecnolo%ia em!arcada $
Modelo de Manual de Instalao, Administrao e Uso do <nome do software> 4
Logotipo
do
Sistema
Portal do Software Pblico Brasileiro
Ar*uitetura
Be+er) ser e&,licitado a ar;uitetura do sistema em ;uesto contendo te&tos, fi$uras,
flu&os, etc!
Modelo de Manual de Instalao, Administrao e Uso do <nome do software> 5
Logotipo
do
Sistema
Portal do Software Pblico Brasileiro
%nstalao do Sistema
Requisitos erais !ara instalao
Informar ;uais os re;uisitos de ,lataforma, softwares, ser+idores ,ara instalao do
sistema!
E&em,lo1
D$ Fm servidor com a sua distri!ui"(o GHFC3inu* preferida$ Aqui vamos usar a
vers(o do ,ed /at I$> onde ser instalado o Gerente do CACIC$ Jste mesmo %uia
pode ser utilizado para o CentOS e 9edora$ Para as demais distri!ui"#es s&
adapt+lo$ Praticamente todos os passos s(o i%uais com as devidas
particularidades da sua distri!ui"(o$
:. As esta"#es 'computadores) em rede para que possa ser instalado um pro%rama
chamado A%ente do CACIC$ As esta"#es podem ser tanto 5indows como 3inu&!
"ardware m#nimo ne$ess%rio
E&em,lo1
Computador com processador Intel ou Amd$
-em&ria ,A-4 ID7- ,A- '7G ,A- recomendvel)8
/D4 DIG para instalar o GHFC3inu*, o CACIC e a !ase de dados 'I>G SCSI
recomendvel)
&r'(requisitos
Be+er) ser informado os ,acotes2ser+ios2com,onentes2softwares a serem instalados,
endereo eletrFnico ,ara download e2ou ,asso4a4,asso da instalao destes!
%embrando ;ue nesse momento ( e&tremamente im,ortante dar o de+ido su,orte ao
usu)rio, ,ois nem sem,re so con0ecedores de determinados ,rocessos de instalao! G
til a insero de printscreens das telas de instalao, detal0amento de comandos em
terminais, diferenas entre sistemas o,eracionais, distribui9es!
Modelo de Manual de Instalao, Administrao e Uso do <nome do software> )
Logotipo
do
Sistema
Portal do Software Pblico Brasileiro
&asso(a(!asso da Instalao no *istema +!era$ional ,inu-
A;ui de+er) conter o ,ass4a4,asso do ,rocesso de instalao de forma detal0ada,
contendo ima$ens das telas de instalao, comandos com e&,lica9es!
E&em,lo1
Passo @4 Confi%ura"(o de cone*(o e !ase de dados para o sistema
Di%ite as informa"#es e clique no !ot(o 0este de cone*(o para realizar o teste E a
mensa%em de retorno deve ser como a a!ai*o$
Para criar a !ase de dados clique no !ot(o Construir D$
O!serve que tudo foi conclu.do com sucesso e em se%uida clique no !ot(o Pr&*imo$
Modelo de Manual de Instalao, Administrao e Uso do <nome do software> .
Logotipo
do
Sistema
Portal do Software Pblico Brasileiro
Atuali/ao do *istema 0*e ne$ess%rio1
Be+er) ser informado os ,assos ,ara atuali'ao do sistema em ;uesto, se necess)rio!
*aso esse item no se a,li;ue, ,or fa+or desconsidere4o!
E&em,lo1
As instru"#es que se se%uem levam em conta as vers#es anteriores do CACIC na forma
padr(o de disponi!iliza"(o, isto , a vers(o n(o foi alterada internamente na empresa
usuria do CACIC$ A atualiza"(o para a vers(o do CACIC+7$K tem tr<s pontos !sicos4
Aplica"(o Gerente 'servidor)
anco de dados
A%entes
O!serva"(o4 Antes de qualquer passo realize c&pia de se%uran"a '!acLup) de sua
instala"(o atual '%erente, a%entes, !anco de dados)$
Atuali/ao do 2erente
Jm uma instala"(o de vers(o anterior e*istente 'e*emplo4 CvarCwwwCcacic7) ser
necessrio so!rescrever os diret&rios e arquivos e*istentes com a nova vers(o
disponi!ilizada$
ai*ar a nova vers(o
e*emplo4 CACIC7$K'Curumin)%erente7$K$>$Mz
Descompactar o conte:do so!rescrevendo a instala"(o e*istente
e*emplo4 N Mz * CACIC7$K'Curumin)%erente7$K$>$Mz CvarCwww
Hesse ponto a instala"(o do %erente estar atualizada para a nova vers(o$
Atuali/ao do 3an$o de dados
A atualiza"(o de !anco de dados '-1S23) de vers#es anteriores dever(o utilizar os
scripts criados especificamente para esse fim$ Para cada vers(o disponi!ilizada
oficialmente h um scripts 'em formato sql) espec.fico de atualiza"(o$
Jsses scripts est(o dispon.veis no diret&rio cacic7CinstaladorCsql do CACIC+ %erente
conforme e*emplos a se%uir
cacicO;un7>>I$sql E para atualizar a vers(o4 Punho de 7>>I
cacicOfev7>>Q$sql E para atualizar a vers(o4 9evereiro de 7>>Q
cacicOv7$7$7$sql E para atualizar a vers(o4 7$7$7
Comandos !sicos para atualiza"(o do !anco de dados 'em console m1sql)4
Sinta*e4
N m1sql +u root HO-JOAHCOOCACIC R nomeOdoOarquivoOsqlOdeOversaoOatualizar
Modelo de Manual de Instalao, Administrao e Uso do <nome do software> 4
Logotipo
do
Sistema
Portal do Software Pblico Brasileiro
Administrao e +so do Sistema
A;ui de+er) ser descrito um how+to de como usar o sistema, confi$ura9es adicionais,
etc! #o+amente, ( de e&trema im,ortHncia o uso de ima$ens e&,licati+as ,ara facilitar a
com,reenso do usu)rio!
Modelo de Manual de Instalao, Administrao e Uso do <nome do software> 5
Logotipo
do
Sistema
Portal do Software Pblico Brasileiro
Lin, da Licena -ridica Creati$e Commons
http4CCcreativecommons$or%ClicensesC!1+saC7$IC!rCle%alcode
Modelo de Manual de Instalao, Administrao e Uso do <nome do software> 16
Logotipo
do
Sistema