path: root/trunk/doc/simplepkg.tex

\documentclass{article}
\usepackage[brazilian]{babel}
\usepackage[latin1]{inputenc}
\usepackage[dvips]{graphics}
\usepackage{hyperref}
\newcommand\link{\hyperlink}

\title{Gerenciamento de instala��es e metapacotes com o simplepkg}
\author{Silvio Rhatto}

\begin{document}\label{start}
\maketitle

\begin{abstract}
O \emph{simplepkg} � um sistema de gerenciamento de sistemas slackware que roda sobre o pkgtool. Ele � composto por v�rios scripts que desempenham fun��es de administra��o e desenvolvimento de sistemas do tipo Slackware, procurando fechar um circuito de produ��o, envolvendo a constru��o, a instala��o de pacotes e at� mesmo a instala��o do sistema de forma automatizada.

Do lado do desenvolvedor/a, ele ajuda na cria��o de SlackBuilds e constru��o de pacotes.  Do lado do administrador/a, ele possibilita a instala��o automatizada de sistemas, instala��o de pacotes e a cria��o de "templates" de instala��o -- que cont�m todos os arquivos de configura��o, informa��es de permiss�es e scripts de p�s-instala��o de uma dada m�quina ou jaula.
\end{abstract}

\section{Descri��o}

Todas as distribui��es de GNU/Linux j� tem algum sistema de empacotamento amadurecido. A quest�o agora � a praticidade de instalar e controlar o que est� instalado, tanto pacotes como arquivos de configura��o de uma m�quina, al�m da facilidade na cria��o de pacotes.

Imagine por exemplo se voc� precisa manter uma lista de pacotes de 200 m�quinas slackware, sendo que algumas s�o usadas como desktop, outras como servidores web, alguma sendo o servidor de email e assim por diante. Imagine agora que voc� perca o disco de algumas dessas m�quinas ou que precise cotidianamente reinstalar ou atualizar um sistema.

Usar o cd de instala��o do slackware e configurar na m�o toda a vez que der um pau faria com que voc� ficasse louco/a e desperdi�asse muito tempo, al�m do que sempre ocorre de esquecermos algum detalhe ou pacote durante a configura��o do sistema. Manter um backup completo de cada m�quina, por outro lado, pode ser muito custoso se o n�mero delas for muito grande.

O \emph{simplepkg} permite que voc� mantenha um template para cada grupo de m�quinas e com apenas um comando instalar o template numa parti��o. Al�m do template, voc� precisa configurar o \emph{simplepkg} para obter pacotes de um reposit�rio local ou remoto.

Gerenciar instala��es e pacotes n�o � tudo o que o \emph{simplepkg} faz. Ele pode ser usado at� na cria��o de jaula e vservers, podendo manter toda a configura��o das m�quinas num reposit�rio Subversion.

O \emph{simplepkg} funciona n�o apenas com o Slackware mas com qualquer port (oficial ou n�o) que siga minimamente os padr�es oficiais.

\section{Arquitetura}

O \emph{simplepkg} � um conjunto de scripts escritos com a filosofia KISS (Keep It Simple, Stupid) em mente.  Ele � um sistema muito simples, composto pelos seguintes comandos:

\begin{itemize}
  \item mkjail: constr�i uma jaula/instala��o de slackware numa pasta
  \item templatepkg: criar ou adiciona pacotes a um template
  \item lspkg: lista pacotes instalados
  \item jail-update: inverso do jail-commit
  \item jail-commit: atualiza o template
  \item rebuildpkg: reconstr�i um pacote a partir de sua entrada no /var/log/packages
  \item simplaret: obt�m pacotes de reposit�rios locais ou remotos
  \item createpkg: baixa, compila e empacota software de acordo com scripts presentes num reposit�rio
  \item repos: cria e mant�m reposit�rios
  \item mkbuild: cria scripts de constru��o de pacotes
\end{itemize}

\section{Instalando o simplepkg}

Para baixar o pacote do \emph{simplepkg}, v� em \link{http://slack.sarava.org/packages/noarch/}{http://slack.sarava.org/packages/noarch/}. Depois, basta usar o comando

\begin{verbatim}
installpkg simplepkg-VERSAO-noarch-BUILD.tgz
\end{verbatim}

\section{Usando o simplepkg}

As tr�s principais aplica��es desse conjunto s�o:

\begin{itemize}
  \item Gerenciamento de pacotes
  \item Cria��o e manuten��o de jaulas
  \item Cria��o de pacotes
\end{itemize}

O gerencamento de pacotes � feito atrav�s do simplaret, e por ser algo bem espec�fico est� detalhado no artigo correspondente. As se��es a seguir mostrar�o como o \emph{simplepkg} pode ser utilizado para criar e manter jaulas, assim como tamb�m criar pacotes.

\section{Criando templates de instala��o}

Originalmente, o \emph{simplepkg} foi desenvolvido para ajudar na automatiza��o de instala��es de sistemas slackware. Para isso, ele trabalha com templates -- listas com pacotes instalados, scripts e arquivos de configura��o -- permitindo criar perfis de instala��o que podem ser ent�o usados para instalar o sistema numa outra parti��o ou criar um chroot.

A constru��o de um template � feita atrav�s do programa templatepkg. Para criar um template de nome "meu-slackware" contendo a lista de pacotes atualmente instalados no seu sistema, digite

\begin{verbatim}
templatepkg -c meu-slackware
\end{verbatim}

A op��o -c (ou --create) criar� a pasta /etc/simplepkg/templates/meu-slackware, que conter� os seguintes componentes:

\begin{itemize}
  \item \emph{/etc/simplepkg/templates/meu-slackware/meu-slackware.d}: c�pia de arquivos de configura��o
  \item \emph{/etc/simplepkg/templates/meu-slackware/meu-slackware.s}: scripts de p�s-instala��o
  \item \emph{/etc/simplepkg/templates/meu-slackware/meu-slackware.perms}: informa��es sobre arquivos
  \item \emph{/etc/simplepkg/templates/meu-slackware/meu-slackware.template}: lista de pacotes
\end{itemize}

Esses quatro componentes s�o suficientes para armazenar todas as caracter�sticas de uma instala��o de slackware: a lista de pacotes controla o software instalado (a partir do conte�do da pasta \emph{/var/log/packages}), a c�pia dos arquivos de configura��o controla as personaliza��es feitas para o uso dos aplicativos e os scripts de p�s-instala��o cuidam de qualquer rotina que precisa ser realizada exatamente ap�s a instala��o do sistema. J� o arquivo de informa��es sobre arquivos cont�m as permiss�es, o dono/a e grupo de cada arquivo de configura��o presente no template.

Se voc� quiser criar um template a partir de uma instala��o de slackware presente numa outra parti��o do sistema que n�o seja a ra�z, basta usar um comando do tipo

\begin{verbatim}
templatepkg -c meu-slackware /mnt/slackware
\end{verbatim}

onde /mnt/slackware � o local onde o sistema alternativo est� instalado. Ap�s criado, o template possuir� apenas a lista de pacotes contendo o nome dos aplicativos instalados no seu sistema. Como a pasta /var/log/packages n�o preserva a ordem de instala��o dos pacotes, ent�o talvez voc� queira editar manualmente a lista de pacotes de um template. Para isso, use o comando

\begin{verbatim}
templatepkg -e meu-slackware
\end{verbatim}

Para adicionar um arquivo de configura��o no seu novo template, basta dar um comando como

\begin{verbatim}
templatepkg -a meu-slackware /etc/hosts
\end{verbatim}

Isso adicionar� o arquivo /etc/hosts no template "meu-slackware". Al�m de salvar o arquivo e copi�-lo automaticamente quando voc� instalar seu sistema, o \emph{simplepkg} ainda pode tomar conta de qualquer altera��o que o /etc/hosts sofrer no sistema, seja mudan�a no conte�do do arquivo, dono ou permiss�o. Se voc� ainda estiver armazenando seus templates num reposit�rio svn (o que veremos a seguir), o \emph{simplepkg} pode ainda manter um hist�rico completo das altera��es do arquivo.

ATEN��O: evite ao m�ximo deixar arquivos contendo senhas ou chaves privadas num template. O lugar mais adequado para deixar esse tipo de coisa � num backup seguro.

\section{Criando jaulas e replicando instala��es}

Uma vez que um template foi criado com uma lista de pacotes e opcionalmente com arquivos de configura��o e scripts de p�s-instala��o (que ser�o detalhados a seguir), voc� pode replicar sua instala��o de slackware utilizando o comando

\begin{verbatim}
mkjail jaula meu-slackware
\end{verbatim}

Isso cria uma nova �rvore do slackware em /vserver/jaula contendo todos os pacotes e arquivos de configura��o do template "meu-slackware". A instala��o dos pacotes ser� feita pelo aplicativo simplaret, que deve estar configurado corretamente e cuja configura��o padr�o deve funcionar para a maioria dos casos.

Se voc� quiser instalar essa jaula em outro local que n�o seja a pasta /vservers (esse local padr�o pode ser mudado pelo arquivo de configura��o do \emph{simplepkg}), basta usar um comando do tipo

\begin{verbatim}
ROOT=/mnt mkjail hda2 meu-slackware
\end{verbatim}

O comando acima faz exatamente o que voc� est� pensando: replica sua instala��o slackware em /mnt/hda2, dispensando totalmente o programa de instala��o do slackware!

Caso nenhum template for especificado, o mkjail utiliza o template /etc/simplepkg/default. O \emph{simplepkg} j� vem com alguns templates padr�es, presentes em /etc/simplepkg/defaults/template.

\section{Scripts de p�s-instala��o}

Opcionalmente, � poss�vel manter scripts de p�s-instala��o num template. Tais script s�o executados exatamente
ap�s a instala��o de uma jaula e c�pia de arquivos de configura��o pelo mkjail. Para criar ou editar um script
de p�s-instala��o, use um comando como

\begin{verbatim}
templatepkg -b meu-slackware nome-do-script.sh
\end{verbatim}

Isso adicionar� o script nome-do-script.sh no template "meu-slackware". O mkjail passa dois argumentos para cada script de p�s-instala��o: a pasta superior e o nome da jaula ("/mnt" e "hda2" no nosso exemplo anterior). Assim, um exemplo de script seria algo como

\begin{verbatim}
#!/bin/bash
chroot $1/$2/ sbin/ldconfig
\end{verbatim}

\section{Listando o conte�do de um template}

Para listar os templates dispon�veis ou o conte�do de um template, use comandos como

\begin{verbatim}
templatepkg -l
templatepkg -l meu-slackware
\end{verbatim}

\section{Removendo arquivos de um template}

Analogamente � forma como se adicona arquivos num template, remov�-los pode ser feito com o seguinte comando:

\begin{verbatim}
templatepkg -d meu-slackware /etc/hosts
\end{verbatim}

Isso remove o arquivo /etc/hosts do template "meu-slackware".

\section{Apagando um template}

Para apagar um template, basta utilizar um comando como

\begin{verbatim}
templatepkg -r meu-slackware
\end{verbatim}

\section{Atualizando um template}

Agora que j� abordamos as op��es do templatepkg, � hora de visitarmos um outro aplicativo, desta vez utilizado para manter um template atualizado. O jail-commit � um script que copia as altera��es dos arquivos (conte�do, propriedade e permiss�es) de um template a partir do conte�do de uma jaula ou instala��o.

Por exemplo, caso se queira copiar as altera��es da jaula /mnt/hda2 no template "meu-slackware", basta usar o comando

\begin{verbatim}
jail-commit /mnt/hda2 meu-slackware
\end{verbatim}

Al�m da lista de pacotes do template "meu-slackware" ser atualizada de acordo com a lista de pacotes presente em /mnt/hda2/var/log/packages, todos os arquivos de configura��o presentes no template "meu-slackware" ser�o comparados com os correspondentes da pasta /mnt/hda2 e as diferen�as s�o copiadas para o template. Da mesma forma, as permiss�es e informa��o de dono/grupo dos arquivos tamb�m � atualizada no template.

O comando jail-commit possibilita que um template sempre esteja atualizado e refletindo a configura��o atual de uma instala��o de slackware. Se voc� quiser atualizar apenas a lista de pacotes de um template, por�m, use

\begin{verbatim}
templatepkg -u meu-template
\end{verbatim}

Para facilitar ainda mais o controle das altera��es do sistema, existe ainda uma facilidade do arquivo /etc/simplepkg/jailist. Esse arquivo serve, al�m de outros prop�sitos descritos na documenta��o do simplaret, para que o jail-commit saiba de antem�o quais s�o as instala��es de sistema do tipo Slackware presentes numa m�quina, al�m da instala��o principal na ra�z do sistema.

Suponha que uma m�quina possua duas instala��es de slackware, al�m da principal (ra�z):

\begin{itemize}
  \item /mnt/slackware-1 usando o template "slackware-1"
  \item /mnt/slackware-2 usando o template "slackware-2"
\end{itemize}

Se o arquivo /etc/simplepkg/jailist contiver as seguintes linhas,

\begin{verbatim}
/mnt/slackware-1
/mnt/slackware-2
\end{verbatim}

ent�o o comando

\begin{verbatim}
jail-commit
\end{verbatim}

atualizar� o template "slackware-1" de acordo com o conte�do da jaula /mnt/slackware-1 e o template "slackware-2" com o conte�do da jaula /mnt/slackware-2. Se, al�m desses dois templates, existir um outro de nome "main", ent�o o jail-commit sem argumentos tamb�m copiar� as atualiza��es da instala��o ra�z, deixando-as no template "main".

Voc� pode inclusive colocar uma entrada no crontab do tipo

\begin{verbatim}
20 4 * * * jail-commit
\end{verbatim}

para que seus templates sejam atualizados diariamente. Se voc� ainda possui o envio de emails configurado na sua m�quina, ent�o a sa�da do jail-commit ser� enviada pelo cron diariamente para seu email, contendo diffs das altera��es de arquivos de configura��o a lista de pacotes adicionados ou removidos no sistema.

\section{Restaurando arquivos de configura��o numa jaula}

A opera��o contr�ria ao que o jail-commit faz tamb�m � poss�vel: suponha que voc� mexeu na configura��o do sistema mas se arrependeu das altera��es e deseja voltar a configura��o para o modo como ela se encontra no seu template, basta usar o comando

\begin{verbatim}
jail-update /mnt/hda2 meu-slackware
\end{verbatim}

\section{Armazenando as configura��es no reposit�rio Subversion}

Para aumentar ainda mais a flexibilidade e o controle do conte�do dos templates, � poss�vel armazen�-los num reposit�rio Subversion. Para isso, edite o arquivo /etc/simplepkg/simplepkg.conf e deixe o par�metro de configura��o \emph{TEMPLATES\_UNDER\_SVN} com o valor "yes".

Depois, crie um reposit�rio subversion para armazenar seus templates, usando algo como

\begin{verbatim}
svnadmin create /var/svn/simplepkg --fs-type fsfs
\end{verbatim}

Com o reposit�rio criado, basta importar seus templates com o comando

\begin{verbatim}
templatepkg -e file:///var/svn/simplepkg
\end{verbatim}

A partir da�, o comando jail-commit enviar� automaticamente todas as altera��es dos templates para o reposit�rio subversion. Se, por outro lado, voc� quiser baixar as altera��es dos templates que est�o no reposit�rio remoto para sua c�pia local, use o comando

\begin{verbatim}
templatepkg -s
\end{verbatim}

\section{Atualiza��o de jaulas}

A atualiza��o de jaulas e sistemas instalados � feita atrav�s do simplaret e tamb�m utiliza o arquivo /etc/simplepkg/jailist. Para mais informa��es a respeito, consulte a documenta��o do simplaret para mais detalhes.

\section{Arquiteturas e vers�es diferentes}

O \emph{simplepkg} foi idealizado para permitir que um mesmo template possa ser usado para criar jaulas de arquiteturas e vers�es diferentes de sistemas padr�o slackware. A atualiza��o desses sistemas tamb�m � unificada. Essa possibilidade s� � permitida se voc� usa o simplaret e n�o o swaret como ferramenta de obten��o de pacotes.

Por exemplo, para criar uma instala��o de slackware 10.1 (assumindo que suas defini��es de reposit�rios do /etc/simplepkg/repos.conf contenham locais com slack 10.1), basta usar o comando

\begin{verbatim}
VERSION=10.1 mkjail minha-jaula template-servidor
\end{verbatim}

Arquiteturas diferentes tamb�m podem ser usadas. Se voc� est� num sistema x86\_64 e quer instalar um slack 10.2 numa parti��o, experimente

\begin{verbatim}
ARCH=i386 VERSION=10.2 ROOT=/mnt mkjail hda2 meu-slackware
\end{verbatim}

Note que os templates independem de arquitetura e vers�o, j� que eles s� cont�m nomes de pacotes, arquivos de configura��o e scripts. Por isso, o templatepkg, o metapkg, o lspkg e o jail-update funcionam normalmente.

Para atualizar suas jaulas, o jail-upgrade checa antes qual a vers�o e arquitetura de cada uma de suas jaulas atrav�s do /etc/slackware-version correspondente e a partir disso aplica os patches da arquitetura e vers�o da mesma, usando para isso o simplaret (veja a documenta��o pr�pria).

Desse modo, mesmo que voc� tenha jaulas de vers�es e arquiteturas diversas, usar o comando "jail-upgrade" faz a atualiza��o sem problemas, desde que seus patches estejam organizados por arquitetura e vers�o, conforme � detalhado na documenta��o do simplaret, em http://slack.sarava.org/node/16.

\section{Criando um pacote de um template}

Se, por algum motivo, voc� quiser construir um pacote com o conte�do de um template, experimente o comando

\begin{verbatim}
templatepkg -p nome-do-template
\end{verbatim}

No entanto, o \emph{simplepkg} foi criado para que esse tipo de comportamento seja evitado, j� que � mais simples manter templates de configura��o do que pacotes contendo a configura��o de uma instala��o.

\section{Construindo pacotes}

At� aqui, apenas mostramos os aplicativos do \emph{simplepkg} usados para a manuten��o de instala��es de slackware. No entanto, uma das outras finalidades desta su�te � a constru��o de pacotes, o que � feita pelo programa createpkg, Como dito anteriormente, o createpkg: baixa, compila e empacota software de acordo com scripts presentes num reposit�rio de scripts, funcionando com um gerenciador de "ports" para slackware.

O createpkg pode funcionar com qualquer tipo de script de constru��o de pacotes (SlackBuilds) mas funcionar� melhor se os mesmos seguirem o padr�o descrito na p�gina

\begin{verbatim}
http://slack.sarava.org/wiki/Main/SlackBuilds
\end{verbatim}

Especificamente, o createpkg foi desenvolvido para utilizar os slackbuild dispon�veis em \link{http://slack.sarava.org/slackbuilds}{http://slack.sarava.org/slackbuilds}. O createpkg trabalha com reposit�rios do tipo subversion.

Para obter os scripts do reposit�rio do slack.sarava.org, digite

\begin{verbatim}
createpkg --sync
\end{verbatim}

Em seguida, voc� pode listas todos os scripts dispon�veis:

\begin{verbatim}
createpkg --list
\end{verbatim}

Para buscar por um pacote, use

\begin{verbatim}
createpkg --search latex2html
\end{verbatim}

No caso, a busca � feita pelo SlackBuild do aplicativo "latex2html". Suponha agora que voc� queira construir o pacote desse aplicativo:

\begin{verbatim}
createpkg latex2html
\end{verbatim}

O pacote resultante estar� na pasta /tmp ou no valor especificado pela vari�vel de ambiente \emph{\$REPOS}. Para criar e tamb�m instalar o pacote, basta

\begin{verbatim}
createpkg --install latex2html
\end{verbatim}

Se o pacote possuir depend�ncias listadas num arquivo slack-required e que n�o estiverem instaladas no sistema, o createpkg tentar� process�-las uma a uma antes de tentar construir o pacote desejado: se as depend�ncias n�o forem encontradas no reposit�rio de scripts, ent�o o createpkg tentar� baix�-las de um reposit�rio bin�rio atrav�s do simplaret. Se voc� n�o quiser que a resolu��o de depend�ncias seja seguida, use a op��o --no-deps.

Para mais detalhes de funcionamento, experimente o comando

\begin{verbatim}
createpkg --help
\end{verbatim}

ou ent�o acesse a p�gina http://slack.sarava.org/wiki/Main/SlackBuilds.

\section{Aplicativos auxiliares}

O \emph{simplepkg} acompanha ainda alguns aplicativos auxiliares:

\begin{itemize}
   \item lspkg: lista pacotes instalados
   \item rebuildpkg: reconstr�i um pacote a partir de sua entrada no /var/log/packages
   \item repos: cria e mant�m reposit�rios
   \item mkbuild: cria scripts de constru��o de pacotes
\end{itemize}

O comando lspkg � um utilit�rio simples para a visualiza��o de pacotes instalados no sistema. J� o rebuildpkg ajuda a recuperar pacotes instalados cujo tgz original foi perdido. O comando rebuildpkg reconstr�i um pacote a partir de uma entrada no /var/log/packages. O comando

\begin{verbatim}
rebuildpkg coreutils
\end{verbatim}

reconstr�i um pacote do coreutils usando os arquivos e as metainforma��es listadas no arquivo do /var/log/packages/ correspondente ao coreutils.

Por fim, os scripts repos e mkbuild s�o os que se encontram na etapa de maior desenvolvimento: repos cria um reposit�rio de pacotes a partir de uma pasta contendo pacotes do tipo pkgtool e o mkbuild � um aplicativo para auxiliar a cria��o de scripts de constru��o de pacotes que podem ser utilizados sozinhos ou pelo o createpkg.

\section{Par�metros de configura��o}

O arquivo de configura��o do \emph{simplepkg} � o /etc/simplepkg/simplepkg.conf. Ele cont�m par�metros de configura��o de todos os scripts, por�m neste texto n�o trataremos das op��es espec�ficas ao simplaret, as quais tem uma se��o espec�fica no artigo correspondente.

\begin{itemize}
  \item \emph{JAIL\_ROOT}: pasta padr�o onde as jaulas s�o criadas pelo mkjail. Valor padr�o: "/vservers".
  \item \emph{ADD\_TO\_JAIL\_LIST}: controla se uma jaula criada pelo mkjail deve ser adicionada automaticamente no arquivo /etc/simplepkg/jailist. O valor padr�o � "1" (habilitado).
  \item \emph{TEMPLATES\_UNDER\_SVN}: indica se os templates est�o armazenados num reposit�rio subversion.  O valor padr�o � "no" (n�o).
  \item \emph{TEMPLATE\_FOLDER}: indica qual � a pasta de templates. O valor padr�o � "/etc/simplepkg/templates" e n�o � recomend�vel alter�-lo.
  \item \emph{TEMPLATE\_STORAGE\_STYLE}: controla a forma de armazenamento de templates. O valor padr�o � "own-folder" e essa op��o apenas deve ser modificada se voc� armazena seus templates num formato antigo do \emph{simplepkg} e deseja manter compatibilidade.
\end{itemize}

Vale lembrar que todas as op��es booleanas (isto �, que podem ser apenas habilitadas ou desabilitadas) do simplepkg.conf tem os seguintes valores permitidos: "1" e "yes" para habilitado e "0" ou "no" para desabilitado.

\section{Mais informa��es}

O \emph{simplepkg} foi escrito por Silvio Rhatto (rhatto at riseup.net) sob licen�a GPL e seu c�digo fonte � disponibilizado atrav�s do reposit�rio subversion:

\begin{verbatim}
svn checkout svn://slack.sarava.org/simplepkg
\end{verbatim}

O wiki de desenvolvimento: http://slack.sarava.org/wiki/Main/SimplePKG e o endere�o da lista de discuss�o utilizada para discuss�es sobre o \emph{simplepkg} ou mesmo distribui��es e pacotes do tipo Slackware � http://listas.sarava.org/wws/info/slack.

\end{document}