book-enea-nfv-access-guide: update it according to review comments

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

3 files changed, 65 insertions, 68 deletions

diff --git a/doc/book-enea-nfv-access-guide/doc/benchmarks.xml b/doc/book-enea-nfv-access-guide/doc/benchmarks.xml
index c9f042e..34748b8 100644
--- a/doc/book-enea-nfv-access-guide/doc/benchmarks.xml
+++ b/doc/book-enea-nfv-access-guide/doc/benchmarks.xml
@@ -1,4 +1,4 @@
-<?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="benchmarks">
@@ -58,7 +58,7 @@
           <row>
             <entry align="left">Network</entry>
 
-            <entry>3x10G ports</entry>
+            <entry>2x10G ports</entry>
           </row>
 
           <row>
@@ -89,8 +89,8 @@
       <section>
         <title>Forward traffic in Docker</title>
 
-        <para>Benchmarking traffic forwarding using testpmd in a Docker
-        container.</para>
+        <para>Benchmarking traffic forwarding using the testpmd application in
+        a Docker container.</para>
 
         <para>Pktgen is used to generate UDP traffic that will reach testpmd,
         running in a Docker image. It will then be forwarded back to source on
@@ -118,11 +118,10 @@
 
           <para>Start by following the steps below:</para>
 
-          <para>Boot the board using the following U-Boot commands:
-          <programlisting>setenv boot_board 'setenv userbootparams nohz_full=1-23 isolcpus=1-23 \
+          <para>Boot the NFV Access Linux using the following kernel
+          parameters in U-Boot: <programlisting>&gt; setenv bootargs 'nohz_full=1-23 isolcpus=1-23 \
 rcu-nocbs=1-23 rcu_nocb_poll clocksource=tsc tsc=reliable nohpet \
-nosoftlockup audit=0 nmi_watchdog=0; setenv satapart 2; run bootsata'
-run boot_board</programlisting></para>
+nosoftlockup audit=0'</programlisting></para>
 
           <para>Configure hugepages and set up the DPDK:<programlisting>echo 4 &gt; /proc/sys/vm/nr_hugepages
 modprobe vfio-pci
@@ -140,12 +139,12 @@ dpdk-devbind -b vfio-pci 0001:01:00.1</programlisting>Run
 
           <para>Start by following the steps below:</para>
 
-          <para>Boot the board using the following U-Boot commands:</para>
+          <para>Boot the NFV Access Linux using the following kernel
+          parameters in U-Boot:</para>
 
-          <programlisting>setenv boot_board 'setenv userbootparams nohz_full=1-23 isolcpus=1-23 \
+          <programlisting>&gt; setenv bootargs 'nohz_full=1-23 isolcpus=1-23 \
 rcu-nocbs=1-23 rcu_nocb_poll clocksource=tsc tsc=reliable nohpet \
-nosoftlockup audit=0 nmi_watchdog=0; setenv satapart 2; run bootsata'
-run boot_board</programlisting>
+nosoftlockup audit=0'</programlisting>
 
           <para>It is expected that a NFV Access guest image is present on the
           target.</para>
@@ -439,12 +438,12 @@ start</programlisting><table>
 
           <para>Start by following the steps below:</para>
 
-          <para>Boot the board using the following U-Boot commands:</para>
+          <para>Boot the NFV Access Linux using the following kernel
+          parameters in U-Boot:</para>
 
-          <programlisting>setenv boot_board 'setenv userbootparams nohz_full=1-23 isolcpus=1-23 \
+          <programlisting>setenv bootargs 'nohz_full=1-23 isolcpus=1-23 \
 rcu-nocbs=1-23 rcu_nocb_poll clocksource=tsc tsc=reliable nohpet \
-nosoftlockup audit=0 nmi_watchdog=0; setenv satapart 2; run bootsata'
-run boot_board</programlisting>
+nosoftlockup audit=0'</programlisting>
 
           <para>Configure hugepages and set up the DPDK:<programlisting>echo 4 &gt; /proc/sys/vm/nr_hugepages
 modprobe vfio-pci
@@ -461,13 +460,12 @@ dpdk-devbind -b vfio-pci 0001:01:00.1</programlisting>Run
 
           <para>Start by following the steps below:</para>
 
-          <para>SSD boot using the following <literal>grub.cfg</literal>
-          entry:</para>
+          <para>Boot the NFV Access Linux using the following kernel
+          parameters in U-Boot:</para>
 
-          <programlisting>setenv boot_board 'setenv userbootparams nohz_full=1-23 isolcpus=1-23 \
+          <programlisting>setenv bootargs 'nohz_full=1-23 isolcpus=1-23 \
 rcu-nocbs=1-23 rcu_nocb_poll clocksource=tsc tsc=reliable nohpet \
-nosoftlockup audit=0 nmi_watchdog=0; setenv satapart 2; run bootsata'
-run boot_board</programlisting>
+nosoftlockup audit=0'</programlisting>
 
           <para>Set up the DPDK and configure the OVS bridge:<programlisting># Clean up old OVS old config
 killall ovsdb-server ovs-vswitchd
@@ -687,11 +685,10 @@ ovs-ofctl add-flow ovsbr0 in_port=2,action=output:1</programlisting>Import a
 
           <para>Start with the steps below:</para>
 
-          <para>Boot the board using the following U-Boot commands:
-          <programlisting>setenv boot_board 'setenv userbootparams nohz_full=1-23 isolcpus=1-23 \
+          <para>Boot the NFV Access Linux using the following kernel
+          parameters in U-Boot: <programlisting>setenv bootargs 'nohz_full=1-23 isolcpus=1-23 \
 rcu-nocbs=1-23 rcu_nocb_poll clocksource=tsc tsc=reliable nohpet \
-nosoftlockup audit=0 nmi_watchdog=0; setenv satapart 2; run bootsata'
-run boot_board</programlisting></para>
+nosoftlockup audit=0'</programlisting></para>
 
           <para>Configure hugepages and set up the DPDK:<programlisting>echo 4 &gt; /proc/sys/vm/nr_hugepages
 modprobe vfio-pci
@@ -708,11 +705,11 @@ dpdk-devbind -b vfio-pci 0001:01:00.1</programlisting>Run
 
           <para>Start by following the steps below:</para>
 
-          <para>Boot the board using the following U-Boot commands:
-          <programlisting>setenv boot_board 'setenv userbootparams nohz_full=1-23 isolcpus=1-23 \
+          <para>Boot the NFV Access Linux using the following kernel
+          parameters in U-Boot: <programlisting>setenv bootargs 'nohz_full=1-23 isolcpus=1-23 \
 rcu-nocbs=1-23 rcu_nocb_poll clocksource=tsc tsc=reliable nohpet \
-nosoftlockup audit=0 nmi_watchdog=0; setenv satapart 2; run bootsata'
-run boot_board</programlisting>Kill unnecessary services: <programlisting>killall ovsdb-server ovs-vswitchd
+nosoftlockup audit=0'</programlisting>Kill unnecessary services:
+          <programlisting>killall ovsdb-server ovs-vswitchd
 rm -rf /etc/openvswitch/*
 rm -rf /var/run/openvswitch/*
 mkdir -p /var/run/openvswitch</programlisting>Configure hugepages, set up the
@@ -1089,11 +1086,10 @@ show port stats 0</programlisting><table>
 
           <para>Start by doing the following:</para>
 
-          <para>Boot the board using the following U-Boot commands:
-          <programlisting>setenv boot_board 'setenv userbootparams nohz_full=1-23 isolcpus=1-23 \
+          <para>Boot the NFV Access Linux using the following kernel
+          parameters in U-Boot: <programlisting>setenv bootargs 'nohz_full=1-23 isolcpus=1-23 \
 rcu-nocbs=1-23 rcu_nocb_poll clocksource=tsc tsc=reliable nohpet \
-nosoftlockup audit=0 nmi_watchdog=0; setenv satapart 2; run bootsata'
-run boot_board</programlisting>Configure hugepages and set up the
+nosoftlockup audit=0'</programlisting>Configure hugepages and set up the
           DPDK:<programlisting>echo 4 &gt; /proc/sys/vm/nr_hugepages
 modprobe vfio-pci
 ifconfig enP1p1s0f1 down
@@ -1109,14 +1105,10 @@ dpdk-devbind -b vfio-pci 0001:01:00.1</programlisting>Run
 
           <para>Start by doing the following:</para>
 
-          <para>SSD boot using the following <literal>grub.cfg</literal>
-          entry: <programlisting>linux (hd0,gpt3)/boot/bzImage root=/dev/sda3 ip=dhcp nohz_full=1-7 \
-isolcpus=1-7 rcu-nocbs=1-7 rcu_nocb_poll intel_pstate=disable \
-clocksource=tsc tsc=reliable nohpet nosoftlockup intel_idle.max_cstate=0 \
-processor.max_cstate=0 mce=ignore_ce audit=0 nmi_watchdog=0 iommu=pt \
-intel_iommu=on  hugepagesz=1GB hugepages=8 default_hugepagesz=1GB \
-hugepagesz=2M hugepages=2048 vfio_iommu_type1.allow_unsafe_interrupts=1</programlisting>Kill
-          Services:<programlisting>killall ovsdb-server ovs-vswitchd
+          <para>Boot the NFV Access Linux using the following kernel
+          parameters in U-Boot: <programlisting>setenv bootargs 'nohz_full=1-23 isolcpus=1-23 \
+rcu-nocbs=1-23 rcu_nocb_poll clocksource=tsc tsc=reliable nohpet \
+nosoftlockup audit=0'</programlisting>Kill Services:<programlisting>killall ovsdb-server ovs-vswitchd
 rm -rf /etc/openvswitch/*
 mkdir -p /var/run/openvswitch</programlisting>Configure hugepages, set up the
           DPDK:<programlisting>echo 20 &gt; /proc/sys/vm/nr_hugepages
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 74cad71..4e2b3a3 100644
--- a/doc/book-enea-nfv-access-guide/doc/getting_started.xml
+++ b/doc/book-enea-nfv-access-guide/doc/getting_started.xml
@@ -1,4 +1,4 @@
-<?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">
@@ -124,9 +124,10 @@
 
         <listitem>
           <para>If the target is not connected on a specific network, Enea
-          provides DHCP and TFTP servers. Please see <link
-          linkend="boot_docker">Docker Installer</link> section, on how to
-          install these two servers on a development host.</para>
+          provides DHCP and TFTP servers that can be used to setup a local
+          network. Please see <link linkend="boot_docker">Docker
+          Installer</link> section, on how to install these two servers on a
+          development host.</para>
 
           <programlisting>&gt; setenv ethact    &lt;vnic0/vnic1&gt;
 &gt; setenv gatewayip &lt;GatewayIP&gt;
@@ -199,23 +200,23 @@
         href="../../s_docbuild/olinkdb/pardoc-common.xml"
         xmlns:xi="http://www.w3.org/2001/XInclude"
         xpointer="element(book_enea_nfv_access_release_info/1)" /> included
-        with this release. </para>
+        with this release.</para>
 
-        <para>All tools are leveraged by a Docker image, which must be built
-        and run on a development host. DHCP and TFTP servers will be installed
-        and configured in order to facilitate a RAMDISK boot process on the
-        target. </para>
+        <para>All required tools are leveraged by the Docker image, which must
+        be built and run on a development host. DHCP and TFTP servers will be
+        installed and configured in order to facilitate a RAMDISK boot process
+        on the target.</para>
 
         <para>The example procedure below details how to build and run a
         provided Docker image. In this case, the host is directly connected to
         a target on <literal>eth1</literal>. For more details about the Docker
         installer, please see <filename>README</filename> file from the Docker
-        installer folder. </para>
+        installer folder.</para>
 
         <para>Prior to using this example setup, on the target side, U-Boot
         needs to be configured with these values, before booting Linux. Note
         that the first eth port (<literal>vnic0</literal>) is connected to a
-        network:</para>
+        network in this example:</para>
 
         <programlisting>&gt; setenv ethact vnic0
 &gt; setenv gatewayip 192.168.1.1
@@ -230,15 +231,13 @@
 &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.ext4.gz.u-boot
+     $(pwd)/images/enea-nfv-access-cn8304.ext4.gz.u-boot
 &gt; docker build . -t el_installer
 &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.ext4.gz.u-boot:/var/lib/tftpboot/ \
-enea-nfv-access.ext4.gz.u-boot
-
-el_installer eth1</programlisting>
+-v $(pwd)/images/eenea-nfv-access-cn8304.ext4.gz.u-boot:/var/lib/tftpboot/ \
+enea-nfv-access-cn8304.ext4.gz.u-boot el_installer eth1</programlisting>
       </section>
     </section>
   </section>
diff --git a/doc/book-enea-nfv-access-guide/doc/hypervisor_virtualization.xml b/doc/book-enea-nfv-access-guide/doc/hypervisor_virtualization.xml
index 69057f3..3f14719 100644
--- a/doc/book-enea-nfv-access-guide/doc/hypervisor_virtualization.xml
+++ b/doc/book-enea-nfv-access-guide/doc/hypervisor_virtualization.xml
@@ -1,4 +1,4 @@
-<?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="hypervisor_virt">
@@ -470,11 +470,12 @@ $ testpmd -c 0x7 -- -i --rxq=2 --txq=2 --nb-cores=2 ...</programlisting>
           <para><emphasis role="bold">vhost-user interface</emphasis></para>
 
           <para>See the Open vSwitch chapter on how to create a
-          <literal>vhost-user</literal> interface using Open vSwitch.
-          Currently there is no Open vSwitch support for networks that are
-          managed by <literal>libvirt </literal>(e.g. NAT). Until further
+          <literal>vhost-user</literal> interface using Open vSwitch(OVS).
+          Currently there is no Open vSwitch(OVS) support for networks that
+          are managed by <literal>libvirt </literal>(e.g. NAT). Until further
           notice, only bridged networks are supported (those where the user
-          has to manually create the bridge).</para>
+          has to manually create the bridge). In order to pass Open vSwitch
+          configuration the &lt;qemu:commandline&gt; is used.</para>
 
           <programlisting>    &lt;qemu:commandline&gt;
       &lt;qemu:arg value='-chardev'/&gt;
@@ -578,7 +579,12 @@ $ dpdk-devbind.py --bind=vfio-pci 0001:01:00.1
     <section id="libvirt-guest-config-ex">
       <title>Libvirt guest configuration examples</title>
 
-      <section id="guest-config-vhost-user-interface">
+      <note>
+        <para>Currently used Libvirt version has some limitations for aarch64
+        which are bypassed using the qemu:commandline option.</para>
+      </note>
+
+      <example>
         <title>Guest configuration with vhost-user interface</title>
 
         <programlisting>&lt;domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'&gt;
@@ -640,9 +646,9 @@ $ dpdk-devbind.py --bind=vfio-pci 0001:01:00.1
      bus=pcie.0,addr=0x2'/&gt;
   &lt;/qemu:commandline&gt;
 &lt;/domain&gt;</programlisting>
-      </section>
+      </example>
 
-      <section id="guest-config-pci-passthrough">
+      <example>
         <title>Guest configuration with PCI passthrough</title>
 
         <programlisting>&lt;domain type='kvm' xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'&gt;
@@ -699,9 +705,9 @@ $ dpdk-devbind.py --bind=vfio-pci 0001:01:00.1
      &lt;qemu:arg value='vfio-pci,host=0001:01:00.1'/&gt;
   &lt;/qemu:commandline&gt;
 &lt;/domain&gt;</programlisting>
-      </section>
+      </example>
 
-      <section id="guest-config-bridge-interface">
+      <example>
         <title>Guest configuration with bridge interface</title>
 
         <programlisting>&lt;domain type='kvm'&gt;
@@ -762,7 +768,7 @@ $ dpdk-devbind.py --bind=vfio-pci 0001:01:00.1
     &lt;/console&gt;
   &lt;/devices&gt;
 &lt;/domain&gt;</programlisting>
-      </section>
+      </example>
     </section>
   </section>
 </chapter>
\ No newline at end of file