Allow custom root volume name setup

In addition to the custom size of the root volume it's now
also possible to setup the name of the root volume as follows:

    <volume name="@root=rootlv"/>

If no name for the root volume is specified the default
name: LVRoot applies as before. This Fixes #1530

doc/source/working_with_images/custom_volumes.rst

@@ -54,6 +54,16 @@ attributes:
 
         <volume name="@root" size="4G"/>
 
+     In addition to the custom size of the root volume it's also possible
+     to setup the name of the root volume as follows:
+
+     .. code:: xml
+
+        <volume name="@root=rootlv" size="4G"/>
+
+     If no name for the root volume is specified the
+     default name: **LVRoot** applies.
+
 - `freespace`: Optional attribute defining the additional free space added
   to the volume. If no suffix (`M` or `G`) is used, the value is considered
   to be in megabytes.

dracut/modules.d/99kiwi-lib/kiwi-lvm-lib.sh

@@ -152,26 +152,19 @@ function read_volume_setup_all_free {
     local volume
     local name
     local mpoint
-    local have_root_volume_setup=false
     while read -r volspec;do
         if ! [[ "${volspec}" =~ "kiwi_Volume_" ]];then
             continue
         fi
         volume=$(echo "${volspec}" | cut -f2 -d= | tr -d \' | tr -d \")
         size=$(echo "${volume}" | cut -f2 -d\| | cut -f2 -d:)
         name=$(echo "${volume}" | cut -f1 -d\|)
-        if [ "${name}" = "LVRoot" ];then
-            have_root_volume_setup=true
-        fi
         if [ "${size}" = "all" ];then
             mpoint=$(echo "${volume}" | cut -f3 -d\|)
             echo "${name},${mpoint}"
             return
         fi
     done < "${profile}"
-    if [ "${have_root_volume_setup}" = "false" ];then
-        echo LVRoot,
-    fi
 }
 
 function get_all_free_volume {

kiwi/defaults.py

@@ -37,6 +37,7 @@
 EDIT_BOOT_CONFIG_SCRIPT = 'edit_boot_config.sh'
 EDIT_BOOT_INSTALL_SCRIPT = 'edit_boot_install.sh'
 IMAGE_METADATA_DIR = 'image'
+ROOT_VOLUME_NAME = 'LVRoot'
 
 
 class Defaults:

kiwi/storage/disk.py

@@ -105,14 +105,13 @@ def create_root_lvm_partition(self, mbsize):
         """
         Create root partition for use with LVM
 
-        Populates kiwi_RootPart(id) and kiwi_RootPartVol(LVRoot)
+        Populates kiwi_RootPart(id)
 
         :param int mbsize: partition size
         """
         self.partitioner.create('p.lxlvm', mbsize, 't.lvm')
         self._add_to_map('root')
         self._add_to_public_id_map('kiwi_RootPart')
-        self._add_to_public_id_map('kiwi_RootPartVol', 'LVRoot')
 
     def create_root_raid_partition(self, mbsize):
         """

kiwi/storage/setup.py

@@ -322,15 +322,15 @@ def _accumulate_volume_size(self, root_mbytes):
 
     def _get_root_volume_configuration(self):
         """
-        Provide LVRoot volume configuration if present and in
+        Provide root volume configuration if present and in
         use according to the selected volume management. So far
         this only affects the LVM volume manager
         """
         root_volume_type = namedtuple(
             'root_volume_type', ['size_type', 'req_size']
         )
         for volume in self.volumes:
-            if volume.name == 'LVRoot':
+            if volume.is_root_volume:
                 if volume.size:
                     [size_type, req_size] = volume.size.split(':')
                     return root_volume_type(

kiwi/system/profile.py

@@ -232,15 +232,18 @@ def _systemdisk_to_profile(self):
 
             volume_count = 1
             for volume in self.xml_state.get_volumes():
-                volume_id_name = 'kiwi_Volume_{id}'.format(id=volume_count)
+                if volume.is_root_volume:
+                    volume_id_name = 'kiwi_Volume_Root'
+                else:
+                    volume_id_name = 'kiwi_Volume_{id}'.format(id=volume_count)
+                    volume_count += 1
                 self.dot_profile[volume_id_name] = '|'.join(
                     [
                         volume.name,
                         'size:all' if volume.fullsize else volume.size,
                         volume.mountpoint or ''
                     ]
                 )
-                volume_count += 1
 
     def _preferences_to_profile(self):
         # kiwi_iversion

kiwi/volume_manager/base.py

@@ -299,7 +299,7 @@ def get_volume_mbsize(
                 if lookup_path == volume_path:
                     continue
                 if lookup_path == os.sep:
-                    # exclude any sub volume path if lookup_path is / [LVRoot]
+                    # exclude any sub volume path if lookup_path is /
                     exclude_paths.append(
                         os.path.normpath(self.root_dir + os.sep + volume_path)
                     )

kiwi/volume_manager/btrfs.py

@@ -157,7 +157,7 @@ def create_volumes(self, filesystem_name):
             )
 
         for volume in canonical_volume_list.volumes:
-            if volume.name == 'LVRoot':
+            if volume.is_root_volume:
                 # the btrfs root volume named '@' has been created as
                 # part of the setup procedure
                 pass

kiwi/volume_manager/lvm.py

@@ -70,8 +70,8 @@ def get_device(self):
         """
         device_map = {}
         for volume_name, volume_node in list(self.volume_map.items()):
-            if volume_name == 'LVRoot':
-                # LVRoot volume device takes precedence over the
+            if self._is_root_volume(volume_name):
+                # root volume device takes precedence over the
                 # root partition device from the disk. Therefore use
                 # the same key to put them on the same level
                 volume_name = 'root'
@@ -228,7 +228,7 @@ def get_fstab(self, persistency_type, filesystem_name):
         """
         fstab_entries = []
         for volume_mount in self.mount_list:
-            if 'LVRoot' not in volume_mount.device:
+            if not self._is_root_volume(volume_mount.device):
                 mount_path = '/'.join(volume_mount.mountpoint.split('/')[3:])
                 if not mount_path.startswith('/'):
                     mount_path = '/' + mount_path
@@ -288,7 +288,7 @@ def umount_volumes(self):
 
     def _create_filesystem(self, volume_name, volume_label, filesystem_name):
         device_node = self.volume_map[volume_name]
-        if volume_name == 'LVRoot' and not volume_label:
+        if self._is_root_volume(volume_name) and not volume_label:
             # if there is no @root volume definition for the root volume,
             # perform a second lookup of a label specified via the
             # rootfs_label from the type setup
@@ -306,7 +306,7 @@ def _create_filesystem(self, volume_name, volume_label, filesystem_name):
 
     def _add_to_mount_list(self, volume_name, realpath):
         device_node = self.volume_map[volume_name]
-        if volume_name == 'LVRoot':
+        if self._is_root_volume(volume_name):
             # root volume must be first in the list
             self.mount_list.insert(
                 0, MountManager(
@@ -343,6 +343,11 @@ def _volume_group_in_use_on_host_system(self, volume_group_name):
             # group name, it is considered to be not used
             return False
 
+    def _is_root_volume(self, name):
+        for volume in self.volumes:
+            if name in volume.name and volume.is_root_volume:
+                return True
+
     def __del__(self):
         if self.volume_group:
             log.info('Cleaning up %s instance', type(self).__name__)

kiwi/xml_state.py

@@ -23,6 +23,8 @@
 from textwrap import dedent
 
 # project
+import kiwi.defaults as defaults
+
 from kiwi import xml_parse
 from kiwi.system.uri import Uri
 from kiwi.defaults import Defaults
@@ -1223,7 +1225,8 @@ def get_volumes(self):  # noqa C901
                         mountpoint=path,
                         fullsize=True,
                         label=volume_label,
-                        attributes=['no-copy-on-write']
+                        attributes=['no-copy-on-write'],
+                        is_root_volume=True|False
                     )
                 ]
 
@@ -1243,7 +1246,8 @@ def get_volumes(self):  # noqa C901
                 'mountpoint',
                 'fullsize',
                 'label',
-                'attributes'
+                'attributes',
+                'is_root_volume'
             ]
         )
 
@@ -1262,6 +1266,7 @@ def get_volumes(self):  # noqa C901
                 fullsize = False
                 label = volume.get_label()
                 attributes = []
+                is_root_volume = False
 
                 if volume.get_copy_on_write() is False:
                     # by default copy-on-write is switched on for any
@@ -1270,11 +1275,21 @@ def get_volumes(self):  # noqa C901
                     attributes.append('no-copy-on-write')
 
                 if '@root' in name:
-                    # setup root volume, it takes a fixed volume name and
-                    # has no specific mountpoint
+                    # setup root volume, it takes an optional volume
+                    # name if specified as @root=name and has no specific
+                    # mountpoint. The default name is set to
+                    # defaults.ROOT_VOLUME_NAME if no other root volume
+                    # name is provided
                     mountpoint = None
                     realpath = '/'
-                    name = 'LVRoot'
+                    is_root_volume = True
+                    root_volume_expression = re.match(
+                        r'@root=(.+)', name
+                    )
+                    if root_volume_expression:
+                        name = root_volume_expression.group(1)
+                    else:
+                        name = defaults.ROOT_VOLUME_NAME
                     have_root_volume_setup = True
                 elif not mountpoint:
                     # setup volume without mountpoint. In this case the name
@@ -1310,7 +1325,8 @@ def get_volumes(self):  # noqa C901
                         mountpoint=mountpoint,
                         realpath=realpath,
                         label=label,
-                        attributes=attributes
+                        attributes=attributes,
+                        is_root_volume=is_root_volume
                     )
                 )
 
@@ -1327,13 +1343,14 @@ def get_volumes(self):  # noqa C901
                 fullsize = True
             volume_type_list.append(
                 volume_type(
-                    name='LVRoot',
+                    name=defaults.ROOT_VOLUME_NAME,
                     size=size,
                     fullsize=fullsize,
                     mountpoint=None,
                     realpath='/',
                     label=None,
-                    attributes=[]
+                    attributes=[],
+                    is_root_volume=True
                 )
             )
 
@@ -1346,7 +1363,8 @@ def get_volumes(self):  # noqa C901
                     mountpoint=None,
                     realpath='swap',
                     label='SWAP',
-                    attributes=[]
+                    attributes=[],
+                    is_root_volume=False
                 )
             )
 

test/data/example_lvm_custom_rootvol_config.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<image schemaversion="7.3" name="custom-root-volume-setup">
+    <description type="system">
+        <author>Marcus Schäfer</author>
+        <contact>ms@suse.com</contact>
+        <specification>
+            openSUSE 13.2 JeOS, is a small text based image
+        </specification>
+    </description>
+    <preferences>
+        <version>1.13.2</version>
+        <packagemanager>zypper</packagemanager>
+        <locale>en_US</locale>
+        <keytable>us.map.gz</keytable>
+        <timezone>Europe/Berlin</timezone>
+        <rpm-excludedocs>true</rpm-excludedocs>
+        <rpm-check-signatures>false</rpm-check-signatures>
+        <bootsplash-theme>openSUSE</bootsplash-theme>
+        <bootloader-theme>openSUSE</bootloader-theme>
+        <type image="oem" filesystem="ext3" installiso="true" kernelcmdline="splash" firmware="efi">
+            <systemdisk>
+                <volume name="@root=myroot" freespace="500M"/>
+            </systemdisk>
+        </type>
+    </preferences>
+    <users>
+        <user groups="root" password="$1$wYJUgpM5$RXMMeASDc035eX.NbYWFl0" home="/root" name="root"/>
+    </users>
+    <repository>
+        <source path="obs://13.2/repo/oss"/>
+    </repository>
+    <packages type="image">
+        <package name="patterns-openSUSE-base"/>
+    </packages>
+    <packages type="bootstrap">
+        <package name="udev"/>
+        <package name="filesystem"/>
+        <package name="glibc-locale"/>
+    </packages>
+</image>

test/unit/storage/disk_test.py

@@ -73,7 +73,6 @@ def test_create_root_lvm_partition(self):
             'p.lxlvm', 100, 't.lvm'
         )
         assert self.disk.public_partition_id_map['kiwi_RootPart'] == 1
-        assert self.disk.public_partition_id_map['kiwi_RootPartVol'] == 'LVRoot'
 
     def test_create_root_raid_partition(self):
         self.disk.create_root_raid_partition(100)

test/unit/system/profile_test.py

@@ -29,11 +29,11 @@ def test_create(self, mock_which, mock_temp):
         os.remove(self.profile_file)
         assert self.profile.dot_profile == {
             'kiwi_Volume_1': 'usr_lib|size:1024|usr/lib',
-            'kiwi_Volume_2': 'LVRoot|freespace:500|',
-            'kiwi_Volume_3': 'etc_volume|freespace:30|etc',
-            'kiwi_Volume_4': 'bin_volume|size:all|/usr/bin',
-            'kiwi_Volume_5': 'usr_bin|freespace:30|usr/bin',
-            'kiwi_Volume_6': 'LVSwap|size:128|',
+            'kiwi_Volume_2': 'etc_volume|freespace:30|etc',
+            'kiwi_Volume_3': 'bin_volume|size:all|/usr/bin',
+            'kiwi_Volume_4': 'usr_bin|freespace:30|usr/bin',
+            'kiwi_Volume_5': 'LVSwap|size:128|',
+            'kiwi_Volume_Root': 'LVRoot|freespace:500|',
             'kiwi_bootkernel': None,
             'kiwi_bootloader': 'grub2',
             'kiwi_bootprofile': None,