392 lines
13 KiB
Python
392 lines
13 KiB
Python
# Copyright (c) 2015 SUSE Linux GmbH. All rights reserved.
|
|
#
|
|
# This file is part of kiwi.
|
|
#
|
|
# kiwi is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# kiwi is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with kiwi. If not, see <http://www.gnu.org/licenses/>
|
|
#
|
|
from tempfile import mkdtemp
|
|
import platform
|
|
|
|
# project
|
|
from ..command import Command
|
|
from ..bootloader.config import BootLoaderConfig
|
|
from ..filesystem.squashfs import FileSystemSquashFs
|
|
from ..filesystem.isofs import FileSystemIsoFs
|
|
from ..system.identifier import SystemIdentifier
|
|
from ..path import Path
|
|
from ..utils.checksum import Checksum
|
|
from ..logger import log
|
|
from ..system.kernel import Kernel
|
|
from ..iso import Iso
|
|
from ..utils.compress import Compress
|
|
from ..archive.tar import ArchiveTar
|
|
|
|
from ..exceptions import (
|
|
KiwiInstallBootImageError
|
|
)
|
|
|
|
|
|
class InstallImageBuilder(object):
|
|
"""
|
|
Installation image builder
|
|
|
|
Attributes
|
|
|
|
* :attr:`arch`
|
|
platform.machine
|
|
|
|
* :attr:`target_dir`
|
|
target directory path name
|
|
|
|
* :attr:`machine`
|
|
Configured build type machine section
|
|
|
|
* :attr:`boot_image`
|
|
Instance of BootImage
|
|
|
|
* :attr:`xml_state`
|
|
Instance of XMLState
|
|
|
|
* :attr:`diskname`
|
|
File name of the disk image
|
|
|
|
* :attr:`isoname`
|
|
File name of the install ISO image
|
|
|
|
* :attr:`pxename`
|
|
File name of the install PXE archive
|
|
|
|
* :attr:`squashed_diskname`
|
|
File name of the squahsfs compressed disk image
|
|
|
|
* :attr:`md5name`
|
|
File name of the disk checksum file
|
|
|
|
* :attr:`mbrid`
|
|
Instance of SystemIdentifier
|
|
|
|
* :attr:`media_dir`
|
|
Temporary directory to collect the install ISO contents
|
|
|
|
* :attr:`pxe_dir`
|
|
Temporary directory to collect the PXE install Archive contents
|
|
|
|
* :attr:`squashed_contents`
|
|
Temporary directory to collect the contents of the squashfs
|
|
compressed disk image. These are the disk image file itself
|
|
and the checksum file
|
|
|
|
* :attr:`custom_iso_args`
|
|
Additional custom ISO creation arguments
|
|
"""
|
|
def __init__(self, xml_state, target_dir, boot_image_task):
|
|
self.arch = platform.machine()
|
|
if self.arch == 'i686' or self.arch == 'i586':
|
|
self.arch = 'ix86'
|
|
self.target_dir = target_dir
|
|
self.machine = xml_state.get_build_type_machine_section()
|
|
self.boot_image_task = boot_image_task
|
|
self.xml_state = xml_state
|
|
self.diskname = ''.join(
|
|
[
|
|
target_dir, '/',
|
|
xml_state.xml_data.get_name(),
|
|
'.' + self.arch,
|
|
'-' + xml_state.get_image_version(),
|
|
'.raw'
|
|
]
|
|
)
|
|
self.isoname = ''.join(
|
|
[
|
|
target_dir, '/',
|
|
xml_state.xml_data.get_name(),
|
|
'.' + self.arch,
|
|
'-' + xml_state.get_image_version(),
|
|
'.install.iso'
|
|
]
|
|
)
|
|
self.pxename = ''.join(
|
|
[
|
|
target_dir, '/',
|
|
xml_state.xml_data.get_name(),
|
|
'.' + self.arch,
|
|
'-' + xml_state.get_image_version(),
|
|
'.install.tar.xz'
|
|
]
|
|
)
|
|
self.squashed_diskname = ''.join(
|
|
[xml_state.xml_data.get_name(), '.raw']
|
|
)
|
|
self.md5name = ''.join(
|
|
[xml_state.xml_data.get_name(), '.md5']
|
|
)
|
|
|
|
self.mbrid = SystemIdentifier()
|
|
self.mbrid.calculate_id()
|
|
|
|
self.media_dir = None
|
|
self.pxe_dir = None
|
|
self.squashed_contents = None
|
|
self.custom_iso_args = None
|
|
|
|
def create_install_iso(self):
|
|
"""
|
|
Create an install ISO from the disk_image as hybrid ISO
|
|
bootable via legacy BIOS, EFI and as disk from Stick
|
|
|
|
Image types which triggers this builder are:
|
|
|
|
* installiso="true|false"
|
|
* installstick="true|false"
|
|
"""
|
|
self.media_dir = mkdtemp(
|
|
prefix='kiwi_install_media.', dir=self.target_dir
|
|
)
|
|
# custom iso metadata
|
|
self.custom_iso_args = {
|
|
'create_options': [
|
|
'-V', '"KIWI Installation System"',
|
|
'-A', self.mbrid.get_id()
|
|
]
|
|
}
|
|
|
|
# the system image transfer is checked against a checksum
|
|
log.info('Creating disk image checksum')
|
|
self.squashed_contents = mkdtemp(
|
|
prefix='kiwi_install_squashfs.', dir=self.target_dir
|
|
)
|
|
checksum = Checksum(self.diskname)
|
|
checksum.md5(self.squashed_contents + '/' + self.md5name)
|
|
|
|
# the kiwi initrd code triggers the install by trigger files
|
|
self._create_iso_install_trigger_files()
|
|
|
|
# the system image is stored as squashfs embedded file
|
|
log.info('Creating squashfs embedded disk image')
|
|
Command.run(
|
|
[
|
|
'cp', '-l', self.diskname,
|
|
self.squashed_contents + '/' + self.squashed_diskname
|
|
]
|
|
)
|
|
squashed_image_file = ''.join(
|
|
[
|
|
self.target_dir, '/', self.squashed_diskname, '.squashfs'
|
|
]
|
|
)
|
|
squashed_image = FileSystemSquashFs(
|
|
device_provider=None, root_dir=self.squashed_contents
|
|
)
|
|
squashed_image.create_on_file(squashed_image_file)
|
|
Command.run(
|
|
['mv', squashed_image_file, self.media_dir]
|
|
)
|
|
|
|
# setup bootloader config to boot the ISO via isolinux
|
|
log.info('Setting up install image bootloader configuration')
|
|
bootloader_config_isolinux = BootLoaderConfig(
|
|
'isolinux', self.xml_state, self.media_dir
|
|
)
|
|
bootloader_config_isolinux.setup_install_boot_images(
|
|
mbrid=None,
|
|
lookup_path=self.boot_image_task.boot_root_directory
|
|
)
|
|
bootloader_config_isolinux.setup_install_image_config(
|
|
mbrid=None
|
|
)
|
|
bootloader_config_isolinux.write()
|
|
|
|
# setup bootloader config to boot the ISO via EFI
|
|
bootloader_config_grub = BootLoaderConfig(
|
|
'grub2', self.xml_state, self.media_dir
|
|
)
|
|
bootloader_config_grub.setup_install_boot_images(
|
|
mbrid=self.mbrid,
|
|
lookup_path=self.boot_image_task.boot_root_directory
|
|
)
|
|
bootloader_config_grub.setup_install_image_config(
|
|
mbrid=self.mbrid
|
|
)
|
|
bootloader_config_grub.write()
|
|
|
|
# create initrd for install image
|
|
log.info('Creating install image boot image')
|
|
self._create_iso_install_kernel_and_initrd()
|
|
|
|
# create iso filesystem from media_dir
|
|
log.info('Creating ISO filesystem')
|
|
iso_image = FileSystemIsoFs(
|
|
device_provider=None,
|
|
root_dir=self.media_dir,
|
|
custom_args=self.custom_iso_args
|
|
)
|
|
iso_header_offset = iso_image.create_on_file(self.isoname)
|
|
|
|
# make it hybrid
|
|
Iso.create_hybrid(
|
|
iso_header_offset, self.mbrid, self.isoname
|
|
)
|
|
|
|
def create_install_pxe_archive(self):
|
|
"""
|
|
Create an oem install tar archive suitable for installing a
|
|
disk image via the network using the PXE boot protocol.
|
|
The archive contains the raw disk image and its checksum
|
|
as well as an install initrd and kernel plus the required
|
|
kernel commandline information which needs to be added
|
|
as append line in the pxelinux config file on the boot
|
|
server
|
|
|
|
Image types which triggers this builder are:
|
|
|
|
* installpxe="true|false"
|
|
"""
|
|
self.pxe_dir = mkdtemp(
|
|
prefix='kiwi_pxe_install_media.', dir=self.target_dir
|
|
)
|
|
# the system image is transfered as xz compressed variant
|
|
log.info('xz compressing disk image')
|
|
pxe_image_filename = ''.join(
|
|
[
|
|
self.pxe_dir, '/',
|
|
self.xml_state.xml_data.get_name(), '.xz'
|
|
]
|
|
)
|
|
compress = Compress(
|
|
source_filename=self.diskname,
|
|
keep_source_on_compress=True
|
|
)
|
|
compress.xz()
|
|
Command.run(
|
|
['mv', compress.compressed_filename, pxe_image_filename]
|
|
)
|
|
|
|
# the system image transfer is checked against a checksum
|
|
log.info('Creating disk image checksum')
|
|
pxe_md5_filename = ''.join(
|
|
[
|
|
self.pxe_dir, '/',
|
|
self.xml_state.xml_data.get_name(), '.md5'
|
|
]
|
|
)
|
|
checksum = Checksum(self.diskname)
|
|
checksum.md5(pxe_md5_filename)
|
|
|
|
# the kiwi initrd code triggers the install by trigger files
|
|
self._create_pxe_install_trigger_files()
|
|
|
|
# create pxe config append information
|
|
# this information helps to configure the boot server correctly
|
|
append_filename = ''.join(
|
|
[
|
|
self.pxe_dir, '/',
|
|
self.xml_state.xml_data.get_name(), '.append'
|
|
]
|
|
)
|
|
cmdline = 'pxe=1'
|
|
custom_cmdline = self.xml_state.build_type.get_kernelcmdline()
|
|
if custom_cmdline:
|
|
cmdline += ' ' + custom_cmdline
|
|
with open(append_filename, 'w') as append:
|
|
append.write('%s\n' % cmdline)
|
|
|
|
# create initrd for pxe install
|
|
log.info('Creating pxe install boot image')
|
|
self._create_pxe_install_kernel_and_initrd()
|
|
|
|
# create pxe install tarball
|
|
log.info('Creating pxe install archive')
|
|
archive = ArchiveTar(
|
|
self.pxename.replace('.xz', '')
|
|
)
|
|
archive.create_xz_compressed(
|
|
self.pxe_dir
|
|
)
|
|
|
|
def _create_pxe_install_kernel_and_initrd(self):
|
|
kernel = Kernel(self.boot_image_task.boot_root_directory)
|
|
if kernel.get_kernel():
|
|
kernel.copy_kernel(self.pxe_dir, '/pxeboot.kernel')
|
|
else:
|
|
raise KiwiInstallBootImageError(
|
|
'No kernel in boot image tree %s found' %
|
|
self.boot_image_task.boot_root_directory
|
|
)
|
|
if self.machine and self.machine.get_domain() == 'dom0':
|
|
if kernel.get_xen_hypervisor():
|
|
kernel.copy_xen_hypervisor(self.pxe_dir, '/pxeboot.xen.gz')
|
|
else:
|
|
raise KiwiInstallBootImageError(
|
|
'No hypervisor in boot image tree %s found' %
|
|
self.boot_image_task.boot_root_directory
|
|
)
|
|
self.boot_image_task.create_initrd(self.mbrid)
|
|
Command.run(
|
|
[
|
|
'mv', self.boot_image_task.initrd_filename,
|
|
self.pxe_dir + '/pxeboot.initrd.xz'
|
|
]
|
|
)
|
|
|
|
def _create_iso_install_kernel_and_initrd(self):
|
|
boot_path = self.media_dir + '/boot/' + self.arch + '/loader'
|
|
Path.create(boot_path)
|
|
kernel = Kernel(self.boot_image_task.boot_root_directory)
|
|
if kernel.get_kernel():
|
|
kernel.copy_kernel(boot_path, '/linux')
|
|
else:
|
|
raise KiwiInstallBootImageError(
|
|
'No kernel in boot image tree %s found' %
|
|
self.boot_image_task.boot_root_directory
|
|
)
|
|
if self.machine and self.machine.get_domain() == 'dom0':
|
|
if kernel.get_xen_hypervisor():
|
|
kernel.copy_xen_hypervisor(boot_path, '/xen.gz')
|
|
else:
|
|
raise KiwiInstallBootImageError(
|
|
'No hypervisor in boot image tree %s found' %
|
|
self.boot_image_task.boot_root_directory
|
|
)
|
|
self.boot_image_task.create_initrd(self.mbrid)
|
|
Command.run(
|
|
[
|
|
'mv', self.boot_image_task.initrd_filename,
|
|
boot_path + '/initrd'
|
|
]
|
|
)
|
|
|
|
def _create_iso_install_trigger_files(self):
|
|
initrd_trigger = \
|
|
self.boot_image_task.boot_root_directory + '/config.vmxsystem'
|
|
iso_trigger = self.media_dir + '/config.isoclient'
|
|
with open(initrd_trigger, 'w') as vmx_system:
|
|
vmx_system.write('IMAGE="%s"\n' % self.squashed_diskname)
|
|
with open(iso_trigger, 'w') as iso_system:
|
|
iso_system.write('IMAGE="%s"\n' % self.squashed_diskname)
|
|
|
|
def _create_pxe_install_trigger_files(self):
|
|
initrd_trigger = \
|
|
self.boot_image_task.boot_root_directory + '/config.vmxsystem'
|
|
with open(initrd_trigger, 'w') as vmx_system:
|
|
vmx_system.write('IMAGE="%s"\n' % self.squashed_diskname)
|
|
|
|
def __del__(self):
|
|
log.info('Cleaning up %s instance', type(self).__name__)
|
|
if self.media_dir:
|
|
Path.wipe(self.media_dir)
|
|
if self.pxe_dir:
|
|
Path.wipe(self.pxe_dir)
|
|
if self.squashed_contents:
|
|
Path.wipe(self.squashed_contents)
|