Add how to boot and Docker installer description

Signed-off-by: Adrian Calianu <adrian.calianu@enea.com>

1 files changed, 107 insertions, 246 deletions

diff --git a/doc/book-enea-nfv-access-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-guide/doc/getting_started.xml
index 65888bf..6c3db86 100644
--- a/doc/book-enea-nfv-access-guide/doc/getting_started.xml
+++ b/doc/book-enea-nfv-access-guide/doc/getting_started.xml
@@ -1,46 +1,15 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <chapter id="plat-release-content">
   <title>Getting Started with Enea NFV Access</title>
 
   <para>Using Enea NFV Access requires access to a Linux machine, which is
-  used for preparing a bootable drive or for developing applications. System
+  used for preparing a boot setup or for developing applications. System
   requirements for the development host are detailed in the <xi:include
   href="../../s_docbuild/olinkdb/pardoc-common.xml"
   xmlns:xi="http://www.w3.org/2001/XInclude"
-  xpointer="element(book_enea_nfv_access_release_info/1)" />.</para>
-
-  <section id="sysshell_config">
-    <title>Default Shell Configuration</title>
-
-    <para>Before installing Enea NFV Access, make sure that bash is the
-    default shell.</para>
-
-    <para><emphasis role="bold">To verify the default system
-    shell</emphasis></para>
-
-    <itemizedlist>
-      <listitem>
-        <para>If your system runs Ubuntu, use list to verify if
-        <filename>/usr/bin</filename> is a symbolic link to <emphasis
-        role="bold">bash</emphasis>:</para>
-
-        <programlisting># ls -l /bin/sh
-lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -&gt; bash</programlisting>
-      </listitem>
-
-      <listitem>
-        <para>Optionally, in case the link points to <literal>dash</literal>,
-        change it through the following steps:</para>
-
-        <programlisting># ls -l /bin/sh
-lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -&gt; dash
-# sudo dpkg-reconfigure dash
-Use dash as the default system shell (/bin/sh)? No</programlisting>
-      </listitem>
-    </itemizedlist>
-  </section>
+  xpointer="element(book_enea_nfv_access_release_info/1)" /></para>
 
   <section condition="hidden" id="release-content">
     <title>NFV Access Release content</title>
@@ -91,7 +60,7 @@ Use dash as the default system shell (/bin/sh)? No</programlisting>
     <para>For each combination of image and target, the following set of
     artifacts is available:</para>
 
-    <programlisting>-- bzImage
+    <programlisting format="linespecific">-- bzImage
    /* kernel image */
 -- bzImage-&lt;target&gt;.bin
    /* kernel image, same as above */
@@ -130,216 +99,108 @@ Use dash as the default system shell (/bin/sh)? No</programlisting>
   <section condition="hidden" id="prebuilt-artifacts">
     <title>How to use the Prebuilt Artifacts</title>
 
-    <section id="boot-ramdisk">
-      <title>Booting Enea NFV Access using RAMDISK</title>
-
-      <para>There may be use cases, especially at first target ramp-up, where
-      the HDD/SDD has no partitions and you need to prepare the disks for
-      boot. Booting from ramdisk can help with this task.</para>
-
-      <para>The prerequisites needed to proceed:</para>
-
-      <itemizedlist>
-        <listitem>
-          <para>Enea NFV Access ext4 rootfs image -
-          enea-nfv-access-inteld1521.ext4.gz</para>
-        </listitem>
-
-        <listitem>
-          <para>Enea NFV Access kernel image - bzImage</para>
-        </listitem>
-
-        <listitem>
-          <para>BIOS has PXE boot enabled</para>
-        </listitem>
-
-        <listitem>
-          <para>PXE/tftp server configured and connected (ethernet) to
-          target.</para>
-        </listitem>
-      </itemizedlist>
-
-      <para>Unzip enea-nfv-access-inteld1521.ext4 and copy bzImage and
-      enea-nfv-access-inteld1521.ext4 images to the tftpserver configured for
-      PXE boot.</para>
-
-      <para>Use the following as an example for the PXE configuration
-      file:</para>
-
-      <programlisting>default vesamenu.c32
-prompt 1
-timeout 0
-
-label el_ramfs
-    menu label ^EneaLinux_RAMfs
-    kernel bzImage
-    append root=/dev/ram0 initrd=enea-nfv-access-inteld1521.ext4 /
-    ramdisk_size=1200000 console=ttyS0,115200 eralyprintk=ttyS0,115200</programlisting>
-
-      <para>Restart the target. Then enter (F11) in the Boot Menu and select
-      the Ethernet interface used for PXE boot. From the PXE Boot Menu select
-      <emphasis role="bold">Enea NFV Access_RAMfs</emphasis>. Once the Enea
-      NFV Access is started you can partition the HDD/SDD and install GRUB as
-      described in in the following section.</para>
-    </section>
-
-    <section id="install-grub">
-      <title>Partitioning a new harddisk and installing GRUB</title>
-
-      <para>The prerequisites needed:</para>
-
-      <itemizedlist>
-        <listitem>
-          <para>grub (<literal>grub-efi-bootx64.efi</literal>) - availalble as
-          a pre-built artifact under
-          <literal>inteld1521/images/enea-nfv-access</literal>.</para>
-        </listitem>
-
-        <listitem>
-          <para><literal>e2fsprogs-mke2fs_1.43.4-r0.0_amd64.deb,/</literal></para>
-
-          <para><literal>dosfstools_4.1-r0.0_amd64.deb</literal> - available
-          under <literal>inteld1521/deb</literal>.</para>
-        </listitem>
-      </itemizedlist>
-
-      <para>Proceed using the following steps:</para>
-
-      <orderedlist>
-        <listitem>
-          <para>Boot target with Enea NFV Access from RAMDISK</para>
-        </listitem>
-
-        <listitem>
-          <para>Install prerequisite packages:</para>
-
-          <programlisting>&gt; dpkg -i e2fsprogs-mke2fs_1.43.4-r0.0_amd64.deb
-&gt; dpkg -i dosfstools_4.1-r0.0_amd64.deb</programlisting>
-        </listitem>
-
-        <listitem>
-          <para>Partition the disk:</para>
-
-          <programlisting>&gt; fdisk /dev/sda
-fdisk&gt; g   {GPT partition type}
-fdisk&gt; n
-fdisk&gt; 1
-fdisk&gt;     {default start part}
-fdisk&gt; +512M
-fdisk&gt; t
-fdisk&gt; 1 {ESP/EFI partition}
-fdisk&gt; n
-fdisk&gt; 2
-fdisk&gt;    {default start part}
-fdisk&gt; +18G
-fdisk&gt; 3
-fdisk&gt;    {default start part}
-fdisk&gt; +20G
-...
-fdisk&gt; 7
-fdisk&gt;  {default start part}
-fdisk&gt;  {default end end part}
-
-fdisk&gt; p  {print partion table}
-fdisk&gt; w   {write to disk}
-fdisk&gt; q</programlisting>
-        </listitem>
-
-        <listitem>
-          <para>Format the partitions:</para>
-
-          <programlisting>&gt; mkfs.fat -F32 -nEFI /dev/sda1
-&gt; mkfs.ext4 -LROOT /dev/sda2
-&gt; mkfs.ext4 -LROOT /dev/sda3
-&gt; mkfs.ext4 -LROOT /dev/sda4
-&gt; mkfs.ext4 -LROOT /dev/sda5
-&gt; mkfs.ext4 -LROOT /dev/sda6
-&gt; mkfs.ext4 -LROOT /dev/sda7</programlisting>
-        </listitem>
-
-        <listitem>
-          <para>Create a GRUB partition:</para>
-
-          <programlisting>&gt; mkdir /mnt/boot
-&gt; mount /dev/sda1 /mnt/boot
-&gt; mkdir -p /mnt/boot/EFI/boot
-
-&gt; cp grub-efi-bootx64.efi /mnt/boot/EFI/boot/bootx64.efi
-&gt; vi /mnt/boot/EFI/boot/grub.cfg
-default=1
-
-menuentry "Linux Reference Image" {
-  linux (hd0,gpt2)/boot/bzImage root=/dev/sda2 ip=dhcp
-}
-
-menuentry "Linux sda3" {
-  linux (hd0,gpt3)/boot/bzImage root=/dev/sda3 ip=dhcp
-}
-
-menuentry "Linux sda4" {
-  linux (hd0,gpt4)/boot/bzImage root=/dev/sda4 ip=dhcp
-}
-
-menuentry "Linux sda5" {
-  linux (hd0,gpt5)/boot/bzImage root=/dev/sda5 ip=dhcp
-}
-
-menuentry "Linux sda6" {
-  linux (hd0,gpt6)/boot/bzImage root=/dev/sda6 ip=dhcp
-}
-
-menuentry "Linux sda7" {
-  linux (hd0,gpt7)/boot/bzImage root=/dev/sda7 ip=dhcp
-}</programlisting>
-        </listitem>
-      </orderedlist>
-    </section>
-
-    <section id="boot-hdd">
-      <title>Installing and booting Enea NFV Access on the harddisk</title>
-
-      <para>After partitioning the harddisk, boot Enea NFV Access from RAMFS
-      or from a reference image installed on one of the partitions.</para>
-
-      <para>To install Enea NFV Access image on a partition follow these
-      steps:</para>
-
-      <orderedlist>
-        <listitem>
-          <para>Copy your image on target:</para>
-
-          <programlisting>server&gt; scp ./enea-nfv-access-inteld1521.tar.gz /
-root@&lt;target_ip&gt;:/home/root/</programlisting>
-        </listitem>
-
-        <listitem>
-          <para>Extract image onto the desired partition:</para>
-
-          <programlisting>target&gt; mount /dev/sda3 /mnt/sda
-target&gt; tar -pzxf /home/root/enea-nfv-access-inteld1521.tar.gz /
--C /mnt/sda</programlisting>
-
-          <para>Alternately, you can do both steps in one command from the
-          server:</para>
-
-          <programlisting>server&gt; cat ./enea-nfv-access-inteld1521.tar.gz | /
-ssh root@&lt;target_ip&gt; "cd /mnt/sda6; tar -zxf -"</programlisting>
-        </listitem>
-
-        <listitem>
-          <para>Reboot</para>
-        </listitem>
-
-        <listitem>
-          <para>From the GRUB menu select your partition</para>
-        </listitem>
-      </orderedlist>
-
-      <note>
-        <para>In order to change kernel boot parameters you need to mount the
-        GRUB partition (i.e. <literal>/dev/sda1</literal>) and change the
-        <literal>EFI/boot/grub.cfg</literal> file.</para>
-      </note>
+    <section id="sysshell_config">
+      <title>Booting NFV Access to RAM</title>
+
+      <para>NFV Access can be booted on target using the RAMDISK images.
+      Following is described how to prepare the environment and configure
+      bootloader(U-Boot), load and boot the NFV Access on target. Please check
+      the <link linkend="boot_prereq">Prerequisites</link> subchapter before
+      starting boot process.</para>
+
+      <para>Connect to target over serial and stop default boot process in
+      U-Boot command line interface. Set U-Boot network configuration for the
+      ethernet port which connects the target to the network. If target is not
+      connected on a specific network, Enea provides DHCP and TFTP servers.
+      Please see <link linkend="boot_docker">Docker Installer</link>
+      subchapter about how to install them on a development host.</para>
+
+      <programlisting>&gt; setenv ethact    &lt;vnic0/vnic1&gt;
+&gt; setenv gatewayip &lt;GatewayIP&gt;
+&gt; setenv serverip  &lt;TFTPserverIP&gt;
+&gt; setenv netmask   &lt;netmask&gt;
+&gt; setenv ipaddr    &lt;target IP&gt;</programlisting>
+
+      <para>Boot NFV Access images:</para>
+
+      <programlisting>&gt; tftpboot $kernel_addr Image 
+&gt; setenv rootfs_addr 0x60000000
+&gt; tftpboot $rootfs_addr enea-nfv-access-cn8304.ext4.gz.u-boot
+&gt; booti $kernel_addr $rootfs_addr $fdtcontroladdr
+&gt; setenv bootargs root=/dev/ram0 rw ramdisk_size=1000000 console=ttyAMA0,115200n8 earlycon=pl011,0x87e028000000 coherent_pool=16M</programlisting>
+
+      <section id="boot_prereq">
+        <title>Prerequisites:</title>
+
+        <itemizedlist>
+          <listitem>
+            <para>NFV Acccess images - see NFV Access release content</para>
+          </listitem>
+        </itemizedlist>
+
+        <itemizedlist>
+          <listitem>
+            <para>DHCP server - If the board is not connected into a specific
+            network Enea provides a docker image with DHCP server. Please see
+            <link linkend="boot_docker">Docker Installer</link>
+            subchapter.</para>
+          </listitem>
+        </itemizedlist>
+
+        <itemizedlist>
+          <listitem>
+            <para>TFTP server - If the board is not connected into a specific
+            network Enea provides a docker image with TFTP server. Please see
+            <link linkend="boot_docker">Docker Installer</link>
+            subchapter.</para>
+          </listitem>
+        </itemizedlist>
+
+        <itemizedlist>
+          <listitem>
+            <para>The board with U-Boot connected to a development host over
+            serial and ethernet.</para>
+          </listitem>
+        </itemizedlist>
+      </section>
+
+      <section id="boot_docker">
+        <title>Docker Installer</title>
+
+        <para>Enea provides a suite of tools in order to create a complete
+        boot process setup. System requirements for the development host are
+        detailed in the Enea NFV Access Release Information document included
+        with this release. All tools are leveraged by a docker image. The
+        docker image must be built and ran on development host. DHCP and TFTP
+        servers will be installed and configured in order to facilitate a
+        RAMDISK boot process on the target. Following is an example of how to
+        build and run Enea provided docker image. In this case host is
+        directly connected to target on eth1. For more details please see
+        README file from docker installater folder.</para>
+
+        <programlisting>&gt; cd nfv-access-tools/nfv-installer/docker-pxe-ramboot/
+&gt; mkdir -p ./images
+&gt; cp &lt;NFVAccessReleasePath&gt;/Image $(pwd)/images/Image
+&gt; cp &lt;NFVAccessReleasePath&gt;/enea-nfv-access-cn8304.ext4.gz.u-boot $(pwd)/images/enea-nfv-access-cn8304.ext4.gz.u-boot</programlisting>
+
+        <programlisting>&gt; docker build . -t el_installer</programlisting>
+
+        <programlisting>&gt; docker run -it --net=host --privileged \
+-v $(pwd)/dhcpd.conf:/etc/dhcp/dhcpd.conf \
+-v $(pwd)/images/Image:/var/lib/tftpboot/Image \
+-v $(pwd)/images/enea-nfv-access-cn8304.ext4.gz.u-boot:/var/lib/tftpboot/enea-nfv-access-cn8304.ext4.gz.u-boot \
+el_installer eth1</programlisting>
+
+        <para>Using this setup, on target side, U-Boot need to be configured
+        as following before starting to boot Linux. It was considered that the
+        first eth port(vnic0) is connected to host:</para>
+
+        <programlisting>&gt; setenv ethact vnic0
+&gt; setenv gatewayip 192.168.1.1
+&gt; setenv serverip 192.168.1.1
+&gt; setenv netmask 255.255.255.0
+&gt; setenv ipaddr 192.168.1.150</programlisting>
+      </section>
     </section>
   </section>
-</chapter>
+</chapter>
\ No newline at end of file