<?xml version="1.0" encoding="ISO8859-1" standalone="no"?>
<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook XML V4.2-Based Extension//EN"
	"../../../share/sgml/freebsd42.dtd" [
<!ENTITY % entities PUBLIC "-//FreeBSD//ENTITIES DocBook FreeBSD Entity Set//FR" "../../share/sgml/entities.ent">
%entities;
]>

<!--
    The FreeBSD Documentation Project
    The FreeBSD French Documentation Project

    $FreeBSD$
    Original revision: 1.2
-->

<article lang="fr">

  <articleinfo>
    <title>Introduction &agrave; NanoBSD</title>

    <authorgroup>
      <author>
	<firstname>Daniel</firstname>
	<surname>Gerzo</surname>
	<!-- 14 March 2006 -->
      </author>
    </authorgroup>

    <copyright>
      <year>2006</year>
      <holder>The FreeBSD Documentation Project</holder>
    </copyright>

    <legalnotice id="trademarks" role="trademarks">
      &tm-attrib.freebsd;
      &tm-attrib.general;
    </legalnotice>

    <pubdate>$FreeBSD$</pubdate>

    <releaseinfo>$FreeBSD$</releaseinfo>

    <abstract>
      <para>Ce document fournit des informations &agrave; propos des
	outils <application>NanoBSD</application>, qui peuvent
	�tre utilis�s pour cr�er des images du
	syst�me &os; pour des applications embarqu�es,
	adapt�es pour utiliser comme support une carte Compact
	Flash (ou tout autre support de stockage).</para>
        &trans.a.tignon;
    </abstract>
  </articleinfo>

  <sect1 id="intro">
    <title>Introduction &agrave; NanoBSD</title>

    <indexterm><primary>NanoBSD</primary></indexterm>

    <para><application>NanoBSD</application> est un outil actuellement
      d�velopp� par &a.phk;.  Il permet de cr�er
      une image du syst�me &os; pour des applications
      embarqu�es, pouvant utiliser une carte Compact Flash
      comme support (ou un autre support de stockage)</para>

    <para>Il peut �tre utilis� pour cr�er des
      images d'installation sp�cialis�es, con�ues
      pour une installation et une maintenance ais�es de
      syst�mes commun�ment appel�s
      <quote>appliances</quote>.  Les appliances ont leur
      mat�riel et leur logiciel int�gr�s dans le
      produit, ce qui signifie que toutes les applications sont
      pr�-install�es.  L'appliance est connect�e
      &agrave; un r�seau existant et peut entrer en fonction
      (presque) imm�diatement.</para>

    <para>Les fonctionnalit�s de
      <application>NanoBSD</application> incluent:</para>

    <itemizedlist>
      <listitem>
	<para>Les logiciels port�s et les paquetages
	  fonctionnent comme sous &os; &mdash; Chaque application peut
	  �tre install�e et utilis�e dans une
	  image <application>NanoBSD</application>, de la m�me
	  fa�on que sous &os;.</para>
      </listitem>

      <listitem>
	<para>Aucune fonctionnalit� ne manque &mdash; S'il est
	  possible de faire quelque chose avec &os;, il sera possible
	  de faire la m�me chose avec
	  <application>NanoBSD</application>, sauf si la
	  fonctionnalit� sp�cifique ou des
	  fonctionnalit�s ont �t� explicitement
	  supprim�es de l'image
	  <application>NanoBSD</application> lors de sa
	  cr�ation.</para>
      </listitem>

      <listitem>
	<para>Tout est en lecture seule pendant l'ex�cution
	  &mdash; D�brancher le cordon d'alimentation est sans
	  danger.  Il n'est pas n�cessaire d'ex�cuter
	  &man.fsck.8; apr�s un arr�t inopin� du
	  syst�me.</para>
      </listitem>

      <listitem>
	<para>Facile &agrave; cr�er et &agrave; personnaliser
	  &mdash; A l'aide d'une seule proc�dure et d'un
	  fichier de configuration il est possible de cr�er des
	  images personnalis�es et de taille r�duite
	  r�pondant &agrave; n'importe quel type de
	  besoin.</para>
      </listitem>
    </itemizedlist>
  </sect1>

  <sect1 id="howto">
    <title>Comment utiliser NanoBSD</title>

    <sect2 id="design">
      <title>L'organisation de NanoBSD</title>

      <para>Une fois que l'image est pr�sente sur le support,
	il est possible de d�marrer
	<application>NanoBSD</application>.  Le
	p�riph�rique de stockage est divis� en
	trois parties par d�faut:</para>

      <itemizedlist>
	<listitem>
	  <para>Deux partitions image: <literal>code#1</literal>
	    et <literal>code#2</literal>.</para>
	</listitem>

	<listitem>
	  <para>La partition de configuration, qui peut �tre
	    mont�e sur le r�pertoire <filename
	    class="directory">/cfg</filename> &agrave;
	    l'ex�cution.</para>
	</listitem>
      </itemizedlist>

      <para>Ces partitions sont normalement mont�es en lecture
	seule.</para>

      <para>Les r�pertoires <filename
	role="directory">/etc</filename> et <filename
	role="directory">/var</filename> sont des disques &man.md.4;
	(malloc).</para>

      <para>La partition de configuration est mont�e sur le
	r�pertoire <filename role="directory">/cfg</filename>.
	Elle contient les fichiers du r�pertoire <filename
	role="directory">/etc</filename> et est bri�vement
	mont�e en lecture seule juste apr�s le
	d�marrage du syst�me, par cons�quent il
	est n�cessaire de recopier les fichiers modifi�s
	de <filename role="directory">/etc</filename> vers le
	r�pertoire <filename role="directory">/cfg</filename>
	si l'on souhaite que les changements soient encore effectifs
	apr�s le red�marrage du syst�me.</para>

      <example>
	<title>Apporter des changements permanents &agrave;
	  <filename>/etc/resolv.conf</filename></title>

	<screen>&prompt.root; <userinput>vi /etc/resolv.conf</userinput>
[...]
&prompt.root; <userinput>mount /cfg</userinput>
&prompt.root; <userinput>cp /etc/resolv.conf /cfg</userinput>
&prompt.root; <userinput>umount /cfg</userinput></screen>
      </example>

      <note>
	<para>La partition qui abrite <filename
	  role="directory">/cfg</filename> doit �tre
	  mont�e uniquement au d�marrage et lors de la
	  copie des fichiers de configuration.</para>

	<para>Garder <filename role="directory">/cfg</filename>
	  mont� en permanence n'est pas une bonne id�e,
	  en particulier si le syst�me
	  <application>NanoBSD</application> tourne sur un
	  p�riph�rique de stockage qui peut �tre
	  endommag� par un grand nombre d'�critures sur
	  la partition (c'est &agrave; dire quand le contenu des
	  tampons de donn�es est transf�r� sur
	  les disques).</para>
      </note>
    </sect2>

    <sect2>
      <title>Cr�er une image NanoBSD</title>

      <para>Une image <application>NanoBSD</application> est
	cr��e &agrave; l'aide d'une simple
	proc�dure <filename>nanobsd.sh</filename>, qui peut
	�tre trouv�e dans le r�pertoire <filename
	role="directory"><replaceable>/usr</replaceable>/src/tools/tools/nanobsd</filename>.
	Ce programme cr�e une image, qui peut �tre
	copi�e sur le support de stockage &agrave; l'aide de
	&man.dd.1;.</para>

      <para>Les commandes n�cessaires &agrave; la
	cr�ation d'une image <application>NanoBSD</application>
	sont:</para>

      <screen>&prompt.root; <userinput>cd /usr/src/tools/tools/nanobsd</userinput> <co id="nbsd-cd"/>
&prompt.root; <userinput>sh nanobsd.sh</userinput> <co id="nbsd-sh"/>
&prompt.root; <userinput>cd /usr/obj/nanobsd.full</userinput> <co id="nbsd-cd2"/>
&prompt.root; <userinput>dd if=_.disk.full of=/dev/da0 bs=64k</userinput> <co id="nbsd-dd"/></screen>

      <calloutlist>
	<callout arearefs="nbsd-cd">
	  <para>Se placer dans le r�pertoire de base du
	    programme de cr�ation de
	    <application>NanoBSD</application>.</para>
	</callout>

	<callout arearefs="nbsd-sh">
	  <para>D�marrer le processus de
	    cr�ation.</para>
	</callout>

	<callout arearefs="nbsd-cd2">
	  <para>Se placer dans le r�pertoire o� les
	    images ont �t� cr�ees.</para>
	</callout>

	<callout arearefs="nbsd-dd">
	  <para>Installer <application>NanoBSD</application> sur le
	    support de stockage.</para>
	</callout>
      </calloutlist>
    </sect2>

    <sect2>
      <title>Personnaliser une image NanoBSD</title>

      <para>C'est probablement la fonctionnalit� la plus
	importante et la plus int�ressante de
	<application>NanoBSD</application>.  C'est aussi l&agrave;
	o� vous passerez le plus de temps lors de vos
	d�veloppements avec
	<application>NanoBSD</application>.</para>

      <para>L'invocation de la commande suivante va obliger
	<filename>nanobsd.sh</filename> &agrave; lire sa configuration
	dans le fichier <filename>myconf.nano</filename> situ�
	dans le r�pertoire courant:</para>

      <screen>&prompt.root; <userinput>sh nanobsd.sh -c myconf.nano</userinput></screen>

      <para>La personnalisation est effectu�e de 2
	fa�ons:</para>

      <itemizedlist>
	<listitem>
	  <para>&agrave; l'aide d'options de configuration</para>
	</listitem>

	<listitem>
	  <para>&agrave; l'aide de fonctions de
	    personnalisation</para>
	</listitem>
      </itemizedlist>

      <sect3>
	<title>Les options de configuration</title>

	<para>Grace aux param�tres de configuration, il est
	  possible de configurer des options qui sont pass�es
	  aux �tapes <literal>buildworld</literal> et
	  <literal>installworld</literal> du processus de compilation
	  de <application>NanoBSD</application>, ainsi que des options
	  internes qui sont pass�es au processus principal de
	  compilation de <application>NanoBSD</application>.  A l'aide
	  de ces options, il est possible de diminuer la taille du
	  syst�me, de fa�on &agrave; ce qu'il tienne
	  dans 64Mo.  Vous pouvez utiliser les options de
	  configuration pour r�duire encore plus &os;,
	  jusqu'&agrave; ce qu'il ne consiste plus qu'en un noyau et 2
	  ou 3 fichiers dans le syst�me de base.</para>

	<para>Le fichier de configuration consiste en une s�rie
	  d'options de configuration, qui surchargent les valeurs par
	  d�faut.  Les directives les plus importantes
	  sont:</para>

	<itemizedlist>
	  <listitem>
	    <para><literal>NANO_NAME</literal> &mdash; Nom de
	      compilation (utilis� pour cr�er le nom des
	      r�pertoires de travail).</para>
	  </listitem>

	  <listitem>
	    <para><literal>NANO_SRC</literal> &mdash; Chemin de
	      l'arbre des sources utilis� pour construire
	      l'image.</para>
	  </listitem>

	  <listitem>
	    <para><literal>NANO_KERNEL</literal> &mdash; Nom du
	      fichier de configuration utilis� pour compiler le
	      noyau.</para>
	  </listitem>

	  <listitem>
	    <para><literal>CONF_BUILD</literal> &mdash; Options
	      pass�es &agrave; la phase
	      <literal>buildworld</literal> de la compilation.</para>
	  </listitem>

	  <listitem>
	    <para><literal>CONF_INSTALL</literal> &mdash; Options
	      pass�es &agrave; la phase
	      <literal>installworld</literal> de la
	      compilation.</para>
	  </listitem>

	  <listitem>
	    <para><literal>CONF_WORLD</literal> &mdash; Options
	      pass�es aux �tapes
	      <literal>buildworld</literal> et
	      <literal>installworld</literal>.</para>
	  </listitem>

	  <listitem>
	    <para><literal>FlashDevice</literal> &mdash;
	      D�finit le type de support &agrave; utiliser.
	      Consulter le fichier
	      <filename>FlashDevice.sub</filename> pour plus de
	      d�tails.</para>
	  </listitem>
	</itemizedlist>
      </sect3>

      <sect3>
	<title>Les fonctions de personnalisation</title>

	<para>Il est possible d'optimiser
	  <application>NanoBSD</application> en utilisant des
	  fonctions d'interpr�teur de commandes dans le fichier
	  de configuration.  L'exemple suivant pr�sente la
	  trame de base des fonctions de personnalisation:</para>

	  <programlisting>cust_foo () (
	echo "bar=topless" &gt; \
		&dollar;{NANO_WORLDDIR}/etc/foo
)
customize_cmd cust_foo</programlisting>

	<para>Un exemple plus utile de fonction de personnalisation
	  est le suivant, qui change la taille par d�faut du
	  r�pertoire <filename role="directory">/etc</filename>
	  de 5Mo &agrave; 30Mo:</para>

	<programlisting>cust_etc_size () (
	cd &dollar;{NANO_WORLDDIR}/conf
	echo 30000 &gt; default/etc/md_size
)
customize_cmd cust_etc_size</programlisting>

	<para>Il existe par d�faut quelques fonctions de
	  personnalisation pr�d�finies et pr�tes
	  &agrave; �tre utilis�es:</para>

	<itemizedlist>
	  <listitem>
	    <para><literal>cust_comconsole</literal> &mdash;
	      D�sactive &man.getty.8; sur les consoles VGA (les
	      p�riph�riques
	      <filename>/dev/ttyv*</filename>) et param�tre la
	      console syst�me sur le port s�rie
	      COM1.</para>
	  </listitem>

	  <listitem>
	    <para><literal>cust_allow_ssh_root</literal> &mdash;
	      Autorise l'ouverture de sessions
	      <username>root</username> via &man.sshd.8;.</para>
	  </listitem>

	  <listitem>
	    <para><literal>cust_install_files</literal> &mdash;
	      Installe les fichiers du r�pertoire <filename
	      role="directory">nanobsd/Files</filename>, qui contient
	      des programmes utiles pour l'administration
	      syst�me.</para>
	  </listitem>
	</itemizedlist>
      </sect3>

      <sect3>
	<title>Exemple de fichier de configuration</title>

	<para>Un exemple complet de fichier de configuration pour
	  cr�er une image <application>NanoBSD</application>
	  personnalis�e peut �tre:</para>

	<programlisting>NANO_NAME=custom
NANO_SRC=/usr/src
NANO_KERNEL=MYKERNEL
NANO_IMAGES=2

CONF_BUILD='
NO_KLDLOAD=YES
NO_NETGRAPH=YES
NO_PAM=YES
'

CONF_INSTALL='
NO_ACPI=YES
NO_BLUETOOTH=YES
NO_CVS=YES
NO_FORTRAN=YES
NO_HTML=YES
NO_LPR=YES
NO_MAN=YES
NO_SENDMAIL=YES
NO_SHAREDOCS=YES
NO_EXAMPLES=YES
NO_INSTALLLIB=YES
NO_CALENDAR=YES
NO_MISC=YES
NO_SHARE=YES
'

CONF_WORLD='
NO_BIND=YES
NO_MODULES=YES
NO_KERBEROS=YES
NO_GAMES=YES
NO_RESCUE=YES
NO_LOCALES=YES
NO_SYSCONS=YES
NO_INFO=YES
'

FlashDevice SanDisk 1G

cust_nobeastie() (
	touch &dollar;{NANO_WORLDDIR}/boot/loader.conf
	echo "beastie_disable=\"YES\"" &gt;&gt; &dollar;{NANO_WORLDDIR}/boot/loader.conf
)

customize_cmd cust_comconsole
customize_cmd cust_install_files
customize_cmd cust_allow_ssh_root
customize_cmd cust_nobeastie</programlisting>
      </sect3>
    </sect2>

    <sect2>
      <title>Mettre &agrave; jour NanoBSD</title>

      <para>Le processus de mise &agrave; jour de
	<application>NanoBSD</application> est relativement
	simple:</para>

      <procedure>
	<step>
	  <para>Cr�er une nouvelle image
	    <application>NanoBSD</application>, comme
	    d'habitude.</para>
	</step>

	<step>
	  <para>T�l�charger la nouvelle image dans une
	    partition inutilis�e d'une appliance
	    <application>NanoBSD</application>
	    op�rationnelle.</para>

	  <para>La diff�rence la plus importante de cette
	    �tape par rapport &agrave; l'installation initiale
	    de <application>NanoBSD</application> est que maintenant
	    au lieu d'utiliser le fichier
	    <filename>_.disk.full</filename> (qui contient une image
	    de la totalit� du disque), l'image
	    <filename>_.disk.image</filename> est install�e
	    (qui contient seulement l'image d'une seule partition
	    syst�me).</para>
	</step>

	<step>
	  <para>Red�marrer le syst�me sur la nouvelle
	    partition.</para>
	</step>

	<step>
	  <para>Si tout s'est bien pass�, la mise &agrave; jour
	    est termin�e.</para>
	</step>

	<step>
	  <para>Si quelque chose s'est mal pass�,
	    red�marrez de nouveau sur la partition
	    pr�c�dente (qui contient l'ancienne image,
	    fonctionnelle celle-ci), pour remettre le syst�me
	    en �tat de marche le plus rapidement possible.
	    Corriger les probl�mes de la nouvelle image, et
	    r�p�ter le processus.</para>
	</step>
      </procedure>

      <para>Pour installer la nouvelle image sur le syst�me
	<application>NanoBSD</application> op�rationnel, il est
	possible d'utiliser la proc�dure
	<filename>updatep1</filename> ou <filename>updatep2</filename>
	situ�e dans le r�pertoire <filename
	role="directory">/root</filename>, en fonction de la partition
	qui est en cours d'utilisation sur le syst�me.</para>

      <para>En fonction des services disponibles sur la machine qui
	dispose de la nouvelle image
	<application>NanoBSD</application> et du type de transfert qui
	est pr�f�r�, il est possible d'utiliser
	une de ces trois m�thodes:</para>

      <sect3>
	<title>Utiliser &man.ftp.1;</title>

	<para>Si la vitesse de transfert est la priorit�,
	  utiliser cet exemple:</para>

	<screen>&prompt.root; <userinput>ftp myhost
get _.disk.image "| sh updatep1"</userinput></screen>
      </sect3>

      <sect3>
	<title>Utiliser &man.ssh.1;</title>

	<para>Si un transfert s�curis� est
	  pr�f�rable, consid�rer l'utilisation de
	  cet exemple:</para>

	<screen>&prompt.root; <userinput>ssh myhost cat _.disk.image.gz | zcat | sh updatep1</userinput></screen>
      </sect3>

      <sect3>
	<title>Utiliser &man.nc.1;</title>

	<para>Utiliser cet exemple si la machine distante n'utilise ni
	  &man.ftp.1; ni &man.sshd.8;:</para>

	<procedure>
	  <step>
	    <para>Tout d'abord, ouvrez un �couteur TCP sur la
	      machine qui dispose de l'image et faites-lui envoyer
	      l'image au client:</para>

	    <screen>myhost&prompt.root; <userinput>nc -l <replaceable>2222</replaceable> &lt; _.disk.image</userinput></screen>

	    <note>
	      <para>Assurez vous que le port utilis� n'est pas
		bloqu� par un pare-feu afin de recevoir les
		connexions entrantes de la machine
		<application>NanoBSD</application>.</para>
	    </note>
	  </step>
	  <step>
	    <para>Se connecter &agrave; la machine qui dispose de la
	      nouvelle image et ex�cuter la proc�dure
	      <filename>updatep1</filename>:</para>

	    <screen>&prompt.root; <userinput>nc myhost <replaceable>2222</replaceable> | sh updatep1</userinput></screen>
	  </step>
	</procedure>
      </sect3>
    </sect2>
  </sect1>
</article>