From 1b9b859ee60570de0064781de3cca45f7b8ddfbc Mon Sep 17 00:00:00 2001 From: Martin Borg Date: Fri, 27 Sep 2019 15:09:16 +0200 Subject: GettingStarted: Update Bare-metal Provisioning chapter - Add information about server notifications - Restructure into subsections Change-Id: I6fa6b41eb118acd68746cf2038c348f723c1f407 Signed-off-by: Martin Borg --- .../doc/bare_metal_provisioning.xml | 205 ++++++++++++++------- 1 file changed, 134 insertions(+), 71 deletions(-) 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 index 3e6869f..8ff70ee 100644 --- 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 @@ -12,20 +12,21 @@
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. + 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. + 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.
@@ -40,13 +41,15 @@ - An HTTP server must be available in the provisioning - network. + An HTTP server must be available and accessible from the uCPE + devices in the provisioning network. Note that the installer will use + the same interface that the uCPE device is PXE-booted from, to obtain + an IP address using DHCP and access the HTTP server. - The uCPE devices are preconfigured in BIOS to boot from the - hard drive where the Enea NFV Access Run Time Platform will be + The uCPE devices are preconfigured in BIOS to boot from the hard + drive where the Enea NFV Access Run Time Platform will be installed. @@ -58,71 +61,114 @@
-
- Installation Configuration File +
+ Server Configuration - 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. - + The following images provided with your Enea NFV Access release + needs to be made available on the PXE and HTTP servers: + - 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. + Copy the Enea NFV Access installer initramfs + image and kernel bzImage for the uCPE device + architecture to the TFTP directory on the PXE server (e.g + /var/lib/tftpboot). - 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). + Compress the Enea NFV Access Run Time Platform + hddimg image for the uCPE device architecture using + gzip and copy the resulting + hddimg.gz file to the HTTP server. - - - 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: - - + + +
+ Installation Configuration File + + An installation configuration file needs to be prepared on the + HTTP server. The format of the configuration file is a list of + "name = value" pairs and the available parameters are + described below. + + Mandatory parameters: + + + + image_url. The HTTP server URL used for + downloading the Enea NFV Access Run Time Platform image to be + installed on the uCPE devices in hddimg.gz + format. + + + + Optional parameters: + + + + install_drive. The name of the drive where + the Enea NFV Access Run Time Platform will be installed (e.g + /dev/sda). If not 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 ask for confirmation before formatting and + partitioning the drive. The default behaviour is to proceed + automatically without any user interaction. + + + + Optional parameters for sending status notifications to a server. + All three must be provided if used: + + + + notify_user. Server SSH username + + + + notify_pass. Server SSH password + + + + notify_path. Location where notification + files will be placed, specified in "Server IP:directory" + format. + + + + Installation Configuration File Example: + + + image_url = http://192.168.1.100/enea-nfv-access-xeon-d.hddimg.gz + install_drive = /dev/sda + notify_user = username + notify_pass = password + notify_path = 192.168.1.100:/home/user/status_notifications + + +
+ +
+ PXE Configuration + + 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> + INSTALL_CFG=http://<Server IP>/<Path to install config file> ipappend 2 +
@@ -130,8 +176,8 @@ 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. + remote management capabilities of the uCPE devices and may require + vendor-specific tools. Example initiation using ipmitool: @@ -141,7 +187,24 @@ 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. + installation drive first in order to automatically start the Enea NFV + Access Run Time Platform when the installation is finished. + +
+ Server Notifications + + Optionally, the uCPE devices can send a notification file to a + server once the installation is complete and Enea NFV Access Runtime + Platform has successfully booted. Notifications are enabled by providing + the notify_* parameters in the installation + configuration file. + + Each uCPE device will push a file to the server location specified + in the installation configuration file. The file name will be the MAC + address of the PXE boot network interface in order to uniquely identify + the device. Note that the status notification will only be sent on the + first boot after installation is done, subsequent reboots of the uCPE + device will not cause any new notifications to be sent. +
\ No newline at end of file -- cgit v1.2.3-54-g00ecf