From 5421fa28adf9a340043e3efcaa3bc828d040f956 Mon Sep 17 00:00:00 2001 From: Sona Sarmadi Date: Mon, 3 Jun 2019 13:54:17 +0200 Subject: GettingStarted: Add Bare Metal Provisioning chapter Change-Id: I86b67a965cf86bad653947766a3698cbe62da091 Signed-off-by: Sona Sarmadi Signed-off-by: Martin Borg --- .../doc/bare_metal_provisioning.xml | 147 +++++++++++++++++++++ .../doc/book.xml | 3 + 2 files changed, 150 insertions(+) create mode 100644 doc/book-enea-nfv-access-getting-started/doc/bare_metal_provisioning.xml diff --git a/doc/book-enea-nfv-access-getting-started/doc/bare_metal_provisioning.xml b/doc/book-enea-nfv-access-getting-started/doc/bare_metal_provisioning.xml new file mode 100644 index 0000000..3e6869f --- /dev/null +++ b/doc/book-enea-nfv-access-getting-started/doc/bare_metal_provisioning.xml @@ -0,0 +1,147 @@ + + + + Bare Metal Provisioning + + This chapter contains information needed in order to use Bare Metal + Provisioning. Bare Metal Provisioning is an optional feature in the Enea NFV + Access Run Time Platform. If you do not intend to use this feature, skip to + the next chapter. + +
+ Introduction + + Bare Metal Provisioning can be used for automated deployment of the Enea + NFV Access Run Time Platform on a large number of uCPE devices. The uCPE + devices may have no previous operating system installed, or are reinstalled + without preserving any existing data. Enea NFV Access Bare + Metal Provisioning is based on standardized Pre-Boot Execution environment (PXE) booting. + + The Bare Metal Provisioning process begins by PXE booting an Enea + NFV Access installer initramfs image. The installer downloads a + configuration file, as well as the Enea NFV Access Run Time Platform image and + then proceeds to install the system by dividing the disk into 2 partitions. A GPT + partition containing the GRUB boot loader and a second partition + containing the Enea NFV Access Run Time Platform root filesystem. When the + installation is complete, the uCPE device is automatically rebooted into + Enea NFV Access Run Time Platform. +
+ +
+ Prerequisites + + + + The uCPE devices to be installed are connected in a working PXE + network boot environment. The PXE server can be set up using any Linux + distribution that includes TFTP and DHCP software packages. Refer to + the documentation for your distribution for setup instructions. + + + + An HTTP server must be available in the provisioning + network. + + + + The uCPE devices are preconfigured in BIOS to boot from the + hard drive where the Enea NFV Access Run Time Platform will be + installed. + + + + A remote management tool is available that can be used to set + the next boot option to PXE and reboot the uCPE devices in order to + begin the installation. + + +
+ +
+ Installation Configuration File + + An installation configuration file needs to be available on an HTTP + server in the provisioning network. + + The installer will use the same interface that the uCPE device + was PXE-booted from, to obtain an IP address (using DHCP) and access the HTTP server. + + The configuration parameters are described below. The configuration + file format is a list of "name = value" pairs. + + + + image_url. The HTTP URL used for downloading + the Enea NFV Access Run Time Platform image (in gzip compressed hddimg + format) to be installed on the uCPE device(s). This image is provided + with your Enea NFV Access release. This parameter is mandatory. + + + + install_drive. The name of the drive where + the Enea NFV Access Run Time Platform will be installed (e.g /dev/sda). + This parameter is optional. If no value is set, the installer will use + the largest detected (non-USB) drive on the uCPE device. + + + + prompt_user. If the parameter is set to + "yes", the installer will prompt the user before formatting and + partitioning the drive. This parameter is optional. The default + behaviour is to not prompt the user (unattended installation). + + + + Installation Configuration File Example: + + + image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz + install_drive = /dev/sda + +
+ +
+ PXE Configuration + + Copy the Enea NFV Access installer initramfs image and kernel + to the tftpboot directory on the PXE server (e.g + /var/lib/tftpboot). These files are provided with your + Enea NFV Access release. + + A PXE entry for the Enea NFV Access installation needs to be added as + the default boot selection in the pxelinux configuration file (e.g + /var/lib/tftpboot/pxelinux.cfg/default). The PXE entry + should have the following settings: + + + default nfv_access + label nfv_access + menu label ^NFV_ACCESS_INSTALLER + kernel <Path to kernel> + append root=/dev/ram0 initrd=<Path to initramfs> LABEL=pxe-installer \ + INSTALL_CFG=http://<Server IP>/<Path to configuration file> + ipappend 2 + +
+ +
+ Starting the Installation + + To initiate the installation, set the boot device (for next boot + only) to PXE and reboot the uCPE devices. How to do this depends on the + remote management capabilities of the uCPE devices and may be + vendor-specific. + + Example initiation using ipmitool: + + + ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address> chassis bootdev pxe + ipmitool -U <user> -P <password> -H <uCPE device IPMI IP address> power reset + + + The uCPE devices should be configured in BIOS to boot from the + installation drive first in order to automatically start the Enea NFV Access + Run Time Platform when the installation is finished. +
+ \ No newline at end of file diff --git a/doc/book-enea-nfv-access-getting-started/doc/book.xml b/doc/book-enea-nfv-access-getting-started/doc/book.xml index 534b7f9..abce2c2 100644 --- a/doc/book-enea-nfv-access-getting-started/doc/book.xml +++ b/doc/book-enea-nfv-access-getting-started/doc/book.xml @@ -27,6 +27,9 @@ + + -- cgit v1.2.3-54-g00ecf