This guide details how to install single or multiple systems, and how to exploit the product-inherent capabilities for a deployment infrastructure.
- Preface
- I Installation preparation
- II Pre-built image deployment
- III Manual installation
- A GNU licenses
- 11.1 The boot screen on machines with a traditional BIOS
- 11.2 The boot screen on machines with UEFI
- 11.3 GRUB options editor
- 12.1 Network settings
- 12.2 License agreement
- 12.3 Disk activation
- 12.4 DASD disk management
- 12.5 Configured zFCP Devices
- 12.6 Registration
- 12.7 Extensions
- 12.8 NTP configuration
- 12.9 Authentication for
root
- 12.10 Installation Settings
- 12.11 Suggested partitioning
- 12.12 Expert Partitioner
- 12.13 Software configuration
- 12.14 Time zone configuration
- 12.15 Booting
- 12.16 Kdump configuration
- 12.17 System overview
- 12.18 Security configuration
- 14.1 US keyboard layout
- 4.1 Configuration of a z/VM directory
- 4.2 Example domain XML file
- 4.3 Transferring the binaries via FTP
- 4.4 sles.exec
- 4.5 Supported network connection types and driver parameters
- 4.6 Network device driver parameters
- 4.7 Networking parameters
- 4.8 Parmfile for an installation from NFS with VNC and AutoYaST, with I/O device auto configuration
- 4.9 Parmfile for installation with NFS, SSH, and HSI and AutoYaST with NFS
- 4.10 Parmfile for installation in VLAN
- 12.1
regcodes.txt
- 12.2
regcodes.xml
Copyright © 2006–2024 SUSE LLC and contributors. All rights reserved.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or (at your option) version 1.3; with the Invariant Section being this copyright notice and license. A copy of the license version 1.2 is included in the section entitled “GNU Free Documentation License”.
For SUSE trademarks, see https://www.suse.com/company/legal/. All third-party trademarks are the property of their respective owners. Trademark symbols (®, ™ etc.) denote trademarks of SUSE and its affiliates. Asterisks (*) denote third-party trademarks.
All information found in this book has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither SUSE LLC, its affiliates, the authors nor the translators shall be held liable for possible errors or the consequences thereof.
Preface #
1 Available documentation #
- Online documentation
Our documentation is available online at https://documentation.suse.com. Browse or download the documentation in various formats.
Note: Latest updatesThe latest updates are usually available in the English-language version of this documentation.
- SUSE Knowledgebase
If you have run into an issue, also check out the Technical Information Documents (TIDs) that are available online at https://www.suse.com/support/kb/. Search the SUSE Knowledgebase for known solutions driven by customer need.
- Release notes
For release notes, see https://www.suse.com/releasenotes/.
- In your system
For offline use, the release notes are also available under
/usr/share/doc/release-notes
on your system. The documentation for individual packages is available at/usr/share/doc/packages
.Many commands are also described in their manual pages. To view them, run
man
, followed by a specific command name. If theman
command is not installed on your system, install it withsudo zypper install man
.
2 Improving the documentation #
Your feedback and contributions to this documentation are welcome. The following channels for giving feedback are available:
- Service requests and support
For services and support options available for your product, see https://www.suse.com/support/.
To open a service request, you need a SUSE subscription registered at SUSE Customer Center. Go to https://scc.suse.com/support/requests, log in, and click .
- Bug reports
Report issues with the documentation at https://bugzilla.suse.com/.
To simplify this process, click the
icon next to a headline in the HTML version of this document. This preselects the right product and category in Bugzilla and adds a link to the current section. You can start typing your bug report right away.A Bugzilla account is required.
- Contributions
To contribute to this documentation, click the
icon next to a headline in the HTML version of this document. This will take you to the source code on GitHub, where you can open a pull request.A GitHub account is required.
Note:only available for EnglishThe
icons are only available for the English version of each document. For all other languages, use the icons instead.For more information about the documentation environment used for this documentation, see the repository's README.
You can also report errors and send feedback concerning the documentation to <doc-team@suse.com>. Include the document title, the product version, and the publication date of the document. Additionally, include the relevant section number and title (or provide the URL) and provide a concise description of the problem.
3 Documentation conventions #
The following notices and typographic conventions are used in this document:
/etc/passwd
: Directory names and file namesPLACEHOLDER: Replace PLACEHOLDER with the actual value
PATH
: An environment variablels
,--help
: Commands, options, and parametersuser
: The name of a user or grouppackage_name: The name of a software package
Alt, Alt–F1: A key to press or a key combination. Keys are shown in uppercase as on a keyboard.
AMD/Intel This paragraph is only relevant for the AMD64/Intel 64 architectures. The arrows mark the beginning and the end of the text block.
IBM Z, POWER This paragraph is only relevant for the architectures
IBM Z
andPOWER
. The arrows mark the beginning and the end of the text block.Chapter 1, “Example chapter”: A cross-reference to another chapter in this guide.
Commands that must be run with
root
privileges. You can also prefix these commands with thesudo
command to run them as a non-privileged user:#
command
>
sudo
command
Commands that can be run by non-privileged users:
>
command
Commands can be split into two or multiple lines by a backslash character (
\
) at the end of a line. The backslash informs the shell that the command invocation will continue after the line's end:>
echo
a b \ c dA code block that shows both the command (preceded by a prompt) and the respective output returned by the shell:
>
command
outputNotices
Warning: Warning noticeVital information you must be aware of before proceeding. Warns you about security issues, potential loss of data, damage to hardware, or physical hazards.
Important: Important noticeImportant information you should be aware of before proceeding.
Note: Note noticeAdditional information, for example about differences in software versions.
Tip: Tip noticeHelpful information, like a guideline or a piece of practical advice.
Compact Notices
Additional information, for example about differences in software versions.
Helpful information, like a guideline or a piece of practical advice.
4 Support #
Find the support statement for SUSE Linux Enterprise Micro and general information about technology previews below. For details about the product lifecycle, see https://www.suse.com/lifecycle.
If you are entitled to support, find details on how to collect information for a support ticket at https://documentation.suse.com/sles-15/html/SLES-all/cha-adm-support.html.
4.1 Support statement for SUSE Linux Enterprise Micro #
To receive support, you need an appropriate subscription with SUSE. To view the specific support offers available to you, go to https://www.suse.com/support/ and select your product.
The support levels are defined as follows:
- L1
Problem determination, which means technical support designed to provide compatibility information, usage support, ongoing maintenance, information gathering and basic troubleshooting using available documentation.
- L2
Problem isolation, which means technical support designed to analyze data, reproduce customer problems, isolate a problem area and provide a resolution for problems not resolved by Level 1 or prepare for Level 3.
- L3
Problem resolution, which means technical support designed to resolve problems by engaging engineering to resolve product defects which have been identified by Level 2 Support.
For contracted customers and partners, SUSE Linux Enterprise Micro is delivered with L3 support for all packages, except for the following:
Technology previews.
Sound, graphics, fonts, and artwork.
Packages that require an additional customer contract.
Packages with names ending in -devel (containing header files and similar developer resources) will only be supported together with their main packages.
SUSE will only support the usage of original packages. That is, packages that are unchanged and not recompiled.
4.2 Technology previews #
Technology previews are packages, stacks, or features delivered by SUSE to provide glimpses into upcoming innovations. Technology previews are included for your convenience to give you a chance to test new technologies within your environment. We would appreciate your feedback. If you test a technology preview, please contact your SUSE representative and let them know about your experience and use cases. Your input is helpful for future development.
Technology previews have the following limitations:
Technology previews are still in development. Therefore, they may be functionally incomplete, unstable, or otherwise not suitable for production use.
Technology previews are not supported.
Technology previews may only be available for specific hardware architectures.
Details and functionality of technology previews are subject to change. As a result, upgrading to subsequent releases of a technology preview may be impossible and require a fresh installation.
SUSE may discover that a preview does not meet customer or market needs, or does not comply with enterprise standards. Technology previews can be removed from a product at any time. SUSE does not commit to providing a supported version of such technologies in the future.
For an overview of technology previews shipped with your product, see the release notes at https://www.suse.com/releasenotes.
Part I Installation preparation #
- 1 Planning for SUSE Linux Enterprise Micro
This chapter describes some basic considerations before installing SUSE Linux Enterprise Micro.
- 2 Installation on AMD64 and Intel 64
This chapter describes the steps necessary to prepare for the installation of SUSE Linux Enterprise Micro on AMD64 and Intel 64 computers. It introduces the steps required to prepare for various installation methods. The list of hardware requirements provides an overview of systems supported by SUSE Linux Enterprise Micro. Find information about available installation methods and several commonly known problems. Also learn how to control the installation, provide installation media, and boot with regular methods.
- 3 Installation on AArch64
This chapter describes the steps necessary to prepare for the installation of SUSE Linux Enterprise Micro on AArch64 computers. It introduces the steps required to prepare for various installation methods. The list of hardware requirements provides an overview of systems supported by SUSE Linux Enterprise Server. Find information about available installation methods and several common known problems. Also learn how to control the installation, provide installation media, and boot with regular methods.
- 4 Installation on IBM Z and LinuxONE
This chapter describes the procedure for preparing the installation of SUSE® Linux Enterprise Micro on IBM Z. It provides all information needed to prepare the installation on the LPAR and z/VM side.
1 Planning for SUSE Linux Enterprise Micro #
This chapter describes some basic considerations before installing SUSE Linux Enterprise Micro.
1.1 Considerations for deployment of SUSE Linux Enterprise Micro #
The implementation of an operating system either in an existing IT environment or as a completely new rollout must be carefully prepared. At the beginning of the planning process, you should try to define the project goals and necessary features. This must always be done individually for each project, but the questions to answer should include the following:
How many installations should be done? Depending on this, the best deployment methods differ.
Will the system be exposed to external threats like hacker attacks?
How will you get regular updates? All patches are provided online for registered users in the SUSE Customer Center.
Do you need help for your local installation? SUSE provides training, support, and consulting for all topics pertaining to SUSE Linux Enterprise Micro. Find more information about this at https://www.suse.com/products/server/.
Do you need third-party products? Make sure that the required product is also supported on the desired platform. SUSE can provide help to support software on different platforms when needed.
1.2 Deployment of SUSE Linux Enterprise Micro #
To make sure that your system will run flawlessly, always try to use certified hardware. The hardware certification process is an ongoing process and the database of certified hardware is updated regularly. Find the search form for certified hardware at https://www.suse.com/yessearch/Search.jsp.
In case you intend to install only several nodes of SLE Micro, you can choose the manual installation or you can directly deploy pre-built images. For a large-scale deployment it is recommended to use the automatic installation by using AutoYaST, SUSE Manager, or wherever you can easily copy the pre-built images to the desired machines, you can also use the pre-built images for a large-scale deployment.
SUSE Linux Enterprise Micro provides you with a broad variety of services. Most of the needed configurations can be made with YaST, the SUSE configuration utility. In addition, many manual configurations are described in the corresponding chapters.
In addition to the plain software installation, you should consider training the end users of the systems and help desk staff.
In the following sections, the system to hold your new SUSE Linux Enterprise Micro installation is called target system or installation target. The term repository (previously called “installation source”) is used for all sources of installation data. This includes physical media, such as CD, DVD, or USB flash drive, and network servers distributing the installation data in your network.
1.3 Running SUSE Linux Enterprise Micro #
The SUSE Linux Enterprise Micro operating system is a well-tested and stable system. Unfortunately, this does not prevent hardware failures or other causes for downtime or data loss. Make sure that you have a backup solution in place for mission-critical tasks.
For optimal security and data safety, you should make regular updates of all the operated machines. If you have a mission critical server, you should run a second identical (pre-production) machine that you can use to test all changes. This also gives you the possibility of switching machines in case of hardware failure.
1.4 Registering SUSE Linux Enterprise Micro #
To get technical support and product updates, you need to register and activate your SUSE product with the SUSE Customer Center. We recommend to register during the installation, since this will enable you to install the system with the latest updates and patches available. However, if you are offline or want to skip the registration step, you can complete registration from the running system.
In case your organization does not provide a local registration server, registering SUSE Linux Enterprise requires a SUSE Customer Center account. In case you do not have one yet, go to the SUSE Customer Center home page (https://scc.suse.com/) to create one.
During the manual installation you will be asked to enter your registration code. For details, refer to Section 12.5, “Registration”. If you deploy SLE Micro pre-built images, you need to register your system after the installation, for details refer to Section 10.1, “Registration”.
If you deploy your instances automatically using AutoYaST, you can register the system during the installation by providing the respective information in the AutoYaST control file. For details, see Book “AutoYaST Guide”, Chapter 4 “Configuration and installation options”, Section 4.3 “System registration and extension selection”.
2 Installation on AMD64 and Intel 64 #
This chapter describes the steps necessary to prepare for the installation of SUSE Linux Enterprise Micro on AMD64 and Intel 64 computers. It introduces the steps required to prepare for various installation methods. The list of hardware requirements provides an overview of systems supported by SUSE Linux Enterprise Micro. Find information about available installation methods and several commonly known problems. Also learn how to control the installation, provide installation media, and boot with regular methods.
2.1 Hardware requirements #
The SUSE® Linux Enterprise Micro operating system can be deployed on a wide range of hardware. It is impossible to list all the different combinations of hardware SUSE Linux Enterprise Server supports. However, to provide you with a guide to help you during the planning phase, the minimum requirements are presented here.
If you want to be sure that a given computer configuration will work, find out which platforms have been certified by SUSE. Find a list at https://www.suse.com/yessearch/.
The Intel 64 and AMD64 architectures support the simple migration of x86 software to 64 bits. Like the x86 architecture, they constitute a value-for-money alternative.
- CPU
Most CPUs available at the time of release are supported.
- Maximum number of CPUs
The maximum number of CPUs supported by software design is 8192 for Intel 64 and AMD64. If you plan to use such a large system, verify with our hardware system certification Web page for supported devices, see https://www.suse.com/yessearch/.
- Memory requirements
SLE Micro requires at least 1GB RAM. Bear in mind that this is a minimal value for the operating system, the actual memory size depends on the workload.
- Hard disk requirements
The minimum hard disk space is 12GB. But the recommended value is 20GB of hard disk space. Adjust the value according to workloads of your containers.
2.2 Installation considerations #
This section encompasses many factors that need to be considered before installing SUSE Linux Enterprise Micro on AMD64 and Intel 64 hardware.
2.2.1 Installation on hardware or virtual machine #
SUSE Linux Enterprise Micro is normally installed as an independent operating system. With virtualization it is also possible to run multiple instances of SUSE Linux Enterprise Micro on the same hardware.
2.2.2 Installation target #
Most installations are to a local hard disk. Therefore, it is necessary for the hard disk controllers to be available to the installation system. If a special controller (like a RAID controller) needs an extra kernel module, provide a kernel module update disk to the installation system.
Other installation targets may be various types of block devices that
provide sufficient disk space and speed to run an operating system. This
includes network block devices like iSCSI
or
SAN
. It is also possible to install on network file
systems that offer the standard Unix permissions. However, it may be
problematic to boot these, because they must be supported by the
initramfs
before the actual system can start. Such
installations can be useful when you need to start the same system in
different locations or you plan to use virtualization features like domain
migration.
2.3 Installation methods #
You can choose the desired installation method by booting the setup with one of the options listed in Section 2.4, “Booting the system”. To enable the additional installation methods, refer to Section 11.3.4, “Specifying remote access”. For information about how to use remote installation methods, refer to Chapter 13, Remote installation.
A brief overview of the different methods:
- Local with monitor and keyboard
This is the method most frequently used to install SUSE Linux Enterprise Micro. This also requires very little preparation but needs a lot of direct interaction.
- Remote via SSH
You can perform installation via SSH either in text mode or use X-forwarding for a graphical installation. For details, refer to Section 13.4, “Monitoring installation via SSH”.
- Remote via serial console
For this installation method, you need a second computer connected via a null modem cable to the target computer. The installation is done in text mode. For details, refer to Section 13.5, “Installation via serial console”.
- Remote via VNC
Use this method to perform the installation using a graphical interface without direct access to the target machine. For details, refer to Section 13.3, “Monitoring installation via VNC”.
2.4 Booting the system #
This section gives an overview of the steps required for the complete installation of SUSE® Linux Enterprise Micro.
In case of the manual installation, an overview of booting the installation system is provided by the following procedure:
Prepare the installation media.
- USB Flash Drive
In case of the manual installation from an ISO, creating a bootable flash disk is the easiest way to start the installation. You need to copy the ISO to the device using the
dd
. The flash disk must not be mounted, and all data on the device will be erased.#
dd
if=PATH_TO_ISO_IMAGE of=USB_STORAGE_DEVICE bs=4M- Network booting
If the target computer's firmware supports it, you can boot the computer from the network and install from a server. This booting method requires a boot server that provides the needed boot images over the network. The exact protocol depends on your hardware. Commonly you need several services, such as TFTP and DHCP or PXE boot.
It is possible to install from many common network protocols, such as NFS, HTTP, FTP, or SMB. For more information on how to perform such an installation, refer to Chapter 13, Remote installation.
Configure the target system firmware to boot the medium you chose. Refer to the documentation of your hardware vendor about how to configure the correct boot order.
Set the boot parameters required for your installation control method. An overview of the different methods is provided in Section 2.3, “Installation methods”. A list of boot parameters is available in Chapter 11, Boot parameters.
Perform the installation as described in Chapter 12, Installation steps. The system needs to restart after the installation is finished.
Optional: Change the boot order of the system to directly boot from the medium to which SUSE Linux Enterprise Micro has been installed. If the system boots from the installation medium, the first boot parameter will be to boot the installed system.
For the deployment of raw images, the procedure is the following:
Prepare the raw image, for details refer to Procedure 7.2, “Preparing the raw disk image”.
Prepare the configuration media, for details refer to Procedure 7.1, “Preparing the configuration device”.
Configure the target system firmware to boot the medium where you copied the raw image. Refer to the documentation of your hardware vendor about how to configure the correct boot order.
Perform the installation as described in Chapter 8, Deploying the raw image. The system needs to restart after the installation is finished.
2.5 Dealing with boot and installation problems #
Prior to delivery, SUSE® Linux Enterprise Micro is subjected to an extensive test program. Despite this, problems occasionally occur during boot or installation.
2.5.1 Problems booting #
Boot problems may prevent the YaST installer from starting on your system. Another symptom is when your system does not boot after the installation has been completed.
- System does not boot from installation media
Change your computer's firmware or BIOS so that the boot sequence is correct. To do this, consult the manual for your hardware.
- The computer hangs
Change the console on your computer so that the kernel outputs are visible. Be sure to check the last outputs. This is normally done by pressing Ctrl–Alt–F10. If you cannot resolve the problem, consult the SUSE Linux Enterprise Micro support staff. To log all system messages at boot time, use a serial connection as described in Section 2.3, “Installation methods”.
- Boot disk
The boot disk is a useful interim solution if you have difficulties setting the other configurations or if you want to postpone the decision regarding the final boot mechanism.
- Virus warning after installation
There are BIOS variants that check the structure of the boot sector (MBR) and erroneously display a virus warning after the installation of GRUB 2. Solve this problem by entering the BIOS and looking for corresponding adjustable settings. For example, switch off
. You can switch this option back on again later. It is unnecessary, however, if Linux is the only operating system you use.
2.5.2 Problems installing #
If an unexpected problem occurs during installation, information is needed to determine the cause of the problem. Use the following directions to help with troubleshooting:
Check the outputs on the various consoles. You can switch consoles with the key combination Ctrl–Alt–Fn. For example, obtain a shell in which to execute various commands by pressing Ctrl–Alt–F2.
Try launching the installation with “Safe Settings” (press F5 on the installation screen and choose ). If the installation works without problems in this case, there is an incompatibility that causes either
ACPI
orAPIC
to fail. In some cases, a BIOS or firmware update fixes this problem.Check the system messages on a console in the installation system by entering the command
dmesg -T
.
2.5.3 Initiating installation instead of booting #
The default option in the boot menu of the installation source for SUSE Linux Enterprise Micro boots the machine into the already installed system. To avoid this and to initiate the installation process instead, choose one of the available installation options in the boot menu.
3 Installation on AArch64 #
This chapter describes the steps necessary to prepare for the installation of SUSE Linux Enterprise Micro on AArch64 computers. It introduces the steps required to prepare for various installation methods. The list of hardware requirements provides an overview of systems supported by SUSE Linux Enterprise Server. Find information about available installation methods and several common known problems. Also learn how to control the installation, provide installation media, and boot with regular methods.
3.1 Hardware requirements #
The SUSE® Linux Enterprise Micro operating system can be deployed on a wide range of hardware. It is impossible to list all the different combinations of hardware SUSE Linux Enterprise Micro supports. However, to provide you with a guide to help you during the planning phase, the minimum requirements are presented here.
If you want to be sure that a given computer configuration will work, find out which platforms have been certified by SUSE. Find a list at https://www.suse.com/yessearch/.
- CPU
The minimum requirement is a CPU that supports the Armv8-A instruction set architecture (ISA), for example, Arm Cortex-A53 or Cortex-A57. Refer to https://www.arm.com/products/processors/cortex-a/ for a list of available Armv8-A processors.
CPUs with the Armv8-R (realtime) and Armv8-M (microcontroller) ISA are currently not supported.
- Maximum number of CPUs
The maximum number of supported CPUs is 256. If you plan to use such a large system, check our hardware system certification Web page for supported devices, see https://www.suse.com/yessearch/.
- Memory requirements
A minimum of 1024 MB of memory is required for a minimal installation. On machines with more than two processors, add 512 MB per CPU. For remote installations via HTTP or FTP, add another 150 MB. Note that these values are only valid for the installation of the operating system—the actual memory requirement in production depends on the system's workload. For systems running the GNOME desktop environment, a minimum of 2048 MB of memory is required and 4096 MB is recommended.
- Hard disk requirements
The disk requirements depend largely on the workload of your containers. Commonly, you need more space than the installation software itself needs to have a system that works properly. The minimum required value is 12 GB. The recommended value is 20 GB.
- Boot methods
The computer can be booted from a USB disk or a network. A special boot server is required to boot over the network. This can be set up with SUSE Linux Enterprise Server.
3.2 Installation considerations #
This section encompasses many factors that need to be considered before installing SUSE Linux Enterprise Micro on AArch64 hardware.
3.2.1 Installation on hardware or virtual machine #
SUSE Linux Enterprise Micro is normally installed as an independent operating system. With virtualization it is also possible to run multiple instances of SLE Micro on the same hardware. The installation of the VM Host Server is performed like a typical installation with some additional packages.
3.2.2 Installation target #
Most installations are to a local hard disk. Therefore, it is necessary for the hard disk controllers to be available to the installation system. If a special controller (like a RAID controller) needs an extra kernel module, provide a kernel module update disk to the installation system.
Other installation targets may be various types of block devices that
provide sufficient disk space and speed to run an operating system. This
includes network block devices like iSCSI
or
SAN
. It is also possible to install on network file
systems that offer the standard Unix permissions. However, it may be
problematic to boot these, because they must be supported by the
initramfs
before the actual system can start. Such
installations can be useful when you need to start the same system in
different locations or you plan to use virtualization features like domain
migration.
3.3 Controlling the installation process #
You can choose the desired installation method by booting the setup with one of the options listed in Section 2.4, “Booting the system”. To enable the additional installation methods, refer to Section 11.3.4, “Specifying remote access”. For information about how to use remote installation methods, refer to Chapter 13, Remote installation.
A brief overview of the different methods:
- Local with monitor and keyboard
This is the method most frequently used to install SUSE Linux Enterprise Micro. This also requires little preparation but needs a lot of direct interaction.
- Remote via SSH
You can perform installation via SSH either in text mode or use X-forwarding for a graphical installation. For details, refer to Section 13.4, “Monitoring installation via SSH”.
- Remote via serial console
For this installation method, you need a second computer connected via a null modem cable to the target computer. The installation is done in text mode. For details, refer to Section 13.5, “Installation via serial console”.
- Remote via VNC
Use this method to perform the installation using a graphical interface without direct access to the target machine. For details, refer to Section 13.3, “Monitoring installation via VNC”.
3.4 Booting the system #
This section gives an overview of the steps required for the complete installation of SUSE® Linux Enterprise Micro.
For a full description of how to install and configure the system with YaST, refer to Part III, “Manual installation”.
In case of the manual installation, an overview of booting the installation system is provided by the following procedure:
Prepare the installation media.
- USB Flash Drive
In case of the manual installation from an ISO, creating a bootable flash disk is the easiest way to start the installation. You need to copy the ISO to the device using the
dd
. The flash disk must not be mounted, and all data on the device will be erased.#
dd
if=PATH_TO_ISO_IMAGE of=USB_STORAGE_DEVICE bs=4MIf you are deploying raw images, you need to prepare the configuration device. For details refer to Chapter 8, Deploying the raw image.
- Network booting
If the target computer's firmware supports it, you can boot the computer from the network and install from a server. This booting method requires a boot server that provides the needed boot images over the network. The exact protocol depends on your hardware. Commonly you need several services, such as TFTP and DHCP or PXE boot.
It is possible to install from many common network protocols, such as NFS, HTTP, FTP, or SMB. For more information on how to perform such an installation, refer to Chapter 13, Remote installation.
Configure the target system firmware to boot the medium you chose. Refer to the documentation of your hardware vendor about how to configure the correct boot order.
Set the boot parameters required for your installation control method. An overview of the different methods is provided in Section 3.3, “Controlling the installation process”. A list of boot parameters is available in Chapter 11, Boot parameters.
Perform the installation as described in Chapter 12, Installation steps. The system needs to restart after the installation is finished.
Optional: Change the boot order of the system to directly boot from the medium to which SUSE Linux Enterprise Micro has been installed. If the system boots from the installation medium, the first boot parameter will be to boot the installed system.
For the deployment of raw images, the procedure is the following:
Prepare the raw image, for details refer to Procedure 7.2, “Preparing the raw disk image”.
Prepare the configuration media, for details refer to Procedure 7.1, “Preparing the configuration device”.
Configure the target system firmware to boot the medium where you copied the raw image. Refer to the documentation of your hardware vendor about how to configure the correct boot order.
Perform the installation as described in Chapter 8, Deploying the raw image. The system needs to restart after the installation is finished.
3.5 Dealing with boot and installation problems #
Although SUSE® Linux Enterprise Micro undergoes an extensive test program, problems may occasionally occur during boot or installation.
3.5.1 Boot problems #
Boot problems may prevent the YaST installer from starting on your system. Another symptom is failure to boot after the installation has been completed.
- Machine boots the installed system instead of the installation medium
Change the boot sequence in your machine's BIOS. Refer to the documentation supplied with your hardware for further information.
- The system hangs
Change the console on your system so that the kernel outputs are visible. Be sure to check the last few lines of output. This is normally done by pressing Ctrl–Alt–F10. If you cannot resolve the problem, consult the SUSE Linux Enterprise Micro support staff. To log all system messages at boot time, use a serial connection as described in Section 2.3, “Installation methods”.
- Boot disk
The boot disk is a useful interim solution for boot issues. If you have difficulties setting the other configurations, or if you want to postpone the decision regarding the final boot mechanism, use a boot disk.
3.5.2 Problems installing #
If an unexpected problem occurs during installation, information is needed to determine the cause of the problem. Use the following directions to help with troubleshooting:
Check the outputs on the various consoles. You can switch consoles with the key combination Ctrl–Alt–Fn. For example, obtain a shell in which to execute various commands by pressing Ctrl–Alt–F2.
Try launching the installation with “Safe Settings” (press F5 on the installation screen and choose ). If the installation works without problems in this case, there is an incompatibility that causes either
ACPI
orAPIC
to fail. In some cases, a firmware update fixes this problem.Check the system messages on a console in the installation system by entering the command
dmesg -T
.
3.5.3 Initiating installation instead of booting #
The default option in the boot menu of the installation medium for SUSE Linux Enterprise Micro boots the machine into the already installed system. To initiate the installation process instead, choose one of the available installation options in the boot menu.
3.6 Raspberry Pi #
SUSE® Linux Enterprise Server is the first enterprise Linux distribution to support the inexpensive Raspberry Pi* single-board computer. SUSE Linux Enterprise Micro 5.5 supports the following models:
Raspberry Pi 3 Model A+
Raspberry Pi 3 Model B
Raspberry Pi 3 Model B+
Raspberry Pi 4 Model B
Raspberry Pi Compute Module 3
Raspberry Pi Compute Module 3+
Raspberry Pi Compute Module 4
The Raspberry Pi differs from more conventional server machines in several ways. First and foremost, it does not come with a boot loader capable of loading operating systems. SUSE Linux Enterprise Micro therefore ships additional boot loader software to fill that gap.
3.6.1 Boot process #
The primary processor on the Raspberry Pi's System-on-Chip (SoC) is the Broadcom VideoCore Graphics Processing Unit (GPU), not the Arm Central Processing Unit (CPU). It is the GPU which starts initializing the hardware from a first-stage boot loader in the on-chip Boot Read-Only Memory (Boot ROM). Only a few configuration options can influence the Boot ROM; see Section 3.6.1.2, “OTP memory”.
The Raspberry Pi 3 hardware does not have any built-in firmware. Instead, its
second-stage boot loader firmware bootcode.bin
is loaded
from the boot medium every time the machine is powered on. It in turn loads
the third-stage boot loader start.elf
.
The Raspberry Pi 4 hardware has a small Electrically Erasable Programmable
Read-Only Memory (EEPROM) for the second-stage boot loader. Apart from that,
its boot sequence is similar to that of the Raspberry Pi 3, loading the
third-stage boot loader start4.elf
from the boot medium.
An update of the second-stage boot loader can be performed by booting from a specially prepared microSD card.
Only insert boot media that you trust, and verify that no file called
recovery.bin
is unintentionally present.
If an armstub8.bin
file is present, it will be loaded as
a fourth-stage boot loader at AArch64 Exception Level 3 (EL3). Otherwise,
a minimal integrated stub will be used.
Code loaded for EL3 (often called BL31) will reside in memory, and Linux may attempt hypercalls into EL3 throughout its runtime.
Verify that your boot media have no armstub8.bin
file
unintentionally present. SUSE Linux Enterprise Micro 5.5 does not include it.
Beware that the Raspberry Pi's SoC does not provide TrustZone secure memory. Both the OS on the CPU and any software on the GPU may access its RAM. It is therefore unsuited for cryptographic EL0-s applications. SUSE Linux Enterprise Micro does not provide an EL1-s Trusted Execution Environment (TEE) for that reason.
SUSE Linux Enterprise Micro for the Raspberry Pi is configured to load a fifth-stage boot loader
called Das U-Boot
.
3.6.1.1 Config.txt #
There is no non-volatile memory to hold configuration information. This means there are no conventional settings to adjust for boot device order, time and date, and so on.
Instead, the boot loader reads a configuration file
config.txt
from the boot medium. The
config.txt
provided by SUSE should not be modified. It
allows the user to optionally provide an extraconfig.txt
file, which can override any setting from config.txt
if
needed. This permits SUSE Linux Enterprise Micro to update the
config.txt
file when needed, without overwriting any
user settings.
3.6.1.2 OTP memory #
The SoC also has a very small amount of One-Time Programmable Memory (OTP memory). This can be used to configure some settings, such as whether the Boot ROM should attempt to boot from USB devices or over Ethernet.
This OTP memory is described on the Raspberry Pi Foundation Web site: https://www.raspberrypi.org/documentation/hardware/raspberrypi/otpbits.md
Configuration settings written into OTP memory cannot be reversed.
The most common use case for OTP memory will be enabling USB boot on Raspberry Pi 3 Model B or Compute Module 3.
3.6.1.3 Enabling USB boot mode for Raspberry Pi 3 Model B #
To permanently allow booting from connected USB mass storage devices on
Raspberry Pi 3 Model B, and from its on-board USB Ethernet, prepare a
microSD card as described in Section 3.6.3, “Deploying an appliance image”.
Before unmounting or ejecting the card and booting from it, add to its FAT
partition a text file extraconfig.txt
(Section 3.6.1.1, “Config.txt”) with the following
setting:
program_usb_boot_mode=1
Then continue to boot from the modified microSD card as usual. Once you see output from the U-Boot or GRUB boot loaders or the Linux kernel, you can remove power and then the microSD card. Your device should now be able to boot from USB (Section 3.6.4, “Installation from USB media”).
Note that once USB boot mode has been enabled for Raspberry Pi 3 Model B, USB boot mode cannot be disabled again (Section 3.6.1.2, “OTP memory”).
For more details, refer to the Raspberry Pi Foundation Web site: https://www.raspberrypi.org/documentation/hardware/raspberrypi/bootmodes/msd.md
For the Raspberry Pi Compute Module 3, the setting required is the same, but the deployment of the modified image is a little more complicated.
3.6.2 Lack of a real-time clock #
There is no battery-backed Real-Time Clock (RTC) on the Raspberry Pi itself.
The lack of a Real-Time Clock means that Raspberry Pi devices need to be configured to fetch the time from a network server by Network Time Protocol (NTP).
However, base boards for the Raspberry Pi Compute Modules may feature an RTC.
It is also possible to connect an RTC via the GPIO connector, using Hardware Attached on Top (HATs) or other expansion boards.
Either way, check whether the respective RTC chipset is supported by SUSE Linux Enterprise Micro. The connected RTC will need to be described to the operating system via a Device Tree Overlay (Section 3.6.1.1, “Config.txt”).
- Compute Module 4 IO Board
dtparam=i2c_vc=on dtoverlay=i2c-rtc,pcf85063a,i2c_csi_dsi
- MyPi base board
dtparam=i2c1=on dtoverlay=i2c-rtc,ds1307
For other boards and HATs, consult the documentation of the they are shipped with.
3.6.3 Deploying an appliance image #
The most common method to deploy an operating system onto Raspberry Pi hardware is to copy a pre-installed system image onto a boot medium, usually a microSD card. This is the simplest and easiest method.
SUSE provides a preconfigured bootable image of SUSE Linux Enterprise Micro for Raspberry Pi hardware. This comes with the Btrfs file system, with compression enabled to improve performance and reduce wear on microSD media.
A microSD card with a minimum size of 8 GB is recommended. Faster cards will give better system performance. On the first boot, the operating system automatically expands the file system to fill the card. This means that the first boot will be substantially slower than subsequent boots.
The process of writing the card image onto microSD media is described in the Raspberry Pi Quick Start.
3.6.4 Installation from USB media #
Some models of Raspberry Pi allow booting from USB mass storage devices. This will then allow deploying SUSE Linux Enterprise Micro on Raspberry Pi similar to server platforms.
Installation can be performed from a removable USB medium, such as a memory stick, onto a microSD card in the machine's internal slot. Alternatively, it can be performed from a removable USB medium onto another USB medium, such as a USB-connected hard disk.
Note that the Ethernet controller on the Raspberry Pi 3 is connected to the device's on-board USB 2.0 bus.
Therefore an operating system running from a disk attached via USB must share the total 480 Mbps bandwidth of the USB 2.0 controller. This will limit performance, and could significantly impact network performance.
This limitation does not apply to the Raspberry Pi 4.
Newer models of Raspberry Pi 3 with BCM2837 B0 silicon (silver instead of black chip), including Raspberry Pi 3 Model B+ and Compute Module 3+, allow booting from USB-connected storage devices by default.
On older models, such as Raspberry Pi 3 Model B or Compute Module 3, USB boot can be enabled by booting from a specially prepared microSD card once. See Section 3.6.1.2, “OTP memory” for instructions.
3.6.5 Installation from network #
Because of the hardware's lack of on-board firmware (Section 3.6.1, “Boot process”), network-booting the Raspberry Pi using PXE is more complex than with more conventional computers.
The process of setting up a PXE boot server for x86 and Arm is described in the SUSE Best Practices document How to Set Up a Multi-PXE Installation Server.
The Raspberry Pi Foundation publishes information on how to boot using PXE one Raspberry Pi from another Raspberry Pi: https://www.raspberrypi.org/documentation/hardware/raspberrypi/bootmodes/net_tutorial.md
3.6.6 More information #
For more information, consult the following resources:
- SUSE Linux Enterprise Server 15 SP4 Release Notes
For more information about hardware compatibility, supported options and functionality when running on Raspberry Pi hardware, consult the Boot and Driver Enablement for Raspberry Pi section of the SUSE Linux Enterprise Server Release Notes:
https://www.suse.com/releasenotes/aarch64/SUSE-SLES/15-SP4/#aarch64-rpi
- Raspberry Pi Quick Start
https://documentation.suse.com/sles/15-SP4/html/SLES-raspberry-pi/article-raspberry-pi.html
- openSUSE Hardware Compatibility List: Raspberry Pi 3
The openSUSE project also has information about installing and configuring Raspberry Pi hardware. Much of this also applies to SUSE Linux Enterprise.
- Das U-Boot
More information about
Das U-Boot
boot loader can be found on the project's GitHub page at https://github.com/u-boot/u-boot.
4 Installation on IBM Z and LinuxONE #
This chapter describes the procedure for preparing the installation of SUSE® Linux Enterprise Micro on IBM Z. It provides all information needed to prepare the installation on the LPAR and z/VM side.
4.1 System requirements #
This section provides basic information about the system requirements, MicroCode level, and software for IBM Z.
4.1.1 Hardware #
SUSE Linux Enterprise Micro runs on the following platforms:
IBM zEnterprise EC12 (zEC12) (2827)
IBM zEnterprise BC12 (zBC12) (2828)
IBM z Systems z13 (2964)
IBM z Systems z13s (2965)
IBM z Systems z14 (3906)
IBM z Systems z14 ZR1 (3907)
IBM z Systems z15 T01 (8561)
IBM z Systems z15 T02 (8562)
IBM z Systems z16 A01 (3931)
IBM LinuxONE Emperor (2964)
IBM LinuxONE Rockhopper (2965)
IBM LinuxONE Emperor II (3906)
IBM LinuxONE Rockhopper II (3907)
IBM LinuxONE III LT1 (8561)
IBM LinuxONE III LT2 (8562)
IBM LinuxONE Emperor 4 (3931)
4.1.1.1 Memory requirements #
Different installation methods have different memory requirements during installation. At least 1 GB of memory is recommended for the text-mode installation under z/VM, LPAR, and KVM. Installation in the graphical mode requires at least 1.5 GB of memory.
A minimum of 512 MB of memory is required for installation from NFS, FTP, and SMB installation sources, or when VNC is used. Keep in mind that memory requirements also depend on the number of devices visible to the z/VM guest or the LPAR image. Installation with many accessible devices (even if unused for the installation) may require more memory.
4.1.1.2 Disk space requirements #
The disk requirements depend largely on the workload of your containers. Minimal requirements for SLE Micro are 12 GB. The recommended value is 20 GB of hard disk space.
4.1.1.3 Network connection #
A network connection is needed to communicate with your SUSE Linux Enterprise Micro system. This can be one or several of the following connections or network cards:
OSA Express Ethernet (including Fast and Gigabit Ethernet)
HiperSockets or Guest LAN
10 GBE, VSWITCH
RoCE (RDMA over Converged Ethernet)
The following interfaces are still included, but no longer supported:
CTC (or virtual CTC)
ESCON
IP network interface for IUCV
For installations under KVM, make sure the following requirements are met to enable the VM Guest to access the network transparently:
The virtual network interface is connected to a host network interface.
The host network interface is connected to a network that the virtual server will join.
If the host is configured to have a redundant network connection by grouping two independent OSA network ports into a bonded network interface, the identifier for the bonded network interface is
bond0
. If more than one bonded interface exists, it isbond1
,bond2
, etc.A non-redundant network connection setup requires the identifier of the single network interface. The identifier has the following format: enccw0.0.NNNN, where NNNN is the device number of the desired network interface.
4.1.2 MicroCode Level, APARs, and fixes #
Documentation about restrictions and requirements for this release of SUSE Linux Enterprise Server be found on IBM developerWorks at https://developer.ibm.com/technologies/linux/. We recommend to use the highest service level available. Contact IBM support for minimum requirements.
For z/VM, the following versions are supported:
z/VM 6.4
z/VM 7.1
z/VM 7.2
z/VM 7.3
Since it might be necessary to activate the VM APARs before installing the new MicroCode levels, clarify the order of installation with IBM support.
4.1.3 Software #
When installing SUSE Linux Enterprise Micro via non-Linux–based NFS or FTP, you might experience problems with NFS or FTP server software. The Windows* standard FTP server can cause errors, so we recommend performing installation via SMB on these machines.
To connect to the SUSE Linux Enterprise Micro installation system, one of the following methods is required (SSH or VNC are recommended):
- SSH with terminal emulation (xterm compatible)
SSH is a standard Unix tool that is present on most Unix or Linux systems. For Windows, you can use the Putty SSH client.
- VNC client
For Linux, the
vncviewer
VNC client is included in SUSE Linux Enterprise Micro as part of thetightvnc
package. For Windows, TightVNC is also available. Download it from https://www.tightvnc.com/.- X server
Find a suitable X server implementation on any Linux or Unix workstation. There are many commercial X Window System environments for Windows and macOS*. Some can be downloaded as free trial versions.
Before installing SUSE Linux Enterprise Micro on IBM Z, consult the
README
file located in the root directory of the first
installation medium of SUSE Linux Enterprise Micro. The file complements this
documentation.
4.2 Preparing for installation #
This chapter explains how to make the data accessible for installation, install SUSE Linux Enterprise Micro using different methods, and prepare and use the IPL of the SUSE Linux Enterprise Micro installation system. The chapter also provides information about network configuration and network installation.
4.2.1 Making the installation data available #
This section provides detailed information about making the SUSE Linux Enterprise Micro IBM Z installation data accessible for installation. Depending on your computer and system environment, choose between NFS or FTP installation. If you are running Microsoft Windows workstations in your environment, you can use the Windows network (including the SMB protocol) to install SUSE Linux Enterprise Micro on your IBM Z system.
It is possible to IPL from DVD and use the DVD as the installation medium. This is very convenient if you have restrictions setting up an installation server providing installation media over your network. The prerequisite is an FCP-attached SCSI DVD Drive.
It is not possible to perform installation from a hard disk by putting the content of the DVD to a partition on a DASD.
4.2.1.1 Using a Linux workstation or SUSE Linux Enterprise Micro DVD #
You can use a Linux workstation in your computer environment to provide the installation data to the IBM Z installation process by NFS or FTP.
Exporting the file system root (/
) does not
automatically export the mounted devices, such as DVD. Therefore, you need
to explicitly name the mount point in /etc/exports
:
/media/dvd *(ro)
After changing this file, restart the NFS server with the command
sudo systemctl restart nfsserver
.
Setting up an FTP server on a Linux system involves the installation and configuration of server software like vsftpd. Downloading the installation data via anonymous login is not supported, therefore you need to configure the FTP server to support user authentication.
4.2.1.1.1 SUSE Linux Enterprise Micro on DVD #
The first installation medium of the SUSE Linux Enterprise Micro for IBM Z contains a bootable Linux image for Intel-based workstations and an image for IBM Z.
For Intel-based workstations, boot from this medium. When prompted, choose the desired answer language and keyboard layout and select
. You need at least 64 MB RAM for this. No disk space is needed, because the entire rescue system resides in the workstation's RAM. This approach requires setting up the networking of the workstation manually.
For IBM Z, IPL your LPAR/VM guest from this medium as described in
Section 4.2.4.1.2, “IPL from FCP-attached SCSI DVD”. After entering your network
parameters, the installation system treats the medium as the source of
installation data. Because IBM Z cannot have an X11-capable terminal
attached directly, choose between VNC or SSH installation. Refer to
Section 13.3, “Monitoring installation via VNC” or
Section 13.4, “Monitoring installation via SSH” for more information.
SSH also provides a graphical installation by tunneling the X connection
through SSH with ssh -X
.
ssh -X
connections between different architectures
By default, recent versions of the X.org and Xwayland servers do not accept connections from
clients on different architectures. If you connect to the IBM Z machine from a AMD64/Intel 64
workstation with ssh -X
, you will likely see the error message:
“Prohibited client endianess, see the Xserver man page”.
To enable X connections between different architectures, create the file
/etc/X11/xorg.conf.d/99-byte-swapping.conf
with the following content:
Section "ServerFlags" Option "AllowByteSwappedClients" "on" EndSection
Restart your X.org or Xwayland server to apply the configuration change:
>
sudo
systemctl restart display-manager.service
4.2.1.2 Using a Microsoft Windows workstation #
You can use a Microsoft Windows workstation on your network to make the installation media available. The easiest way to do this is to use the SMB protocol. Make sure to activate
as this enables the encapsulation of SMB packages into TCP/IP packages. Find details in the Windows online help or other Windows-related documentation that covers networking.4.2.1.2.1 Using SMB #
To make the installation media available with SMB, insert the USB flash drive with SLE-15-SP5-Online-ARCH-GM-media1.iso into the USB port of the Windows workstation. Then create a new share using the USB flash drive's letter and make it available for everyone in the network.
The installation path in YaST can be:
smb://DOMAIN;USER:PW@SERVERNAME/SHAREPATH
Where the placeholders mean:
- DOMAIN
Optional workgroup or active directory domain.
- USER, PW
Optional user name and password of a user who can access this server and its share.
- SERVERNAME
The name of the server that hosts the share(s).
- SHAREPATH
The path to the share(s).
4.2.1.2.2 With NFS #
Refer to the documentation provided with the third party product that enables NFS server services for your Windows workstation. The USB flash drive containing the SLE-15-SP5-Online-ARCH-GM-media1.iso medium must be in the available NFS path.
4.2.1.2.3 Using FTP #
Refer to the documentation provided with the third-party product that is enabling FTP server services on your Windows workstation. The USB flash drive containing the SLE-15-SP5-Online-ARCH-GM-media1.iso medium must be in the available FTP path.
The FTP server that is bundled with certain Microsoft Windows releases implements only a subset of the FTP commands, and it is not suitable for providing the installation data. In this case, use a third-party FTP server that offers the required functionality.
4.2.1.2.4 Using an FCP-attached SCSI DVD drive #
After you IPLed from the SCSI DVD as described in Section 4.2.4.1.2, “IPL from FCP-attached SCSI DVD”, the installation system uses the DVD as the installation medium. In this case, you do not need the installation media on an FTP, NFS, or SMB server. However, you need the network configuration data for your SUSE Linux Enterprise Micro, because you must set up the network during the installation to perform a graphical installation via VNC or by X.
4.2.1.3 Using a Cobbler server for zPXE #
IPLing from the network requires a Cobbler server to provide the kernel, initrd, and the installation data. Preparing the Cobbler server requires the following steps:
4.2.1.3.1 Importing the installation data #
Importing the media requires the installation source to be available on the Cobbler server—either from USB flash drive or from a network source. Run the following command to import the data:
>
sudo
cobbler import --path=PATH1 --name=IDENTIFIER2 --arch=s390x
Mount point of the installation data. | |
A string identifying the imported product, for example
“sles15_s390x”. This string is used as the name for the
subdirectory where the installation data is copied to. On a Cobbler
server running on SUSE Linux Enterprise this is
|
4.2.1.3.2 Adding a distribution #
Adding a distribution allows Cobbler to provide the kernel and the initrd required to IPL via zPXE. Run the following command on the Cobbler server to add SUSE Linux Enterprise Micro for IBM Z:
>
sudo
cobbler distro add --arch=s390 --breed=suse --name="IDENTIFIER"1 \ --os-version=slemicro5.22 \ --initrd=/srv/www/cobbler/ks_mirror/IDENTIFIER/boot/s390x/initrd3 \ --kernel=/srv/www/cobbler/ks_mirror/IDENTIFIER/boot/s390x/linux4 \ --kopts="install=http://cobbler.example.com/cobbler/ks_mirror/IDENTIFIER"5
Unique identifier for the distribution, for example “SLE Micro 5.5 IBM Z”. | |
Operating system identifier. Use | |
Path to the initrd. The first part of the path
( | |
Path to the kernel. The first part of the path
( | |
URL to the installation directory on the Cobbler server. |
4.2.1.3.3 Adjusting the profile #
Adding a distribution (see Section 4.2.1.3.2, “Adding a distribution”) automatically generates a profile with the corresponding IDENTIFIER. Use the following command to make a few required adjustments:
>
sudo
cobbler distro edit \ --name=IDENTIFIER1 --os-version=sles102 --ksmeta=""3 --kopts="install=http://cobbler.example.com/cobbler/ks_mirror/IDENTIFIER"4
Identifier for the profile. Use the string specified when added the distribution. | |
Operating system version. Distribution to which the profile should
apply. Use the string specified with
| |
Option required for templating Kickstart files. Since it is not used for SUSE, leave it empty. | |
Space-separated list of kernel parameters. It must include at least the
|
4.2.1.3.4 Adding systems #
The last step is to add systems to the Cobbler server. This step must be performed for every IBM Z guest that should boot via zPXE. Guests are identified by their z/VM user ID (in the following example, the ID “linux01”). Note that the ID must be lowercase. To add a system, run the following command:
>
sudo
cobbler system add --name=linux01 --hostname=linux01.example.com \ --profile=IDENTIFIER --interface=qdio \ --ip-address=192.168.2.103 --subnet=192.168.2.255 --netmask=255.255.255.0 \ --name-servers=192.168.1.116 --name-servers-search=example.com \ --gateway=192.168.2.1 --kopts="KERNEL_OPTIONS"
The --kopts
option allows you to specify the kernel and
installation parameters that are usually specified in the parmfile.
Specify the parameters using the following format:
PARAMETER1=VALUE1 PARAMETER2=VALUE2. The
installer prompts for missing parameters. For a fully-automated
installation, you need to specify all parameters for networking, DASDs and
provide an AutoYaST file. Below is an example for a guest equipped with an OSA
interface using the same network parameters as above.
--kopts=" \ AutoYaST=http://192.168.0.5/autoinst.xml \ Hostname=linux01.example.com \ Domain=example.com \ HostIP=192.168.2.103 \ Gateway=192.168.2.1 \ Nameserver=192.168.1.116 \ Searchdns=example.com \ InstNetDev=osa; \ Netmask=255.255.255.0 \ Broadcast=192.168.2.255 \ OsaInterface=qdio \ Layer2=0 \ PortNo=0 \ ReadChannel=0.0.0700 \ WriteChannel=0.0.0701 \ DataChannel=0.0.0702 \ DASD=600"
4.2.1.4 Installing from a USB Flash Drive of the HMC #
Installation of SUSE Linux Enterprise Micro on IBM Z servers usually requires a network installation source. If this requirement cannot be fulfilled, SUSE Linux Enterprise Server allows you to use the USB flash drive of the Hardware Management Console (HMC) as an installation source for installation on an LPAR.
To perform installation from the USB flash drive of the HMC, proceed as follows:
Add
install=hmc:/
to theparmfile
(see Section 4.4, “The parmfile—automating the system configuration”) or kernel options.In the manual-mode installation using
linuxrc
, choose Start Installation, then Installation, and then Hardware Management Console. The installation medium must be in the HMC.
Before starting the installation, specify a network configuration in
linuxrc
. You cannot do this via boot parameters, and
it is very likely that you will need network access. In
linuxrc
, go to Start
Installation, then choose Network
Setup.
Before granting access to the media in the USB flash drive of the HMC,
wait until the Linux system is booted. IPLing can disrupt the connection
between the HMC and the LPAR. If the first attempt to use the described
method fails, you can grant the access and retry the option
HMC
.
The USB flash drive is not kept as an installation repository, as the installation is a one-time procedure. If you need an installation repository, register and use the online repository.
4.2.2 Installation types #
This section describes SUSE Linux Enterprise Micro installation steps for each installation mode. When the preparation steps described in the previous chapters have been completed, follow the overview of the desired installation mode.
As described in Section 4.2.1, “Making the installation data available”, there are three different installation modes for Linux on IBM Z: LPAR, z/VM, and KVM guest installation.
Prepare the devices needed for installation. See Section 4.2.3.1, “Preparing the IPL of an LPAR installation”.
IPL the installation system. See Section 4.2.4.1, “IPLing an LPAR installation”.
Configure the network. See Section 4.2.5, “Network configuration”.
Connect to the SUSE Linux Enterprise Micro installation system. See Section 4.2.6, “Connecting to the SUSE Linux Enterprise Micro installation system”.
Start the installation using YaST and IPL the installed system. See Chapter 12, Installation steps.
Prepare the devices needed for installation. See Section 4.2.3.2.1, “Adding a Linux guest using dirMaint”.
IPL the installation system. See Section 4.2.4.2, “IPLing a z/VM installation”.
Configure the network. See Section 4.2.5, “Network configuration”.
Connect to the SUSE Linux Enterprise Micro installation system. See Section 4.2.6, “Connecting to the SUSE Linux Enterprise Micro installation system”.
Start the installation using YaST and IPL the installed system. See Chapter 12, Installation steps.
Create a virtual disk image and write a domain XML file. See Section 4.2.3.3, “Preparing the IPL of a KVM guest installation”.
Prepare the installation target and IPL the VM Guest. See Section 4.2.4.3, “IPLing a KVM guest installation”.
Section 4.2.5.3, “Set up the network and select the installation source”.
Connect to the SUSE Linux Enterprise Micro installation system. See Section 4.2.6, “Connecting to the SUSE Linux Enterprise Micro installation system”.
Start the installation using YaST and IPL the installed system. See Chapter 12, Installation steps.
4.2.3 Preparing the IPL of the SUSE Linux Enterprise Micro installation system #
4.2.3.1 Preparing the IPL of an LPAR installation #
Configure your IBM Z system to start in ESA/S390 or Linux-only mode with an appropriate activation profile and IOCDS. For further information, refer to the IBM documentation. Continue as described in Section 4.2.4.1, “IPLing an LPAR installation”.
4.2.3.2 Preparing the IPL of a z/VM installation #
4.2.3.2.1 Adding a Linux guest using dirMaint #
The first step is to attach and format one or multiple DASDs in the system
to be used by the Linux guest in z/VM. Next, create a new user in z/VM.
The example shows the directory for a user LINUX1
with
the password LINPWD
, 1 GB of memory (extendable up
to 2 GB), several minidisks (MDISK), two CPUs, and an OSA QDIO
device.
When assigning memory to a z/VM guest, make sure that the memory size is
adequate for the preferred installation type, as described in Section 4.1.1.1, “Memory requirements”. To set the memory size to
1 GB, use the command CP DEFINE STORAGE 1G
. After
the installation has finished, reset the memory size to the desired value.
USER LINUX1 LINPWD 1024M 2048M G *____________________________________________ * LINUX1 *____________________________________________ * This VM Linux guest has two CPUs defined. CPU 01 CPUID 111111 CPU 02 CPUID 111222 IPL CMS PARM AUTOCR IUCV ANY IUCV ALLOW MACH ESA 10 OPTION MAINTCCW RMCHINFO SHARE RELATIVE 2000 CONSOLE 01C0 3270 A SPOOL 000C 2540 READER * SPOOL 000D 2540 PUNCH A SPOOL 000E 3203 A * OSA QDIO DEVICE DEFINITIONS DEDICATE 9A0 9A0 DEDICATE 9A1 9A1 DEDICATE 9A2 9A2 * LINK MAINT 0190 0190 RR LINK MAINT 019E 019E RR LINK MAINT 019D 019D RR * MINIDISK DEFINITIONS MDISK 201 3390 0001 0050 DASD40 MR ONE4ME TWO4ME THR4ME MDISK 150 3390 0052 0200 DASD40 MR ONE4ME TWO4ME THR4ME MDISK 151 3390 0253 2800 DASD40 MR ONE4ME TWO4ME THR4ME
This example uses minidisk 201 as the guest's home disk. Minidisk 150 with 200 cylinders is the Linux swap device. Disk 151 with 2800 cylinders holds the Linux installation.
As user MAINT
, add the guest to
the user directory with DIRM FOR LINUX1 ADD
. Enter the
name of the guest (LINUX1
) and press
F5. Set up the environment of the user with:
DIRM DIRECT DIRM USER WITHPASS
The last command returns a reader file number. This number is needed for the next command:
RECEIVE <number> USER DIRECT A (REPL)
You can now log in on the guest as user
LINUX1
.
If you do not have the dirmaint
option available, refer
to the IBM documentation on how to set up this user.
Proceed with Section 4.2.4.2, “IPLing a z/VM installation”.
4.2.3.3 Preparing the IPL of a KVM guest installation #
A KVM guest installation requires a domain XML file that specifies the virtual machine and at least one virtual disk image for the installation.
4.2.3.3.1 Create a virtual disk image #
By default, libvirt searches for disk images in
/var/lib/libvirt/images/
on the VM Host Server. Although
images can also be stored anywhere on the file system, it is recommended
to store all images in a single location for easier maintainability. To
create an image, log in to the KVM host server and run the following
command:
qemu-img create -f qcow2 /var/lib/libvirt/images/s12lin_qcow2.img 10G
This creates a qcow2 image with a size of 10 GB in
/var/lib/libvirt/images/
.
4.2.3.3.2 Write a domain XML file #
A domain XML file is used to define the VM Guest. To create the domain
XML file, open an empty file s15-1.xml
with an editor
and create a file like in the following example.
The following example creates a VM Guest with a single CPU, 1 GB RAM,
and the virtual disk image created in the previous section
(Section 4.2.3.3.1, “Create a virtual disk image”). It assumes that the
virtual server is attached to the host network interface
bond0
. Change the source devices element to match your
network setup.
<domain type="kvm"> <name>s15-1</name> <description>Guest-System SUSE SLES15</description> <memory>1048576</memory> <vcpu>1</vcpu> <os> <type arch="s390x" machine="s390-ccw-virtio">hvm</type> <!-- Boot kernel - remove 3 lines after successful installation --> <kernel>/var/lib/libvirt/images/s15-kernel.boot</kernel> <initrd>/var/lib/libvirt/images/s15-initrd.boot</initrd> <cmdline>linuxrcstderr=/dev/console</cmdline> </os> <iothreads>1</iothreads> <on_poweroff>destroy</on_poweroff> <on_reboot>restart</on_reboot> <on_crash>preserve</on_crash> <devices> <emulator>/usr/bin/qemu-system-s390x</emulator> <disk type="file" device="disk"> <driver name="qemu" type="qcow2" cache="none" iothread="1" io="native"/> <source file="/var/lib/libvirt/images/s15lin_qcow2.img"/> <target dev="vda" bus="virtio"/> </disk> <interface type="direct"> <source dev="bond0" mode="bridge"/> <model type="virtio"/> </interface> <console type="pty"> <target type="sclp"/> </console> </devices> </domain>
4.2.4 IPLing the SUSE Linux Enterprise Micro installation system #
4.2.4.1 IPLing an LPAR installation #
There are different ways to IPL SUSE Linux Enterprise Micro into an LPAR. The preferred way is to use the feature of the SE or HMC.
4.2.4.1.1 IPL from DVD-ROM #
Mark the LPAR to install and select
. Leave the field for the file location blank or enter the path to the root directory of the first DVD-ROM and select . Keep the default selection in the list of options that appears. should now show the kernel boot messages.4.2.4.1.2 IPL from FCP-attached SCSI DVD #
You can use the
procedure by selecting as to IPL from SCSI. Enter the WWPN (Worldwide port name) and LUN (Logical unit number) provided by your SCSI bridge or storage (16 digits—do not omit the trailing 0s). The boot program selector must be 2. Use your FCP adapter as and perform an IPL.4.2.4.2 IPLing a z/VM installation #
This section describes IPLing the installation system to install SUSE Linux Enterprise Micro for IBM Z on a z/VM system.
4.2.4.2.1 IPL from the z/VM reader #
You need a working TCP/IP connection and an FTP client program within your newly-defined z/VM guest to transfer the installation system via FTP. Setting up TCP/IP for z/VM is beyond the scope of this manual. Refer to the appropriate IBM documentation.
Log in as the z/VM Linux guest to IPL. Make the content of the directory
/boot/s390x
of the Unified Installer (medium 1) available via
FTP within your network. From this directory, get the files
linux
, initrd
,
parmfile
, and sles.exec
.
Transfer the files with a fixed block size of 80 characters. Specify it
with the FTP command locsite fix 80
. It is important to
copy linux
(the Linux kernel) and
initrd
(the installation image) as binary files, so
use the binary
transfer mode.
parmfile
and sles.exec
need to
be transferred in ASCII mode.
The following example shows the required steps. This particular scenario
assumes that the required files are accessible from an FTP server at the
IP address 192.168.0.3
and the login is
lininst
.
FTP 192.168.0.3 VM TCP/IP FTP Level 530 Connecting to 192.168.0.3, port 21 220 ftpserver FTP server (Version wu-2.4.2-academ[BETA-18](1) Thu Feb 11 16:09:02 GMT 2010) ready. USER lininst 331 Password required for lininst PASS ****** 230 User lininst logged in. Command: binary 200 Type set to I Command: locsite fix 80 Command: get /media/dvd1/boot/s390x/linux sles.linux 200 PORT Command successful 150 Opening BINARY mode data connection for /media/dvd1/boot/s390x/linux (10664192 bytes) 226 Transfer complete. 10664192 bytes transferred in 13.91 seconds. Transfer rate 766.70 Kbytes/sec. Command: get /media/dvd1/boot/s390x/initrd sles.initrd 200 PORT Command successful 150 Opening BINARY mode data connection for /media/dvd1/boot/s390x/initrd (21403276 bytes) 226 Transfer complete. 21403276 bytes transferred in 27.916 seconds. Transfer rate 766.70 Kbytes/sec. Command: ascii 200 Type set to A Command: get /media/dvd1/boot/s390x/parmfile sles.parmfile 150 Opening ASCII mode data connection for /media/dvd1/boot/s390x/parmfile (5 bytes) 226 Transfer complete. 5 bytes transferred in 0.092 seconds. Transfer rate 0.05 Kbytes/sec. Command: get /media/dvd1/boot/s390x/sles.exec sles.exec 150 Opening ASCII mode data connection for /media/dvd1/boot/s390x/sles.exec (891 bytes) 226 Transfer complete. 891 bytes transferred in 0.097 seconds. Transfer rate 0.89 Kbytes/sec. Command: quit
Use the REXX script sles.exec you downloaded to IPL the Linux installation system. This script loads the kernel, parmfile, and the initial RAM disk into the reader for IPL.
/* REXX LOAD EXEC FOR SUSE LINUX S/390 VM GUESTS */ /* LOADS SUSE LINUX S/390 FILES INTO READER */ SAY '' SAY 'LOADING SLES FILES INTO READER...' 'CP CLOSE RDR' 'PURGE RDR ALL' 'SPOOL PUNCH * RDR' 'PUNCH SLES LINUX A (NOH' 'PUNCH SLES PARMFILE A (NOH' 'PUNCH SLES INITRD A (NOH' 'IPL 00C'
Using the script, you can IPL the SUSE Linux Enterprise Micro installation system with
the command sles
. The Linux kernel then starts and
outputs its boot messages.
To continue the installation, proceed to Section 4.2.5, “Network configuration”.
4.2.4.2.2 IPL from FCP-attached SCSI DVD #
To IPL in z/VM, prepare the SCSI IPL process by using the SET LOADDEV parameter:
SET LOADDEV PORTNAME 200400E8 00D74E00 LUN 00020000 00000000 BOOT 2
After setting the LOADDEV parameter with the appropriate values, IPL your FCP adapter, for example:
IPL FC00
To continue the installation, proceed with Section 4.2.5, “Network configuration”.
4.2.4.2.3 IPL from a Cobbler server with zPXE #
To IPL from a Cobbler server with zPXE, you need to transfer the
zpxe.rexx
script via FTP from the Cobbler server to
your z/VM guest. To do this, the z/VM guest needs a working TCP/IP
connection and an FTP client program.
Log in as the z/VM Linux guest to IPL and transfer the script with a fixed
size of 80 characters in ASCII mode (see
Example 4.3, “Transferring the binaries via FTP” for an
example). The zpxe.rexx
script is available on the
Unified Installer DVD at /boot/s390x/zpxe.rexx
or on a SLE
Cobbler server at
/usr/share/doc/packages/s390-tools/zpxe.rexx
.
zpxe.rexx
is supposed to replace the
PROFILE EXEC
of your guest. Make a backup copy of the
existing PROFILE EXEC
and rename ZPXE
REXX
to PROFILE EXEC
. Alternatively, call
ZPXE REXX
from the existing PROFILE
EXEC
by adding the 'ZPXE REXX'
line to it.
The last step is to create a configuration file ZPXE
CONF
that instructs ZPXE REXX
which
Cobbler server to contact and which disk to IPL. Run xedit zpxe
conf a
and create ZPXE CONF
with the
following content (replace the example data accordingly):
HOST cobbler.example.com IPLDISK 600
This connects the Cobbler server next time you log in to the z/VM guest. If an installation is scheduled on the Cobbler server, it will be executed. To schedule the installation, run the following command on the Cobbler server:
>
sudo
cobbler system edit --name ID1 --netboot-enabled 12 --profile PROFILENAME3
z/VM user ID. | |
Enable IPLing from the network. | |
Name of an existing profile, see Section 4.2.1.3.3, “Adjusting the profile”. |
4.2.4.3 IPLing a KVM guest installation #
To start the guest installation, you first need to start the VM Guest defined in Section 4.2.3.3.1, “Create a virtual disk image”. Before you begin, ensure the kernel and initrd are available for IPL.
4.2.4.3.1 Preparing the installation source #
Kernel and initrd of the installation system need to be copied to the VM Host Server to IPL the VM Guest into the installation system.
Log in to the KVM host and make sure you can connect to the remote host or device serving the installation source.
Copy the following two files from the installation source to
/var/lib/libvirt/images/
. If the data is served from a remote host, useftp
,sftp
, orscp
to transfer the files:/boot/s390x/initrd
/boot/s390x/cd.ikr
Rename the files on the KVM host:
>
sudo
cd /var/lib/libvirt/images/>
sudo
mv initrd s15-initrd.boot>
sudo
mv cd.ikr s15-kernel.boot
4.2.4.3.2 IPL the VM Guest #
To IPL the VM Guest, log in to the KVM host and run the following command:
>
virsh create s15-1.xml --console
The installation process starts when the VM Guest is up and running, and you should see the following message:
Domain s15-1 started Connected to domain s15-1 Escape character is ^] Initializing cgroup subsys cpuset Initializing cgroup subsys cpu Initializing cgroup subsys cpuacct . . Please make sure your installation medium is available. Retry? 0) <-- Back <-- 1) Yes 2) No
Answer Section 4.2.5.3, “Set up the network and select the installation source”.
and choose on the next step. Proceed as described in4.2.5 Network configuration #
Wait until the kernel has completed its start-up routines. If you perform the installation in basic mode or in an LPAR, open the
on the HMC or SE.
First, choose linuxrc
main menu. Then choose to start the installation process. Select
as the installation medium, then select the type
of network protocol to use for the installation.
Section 4.2.1, “Making the installation data available” describes how to make the
installation data available for the various types of network connections.
Currently, , ,
, and (Windows file
sharing) are supported.
From the list of available devices, choose an OSA or HiperSockets network device for receiving the installation data. Although the list may contain CTC, ESCON, or IUCV devices, they are no longer supported on SUSE Linux Enterprise Micro.
4.2.5.1 Configure a HiperSockets interface #
Select a HiperSocket device from the list of network devices. Then enter values for the read, write, and data channels:
Choose the network device. 1) IBM parallel CTC Adapter (0.0.0600) 2) IBM parallel CTC Adapter (0.0.0601) 3) IBM parallel CTC Adapter (0.0.0602) 4) IBM Hipersocket (0.0.0800) 5) IBM Hipersocket (0.0.0801) 6) IBM Hipersocket (0.0.0802) 7) IBM OSA Express Network card (0.0.0700) 8) IBM OSA Express Network card (0.0.0701) 9) IBM OSA Express Network card (0.0.0702) 10) IBM OSA Express Network card (0.0.f400) 11) IBM OSA Express Network card (0.0.f401) 12) IBM OSA Express Network card (0.0.f402) 13) IBM IUCV > 4 Device address for read channel. (Enter '+++' to abort). [0.0.0800]> 0.0.0800 Device address for write channel. (Enter '+++' to abort). [0.0.0801]> 0.0.0801 Device address for data channel. (Enter '+++' to abort). [0.0.0802]> 0.0.0802
4.2.5.2 Configure an OSA express device #
Select an OSA Express device from the list of network devices and specify a port number. Enter the values for the read, write and data channels. Choose whether to enable OSI Layer 2 support.
The port number is required for the new 2 port OSA Express 3 Network
devices. If you are not using an OSA Express 3 device, enter
0
. OSA Express cards can also run in the “OSI
layer 2 support” mode or the older more common “layer
3” mode. The card mode affects all systems that share the device,
including systems on other LPARs. If in doubt, specify 2
for compatibility with the default mode used by other operating systems
such as z/VM and z/OS. Consult with your hardware administrator for further
information on these options.
Choose the network device. 1) IBM parallel CTC Adapter (0.0.0600) 2) IBM parallel CTC Adapter (0.0.0601) 3) IBM parallel CTC Adapter (0.0.0602) 4) IBM Hipersocket (0.0.0800) 5) IBM Hipersocket (0.0.0801) 6) IBM Hipersocket (0.0.0802) 7) IBM OSA Express Network card (0.0.0700) 8) IBM OSA Express Network card (0.0.0701) 9) IBM OSA Express Network card (0.0.0702) 10) IBM OSA Express Network card (0.0.f400) 11) IBM OSA Express Network card (0.0.f401) 12) IBM OSA Express Network card (0.0.f402) 13) IBM IUCV > 7 Enter the relative port number. (Enter '+++' to abort). > 0 Device address for read channel. (Enter '+++' to abort). [0.0.0700]> 0.0.0700 Device address for write channel. (Enter '+++' to abort). [0.0.0701]> 0.0.0701 Device address for data channel. (Enter '+++' to abort). [0.0.0702]> 0.0.0702 Enable OSI Layer 2 support? 0) <-- Back <-- 1) Yes 2) No > 1 MAC address. (Enter '+++' to abort). > +++
4.2.5.3 Set up the network and select the installation source #
After all network device parameters have been entered, the respective driver is installed and you see the corresponding kernel messages.
Next, you need to specify whether to use DHCP autoconfiguration for setting up the network interface parameters. Because DHCP only works on a few devices and requires special hardware configuration settings, choose
. Doing this prompts you to specify the following networking parameters:The IP address of the system to install
The corresponding netmask (if not having been specified with the IP address)
The IP address of a gateway to reach the server
A list of search domains covered by the domain name server (DNS)
The IP address of your domain name server
Automatic configuration via DHCP? 0) <-- Back <-- 1) Yes 2) No > 2 Enter your IP address with network prefix. You can enter more than one, separated by space, if necessary. Leave empty for autoconfig. Examples: 192.168.5.77/24 2001:db8:75:fff::3/64. (Enter '+++' to abort). > 192.168.0.20/24 Enter your name server IP address. You can enter more than one, separated by space, if necessary. Leave empty if you don't need one. Examples: 192.168.5.77 2001:db8:75:fff::3. (Enter '+++' to abort). > 192.168.0.1 Enter your search domains, separated by a space:. (Enter '+++' to abort). > example.com Enter the IP address of your name server. Leave empty if you do not need one. (En ter '+++' to abort). > 192.168.0.1
Finally, provide the required information about the installation server, such as the IP address, the directory containing the installation data, and login credentials. The installation system loads when the required information has been provided.
4.2.6 Connecting to the SUSE Linux Enterprise Micro installation system #
After loading the installation system, linuxrc prompts you to choose what
type of display to use to control the installation procedure. The available
options include Remote X11
(X Window System),
VNC
(Virtual Network Computing protocol),
SSH
(text mode or X11 installation via Secure Shell),
Text-based UI
and Graphical UI
. The
latter starts YaST in graphical mode on a local graphics display if it
exists. On the s390x architecture, a local graphics display can be
implemented using QEMU and the virtio-gpu
driver.
The recommended options are VNC
or SSH
.
If the Text-based UI
option is selected, YaST starts in
text mode, and you can perform the installation directly within your
terminal. The
Text-based UI
option is only useful when installing into LPAR.
To be able to work with YaST in the text mode, it needs to run in a
terminal with VT220/Linux emulation (also called Text-based UI
).
4.2.6.1 Initiating the installation for VNC #
To remotely control an installation via VNC, follow these steps:
Selecting the
VNC
option starts the VNC server. A short note in the console displays the IP address and display number for connecting with vncviewer.Enter the IP address and the display number of the SUSE Linux Enterprise Micro installation system when prompted to do so.
When prompted, enter the IP address and the display number of the SUSE Linux Enterprise Micro installation system.
http://<IP address of installation system>:5801/
After the connection has been established, install SUSE Linux Enterprise Micro with YaST.
4.2.6.2 Initiating the installation for the X Window system #
The direct installation with the X Window System relies on an authentication mechanism based on host names. This mechanism is disabled in current SUSE Linux Enterprise Micro versions. We recommend performing the installation using SSH or VNC.
To remotely control an installation via X forwarding, follow these steps:
Make sure that the X server allows the client (the system that is installed) to connect. Set the variable
DISPLAYMANAGER_XSERVER_TCP_PORT_6000_OPEN="yes"
in the file/etc/sysconfig/displaymanager
. Restart the X server and allow client binding to the server usingxhost CLIENT_IP_ADDRESS
.When prompted at the installation system, enter the IP address of the machine running the X server.
Wait until YaST opens, then start the installation.
4.2.6.3 Initiating the installation for SSH #
To connect to an installation system with the name
earth
via SSH, use the ssh -X
earth
command. If your workstation runs on Microsoft
Windows, use the Putty tool available from
https://www.chiark.greenend.org.uk/~sgtatham/putty/.
Set in Putty under › › .
If you use another operating system, execute ssh -X
earth
to connect to an installation system with the
name earth
. X-Forwarding over SSH is
supported if you have a local X server available. Otherwise, YaST
provides a text interface over ncurses.
When prompted, enter the root
user name and log in with
your password. Enter yast.ssh
to start YaST. YaST
then guides you through the installation.
In certain situations, running the GUI version of YaST over SSH with X forwarding may fail with the following error message:
XIO: fatal IO error 11 (Resource temporarily unavailable) on X server "localhost:11.0"
In this case you have two options.
Run YaST with the
QT_XCB_GL_INTEGRATION=none
option, for example:QT_XCB_GL_INTEGRATION=none yast.ssh QT_XCB_GL_INTEGRATION=none yast2 disk
Run the ncurses version of YaST application by disabling X forwarding or by specifying ncurses as the desired UI. To do the latter, use the
yast2 disk --ncurses
orYUI_PREFERED_BACKEND=ncurses yast2 disk
command.
Proceed with the installation procedure as described in Chapter 12, Installation steps.
4.2.7 The SUSE Linux Enterprise Micro boot procedure on IBM Z #
On SLES 10 and 11 the boot process was handled by the zipl boot loader. To enable booting from Btrfs partitions and supporting system rollbacks with Snapper, the way SUSE Linux Enterprise Micro is booted on IBM Z has changed.
GRUB 2 replaces zipl on SUSE Linux Enterprise Micro for IBM Z. GRUB 2 on the
AMD64/Intel 64 architecture includes device drivers on the firmware level
to access the file system. On the mainframe there is no firmware and adding
ccw
to GRUB 2 would not only be a major undertaking, but
would also require a reimplementation of zipl in GRUB 2. Therefore
SUSE Linux Enterprise Micro uses a two-stage approach:
- Stage one:
A separate partition containing the kernel and an initrd is mounted to
/boot/zipl
. This kernel and the initrd are loaded via zipl using the configuration from/boot/zipl/config
.This configuration adds the keyword
initgrub
to the kernel command line. When the kernel and initrd are loaded, the initrd activates the devices required to mount the root file system (see/boot/zipl/active_devices.txt
). Afterward a GRUB 2 user space program is started, which reads/boot/grub2/grub.cfg
.- Stage two:
The kernel and the initrd specified in
/boot/grub2/grub.cfg
are started viakexec
. Devices listed in/boot/zipl/active_devices.txt
that are necessary for starting the on-disk system are then activated. Other devices from that list will be whitelisted, but otherwise ignored. The root file system is mounted and the boot procedure continues like on the other architectures.
4.3 Secure boot #
For the secure boot functionality to work on a IBM Z system, the following conditions must be met.
The machine must be z15 T01, z15 T02, LinuxONE III LT1, LinuxONE III LT2, or a later model.
You must use an LPAR (secure boot is not supported on z/VM and KVM).
The LPAR must have secure boot enabled.
You must use SCSI (FCP) disks (secure boot is not supported on DASD).
In case you migrate to a different machine (for example, from z13 to z15), ensure that the LPAR on the target machine has the secure boot state of the system on its disk.
Changing the secure boot state must be performed according to the following procedure.
Enable secure boot in YaST and write the new boot loader.
Shut down the system.
Change the configuration of the LPAR (enable or disable secure boot).
Boot the system.
The system on the disk configured with the secure=1
parameter can be booted on z15 HMC as long as the firmware supports the new
on-disk format (which is always the case on z15).
4.4 The parmfile—automating the system configuration #
The installation process can be partially automated by specifying the
essential parameters in the parmfile
. The
parmfile
contains all the data required for network
setup and DASD configuration. In addition to that, it can be used to set up
the connection method to the SUSE Linux Enterprise Micro installation system and the
YaST instance running there. This reduces user interaction to the actual
YaST installation.
The parameters listed in Section 4.4.1, “General parameters” can be passed to the installation routine as the default values for installation. Note that all IP addresses, server names, and numerical values are examples. Replace them with the actual values of your installation scenario.
The number of lines in the parmfile is limited to 10. You can specify more
than one parameter on a line. Parameter names are not case-sensitive.
Parameters must be separated by spaces. You may specify the parameters in
any order. Always keep the PARAMETER=value
string
together on one line. The length of each line must not exceed 80 characters.
For example:
Hostname=s390zvm01.suse.de HostIP=10.11.134.65
By default, you can only assign IPv4 network addresses to your machine. To
enable IPv6 during installation, specify one of the following parameters at
the boot prompt: ipv6=1
(accept IPv4 and IPv6) or
ipv6only=1
(accept IPv6 only).
Some of the following parameters are required. If they are missing, the automatic process prompts you to specify them.
4.4.1 General parameters #
AutoYaST=
<URL>Manual=0
The
AutoYaST
parameter specifies the location of theautoinst.xml
control file for automatic installation. TheManual
parameter controls if the other parameters are only default values that still must be acknowledged by the user. Set this parameter to0
if all values should be accepted and no questions asked. SettingAutoYaST
defaultsManual
to0
.DeviceAutoConfig=<0|1|2>
In
linuxrc
, the DeviceAutoConfig parameter controls the use of I/O device auto-configuration data for IBM Z systems.If set to
0
, auto-configuration is disabled. If set to1
, the existing auto-config data are applied. If set to2
(the default), a dialog is shown if auto-config data are present. The user is asked whether to apply them.For more details, see Section 4.4.4, “I/O device auto-configuration on IBM Z systems”.
Info=
<URL>Specifies a location for a file with additional options. This helps to overcome the limitations of 10 lines (and 80 characters per line under z/VM) for the parmfile. Further documentation on the Info file can be found in Book “AutoYaST Guide”, Chapter 9 “The auto-installation process”, Section 9.3.3 “Combining the
linuxrc
info
file with the AutoYaST control file”. Since the Info file can typically only be accessed through the network on IBM Z, you cannot use it to specify the options required to set up the network (that is, the options described in Section 4.4.2, “Configuring the network interface”). Other linuxrc-specific options, such as those related to debugging, must be specified in the parmfile itself.Upgrade=<0|1>
To upgrade SUSE Linux Enterprise, specify
Upgrade=1
. A custom parmfile is required for upgrading an existing installation of SUSE Linux Enterprise. Without this parameter, the installation provides no upgrade option.
4.4.2 Configuring the network interface #
The settings described in this section apply only to the network interface used during installation.
Hostname=zsystems.example.com
Enter the fully qualified host name.
Domain=example.com
Domain search path for DNS. Allows you to use short host names instead of fully qualified ones.
HostIP=192.168.1.2/24
Enter the IP address of the interface to configure.
Gateway=192.168.1.3
Specify the gateway to use.
Nameserver=192.168.1.4
Specify the DNS server in charge.
InstNetDev=osa
Enter the type of interface to configure. Possible values are
osa
,hsi
,ctc
,escon
, andiucv
(CTC, ESCON, and IUCV are no longer supported).For the
ctc
interfacesescon
andiucv
(CTC, ESCON, and IUCV are no longer supported), enter the IP address of the peer:Pointopoint=192.168.55.20
OsaInterface=<lcs|qdio>
For
osa
network devices, specify the host interface (qdio
orlcs
).Layer2=<0|1>
For
osa
QDIO Ethernet andhsi
devices, specify whether to enable (1
) or disable (0
) OSI Layer 2 support.OSAHWAddr=02:00:65:00:01:09
For Layer 2-enabled
osa
QDIO Ethernet devices. Either specify a MAC address manually or stateOSAHWADDR=
(with trailing white space) for the system default.PortNo=<0|1>
For
osa
network devices, specify the port number (provided the device supports this feature). The default value is 0.
Each of the interfaces requires certain setup options:
Interfaces
ctc
andescon
(CTC and ESCON are no longer supported):ReadChannel=0.0.0600 WriteChannel=0.0.0601
ReadChannel
specifies the READ channel to use.WriteChannel
specifies the WRITE channel.For the
ctc
interface (no longer supported), specify the protocol that should be used for this interface:CTCProtocol=<0/1/2>
Valid entries would be:
0
Compatibility mode, also for non-Linux peers other than OS/390 and z/OS (this is the default mode)
1
Extended mode
2
Compatibility mode with OS/390 and z/OS
Network device type
osa
with interfacelcs
:ReadChannel=0.0.0124
ReadChannel
stands for the channel number used in this setup. A second port number can be derived from this by adding one toReadChannel
.Portnumber
is used to specify the relative port.Interface
iucv
:IUCVPeer=PEER
Enter the name of the peer machine.
Network device type
osa
with interfaceqdio
for OSA-Express Gigabit Ethernet:ReadChannel=0.0.0700 WriteChannel=0.0.0701 DataChannel=0.0.0702
For
ReadChannel
, enter the number of the READ channel. ForWriteChannel
, enter the number of the WRITE channel.DataChannel
specifies the DATA channel. Make sure that the READ channel has an even device number.Interface
hsi
for HiperSockets and VM guest LANs:ReadChannel=0.0.0800 WriteChannel=0.0.0801 DataChannel=0.0.0802
For
ReadChannel
, enter the appropriate number for the READ channel. ForWriteChannel
andDataChannel
, enter the WRITE and DATA channel numbers.
4.4.3 Specifying the installation source and YaST interface #
Install=nfs://server/directory/DVD1/
Specify the location of the installation source to use. Supported protocols are
nfs
,smb
(Samba/CIFS),ftp
,tftp
http
, andhttps
.If an
ftp
,tftp
orsmb
URL is provided, specify the user name and password. Skip credentials for anonymous or guest login.Install=ftp://USER:PASSWORD@SERVER/DIRECTORY/DVD1/ Install=tftp://USER:PASSWORD@SERVER/DIRECTORY/DVD1/
If you want to perform the installation over an encrypted connection, use an
https
URL. If the certificate cannot be verified, use thesslcerts=0
boot option to disable certificate checking.In case of a Samba or CIFS installation, you can also specify the domain:
Install=smb://WORKDOMAIN;USER:PASSWORD@SERVER/DIRECTORY/DVD1/
ssh=1
vnc=1
Display_IP=192.168.42.42
The installation method depends on which parameter you specify.
ssh
enables SSH installation,vnc
starts a VNC server on the installing machine, andDisplay_IP
causes the installing system to try to connect to an X server at the specified address. Only one of these parameters should be set.Important: X authentication mechanismThe direct installation with the X Window System relies on an authentication mechanism based on host names. This mechanism is disabled on current SUSE Linux Enterprise Micro versions. We recommend to perform an installation using SSH or VNC is preferred.
To allow a connection between YaST and the remote X server, run
xhost
<IP address>
with the address of the installing machine on the remote machine.For
VNC
, specify a password of six to eight characters to use for installation:VNCPassword=<a password>
For
SSH
, specify a password of six to eight characters to use for installation:ssh.password=<a password>
4.4.4 I/O device auto-configuration on IBM Z systems #
I/O device auto-configuration is a mechanism that allows users to specify IDs and settings of I/O devices that should be automatically enabled in Linux. This information is specified for an LPAR via an HMC running in DPM (Dynamic Partition Manager) mode.
The I/O device auto-configuration functionality is available on systems with the DPM running. DPM runs by default on LinuxONE machines. For IBM Z, this functionality must be ordered.
In linuxrc
, the DeviceAutoConfig parameter
controls the use of I/O device auto-configuration data for IBM Z systems.
- DeviceAutoConfig=0
If set to
0
, auto-configuration is disabled.- DeviceAutoConfig=1
If set to
1
, existing auto-config data are applied.- DeviceAutoConfig=2 (default)
If set to
2
(the default), a dialog is shown if auto-config data are present. The user is asked whether to apply them.
If device auto-config is disabled by the user, the kernel parameter rd.zdev=no-auto is added to the boot options of the target system.
To enable I/O auto-configuration using YaST, run the yast2
system_settings
command, switch to the section, and enable the option.
To disable I/O auto-configuration in an AutoYaST profile, add the following
kernel parameter in the append
section of the
global boot loader options. For example:
<bootloader> <global> <append>rd.zdev=no-auto</append> </global> </bootloader>
For more context on the AutoYaST boot loader options, see Book “AutoYaST Guide”, Chapter 4 “Configuration and installation options”, Section 4.4 “The boot loader”.
During installation, the status of the auto-configuration setting is displayed in the
section of the screen.4.4.5 Example parmfiles #
The maximum capacity of a parmfile is 860 characters. As a rule of thumb, the parmfile should contain a maximum of 10 lines with no more than 79 characters. When reading a parmfile, all lines are concatenated without adding white spaces, therefore the last character (79) of each line needs to be a Space.
To receive potential error messages on the console, use
linuxrclog=/dev/console
ramdisk_size=131072 root=/dev/ram1 ro init=/linuxrc TERM=dumb instnetdev=osa osainterface=qdio layer2=1 osahwaddr= pointopoint=192.168.0.1 hostip=192.168.0.2 nameserver=192.168.0.3 DeviceAutoConfig=1 install=nfs://192.168.0.4/SLES/SLES-12-Server/s390x/DVD1 autoyast=http://192.168.0.5/autoinst.xml linuxrclog=/dev/console vnc=1 VNCPassword=testing
ramdisk_size=131072 root=/dev/ram1 ro init=/linuxrc TERM=dumb AutoYast=nfs://192.168.1.1/autoinst/s390.xml Hostname=zsystems.example.com HostIP=192.168.1.2 Gateway=192.168.1.3 Nameserver=192.168.1.4 InstNetDev=hsi layer2=0 Netmask=255.255.255.128 Broadcast=192.168.1.255 readchannel=0.0.702c writechannel=0.0.702d datachannel=0.0.702e install=nfs://192.168.1.5/SLES-12-Server/s390x/DVD1/ ssh=1 ssh.password=testing linuxrclog=/dev/console
ro ramdisk_size=50000 MANUAL=0 PORTNO=1 ReadChannel=0.0.b140 WriteChannel=0.0.b141 DataChannel=0.0.b142 cio_ignore=all,!condev,!0.0.b140-0.0.b142,!0.0.e92c,!0.0.5000,!0.0.5040 HostIP= Gateway= Hostname=zsystems.example.com nameserver=192.168.0.1 Install=ftp://user:password@10.0.0.1/s390x/SLES15.0/INST/ usevnc=1 vncpassword=12345 InstNetDev=osa Layer2=1 OSAInterface=qdio ssl_certs=0 osahwaddr= domain=example.com self_update=0 vlanid=201
4.5 Using the vt220 terminal emulator #
Recent MicroCode Levels allow the use of an integrated vt220 terminal
emulator (ASCII terminal) in addition to the standard line mode terminal.
The vt220 terminal is connected to /dev/ttysclp0
. The
line mode terminal is connected to /dev/ttysclp_line0
.
For LPAR installations, the vt220 terminal emulator is activated by default.
To start the Text-based UI on HMC, log in to the HMC, and select
› › . Select the radio button for the LPAR and select › .
To redirect the kernel messages at boot time from the system console to the
vt220 terminal, add the following entries to the
parameters
line in /etc/zipl.conf
:
console=ttysclp0 console=ttysclp_line0
The resulting parameters
line would look like the
following example:
parameters = "root=/dev/dasda2 TERM=dumb console=ttysclp0 console=ttysclp_line0"
Save the changes in /etc/zipl.conf
, run
zipl
, and reboot the system.
4.6 More information #
Find further technical documentation about IBM Z in the IBM Redbooks (https://www.redbooks.ibm.com/Redbooks.nsf/domains/zsystems) or at IBM developerWorks (https://developer.ibm.com/). SUSE Linux Enterprise Micro-specific documentation is available from https://developer.ibm.com/technologies/linux/.
4.6.1 General documents about Linux on IBM Z #
A general coverage of Linux on IBM Z can be found in the following documents:
Linux on IBM eServer zSeries and S/390: ISP and ASP Solutions (SG24-6299)
These documents might not reflect the current state of Linux, but the principles of Linux deployment outlined there remain accurate.
4.6.2 Technical issues of Linux on IBM Z #
Refer to the following documents for technical information about the Linux kernel and application topics. For the most recent versions of the documents, visit (https://developer.ibm.com/technologies/linux/).
Linux on System z Device Drivers, Features, and Commands
zSeries ELF Application Binary Interface Supplement
Linux on System z Device Drivers, Using the Dump Tools
IBM zEnterprise 196 Technical Guide
IBM zEnterprise EC12 Technical Guide
IBM z13 Technical Guide
IBM z14 Technical Guide
IBM z15 Technical Guide
A Redbook for Linux application development is available at https://www.redbooks.ibm.com:
Linux on IBM eServer zSeries and S/390: Application Development (SG24-6807)
4.6.3 Advanced configurations for Linux on IBM Z #
Refer to the following Redbooks, Redpapers, and online resources for more complex IBM Z scenarios:
Linux on IBM eServer zSeries and S/390: Large Scale Deployment (SG24-6824)
Linux on IBM eServer zSeries and S/390: Performance Measuring and Tuning (SG24-6926)
Linux with zSeries and ESS: Essentials (SG24-7025)
IBM TotalStorage Enterprise Storage Server Implementing ESS Copy Services with IBM eServer zSeries (SG24-5680)
Linux on IBM zSeries and S/390: High Availability for z/VM and Linux (REDP-0220)
Saved Segments Planning and Administration
Linux on System z documentation for "Development stream"
Introducing IBM Secure Execution for Linux, Securing the guest
Part II Pre-built image deployment #
- 5 Description of pre-built images
SLE Micro can be deployed using pre-built images. Currently, there are two types of images available: raw disk images and selfinstall ISOs.
- 6 Overview of the deployment process
SUSE Linux Enterprise Micro provides pre-built images (raw and selfinstall ISOs) that can be directly deployed to your device storage: a memory card, a USB flash drive or a hard disk. The options for which type of device you can deploy the image to depend on your particular hardware—follow the guida…
- 7 Preparing the configuration device
The following procedure describes how to prepare the configuration device (usually a USB flash disk). Ensure that the configuration device is connected to your host running SLE Micro during its first boot.
- 8 Deploying the raw image
During the deployment of the raw image, the image of the system is just copied to the selected disk. Therefore, an EFI boot entry is not created (like it normally would if the system is deployed using an installer). You might need to manually boot your system using the EFI shell by selecting the SLE…
- 9 Deploying selfinstall images
The chapter describes deployment of SLE Micro from selfinstall pre-built ISO images.
- 10 Post-deployment steps
The chapter describes registration of SLE Micro and covers extensions available for SLE Micro.
5 Description of pre-built images #
SLE Micro can be deployed using pre-built images. Currently, there are two types of images available: raw disk images and selfinstall ISOs.
SLE Micro raw images are delivered for the AMD64/Intel 64 architecture, IBM Z ZSeries and also AArch64. The selfinstall images are currently delivered only for the AMD64/Intel 64 architecture. The pre-built images are intended to be configured on the first boot by using either Ignition or Combustion. The boot loader detects the first boot; for more information see Section 5.1, “First boot detection”. Each image has default mounted subvolumes as described in Section 7.1, “Default partitioning”. The procedure of deploying these images is described in Chapter 8, Deploying the raw image.
On the pre-built images, firewall is disabled by default, as running it along with Podman may result in missing Podman-related firewall
rules after reloading the firewalld
service. Therefore,
it is recommended to keep the firewall disabled if you intend to use Podman.
SLE Micro can run as a KVM host server—Xen is not supported. However, there are several limitations of SLE Micro running as a VM Host Server; for details refer to virtualization limits and support.
5.1 First boot detection #
The configuration runs on the first boot only. To distinguish between the
first and subsequent boots, the flag file
/boot/writable/firstboot_happened
is created
after the first boot took place. If the file is not present in the file
system, the attribute ignition.firstboot
is passed to the
kernel command line, and thus both Ignition and Combustion are
triggered to run (in the initramfs
).
After completing the first boot, the
/boot/writable/firstboot_happened
flag file is created.
Even though the configuration may not be successful, due to improper or
missing configuration files, the
/boot/writable/firstboot_happened
flag file is
created.
You may force the first boot configuration on subsequent boot by passing
the ignition.firstboot
attribute to the kernel command
line or by deleting the
/boot/writable/firstboot_happened
flag file.
6 Overview of the deployment process #
SUSE Linux Enterprise Micro provides pre-built images (raw and selfinstall ISOs) that can be directly deployed to your device storage: a memory card, a USB flash drive or a hard disk. The options for which type of device you can deploy the image to depend on your particular hardware—follow the guidance in your vendor documentation.
To prepare the setup, you need the following:
a disk (either a physical or a virtual) where SLE Micro will run
in case of a selfinstall ISO image—a bootable device with the selfinstall ISO (for example, a flash drive)
(optionally) a device that serves as a configuration medium. You can perform basic configuration even without the configuration medium
The deployment process of SLE Micro pre-built images can be summarized in three stages:
- Preparing a configuration device
If you need a more complex configuration other than setting time,
root
password and language, you have to prepare a configuration device as described in Chapter 7, Preparing the configuration device.Bear in mind that, if used, the configuration device must be plugged in throughout the whole configuration process on the first boot. It is recommended to plug in the device before starting the installation process. However, if your firmware does not support having two or more USB disks attached on boot, you can exchange the USB device before starting the configuration process.
- Deploying the pre-built image
After downloading the image, you can boot your machine with either the configuration device attached or using JeOS Firstboot to perform basic configuration.
- Post-deployment procedures
After you deploy the image, register it or activate extensions.
7 Preparing the configuration device #
The following procedure describes how to prepare the configuration device (usually a USB flash disk). Ensure that the configuration device is connected to your host running SLE Micro during its first boot.
Format the disk to any file system supported by SLE Micro: Ext3, Ext4, etc.:
>
sudo mkfs.ext4 /dev/sdYSet the device label to either
ignition
(when either Ignition or Combustion is used) orcombustion
(when only Combustion is used). If needed, you can use uppercase letters for the labels, too. To label the device, run:>
sudo e2label /dev/sdY ignitionYou can use any type of configuration storage media that your virtualization system or your hardware supports: ISO image, a USB flash disk, etc.
Mount the device:
>
sudo mount /dev/sdY /mntCreate the directory structure as mentioned in Section 7.2, “Configuring SLE Micro using Ignition” or Section 7.3, “Configuring SLE Micro using Combustion”, depending on the configuration tool used:
>
sudo mkdir -p /mnt/ignition/or:
>
sudo mkdir -p /mnt/combustion/Prior to booting for the first time, prepare all elements of the configuration that will be used by Ignition or Combustion. To log in to your system, you need to provide a password for
root
or set up passwordless authentication, otherwise the system will not be accessible after the first boot.
7.1 Default partitioning #
The pre-built images are delivered with a default partitioning scheme, which
can be changed during the first boot by using Ignition or Combustion. For a
procedure to repartition the system, refer to
Section 7.2.1, “config.ign
” or
Section 7.3.1, “The script
configuration file”.
If you intend to perform any changes to the default partitioning scheme, the root file system must be Btrfs.
Each image has the following subvolumes:
/home /root /opt /srv /usr/local /var
The images also have mounted subvolumes for booting by default. The specific subvolumes differ according to the architecture.
The /etc
directory is mounted as OverlayFS, where the
upper directory is mounted to /var/lib/overlay/1/etc/
. For details, refer to Book “Administration Guide”, Chapter 1 “Read-only file system”, Section 1.1 “/etc
on a read-only file system”.
You can recognize the subvolumes mounted by default by the option
x-initrd.mount
in /etc/fstab
. Other
subvolumes or partitions must be configured either by Ignition or
Combustion.
7.2 Configuring SLE Micro using Ignition #
Ignition is a provisioning tool that enables you to configure a system
according to your specification on the first boot. When the system is
booted for the first time, Ignition is loaded as part of an
initramfs
and searches for a configuration file
within a specific directory (on a USB flash drive, or you can provide a
URL). All changes are performed before the kernel switches from the
temporal file system to the real root file system (before the
switch_root
command is issued).
Ignition uses a configuration file in the JSON format. The file is called
config.ign
.
7.2.1 config.ign
#
config.ign
is a JSON configuration file that
provides prescriptions for Ignition. You can either create the file
manually in JSON, or you can use the Fuel Ignition tool
(https://opensuse.github.io/fuel-ignition/) to
generate a basic set of prescriptions. Bear in mind that the Fuel
Ignition tool does not provide a full set of options, so you might have
to modify the file manually.
When installing on bare metal, the configuration file
config.ign
must reside in the
ignition
subdirectory on the configuration media
labeled ignition
. The directory structure must look as
follows:
<root directory> └── ignition └── config.ign
If you intend to configure a QEMU/KVM virtual machine, provide the path
to config.ign
as an attribute of the
qemu
command. For example:
-fw_cfg name=opt/com.coreos/config,file=PATH_TO_config.ign
When configuring a virtual machine with Virtual Machine Manager (libvirt
),
provide the path to the config.ign
file in its XML
definition, for example:
<domain ... > <sysinfo type="fwcfg"> <entry name="opt/com.coreos/config" file="/location/to/config.ign"/> </sysinfo> </domain>
Alternatively, when using libvirt
, you can provide the path as an option to the virt-install
command:
--sysinfo type=fwcfg,entry0.name="opt/com.coreos/config",entry0.file="PATH_TO_config.ign>"
The config.ign
file contains various data types: objects,
strings, integers, Booleans and lists of objects. For a complete
specification, refer to
Ignition
specification v3.3.0.
The version
attribute is mandatory, and with
SLE Micro, its value must be set either to 3.3.0
or to
any lower version. Otherwise Ignition will fail.
To log in to your system as root, you must at least include a
password for root
. However, it is recommended to establish access
via SSH keys. If you want to configure a password, make sure to use a
secure one. If you use a randomly generated password, use at least 10
characters. If you create your password manually, use even more than 10
characters and combine uppercase and lowercase letters and numbers.
7.2.1.1 Configuration examples #
This section will provide you with some common examples of the Ignition configuration in the JSON format.
Bear in mind that if you want to create files outside the
default mounted directories,
you need to define the directories using the
filesystem
attribute.
version
attribute is mandatory
Include the version specification in config.ign
(version 3.3.0 or lower).
7.2.1.1.1 Storage configuration #
The storage
attribute is used to configure
partitions and RAID, define file systems, create files, etc. To define
partitions, use the disks
attribute. The
filesystem
attribute is used to format partitions. The
files
attribute can be used to create files in the
file system. Each of the mentioned attributes is described in the
following sections.
7.2.1.1.1.1 The disks
attribute #
The disks
attribute is a list of devices that
enables you to define partitions on these devices. The
disks
attribute must contain at least one
device
. Other attributes are optional. The
following example will use a single virtual device and divide the
disk into four partitions:
{ "variant": "fcos", "version": "3.3.0", "storage": { "disks": [ { "device": "/dev/vda", "wipe_table": true, "partitions": [ { "label": "root", "number": 1, "type_guid": "4F68BCE3-E8CD-4DB1-96E7-FBCAF984B709" }, { "label": "boot", "number": 2, "type_guid": "BC13C2FF-59E6-4262-A352-B275FD6F7172" }, { "label": "swap", "number": 3, "type_guid": "0657FD6D-A4AB-43C4-84E5-0933C84B4F4F" }, { "label": "home", "number": 4, "type_guid": "933AC7E1-2EB4-4F13-B844-0E14E2AEF915" } ] } ] } }
7.2.1.1.1.2 The raid
attribute #
The raid
is a list of RAID arrays. The following
attributes of raid
are mandatory:
- level
a level of the particular RAID array (linear, raid0, raid1, raid2, raid3, raid4, raid5, raid6)
- devices
a list of devices in the array referenced by their absolute paths
- name
a name that will be used for the md device
{ "variant": "fcos", "version": "3.3.0", "storage": { "raid": [ { "name": "system", "level": "raid1", "devices": [ "/dev/sda", "/dev/sdb" ] } ] } }
7.2.1.1.1.3 The filesystem
attribute #
The file system
attribute does not modify mount units. If you add a new partition or remove an
existing partition, you must manually adjust the mount units.
filesystem
must contain the following
attributes:
- device
the absolute path to the device, typically
/dev/sda
in case of physical disk- format
the file system format (btrfs, ext4, xfs, vfat or swap)
NoteIn the case of SLE Micro, the
root
file system must be formatted to Btrfs.
The following example demonstrates using the
filesystem
attribute. The
/opt
directory will be mounted to the
/dev/sda1
partition, which is formatted to
Btrfs. The partition table will not be erased.
{ "variant": "fcos", "version": "3.3.0", "storage": { "filesystems": [ { "path": "/opt", "device": "/dev/sda1", "format": "btrfs", "wipe_filesystem": false } ] } }
7.2.1.1.1.4 The files
attribute #
You can use the files
attribute to create any
files on your machine. Bear in mind that if you want to create
files outside the
default mounted directories,
you need to define the directories by using the
filesystem
attribute.
In the following example, a host name is created by using the
files
attribute. The file
/etc/hostname
will be created with the
slemicro-1 host name.
Bear in mind that JSON uses the decimal numeral system, so the
mode
value is a decimal notation of the access
rights.
{ "variant": "fcos", "version": "3.3.0", "storage": { "files": [ { "path": "/etc/hostname", "mode": 420, "overwrite": true, "contents": { "inline": "slemicro-1" } } ] } }
7.2.1.1.1.5 The directories
attribute #
The directories
attribute is a list of
directories that will be created in the file system. The
directories
attribute must contain at least one
path
attribute.
{ "variant": "fcos", "version": "3.3.0", "storage": { "directories": [ { "path": "/mnt/backup", "user": { "name": "tux" } } ] } }
7.2.1.1.2 Users administration #
The passwd
attribute is used to add users. If you
intend to log in to your system, create root
and set the
root
's password and/or add the SSH key to the Ignition
configuration. You need to hash the root
password, for example,
by using the openssl
command:
openssl passwd -6
The command creates a hash of the password you chose. Use this hash
as the value of the password_hash
attribute.
The users
attribute must contain at least one
name
attribute.
ssh_authorized_keys
is a list of SSH keys for the
user.
root
When you are creating other users than root
, you need to
define /home
directories for the users,
because these directories (usually
/home/USER_NAME
)
are not mounted by default. Therefore, declare these directories
using the storage
/filesystem
attribute. For example, for tux, the example
looks as follows:
{ "ignition": { "version": "3.2.0" }, "passwd": { "users": [ { "name": "tux", "passwordHash": "$2a$10$US9XSqLOqMmGq/OnhlVjPOwuZREh2.iEtlwD5LI7DKgV24NJU.wO6" } ] }, "storage": { "filesystems": [ { "device": "/dev/disk/by-label/ROOT", "format": "btrfs", "mountOptions": [ "subvol=/@/home" ], "path": "/home", "wipeFilesystem": false } ] } }
7.2.1.1.3 Enabling systemd
services #
You can enable systemd
services by specifying them in the
systemd
attribute. The name
must be the exact name of a service to be enabled (including the
suffix).
{ "ignition": { "version": "3.0.0" }, "systemd": { "units": [ { "enabled": true, "name": "sshd.service" } ] } }
7.3 Configuring SLE Micro using Combustion #
Combustion is a dracut module that enables you to configure your system on
its first boot. Combustion reads a provided file called
script
and executes commands in it and thus performs
changes to the file system. You can use Combustion to change the default
partitions, set users' passwords, create files, install packages, etc.
The Combustion dracut module is invoked after the
ignition.firstboot
argument is passed to the kernel
command line. Combustion then reads the configuration from
script
. Combustion tries to configure the network if the
network flag has been found in script
. After
/sysroot
is mounted, Combustion tries to activate all
mount points in /etc/fstab
and then call
transactional-update
to apply other changes (like setting
root
password or installing packages).
When using Combustion, you need to label the configuration device with the
name combustion
, create a specific directory structure in
that configuration medium, and include a configuration file named
script
. In the root directory of the configuration
medium, create a directory called combustion
and place
the script
into this directory along with other
files—SSH key, configuration files, etc. The directory structure then
should look as follows:
<root directory> └── combustion └── script └── other files
You can use Combustion to configure your QEMU/KVM virtual machine. In this
case, pass the location of the script
file using the
fw_cfg
parameter of the qemu
command:
-fw_cfg name=opt/org.opensuse.combustion/script,file=/var/combustion-script
When configuring a virtual machine with Virtual Machine Manager (libvirt
),
provide the path to the script
file in its XML
definition, for example:
<domain ... > <sysinfo type="fwcfg"> <entry name="opt/org.opensuse.combustion/script" file="/location/of/script"/> </sysinfo> </domain>
Alternatively, when using libvirt
, you can provide the path as an option to the virt-install
command:
--sysinfo type=fwcfg,entry0.name="opt/org.opensuse.combustion/script",entry0.file="PATH_TO_script>"
Combustion can be used along with Ignition. If you intend to do so, label
your configuration medium ignition
and include the
ignition
directory with the
config.ign
to your directory structure, as shown below:
<root directory> └── combustion └── script └── other files └── ignition └── config.ign
In this scenario, Ignition runs before Combustion.
7.3.1 The script
configuration file #
The script
configuration file is a set of commands that
are executed on your system in a transactional-update shell. This section
provides examples for performing various configuration tasks by using
Combustion.
As the script
file is interpreted by shell,
start the file with the interpreter declaration on the first line.
For example, for Bash:
#!/bin/bash
To log in to your system, include at least the root
password. However, it is recommended to establish the authentication using SSH
keys. If you need to use a root
password, make sure to configure a
secure password. If you use a randomly generated password, use at least
10 characters. If you create your password manually, use even more than 10
characters and combine uppercase and lowercase letters, and numbers.
7.3.1.1 Network configuration #
To configure and use the network connection during the first boot, add the
following statement to your script
:
# combustion: network
Using this statement will pass the rd.neednet=1
argument
to dracut. If you do not use the statement, the system will be configured
without any network connection.
7.3.1.2 Performing modifications in the initramfs #
You may need to perform changes to the initramfs environment, for
example, to write a custom network configuration for NetworkManager into
/etc/NetworkManager/system-connections/
. To do so,
use the prepare
statement.
For example, to create a connection with a static IP address and configure DNS:
#!/bin/bash # combustion: network prepare set -euxo pipefail nm_config() { umask 077 # Required for NM config mkdir -p /etc/NetworkManager/system-connections/ cat >/etc/NetworkManager/system-connections/static.nmconnection <<-EOF [connection] id=static type=ethernet autoconnect=true [ipv4] method=manual dns=192.168.100.1 address1=192.168.100.42/24,192.168.100.1 EOF } if [ "${1-}" = "--prepare" ]; then nm_config # Configure NM in the initrd exit 0 fi # Redirect output to the console exec > >(exec tee -a /dev/tty0) 2>&1 nm_config # Configure NM in the system curl example.com # Close outputs and wait for tee to finish exec 1>&- 2>&-; wait; # Leave a marker echo "Configured with combustion" > /etc/issue.d/combustion
7.3.1.3 Waiting for the task to complete #
Some processes may be run in background, for example, the tee
process
that redirects output to the terminal. To ensure that all running processes are completed before the
script
execution finishes, add the following line:
exec 1>&- 2>&-; wait;
7.3.1.4 Partitioning #
SLE Micro raw images are delivered with a default partitioning scheme as
described in Section 7.1, “Default partitioning”. You might want to
use a different partitioning. The following set of example snippets moves the
/home
to a different partition.
The following script performs changes that are not included in snapshots.
If the script fails and the snapshot is discarded, some changes remain
visible and cannot be reverted (like the changes to the
/dev/vdb
device.)
The following snippet creates a GPT with a single partition on the
/dev/vdb
device:
sfdisk /dev/vdb <<EOF label: gpt type=linux EOF partition=/dev/vdb1
As the sfdisk
command may take longer time to complete, postpone
label
by using the
sleep
command after sfdisk
.
The partition is formatted to Btrfs:
wipefs --all ${partition} mkfs.btrfs ${partition}
Possible content of /home
is moved to the new
/home
folder location by the following snippet:
mount /home mount ${partition} /mnt rsync -aAXP /home/ /mnt/ umount /home /mnt
The snippet below removes an old entry in /etc/fstab
and creates a new entry:
awk -i inplace '$2 != "/home"' /etc/fstab echo "$(blkid -o export ${partition} | grep ^UUID=) /home btrfs defaults 0 0" >>/etc/fstab
7.3.1.5 Setting a password for root
#
Before you set the root
password, generate a hash of the password,
for example, by using the openssl passwd -6
. To set the
password, add the following to your script
:
echo 'root:$5$.wn2BZHlEJ5R3B1C$TAHEchlU.h2tvfOpOki54NaHpGYKwdNhjaBuSpDotD7' | chpasswd -e
7.3.1.6 Adding SSH keys #
The following snippet creates a directory to store the root
's SSH key
and then copies the public SSH key located on the configuration device to
the authorized_keys
file.
mkdir -pm700 /root/.ssh/ cat id_rsa_new.pub >> /root/.ssh/authorized_keys
The SSH service must be enabled in case you need to use remote login via SSH. For details, refer to Section 7.3.1.7, “Enabling services”.
7.3.1.7 Enabling services #
You may need to enable some services, for example, the SSH service. To
enable the SSH service, add the following line to
script
:
systemctl enable sshd.service
7.3.1.8 Installing packages #
As some packages may require additional subscription, you might need to register your system beforehand. An available network connection may also be needed to install additional packages.
During the first boot configuration, you can install additional packages to
your system. For example, you can install the vim
editor
by adding:
zypper --non-interactive install vim-small
Bear in mind that you cannot use zypper
after the configuration is complete and you boot to the configured system.
To perform changes later, you must use the
transactional-update
command to create a changed
snapshot. For details, refer to Book “Administration Guide”, Chapter 3 “Administration using transactional updates”.
7.4 Preparing the raw image #
To prepare the raw image, proceed as follows:
Download the raw image and decompress it:
>
xz -d DOWNLOADED_IMAGE.raw.xzCopy the decompressed image to the device where SLE Micro will run:
>
dd if=DOWNLOADED_IMAGE.raw of=/dev/sdX
7.5 Minimal initial configuration #
If you do not attach any configuration device when booting the raw image for the first time, jeos-firstboot enables you to perform minimal configuration of your system as follows:
8 Deploying the raw image #
During the deployment of the raw image, the image of the system is
just copied to the selected disk. Therefore, an EFI boot entry is not
created (like it normally would if the system is deployed using an
installer). You might need to manually boot your system using the EFI
shell by selecting the SLE Micro boot loader. After the first boot, you can
use efibootmgr
to create the boot entry.
efibootmgr
is available by default in the deployed
image.
To deploy the raw image to your machine, proceed as follows:
Download the raw image and decompress it:
>
xz -d DOWNLOADED_IMAGE.raw.xzCopy the decompressed image to the device where SLE Micro will run:
>
dd if=DOWNLOADED_IMAGE.raw of=/dev/sdXIf needed, plug in the configuration devices you prepared in Chapter 7, Preparing the configuration device.
Boot the machine.
Without the configuration device, JeOS Firstboot prompts you to configure the system as follows:
Confirm the configuration.
Select your keyboard layout and confirm your selection.
Read the license agreement and accept it.
Select your time zone.
Enter a password for
root
.Confirm the
root
password.Accept the statement about SLE Micro registration.
You can log in to your system and perform additional steps as described in Chapter 10, Post-deployment steps.
9 Deploying selfinstall images #
The chapter describes deployment of SLE Micro from selfinstall pre-built ISO images.
During the deployment of the selfinstall ISO, the image of the system is
just copied to the selected disk. Therefore, an EFI boot entry is not
created (like it normally would if the system is deployed using an
installer). You might need to manually boot your system using the EFI
shell by selecting the SLE Micro boot loader. After the first boot, you can
use efibootmgr
to create the boot entry.
efibootmgr
is available by default in the deployed
image.
When deploying SLE Micro using the pre-built selfinstall ISO, proceed as follows:
If needed, plug in the configuration device.
Boot your machine with the selfinstall ISO attached.
Select
to start the installation process.Select the disk where SLE Micro will be installed and confirm that you want to delete data on the disk. A SLE Micro image is then copied to the disk.
Using
kexec
, your system reboots and is then prepared for the configuration process.Start the configuration process by selecting jeos-firstboot is started.
. SLE Micro is either configured according to the instructions provided on the configuration device, or(Optional) Configure your system with jeos-firstboot:
Confirm the configuration.
Select your keyboard layout and confirm your selection.
Read the license agreement and accept it.
Select your time zone.
Enter a password for
root
.Confirm the
root
password.Accept the statement about SLE Micro registration.
After the first boot, you can register your SLE Micro instance by using the
transactional-update
command. For details, refer to Section 10.1, “Registration”.SLE Micro has extensions available. To use some of these extensions, you need to add the extension to your subscription from the installed system. For details, refer to Section 10.2, “Managing extensions”.
10 Post-deployment steps #
The chapter describes registration of SLE Micro and covers extensions available for SLE Micro.
10.1 Registration #
Registering the system is possible from the command line using the
transactional-update register
command. For information
that goes beyond the scope of this section, refer to the inline
documentation with SUSEConnect --help
To register SUSE Linux Enterprise Micro with SUSE Customer Center, run
transactional-update register
as follows:#
transactional-update register -r REGISTRATION_CODE -e EMAIL_ADDRESSTo register with a local registration server, additionally provide the URL to the server:
#
transactional-update register -r REGISTRATION_CODE -e EMAIL_ADDRESS \ --url "https://suse_register.example.com/"Replace REGISTRATION_CODE with the registration code you received with your copy of SUSE Linux Enterprise Micro. Replace EMAIL_ADDRESS with the e-mail address associated with the SUSE account you or your organization uses to manage subscriptions.
Reboot your system to switch to the latest snapshot.
SUSE Linux Enterprise Micro is now registered.
10.2 Managing extensions #
SLE Micro supports the following extensions:
SUSE Linux Enterprise Live Patching
The extension is available only for the x86 (except for the real-time kernel) and IBM Z architectures. Bear in mind that the extension might require an additional subscription.
Package Hub
A free module that provides access to community-maintained packages. Packages in the Package Hub are approved by SUSE for use on SUSE Linux Enterprise Server, thus the packages might not be installable on SLE Micro.
As the extension activation or deactivation is performed as a
transactional-update
command and thus creates a new snapshot, you need to restart
your system to boot to the new snapshot and apply the changes.
10.2.1 Activating extensions #
To activate an extension, proceed as follows:
List available extensions by running:
#
transactional-update --quiet register -list-extensionsThe output provides you with a command to activate the extensions, for example, for the
SUSE Linux Enterprise Live Patching
:#
transactional-update register -p sle-module-live-patching/15.4/x86_64 \ -r registration code
If you activated the SUSE Linux Enterprise Live Patching
extension, you need to perform additional steps as described below:
SUSE Linux Enterprise Live Patching
#Configure
libzypp
in the/etc/zypp/zypp.conf
file as follows:multiversion = provides:multiversion(kernel)
to keep the current kernel running while patching the system, otherwise you may get dependency conflicts while kernel updates are being applied.
multiversion.kernels = latest
after applying the live patch, a cleanup of kernels is performed in the new snapshot. If not set, the snapshot keeps the previous kernel and performs kernel updates also on the previous kernel.
Additionally, set
LIVEPATCH_KERNEL='always'
in the/etc/sysconfig/livepatching
file.Note: Matching version of thekernel-default-livepatch
and kernelTo ensure that the live patches will be installed even after the kernel upgrade, install the matching version of the
kernel-default-livepatch
package.Now, install the extension by running:
#
transactional-update pkg install kernel-default-livepatchReboot your system to switch to the new snapshot.
10.2.2 Deactivating extensions #
To deactivate the extension, run the following command:
#
transactional-update register -d \
-p EXTENSION_NAME
For example, for the SUSE Linux Enterprise Live Patching
extension, the command is as follows:
#
transactional-update register -d \
-p sle-module-live-patching/15.4/x86_64
Part III Manual installation #
- 11 Boot parameters
SUSE Linux Enterprise Micro allows setting several parameters during boot, for example choosing the source of the installation data or setting the network configuration.
- 12 Installation steps
This chapter describes the procedure in which the data for SUSE Linux Enterprise Micro is copied to the target device. Some basic configuration parameters for the newly installed system are set during the procedure. A graphical user interface will guide you through the installation. The text-mode installation has the same steps but looks different. For information about performing non-interactive automated installations, see Book “AutoYaST Guide”.
- 13 Remote installation
The installation of SUSE® Linux Enterprise Micro can be performed entirely over the network. This chapter describes how to provide the required environment for booting, installing and controlling the installation via the network.
- 14 Troubleshooting
This section covers several common installation problems and describes possible solutions.
11 Boot parameters #
SUSE Linux Enterprise Micro allows setting several parameters during boot, for example choosing the source of the installation data or setting the network configuration.
Using the appropriate set of boot parameters helps simplify your installation
procedure. Many parameters can also be configured later using the linuxrc
routines, but using the boot parameters is easier. In some automated setups,
the boot parameters can be provided with initrd
or an
info
file.
The way the system is started for the installation depends on the architecture—system start-up is different for PC (AMD64/Intel 64) or mainframe, for example. If you install SUSE Linux Enterprise Micro as a VM Guest on a KVM or Xen hypervisor, follow the instructions for the AMD64/Intel 64 architecture.
The terms Boot Parameters and Boot Options are often used interchangeably. In this documentation, we mostly use the term Boot Parameters.
11.1 Using the default boot parameters #
Generally, selecting
starts the installation boot process.If problems occur, use Chapter 14, Troubleshooting.
or . For more information about troubleshooting the installation process, refer toThe menu bar at the bottom of the screen offers some advanced functionality needed in some setups. Using the function keys (F1 ... F12), you can specify additional options to pass to the installation routines without having to know the detailed syntax of these parameters (see Chapter 11, Boot parameters). A detailed description of the available function keys is available in Section 11.2.1, “The boot screen on machines with traditional BIOS”.
11.2 PC (AMD64/Intel 64/AArch64) #
This section describes changing the boot parameters for AMD64, Intel 64 and AArch64.
11.2.1 The boot screen on machines with traditional BIOS #
The boot screen displays several options for the installation procedure. Enter to boot it. The relevant options are:
boots the installed system and is selected by default. Select one of the other options with the arrow keys and pressThe normal installation mode. All modern hardware functions are enabled. In case the installation fails, see F5 for boot parameters that disable potentially problematic functions.
- ›
Boot a Linux system that is already installed. You will be asked from which partition to boot the system.
- ›
This option is only available when you install from media created from downloaded ISOs. In this case it is recommended to check the integrity of the installation medium. This option starts the installation system before automatically checking the media. In case the check was successful, the normal installation routine starts. If a corrupt media is detected, the installation routine aborts. Replace the broken medium and restart the installation process.
- ›
Tests your system RAM using repeated read and write cycles. Terminate the test by rebooting. For more information, see Section 14.4, “Boot failure”.
Use the function keys shown at the bottom of the screen to change the language, screen resolution, installation source or to add an additional driver from your hardware vendor:
- F1
Get context-sensitive help for the active element of the boot screen. Use the arrow keys to navigate, Enter to follow a link, and Esc to leave the help screen.
- F2
Select the display language and a corresponding keyboard layout for the installation. The default language is English (US).
- F3
Select various graphical display modes for the installation. By “Kernel Mode Setting”). If this setting does not work on your system, choose and, optionally, specify
the video resolution is automatically determined using KMS (vga=ask
on the boot command line to get prompted for the video resolution. Choose if the graphical installation causes problems.- F4
Normally, the installation is performed from the inserted installation medium. Here, select other sources, like FTP or NFS servers, or configure a proxy server.
- F5
If you encounter problems with the regular installation, this menu offers to disable a few potentially problematic functions. If your hardware does not support ACPI (advanced configuration and power interface) select
to install without ACPI support. disables support for APIC (Advanced Programmable Interrupt Controllers) which may cause problems with some hardware. boots the system with the DMA mode (for CD/DVD-ROM drives) and power management functions disabled.If you are not sure, try the following options first:
or . Experts can also use the command line ( ) to enter or change kernel parameters.- F6
Press this key to notify the system that you have an optional driver update for SUSE Linux Enterprise Micro. With or , load drivers directly before the installation starts. If you select , you are prompted to insert the update disk at the appropriate point in the installation process.
11.2.2 The boot screen on machines equipped with UEFI #
UEFI (Unified Extensible Firmware Interface) is a new industry standard which replaces and extends the traditional BIOS. The latest UEFI implementations contain the “Secure Boot” extension, which prevents booting malicious code by only allowing signed boot loaders to be executed.
The boot manager GRUB 2, used to boot machines with a traditional BIOS,
does not support UEFI, therefore GRUB 2 is replaced with GRUB 2 for EFI. If
Secure Boot is enabled, YaST will automatically select GRUB 2 for EFI for
installation. From an administrative and user perspective, both boot
manager implementations behave the same and are called
GRUB 2
in the following.
When installing with Secure Boot enabled, you cannot load drivers that are not shipped with SUSE Linux Enterprise Micro. This is also true of drivers shipped via SolidDriver, because their signing key is not trusted by default.
To load drivers not shipped with SUSE Linux Enterprise Micro, do either of the following:
Before the installation, add the needed keys to the firmware database via firmware/system management tools.
Use a bootable ISO that will enroll the needed keys in the MOK list on the first boot.
The boot screen displays several options for the installation procedure. Change the selected option with the arrow keys and press Enter to boot it. The relevant options are:
The normal installation mode. All modern hardware functions are enabled. In case the installation fails, see F5 for boot parameters that disable potentially problematic functions.
- ›
Starts a minimal Linux system without a graphical user interface. For more information, see
- ›
Boot a Linux system that is already installed. You will be asked from which partition to boot the system.
- ›
This option is only available when you install from media created from downloaded ISOs. In this case it is recommended to check the integrity of the installation medium. This option starts the installation system before automatically checking the media. In case the check was successful, the normal installation routine starts. If a corrupt media is detected, the installation routine aborts.
GRUB 2 for EFI on SUSE Linux Enterprise Micro does not support a boot prompt or function keys for adding boot parameters. By default, the installation will be started with American English and the boot media as the installation source. A DHCP lookup will be performed to configure the network. To change these defaults or to add boot parameters you need to edit the respective boot entry. Highlight it using the arrow keys and press E. See the on-screen help for editing hints (note that only an English keyboard is available now). The entry will look similar to the following:
setparams 'Installation' set gfxpayload=keep echo 'Loading kernel ...' linuxefi /boot/x86_64/loader/linux splash=silent echo 'Loading initial ramdisk ...' initrdefi /boot/x86_64/loader/initrd
Add space-separated parameters to the end of the line starting with
linuxefi
. To boot the edited entry, press
F10. If you access the machine via serial console, press
Esc–0. A
complete list of parameters is available at
https://en.opensuse.org/Linuxrc.
11.3 List of important boot parameters #
This section contains a selection of important boot parameters.
11.3.1 General boot parameters #
autoyast=
URLThe
autoyast
parameter specifies the location of theautoinst.xml
control file for automatic installation.manual=<0|1>
The
manual
parameter controls whether the other parameters are only default values that still must be acknowledged by the user. Set this parameter to0
if all values should be accepted and no questions asked. Settingautoyast
implies settingmanual
to0
.Info=
URLSpecifies a location for a file from which to read additional options.
upgrade=<0|1>
To upgrade SUSE Linux Enterprise Micro, specify
Upgrade=1
.dud=
URLLoad driver updates from URL.
Set
dud=ftp://ftp.example.com/PATH_TO_DRIVER
ordud=http://www.example.com/PATH_TO_DRIVER
to load drivers from a URL. Whendud=1
you will be asked for the URL during boot.language=
LANGUAGESet the installation language. Some supported values are
cs_CZ
,de_DE
,es_ES
,fr_FR
,ja_JP
,pt_BR
,pt_PT
,ru_RU
,zh_CN
, andzh_TW
.acpi=off
Disable ACPI support.
noapic
No logical APIC.
nomodeset
Disable KMS.
textmode=1
Start installer in text mode.
console=
SERIAL_DEVICE[,MODE]SERIAL_DEVICE can be an actual serial or parallel device (for example
ttyS0
) or a virtual terminal (for exampletty1
). MODE is the baud rate, parity and stop bit (for example9600n8
). The default for this setting is set by the mainboard firmware. If you do not see output on your monitor, try settingconsole=tty1
. It is possible to define multiple devices.
11.3.2 Configuring the network interface #
The settings discussed in this section apply only to the network interface used during installation.
The network will only be configured if it is required during the
installation. To force the network to be configured, use the
netsetup
or ifcfg
parameters.
netsetup=VALUE
netsetup=dhcp
forces a configuration via DHCP. Setnetsetup=-dhcp
when configuring the network with the boot parametershostip
,gateway
andnameserver
. With the optionnetsetup=hostip,netmask,gateway,nameserver
the installer asks for the network settings during boot.ifcfg=INTERFACE[.VLAN]=[.try,]SETTINGS
INTERFACE can be
*
to match all interfaces or, for example,eth*
to match all interfaces that start witheth
. It is also possible to use MAC addresses as values.Optionally, a VLAN can be set behind the interface name, separated by a period.
If SETTINGS is
dhcp
, all matching interfaces will be configured with DHCP. If you add thetry
option, configuration will stop when the installation repository can be reached via one of the configured interfaces.Alternatively, you can use static configuration. With static parameters, only the first matching interface will be configured, unless you add the
try
option. This will configure all interfaces until the repository can be reached.The syntax for the static configuration is:
ifcfg=*="IPS_NETMASK,GATEWAYS,NAMESERVERS,DOMAINS"
Each comma separated value can in turn contain a list of space character separated values. IPS_NETMASK is in the CIDR notation, for example
10.0.0.1/24
. The quotes are only needed when using space character separated lists. Example with two name servers:ifcfg=*="10.0.0.10/24,10.0.0.1,10.0.0.1 10.0.0.2,example.com"
Tip: Other networking parametersThe
ifcfg
boot parameter is very powerful and allows you to set almost all networking parameters. In addition to the parameters mentioned above, you can set values for all configuration options (comma separated) from/etc/sysconfig/network/ifcfg.template
and/etc/sysconfig/network/config
. The following example sets a custom MTU size on an interface otherwise configured via DHCP:ifcfg=eth0=dhcp,MTU=1500
hostname=host.example.com
Enter the fully qualified host name.
domain=example.com
Domain search path for DNS. Allows you to use short host names instead of fully qualified ones.
hostip=192.168.1.2[/24]
Enter the IP address of the interface to configure. The IP can contain the subnet mask, for example
hostip=192.168.1.2/24
. This setting is only evaluated if the network is required during the installation.gateway=192.168.1.3
Specify the gateway to use. This setting is only evaluated if the network is required during the installation.
nameserver=192.168.1.4
Specify the DNS server in charge. This setting is only evaluated if the network is required during the installation.
domain=example.com
Domain search path. This setting is only evaluated if the network is required during the installation.
11.3.3 Specifying the installation source #
If you are not using DVD or USB flash drive for installation, specify an alternative installation source.
install=SOURCE
Specify the location of the installation source to use. Possible protocols are
cd
,hd
,slp
,nfs
,smb
(Samba/CIFS),ftp
,tftp
,http
, andhttps
. The default option iscd
.To install over an encrypted connection, use an
https
URL. If the certificate cannot be verified, disable certificate checking with thesslcerts=0
boot parameter.If an
http
,https
,ftp
,tftp
, orsmb
URL is given, you can authenticate by specifying the user name and password with the URL. Example:install=https://USER:PASSWORD@SERVER/DIRECTORY/DVD1/
In case of a Samba or CIFS installation, you can also specify the domain that should be used:
install=smb://WORKDOMAIN;USER:PASSWORD@SERVER/DIRECTORY/DVD1/
To use
cd
,hd
orslp
, set them as the following example:install=cd:/ install=hd:/?device=sda/PATH_TO_ISO install=slp:/
11.3.4 Specifying remote access #
Only one of the different remote control methods should be specified at a time. The different methods are: SSH, VNC, remote X server. For information about how to use the parameters listed in this section, see Chapter 13, Remote installation.
display_ip=
IP_ADDRESSDisplay_IP
causes the installing system to try to connect to an X server at the given address.Important: X authentication mechanismThe direct installation with the X Window System relies on a primitive authentication mechanism based on host names. This mechanism is disabled on current SUSE Linux Enterprise Micro versions. Installation with SSH or VNC is preferred.
vnc=1
Enables a VNC server during the installation.
vncpassword=
PASSWORDSets the password for the VNC server.
ssh=1
ssh
enables SSH installation.ssh.password=
PASSWORDSpecifies an SSH password for the root user during installation.
11.4 Advanced setups #
To configure access to a local RMT or supportconfig
server for the installation, you can specify boot parameters to set up these
services during installation. The same applies if you need IPv6 support
during the installation.
11.4.1 Using IPv6 for the installation #
By default you can only assign IPv4 network addresses to your machine. To enable IPv6 during installation, enter one of the following parameters at the boot prompt:
- Accept IPv4 and IPv6
ipv6=1
- Accept IPv6 only
ipv6only=1
11.4.2 Using a proxy for the installation #
In networks enforcing the usage of a proxy server for accessing remote web sites, registration during installation is only possible when configuring a proxy server.
On systems with traditional BIOS, press F4 on the boot screen and set the required parameters in the dialog.
On Systems with UEFI BIOS, provide the boot parameter
proxy
at the boot prompt:
On the boot screen, press E to edit the boot menu.
Append the
proxy
parameter to thelinux
line in the following format:proxy=https://proxy.example.com:PORT
If the proxy server requires authentication, add the credentials as follows:
proxy=https://USER:PASSWORD@proxy.example.com:PORT
If the proxy server's SSL certificate cannot be verified, disable certificate checking with the
sslcerts=0
boot parameter.The outcome will be similar to the following:
Figure 11.3: GRUB options editor #Press F10 to boot with the new proxy setting.
11.4.3 Enabling SELinux support #
Enabling SELinux upon installation start-up enables you to configure it after the installation has been finished without having to reboot. Use the following parameters:
security=selinux selinux=1
11.4.4 Scale user interface for high DPI #
If your screen uses a very high DPI, use the boot parameter
QT_AUTO_SCREEN_SCALE_FACTOR
. This scales font and user
interface elements to the screen DPI.
QT_AUTO_SCREEN_SCALE_FACTOR=1
11.4.5 Using CPU mitigations #
The boot parameter mitigations
lets you control
mitigation options for side-channel attacks on affected CPUs. Its possible
values are:
auto
.
Enables all mitigations required for your CPU model, but does
not protect against cross-CPU thread attacks. This setting may impact
performance to some degree, depending on the workload.
nosmt
.
Provides the full set of available security mitigations. Enables all
mitigations required for your CPU model. In addition, it disables
Simultaneous Multithreading (SMT) to avoid side-channel attacks across
multiple CPU threads. This setting may further impact performance,
depending on the workload.
off
.
Disables all mitigations. Side-channel attacks against your CPU
are possible, depending on the CPU model. This setting has no impact
on performance.
Each value comes with a set of specific parameters, depending on the CPU architecture, the kernel version, and on the vulnerabilities that need to be mitigated. Refer to the kernel documentation for details.
11.5 More information #
You can find more information about boot parameters in the openSUSE wiki at https://en.opensuse.org/SDB:Linuxrc#Parameter_Reference.
12 Installation steps #
This chapter describes the procedure in which the data for SUSE Linux Enterprise Micro is copied to the target device. Some basic configuration parameters for the newly installed system are set during the procedure. A graphical user interface will guide you through the installation. The text-mode installation has the same steps but looks different. For information about performing non-interactive automated installations, see Book “AutoYaST Guide”.
If you are a first-time user of SUSE Linux Enterprise Micro, you should follow the default YaST proposals in most parts, but you can also adjust the settings as described here to fine-tune your system according to your preferences. Help for each installation step is provided by clicking .
If the installer does not detect your mouse correctly, use →| for navigation, arrow keys to scroll, and Enter to confirm a selection. Various buttons or selection fields contain a letter with an underscore. Use Alt–Letter to select a button or a selection directly instead of navigating there with →|.
12.1 Overview #
This section provides an overview of all installation steps. Each step contains a link to a more detailed description.
At first, YaST performs network configuration. For details, refer to Section 12.2, “Network settings”.
The actual installation starts with language and keyboard selection and the license agreement. For details, refer to Section 12.3, “Language, Keyboard, and License Agreement”.
Accept the license agreement to proceed to the next step.
IBM Z machines need to activate disks. For details, see Section 12.4, “IBM Z: disk activation”.
Register your system. For details, refer to Section 12.5, “Registration”.
Install available extensions. For details, refer to Section 12.6, “Extension and Module Selection”
Configure NTP servers as described in Section 12.7, “NTP Configuration”.
Set a password for the system administrator
root
. For details, refer to Section 12.8, “Authentication for the System Administratorroot
”.The last installation step is an overview of all installation settings. For details, refer to Section 12.9, “Installation Settings”.
12.2 Network settings #
After booting into the installation, the installation routine is set up. During this setup, an attempt to configure at least one network interface with DHCP is made. In case this attempt has failed, the
dialog launches now.Choose a network interface from the list and click
to change its settings. Use the tabs to configure DNS and routing. On IBM Z this dialog does not start automatically. It can be started in the step.In case DHCP was successfully configured during installation setup, you can also access this dialog by clicking
at the and the step. It lets you change the automatically provided settings.If at least one network interface has been configured via boot parameters (see Section 11.3.2, “Configuring the network interface”), automatic DHCP configuration is disabled and the boot parameter configuration is imported and used.
To access a SAN or a local RAID during the installation, you can use the libstorage command line client for this purpose:
Switch to a console with Ctrl–Alt–F2.
Install the libstoragemgmt extension by running
extend libstoragemgmt
.Now you have access to the
lsmcli
command. For more information, runlsmcli --help
.To return to the installer, press Alt–F7
Supported are Netapp Ontap, all SMI-S compatible SAN providers, and LSI MegaRAID.
12.3 Language, Keyboard, and License Agreement #
The
and settings are initialized with the language you chose on the boot screen. If you did not change the default, it will be English (US). Change the settings here, if necessary.Changing the language will automatically preselect a corresponding keyboard layout. Override this proposal by selecting a different keyboard layout from the drop-down box. Use the
text box to test the layout. The language selected here is also used to assume a time zone for the system clock.By clicking
you can access the SLE Micro release notes in English.Read the License Agreement. It is presented in the language you have chosen on the boot screen. Translations are available via the SUSE Linux Enterprise Micro. Click to terminate the installation.
› drop-down box. If you agree to the terms, check and click to proceed with the installation. If you do not agree to the license agreement, you cannot install12.4 IBM Z: disk activation #
When installing on IBM Z platforms, the language selection dialog is followed by a dialog to configure the attached hard disks.
Select DASD, Fibre Channel Attached SCSI Disks (zFCP), or iSCSI for installation of SUSE Linux Enterprise Micro. The DASD and zFCP configuration buttons are only available if the corresponding devices are attached.
You can also change the
in this screen by launching the dialog. Choose a network interface from the list and click to change its settings. Use the tabs to configure DNS and routing.12.4.1 Configuring DASD disks #
Skip this step if you are not installing on IBM Z hardware.
After selecting
, an overview lists all available DASDs. To get a clearer picture of the available devices, use the text box located above the list to specify a range of channels to display. To filter the list according to such a range, select .Specify the DASDs to use for the installation by selecting the corresponding entries in the list. Use
to select all DASDs currently displayed. Activate and make the selected DASDs available for the installation by selecting › . To format the DASDs, select › .12.4.2 Configuring zFCP disks #
Skip this step if you are not installing on IBM Z hardware.
After selecting
, a dialog with a list of the zFCP disks available on the system opens. In this dialog, select to open another dialog in which to enter zFCP parameters.To make a zFCP disk available for the SUSE Linux Enterprise Micro installation, choose an available from the drop-down box. (World Wide Port Number) and (Logical Unit Number) return lists with available WWPNs and FCP-LUNs, respectively, to choose from. Automatic LUN scanning only works with NPIV enabled.
When completed, exit the zFCP dialog with
and the general hard disk configuration dialog with to continue with the rest of the configuration.12.5 Registration #
To get technical support and product updates, you need to register and activate SUSE Linux Enterprise Micro with the SUSE Customer Center or a local registration server. Registering your product at this stage also grants you immediate access to the update repository. This enables you to install the system with the latest updates and patches available.
From this dialog, you can switch to the YaST Section 12.2, “Network settings”.
module by clicking .For details, seeThe dialog offers the following possibilities, each described further:
To register with the SUSE Customer Center, enter the SUSE Linux Enterprise Micro. Proceed with .
associated with your SCC account and the forIf your organization provides a local registration server, you may alternatively register there. Activate
and either choose a URL from the drop-down box or type in an address. Proceed with .If you want to skip registration or you are offline, click
. Accept the warning with and proceed with .Important: Skipping registrationYour system needs to be registered in order to retrieve updates and to be eligible for support. You can register later, after the installation by using
SUSEConnect
, for details, see Section 10.1, “Registration”.
After SUSE Linux Enterprise Micro has been successfully registered, you are asked whether to install the latest available online updates during the installation. If choosing , the system will be installed with the most current packages without having to apply the updates after installation. Activating this option is recommended.
If the system was successfully registered during installation, YaST will disable repositories from local installation media such as CD/DVD or flash disks when the installation has been completed. This prevents problems if the installation source is no longer available and ensures that you always get the latest updates from the online repositories.
12.5.1 Loading registration codes from USB storage #
To make the registration more convenient, you can also store your registration codes on a USB storage device such as a flash disk. YaST will automatically pre-fill the corresponding text box. This is particularly useful when testing the installation or if you need to register many systems or extensions.
Create a file named regcodes.txt
or
regcodes.xml
on the USB disk. If both are present, the
XML takes precedence.
In that file, identify the product with the name returned by
zypper search --type product
and assign it a
registration code as follows:
regcodes.txt
#SLEMicro cc36aae1
regcodes.xml
#<?xml version="1.0"?>
<profile xmlns="http://www.suse.com/1.0/yast2ns"
xmlns:config="http://www.suse.com/1.0/configns">
<suse_register>
<addons config:type="list">
<addon>
<name>SLEMicro</name>
<reg_code>cc36aae1</reg_code>
</addon>
</addons>
</suse_register>
</profile>
Currently flash disks are only scanned during installation or upgrade, but not when registering a running system.
12.6 Extension and Module Selection #
SLE Micro currently offers the following extensions:
SUSE Linux Enterprise Live Patching
extension that enables you to apply critical patches without rebooting your system. Bear in mind that you might need an additional subscription on top of the subscription for SLE Micro.
If you enabled the
SUSE Linux Enterprise Live Patching
extension, you need to configure your system as described in Procedure 10.2, “Completing activation of theSUSE Linux Enterprise Live Patching
”.Note: Availability of theSUSE Linux Enterprise Live Patching
extensionThe
SUSE Linux Enterprise Live Patching
extension is available only for the x86 (except for the real-time kernel) and IBM Z architectures.SUSE Package Hub
A free module that provides access to community-maintained packages. Packages in the Package Hub are approved by SUSE for use on SUSE Linux Enterprise Server, thus the packages might not be installable on SLE Micro.
To enable a module, click the corresponding checkbox and then
to proceed.12.7 NTP Configuration #
In order to keep time on your system properly synchronized, configure at least one NTP server. You can enter more NTP servers as a comma or space separated list.
12.8 Authentication for the System Administrator root
#
root
#
Configure a strong password for root
. If your root
password is
randomly generated, use at least 10 characters. If you set your root
password manually, use a longer password that includes a combination of
uppercase and lowercase letters and numbers. The maximum length for
passwords is 72 characters, and passwords are case-sensitive.
If you want to access the system remotely via SSH using a public key, import a key from a removable storage device or an existing partition. To do so click
and select the public SSH key.Click
to proceed to the next installation step.12.9 Installation Settings #
To access a particular setting, click the respective heading. Or some options can be directly changed on the screen by clicking the button next to the option.
12.9.1 Partitioning #
SLE Micro requires Btrfs on the root partition with snapshots and Snapper enabled. Snapper is enabled by default—do not disable it afterwards.
- Custom partitioning on UEFI machines
A UEFI machine requires an EFI system partition that must be mounted to
/boot/efi
. This partition must be formatted with theFAT32
file system.If an EFI system partition is already present on your system (for example from a previous Windows installation) use it by mounting it to
/boot/efi
without formatting it.If no EFI system partition is present on your UEFI machine, make sure to create it. The EFI system partition must be a physical partition or RAID 1. Other RAID levels, LVM and other technologies are not supported. It needs to be formatted with the FAT32 file system.
- Custom partitioning and
Snapper
If the root partition is larger than 12 GB, SUSE Linux Enterprise Micro by default enables file system snapshots. It is not recommended to use the root partition smaller than 12 GB, because it might cause issues when running SLE Micro.
SUSE Linux Enterprise Micro uses Snapper together with Btrfs for this feature. Btrfs needs to be set up with snapshots enabled for the root partition.
Being able to create system snapshots that enable rollbacks requires important system directories to be mounted on a single partition, for example
/usr
. Only directories that are excluded from snapshots may reside on separate partitions, for example/usr/local
,/var
, and/tmp
.The installer will automatically create
single
snapshots during and immediately after the installation.Important: Btrfs snapshots and root partition sizeSnapshots may take considerable storage space. Generally, the older a snapshot is or the larger the change set it covers, the more storage space the snapshot takes. And the more snapshots you keep, the more disk space you need.
To prevent the root partition being filled up with snapshot data, you need to make sure that there is enough space on it. In case you do frequent updates or other installations, consider at least 40 GB for the root partition.
- Btrfs data volumes
Using Btrfs for data volumes is supported on SUSE Linux Enterprise Micro 5.5. For applications that require Btrfs as a data volume, consider creating a separate file system with quota groups disabled. This is already the default for non-root file systems.
- Btrfs on an encrypted root partition
The default partitioning setup suggests formatting the root partition to Btrfs. To encrypt the root partition, make sure to use the GPT partition table type instead of the MSDOS type. Otherwise the GRUB2 boot loader may not have enough space for the second stage loader.
- IBM Z: Using minidisks in z/VM
If SUSE Linux Enterprise Micro is installed on minidisks in z/VM, which reside on the same physical disk, the access path of the minidisks (/dev/disk/by-id/) is not unique. This is because it represents the ID of the physical disk. If two or more minidisks are on the same physical disk, they all have the same ID.
To avoid problems when mounting minidisks, always mount them either by path or by UUID.
- IBM Z: LVM root file system
If you configure the system with a root file system on LVM or software RAID array, you must place
/boot
on a separate, non-LVM or non-RAID partition, otherwise the system will fail to boot. The recommended size for such a partition is 500 MB and the recommended file system is Ext4.- Supported software RAID volumes
Installing to and booting from existing software RAID volumes is supported for Disk Data Format (DDF) volumes and Intel Matrix Storage Manager (IMSM) volumes. IMSM is also known by the following names:
Intel Rapid Storage Technology
Intel Matrix Storage Technology
Intel Application Accelerator / Intel Application Accelerator RAID Edition
Intel Virtual RAID on CPU (Intel VROC, see https://www.intel.com/content/www/us/en/support/articles/000024498/memory-and-storage/ssd-software.html for more details)
- Mount points for FCoE and iSCSI devices
FCoE and iSCSI devices will appear asynchronously during the boot process. While the initrd guarantees that those devices are set up correctly for the root file system, there are no such guarantees for any other file systems or mount points like
/usr
. Hence any system mount points like/usr
or/var
are not supported. To use those devices, ensure correct synchronization of the respective services and devices.
In case you need to adjust the partitioning scheme, click the
menu to open the dialog box.The installer creates a proposal for one of the available disks containing a root partition formatted with Btrfs and a swap partition. If one or more swap partitions have been detected on the available hard disks, these partitions will be used. You have several options to proceed:
Click
to accept the proposal without any changes and return to the screen.To adjust the proposal, choose
. First, choose which hard disks and partitions to use. In the screen, you can enable Logical Volume Management (LVM) and activate disk encryption. Afterward specify the . You can adjust the file system for the root partition and create a separate home and swap partitions. If you plan to suspend your machine, make sure to create a separate swap partition and check . If the root file system format is Btrfs, you can also enable or disable Btrfs snapshots here.To create a custom partition setup, click Section 12.9.1.1, “Expert Partitioner”.
. Select either if you want start with the suggested disk layout, or to ignore the suggested layout and start with the existing layout on the disk. For details, refer to
12.9.1.1 Expert Partitioner #
Expert partitioner enables you to set up logical volume management (LVM), configure software RAID and device mapping (DM), encrypt partitions, mount NFS shares and manage tmpfs volumes. To fine-tune settings such as the subvolume and snapshot handling for each Btrfs partition, choose
.
All existing or suggested partitions on all connected hard disks are
displayed in the left part of the /dev/sda
(or
/dev/dasda
). Partitions are listed as parts
of these devices, such as
/dev/sda1
(or
/dev/dasda1
, respectively). The size, type,
encryption status, file system, and mount point of the hard disks and
their partitions are also displayed. The mount point describes where the
partition appears in the Linux file system tree.
12.9.1.1.1 Partition tables #
SUSE Linux Enterprise Micro allows to use and create different partition tables. In some cases the partition table is called disk label. The partition table is important to the boot process of your computer. To boot your machine from a partition in a newly created partition table, make sure that the table format is supported by the firmware.
To change the partition table, click the relevant disk name in the left part and choose
› . You can create the following partition tables:- Master boot record
The master boot record (MBR) is the legacy partition table used on IBM PCs. It is sometimes also called an MS-DOS partition table. The MBR only supports four primary partitions. If the disk already has an MBR, SUSE Linux Enterprise Micro allows you to create additional partitions in it which can be used as the installation target.
The limit of four partitions can be overcome by creating an extended partition. The extended partition itself is a primary partition and can contain more logical partitions.
- GPT partition table
UEFI computers use a GUID Partition Table (GPT) by default. SUSE Linux Enterprise Micro will create a GPT on a disk if no other partition table exists.
Old BIOS firmware does not support booting from GPT partitions.
You need a GPT partition table to use more than four primary partitions, UEFI Secure Boot or use disks larger than 2 TB.
12.9.1.1.2 Creating partitions #
The expert partitioner enables you to add partitions. Bear in mind that the root file system must be formatted to Btrfs and snapshots must be enabled.
The procedure below creates a Btrfs partition with enabled snapshots.
Select the desired hard disk in the left part and click
.Define size of the partition or define the region of disk for the partition. Proceed with
Select a role:
Format and mount the partition as needed and proceed with
:(Optional) If you chose to encrypt the partition, enter the encryption password and complete the process with
:
12.9.1.1.3 Creating volume groups #
To create a volume group follow these steps:
12.9.1.1.4 Creating RAIDs #
SLE Micro supports the following RAID levels: 0, 1, 5, 6 and 10. To create a RAID follow proceed as follows:
Create partitions (the count of partitions depend on the RAID level) with these parameters:
The partitions have the
role assigned.The partitions are not formatted to any file system.
The partitions are not mounted.
The partitions have the
Linux RAID
.
Click
in the left pane and then click . The dialog box opens.Choose the partitions and add them to the RAID. Select RAID level and optionally you can name the RAID. Proceed with
.Select the
. The default value is usually sufficient. Click .In the
select the created RAID and click .Select a role of the RAID and click
.Format and mount the device and optionally you can select that the RAID will be encrypted.
12.9.2 Software #
SUSE Linux Enterprise Micro contains several software patterns for various application purposes. Click to open the screen where you can modify the pattern selection according to your needs. Select a pattern from the list and see a description in the right-hand part of the window.
In this menu you can select the Web based remote system
management
pattern that will install Cockpit
system. Cockpit is a web monitoring tool that enables you to administer
your system. For details, refer to Article “Cockpit Guide”, Section 2 “Getting Cockpit”.
Here you can also select the KVM Virtualization Host
pattern to install packages required to run SLE Micro as a KVM host server
(Xen is not supported). However, you should consider the limitations of
SLE Micro running as a KVM host server; for details, refer to
virtualization
limits and support.
Each pattern contains several software packages needed for specific functions (for example Podman). For a more detailed selection based on software packages to install, select
to switch to the YaST Software Manager.12.9.3 Timezone #
By default, the time is synchronized by using the NTP servers you provided in the previous steps of the installation procedure. You can select the region and time zone either by clicking a particular place on the map or by selecting a region and time zone in the drop-down menus.
The switch from standard time to daylight saving time (and vice versa) can only be performed automatically when the hardware clock (CMOS clock) is set to UTC. This also applies if you use automatic time synchronization with NTP, because automatic synchronization will only be performed if the time difference between the hardware and system clock is less than 15 minutes.
Since a wrong system time can cause serious problems, it is strongly recommended to always set the hardware clock to UTC.
The button
enables you to set the date and time manually or configure NTP servers synchronization.If you want to set the time and date manually, click the
button and select .Since the operating system is not allowed to change time and date directly, the
option is not available on IBM Z.12.9.4 Network Configuration #
Network is automatically configured at the beginning of the installation process, but if it is necessary you can change the configuration by clicking Section 12.2, “Network settings”.
. A dialog box opens, for details refer to
SLE Micro uses NetworkManager by default, but you can switch to wicked
by clicking . Bear in mind that after the installation is complete, you cannot switch the network managing service to NetworkManager.
12.9.5 Booting #
The installer proposes a boot configuration for your system. Other operating systems found on your computer, such as Microsoft Windows or other Linux installations, will automatically be detected and added to the boot loader. However, SUSE Linux Enterprise Micro will be booted by default. Normally, you can leave these settings unchanged. If you need a custom setup, modify the proposal according to your needs.
Booting a configuration where /boot
resides on a
software RAID 1 device is supported, but it requires installing the boot
loader into the MBR ( › ). Having
/boot
on software RAID devices with a level other
than RAID 1 is not supported.
12.9.6 Kdump #
Using Kdump, you can save a dump of the kernel (in case of a crash) to analyze what went wrong. By default, Kdump is enabled. By clicking
you open a dialog box for configuring Kdump.- Start-Up
Here you can disable Kdump and configure the amount of memory reserved for Kdump. Usually you do not have to change the prefilled values.
- Dump Filtering
Dump filtering enables you to select which pages will be included in the Kdump, and to define the format of of Kdump.
- Dump Target
You can select a local directory or you can save KDump to a remote location. If you prefer a remote location, you also need to configure connection details according to the respective protocol.
- Email Notifications
To receive email notifications if an event occurs, specify an email address.
- Expert Settings
This option enables you to define command-line parameters, custom kernel dump and other advanced settings related to Kdump.
12.9.7 System #
This screen lists all the hardware information the installer could obtain about your computer. When opened for the first time, the hardware detection is started. Depending on your system, this may take some time. Select any item in the list and click
to see detailed information about the selected item. Use to save a detailed list to either the local file system or a removable device.Advanced users can also change the
and kernel settings by choosing . A screen with two tabs opens:Each kernel driver contains a list of device IDs of all devices it supports. If a new device is not in any driver's database, the device is treated as unsupported, even if it can be used with an existing driver. You can add PCI IDs to a device driver here. Only advanced users should attempt to do so.
To add an ID, click
and select whether to enter the data, or whether to choose from a list. Enter the required data. The is the directory name from/sys/bus/pci/drivers
—if empty, the name is used as the directory name. Existing entries can be managed with and .Activating the https://www.kernel.org/doc/html/latest/admin-guide/sysrq.html for details.
item, will let you issue basic commands (such as rebooting the system or writing kernel dumps) in case the system crashes. Enabling these keys is recommended when doing kernel development. Refer to
12.9.8 Security #
Using firewall along with Podman may result in missing Podman-related firewall
rules after reloading the firewalld
service. Therefore,
it is recommended to keep the firewall in its default
setting (disabled) if you intend to use Podman.
You can enable the firewall or disable the SSH service directly by clicking
the respective button. Clicking on the button next to CPU mitigations
configuration.
The
refer to kernel boot command line parameters for software mitigations that have been deployed to prevent CPU side-channel attacks. You can configure the following values:- Auto
All CPU side channel mitigations are enabled as they are detected based on the CPU type. The auto-detection handles both unaffected older CPUs and unaffected newly released CPUs and transparently disables mitigations. This options leave SMT enabled.
- Off
All CPU side channel mitigations are disabled. While this option gives the higher performance, it also bears the highest risk. Do not use this setting where there is a risk of untrusted code.
- Auto + No Smt
All CPU side channel mitigations are enabled as they are detected based on the CPU type. Additionally the symmetric multi-threading of the CPU is disabled if necessary, for instance to mitigate the L1 Terminal Fault side channel issue.
- Manually
CPU mitigations are detected manually.
By default, the firewall is disabled. Click
to change the default.The SSH service is enabled by default. Click
to change the setting. If you disable the SSH service, you will not be able to login to your system remotely. The SSH port (22) is open by default.The default SELinux option is
. You can change the value by clicking and selecting another option in the menu.In the
dialog box, you can also select PolicyKit privileges in the dropdown menu.13 Remote installation #
The installation of SUSE® Linux Enterprise Micro can be performed entirely over the network. This chapter describes how to provide the required environment for booting, installing and controlling the installation via the network.
13.1 Overview #
For a remote installation you need to consider how to boot, how to control the installation, and the source of the installation data. All available options can be combined with each other, if they are available for your hardware platform.
- Boot method
Depending on the hardware, several options for booting a system exist. Common options are DVD, USB drive or PXE boot. For more information about your platform, refer to Part I, “Installation preparation”.
- Data source
Most commonly, DVDs or USB drives are used as a source for installing SUSE Linux Enterprise Micro. Alternatively, installation servers can be used. In this case, use the
install
boot parameter to specify the source. For details, refer to Section 11.3.3, “Specifying the installation source”.- Installation methods
Instead of using a keyboard and monitor directly attached to the target machine, the installation can be performed via SSH, VNC, or by using the serial console of a machine. This is described in the sections Section 13.3, “Monitoring installation via VNC”, Section 13.4, “Monitoring installation via SSH” and Section 13.5, “Installation via serial console”.
AutoYaST can be used to fully automate the installation process. For further information, refer to Book “AutoYaST Guide”.
13.2 Scenarios for remote installation #
This section introduces the most common installation scenarios for remote installations. For each scenario, carefully check the list of prerequisites and follow the procedure outlined for that scenario. If in need of detailed instructions for a particular step, follow the links provided for each one of them.
13.2.1 Installation from source media via VNC #
This type of installation still requires some degree of physical access to the target system to boot for installation. The installation is controlled by a remote workstation using VNC to connect to the installation program. User interaction is required as with the manual installation in Chapter 12, Installation steps.
For this type of installation, make sure that the following requirements are met.
Target system with a working network connection.
Controlling system with a working network connection and VNC viewer software or JavaScript-enabled browser (Firefox, Chromium, Internet Explorer, Opera, etc.).
Installation DVD or USB flash drive.
To perform this kind of installation, proceed as follows:
After the installation of SLE Micro is finished, you will no longer be able to log in to the system using VNC.
Boot the target system using the installation medium (USB flash drive) of the SUSE Linux Enterprise Micro media kit.
When the boot screen of the target system appears, use the boot parameters prompt to set the VNC options and static network configuration, if required. For information about boot parameters, see Chapter 11, Boot parameters.
Boot parameters for a static network configuration:
netdevice=NETDEVICE hostip=IP_ADDRESS netmask=NETMASK gateway=IP_GATEWAY vnc=1 VNCPassword=PASSWORD
Boot parameters for a dynamic (DHCP) network configuration:
vnc=1 VNCPassword=PASSWORD
The target system boots to a text-based environment and shows the network address and display number. VNC installations announce themselves over OpenSLP, provided the firewall settings are configured appropriately. They can be found using
slptool
as described in Section 13.3.1, “Preparing for VNC installation”.On the controlling workstation, open a VNC viewer or Web browser and connect to the target system using the provided network address and display number as described in Section 13.3, “Monitoring installation via VNC”.
Perform the installation as described in Chapter 12, Installation steps.
13.2.2 Network installation using VNC #
This type of installation does not require a direct interaction with the target machine. The system is booted via PXE and the installation data is fetched from a server.
To perform this type of installation, make sure that the following requirements are met.
At least one machine that can be used for installing a DHCP, NFS, HTTP, FTP, TFTP, or SMB server.
Target system capable of PXE boot, networking, and Wake on LAN, plugged in and connected to the network.
Controlling system with a working network connection and VNC viewer software or JavaScript-enabled browser (Firefox, Chromium, Microsoft Edge, Opera, etc.).
To perform this type of installation, proceed as follows.
After the installation of SLE Micro is finished, you will no longer be able to log in to the system using VNC.
Set up the server that contains the installation data.
Set up a DHCP and TFTP server for the network. Add the required boot parameters to enable the VNC server.
Enable PXE boot in the target machine firmware.
Initiate the boot process of the target system using Wake on LAN.
On the controlling workstation, open a VNC viewing application or Web browser and connect to the target system.
Perform the installation as described in Chapter 12, Installation steps.
13.2.3 Installation from source media via SSH #
This type of installation still requires some degree of physical access to the target system to boot for installation and to determine the IP address of the installation target. The installation itself is entirely controlled from a remote workstation using SSH to connect to the installer. User interaction is required as with the regular installation described in Chapter 12, Installation steps.
For this type of installation, make sure that the following requirements are met.
Target system with working network connection.
Controlling system with working network connection and working SSH client software.
Installation DVD or USB flash drive.
To perform this kind of installation, proceed as follows:
Set up the installation target and installation server.
Boot the target system using the installation medium (USB flash drive) of the SUSE Linux Enterprise Micro media kit.
When the boot screen of the target system appears, use the boot parameters prompt to set the SSH options and, if required, the static network configuration. For information about boot parameters, see Chapter 11, Boot parameters.
Boot parameters for a static network configuration:
netdevice=NETDEVICE hostip=IP_ADDRESS netmask=NETMASK gateway=IP_GATEWAY ssh=1 ssh.password=PASSWORD
Boot parameters for a dynamic (DHCP) network configuration:
ssh=1 ssh.password=PASSWORD
The target system boots to a text-based environment, giving the network address under which the graphical installation environment can be addressed by any SSH client.
On the controlling workstation, open a terminal window and connect to the target system as described in Section 13.4.2, “Connecting to the installation program”.
Perform the installation as described in Chapter 12, Installation steps.
13.2.4 Installation from network via SSH #
This type of installation does not require a direct interaction with the target machine. The system is booted via PXE and the installation data is fetched from a server.
To perform this type of installation, make sure that the following requirements are met:
At least one machine that can be used for installing a DHCP, NFS, HTTP, FTP, TFTP, or SMB server.
Target system capable of PXE boot, networking, and Wake on LAN, plugged in and connected to the network.
Controlling system with working network connection and SSH viewer software.
To perform this type of installation, proceed as follows.
Set up the server that contains the installation data.
Set up a DHCP and TFTP server for the network. Add the required boot parameters to enable the SSH server.
Enable PXE boot in the target machine firmware.
Initiate the boot process of the target system using Wake on LAN.
On the controlling workstation, open an SSH client software and connect to the target system.
Perform the installation as described in Chapter 12, Installation steps.
13.3 Monitoring installation via VNC #
Using a VNC viewer, you can remotely control the installation of SUSE Linux Enterprise Micro from virtually any operating system. This section introduces the setup using a VNC viewer or a Web browser.
13.3.1 Preparing for VNC installation #
To enable VNC on the installation target, specify the appropriate boot parameters at the initial boot for installation (see Chapter 11, Boot parameters). The target system boots into a text-based environment and waits for a VNC client to connect to the installation program.
The installation program announces the IP address and display number needed to connect for installation. If you have physical access to the target system, this information is provided right after the system booted for installation. Enter this data when your VNC client software prompts for it and provide your VNC password.
Because the installation target announces itself via OpenSLP, you can retrieve the address information of the installation target via an SLP browser. There is no need for physical access to the installation target provided your network setup and all machines support OpenSLP:
Run
slptool findsrvtypes | grep vnc
to get a list of all services offering VNC. The VNC installation targets should be available under a service namedYaST.installation.suse
.Run
slptool findsrvs
YaST.installation.suse to get a list of installations available. Use the IP address and the port (usually5901
) provided with your VNC viewer.
13.3.2 Connecting to the installation program #
There are two ways to connect to a VNC server (the installation target in this case). You can either start a VNC viewer or connect using a JavaScript-enabled Web browser.
Using VNC, you can install a Linux system from any other operating system, including other Linux distributions, Windows, or macOS.
On a Linux machine, make sure that the package
tightvnc
is installed. On a Windows machine,
install the Windows port of this application (see https://www.tightvnc.com/download.html).
To connect to the installer running on the target machine, proceed as follows.
Start the VNC viewer.
Enter the IP address and display number of the installation target:
IP_ADDRESS:DISPLAY_NUMBER
This opens a window displaying the YaST screen as in a regular local installation.
Instead of a VNC viewer, you can use a JavaScript-enabled browser that has JavaScript support enabled to perform the installation.
Note that the browser VNC connection is not encrypted.
To perform a VNC installation, proceed as follows.
Launch the Web browser and enter the following at the address prompt:
http://IP_ADDRESS_OF_TARGET:5801
When prompted, enter the VNC password. This opens a window with the YaST screen as in a regular local installation.
13.4 Monitoring installation via SSH #
Using an SSH client, you can perform the installation remotely via SSH.
13.4.1 Preparing for SSH installation #
In addition to installing the required software package (OpenSSH for Linux and PuTTY for Windows), you need to specify the appropriate boot parameters to enable SSH for installation. See Chapter 11, Boot parameters for details. OpenSSH is installed by default on any SUSE Linux–based operating system.
13.4.2 Connecting to the installation program #
After you have started the SSH installation, use this procedure to connect to the SSH session.
Retrieve the installation target's IP address. If you have physical access to the target machine, obtain the IP address that the installation routine provides from the console after the initial boot. Otherwise, obtain the IP address that has been assigned to the target machine in the DHCP server configuration.
Run the following command in the terminal:
ssh -X root@TARGET_IP_ADDRESS
Replace TARGET_IP_ADDRESS with the actual IP address of the installation target.
When prompted for a user name, enter
root
.When prompted, enter the password that has been set with the SSH boot parameter. If the authentication is successful, you should see a command-line prompt for the installation target appear.
Enter
yast
to launch the installation program. This opens a window showing the YaST screen as described in Chapter 12, Installation steps.
13.5 Installation via serial console #
For this installation method, you need a computer connected by a null modem cable to the target machine where SUSE Linux Enterprise Micro will be installed. Both machines must support the serial console. Certain firmware implementations are already configured to send the boot console output to a serial console. In this case, no additional configuration is required.
If the firmware does not use the serial console for the boot console output,
set the following boot parameter for the installation:
console=TTY,BAUDRATE
.
For further information, see Chapter 11, Boot parameters.
BAUDRATE needs to be replaced by the baud rate for the interface. Valid values are 115200, 38400, or 9600. TTY needs to be replaced by the name of the interface. On most computers, there is one or more serial interfaces. Depending on the hardware, the names of the interfaces may vary:
ttyS0 for APM
ttyAMA0 for Server Base System Architecture (SBSA)
ttyPS0 for Xilinx
For the installation, you need a terminal program like
minicom
or screen
. To initiate the
serial connection, launch the screen program in a local console by entering
the following command:
>
screen
/dev/ttyUSB0 115200
This means that screen listens to the first serial port with a baud rate of 115200. From this point on, the installation proceeds similarly to the text-based installation over this terminal.
14 Troubleshooting #
This section covers several common installation problems and describes possible solutions.
14.1 Checking media #
If you encounter any problems using the SUSE Linux Enterprise Micro installation media, check its integrity. Boot from the media and choose › from the boot menu. A minimal system boots and lets you choose which device to check. Select the respective device and confirm with to perform the check.
On a running system, start YaST and choose
› . Insert the medium and click . The integrity check may take time.If errors are detected during the check, do not use this medium for installation. Media problems may, for example, occur when having burned the medium on DVD yourself. Burning the media at a low speed (4x) helps to avoid problems.
14.2 No bootable drive available #
If your computer cannot boot from USB or DVD drive, you have several alternatives.
- Using an external USB flash drive or DVD drive
Linux supports most existing USB flash drives and DVD drives. If the system has no USB flash drive or DVD drive, it is still possible that an external drive, connected through USB, FireWire, or SCSI, can be used to boot the system. Sometimes a firmware update may help if you encounter problems.
- Network boot via PXE
If the machine lacks both a USB flash drive and DVD drive, but it has a working Ethernet connection, you can perform a network-based installation.
- USB flash drive
You can use a USB flash drive if the machine lacks a DVD drive and a network connection.
14.3 Booting from installation media fails #
The machine may fail to boot from the installation media due to an incorrect boot sequence setting in BIOS. The USB flash drive or DVD drive must be set as the first boot device in the BIOS boot sequence.
Enter the BIOS using the proper key shown by the boot routines and wait for the BIOS screen to appear.
To change the boot sequence in an AWARD BIOS, look for the Enter.
entry. Other manufacturers may have a different name for this, such as . When you have found the entry, select it and confirm withLook for a subentry called Page ↑ or Page ↓ until the USB flash drive or DVD drive is listed first.
or . Change the settings by pressingExit the BIOS setup screen by pressing Esc. To save the changes, select , or press F10. To save the modified settings, press Y.
Open the setup by pressing Ctrl–A.
Select
. The connected hardware components are now displayed.Make note of the SCSI ID of your USB flash drive or DVD drive.
Exit the menu with Esc.
Open Enter.
. Under , select and pressEnter the ID of the USB flash drive or DVD drive and press Enter again.
Press Esc twice to return to the start screen of the SCSI BIOS.
Exit this screen and confirm with
to boot the computer.
Regardless of what language and keyboard layout the installed system will be using, most BIOS configurations use the US keyboard layout as shown below.
14.4 Boot failure #
Some hardware types, mainly very old or very recent ones, fail to boot. Reasons can be missing support for hardware in the installation kernel or drivers causing problems on some specific hardware.
If installation fails using the standard
mode, try the following.With the installation media still in the drive, reboot the machine with Ctrl–Alt–Del or using the hardware reset button.
When the boot screen appears, press F5, use the arrow keyboard keys to navigate to , and press Enter to boot and initiate the installation process. This option disables the support for ACPI power management techniques.
Proceed with the installation as described in Chapter 12, Installation steps.
If this fails, proceed as above, but choose
instead. This option disables ACPI and DMA support. This option works with most hardware.
If both options fail, use the boot parameters prompt to specify the
kernel parameters to enable support for the hardware in use. For more
information about the parameters available as boot parameters, refer to the
kernel documentation located in
/usr/src/linux/Documentation/kernel-parameters.txt
.
Install the kernel-source
package to view the kernel documentation.
There are other ACPI-related kernel parameters that can be entered at the boot prompt prior to booting for installation:
acpi=off
This parameter disables the complete ACPI subsystem on your computer. This may be useful if your computer cannot handle ACPI or if you think ACPI in your computer causes trouble.
acpi=force
Always enable ACPI even if your computer has a BIOS released before 2000. This parameter also enables ACPI if it is set in addition to
acpi=off
.acpi=noirq
Do not use ACPI for IRQ routing.
acpi=ht
Run only enough ACPI to enable hyper-threading.
acpi=strict
Be less tolerant of platforms that are not strictly ACPI-compliant.
pci=noacpi
Disable PCI IRQ routing of the new ACPI system.
pnpacpi=off
Enable this option to avoid issues caused by incorrectly configured device resources in BIOS.
notsc
Disable the time stamp counter. This option can be used to work around timing problems on your systems. It is a recent feature, so if you see regressions on your machine, especially time related or even total hangs, this option is worth a try.
nohz=off
Disable the nohz feature. If your machine hangs, enabling this option may help.
When you have determined the right parameter combination, YaST automatically writes them to the boot loader configuration to make sure that the system boots properly next time.
If errors occur when the kernel is loaded or during the installation, select
in the boot menu to check the memory. If returns an error, this usually indicates a hardware error.14.5 Graphical installer fails to start #
The machine boots into the installation interface, and the graphical installer does not start when you select
.There are several ways to deal with this situation.
Select another screen resolution for the installation dialogs.
Select
for installation.Perform a remote installation via VNC using the graphical installer.
Boot for installation.
Press F3 to open a menu from which to select a lower resolution for installation purposes.
Select Chapter 12, Installation steps.
and proceed with the installation as described in
Boot for installation.
Press F3 and select .
Select Chapter 12, Installation steps.
and proceed with the installation as described in
Boot for installation.
Enter the following text at the boot parameters prompt:
vnc=1 vncpassword=SOME_PASSWORD
Replace SOME_PASSWORD with the password to use for VNC installation.
Select Enter to start the installation.
then pressInstead of starting right into the graphical installation routine, the system continues to run in a text mode. The system then halts, displaying a message containing the IP address and port number at which the installer can be reached via a browser interface or a VNC viewer application.
When using a browser to access the installer, launch the browser and enter the address information provided by the installation routines on the future SUSE Linux Enterprise Micro machine and press Enter:
http://IP_ADDRESS_OF_MACHINE:5801
A dialog opens in the browser window prompting you for the VNC password. Enter it and proceed with the installation as described in Chapter 12, Installation steps.
Important: Cross-platform supportInstallation via VNC works with any browser under any operating system, provided Java support is enabled.
Provide the IP address and password to your VNC viewer when prompted. A window opens, displaying the installation dialogs. Proceed with the installation as usual.
14.6 Only minimal boot screen is displayed #
You inserted the medium into the drive, the BIOS routines are finished, and the system launches a minimal, text-based interface. This may happen on any machine that does not have sufficient graphics memory for rendering a graphical boot screen.
Although the text boot screen looks minimal, it provides nearly the same functionality as the graphical one.
- Boot options
Unlike the graphical interface, the different boot parameters cannot be selected using the cursor keys of your keyboard. The boot menu of the text-mode boot screen provides keywords that can be entered at the boot prompt. These keywords match the options in the graphical version. Enter your choice and press Enter to launch the boot process.
- Custom boot options
After selecting a boot parameter, enter the appropriate keyword at the boot prompt or enter some custom boot parameters as described in Section 14.4, “Boot failure”. To launch the installation process, press Enter.
- Screen resolutions
Use the function keys (F1 ... F12) to determine the screen resolution for installation. If you need to boot in text mode, choose F3.
A GNU licenses #
This appendix contains the GNU Free Documentation License version 1.2.
GNU Free Documentation License #
Copyright (C) 2000, 2001, 2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
0. PREAMBLE #
The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or non-commercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
1. APPLICABILITY AND DEFINITIONS #
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
2. VERBATIM COPYING #
You may copy and distribute the Document in any medium, either commercially or non-commercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
3. COPYING IN QUANTITY #
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
4. MODIFICATIONS #
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
State on the Title page the name of the publisher of the Modified Version, as the publisher.
Preserve all the copyright notices of the Document.
Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
Include an unaltered copy of this License.
Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.
Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.
Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
5. COMBINING DOCUMENTS #
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".
6. COLLECTIONS OF DOCUMENTS #
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
7. AGGREGATION WITH INDEPENDENT WORKS #
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
8. TRANSLATION #
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
9. TERMINATION #
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
10. FUTURE REVISIONS OF THIS LICENSE #
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.
ADDENDUM: How to use this License for your documents #
Copyright (c) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with...Texts.” line with this:
with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.