SDKs: updated Using the Enea NFV Access SDKs

    - Added Extensible SDK
    - Added Element ODM section

Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>

1 files changed, 50 insertions, 77 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 8a3bd27..075675e 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
@@ -72,6 +72,10 @@
         <para>Environment Setup Script which defines the environment
         variables</para>
       </listitem>
+
+      <listitem>
+        <para>Element ODM SDK</para>
+      </listitem>
     </itemizedlist>
 
     <para>To install the SDK on your host development machine, there is an
@@ -123,6 +127,19 @@
       </orderedlist>
     </section>
 
+    <section id="install-odm-sdk">
+      <title>Installing the Element ODM SDK</title>
+
+      <para>The Element ODM SDK contains a compressed archive file,
+      odm-sdk-x.y.z-arch.tar.gz. Please refer to the Element ODM documentaion
+      located at the Documentaion folder for how to install and use the ODM
+      SDK.</para>
+
+      <programlisting>Documentation/
+   Element_ODM_Kick_Start_Guide.pdf
+   Element_On_Device_Mgmt_Guide.pdf</programlisting>
+    </section>
+
     <section id="crosscomp-apps">
       <title>Cross-Compiling Applications from Command Line</title>
 
@@ -388,7 +405,7 @@ NOTE: devtool creates a Git repository locally during the extraction under
         <listitem>
           <para>Use any recipe from &lt;SDK_dir&gt;/layers/poky/meta*</para>
 
-          <programlisting>$ devtool mdify recipe 
+          <programlisting>$ devtool modify recipe
 
 EX:
 $ devtool modify curl</programlisting>
@@ -453,9 +470,11 @@ NOTE: following directories and files are created:
           <para><programlisting>$ devtool build [recipe]
 
 EX:
+$ devtool build bbexample
+or
 $ 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>
+          <literal>&lt;SDK_dir&gt;/tmp/work/&lt;arch&gt;-enea-linux/&lt;recipe&gt;</literal></literal></para>
         </listitem>
       </orderedlist>
     </section>
@@ -477,8 +496,17 @@ $ devtool build isic</programlisting>The recipe build results can be seen
         <listitem>
           <para>Deploy to target:</para>
 
-          <programlisting>$ devtool deploy-target isic root@&lt;target_ip_address&gt;
-root@xeon-d:~# isic
+          <programlisting>Example 1: deploy bbexample application
+$ devtool deploy-target bbexample root@&lt;target_ip_address&gt;
+
+Now run the bbexample on target:
+# bbexample
+Hello Yocto World...
+Hello World (from a shared library!)
+
+Example 2: deploy isic application
+$ devtool deploy-target isic root@&lt;target_ip_address&gt;
+# isic
 isic: error while loading shared libraries: libnet.so.9: cannot open shared 
 object file: No such file or directory
 
@@ -488,9 +516,8 @@ $ devtool modify libnet
 $ devtool build libnet
 $ devtool deploy-target libnet root@&lt;target_ip_address&gt;
 
-Now isic runs on target:
-
-root@xeon-d:~# isic
+Now run the isic on target:
+# isic
 usage: isic [-v] [-D] -s &lt;source ip&gt; -d &lt;destination ip&gt; [-r &lt;random seed&gt;]
 ...</programlisting>
         </listitem>
@@ -501,102 +528,48 @@ usage: isic [-v] [-D] -s &lt;source ip&gt; -d &lt;destination ip&gt; [-r &lt;ran
 
           <programlisting>$ devtool undeploy-target isic root@&lt;target_ip_address&gt;</programlisting>
         </listitem>
-
-        <listitem>
-          <para>Delete recipe and source files from workspace:</para>
-
-          <programlisting>$ devtool finish isic recipes/isic
-
-NOTE: Leaving source tree &lt;SDK_dir&gt;/workspace/sources/isic as-is; 
-if you no longer need it then please delete it manually
-
-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="docker_deploy">
       <title>Creating and Deploying a Docker image</title>
 
-      <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>
+      <para>You can build a docker container image from your Extensible SDK
+      and add your application into the container image.</para>
 
       <orderedlist>
         <listitem>
-          <para>Create a Dockefile for helloworld:</para>
-
-          <programlisting>#######################################
-# helloworld example Dockerfile
-########################################
-
-FROM ubuntu
-MAINTAINER John Smith &lt;John.Smith@gmail.com&gt;
-LABEL version="0.1" description="Helloworld example"
-
-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>Build it:</para>
+          <para>Create container image recipe in the workspace layer e.g.
+          cont-image and add the following lines:</para>
 
-          <programlisting>$ docker build .
-.....
-Successfully built fb7d03c7cba1</programlisting>
-        </listitem>
+          <programlisting>IMAGE_INSTALL += "your_application"
 
-        <listitem>
-          <para>Run the docker image:</para>
+LICENSE = "MIT"
 
-          <programlisting>$ docker run --name helloworld fb7d03c7cba1
-Hello World run from host!!</programlisting>
-        </listitem>
-
-        <listitem>
-          <para>Save:</para>
+IMAGE_FSTYPES = "container"
 
-          <programlisting>$ docker save fb7d03c7cba1 | gzip &gt; helloworld.tar.gz</programlisting>
+inherit core-image</programlisting>
         </listitem>
 
         <listitem>
-          <para>Deploy to target:</para>
+          <para>Add the following line in local.conf:</para>
 
-          <programlisting>$ scp helloworld.tar.gz root@&lt;target IP-address&gt;:/home/root</programlisting>
+          <programlisting>IMAGE_CONTAINER_NO_DUMMY = "1"</programlisting>
         </listitem>
 
         <listitem>
-          <para>Load the docker image on target:</para>
-
-          <programlisting>root@xeon-d:~# docker load -i helloworld.tar.gz</programlisting>
-        </listitem>
+          <para>Build the container image:</para>
 
-        <listitem>
-          <para>List docker images:</para>
+          <programlisting>$ devtool build-image cont-image
 
-          <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>
+NOTE: The image build result can be seen here:<literal>
+ <literal>&lt;SDK_dir&gt;</literal></literal>/tmp/deploy/images/qemux86-64/</programlisting>
         </listitem>
 
         <listitem>
-          <para>Run the docker image:</para>
+          <para>Copy the image to target and import in Docker:</para>
 
-          <programlisting>root@xeon-d:~# docker run fb7d03c7cba1
-Hello World run from inside docker target!!</programlisting>
+          <programlisting># docker import cont-image-qemux86.tar.bz2 your_application</programlisting>
         </listitem>
       </orderedlist>
     </section>