1 files changed, 202 insertions, 218 deletions

diff --git a/doc/book-enea-nfv-access-guide-intel/doc/using_nfv_access_sdks.xml b/doc/book-enea-nfv-access-guide-intel/doc/using_nfv_access_sdks.xml
index 25090c6..8a3bd27 100644
--- a/doc/book-enea-nfv-access-guide-intel/doc/using_nfv_access_sdks.xml
+++ b/doc/book-enea-nfv-access-guide-intel/doc/using_nfv_access_sdks.xml
@@ -6,9 +6,15 @@
 
   <para>Enea NFV Access comes with two Software Development Kits (SDK), the
   "Standard SDK" and the "Extensible SDK". Standard SDK can be used to develop
-  user-applications and kernel modules on host to run on target device (i.e.
-  on ARM, PPC, x86, ..). The standard SDK can also be used for cross debugging
-  your kernel or application.</para>
+  and debug user-applications and kernel modules specific to the target
+  architecture on host to run on target device (i.e. Xeon D, Atom
+  C3000).</para>
+
+  <para>The Extensible SDK provides features that help you easily add a new
+  Yocto recipe, build, test and package software and optionally deploy it to
+  target device. The Extensible SDK however is based on core-i7 architecture
+  and can't be used for building the kernel modules specific to other
+  architectures.</para>
 
   <para><emphasis role="bold">Benefits of Extensible
   SDK:</emphasis><orderedlist>
@@ -18,7 +24,7 @@
 
       <listitem>
         <para>Easy to add new apps and libraries, modify source of an existing
-        component or add new layers/recipes</para>
+        component or add new Yocto layers/recipes</para>
       </listitem>
 
       <listitem>
@@ -34,10 +40,18 @@
       </listitem>
 
       <listitem>
-        <para>Runs on a range of host operating systems (Windows, Mac)</para>
+        <para>Runs on a range of host distributions</para>
       </listitem>
     </orderedlist></para>
 
+  <para>For additional information about SDKs, please refer to the <ulink
+  url="https://wiki.yoctoproject.org/wiki/Application_Development_with_Extensible_SDK#Extensible_SDK">Application
+  Development with Extensible SDK, </ulink> <ulink
+  url="https://wiki.yoctoproject.org/wiki/Extensible_SDK">Extensible SDK Wiki
+  page</ulink> and <ulink
+  url="https://www.yoctoproject.org/docs/current/sdk-manual/sdk-manual.html">Yocto
+  SDK Manual</ulink>.</para>
+
   <section id="std_sdk">
     <title>Standard SDK</title>
 
@@ -74,17 +88,7 @@
     generate executables for the preferred target machine. Cross-gdb
     (<filename>x86_64-enea-linux-gdb</filename>) is created by the
     Cross-Development toolchain. It can be used to debug applications on the
-    target platform from the development workstation. For kernel debugging,
-    <command>ftrace</command> and <command>kgdb</command> are enabled on the
-    host sdk image.</para>
-
-    <para>Various user-space tools helpful in the development process, are
-    also provided. The tools include <emphasis
-    role="bold">LatencyTop</emphasis>, <emphasis role="bold">Perf</emphasis>,
-    <emphasis role="bold">CrossTap</emphasis>, <emphasis
-    role="bold">OProfile</emphasis>, <emphasis
-    role="bold">Lttng-ust</emphasis> and <emphasis
-    role="bold">GDBserver</emphasis>.</para>
+    target platform from the development workstation.</para>
 
     <section id="install-crosscomp">
       <title>Installing the Cross-Compilation Toolchain</title>
@@ -282,63 +286,15 @@ MODULE_LICENSE("GPL");</programlisting>
         remote debugging is started and the GDB commands are available to
         debug your program from the target machine.</para>
       </section>
-
-      <section id="kernel_crossdebug">
-        <title>Kernel Cross-Debugging</title>
-
-        <para>In order to debug the kernel, a serial connection is required
-        between the development and target machines. Debugging commands will
-        be sent from your workstation to the target machine via a serial
-        port.</para>
-
-        <para>The KGDB kernel options are enabled in the Enea NFV Access Host
-        SDK image and the tool can be used in the following way:</para>
-
-        <itemizedlist>
-          <listitem>
-            <para>On target, once serial communication is established,
-            configure <literal>kgdboc</literal> after the kernel
-            boots:<programlisting># echo ttyS0,115200 &gt; /sys/module/kgdboc/parameters/kgdboc</programlisting></para>
-          </listitem>
-
-          <listitem>
-            <para>In order to connect to gdb via kgdboc, the kernel must first
-            be stopped:<programlisting># echo g &gt; /proc/sysrq-trigger</programlisting></para>
-          </listitem>
-
-          <listitem>
-            <para>Close the console to the target, eg.: <command>Ctrl +
-            ]</command> for a telnet session.</para>
-          </listitem>
-
-          <listitem>
-            <para>On your development machine, start cross-gdb using the
-            vmlinux kernel image as a parameter. The image is located in
-            <filename>&lt;sdkdir&gt;/sysroots/corei7-64-enea-linux/boot/</filename>
-            and should be the same as the image found in the
-            <literal>/boot</literal> directory from the
-            target.<programlisting># x86_64-enea-linux-gdb /
-./sysroots/corei7-64-enea-linux/boot/vmlinux-4.9.30-intel-pk-standard</programlisting></para>
-          </listitem>
-
-          <listitem>
-            <para>Connect GDB to the target machine using target command and
-            the serial device:<programlisting>(gdb) set remotebaud 115200
-(gdb) target remote /dev/ttyS0</programlisting></para>
-          </listitem>
-        </itemizedlist>
-
-        <para>The kernel can now be debugged in a similar manner as an
-        application program.</para>
-      </section>
     </section>
   </section>
 
   <section id="esdk">
     <title>Extensible SDK</title>
 
-    <para>The Extensible SDK provides features that help you easily build an
-    exsiting or a new component. The Extensible SDK consits of:</para>
+    <para>The Extensible SDK provides a number of features that help you
+    easily build, test and package software, and optionally deploy it to
+    target device. The Extensible SDK consits of:</para>
 
     <itemizedlist>
       <listitem>
@@ -355,8 +311,9 @@ MODULE_LICENSE("GPL");</programlisting>
       </listitem>
 
       <listitem>
-        <para>Devtool (to add, build and deploy the application to target
-        device)</para>
+        <para>Devtool (d<emphasis>evtool add </emphasis>to create
+        automatically a recipe for an existing source code, <emphasis>devtool
+        modify</emphasis> to build an existing recipe, etc ..)</para>
       </listitem>
     </itemizedlist>
 
@@ -395,226 +352,253 @@ Run devtool --help for further details.</programlisting></para>
       </orderedlist>
     </section>
 
-    <section id="mod_comp_esdk">
-      <title>Modifying an existing component</title>
+    <section id="add_new_comp_esdk">
+      <title>Adding a new component</title>
+
+      <para>The <emphasis>devtool add</emphasis> command is used to create a
+      new recipe and <emphasis>devtool modify</emphasis> command is used to
+      work on an existing recipe. To add a component, you can:</para>
+
+      <para><emphasis role="bold">A) Generate a recipe from the existing
+      application code and Makefile</emphasis></para>
 
       <orderedlist>
         <listitem>
-          <para>Extract source and add recipe to workspace:</para>
+          <para>Run <emphasis>devtool add</emphasis> command to generate a
+          recipe:</para>
 
-          <programlisting>$ devtool modify -x recipename myapp /path/to/source</programlisting>
-        </listitem>
+          <programlisting>$ devtool add recipe /path/to/your_application 
 
-        <listitem>
-          <para>Edit the source code and build it:</para>
+EX:
+$ devtool add bbexample /path/to/bbexample 
+or download from upstream git repository
+$ devtool add bbexample https://github.com/whbruce/bbexample.git
 
-          <programlisting>$ devtool build recipename </programlisting>
+NOTE: Recipe &lt;SDK_dir&gt;/workspace/recipes/bbexample/bbexample.bb has been
+automatically created; further editing may be required to make it fully functional
+NOTE: devtool creates a Git repository locally during the extraction under 
+      &lt;SDK_dir&gt;/workspace/source/bbexample</programlisting>
         </listitem>
+      </orderedlist>
+
+      <para><emphasis role="bold">B) Use an existing recipe from a Yocto
+      layer</emphasis></para>
 
+      <orderedlist>
         <listitem>
-          <para>Push source code changes, or generate as patches on top of
-          recipe:</para>
+          <para>Use any recipe from &lt;SDK_dir&gt;/layers/poky/meta*</para>
+
+          <programlisting>$ devtool mdify recipe 
 
-          <programlisting>$ devtool update­recipe recipename</programlisting>
+EX:
+$ devtool modify curl</programlisting>
         </listitem>
       </orderedlist>
-    </section>
 
-    <section id="add_comp_esdk">
-      <title>Adding a new component</title>
+      <para><emphasis role="bold">C) Alternatively bring a new recipe from the
+      upstream Yocto project if the recipe is not included in your Extensible
+      SDK </emphasis></para>
 
       <orderedlist>
         <listitem>
-          <para>Add application to workspace:</para>
+          <para>Clone a recipe from the upstream Yocto project, e.g.
+          meta-security:</para>
 
-          <programlisting>$ devtool add myapp /path/to/source</programlisting>
+          <programlisting>$ pushd &lt;SDK_dir&gt;/layers/poky
+$ git clone -b rocko git://git.yoctoproject.org/meta-security</programlisting>
         </listitem>
 
         <listitem>
-          <para>Build it:</para>
+          <para>Use the <emphasis>bitbake-layers</emphasis> script to add the
+          meta-security to BBLAYERS:</para>
+
+          <programlisting>$ layers/poky/bitbake/bin/bitbake-layers add-layer layers/poky/meta-security
+
+If you get dependency ERROR, you need to clone all required layer as well: 
+ERROR: Layer 'security' depends on layer 'perl-layer', but this layer is 
+not enabled in your configuration
 
-          <programlisting>$ devtool build myapp </programlisting>
+clone meta-perl from openembedded and run add-layers again: 
+$ layers/poky/bitbake/bin/bitbake-layers add-layer layers/poky/meta-security
+
+NOTE: Now &lt;SDK_dir&gt;/layers/poky/meta-security is created and the layer has been 
+added to: &lt;SDK_dir&gt;/conf/bblayers.conf
+  ...
+  ${SDKBASEMETAPATH}/layers/poky/meta-security \</programlisting>
+        </listitem>
+
+        <listitem>
+          <para>Use <emphasis>devtool modify</emphasis> command to work an an
+          existing recipe inside meta-security layer:</para>
+
+          <programlisting>$ devtool modify recipe
+
+EX:
+$ devtool modify isic
+
+NOTE: following directories and files are created:
+&lt;SDK_dir&gt;/workspace/appends/isic_0.07.bbappend 
+&lt;SDK_dir&gt;/workspace/sources/isic</programlisting>
         </listitem>
       </orderedlist>
     </section>
 
-    <section id="create_recipe_esdk">
-      <title>Creating recipe for a new application </title>
-
-      <para>Devtool provides a number of features that help you easily to
-      build, test and package software within the extensible SDK, and
-      optionally deploy it to target device:</para>
+    <section id="devtool_build">
+      <title>Build your application/recipe</title>
 
-      <para>This example will show how to generate a recipe from the existing
-      application code and Makefile, edit the recipe in order to provide an
-      installation path for the application, build the recipe, and deploy the
-      output on a target, or create a DEB package from the recipe and install
-      the package.</para>
+      <para>Use devtool build command to build the recipe:</para>
 
       <orderedlist>
         <listitem>
-          <para>Create a simple application and Makefile in
-          <literal>&lt;workspace_dir&gt;/my_app</literal>:</para>
+          <para><programlisting>$ devtool build [recipe]
 
-          <para><literal>&lt;workspace_dir&gt;/my_app/my_hello_app.c</literal></para>
+EX:
+$ devtool build isic</programlisting>The recipe build results can be seen
+          here:<literal>
+          <literal>&lt;SDK_dir&gt;/tmp/work/&lt;arch&gt;-enea-linux/isic</literal></literal></para>
+        </listitem>
+      </orderedlist>
+    </section>
+  </section>
 
-          <programlisting>#include &lt;stdio.h&gt;
+  <section id="deploy">
+    <title>Deploy your Application to target</title>
 
-int main(void)
-{
-    printf("Hello world!\n");
-    return 0;
-}</programlisting>
+    <para>Deploy your application to target by using <emphasis>devtool
+    deploy-target</emphasis> command or build an docker image and dploy the
+    docker image.</para>
 
-          <para><literal>&lt;workspace_dir&gt;/my_app/Makefile</literal></para>
+    <section id="deploy-artifacts-esdk">
+      <title>Using <emphasis>devtool deploy-target</emphasis> command</title>
 
-          <programlisting>my_hello_app:</programlisting>
-        </listitem>
+      <para>Deploy the application to the target device:</para>
 
+      <orderedlist>
         <listitem>
-          <para>Generate a recipe (my-hello-recipe) using the source tree of
-          the application
-          (<literal>&lt;workspace_dir&gt;/my_app</literal>):</para>
-
-          <programlisting>$ devtool add my-hello-recipe &lt;workspace_dir&gt;/my_app
-NOTE: Using source tree as build directory since that would be the default for this
-recipe
-NOTE: Recipe &lt;SDK_dir&gt;/workspace/recipes/my-hello-recipe/my-hello-recipe.bb has been
-automatically created; further editing may be required to make it fully functional</programlisting>
-
-          <programlisting>$ cat &lt;SDK_dir&gt;/workspace/recipes/my-hello-recipe/my-hello-recipe.bb
-# Recipe created by recipetool
-# This is the basis of a recipe and may need further editing in order to be fully
-# functional.
-# (Feel free to remove these comments when editing.)
-#
-# Unable to find any files that looked like license statements. Check the
-# accompanying documentation and source headers and set LICENSE and
-# LIC_FILES_CHKSUM accordingly.
-#
-# NOTE: LICENSE is being set to "CLOSED" to allow you to at least start building - if
-# this is not accurate with respect to the licensing of the software being built (it
-# will not be in most cases) you must specify the correct value before using this
-# recipe for anything other than initial testing/development!
-LICENSE = "CLOSED"
-LIC_FILES_CHKSUM = ""
-
-# No information for SRC_URI yet (only an external source tree was specified)
-SRC_URI = ""
-
-
-# NOTE: this is a Makefile-only piece of software, so we cannot generate much of the
-# recipe automatically - you will need to examine the Makefile yourself and ensure
-# that the appropriate arguments are passed in.
-
-do_configure () {
-    # Specify any needed configure commands here
-    :
-}
+          <para>Deploy to target:</para>
 
-do_compile () {
-    # You will almost certainly need to add additional arguments here
-    oe_runmake
-}
+          <programlisting>$ devtool deploy-target isic root@&lt;target_ip_address&gt;
+root@xeon-d:~# isic
+isic: error while loading shared libraries: libnet.so.9: cannot open shared 
+object file: No such file or directory
 
-do_install () {
-    # NOTE: unable to determine what to put here - there is a Makefile but no
-    # target named "install", so you will need to define this yourself
-    :
-}</programlisting>
-        </listitem>
+NOTE: If you get dependency error, you need to build that recipe as well and 
+deploy to target:
+$ devtool modify libnet
+$ devtool build libnet
+$ devtool deploy-target libnet root@&lt;target_ip_address&gt;
 
-        <listitem>
-          <para>Edit the recipe to provide an installation path for the
-          application:</para>
-
-          <programlisting>$ devtool edit-recipe my-hello-recipe</programlisting>
-
-          <programlisting>$ cat &lt;SDK_dir&gt;/workspace/recipes/my-hello-recipe/my-hello-recipe.bb
-...
-do_install () {
-    # NOTE: unable to determine what to put here - there is a Makefile but no
-    # target named "install", so you will need to define this yourself
-    install -d ${D}${bindir}
-    install -m 0777 ${S}/my_hello_app ${D}${bindir}
-}
+Now isic runs on target:
+
+root@xeon-d:~# isic
+usage: isic [-v] [-D] -s &lt;source ip&gt; -d &lt;destination ip&gt; [-r &lt;random seed&gt;]
 ...</programlisting>
         </listitem>
 
         <listitem>
-          <para>Build the recipe:</para>
-
-          <programlisting>$ devtool build my-hello-recipe</programlisting>
+          <para>Remove/uninstall the application from target if you don't need
+          it:</para>
 
-          <para>The recipe build results can be seen here:
-          <literal>&lt;SDK_dir&gt;/tmp/work/&lt;arch&gt;-enea-linux/my-hello-recipe/1.0-r0/</literal></para>
+          <programlisting>$ devtool undeploy-target isic root@&lt;target_ip_address&gt;</programlisting>
         </listitem>
 
         <listitem>
-          <para>Deploy the output (in this case, the application) on
-          target:</para>
-
-          <programlisting>$ devtool deploy-target my-hello-recipe root@&lt;target_ip_address&gt;
-Parsing recipes..done.
-NOTE: Successfully deployed
-&lt;SDK_dir&gt;/tmp/work/&lt;arch&gt;-enea-linux/my-hello-recipe/1.0-r0/image</programlisting>
+          <para>Delete recipe and source files from workspace:</para>
 
-          <para>As an alternative you can create a DEB package:</para>
+          <programlisting>$ devtool finish isic recipes/isic
 
-          <programlisting>$ devtool package my-hello-recipe
-...NOTE: Your packages are in &lt;SDK_dir&gt;/tmp/deploy/deb</programlisting>
+NOTE: Leaving source tree &lt;SDK_dir&gt;/workspace/sources/isic as-is; 
+if you no longer need it then please delete it manually
 
-          <para>Then copy the DEB package on the target and install it using
-          dpkg:</para>
-
-          <programlisting># dpkg -i my-hello-recipe-1.0-r0.1.&lt;arch&gt;.deb</programlisting>
+rm -rf &lt;SDK_dir&gt;/workspace/appends/isic_0.07.bbappend
+rm -rf &lt;SDK_dir&gt;/workspace/source/isic</programlisting>
         </listitem>
       </orderedlist>
     </section>
 
-    <section id="update_esdk">
-      <title>Updating and Extending the Extensible SDK</title>
+    <section id="docker_deploy">
+      <title>Creating and Deploying a Docker image</title>
 
-      <para>Update and Extend your Extensible SDK:</para>
+      <para>Docker can build images automatically by reading the instructions
+      from a Dockerfile. A Dockerfile is a text document that contains all the
+      commands a user could call on the command line to assemble an image. For
+      detailed info about docker, please refer to the <ulink
+      url="https://docs.docker.com/">Docker documentation.</ulink></para>
 
       <orderedlist>
         <listitem>
-          <para>Update your SDK</para>
+          <para>Create a Dockefile for helloworld:</para>
+
+          <programlisting>#######################################
+# helloworld example Dockerfile
+########################################
 
-          <programlisting>$ devtool sdk-update [url]</programlisting>
+FROM ubuntu
+MAINTAINER John Smith &lt;John.Smith@gmail.com&gt;
+LABEL version="0.1" description="Helloworld example"
 
-          <para>The recipe build results can be seen here:
-          <literal>&lt;SDK_dir&gt;/tmp/work/&lt;arch&gt;-enea-linux/my-hello-recipe/1.0-r0/</literal></para>
+COPY path/to/helloworld /helloworld
+
+CMD /helloworld</programlisting>
+
+          <note>
+            <para>Don't forget to add required dependecies for the recipe in
+            the docker image as well. As we saw in the previous example isic
+            depended on libnet so we had to build and deploy libnet to target
+            separately. The same needs to be done here, e.g. if you build a
+            docker image for isic, you need to add libnet to the container
+            filesystem.</para>
+          </note>
         </listitem>
 
         <listitem>
-          <para>Extend your SDK</para>
+          <para>Build it:</para>
 
-          <programlisting>$ devtool search package-name
-$ devtool sdk -install [-s] recipe-name
-Ex:
-$ devtool sdk-install meta-extsdk-toolchain</programlisting>
+          <programlisting>$ docker build .
+.....
+Successfully built fb7d03c7cba1</programlisting>
+        </listitem>
+
+        <listitem>
+          <para>Run the docker image:</para>
 
-          <para>The recipe build results can be seen here:
-          <literal>&lt;SDK_dir&gt;/tmp/work/&lt;arch&gt;-enea-linux/my-hello-recipe/1.0-r0/</literal></para>
+          <programlisting>$ docker run --name helloworld fb7d03c7cba1
+Hello World run from host!!</programlisting>
         </listitem>
-      </orderedlist>
-    </section>
 
-    <section id="deploy-artifacts-esdk">
-      <title>Deploying your artifacts</title>
+        <listitem>
+          <para>Save:</para>
 
-      <para>You can use <literal>ssh</literal> to deploy your artifacts on the
-      host target. For this you will need a network connection to the target
-      device: </para>
+          <programlisting>$ docker save fb7d03c7cba1 | gzip &gt; helloworld.tar.gz</programlisting>
+        </listitem>
 
-      <programlisting>$ devtool deploy­target myapp device</programlisting>
-    </section>
+        <listitem>
+          <para>Deploy to target:</para>
+
+          <programlisting>$ scp helloworld.tar.gz root@&lt;target IP-address&gt;:/home/root</programlisting>
+        </listitem>
+
+        <listitem>
+          <para>Load the docker image on target:</para>
+
+          <programlisting>root@xeon-d:~# docker load -i helloworld.tar.gz</programlisting>
+        </listitem>
+
+        <listitem>
+          <para>List docker images:</para>
 
-    <section id="create_docker_image">
-      <title>Creating and Deploying a Docker image </title>
+          <programlisting>root@xeon-d:~# docker images
+REPOSITORY          TAG          IMAGE ID            CREATED             SIZE
+&lt;none&gt;              &lt;none&gt;       fb7d03c7cba1        3 hours ago         79.6MB</programlisting>
+        </listitem>
+
+        <listitem>
+          <para>Run the docker image:</para>
 
-      <para>You can build a docker image ....</para>
+          <programlisting>root@xeon-d:~# docker run fb7d03c7cba1
+Hello World run from inside docker target!!</programlisting>
+        </listitem>
+      </orderedlist>
     </section>
   </section>
 </chapter>
\ No newline at end of file