Installing Fujitsu Enterprise Postgres on SUSE Linux Enterprise Server for IBM Z and LinuxONE #

The enterprise database management system (DBMS) is a fundamental tool of the modern business. Enterprises of all sizes rely on their DBMS to collect and manage huge volumes of data securely and reliably, all while responding to hundreds or thousands of simultaneous inquiries.

SUSE Linux Enterprise Server is trusted by enterprises around the world for their mission-critical IT deployments. A multimodal operating system that paves the way for IT transformation in the software-defined era. The modern and modular OS helps simplify multimodal IT, makes traditional IT infrastructure efficient and provides an engaging platform for developers. As a result, organizations can easily deploy and transition business-critical workloads across on-premises and public cloud environments.

Fujitsu has been developing enterprise, mission-critical database systems for over 35 years. Since 2004, Fujitsu has provided development, support, training, and consulting services to businesses worldwide for PostgreSQL, one of the world’s most advanced, open source database systems. Fujitsu Enterprise Postgres remains compatible with open source PostgreSQL, while adding enhanced features, such as in-memory columnar indexing, data masking, transparent data encryption, and dedicated audit logging.

IBM Z and LinuxONE systems are an enterprise-class, purpose-built, data serving platform for business-critical Linux workloads that mandate the highest levels of security, scalability, performance, and resilience. The platform supports traditional n-tier Linux applications and databases, and cloud-ready containerized workloads and microservices, delivering a true, secure, hybrid-cloud platform for organizations of all sizes.

This document guides an administrator through the installation of Fujitsu Enterprise Postgres 12 on a SUSE Linux Enterprise Server 12 SP5, leveraging automation to reduce the time required to deploy both SUSE Linux Enterprise Server and Fujitsu Enterprise Postgres. It is written using SUSE Linux Enterprise Server on s390x (IBM Z and LinuxONE) as a KVM virtual machine. But these steps can be applied to the installation of Fujitsu Enterprise Postgres on SUSE Linux Enterprise Server for any supported architecture (x86_64, ppc64le, and s390x), whether on physical hardware or in a virtual machine.

The end result of following these steps is Fujitsu Enterprise Postgres running on SUSE Linux Enterprise Server with a test database.

This document describes the following:

Starting with the hardware, IBM Z and LinuxONE systems are ideal platforms for sensitive data and critical applications. Several built-in hardware features help to protect data at rest and in-flight from internal and external threats.

SUSE Linux Enterprise Server for IBM Z and LinuxONE delivers the open source components that surface the hardware capabilities and bring key open source technologies to the platform. For example, Kernel-based Virtual Machine (KVM) is an open source virtualization technology included in SUSE Linux Enterprise Server for IBM Z and LinuxONE. Some of the benefits of KVM are as follows:

Combining IBM Z and LinuxONE with SUSE Linux Enterprise Server and Fujitsu Enterprise Postgres delivers a highly secure, agile data platform for mission-critical applications. This enables organizations to create full DevOps pipelines with secure, virtual environments for development, testing, quality assurance, and, of course, production.

The following environment is used for this document (your environment might be different):

The goal is to install a SUSE Linux Enterprise Server 15 SP2 KVM hypervisor host in an IBM Z LPAR. We choose SUSE Linux Enterprise Server 15 SP2 as a KVM hypervisor because it contains the latest KVM features and has the longest support cycle of the currently supported SUSE Linux Enterprise Server versions.

Use the guidelines for this installation as described in section Installation on IBM Z and LinuxONE of the SUSE Linux Enterprise Server Deployment Guide.

Also, adhere to the following guidelines when you perform the installation:

The goal of this chapter is to copy a preconfigured autoyast.xml file and a prep script that will automate the installation of SUSE Linux Enterprise Server into a VM. It is important to review and edit the prep script that will be used to prepare the VM for the SUSE Linux Enterprise Server 12 SP5 installation.

Complete the following steps to install a SUSE Linux Enterprise Server KVM virtual machine:

Note

If this script must be run again, remove the Fujitsu Enterprise Postgres VM runtime definition by using the virsh undefine fep command.

AutoYaST is used to install the SUSE Linux Enterprise Server KVM VM. Running the prep-for-fep-install.sh script creates an ISO file that contains the AutoYaST configuration. It also creates the XML files with the configuration described below which is used to install and run the KVM VM:

The goal of this chapter is to successfully install SUSE Linux Enterprise Server 12 SP5. To accomplish this, the VM is started and the AutoYaST installation begins automatically.

Complete the following steps to install and configure the SUSE Linux Enterprise Server 12 SP5 KVM guest:

Note

Be sure that SUSE Linux Enterprise Server is registered to the SUSE Customer Center (SCC), a local Subscription Management Tool (SMT), or local Repository Mirroring Tool (RMT) server.

Now that the virtual machine is provisioned, Fujitsu Enterprise Postgres can be installed.

Complete the following steps to install the Fujitsu Enterprise Postgres RPM packages and enable Fujitsu Enterprise Postgres WebAdmin. Refer to the Resources - FUJITSU Enterprise Postgres 12 on IBM LinuxONE™ page for detailed installation and configuration instructions.

Note

The systemctl service name for Fujitsu Enterprise Postgres 12 is FSEPWAD_120_WA_64.service.

Complete the following steps to create a test database to confirm that Fujitsu Enterprise Postgres has been installed and is running correctly:

This getting started guide has been an introduction to deploying Fujitsu Enterprise Postgres on SUSE Linux Enterprise Server using KVM virtual machines on an IBM Z or LinuxONE system. Automation has been used to simplify the deployment of SUSE Linux Enterprise Server in a KVM virtual machine.

For more information, visit:

Example fep-autoyast.xml file:

<?xml version="1.0"?>
<!DOCTYPE profile>
<profile xmlns="http://www.suse.com/1.0/yast2ns" xmlns:config="http://www.suse.com/1.0/configns">
  <add-on>
    <add_on_products config:type="list"/>
  </add-on>
  <dasd>
    <devices config:type="list"/>
    <format_unformatted config:type="boolean">false</format_unformatted>
  </dasd>
  <deploy_image>
    <image_installation config:type="boolean">false</image_installation>
  </deploy_image>
  <firewall>
    <enable_firewall config:type="boolean">false</enable_firewall>
    <start_firewall config:type="boolean">false</start_firewall>
  </firewall>
  <general>
    <ask-list config:type="list"/>
    <cio_ignore config:type="boolean">false</cio_ignore>
    <mode>
      <confirm config:type="boolean">true</confirm>
    </mode>
    <proposals config:type="list"/>
    <signature-handling>
      <accept_file_without_checksum config:type="boolean">true</accept_file_without_checksum>
      <accept_non_trusted_gpg_key config:type="boolean">true</accept_non_trusted_gpg_key>
      <accept_unknown_gpg_key config:type="boolean">true</accept_unknown_gpg_key>
      <accept_unsigned_file config:type="boolean">true</accept_unsigned_file>
      <accept_verification_failed config:type="boolean">false</accept_verification_failed>
      <import_gpg_key config:type="boolean">true</import_gpg_key>
    </signature-handling>
    <storage>
      <partition_alignment config:type="symbol">align_optimal</partition_alignment>
      <start_multipath config:type="boolean">false</start_multipath>
    </storage>
  </general>
  <kdump>
    <add_crash_kernel config:type="boolean">true</add_crash_kernel>
    <crash_kernel>163M</crash_kernel>
  </kdump>
  <language>
    <language>en_US</language>
    <languages/>
  </language>
  <login_settings/>
  <networking>
    <dns>
      <dhcp_hostname config:type="boolean">false</dhcp_hostname>
      <write_hostname config:type="boolean">false</write_hostname>
    </dns>
    <ipv6 config:type="boolean">false</ipv6>
    <keep_install_network config:type="boolean">true</keep_install_network>
    <managed config:type="boolean">false</managed>
    <interfaces config:type="list">
      <interface>
        <bootproto>none</bootproto>
        <device>eth0</device>
        <dhclient_set_default_route>yes</dhclient_set_default_route>
        <name>Ethernet Card 0 (virtio4)</name>
        <startmode>auto</startmode>
      </interface>
  </interfaces>
  </networking>
  <nis>
    <start_autofs config:type="boolean">false</start_autofs>
    <start_nis config:type="boolean">false</start_nis>
  </nis>
  <ntp-client>
    <start_at_boot config:type="boolean">false</start_at_boot>
    <start_in_chroot config:type="boolean">false</start_in_chroot>
    <sync_interval config:type="integer">5</sync_interval>
    <synchronize_time config:type="boolean">false</synchronize_time>
  </ntp-client>
  <partitioning config:type="list">
    <drive>
      <device>/dev/vda</device>
      <disklabel>msdos</disklabel>
      <enable_snapshots config:type="boolean">true</enable_snapshots>
      <initialize config:type="boolean">true</initialize>
      <partitions config:type="list">
        <partition>
          <create config:type="boolean">true</create>
          <crypt_fs config:type="boolean">false</crypt_fs>
          <filesystem config:type="symbol">ext2</filesystem>
          <format config:type="boolean">true</format>
          <fstopt>acl,user_xattr</fstopt>
          <loop_fs config:type="boolean">false</loop_fs>
          <mount>/boot/zipl</mount>
          <mountby config:type="symbol">uuid</mountby>
          <partition_id config:type="integer">131</partition_id>
          <partition_nr config:type="integer">1</partition_nr>
          <partition_type>primary</partition_type>
          <resize config:type="boolean">false</resize>
          <size>auto</size>
        </partition>
        <partition>
          <create config:type="boolean">true</create>
          <crypt_fs config:type="boolean">false</crypt_fs>
          <filesystem config:type="symbol">swap</filesystem>
          <format config:type="boolean">true</format>
          <fstopt>defaults</fstopt>
          <loop_fs config:type="boolean">false</loop_fs>
          <mount>swap</mount>
          <mountby config:type="symbol">uuid</mountby>
          <partition_id config:type="integer">130</partition_id>
          <partition_nr config:type="integer">2</partition_nr>
          <resize config:type="boolean">false</resize>
          <!-- Minimum of 4G of swap required for Oracle 19c installation -->
          <size>4G</size>
        </partition>
        <partition>
          <create config:type="boolean">true</create>
          <crypt_fs config:type="boolean">false</crypt_fs>
          <filesystem config:type="symbol">btrfs</filesystem>
          <format config:type="boolean">true</format>
          <fstopt>defaults</fstopt>
          <loop_fs config:type="boolean">false</loop_fs>
          <mount>/</mount>
          <mountby config:type="symbol">uuid</mountby>
          <partition_id config:type="integer">131</partition_id>
          <partition_nr config:type="integer">3</partition_nr>
          <partition_type>primary</partition_type>
          <resize config:type="boolean">false</resize>
          <size>max</size>
        </partition>
      </partitions>
      <pesize/>
      <type config:type="symbol">CT_DISK</type>
      <use>all</use>
    </drive>
    <drive>
      <device>/dev/vdb</device>
      <disklabel>msdos</disklabel>
      <enable_snapshots config:type="boolean">false</enable_snapshots>
      <initialize config:type="boolean">true</initialize>
      <partitions config:type="list">
        <partition>
          <create config:type="boolean">true</create>
          <crypt_fs config:type="boolean">false</crypt_fs>
          <filesystem config:type="symbol">xfs</filesystem>
          <format config:type="boolean">true</format>
          <fstopt>defaults</fstopt>
          <loop_fs config:type="boolean">false</loop_fs>
          <mount>/database</mount>
          <mountby config:type="symbol">uuid</mountby>
          <partition_id config:type="integer">131</partition_id>
          <partition_nr config:type="integer">1</partition_nr>
          <partition_type>primary</partition_type>
          <resize config:type="boolean">false</resize>
          <size>max</size>
        </partition>
      </partitions>
      <pesize/>
      <type config:type="symbol">CT_DISK</type>
      <use>all</use>
    </drive>
    <drive>
      <device>/dev/vdc</device>
      <disklabel>msdos</disklabel>
      <enable_snapshots config:type="boolean">false</enable_snapshots>
      <initialize config:type="boolean">true</initialize>
      <partitions config:type="list">
        <partition>
          <create config:type="boolean">true</create>
          <crypt_fs config:type="boolean">false</crypt_fs>
          <filesystem config:type="symbol">xfs</filesystem>
          <format config:type="boolean">true</format>
          <fstopt>defaults</fstopt>
          <loop_fs config:type="boolean">false</loop_fs>
          <mount>/translog</mount>
          <mountby config:type="symbol">uuid</mountby>
          <partition_id config:type="integer">131</partition_id>
          <partition_nr config:type="integer">1</partition_nr>
          <partition_type>primary</partition_type>
          <resize config:type="boolean">false</resize>
          <size>max</size>
        </partition>
      </partitions>
      <pesize/>
      <type config:type="symbol">CT_DISK</type>
      <use>all</use>
    </drive>
    <drive>
      <device>/dev/vdc</device>
      <disklabel>msdos</disklabel>
      <enable_snapshots config:type="boolean">false</enable_snapshots>
      <initialize config:type="boolean">true</initialize>
      <partitions config:type="list">
        <partition>
          <create config:type="boolean">true</create>
          <crypt_fs config:type="boolean">false</crypt_fs>
          <filesystem config:type="symbol">xfs</filesystem>
          <format config:type="boolean">true</format>
          <fstopt>defaults</fstopt>
          <loop_fs config:type="boolean">false</loop_fs>
          <mount>/dbtranslg</mount>
          <mountby config:type="symbol">uuid</mountby>
          <partition_id config:type="integer">131</partition_id>
          <partition_nr config:type="integer">1</partition_nr>
          <partition_type>primary</partition_type>
          <resize config:type="boolean">false</resize>
          <size>max</size>
        </partition>
      </partitions>
      <pesize/>
      <type config:type="symbol">CT_DISK</type>
      <use>all</use>
    </drive>
    <drive>
      <device>/dev/vdd</device>
      <disklabel>msdos</disklabel>
      <enable_snapshots config:type="boolean">false</enable_snapshots>
      <initialize config:type="boolean">true</initialize>
      <partitions config:type="list">
        <partition>
          <create config:type="boolean">true</create>
          <crypt_fs config:type="boolean">false</crypt_fs>
          <filesystem config:type="symbol">xfs</filesystem>
          <format config:type="boolean">true</format>
          <fstopt>defaults</fstopt>
          <loop_fs config:type="boolean">false</loop_fs>
          <mount>/dbbackup</mount>
          <mountby config:type="symbol">uuid</mountby>
          <partition_id config:type="integer">131</partition_id>
          <partition_nr config:type="integer">1</partition_nr>
          <partition_type>primary</partition_type>
          <resize config:type="boolean">false</resize>
          <size>max</size>
        </partition>
      </partitions>
      <pesize/>
      <type config:type="symbol">CT_DISK</type>
      <use>all</use>
    </drive>
  </partitioning>
  <report>
    <errors>
      <log config:type="boolean">true</log>
      <show config:type="boolean">true</show>
      <timeout config:type="integer">0</timeout>
    </errors>
    <messages>
      <log config:type="boolean">true</log>
      <show config:type="boolean">true</show>
      <timeout config:type="integer">0</timeout>
    </messages>
    <warnings>
      <log config:type="boolean">true</log>
      <show config:type="boolean">true</show>
      <timeout config:type="integer">0</timeout>
    </warnings>
    <yesno_messages>
      <log config:type="boolean">true</log>
      <show config:type="boolean">true</show>
      <timeout config:type="integer">0</timeout>
    </yesno_messages>
  </report>
  <services-manager>
    <default_target>multi-user</default_target>
  </services-manager>
  <software>
    <image/>
    <install_recommended config:type="boolean">true</install_recommended>
    <instsource/>
    <packages config:type="list">
      <package>vlan</package>
      <package>snapper</package>
      <package>sles-release</package>
      <package>openssh</package>
      <package>lvm2</package>
      <package>kexec-tools</package>
      <package>kdump</package>
      <package>grub2</package>
      <package>glibc</package>
      <package>e2fsprogs</package>
      <package>btrfsprogs</package>
      <!-- Required by FEP install -->
      <package>dstat</package>
      <package>libmemcached</package>
      <package>openCryptoki</package>
      <package>python3</package>
      <package>sysstat</package>
      <package>java-1_8_0-openjdk</package>
    </packages>
    <patterns config:type="list">
      <pattern>Minimal</pattern>
      <pattern>base</pattern>
      <pattern>documentation</pattern>
      <pattern>yast2</pattern>
    </patterns>
  </software>
  <timezone>
    <hwclock>UTC</hwclock>
    <timezone>America/New_York</timezone>
  </timezone>
  <users config:type="list">
    <user>
      <fullname>root</fullname>
      <gid>0</gid>
      <home>/root</home>
      <password_settings>
        <expire/>
        <flag/>
        <inact/>
        <max/>
        <min/>
        <warn/>
      </password_settings>
      <shell>/bin/bash</shell>
      <uid>0</uid>
      <user_password>password</user_password>
      <username>root</username>
    </user>
    <user>
      <fullname>fsepuser</fullname>
      <password_settings>
        <expire/>
        <flag/>
        <inact/>
        <max/>
        <min/>
        <warn/>
      </password_settings>
      <shell>/bin/bash</shell>
      <user_password>password</user_password>
      <username>fsepuser</username>
    </user>
  </users>
  <zfcp>
    <devices config:type="list"/>
  </zfcp>
  <scripts>
    <init-scripts config:type="list">
      <script>
        <filename>01-init.sh</filename>
        <interpreter>shell</interpreter>
        <source><![CDATA[
#!/bin/sh

echo "Running Init script - 01-init.sh"
chown -R fsepuser /database
chown -R fsepuser /dbtranslg
chown -R fsepuser /dbbackup
chown
]]>
        </source>
      </script>
    </init-scripts>
  </scripts>
</profile>

Example prep-for-fep-vm-install.sh file:

#!/bin/bash

# KVM Host variables
AUTOYAST_FILE=/root/fep-autoyast.xml
ISO_FILE=/var/lib/libvirt/images/isos/SLE-12-SP5-Server-DVD-s390x-GM-DVD1.iso
INSTALL_DIR=/var/lib/libvirt/images/sles12sp5-install

# FEP VM variables
VM_OS_QCOW2=/var/lib/libvirt/images/fep_os.qcow2
VM_OS_QCOW2_SIZE=25G
VM_FEPDB_SCSI=/dev/mapper/36005076307ffd3b3000000000000013e
VM_FEPTRANS_SCSI=/dev/mapper/36005076307ffd3b3000000000000013f
VM_FEPBU_SCSI=/dev/mapper/36005076307ffd3b30000000000000140
VEPA_NIC=eth1
VEPA_NIC_DEVNO=0x0810

if test ! -e ${ISO_FILE}; then
    echo
    echo "Please copy $(basename ${ISO_FILE}) to $(dirname ${ISO_FILE})."
    echo "Quitting..."
    exit 1
fi
if test ! -e ${AUTOYAST_FILE}; then
    echo
    echo "Please copy $(basename ${AUTOYAST_FILE}) to $(dirname ${AUTOYAST_FILE})."
    echo "Quitting..."
    exit 1
fi

if test -e ${VM_OS_QCOW2} -o -e /var/lib/libvirt/images/sles12sp5-install -o -e /root/fep_install.xml; then
   echo "Cleaning up a previous FEP VM installation attempt."
   rm -rf ${VM_OS_QCOW2} /var/lib/libvirt/images/sles12sp5-install /root/fep_install.xml
   virsh undefine fep >/dev/null 2>&1
fi

echo "Setting up environment for autoyast installation."
mkdir -p ${INSTALL_DIR}
TMP_MNT=$(mktemp -d)
mount ${ISO_FILE} ${TMP_MNT} > /dev/null 2>&1
cp ${TMP_MNT}/boot/s390x/linux ${INSTALL_DIR}
cp ${TMP_MNT}/boot/s390x/initrd ${INSTALL_DIR}
cp ${AUTOYAST_FILE} ${INSTALL_DIR}/autoyast.xml
umount ${TMP_MNT}
rmdir ${TMP_MNT}
mkisofs -quiet ${INSTALL_DIR}/autoyast.xml > ${INSTALL_DIR}/autoyast.iso

echo "Creating FEP OS qcow2 virtual disk file."
if type -p qemu-img > /dev/null 2>&1; then
    qemu-img create -q -f qcow2 ${VM_OS_QCOW2} ${VM_OS_QCOW2_SIZE}
else
    echo
    echo "Unable to find qemu-img."
    echo "Quitting..."
    exit 1
fi

echo "Generating FEP virtual machine xml file for SLES installation."
for disk in ${VM_OS_QCOW2} ${VM_FEBDB_SCSI} ${VM_FEPTRANS_SCSI}; do
    if test ! -e ${disk}; then
        echo
        echo "${disk} is not defined."
        echo "Quitting..."
        exit 1
    fi
done
if test $(lsqeth | grep -c ${VEPA_NIC}) -eq 0; then
    echo
    echo "${VEPA_NIC} is not defined."
    echo "Quitting..."
    exit 1
fi
virt-install --name fep --vcpus 4 --memory 4096 \
--disk path=${VM_OS_QCOW2},target=vda \
--disk path=${VM_FEPDB_SCSI},cache=none,io=native,target=vdb \
--disk path=${VM_FEPTRANS_SCSI},cache=none,io=native,target=vdc \
--disk path=${VM_FEPBU_SCSI},cache=none,io=native,target=vdd \
--network type=direct,source=${VEPA_NIC},address.type=ccw,address.cssid=0xfe,address.ssid=0x0,address.devno=${VEPA_NIC_DEVNO} \
--cdrom ${ISO_FILE} \
--disk path=${INSTALL_DIR}/autoyast.iso,device=cdrom \
--boot kernel=${INSTALL_DIR}/linux,initrd=${INSTALL_DIR}/initrd,\
kernel_args="self_update=0 install=cd:/ autoyast=device://sr1/autoyast.xml" \
--print-xml 1 > /root/fep_install.xml

echo "Defining FEP virtual machine for runtime administration."
virsh -q define /root/fep_install.xml
virt-xml -q fep --remove-device --disk path=${INSTALL_DIR}/autoyast.iso,device=cdrom
virt-xml -q fep --edit --boot kernel=,initrd=,kernel_args=
virt-xml -q fep --edit --events on_reboot=restart

exit 0

Copyright © 2006–2023 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".

SUSE, the SUSE logo and YaST are registered trademarks of SUSE LLC in the United States and other countries. For SUSE trademarks, see https://www.suse.com/company/legal/.

Linux is a registered trademark of Linus Torvalds. All other names or trademarks mentioned in this document may be trademarks or registered trademarks of their respective owners.

Documents published as part of the SUSE Best Practices series have been contributed voluntarily by SUSE employees and third parties. They are meant to serve as examples of how particular actions can be performed. They have been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. SUSE cannot verify that actions described in these documents do what is claimed or whether actions described have unintended consequences. SUSE LLC, its affiliates, the authors, and the translators may not be held liable for possible errors or the consequences thereof.

Below we draw your attention to the license under which the articles are published.

Copyright © 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.

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 noncommercially. 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 in order 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.

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.

You may copy and distribute the Document in any medium, either commercially or noncommercially, 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.

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.

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:

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.

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".

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.

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.

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.

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.

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 http://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.

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.