From b3ce8ffb11a8be15b1998f67dc9f388dc7278287 Mon Sep 17 00:00:00 2001 From: Miruna Paun Date: Mon, 4 Dec 2017 13:08:25 +0100 Subject: LXCR-8047 Created a copy of the NFV Access Guide and Release Notes for intel --- .../doc/getting_started.xml | 360 +++++++++++++-------- ...kernel-in-grub2-boot-loader-on-ubuntu-14.04.png | Bin 0 -> 6403 bytes ...kernel-in-grub2-boot-loader-on-ubuntu-14.04.svg | 3 + 3 files changed, 222 insertions(+), 141 deletions(-) create mode 100644 doc/book-enea-nfv-access-guide/doc/images/select-linux-kernel-in-grub2-boot-loader-on-ubuntu-14.04.png create mode 100644 doc/book-enea-nfv-access-guide/doc/images/select-linux-kernel-in-grub2-boot-loader-on-ubuntu-14.04.svg (limited to 'doc/book-enea-nfv-access-guide') 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 ed74f48..b6cf927 100644 --- a/doc/book-enea-nfv-access-guide/doc/getting_started.xml +++ b/doc/book-enea-nfv-access-guide/doc/getting_started.xml @@ -5,254 +5,332 @@ Getting Started with Enea NFV Access Using Enea NFV Access requires access to a Linux machine, which is - used for preparing the bootable drive or for developing applications. System + used for preparing a bootable drive or for developing applications. System requirements for the development host are detailed in the document included - with this release. + xpointer="element(book_enea_nfv_access_release_info/1)" />.
- System Shell Configuration + Default Shell Configuration - Before installing Enea NFV Access, ensure that bash is the default - shell. + Before installing Enea NFV Access, make sure that bash is the + default shell. - If your system runs Ubuntu, you can use ls -l to ensure - /usr/bin is a symbolic link to bash. In case the link - points to dash, which is default in some Ubuntu versions, change it to - bash by running sudo dpkg-reconfigure - dash and answer No to the - question Use dash as the default system shell - (/bin/sh)?: + To verify the default system + shell - # ls -l /bin/sh + + + If your system runs Ubuntu, use list to verify if + /usr/bin is a symbolic link to bash: + + # ls -l /bin/sh lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -> bash + + + + Optionally, in case the link points to dash, + change it through the following steps: + + # ls -l /bin/sh +lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -> dash +# sudo dpkg-reconfigure dash +Use dash as the default system shell (/bin/sh)? No + +
Enea NFV Access Installer - The easiest way to get up and running with Enea NFV Access is to use - the installer provided in the install directory for each supported - architecture in this release. The purpose of this installer is to guide - you through creating a bootable Enea NFV Access installation on a physical - media (e.g. USB stick or HDD). + The easiest way to get started with Enea NFV Access is by using the + installer provided for each supported architecture in this release. Each + installer guides you in the creation of a bootable Enea NFV Access + installation on a physical media. -
- Installer Prerequisites +
+ Prerequisites - Using the installer on the development host requires the - following: + The following files are needed on the development host + machine: - a GRUB .efi binary + A GRUB.efi binary - available from the GNU + GRUB download page. - a physical drive of 16GB or larger + For booting from an SSD/HDD: a rootfs that needs to be + installed on the board (e.g. + [path_to_EneaNFV_Access_folder]/[architecture]/inteld1521/images/enea-nfv-access/enea-nfv-access.tar.gz). - For USB booting you will need: a development based rootfs, - provided with the release (e.g. - enea-nfv-access-dev-inteld1521.tar.gz). + For USB booting: a development based rootfs (e.g. + [path_to_EneaNFV_Access_folder]/[architecture]/inteld1521/images/enea-nfv-access-dev/enea-nfv-access-dev-inteld1521.tar.gz). + + Using the installer on the development host requires the + following: + + - For booting from an SSD or HDD you will need: any rootfs that - needs to be installed on the board, provided with the release (e.g. - enea-nfv-access.tar.gz). + A physical drive of 16GB or larger + + + + Root permissions
-
- Installer Usage - - The Enea NFV Access installer - shall be executed on the development host machine with root permissions. - Once the nfv_installer prompt is displayed, press - ENTER to get the full list of built-in - commands: - - help - a guide on how to use the installer -list-params - lists parameters -list-steps - lists the available steps and the parameters that they depend on -set - sets a parameter (e.g. "set drive=/dev/sda") -clear - clears a parameter (e.g. "clear drive") -list-partitions - lists current drives and partitions -dry - describes the steps to be executed and checks if the files exist -run - executes the steps -q or quit - exits the script - - Enea NFV Access creates a bootable media by performing these - steps: +
+ Installer Setup and Usage + + To install Enea NFV Access on a physical + drive - Create two partitions on a designated drive (e.g. - /dev/sda): + Go to the installer location: # cd [path_to_EneaNFV_Access_folder]/[architecture]/install/ +nfv-installer/script-installer + + + + Execute the script file, this will bring you to the installer + prompt: # sudo ./nfv_installer.sh + + + + Optionally, press ENTER to see the list of available + commands:help - displays a guide on how to use the installer +list-params - lists all available parameters +list-steps - lists the installer steps and the parameters that they depend on +set - sets a parameter (e.g. set drive=/dev/sda) +clear - clears a parameter (e.g. clear drive) +list-partitions - lists current drives and partitions +dry - performs a simulation test run +run - executes the installer, using the values you set for each parameter +q or quit - exits the script + + + + Set the required parameters depending on what steps you want + to run: + + + When using the installer for the first time, make sure to + set ALL parameters in order to be able to run all steps. See + "Example 2" + for details. + + + # set <parameter_name>=<parameter_value> + + + + drive=</dev/sdaX> - the drive + to partition + + + + grub_binary=<file> - points + to the GRUB executable to be installed + where grub_destination is set. + + + + grub_destination=<drive> - + specifies the partition where GRUB will be + installed + - - a 512MB partition for GRUB + rootfs_destination=<drive> - + specifies the partition where the rootfs + will be deployed, used by GRUB to boot off + of. - the rest of the drive is reserved for the rootfs + rootfs_targz=<rootfs.tar.gz + file> - the archive of the Enea NFV Access + rootfs you wish to unpack to where + rootfs_destination is set. Which file you + unpack depends on whether you booting from an SSD/HDD or from a + USB drive. - + - Configure GRUB on one partition (usually the first - one). + Optionally, perform a test run before affecting the actual + layout of the physical media with the command: dry - Copy a root filesystem on the other partition. + Run the installer: run - - - Running step 3 will implicitly copy the installer on that root - filesystem in - /usr/bin/install_nfvaccess.sh. - + + Exit the script: quit + + - Each step mentioned above is executed or not depending on whether - certain parameters are set. Run the - list-steps command in order to - understand the built-in steps that the installer can execute and what - parameters they depend on. The command will print the following: + The Enea NFV Access installer creates a bootable media by + performing three steps. Each step is executed or not depending on + whether certain parameters are set: - Format drive - Uses the drive set for the - drive parameter to create a 512MB partition for - GRUB and another partition for the rootfs. The rootfs partition will - be as large as the physical media minus 512MB. This step depends on - the following parameter(s): drive= + Format drive - creates a 512MB partition + which will be used by GRUB, and another to be + used for the rootfs (it should occupy the rest + of the physical media minus the first partition). This step depends + on the following parameter(s): drive= GRUB install - Installs the - binary pointed to by grub_binary on the drive set - in grub_destination. A - grub.cfg file will be created that will be - configured to boot off of rootfs_destination. - This step depends on the following parameters:grub_destination= + grub_binary on the drive set for + grub_destination. A grub.cfg + file will be created that will be configured to boot off of + rootfs_destination. This step depends on the + following parameters:grub_destination= grub_binary= rootfs_destination= - Root filesystem install - - Copies the files found in rootfs_targz to the - drive set in rootfs_destination. This step - depends on the following parameters:rootfs_targz= + Root Filesystem install - + Copies and unpacks the files found in + rootfs_targz to the + rootfs_destination. This step depends on the + following parameters:rootfs_targz= rootfs_destination= - Parameters can be set through the set command - or cleared using the clear command. Since some - parameters are common for multiple steps, as is - rootfs_destination for the GRUB and rootfs - installation steps, you can get a list of all the parameters, by running - list-params. - - The following parameters can be configured:grub_destination=[drive] - specifies the drive where GRUB will be installed -grub_binary=[file] - points to the GRUB executable to be installed - where grub_destination is set -rootfs_destination=[drive] - specifies where the rootfs will be deployed -rootfs_targz=[.tar.gz file] - what file to unpack to where rootfs_destination is set -drive=[/dev/sdaX] - what drive to partition - - Before performing the actual partitioning and copying, a dry run, - using the dry command, can be executed without - affecting the actual layout of the physical media. Once all the - parameters are set according to the intended scenario, simply execute - the run command to set up the bootable media. Below - are a few examples of how the Enea NFV Access installer may be - used. - - Example of partitioning a drive:set drive=/dev/sda -run - - Example of partitioning a drive, installing GRUB and a root - filesystem:set drive=/dev/sda + After using the installer and setting up the bootable media, + connect it to the target machine and configure the target machine to use + it as a primary boot device. +
+ +
+ Examples of Execution + + Below are a few examples of setups that the Enea NFV Access + installer can be used for: + + + Partitioning a drive + + set drive=/dev/sda +run + + + + Partitioning a drive, installing GRUB and a Root + Filesystem: + + set drive=/dev/sda set grub_destination=/dev/sda1 set grub_binary=/home/user/grub-binary.efi set rootfs_destination=/dev/sda2 set rootfs_targz=/home/user/rootfs.tar.gz -run +run + - Example of deploying ONLY a root filesystem:set rootfs_destination=/dev/sda2 -set rootfs_targz=/home/user/rootfs.tar.gz -runs + + Deploying ONLY a root filesystem: - After using the installer and setting up the bootable media, - connect it to the target machine and configure the target machine to use - it as a primary boot device. + set rootfs_destination=/dev/sda2 +set rootfs_targz=/home/user/rootfs.tar.gz +run +
Troubleshooting - GRUB might display the following: error: no such - partition or error: disk not found, if - the default GRUB config is set to use hd0 as the - primary drive for booting. Due to this, the errors described above have - two possible causes: + GRUB might display the following errors if the default + configuration is set to use hd0 as the primary + drive for booting: + + + + error: no such partition + + + + error: disk not found + + + + These errors have two possible causes: The drive where Enea NFV Access was installed is not - identified as hd0 by the BIOS. + identified as hd0 by BIOS. - The BIOS has assigned the hd0 label to a + BIOS has assigned the hd0 label to a different drive (e.g. a USB stick) than the one where Enea NFV Access was installed. - The solution for these errors is detailed below: + To rectify these problems the primary boot drive must be assigned + to the correct partition. + + To change the partition for the primary boot + drive - In the GRUB selection screen press - c to enter the command - line. + Restart the host and in the GRUB + selection screen, enter the command line by pressing + C: + + + + + + - Run ls to list all of the available - partitions + List all of the available partitions with + ls: partition list example - For each available partition run ls - PARTITION in order to identify where Enea NFV Access was - installed. + In order to identify where Enea NFV Access was installed, for + each available partition run ls + <partition>: ls hd0 - After identifying the partition, press ESC - to return to the GRUB selection screen and press - e to edit the boot command. + After identifying the partition, return to the GRUB selection + screen by pressing esc - Set the boot partition to the one identified in step 3 + Press e to edit and set the boot partition + to the one identified previously: edit and set partition example - Press F10 to boot + To reboot to see if the change worked, press: + F10
diff --git a/doc/book-enea-nfv-access-guide/doc/images/select-linux-kernel-in-grub2-boot-loader-on-ubuntu-14.04.png b/doc/book-enea-nfv-access-guide/doc/images/select-linux-kernel-in-grub2-boot-loader-on-ubuntu-14.04.png new file mode 100644 index 0000000..c28d643 Binary files /dev/null and b/doc/book-enea-nfv-access-guide/doc/images/select-linux-kernel-in-grub2-boot-loader-on-ubuntu-14.04.png differ diff --git a/doc/book-enea-nfv-access-guide/doc/images/select-linux-kernel-in-grub2-boot-loader-on-ubuntu-14.04.svg b/doc/book-enea-nfv-access-guide/doc/images/select-linux-kernel-in-grub2-boot-loader-on-ubuntu-14.04.svg new file mode 100644 index 0000000..319bf7e --- /dev/null +++ b/doc/book-enea-nfv-access-guide/doc/images/select-linux-kernel-in-grub2-boot-loader-on-ubuntu-14.04.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file -- cgit v1.2.3-54-g00ecf