diff options
author | Sona Sarmadi <sona.sarmadi@enea.com> | 2018-06-28 12:58:08 +0200 |
---|---|---|
committer | Sona Sarmadi <sona.sarmadi@enea.com> | 2018-06-28 12:59:08 +0200 |
commit | 5a9cc42af4f3df199cc7be87af57f435e31a5ca9 (patch) | |
tree | 302fdde48397ac7891dc89d44f832322c1fdeb37 | |
parent | c3e1a330d4caee9e76b006454f532198bf945d51 (diff) | |
download | nfv-access-documentation-5a9cc42af4f3df199cc7be87af57f435e31a5ca9.tar.gz |
Fixed Miruna's comments from pdf file
Ref: LXCR-8412
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
-rw-r--r-- | doc/book-enea-nfv-access-guide-intel/doc/using_nfv_access_sdks.xml | 104 |
1 files changed, 58 insertions, 46 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 e084502..d81cfdb 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 | |||
@@ -328,8 +328,11 @@ MODULE_LICENSE("GPL");</programlisting> | |||
328 | <title>Extensible SDK</title> | 328 | <title>Extensible SDK</title> |
329 | 329 | ||
330 | <para>The Extensible SDK provides a number of features that help you | 330 | <para>The Extensible SDK provides a number of features that help you |
331 | easily build, test and package software, and optionally deploy it to | 331 | easily build, test and package software, and optionally deploy it to the |
332 | target device. The Extensible SDK consits of:</para> | 332 | target device.</para> |
333 | |||
334 | <para><emphasis role="bold">The Extensible SDK consits | ||
335 | of:</emphasis></para> | ||
333 | 336 | ||
334 | <itemizedlist> | 337 | <itemizedlist> |
335 | <listitem> | 338 | <listitem> |
@@ -337,7 +340,7 @@ MODULE_LICENSE("GPL");</programlisting> | |||
337 | </listitem> | 340 | </listitem> |
338 | 341 | ||
339 | <listitem> | 342 | <listitem> |
340 | <para>Libraries, Headers and Symbols for x86 architecture</para> | 343 | <para>Libraries, Headers and Symbols for the x86 architecture</para> |
341 | </listitem> | 344 | </listitem> |
342 | 345 | ||
343 | <listitem> | 346 | <listitem> |
@@ -346,9 +349,7 @@ MODULE_LICENSE("GPL");</programlisting> | |||
346 | </listitem> | 349 | </listitem> |
347 | 350 | ||
348 | <listitem> | 351 | <listitem> |
349 | <para>Devtool (d<emphasis>evtool add </emphasis>to create | 352 | <para>Devtool</para> |
350 | automatically a recipe for an existing source code, <emphasis>devtool | ||
351 | modify</emphasis> to build an existing recipe, etc ..)</para> | ||
352 | </listitem> | 353 | </listitem> |
353 | </itemizedlist> | 354 | </itemizedlist> |
354 | 355 | ||
@@ -378,7 +379,7 @@ MODULE_LICENSE("GPL");</programlisting> | |||
378 | </listitem> | 379 | </listitem> |
379 | 380 | ||
380 | <listitem> | 381 | <listitem> |
381 | <para>Setup the toolchain environment for your target by sourcing | 382 | <para>Set up the toolchain environment for your target by sourcing |
382 | the environment-setup script. Example: <programlisting>$ source sdkdir/environment-setup-corei7-64-enea-linux | 383 | the environment-setup script. Example: <programlisting>$ source sdkdir/environment-setup-corei7-64-enea-linux |
383 | SDK environment now set up; additionally you may now run devtool to | 384 | SDK environment now set up; additionally you may now run devtool to |
384 | perform development tasks. | 385 | perform development tasks. |
@@ -390,17 +391,19 @@ Run devtool --help for further details.</programlisting></para> | |||
390 | <section id="add_new_comp_esdk"> | 391 | <section id="add_new_comp_esdk"> |
391 | <title>Adding a new component</title> | 392 | <title>Adding a new component</title> |
392 | 393 | ||
393 | <para>The <emphasis>devtool add</emphasis> command is used to create a | 394 | <para>The<emphasis> <emphasis><literal><literal>devtool</literal> |
394 | new recipe and <emphasis>devtool modify</emphasis> command is used to | 395 | <literal>add</literal></literal></emphasis> </emphasis>command is used |
395 | work on an existing recipe. To add a component, you can:</para> | 396 | to create a new recipe and |
397 | <emphasis><emphasis><literal>devtool</literal> | ||
398 | <literal>modify</literal></emphasis> </emphasis>command is used to work | ||
399 | on an existing recipe. To add a component, you can:</para> | ||
396 | 400 | ||
397 | <para><emphasis role="bold">A) Generate a recipe from the existing | 401 | <para><emphasis role="bold">A) Generate a recipe from the existing |
398 | application code and Makefile</emphasis></para> | 402 | application code and Makefile</emphasis></para> |
399 | 403 | ||
400 | <orderedlist> | 404 | <orderedlist> |
401 | <listitem> | 405 | <listitem> |
402 | <para>Run <emphasis>devtool add</emphasis> command to generate a | 406 | <para>Run devtool add command to generate a recipe:</para> |
403 | recipe:</para> | ||
404 | 407 | ||
405 | <programlisting>$ devtool add recipe /path/to/your_application | 408 | <programlisting>$ devtool add recipe /path/to/your_application |
406 | 409 | ||
@@ -409,10 +412,15 @@ $ devtool add bbexample /path/to/bbexample | |||
409 | or download from upstream git repository | 412 | or download from upstream git repository |
410 | $ devtool add bbexample https://github.com/whbruce/bbexample.git | 413 | $ devtool add bbexample https://github.com/whbruce/bbexample.git |
411 | 414 | ||
412 | NOTE: Recipe <SDK_dir>/workspace/recipes/bbexample/bbexample.bb has been | 415 | |
413 | automatically created; further editing may be required to make it fully functional | 416 | NOTE: devtool creates a Git repository locally during the extraction at: |
414 | NOTE: devtool creates a Git repository locally during the extraction under | 417 | sdkdir/workspace/source/bbexample</programlisting> |
415 | <SDK_dir>/workspace/source/bbexample</programlisting> | 418 | |
419 | <note> | ||
420 | <para>Recipe | ||
421 | <literal>sdkdir/workspace/recipes/bbexample/bbexample.bb has been | ||
422 | automatically created.</literal></para> | ||
423 | </note> | ||
416 | </listitem> | 424 | </listitem> |
417 | </orderedlist> | 425 | </orderedlist> |
418 | 426 | ||
@@ -421,7 +429,8 @@ NOTE: devtool creates a Git repository locally during the extraction under | |||
421 | 429 | ||
422 | <orderedlist> | 430 | <orderedlist> |
423 | <listitem> | 431 | <listitem> |
424 | <para>Use any recipe from <SDK_dir>/layers/poky/meta*</para> | 432 | <para>Use any recipe from |
433 | <literal>sdkdir/layers/poky/meta*</literal></para> | ||
425 | 434 | ||
426 | <programlisting>$ devtool modify recipe | 435 | <programlisting>$ devtool modify recipe |
427 | 436 | ||
@@ -439,12 +448,12 @@ $ devtool modify curl</programlisting> | |||
439 | <para>Clone a recipe from the upstream Yocto project, e.g. | 448 | <para>Clone a recipe from the upstream Yocto project, e.g. |
440 | meta-security:</para> | 449 | meta-security:</para> |
441 | 450 | ||
442 | <programlisting>$ pushd <SDK_dir>/layers/poky | 451 | <programlisting>$ pushd sdkdir/layers/poky |
443 | $ git clone -b rocko git://git.yoctoproject.org/meta-security</programlisting> | 452 | $ git clone -b rocko git://git.yoctoproject.org/meta-security</programlisting> |
444 | </listitem> | 453 | </listitem> |
445 | 454 | ||
446 | <listitem> | 455 | <listitem> |
447 | <para>Use the <emphasis>bitbake-layers</emphasis> script to add the | 456 | <para>Use the <literal>bitbake-layers</literal> script to add the |
448 | meta-security to BBLAYERS:</para> | 457 | meta-security to BBLAYERS:</para> |
449 | 458 | ||
450 | <programlisting>$ layers/poky/bitbake/bin/bitbake-layers add-layer layers/poky/meta-security | 459 | <programlisting>$ layers/poky/bitbake/bin/bitbake-layers add-layer layers/poky/meta-security |
@@ -456,32 +465,42 @@ not enabled in your configuration | |||
456 | clone meta-perl from openembedded and run add-layers again: | 465 | clone meta-perl from openembedded and run add-layers again: |
457 | $ layers/poky/bitbake/bin/bitbake-layers add-layer layers/poky/meta-security | 466 | $ layers/poky/bitbake/bin/bitbake-layers add-layer layers/poky/meta-security |
458 | 467 | ||
459 | NOTE: Now <SDK_dir>/layers/poky/meta-security is created and the layer has been | 468 | NOTE: Now sdkdir/layers/poky/meta-security is created and the layer has been |
460 | added to: <SDK_dir>/conf/bblayers.conf | 469 | added to: sdkdir/conf/bblayers.conf |
461 | ... | 470 | ... |
462 | ${SDKBASEMETAPATH}/layers/poky/meta-security \</programlisting> | 471 | ${SDKBASEMETAPATH}/layers/poky/meta-security \</programlisting> |
472 | |||
473 | <note> | ||
474 | <para>The image build result can be seen at: | ||
475 | <literal>sdkdir/tmp/deploy/images/qemux86-64</literal></para> | ||
476 | </note> | ||
463 | </listitem> | 477 | </listitem> |
464 | 478 | ||
465 | <listitem> | 479 | <listitem> |
466 | <para>Use <emphasis>devtool modify</emphasis> command to work an an | 480 | <para>Use <literal>devtool modify</literal> to operate an existing |
467 | existing recipe inside meta-security layer:</para> | 481 | recipe inside meta-security layer:</para> |
468 | 482 | ||
469 | <programlisting>$ devtool modify recipe | 483 | <programlisting>$ devtool modify recipe |
470 | 484 | ||
471 | EX: | 485 | EX: |
472 | $ devtool modify isic | 486 | $ devtool modify isic |
473 | 487 | ||
474 | NOTE: following directories and files are created: | 488 | NOTE: </programlisting> |
475 | <SDK_dir>/workspace/appends/isic_0.07.bbappend | 489 | |
476 | <SDK_dir>/workspace/sources/isic</programlisting> | 490 | <note> |
491 | <para>following directories and files are created: | ||
492 | sdkdir/workspace/appends/isic_0.07.bbappend | ||
493 | sdkdir/workspace/sources/isic</para> | ||
494 | </note> | ||
477 | </listitem> | 495 | </listitem> |
478 | </orderedlist> | 496 | </orderedlist> |
479 | </section> | 497 | </section> |
480 | 498 | ||
481 | <section id="devtool_build"> | 499 | <section id="devtool_build"> |
482 | <title>Build your application/recipe</title> | 500 | <title>Build your application</title> |
483 | 501 | ||
484 | <para>Use devtool build command to build the recipe:</para> | 502 | <para>Use <literal>devtool</literal> <literal>build</literal> to build |
503 | the recipe:</para> | ||
485 | 504 | ||
486 | <orderedlist> | 505 | <orderedlist> |
487 | <listitem> | 506 | <listitem> |
@@ -491,8 +510,8 @@ EX: | |||
491 | $ devtool build bbexample | 510 | $ devtool build bbexample |
492 | or | 511 | or |
493 | $ devtool build isic</programlisting><note> | 512 | $ devtool build isic</programlisting><note> |
494 | <para>The image build result can be seen here: | 513 | <para>The image build result can be seen at: |
495 | <literal><SDK_dir>/tmp/deploy/images/qemux86-64</literal></para> | 514 | <literal>sdkdir/tmp/deploy/images/qemux86-64</literal></para> |
496 | </note></para> | 515 | </note></para> |
497 | </listitem> | 516 | </listitem> |
498 | </orderedlist> | 517 | </orderedlist> |
@@ -502,9 +521,9 @@ $ devtool build isic</programlisting><note> | |||
502 | <section id="deploy"> | 521 | <section id="deploy"> |
503 | <title>Deploy your Application to target</title> | 522 | <title>Deploy your Application to target</title> |
504 | 523 | ||
505 | <para>Deploy your application to target by using <emphasis>devtool | 524 | <para>Deploy your application to the target by using <literal>devtool |
506 | deploy-target</emphasis> command or build an docker image and dploy the | 525 | deploy-target</literal> or by building a <literal>docker |
507 | docker image.</para> | 526 | image</literal>.</para> |
508 | 527 | ||
509 | <section id="deploy-artifacts-esdk"> | 528 | <section id="deploy-artifacts-esdk"> |
510 | <title>Using <emphasis>devtool deploy-target</emphasis> command</title> | 529 | <title>Using <emphasis>devtool deploy-target</emphasis> command</title> |
@@ -529,8 +548,9 @@ $ devtool deploy-target isic root@<target_ip_address> | |||
529 | isic: error while loading shared libraries: libnet.so.9: cannot open shared | 548 | isic: error while loading shared libraries: libnet.so.9: cannot open shared |
530 | object file: No such file or directory | 549 | object file: No such file or directory |
531 | 550 | ||
532 | NOTE: If you get dependency error, you need to build that recipe as well and | 551 | NOTE: It is mandatory to add required dependecies. E.g. isic is dependent on libnet, |
533 | deploy to target: | 552 | you need to build and deploy libnet separately to the target: |
553 | |||
534 | $ devtool modify libnet | 554 | $ devtool modify libnet |
535 | $ devtool build libnet | 555 | $ devtool build libnet |
536 | $ devtool deploy-target libnet root@<target_ip_address> | 556 | $ devtool deploy-target libnet root@<target_ip_address> |
@@ -542,8 +562,7 @@ usage: isic [-v] [-D] -s <source ip> -d <destination ip> [-r <ran | |||
542 | </listitem> | 562 | </listitem> |
543 | 563 | ||
544 | <listitem> | 564 | <listitem> |
545 | <para>Remove/uninstall the application from target if you don't need | 565 | <para>Remove/uninstall the application from target as needed:</para> |
546 | it:</para> | ||
547 | 566 | ||
548 | <programlisting>$ devtool undeploy-target isic root@<target_ip_address></programlisting> | 567 | <programlisting>$ devtool undeploy-target isic root@<target_ip_address></programlisting> |
549 | </listitem> | 568 | </listitem> |
@@ -571,20 +590,13 @@ inherit core-image</programlisting> | |||
571 | </listitem> | 590 | </listitem> |
572 | 591 | ||
573 | <listitem> | 592 | <listitem> |
574 | <para>Add the following line in | ||
575 | <literal>local.conf</literal>:</para> | ||
576 | |||
577 | <programlisting>IMAGE_CONTAINER_NO_DUMMY = "1"</programlisting> | ||
578 | </listitem> | ||
579 | |||
580 | <listitem> | ||
581 | <para>Build the container image:</para> | 593 | <para>Build the container image:</para> |
582 | 594 | ||
583 | <programlisting>$ devtool build-image cont-image </programlisting> | 595 | <programlisting>$ devtool build-image cont-image </programlisting> |
584 | 596 | ||
585 | <note> | 597 | <note> |
586 | <para>The image build result can be seen here: | 598 | <para>The image build result can be seen at: |
587 | <literal><SDK_dir>/tmp/deploy/images/qemux86-64</literal></para> | 599 | <literal>sdkdir/tmp/deploy/images/qemux86-64</literal></para> |
588 | </note> | 600 | </note> |
589 | </listitem> | 601 | </listitem> |
590 | 602 | ||