diff options
| -rw-r--r-- | doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml | 77 |
1 files changed, 51 insertions, 26 deletions
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml index 72c5570..77c3244 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml | |||
| @@ -19,7 +19,7 @@ | |||
| 19 | <itemizedlist> | 19 | <itemizedlist> |
| 20 | <listitem> | 20 | <listitem> |
| 21 | <para>If your system runs Ubuntu, use list to verify if | 21 | <para>If your system runs Ubuntu, use list to verify if |
| 22 | <filename>/usr/bin</filename> is a symbolic link to | 22 | <filename>/bin/sh</filename> is a symbolic link to |
| 23 | <literal>bash</literal>:</para> | 23 | <literal>bash</literal>:</para> |
| 24 | 24 | ||
| 25 | <programlisting># ls -l /bin/sh | 25 | <programlisting># ls -l /bin/sh |
| @@ -266,16 +266,33 @@ sdb 8:0 0 111.8G 0 disk | |||
| 266 | 266 | ||
| 267 | <listitem> | 267 | <listitem> |
| 268 | <para>Once the USB stick is properly booted, a GRUB menu appears on | 268 | <para>Once the USB stick is properly booted, a GRUB menu appears on |
| 269 | the serial console. Two options are available:</para> | 269 | the serial console. The following options are available:</para> |
| 270 | 270 | ||
| 271 | <itemizedlist> | 271 | <itemizedlist> |
| 272 | <para><emphasis role="bold">Using the serial | ||
| 273 | console</emphasis>:</para> | ||
| 274 | |||
| 272 | <listitem> | 275 | <listitem> |
| 273 | <para>live-boot. Boots NFV Access directly from the USB | 276 | <para>live-boot serial. Boots NFV Access directly from the USB |
| 274 | stick.</para> | 277 | stick.</para> |
| 275 | </listitem> | 278 | </listitem> |
| 276 | 279 | ||
| 277 | <listitem> | 280 | <listitem> |
| 278 | <para>Installer. Launches the NFV Access installer.</para> | 281 | <para>installer serial. Launches NFV Access.</para> |
| 282 | </listitem> | ||
| 283 | </itemizedlist> | ||
| 284 | |||
| 285 | <itemizedlist> | ||
| 286 | <para><emphasis role="bold">Using the graphics | ||
| 287 | console:</emphasis></para> | ||
| 288 | |||
| 289 | <listitem> | ||
| 290 | <para>live-boot graphical. Boots NFV Access directly from the | ||
| 291 | USB stick.</para> | ||
| 292 | </listitem> | ||
| 293 | |||
| 294 | <listitem> | ||
| 295 | <para>installer graphical. Launches NFV Access.</para> | ||
| 279 | </listitem> | 296 | </listitem> |
| 280 | </itemizedlist> | 297 | </itemizedlist> |
| 281 | 298 | ||
| @@ -287,7 +304,8 @@ sdb 8:0 0 111.8G 0 disk | |||
| 287 | 304 | ||
| 288 | <listitem> | 305 | <listitem> |
| 289 | <para>To launch the installer, select <command>installer</command> | 306 | <para>To launch the installer, select <command>installer</command> |
| 290 | from the GRUB menu. An installation menu will appear, containing the following options:</para> | 307 | from the GRUB menu. An installation menu will appear, containing the |
| 308 | following options:</para> | ||
| 291 | 309 | ||
| 292 | <itemizedlist> | 310 | <itemizedlist> |
| 293 | <listitem> | 311 | <listitem> |
| @@ -371,13 +389,14 @@ sdb 8:0 0 111.8G 0 disk | |||
| 371 | <para>Device ID. An unique uuid format string.</para> | 389 | <para>Device ID. An unique uuid format string.</para> |
| 372 | </listitem> | 390 | </listitem> |
| 373 | </itemizedlist> | 391 | </itemizedlist> |
| 374 | <note> | 392 | |
| 375 | <para>Modifying any of the Default parameters (e.g Core | 393 | <note> |
| 376 | isolation, 1G huge page count, etc.) will automatically update | 394 | <para>Modifying any of the Default parameters (e.g Core |
| 377 | the kernel parameters string. Updating the Custom | 395 | isolation, 1G huge page count, etc.) will automatically update |
| 378 | parameters within the kernel string directly will override any | 396 | the kernel parameters string. Updating the Custom parameters |
| 379 | values set previously for the Default parameters.</para> | 397 | within the kernel string directly will override any values set |
| 380 | </note> | 398 | previously for the Default parameters.</para> |
| 399 | </note> | ||
| 381 | </listitem> | 400 | </listitem> |
| 382 | </itemizedlist> | 401 | </itemizedlist> |
| 383 | </listitem> | 402 | </listitem> |
| @@ -388,9 +407,8 @@ sdb 8:0 0 111.8G 0 disk | |||
| 388 | 407 | ||
| 389 | <note> | 408 | <note> |
| 390 | <para>It is recommended to perform a dry run with the | 409 | <para>It is recommended to perform a dry run with the |
| 391 | <command>Start install (dry run)</command> option | 410 | <command>Start install (dry run)</command> option before |
| 392 | before proceeding with actually modifying the | 411 | proceeding with actually modifying the drive.</para> |
| 393 | drive.</para> | ||
| 394 | </note> | 412 | </note> |
| 395 | </listitem> | 413 | </listitem> |
| 396 | 414 | ||
| @@ -478,7 +496,7 @@ run</programlisting> | |||
| 478 | <figure> | 496 | <figure> |
| 479 | <mediaobject> | 497 | <mediaobject> |
| 480 | <imageobject> | 498 | <imageobject> |
| 481 | <imagedata align="center" fileref="images/efi_menu.png" scale="60" /> | 499 | <imagedata align="center" fileref="images/efi_menu.png" scale="60" /> |
| 482 | </imageobject> | 500 | </imageobject> |
| 483 | </mediaobject> | 501 | </mediaobject> |
| 484 | </figure> | 502 | </figure> |
| @@ -501,18 +519,23 @@ run</programlisting> | |||
| 501 | 519 | ||
| 502 | <itemizedlist> | 520 | <itemizedlist> |
| 503 | <listitem> | 521 | <listitem> |
| 504 | <para>If a system has an amount of memory that's lower than 8GB, | 522 | <para>If a system has an amount of memory up to 8GB, the allocation |
| 505 | the allocation algorithm will reserve 70% of the memory as hugepages, | 523 | algorithm will reserve up to 30%, but no more than 2GB, for the OS and |
| 506 | leaving the rest to be used by the OS.</para> | 524 | the rest as huge pages.</para> |
| 507 | </listitem> | 525 | </listitem> |
| 508 | 526 | ||
| 509 | <listitem> | 527 | <listitem> |
| 510 | <para>If a system has an amount of memory that's higher than 8GB, the allocation | 528 | <para>If a system has an amount of memory that's higher than 8GB, the |
| 511 | algorithm will reserve all but 2GB of memory as 1GB hugepages, leaving the rest (2GB) | 529 | allocation algorithm will reserve all but 2GB of memory as 1GB |
| 512 | to be used by the OS.</para> | 530 | hugepages, leaving the rest (2GB) to be used by the OS.</para> |
| 513 | </listitem> | 531 | </listitem> |
| 514 | </itemizedlist> | 532 | </itemizedlist> |
| 515 | 533 | ||
| 534 | <note> | ||
| 535 | <para>This is a best effort reservation, after the kernel boot, so the | ||
| 536 | results may not be as described.</para> | ||
| 537 | </note> | ||
| 538 | |||
| 516 | <section id="hugepage_customizing_auto"> | 539 | <section id="hugepage_customizing_auto"> |
| 517 | <title>Customizing Automatic Hugepage Reservation</title> | 540 | <title>Customizing Automatic Hugepage Reservation</title> |
| 518 | 541 | ||
| @@ -569,16 +592,18 @@ run</programlisting> | |||
| 569 | 592 | ||
| 570 | <itemizedlist> | 593 | <itemizedlist> |
| 571 | <listitem> | 594 | <listitem> |
| 572 | <para>2GB of memory: approximately 616MB allocated for OS and 1432MB allocated | 595 | <para>2GB of memory: 1024MB allocated for OS and 1024MB allocated as |
| 573 | as 2MB hugepages.</para> | 596 | 2MB hugepages.</para> |
| 574 | </listitem> | 597 | </listitem> |
| 575 | 598 | ||
| 576 | <listitem> | 599 | <listitem> |
| 577 | <para>4GB of memory: 1024MB allocated for OS and 7168MB as hugepages.</para> | 600 | <para>4GB of memory: 1024MB allocated for OS and 3072MB allocated as |
| 601 | 2MB hugepages.</para> | ||
| 578 | </listitem> | 602 | </listitem> |
| 579 | 603 | ||
| 580 | <listitem> | 604 | <listitem> |
| 581 | <para>16GB of memory: 2GB allocated for OS and 14GB as 1GB hugepages.</para> | 605 | <para>16GB of memory: 1GB allocated for OS and 15GB as 1GB |
| 606 | hugepages.</para> | ||
| 582 | </listitem> | 607 | </listitem> |
| 583 | </itemizedlist> | 608 | </itemizedlist> |
| 584 | </section> | 609 | </section> |
