Bootstrap node¶

Creating a custom bootstrap node¶

You can create a new Ubuntu bootstrap using the fuel-bootsrtap command. To create and activate a new Ubuntu bootstrap:

1. Build a new bootstrap image as a .tar archive.
2. Import the configured image from the archive.
3. Activate the new image.

To build the new bootstrap image:

1. Type the command:

   fuel-bootstrap build
   

   System response:

   Try to build image with data:
   bootstrap:
    container: {format: tar.gz, meta_file: metadata.yaml}
    extend_kopts: biosdevname=0 net.ifnames=1 debug ignore_loglevel log_buf_len=10M
      print_fatal_signals=1 LOGLEVEL=8
    extra_files: [/usr/share/fuel_bootstrap_cli/files/trusty]
    label: 93f117b9-65b7-41fa-ade2-52002989dda1
    modules:
    - {mask: kernel, name: kernel, uri: 'http://127.0.0.1:8080/bootstraps/93f117b9-65b7-41fa-ade2-52002989dda1/vmlinuz'}
    - {compress_format: xz, mask: initrd, name: initrd, uri: 'http://127.0.0.1:8080/bootstraps/93f117b9-65b7-41fa-ade2-52002989dda1/initrd.img'}
    - &id001 {compress_format: xz, container: raw, format: ext4, mask: rootfs, name: rootfs,
      uri: 'http://127.0.0.1:8080/bootstraps/93f117b9-65b7-41fa-ade2-52002989dda1/root.squashfs'}
    post_script_file: null
    root_ssh_authorized_file: /root/.ssh/id_rsa.pub
    uuid: 93f117b9-65b7-41fa-ade2-52002989dda1
   
   ...
   
   Build process is in progress. Usually it takes 15-20 minutes. It depends on your Internet connection and hardware performance.
   --- Building bootstrap image (do_mkbootstrap) ---
   *** Preparing image space ***
   Installing BASE operating system into image
   Starting new HTTP connection (1): 127.0.0.1
   Starting new HTTP connection (1): mirror.fuel-infra.org
   Starting new HTTP connection (1): mirror.fuel-infra.org
   Starting new HTTP connection (1): mirror.fuel-infra.org
   Building initramfs
   Building squashfs
   squashfs_image clean-up
   Creating archive: /tmp/93f117b9-65b7-41fa-ade2-52002989dda1.tar.gz
   --- Building bootstrap image END (do_mkbootstrap) ---
   Cleanup chroot
   Bootstrap image 93f117b9-65b7-41fa-ade2-52002989dda1 has been built: /tmp/93f117b9-65b7-41fa-ade2-52002989dda1.tar.gz
   

   A new bootstrap image has been successfully built. By default, Fuel places the new bootstrap image into the /tmp folder. For example, /tmp/93f117b9-65b7-41fa-ade2-52002989dda1.tar.gz.

2. Import the bootstrap image:

   fuel-bootstrap import /tmp/93f117b9-65b7-41fa-ade2-52002989dda1.tar.gz
   

   System response:

   fuel-bootstrap import /tmp/93f117b9-65b7-41fa-ade2-52002989dda1.tar.gz
   
   Try extract /tmp/93f117b9-65b7-41fa-ade2-52002989dda1.tar.gz to /tmp/tmpaLrxol
   Bootstrap image 93f117b9-65b7-41fa-ade2-52002989dda1 has been imported.
   

3. Activate the bootstrap image:

   fuel-bootstrap activate 93f117b9-65b7-41fa-ade2-52002989dda1
   

   System response:

   Starting new HTTP connection (1): 10.20.0.2
   Starting new HTTP connection (1): 10.20.0.2
   Starting new HTTP connection (1): 10.20.0.2
   Starting new HTTP connection (1): 10.20.0.2
   Bootstrap image 93f117b9-65b7-41fa-ade2-52002989dda1 has been activated.
   

fuel-bootstrap-image
fuel-bootstrap-image-set ubuntu

See also:

• Fuel Installation Guide

Modifying initramfs image manually for the bootstrap node¶

The fuel-bootstrap utility builds Ubuntu bootstrap. The bootstrap is split into two files: initrd.img and root.squashfs. Fuel downloads and unpacks the intrd.img file as a temporary file system during the PXE boot. The image makes initialization and downloads the root.squashfs image. After that, the root.squashfs is unpacked. The mount point of the file system is switched to root.squasfs.

There is a possibility to add a package into a bootstrap “on the fly” using the following command:

fuel-bootstrap build --package <package-name>

The command adds the package into both images: initrd.img and root.squashfs.

You can add an arbitrary files and folders into root.squasfs (but not to initrd.img) using the following command:

fuel-bootstrap build --extra-dir <root-path>

There are tasks that require editing a bootstrap manually. For example, adding kernel module binaries into initramfs and root.squashfs.

To edit the initramfs (initrd.img) image, unpack the image, modify, and pack it back. The initramfs image is a compressed cpio archive.

To change the initramfs image (initrd.img) and root.squashfs, follow the steps below.

1. Unpack initrd.img and root.squashfs:

   1. Create a folder for modifying bootstrap and copy the initramfs and root.squashfs images into it:

      mkdir /tmp/initrd-orig
      cp /var/www/nailgun/bootstraps/active_bootstrap/initrd.img /tmp/initrd-orig/
      cp /var/www/nailgun/bootstraps/active_bootstrap/root.squashfs /tmp/initrd-orig/
      

   2. Unpack initramfs.

      1. Uncompress the initrd.img file:

         cd /tmp/initrd-orig/
         mv initrd.img initrd.img.xz
         xz -d initrd.img.xz
         

      2. Unpack the cpio archive to the initramfs folder:

         mkdir initramfs
         cd initramfs
         cpio -i < ../initrd.img
         

   3. Unpack the root.squashfs image into the squashfs-root folder:

      cd /tmp/initrd-orig/
      unsquashfs root.squashfs
      

   4. See the RAM content that you will have in the bootstrap:

      ls -l /tmp/initrd-orig/initramfs
      ls -l /tmp/initrd-orig/squashfs-root
      

2. Modify initrd.img and root.squashfs

   Warning

   To add or update a new kernel module, use the depmod command. It will update the modules.alias and modules.dep files informing the kernel about the new module.

   Note

   There is a safe way to update kernel modules for Ubuntu, when the new module is installed into the /lib/modules/<version>/updates folder. The previous kernel module is still kept in the system, but hidden by the new module. When something goes wrong with the new module it can be easily removed from the /update folder and the older version of module will be returned back.

   1. Modify it as you need. For example, copy new kernel module aacraid into the initrd corresponding kernel folder:

      mkdir -p /tmp/initrd-orig/initramfs/lib/modules/3.13.0-77-generic/updates
      cp aacraid.ko /tmp/initrd-orig/initramfs/lib/modules/3.13.0-77-generic/updates
      

   2. Modify the squashfs-root by copying the new kernel module aacraid into the specified folder (kernel version may be different in your case):

      mkdir -p /tmp/initrd-orig/squashfs-root/lib/modules/3.13.0-77-generic/updates
      cp aacraid.ko /tmp/initrd-orig/squashfs-root/lib/modules/3.13.0-77-generic/updates
      

   3. Run depmod to update information about kernel modules on initrd and root.squashfs:

      depmod -a -b /tmp/initrd-orig/initramfs/ -F /tmp/initrd-orig/squashfs-root/boot/System.map-3.13.0-77-generic 3.13.0-77-generic
      depmod -a -b /tmp/initrd-orig/squashfs-root/ -F /tmp/initrd-orig/squashfs-root/boot/System.map-3.13.0-77-generic 3.13.0-77-generic
      

      See depmod command parameters:

      depmod -a -b <base dir> -F <System.map location> <kernel version>
      

      System response

      ====  =================================================================
       -a     Rebuild information for all modules
       -b     Base folder, If your modules are not currently in the (normal)
              directory /lib/modules/version. In our case it were the folders
              where initramfs and root.squasfs
       -F     location of the System.map produced when the kernel was built
      ====  =================================================================
      

      Note

      It is important to pass a correct kernel version to the depmod command at the end of the parameters. Otherwise, the version of the current kernel on the Fuel master node will be used.

      The following files will be modified in the initramfs and squashfs-root folders after running the depmod command:

      • lib/modules/3.13.0-77-generic/modules.alias
      • lib/modules/3.13.0-77-generic/modules.alias.bin
      • lib/modules/3.13.0-77-generic/modules.dep
      • lib/modules/3.13.0-77-generic/modules.dep.bin
      • lib/modules/3.13.0-77-generic/modules.symbols.bin

      To get more information on how to:

      • Pass options to a module
      • Start dependent modules
      • Start black-list modules

      see the modprobe.d man page.

3. Pack the initramfs and squashfs-root

   1. Pack the initramfs back to initfamfs.img.new image:

      cd /tmp/initrd-orig/initramfs
      find . | cpio --quiet -o -H newc | xz --check=crc32 > ../initrd.img.new
      

   2. Pack the squashfs to the root.squashfs.new

      Warning

      squashfs utilities (mksquashfs) installed on a user’s machine or the Fuel Master node can be incompatible with squashfs code in the bootstrap kernel. To verify the generated squashfs image is compatible with the bootstrap kernel, use mksquashfs utility installed in squashfs-root. A simple way to do that is using bind mounts:

      cd /tmp/initrd-orig
      mkdir -p /tmp/initrd-orig/squashfs-root/mnt/dst
      mkdir -p /tmp/initrd-orig/dst
      mount --bind dst squashfs-root/mnt/dst
      chroot squashfs-root mksquashfs / /mnt/dst/root.squashfs.new -comp xz -noappend -e /mnt/dst
      # clean up
      umount squashfs-root/mnt/dst
      

      The output of the mksquashfs command should be as follows:

      mksquashfs squashfs-root root.squashfs.new -comp xz
      
        quashfs squashfs-root root.squashfs.new -comp xz
        Parallel mksquashfs: Using 2 processors
        Creating 4.0 filesystem on root.squashfs.new, block size 131072.
        [================================================\] 105857/105857 100%
      
        Exportable Squashfs 4.0 filesystem, xz compressed, data block size 131072
          compressed data, compressed metadata, compressed fragments, compressed xattrs
          duplicates are removed
        Filesystem size 598514.76 Kbytes (584.49 Mbytes)
          47.89% of uncompressed filesystem size (1249842.98 Kbytes)
        Inode table size 933186 bytes (911.31 Kbytes)
          23.04% of uncompressed inode table size (4050950 bytes)
        Directory table size 1904568 bytes (1859.93 Kbytes)
          48.93% of uncompressed directory table size (3892589 bytes)
        Number of duplicate files found 7780
        Number of inodes 121770
        Number of files 106698
        Number of fragments 4627
        Number of symbolic links  6388
        Number of device nodes 81
        Number of fifo nodes 0
        Number of socket nodes 0
        Number of directories 8603
        Number of ids (unique uids + gids) 18
        Number of uids 4
          root (0)
          unknown (102)
          unknown (100)
          unknown (101)
        Number of gids 17
          root (0)
          unknown (44)
          unknown (29)
          tty (5)
          man (15)
          disk (6)
          unknown (42)
          unknown (102)
          unknown (43)
          unknown (103)
          mem (8)
          unknown (106)
          ftp (50)
          unknown (101)
          unknown (105)
          adm (4)
          unknown (104)
      

   3. Copy new files and update the current bootstrap

      cp dst/root.squashfs.new initrd.img.new /var/www/nailgun/bootstraps/active_bootstrap/
      cd /var/www/nailgun/bootstraps/active_bootstrap/
      mv initrd.img initrd.img.orig
      mv root.squashfs root.squashfs.orig
      cp initrd.img.new initrd.img
      cp root.squashfs.new root.squashfs
      cobbler sync
      

   4. Clean up. Remove /tmp/initrd-orig temporary folder:

      rm -Rf /tmp/initrd-orig
      

Creating a DKMS package from sources¶

Before creating a DKMS package from sources, verify that you have completed the following steps:

1. Create the chroot folder.
2. Install the following packages to the chroot folder: DKMS, build-essential, and debhelper.

Once you complete the steps above, create a DKMS package from sources:

1. Create a folder for a required kernel module in the <module name>-<version> format in the /usr/src directory located in chroot. For example, if the module name is i40e and module version is 1.3.47, create a /usr/src/i40e-1.3.47 folder in chroot.
2. Copy the sources into the created folder.
3. Create and modify a dkms.conf file in the <chroot folder>/usr/src/<module>-<version>/ directory.

PACKAGE_NAME="$module_name-dkms"
PACKAGE_VERSION="$module_version"
BUILT_MODULE_NAME="$module_name"
DEST_MODULE_LOCATION="/updates"

PACKAGE_NAME="i40e-dkms"
PACKAGE_VERSION="1.3.47"
BUILT_MODULE_NAME="i40e"
DEST_MODULE_LOCATION="/updates"
MAKE="make -C src/ KERNELDIR=/lib/modules/\${kernelver}/build"
BUILD_KERNEL="\${kernelver}"
CLEAN="make -C src/ clean"
BUILT_MODULE_LOCATION="src/"
REMAKE_INITRD="yes"

mkdeb
mkdriverdisk

$ ls /tmp/dkms-deb/
i40e-1.3.47-ubuntu-dd.tar  i40e-dkms_1.3.47_all.deb

The script requires following parameters to be provided:
$1 - ``chroot`` folder with Ubuntu has been deployed
$2 - module name
$3 - module version
$4 - path to the folder where is sources of the kernel module

#!/bin/bash
# Check passed parameters, expectations are following:
# $1 - chroot folder with Ubuntu has been deployed
# $2 - module name
# $3 - module version
# $4 - path to the folder where is sources of the kernel module

if [ $# != 4 ] ;
then
  echo "ERR: Passed wrong number of parameters, the expectation are following"
  echo " $1 - chroot folder with Ubuntu has been deployed"
  echo " $2 - module name"
  echo " $3 - module version"
  echo " $4 - path to the folder where is sources of the module"
  echo "$0 <chroot_dir> <module-name> <module-version> <path-to-src>"
  exit 1;
else
   root_dir=$1 # chroot folder
   module_name=$2
   module_version=$3
   module_src_dir=$4
fi
if [ ! -d "$root_dir" ]  ||  [ ! -d "$module_src_dir" ] ;
then
    echo "ERR: The $root_dir or $module_src_dir was not found";
    exit 1;
fi

output_dir="/tmp/dkms-deb"

# Create the folder ${root_dir}/usr/src/${module-name}-${module-version}
mkdir -p "${root_dir}/usr/src/${module_name}-${module_version}"
chmod 755 "${root_dir}/usr/src/${module_name}-${module_version}"

# Copy sources into the folder
cp -R "$module_src_dir"/* \
    ${root_dir}/usr/src/${module_name}-${module_version}

# Create the dkms.conf package
cat > "${root_dir}/usr/src/${module_name}-${module_version}/dkms.conf" <<-EOF
MAKE="make -C src/ KERNELDIR=/lib/modules/\${kernelver}/build"
BUILD_KERNEL="\${kernelver}"
CLEAN="make -C src/ clean"
BUILT_MODULE_NAME="$module_name"
BUILT_MODULE_LOCATION="src/"
DEST_MODULE_LOCATION="/updates"
PACKAGE_NAME="$module_name-dkms"
PACKAGE_VERSION="$module_version"
REMAKE_INITRD="yes"
EOF

# Deduce the kernel version
KERNELDIR=$(ls -d ${root_dir}/lib/modules/*)
kv="${KERNELDIR##*/}"

# Build the binaries by DKMS
# Add the dkms
chroot $root_dir  env \
                LC_ALL=C \
                DEBIAN_FRONTEND=noninteractive \
                DEBCONF_NONINTERACTIVE_SEEN=true \
                TMPDIR=/tmp \
                TMP=/tmp \
                PATH=$PATH:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin \
                BUILD_KERNEL=${kv} \
                dkms add -m "${module_name}"/"${module_version}" -k ${kv}

# Build the kernel module by dkms
chroot $root_dir  env \
                LC_ALL=C \
                DEBIAN_FRONTEND=noninteractive \
                DEBCONF_NONINTERACTIVE_SEEN=true \
                TMPDIR=/tmp \
                TMP=/tmp \
                PATH=$PATH:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin \
                BUILD_KERNEL=${kv} \
                dkms build -m "${module_name}"/"${module_version}" -k ${kv}

# Create the deb-dkms package
chroot $root_dir  env \
                LC_ALL=C \
                DEBIAN_FRONTEND=noninteractive \
                DEBCONF_NONINTERACTIVE_SEEN=true \
                TMPDIR=/tmp \
                TMP=/tmp \
                PATH=$PATH:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin \
                BUILD_KERNEL=${kernelver} \
                dkms mkdeb -m "${module_name}"/"${module_version}" -k ${kv}

# Create the disk-driver archive with
# module binaries in deb package ready to install on bootstrap
chroot $root_dir  env \
                LC_ALL=C \
                DEBIAN_FRONTEND=noninteractive \
                DEBCONF_NONINTERACTIVE_SEEN=true \
                TMPDIR=/tmp \
                TMP=/tmp \
                BUILD_KERNEL=${kv} \
                PATH=$PATH:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin \
                dkms mkdriverdisk -m "${module_name}"/"${module_version}" \
                        -k ${kv} -d ubuntu --media tar

# Create /tmp/dkms-deb folder and copy the created deb file into it
if [ ! -d "${output_dir}" ];
   then
   mkdir -p ${output_dir}
fi
# Copy the built deb dkms package into the folder
# and driver disk tar archive.i
# The archive contains the binary module as a deb package for given kernel version
#
cp ${root_dir}/var/lib/dkms/${module_name}/${module_version}/deb/*.deb ${output_dir}
cp ${root_dir}/var/lib/dkms/${module_name}/${module_version}/driver_disk/*.tar ${output_dir}

# Don't forget to umount ${root_dir}/proc and remove ${root_dir}
umount ${root_dir}/proc
rm -Rf ${root_dir}

tar -xvf i40e-1.3.47-ubuntu-dd.tar
./
./ubuntu-drivers/
./ubuntu-drivers/3.13.0/
./ubuntu-drivers/3.13.0/i40e_1.3.47-3.13.0-77-generic_x86_64.deb
...

# dkms build -m be2net/10.4u

Kernel preparation unnecessary for this kernel.  Skipping...

Building module:
make clean
make: *** No rule to make target `clean'.  Stop.
(bad exit status: 2)
{ make KERNELRELEASE=3.13.0-77-generic -C /lib/modules/3.13.0-77-generic/build SUBDIRS=/var/lib/dkms/be2net/10.4u/build modules; } >> /var/lib/dkms/be2net/10.4u/build/make.log 2>&1
(bad exit status: 2)
ERROR (dkms apport): binary package for be2net: 10.4u not found
Error! Bad return status for module build on kernel: 3.13.0-77-generic (x86_64)
Consult /var/lib/dkms/be2net/10.4u/build/make.log for more information.

# cat /var/lib/dkms/be2net/10.4u/build/make.log
DKMS make.log for be2net-10.4u for kernel 3.13.0-77-generic (x86_64)

make: Entering directory `/usr/src/linux-headers-3.13.0-77-generic'
CC [M]  /var/lib/dkms/be2net/10.4u/build/be_main.o
/var/lib/dkms/be2net/10.4u/build/be_main.c: In function ‘be_mac_addr_set’:
/var/lib/dkms/be2net/10.4u/build/be_main.c:315:2: error: implicit declaration of function ‘ether_addr_copy’ [-Werror=implicit-function-declaration]
ether_addr_copy(netdev->dev_addr, addr->sa_data);
^
/var/lib/dkms/be2net/10.4u/build/be_main.c: In function ‘be_get_tx_vlan_tag’:
/var/lib/dkms/be2net/10.4u/build/be_main.c:727:2: error: implicit declaration of function ‘skb_vlan_tag_get’ [-Werror=implicit-function-declaration]
vlan_tag = skb_vlan_tag_get(skb);
^
/var/lib/dkms/be2net/10.4u/build/be_main.c: In function ‘be_get_wrb_params_from_skb’:
/var/lib/dkms/be2net/10.4u/build/be_main.c:789:2: error: implicit declaration of function ‘skb_vlan_tag_present’ [-Werror=implicit-function-declaration]
if (skb_vlan_tag_present(skb)) {
^
/var/lib/dkms/be2net/10.4u/build/be_main.c: In function ‘be_insert_vlan_in_pkt’:
/var/lib/dkms/be2net/10.4u/build/be_main.c:1001:3: error: implicit declaration of function ‘vlan_insert_tag_set_proto’ [-Werror=implicit-function-declaration]
 skb = vlan_insert_tag_set_proto(skb, htons(ETH_P_8021Q),
 ^
/var/lib/dkms/be2net/10.4u/build/be_main.c:1001:7: warning: assignment makes pointer from integer without a cast [enabled by default]
 skb = vlan_insert_tag_set_proto(skb, htons(ETH_P_8021Q),
     ^
/var/lib/dkms/be2net/10.4u/build/be_main.c:1011:7: warning: assignment makes pointer from integer without a cast [enabled by default]
 skb = vlan_insert_tag_set_proto(skb, htons(ETH_P_8021Q),
     ^
/var/lib/dkms/be2net/10.4u/build/be_main.c: In function ‘be_xmit_workarounds’:
/var/lib/dkms/be2net/10.4u/build/be_main.c:1132:3: error: implicit declaration of function ‘skb_put_padto’ [-Werror=implicit-function-declaration]
 if (skb_put_padto(skb, 36))
 ^
/var/lib/dkms/be2net/10.4u/build/be_main.c: In function ‘be_xmit’:
/var/lib/dkms/be2net/10.4u/build/be_main.c:1299:19: error: ‘struct sk_buff’ has no member named ‘xmit_more’
bool flush = !skb->xmit_more;

/*
* This file is part of the Linux NIC driver for Emulex networking products.
*
* Copyright (C) 2005-2015 Emulex. All rights reserved.
*
* EMULEX and SLI are trademarks of Emulex.
* www.emulex.com
* linux-drivers@emulex.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of version 2 of the GNU General Public License as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful.
* ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
* INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
* PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE
* EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.
* See the GNU General Public License for more details, a copy of which
* can be found in the file COPYING included with this package
*/

#ifndef BE_COMPAT_H
#define BE_COMPAT_H

#ifdef RHEL_RELEASE_CODE
#define RHEL
#endif

#ifndef RHEL_RELEASE_CODE
#define RHEL_RELEASE_CODE 0
#endif

#ifndef RHEL_RELEASE_VERSION
#define RHEL_RELEASE_VERSION(a,b) (((a) << 8) + (b))
#endif

#ifndef NETIF_F_HW_VLAN_CTAG_DEFINED
#define NETIF_F_HW_VLAN_CTAG_TX         NETIF_F_HW_VLAN_TX
#define NETIF_F_HW_VLAN_CTAG_RX         NETIF_F_HW_VLAN_RX
#define NETIF_F_HW_VLAN_CTAG_FILTER     NETIF_F_HW_VLAN_FILTER
#endif

/*************************** NAPI backport ********************************/
#if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 27)

/* RHEL 5.4+ has a half baked napi_struct implementation.
* Bypass it and use simulated NAPI using multiple netdev structs
*/
#ifdef RHEL
typedef struct napi_struct        rhel_napi;
#endif

#define netif_napi_add           netif_napi_add_compat
#define netif_napi_del           netif_napi_del_compat
#define napi_gro_frags(napi)     napi_gro_frags((rhel_napi*) napi)
#define napi_get_frags(napi)     napi_get_frags((rhel_napi*) napi)
#define vlan_gro_frags(napi, g, v)    vlan_gro_frags((rhel_napi*) napi, g, v);
#define napi_schedule(napi)      netif_rx_schedule((napi)->dev)
#define napi_enable(napi)        netif_poll_enable((napi)->dev)
#define napi_disable(napi)       netif_poll_disable((napi)->dev)
#define napi_complete(napi)      napi_gro_flush((rhel_napi *)napi); \
                  netif_rx_complete(napi->dev)
#define napi_schedule_prep(napi)    netif_rx_schedule_prep((napi)->dev)
#define __napi_schedule(napi)        __netif_rx_schedule((napi)->dev)

#define napi_struct           napi_struct_compat

struct napi_struct_compat {
#ifdef RHEL
   rhel_napi napi;    /* must be the first member */
#endif
   struct net_device *dev;
   int (*poll) (struct napi_struct *napi, int budget);
};

extern void netif_napi_del_compat(struct napi_struct *napi);
extern void netif_napi_add_compat(struct net_device *, struct napi_struct *,
              int (*poll) (struct napi_struct *, int), int);
#endif /*********************** NAPI backport *****************************/

Creating and injecting the initrd_update into bootstrap¶

A typical use case for creating initrd_update looks as follows: a great number of proprietary drivers for equipment cannot be shipped with GA Fuel ISO due to legal issues and should be installed by users themselves.

That means, you can add (or inject) the required issues (drivers, scripts etc.) during Fuel ISO installation procedure.

Injection workflow consists of several stages:

1. Prepare the injected initramfs image with the required kernel modules (for CentOS).
2. Modify bootstrap (CentOS)

Prepare injected initramfs image for CentOS

The injected initramfs image should contain the files what are going to be put on (or let’s say injected into) the original initramfs on the bootstrap in addition to the deployed (original) RAM file system.

The injected initramfs image should have the following structure:

/
/lib/modules/<kernel-version>/kernel/<path-to-the-driver>/<module.ko>
/etc/modprobe.d/<module>.conf

Let’s put all required files into the folder called dd-src and create the image. For example, we need the 2.6.32-504 (CentOs 6.6) kernel:

1. Create the working folder dd-src:

   mkdir dd-src
   

2. Put the kernel modules into:

   mkdir -p ./dd-src/lib/modules/2.6.32-504.1.3.el6.x86_64/kernel/drivers/scsi
   cp hpvsa.ko ./dd-src/lib/modules/2.6.32-504.1.3.el6.x86_64/kernel/drivers/scsi
   

3. Put the <module-name>.conf file with the modprobe command into the etc/modprobe.d/ folder:

   mkdir -p ./dd-src/etc/modprobe.d/
   echo modprobe hpvsa > ./dd-src/etc/modprobe.d/hpvsa.conf
   chmod +x ./dd-src/etc/modprobe.d/hpvsa.conf
   

   There is the second (deprecated) way: create the /etc/rc.modules executable file and list the command to probe with the module name. Do not use /etc/rc.local file for this purpose, because it is too late for init hardware:

   mkdir ./dd-src/etc
   echo modprobe hpvsa > ./dd-src/etc/rc.modules
   chmod +x ./dd-src/etc/rc.modules
   

4. Create the dd-src.tar.gz file for coping to the Fuel Master node:

   tar -czvf dd-src.tar.gz ./dd-src
   

   The dd-src.tar.gz file can now be copied to the Fuel Master node.

Adding initrd_update image to the bootstrap

Assume that the Fuel Master node has been deployed:

1. Connect to the Fuel Master node:

   ssh root@<your-Fuel-Master-node-IP>
   

2. Prepare initramfs update image:

   tar -xzvf dd-src.tar.gz
   cd dd-src
   find . | cpio --quiet -o -H newc | gzip -9 > /tmp/initrd_update.img
   

3. Copy into the TFTP (PXE) bootstrap folder:

   cp /tmp/initrd_update.img /var/www/nailgun/bootstrap/
   chmod 755 /var/www/nailgun/bootstrap/initrd_update.img
   

4. Copy inside the cobbler container to the folder:

   dockerctl copy initrd_update.img cobbler:/var/lib/tftpboot/initrd_update.img
   

5. Modify the bootstrap menu initrd parameter.

   • Log into the cobbler container:

     dockerctl shell cobbler
     

   • Get the variable kopts variable value:

     cobbler profile dumpvars --name=bootstrap | grep kernel_options
     kernel_options : ksdevice=bootif locale=en_US text mco_user=mcollective initrd=initrd_update.img biosdevname=0 lang url=http://10.20.0.2:8000/api priority=critical mco_pass=HfQqE2Td kssendmac
     

   • Add initrd=initrd_update.img at the beginning of the string and re-sync the container. It turns into the kernel parameter passing to the kernel on boot ‘initrd=initramfs.img,initrd_update.img’:

     cobbler profile edit --name bootstrap --kopts='initrd=initrd_update.img ksdevice=bootif lang=  locale=en_US text mco_user=mcollective priority=critical url=http://10.20.0.2:8000/api biosdevname=0 mco_pass=HfQqE2Td kssendmac'
     cobbler sync
     

Modifying initramfs image manually for bootstrap node¶

To edit the initramfs (initrd) image, you should unpack it, modify and pack back. Initramfs image is a gzip-ed cpio archive.

To change initramfs image, follow these steps:

1. Create a folder for modifying initramfs image and copy the initramfs image into it:

   mkdir /tmp/initrd-orig
   dockerctl copy cobbler:/var/lib/tftpboot/images/bootstrap/initramfs.img /tmp/initrd-orig/
   

2. Unpack initramfs image. First of all, unzip it:

   cd /tmp/initrd-orig/
   mv initramfs.img initramfs.img.gz
   gunzip initramfs.img.gz
   

3. Unpack the cpio archive to the initramfs folder:

   mkdir initramfs
   cd initramfs
   cpio -i < ../initramfs.img
   

4. Now you have the file system what you have in the RAM on the bootstrap:

   ls -l /tmp/initrd-orig/initramfs
   

5. Modify it as you need. For example, copy files or modify the scripts:

     cp hpvsa.ko lib/modules/2.6.32-504.1.3.el6.x86_64/kernel/drivers/scsi/
     echo "modprobe hpvsa" > etc/modprobe.d/hpvsa.conf
   
   
   To get more information on how to pass options to
   the module, start dependent modules or black-list modules please,
   consult see the *modprobe.d* man page.
   
   ::
   
       vi etc/modprobe.d/blacklist.conf
   

6. Pack the initramfs back to initramfs.img.new image:

   cd /tmp/initrd-orig/initramfs
   find . | cpio --quiet -o -H newc | gzip -9 > /tmp/initramfs.img.new
   

7. Clean up. Remove /tmp/initrd-orig temporary folder:

   rm -Rf /tmp/initrd-orig/
   

Creating a custom bootstrap node¶

This option requires further investigation and will be introduced in the near future.

Replacing default bootstrap node with the custom one

Let’s suppose that you have created or modified the initramfs image. It is placed in the /tmp folder under initramfs.img.new name.

To replace the default bootstrap with the custom, follow these steps:

1. Save the previous initramfs image:

   mv /var/www/nailgun/bootstrap/initramfs.img /var/www/nailgun/bootstrap/initramfs.img.old
   

2. Copy the new initramfs image into the bootstrap folder:

   cd /tmp
   cp initramfs.img.new /var/www/nailgun/bootstrap/initramfs.img
   dockerctl copy /var/www/nailgun/bootstrap/initramfs.img cobbler:/var/lib/tftpboot/images/bootstrap/initramfs.img
   

3. Make the Cobbler update the files:

   cobbler sync