lorax/docs/html/livemedia-creator.html

1001 lines
81 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
2021-04-23 20:42:41 +00:00
<html class="writer-html5" lang="en" >
<head>
2021-10-11 22:40:42 +00:00
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
2021-10-11 22:40:42 +00:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
2021-12-11 00:02:04 +00:00
<title>livemedia-creator &mdash; Lorax 36.3 documentation</title>
2021-10-11 22:40:42 +00:00
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
2021-10-11 22:40:42 +00:00
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
2020-09-08 18:59:15 +00:00
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
2021-10-11 22:40:42 +00:00
<script src="_static/js/theme.js"></script>
2018-05-12 00:18:21 +00:00
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
2021-04-23 20:42:41 +00:00
<link rel="next" title="mkksiso" href="mkksiso.html" />
2018-05-12 00:18:21 +00:00
<link rel="prev" title="Lorax" href="lorax.html" />
</head>
2021-10-11 22:40:42 +00:00
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
2016-02-13 00:06:33 +00:00
<div class="wy-side-scroll">
2019-03-27 23:44:14 +00:00
<div class="wy-side-nav-search" >
2016-02-13 00:06:33 +00:00
<a href="index.html" class="icon icon-home"> Lorax
</a>
<div class="version">
2021-12-11 00:02:04 +00:00
36.3
2016-02-13 00:06:33 +00:00
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
2021-10-11 22:40:42 +00:00
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
2017-11-28 17:18:51 +00:00
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction to Lorax</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html#before-lorax">Before Lorax</a></li>
2016-02-13 00:06:33 +00:00
<li class="toctree-l1"><a class="reference internal" href="lorax.html">Lorax</a></li>
2016-11-29 17:27:44 +00:00
<li class="toctree-l1 current"><a class="current reference internal" href="#">livemedia-creator</a><ul>
2018-08-13 23:43:20 +00:00
<li class="toctree-l2"><a class="reference internal" href="#livemedia-creator-cmdline-arguments">livemedia-creator cmdline arguments</a><ul>
2021-10-11 22:40:42 +00:00
<li class="toctree-l3"><a class="reference internal" href="#options">options</a></li>
2018-08-13 23:43:20 +00:00
<li class="toctree-l3"><a class="reference internal" href="#disk/fs image arguments">disk/fs image arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="#appliance arguments">appliance arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="#qemu arguments">qemu arguments</a></li>
2020-01-16 18:13:02 +00:00
<li class="toctree-l3"><a class="reference internal" href="#dracut arguments: (default: )">dracut arguments: (default: )</a></li>
2018-08-13 23:43:20 +00:00
<li class="toctree-l3"><a class="reference internal" href="#pxe to live arguments">pxe to live arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="#OCI arguments">OCI arguments</a></li>
<li class="toctree-l3"><a class="reference internal" href="#Vagrant arguments">Vagrant arguments</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#quickstart">Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="#how-iso-creation-works">How ISO creation works</a></li>
2018-06-04 23:27:56 +00:00
<li class="toctree-l2"><a class="reference internal" href="#kickstarts">Kickstarts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#user-created-repositories">User created repositories</a></li>
<li class="toctree-l3"><a class="reference internal" href="#using-a-proxy-with-repos">Using a Proxy with repos</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#anaconda-image-install-no-virt">Anaconda image install (no-virt)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ami-images">AMI Images</a></li>
<li class="toctree-l2"><a class="reference internal" href="#appliance-creation">Appliance Creation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#filesystem-image-creation">Filesystem Image Creation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#tar-file-creation">TAR File Creation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#live-image-for-pxe-boot">Live Image for PXE Boot</a></li>
<li class="toctree-l2"><a class="reference internal" href="#atomic-live-image-for-pxe-boot">Atomic Live Image for PXE Boot</a></li>
2019-03-27 23:44:14 +00:00
<li class="toctree-l2"><a class="reference internal" href="#using-mock-and-no-virt-to-create-images">Using Mock and --no-virt to Create Images</a></li>
2016-03-18 23:30:48 +00:00
<li class="toctree-l2"><a class="reference internal" href="#using-mock-and-qemu-to-create-images">Using Mock and qemu to Create Images</a></li>
<li class="toctree-l2"><a class="reference internal" href="#openstack-image-creation">OpenStack Image Creation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#docker-image-creation">Docker Image Creation</a></li>
2015-12-04 18:12:19 +00:00
<li class="toctree-l2"><a class="reference internal" href="#open-container-initiative-image-creation">Open Container Initiative Image Creation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#vagrant-image-creation">Vagrant Image Creation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#creating-uefi-disk-images-with-virt">Creating UEFI disk images with virt</a></li>
<li class="toctree-l2"><a class="reference internal" href="#debugging-problems">Debugging problems</a></li>
<li class="toctree-l2"><a class="reference internal" href="#hacking">Hacking</a></li>
</ul>
</li>
2019-11-05 22:36:46 +00:00
<li class="toctree-l1"><a class="reference internal" href="mkksiso.html">mkksiso</a></li>
<li class="toctree-l1"><a class="reference internal" href="product-images.html">Product and Updates Images</a></li>
2018-05-12 00:18:21 +00:00
<li class="toctree-l1"><a class="reference internal" href="modules.html">src</a></li>
</ul>
2016-02-13 00:06:33 +00:00
</div>
</div>
</nav>
2021-10-11 22:40:42 +00:00
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
2017-11-28 17:18:51 +00:00
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Lorax</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
2021-10-11 22:40:42 +00:00
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
2021-04-23 20:42:41 +00:00
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
2017-11-28 17:18:51 +00:00
<li>livemedia-creator</li>
<li class="wy-breadcrumbs-aside">
2017-11-28 17:18:51 +00:00
<a href="_sources/livemedia-creator.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
2016-02-13 00:06:33 +00:00
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
2021-10-11 22:40:42 +00:00
<section id="livemedia-creator">
<h1>livemedia-creator<a class="headerlink" href="#livemedia-creator" title="Permalink to this headline"></a></h1>
2019-03-27 23:44:14 +00:00
<dl class="field-list simple">
<dt class="field-odd">Authors</dt>
<dd class="field-odd"><p>Brian C. Lane &lt;<a class="reference external" href="mailto:bcl&#37;&#52;&#48;redhat&#46;com">bcl<span>&#64;</span>redhat<span>&#46;</span>com</a>&gt;</p>
</dd>
</dl>
<p>livemedia-creator uses <a class="reference external" href="https://github.com/rhinstaller/anaconda">Anaconda</a>,
<a class="reference external" href="https://github.com/rhinstaller/pykickstart">kickstart</a> and <a class="reference external" href="https://github.com/rhinstaller/lorax">Lorax</a> to create bootable media that use the
same install path as a normal system installation. It can be used to make live
isos, bootable (partitioned) disk images, tarfiles, and filesystem images for
use with virtualization and container solutions like libvirt, docker, and
OpenStack.</p>
2016-03-18 23:30:48 +00:00
<p>The general idea is to use qemu with kickstart and an Anaconda boot.iso to
install into a disk image and then use the disk image to create the bootable
media.</p>
2019-03-27 23:44:14 +00:00
<p>livemedia-creator --help will describe all of the options available. At the
minimum you need:</p>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">--make-iso</span></code> to create a final bootable .iso or one of the other <code class="docutils literal notranslate"><span class="pre">--make-*</span></code> options.</p>
<p><code class="docutils literal notranslate"><span class="pre">--iso</span></code> to specify the Anaconda install media to use with qemu.</p>
<p><code class="docutils literal notranslate"><span class="pre">--ks</span></code> to select the kickstart file describing what to install.</p>
2016-03-18 23:30:48 +00:00
<p>To use livemedia-creator with virtualization you will need to have qemu installed.</p>
2018-05-12 00:18:21 +00:00
<p>If you are going to be using Anaconda directly, with <code class="docutils literal notranslate"><span class="pre">--no-virt</span></code> mode, make sure
2016-03-18 23:30:48 +00:00
you have the anaconda-tui package installed.</p>
<p>Conventions used in this document:</p>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">lmc</span></code> is an abbreviation for livemedia-creator.</p>
<p><code class="docutils literal notranslate"><span class="pre">builder</span></code> is the system where livemedia-creator is being run</p>
<p><code class="docutils literal notranslate"><span class="pre">image</span></code> is the disk image being created by running livemedia-creator</p>
2021-10-11 22:40:42 +00:00
<section id="livemedia-creator-cmdline-arguments">
2016-03-18 23:30:48 +00:00
<h2>livemedia-creator cmdline arguments<a class="headerlink" href="#livemedia-creator-cmdline-arguments" title="Permalink to this headline"></a></h2>
2019-03-27 23:44:14 +00:00
<p><p>Create Live Install Media</p>
</p>
2021-10-11 22:40:42 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">livemedia</span><span class="o">-</span><span class="n">creator</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span>
<span class="p">(</span><span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">iso</span> <span class="o">|</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">disk</span> <span class="o">|</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">fsimage</span> <span class="o">|</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">appliance</span> <span class="o">|</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">ami</span> <span class="o">|</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">tar</span> <span class="o">|</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">tar</span><span class="o">-</span><span class="n">disk</span> <span class="o">|</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">pxe</span><span class="o">-</span><span class="n">live</span> <span class="o">|</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">ostree</span><span class="o">-</span><span class="n">live</span> <span class="o">|</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">oci</span> <span class="o">|</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">vagrant</span><span class="p">)</span>
<span class="p">[</span><span class="o">--</span><span class="n">iso</span> <span class="n">ISO</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">iso</span><span class="o">-</span><span class="n">only</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">iso</span><span class="o">-</span><span class="n">name</span> <span class="n">ISO_NAME</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ks</span> <span class="n">KS</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">image</span><span class="o">-</span><span class="n">only</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">no</span><span class="o">-</span><span class="n">virt</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">proxy</span> <span class="n">PROXY</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">anaconda</span><span class="o">-</span><span class="n">arg</span> <span class="n">ANACONDA_ARGS</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">armplatform</span> <span class="n">ARMPLATFORM</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">location</span> <span class="n">LOCATION</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">logfile</span> <span class="n">LOGFILE</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">lorax</span><span class="o">-</span><span class="n">templates</span> <span class="n">LORAX_TEMPLATES</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">tmp</span> <span class="n">TMP</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">resultdir</span> <span class="n">RESULT_DIR</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">macboot</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">nomacboot</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">extra</span><span class="o">-</span><span class="n">boot</span><span class="o">-</span><span class="n">args</span> <span class="n">EXTRA_BOOT_ARGS</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">disk</span><span class="o">-</span><span class="n">image</span> <span class="n">DISK_IMAGE</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">keep</span><span class="o">-</span><span class="n">image</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">fs</span><span class="o">-</span><span class="n">image</span> <span class="n">FS_IMAGE</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">image</span><span class="o">-</span><span class="n">name</span> <span class="n">IMAGE_NAME</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">tar</span><span class="o">-</span><span class="n">disk</span><span class="o">-</span><span class="n">name</span> <span class="n">TAR_DISK_NAME</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">fs</span><span class="o">-</span><span class="n">label</span> <span class="n">FS_LABEL</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">image</span><span class="o">-</span><span class="n">size</span><span class="o">-</span><span class="n">align</span> <span class="n">IMAGE_SIZE_ALIGN</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">image</span><span class="o">-</span><span class="nb">type</span> <span class="n">IMAGE_TYPE</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">qemu</span><span class="o">-</span><span class="n">arg</span> <span class="n">QEMU_ARGS</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">qcow2</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">qcow2</span><span class="o">-</span><span class="n">arg</span> <span class="n">QEMU_ARGS</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">compression</span> <span class="n">COMPRESSION</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">compress</span><span class="o">-</span><span class="n">arg</span> <span class="n">COMPRESS_ARGS</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">app</span><span class="o">-</span><span class="n">name</span> <span class="n">APP_NAME</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">app</span><span class="o">-</span><span class="n">template</span> <span class="n">APP_TEMPLATE</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">app</span><span class="o">-</span><span class="n">file</span> <span class="n">APP_FILE</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ram</span> <span class="n">MEMORY</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">vcpus</span> <span class="n">VCPUS</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">vnc</span> <span class="n">VNC</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">arch</span> <span class="n">ARCH</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">kernel</span><span class="o">-</span><span class="n">args</span> <span class="n">KERNEL_ARGS</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">ovmf</span><span class="o">-</span><span class="n">path</span> <span class="n">OVMF_PATH</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">virt</span><span class="o">-</span><span class="n">uefi</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">no</span><span class="o">-</span><span class="n">kvm</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="k">with</span><span class="o">-</span><span class="n">rng</span> <span class="n">WITH_RNG</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">dracut</span><span class="o">-</span><span class="n">conf</span> <span class="n">DRACUT_CONF</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">dracut</span><span class="o">-</span><span class="n">arg</span> <span class="n">DRACUT_ARGS</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">live</span><span class="o">-</span><span class="n">rootfs</span><span class="o">-</span><span class="n">size</span> <span class="n">LIVE_ROOTFS_SIZE</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">live</span><span class="o">-</span><span class="n">rootfs</span><span class="o">-</span><span class="n">keep</span><span class="o">-</span><span class="n">size</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">oci</span><span class="o">-</span><span class="n">config</span> <span class="n">OCI_CONFIG</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">oci</span><span class="o">-</span><span class="n">runtime</span> <span class="n">OCI_RUNTIME</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">vagrant</span><span class="o">-</span><span class="n">metadata</span> <span class="n">VAGRANT_METADATA</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">vagrantfile</span> <span class="n">VAGRANTFILE</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">project</span> <span class="n">PROJECT</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">releasever</span> <span class="n">RELEASEVER</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">volid</span> <span class="n">VOLID</span><span class="p">]</span>
<span class="p">[</span><span class="o">--</span><span class="n">squashfs</span><span class="o">-</span><span class="n">only</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">timeout</span> <span class="n">TIMEOUT</span><span class="p">]</span> <span class="p">[</span><span class="o">-</span><span class="n">V</span><span class="p">]</span>
2018-08-13 23:43:20 +00:00
</pre></div>
</div>
2021-10-11 22:40:42 +00:00
<section id="options">
<h3>options<a class="headerlink" href="#options" title="Permalink to this headline"></a></h3>
2019-03-27 23:44:14 +00:00
<dl class="option-list">
<dt><kbd>--make-iso</kbd></dt>
<dd><p>Build a live iso</p>
<p>Default: False</p>
</dd>
<dt><kbd>--make-disk</kbd></dt>
<dd><p>Build a partitioned disk image</p>
<p>Default: False</p>
</dd>
<dt><kbd>--make-fsimage</kbd></dt>
<dd><p>Build a filesystem image</p>
<p>Default: False</p>
</dd>
<dt><kbd>--make-appliance</kbd></dt>
<dd><p>Build an appliance image and XML description</p>
<p>Default: False</p>
</dd>
<dt><kbd>--make-ami</kbd></dt>
<dd><p>Build an ami image</p>
<p>Default: False</p>
</dd>
<dt><kbd>--make-tar</kbd></dt>
<dd><p>Build a tar of the root filesystem</p>
<p>Default: False</p>
</dd>
2019-04-17 19:12:11 +00:00
<dt><kbd>--make-tar-disk</kbd></dt>
<dd><p>Build a tar of a partitioned disk image</p>
<p>Default: False</p>
</dd>
2019-03-27 23:44:14 +00:00
<dt><kbd>--make-pxe-live</kbd></dt>
<dd><p>Build a live pxe boot squashfs image</p>
<p>Default: False</p>
</dd>
<dt><kbd>--make-ostree-live</kbd></dt>
<dd><p>Build a live pxe boot squashfs image of Atomic Host</p>
<p>Default: False</p>
</dd>
<dt><kbd>--make-oci</kbd></dt>
<dd><p>Build an Open Container Initiative image</p>
<p>Default: False</p>
</dd>
<dt><kbd>--make-vagrant</kbd></dt>
<dd><p>Build a Vagrant Box image</p>
<p>Default: False</p>
</dd>
<dt><kbd>--iso</kbd></dt>
<dd><p>Anaconda installation .iso path to use for qemu</p>
</dd>
<dt><kbd>--iso-only</kbd></dt>
<dd><p>Remove all iso creation artifacts except the boot.iso, combine with --iso-name to rename the boot.iso</p>
<p>Default: False</p>
</dd>
<dt><kbd>--iso-name</kbd></dt>
<dd><p>Name of output iso file for --iso-only. Default is boot.iso</p>
</dd>
<dt><kbd>--ks</kbd></dt>
<dd><p>Kickstart file defining the install.</p>
</dd>
<dt><kbd>--image-only</kbd></dt>
<dd><p>Exit after creating fs/disk image.</p>
<p>Default: False</p>
</dd>
<dt><kbd>--no-virt</kbd></dt>
<dd><p>Run anaconda directly on host instead of using qemu</p>
<p>Default: False</p>
</dd>
<dt><kbd>--proxy</kbd></dt>
<dd><p>proxy URL to use for the install</p>
</dd>
<dt><kbd>--anaconda-arg</kbd></dt>
<dd><p>Additional argument to pass to anaconda (no-virt mode). Pass once for each argument</p>
</dd>
<dt><kbd>--armplatform</kbd></dt>
<dd><p>the platform to use when creating images for ARM, i.e., highbank, mvebu, omap, tegra, etc.</p>
</dd>
<dt><kbd>--location</kbd></dt>
<dd><p>location of iso directory tree with initrd.img and vmlinuz. Used to run qemu with a newer initrd than the iso.</p>
</dd>
<dt><kbd>--logfile</kbd></dt>
<dd><p>Name and path for primary logfile, other logs will be created in the same directory.</p>
<p>Default: ./livemedia.log</p>
</dd>
<dt><kbd>--lorax-templates</kbd></dt>
<dd><p>Path to mako templates for lorax</p>
</dd>
<dt><kbd>--tmp</kbd></dt>
<dd><p>Top level temporary directory</p>
<p>Default: /var/tmp</p>
</dd>
<dt><kbd>--resultdir</kbd></dt>
<dd><p>Directory to copy the resulting images and iso into. Defaults to the temporary working directory</p>
</dd>
<dt><kbd>--macboot</kbd></dt>
2019-11-05 22:36:46 +00:00
<dd><p>Make the iso bootable on UEFI based Mac systems</p>
<p>Default: True</p>
2019-03-27 23:44:14 +00:00
</dd>
<dt><kbd>--nomacboot</kbd></dt>
2019-11-05 22:36:46 +00:00
<dd><p>Do not create a Mac bootable iso</p>
<p>Default: False</p>
2019-03-27 23:44:14 +00:00
</dd>
<dt><kbd>--extra-boot-args</kbd></dt>
<dd><p>Extra arguments to add to the bootloader kernel cmdline in the templates</p>
<p>Default: &quot;&quot;</p>
</dd>
<dt><kbd>--project</kbd></dt>
<dd><p>substituted for &#64;PROJECT&#64; in bootloader config files</p>
<p>Default: &quot;Linux&quot;</p>
</dd>
<dt><kbd>--releasever</kbd></dt>
<dd><p>substituted for &#64;VERSION&#64; in bootloader config files</p>
2021-12-11 00:02:04 +00:00
<p>Default: &quot;36&quot;</p>
2019-03-27 23:44:14 +00:00
</dd>
<dt><kbd>--volid</kbd></dt>
<dd><p>volume id</p>
</dd>
2019-07-29 22:17:38 +00:00
<dt><kbd>--squashfs-only</kbd></dt>
<dd><p>Use a plain squashfs filesystem for the runtime.</p>
<p>Default: False</p>
</dd>
2019-03-27 23:44:14 +00:00
<dt><kbd>--timeout</kbd></dt>
<dd><p>Cancel installer after X minutes</p>
</dd>
<dt><kbd>-V</kbd></dt>
<dd><p>show program's version number and exit</p>
</dd>
</dl>
2021-10-11 22:40:42 +00:00
</section>
<section id="disk/fs image arguments">
2018-08-13 23:43:20 +00:00
<h3>disk/fs image arguments<a class="headerlink" href="#disk/fs image arguments" title="Permalink to this headline"></a></h3>
2019-03-27 23:44:14 +00:00
<dl class="option-list">
<dt><kbd>--disk-image</kbd></dt>
<dd><p>Path to existing disk image to use for creating final image.</p>
</dd>
<dt><kbd>--keep-image</kbd></dt>
<dd><p>Keep raw disk image after .iso creation</p>
<p>Default: False</p>
</dd>
<dt><kbd>--fs-image</kbd></dt>
<dd><p>Path to existing filesystem image to use for creating final image.</p>
</dd>
<dt><kbd>--image-name</kbd></dt>
<dd><p>Name of output file to create. Used for tar, fs and disk image. Default is a random name.</p>
</dd>
2019-04-17 19:12:11 +00:00
<dt><kbd>--tar-disk-name</kbd></dt>
<dd><p>Name of the archive member for make-tar-disk.</p>
</dd>
2019-03-27 23:44:14 +00:00
<dt><kbd>--fs-label</kbd></dt>
<dd><p>Label to set on fsimage, default is 'Anaconda'</p>
<p>Default: &quot;Anaconda&quot;</p>
</dd>
2019-04-17 19:12:11 +00:00
<dt><kbd>--image-size-align</kbd></dt>
<dd><p>Create a disk image with a size that is a multiple of this value in MiB.</p>
<p>Default: 0</p>
</dd>
2019-03-27 23:44:14 +00:00
<dt><kbd>--image-type</kbd></dt>
<dd><p>Create an image with qemu-img. See qemu-img --help for supported formats.</p>
</dd>
<dt><kbd>--qemu-arg</kbd></dt>
<dd><p>Arguments to pass to qemu-img. Pass once for each argument, they will be used for ALL calls to qemu-img.</p>
<p>Default: []</p>
</dd>
<dt><kbd>--qcow2</kbd></dt>
<dd><p>Create qcow2 image instead of raw sparse image when making disk images.</p>
<p>Default: False</p>
</dd>
<dt><kbd>--qcow2-arg</kbd></dt>
<dd><p>Arguments to pass to qemu-img. Pass once for each argument, they will be used for ALL calls to qemu-img.</p>
<p>Default: []</p>
</dd>
<dt><kbd>--compression</kbd></dt>
<dd><p>Compression binary for make-tar. xz, lzma, gzip, and bzip2 are supported. xz is the default.</p>
<p>Default: &quot;xz&quot;</p>
</dd>
<dt><kbd>--compress-arg</kbd></dt>
<dd><p>Arguments to pass to compression. Pass once for each argument</p>
<p>Default: []</p>
</dd>
</dl>
2021-10-11 22:40:42 +00:00
</section>
<section id="appliance arguments">
2018-08-13 23:43:20 +00:00
<h3>appliance arguments<a class="headerlink" href="#appliance arguments" title="Permalink to this headline"></a></h3>
2019-03-27 23:44:14 +00:00
<dl class="option-list">
<dt><kbd>--app-name</kbd></dt>
<dd><p>Name of appliance to pass to template</p>
</dd>
<dt><kbd>--app-template</kbd></dt>
<dd><p>Path to template to use for appliance data.</p>
</dd>
<dt><kbd>--app-file</kbd></dt>
<dd><p>Appliance template results file.</p>
<p>Default: &quot;appliance.xml&quot;</p>
</dd>
</dl>
2021-10-11 22:40:42 +00:00
</section>
<section id="qemu arguments">
2018-08-13 23:43:20 +00:00
<h3>qemu arguments<a class="headerlink" href="#qemu arguments" title="Permalink to this headline"></a></h3>
2019-03-27 23:44:14 +00:00
<dl class="option-list">
<dt><kbd>--ram</kbd></dt>
<dd><p>Memory to allocate for installer in megabytes.</p>
<p>Default: 2048</p>
</dd>
<dt><kbd>--vcpus</kbd></dt>
<dd><p>Passed to qemu -smp command</p>
</dd>
<dt><kbd>--vnc</kbd></dt>
<dd><p>Passed to qemu -display command. eg. vnc=127.0.0.1:5, default is to choose the first unused vnc port.</p>
</dd>
<dt><kbd>--arch</kbd></dt>
<dd><p>System arch to build for. Used to select qemu-system-* command. Defaults to qemu-system-&lt;arch&gt;</p>
</dd>
<dt><kbd>--kernel-args</kbd></dt>
<dd><p>Additional argument to pass to the installation kernel</p>
</dd>
<dt><kbd>--ovmf-path</kbd></dt>
<dd><p>Path to OVMF firmware</p>
<p>Default: &quot;/usr/share/edk2/ovmf/&quot;</p>
</dd>
<dt><kbd>--virt-uefi</kbd></dt>
<dd><p>Use OVMF firmware to boot the VM in UEFI mode</p>
<p>Default: False</p>
</dd>
<dt><kbd>--no-kvm</kbd></dt>
<dd><p>Skip using kvm with qemu even if it is available.</p>
<p>Default: False</p>
</dd>
<dt><kbd>--with-rng</kbd></dt>
<dd><p>RNG device for QEMU (none for no RNG)</p>
<p>Default: &quot;/dev/random&quot;</p>
</dd>
</dl>
2021-10-11 22:40:42 +00:00
</section>
<section id="dracut arguments: (default: )">
2020-01-16 18:13:02 +00:00
<h3>dracut arguments: (default: )<a class="headerlink" href="#dracut arguments: (default: )" title="Permalink to this headline"></a></h3>
2019-03-27 23:44:14 +00:00
<dl class="option-list">
2020-01-16 18:13:02 +00:00
<dt><kbd>--dracut-conf</kbd></dt>
<dd><p>Path to a dracut.conf file to use instead of the default arguments. See the dracut.conf(5) manpage.</p>
</dd>
2019-03-27 23:44:14 +00:00
<dt><kbd>--dracut-arg</kbd></dt>
2020-01-16 18:13:02 +00:00
<dd><p>Argument to pass to dracut when rebuilding the initramfs. Pass this once for each argument. NOTE: this overrides the defaults.</p>
2019-03-27 23:44:14 +00:00
</dd>
</dl>
2021-10-11 22:40:42 +00:00
</section>
<section id="pxe to live arguments">
2018-08-13 23:43:20 +00:00
<h3>pxe to live arguments<a class="headerlink" href="#pxe to live arguments" title="Permalink to this headline"></a></h3>
2019-03-27 23:44:14 +00:00
<dl class="option-list">
<dt><kbd>--live-rootfs-size</kbd></dt>
<dd><p>Size of root filesystem of live image in GiB</p>
<p>Default: 0</p>
</dd>
<dt><kbd>--live-rootfs-keep-size</kbd></dt>
<dd><p>Keep the original size of root filesystem in live image</p>
<p>Default: False</p>
</dd>
</dl>
2021-10-11 22:40:42 +00:00
</section>
<section id="OCI arguments">
2018-08-13 23:43:20 +00:00
<h3>OCI arguments<a class="headerlink" href="#OCI arguments" title="Permalink to this headline"></a></h3>
2019-03-27 23:44:14 +00:00
<dl class="option-list">
<dt><kbd>--oci-config</kbd></dt>
<dd><p>config.json OCI configuration file</p>
</dd>
<dt><kbd>--oci-runtime</kbd></dt>
<dd><p>runtime.json OCI configuration file</p>
</dd>
</dl>
2021-10-11 22:40:42 +00:00
</section>
<section id="Vagrant arguments">
2018-08-13 23:43:20 +00:00
<h3>Vagrant arguments<a class="headerlink" href="#Vagrant arguments" title="Permalink to this headline"></a></h3>
2019-03-27 23:44:14 +00:00
<dl class="option-list">
<dt><kbd>--vagrant-metadata</kbd></dt>
<dd><p>optional metadata.json file</p>
</dd>
<dt><kbd>--vagrantfile</kbd></dt>
<dd><p>optional vagrantfile</p>
</dd>
</dl>
2021-10-11 22:40:42 +00:00
</section>
</section>
<section id="quickstart">
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline"></a></h2>
<p>Run this to create a bootable live iso:</p>
2018-05-12 00:18:21 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">livemedia</span><span class="o">-</span><span class="n">creator</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">iso</span> \
2016-11-29 17:27:44 +00:00
<span class="o">--</span><span class="n">iso</span><span class="o">=/</span><span class="n">extra</span><span class="o">/</span><span class="n">iso</span><span class="o">/</span><span class="n">boot</span><span class="o">.</span><span class="n">iso</span> <span class="o">--</span><span class="n">ks</span><span class="o">=./</span><span class="n">docs</span><span class="o">/</span><span class="n">fedora</span><span class="o">-</span><span class="n">livemedia</span><span class="o">.</span><span class="n">ks</span>
</pre></div>
</div>
<p>You can run it directly from the lorax git repo like this:</p>
2018-05-12 00:18:21 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>sudo PATH=./src/sbin/:$PATH PYTHONPATH=./src/ ./src/sbin/livemedia-creator \
--make-iso --iso=/extra/iso/boot.iso \
--ks=./docs/fedora-livemedia.ks --lorax-templates=./share/
</pre></div>
</div>
2016-03-18 23:30:48 +00:00
<p>You can observe the installation using vnc. The logs will show what port was
2018-05-12 00:18:21 +00:00
chosen, or you can use a specific port by passing it. eg. <code class="docutils literal notranslate"><span class="pre">--vnc</span> <span class="pre">vnc:127.0.0.1:5</span></code></p>
<p>This is usually a good idea when testing changes to the kickstart. lmc tries
to monitor the logs for fatal errors, but may not catch everything.</p>
2021-10-11 22:40:42 +00:00
</section>
<section id="how-iso-creation-works">
<h2>How ISO creation works<a class="headerlink" href="#how-iso-creation-works" title="Permalink to this headline"></a></h2>
<p>There are 2 stages, the install stage which produces a disk or filesystem image
as its output, and the boot media creation which uses the image as its input.
Normally you would run both stages, but it is possible to stop after the
2018-05-12 00:18:21 +00:00
install stage, by using <code class="docutils literal notranslate"><span class="pre">--image-only</span></code>, or to skip the install stage and use
a previously created disk image by passing <code class="docutils literal notranslate"><span class="pre">--disk-image</span></code> or <code class="docutils literal notranslate"><span class="pre">--fs-image</span></code></p>
2016-03-18 23:30:48 +00:00
<p>When creating an iso qemu boots using the passed Anaconda installer iso
2018-05-12 00:18:21 +00:00
and installs the system based on the kickstart. The <code class="docutils literal notranslate"><span class="pre">%post</span></code> section of the
kickstart is used to customize the installed system in the same way that
current spin-kickstarts do.</p>
<p>livemedia-creator monitors the install process for problems by watching the
install logs. They are written to the current directory or to the base
2019-03-27 23:44:14 +00:00
directory specified by the --logfile command. You can also monitor the install
2016-03-18 23:30:48 +00:00
by using a vnc client. This is recommended when first modifying a kickstart,
since there are still places where Anaconda may get stuck without the log
monitor catching it.</p>
<p>The output from this process is a partitioned disk image. kpartx can be used
to mount and examine it when there is a problem with the install. It can also
be booted using kvm.</p>
2019-03-27 23:44:14 +00:00
<p>When creating an iso the disk image's / partition is copied into a formatted
2016-03-18 23:30:48 +00:00
filesystem image which is then used as the input to lorax for creation of the
final media.</p>
<p>The final image is created by lorax, using the templates in /usr/share/lorax/live/
2018-05-12 00:18:21 +00:00
or the live directory below the directory specified by <code class="docutils literal notranslate"><span class="pre">--lorax-templates</span></code>. The
2016-03-18 23:30:48 +00:00
templates are written using the Mako template system with some extra commands
added by lorax.</p>
2016-02-13 00:06:33 +00:00
<div class="admonition note">
2019-03-27 23:44:14 +00:00
<p class="admonition-title">Note</p>
<p>The output from --make-iso includes the artifacts used to create the boot.iso;
2016-02-13 00:06:33 +00:00
the kernel, initrd, the squashfs filesystem, etc. If you only want the
2018-05-12 00:18:21 +00:00
boot.iso you can pass <code class="docutils literal notranslate"><span class="pre">--iso-only</span></code> and the other files will be removed. You
can also name the iso by using <code class="docutils literal notranslate"><span class="pre">--iso-name</span> <span class="pre">my-live.iso</span></code>.</p>
2016-02-13 00:06:33 +00:00
</div>
2021-10-11 22:40:42 +00:00
</section>
<section id="kickstarts">
<h2>Kickstarts<a class="headerlink" href="#kickstarts" title="Permalink to this headline"></a></h2>
<p>The docs/ directory includes several example kickstarts, one to create a live
desktop iso using GNOME, and another to create a minimal disk image. When
creating your own kickstarts you should start with the minimal example, it
includes several needed packages that are not always included by dependencies.</p>
<p>Or you can use existing spin kickstarts to create live media with a few
changes. Here are the steps I used to convert the Fedora XFCE spin.</p>
<ol class="arabic">
2019-03-27 23:44:14 +00:00
<li><p>Flatten the xfce kickstart using ksflatten</p></li>
<li><p>Add zerombr so you don't get the disk init dialog</p></li>
<li><p>Add clearpart --all</p></li>
<li><p>Add swap partition</p></li>
<li><p>bootloader target</p></li>
<li><p>Add shutdown to the kickstart</p></li>
<li><p>Add network --bootproto=dhcp --activate to activate the network
This works for F16 builds but for F15 and before you need to pass
something on the cmdline that activate the network, like sshd:</p>
<blockquote>
2018-05-12 00:18:21 +00:00
<div><p><code class="docutils literal notranslate"><span class="pre">livemedia-creator</span> <span class="pre">--kernel-args=&quot;sshd&quot;</span></code></p>
</div></blockquote>
</li>
2019-03-27 23:44:14 +00:00
<li><p>Add a root password:</p>
2018-05-12 00:18:21 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">rootpw</span> <span class="n">rootme</span>
2016-11-29 17:27:44 +00:00
<span class="n">network</span> <span class="o">--</span><span class="n">bootproto</span><span class="o">=</span><span class="n">dhcp</span> <span class="o">--</span><span class="n">activate</span>
<span class="n">zerombr</span>
<span class="n">clearpart</span> <span class="o">--</span><span class="nb">all</span>
<span class="n">bootloader</span> <span class="o">--</span><span class="n">location</span><span class="o">=</span><span class="n">mbr</span>
<span class="n">part</span> <span class="n">swap</span> <span class="o">--</span><span class="n">size</span><span class="o">=</span><span class="mi">512</span>
<span class="n">shutdown</span>
</pre></div>
</div>
</li>
2019-03-27 23:44:14 +00:00
<li><p>In the livesys script section of the %post remove the root password. This
really depends on how the spin wants to work. You could add the live user
that you create to the %wheel group so that sudo works if you wanted to.</p>
<blockquote>
2018-05-12 00:18:21 +00:00
<div><p><code class="docutils literal notranslate"><span class="pre">passwd</span> <span class="pre">-d</span> <span class="pre">root</span> <span class="pre">&gt;</span> <span class="pre">/dev/null</span></code></p>
</div></blockquote>
</li>
2019-03-27 23:44:14 +00:00
<li><p>Remove /etc/fstab in %post, dracut handles mounting the rootfs</p>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">cat</span> <span class="pre">/dev/null</span> <span class="pre">&gt;</span> <span class="pre">/dev/fstab</span></code></p>
2019-03-27 23:44:14 +00:00
<p>Do this only for live iso's, the filesystem will be mounted read only if
there is no /etc/fstab</p>
</li>
2019-03-27 23:44:14 +00:00
<li><p>Don't delete initramfs files from /boot in %post</p></li>
<li><p>When creating live iso's you need to have, at least, these packages in the %package section::
2015-10-07 18:25:53 +00:00
dracut-config-generic
dracut-live
-dracut-config-rescue
2018-06-04 23:27:56 +00:00
grub2-efi
2019-03-27 23:44:14 +00:00
syslinux</p></li>
</ol>
2021-10-11 22:40:42 +00:00
<section id="user-created-repositories">
2018-06-04 23:27:56 +00:00
<h3>User created repositories<a class="headerlink" href="#user-created-repositories" title="Permalink to this headline"></a></h3>
<p>If you are using your own repositories and installing groups (eg. &#64;core) make
sure you create the repodata with groups like this <code class="docutils literal notranslate"><span class="pre">createrepo</span> <span class="pre">-g</span>
<span class="pre">/path/to/groups.xml</span> <span class="pre">/path/to/rpms</span></code></p>
2021-10-11 22:40:42 +00:00
</section>
<section id="using-a-proxy-with-repos">
2018-06-04 23:27:56 +00:00
<h3>Using a Proxy with repos<a class="headerlink" href="#using-a-proxy-with-repos" title="Permalink to this headline"></a></h3>
2016-03-18 23:30:48 +00:00
<p>One drawback to using qemu is that it pulls the packages from the repo each
time you run it. To speed things up you either need a local mirror of the
packages, or you can use a caching proxy. When using a proxy you pass it to
livemedia-creator like this:</p>
<blockquote>
2019-03-27 23:44:14 +00:00
<div><p><code class="docutils literal notranslate"><span class="pre">--proxy=http://proxy.yourdomain.com:3128</span></code></p>
</div></blockquote>
<p>You also need to use a specific mirror instead of mirrormanager so that the
packages will get cached, so your kickstart url would look like:</p>
<blockquote>
2019-03-27 23:44:14 +00:00
<div><p><code class="docutils literal notranslate"><span class="pre">url</span> <span class="pre">--url=&quot;http://dl.fedoraproject.org/pub/fedora/linux/development/rawhide/x86_64/os/&quot;</span></code></p>
</div></blockquote>
<p>You can also add an update repo, but don't name it updates. Add --proxy to it
2018-06-04 23:27:56 +00:00
as well. You can use all of the <a class="reference external" href="https://pykickstart.readthedocs.io/en/latest/kickstart-docs.html#chapter-2-kickstart-commands-in-fedora">kickstart commands</a> in your kickstart. Make sure there
is only one <code class="docutils literal notranslate"><span class="pre">url</span></code> command, other repos have to use the <code class="docutils literal notranslate"><span class="pre">repo</span></code> command and cannot be
2019-03-27 23:44:14 +00:00
named <code class="docutils literal notranslate"><span class="pre">updates</span></code> which is reserved for Anaconda's use. eg.:</p>
2018-06-04 23:27:56 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">url</span> <span class="o">--</span><span class="n">url</span><span class="o">=</span><span class="n">PRIMARY</span><span class="o">-</span><span class="n">REPO</span><span class="o">-</span><span class="n">URL</span> <span class="o">--</span><span class="n">proxy</span><span class="o">=</span><span class="n">PROXY</span><span class="o">-</span><span class="n">URL</span>
<span class="n">repo</span> <span class="o">--</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;repo1&quot;</span> <span class="o">--</span><span class="n">baseurl</span><span class="o">=</span><span class="n">FIRST</span><span class="o">-</span><span class="n">REPO</span><span class="o">-</span><span class="n">URL</span> <span class="o">--</span><span class="n">proxy</span><span class="o">=</span><span class="n">PROXY</span><span class="o">-</span><span class="n">URL</span>
<span class="n">repo</span> <span class="o">--</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;repo2&quot;</span> <span class="o">--</span><span class="n">baseurl</span><span class="o">=</span><span class="n">SECOND</span><span class="o">-</span><span class="n">REPO_URL</span> <span class="o">--</span><span class="n">proxy</span><span class="o">=</span><span class="n">PROXY</span><span class="o">-</span><span class="n">URL</span>
</pre></div>
</div>
2021-10-11 22:40:42 +00:00
</section>
</section>
<section id="anaconda-image-install-no-virt">
<h2>Anaconda image install (no-virt)<a class="headerlink" href="#anaconda-image-install-no-virt" title="Permalink to this headline"></a></h2>
2018-05-12 00:18:21 +00:00
<p>You can create images without using qemu by passing <code class="docutils literal notranslate"><span class="pre">--no-virt</span></code> on the
2019-03-27 23:44:14 +00:00
cmdline. This will use Anaconda's directory install feature to handle the
2016-03-18 23:30:48 +00:00
install. There are a couple of things to keep in mind when doing this:</p>
<ol class="arabic simple">
2019-03-27 23:44:14 +00:00
<li><p>It will be most reliable when building images for the same release that the
host is running. Because Anaconda has expectations about the system it is
running under you may encounter strange bugs if you try to build newer or
2019-03-27 23:44:14 +00:00
older releases.</p></li>
<li><p>It may totally trash your host. So far I haven't had this happen, but the
possibility exists that a bug in Anaconda could result in it operating on
real devices. I recommend running it in a virt or on a system that you can
2019-03-27 23:44:14 +00:00
afford to lose all data from.</p></li>
</ol>
<p>The logs from anaconda will be placed in an ./anaconda/ directory in either
2019-03-27 23:44:14 +00:00
the current directory or in the directory used for --logfile</p>
<p>Example cmdline:</p>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">livemedia-creator</span> <span class="pre">--make-iso</span> <span class="pre">--no-virt</span> <span class="pre">--ks=./fedora-livemedia.ks</span></code></p>
2015-12-04 18:12:19 +00:00
<div class="admonition note">
2019-03-27 23:44:14 +00:00
<p class="admonition-title">Note</p>
<p>Using no-virt to create a partitioned disk image (eg. --make-disk or
--make-vagrant) will only create disks usable on the host platform (BIOS
2015-12-04 18:12:19 +00:00
or UEFI). You can create BIOS partitioned disk images on UEFI by using
virt.</p>
</div>
2018-11-13 17:53:31 +00:00
<div class="admonition note">
2019-03-27 23:44:14 +00:00
<p class="admonition-title">Note</p>
<p>As of version 30.7 SELinux can be set to Enforcing. The current state is
2018-11-13 17:53:31 +00:00
logged for debugging purposes and if there are SELinux denials they should
be reported as a bug.</p>
</div>
2021-10-11 22:40:42 +00:00
</section>
<section id="ami-images">
<h2>AMI Images<a class="headerlink" href="#ami-images" title="Permalink to this headline"></a></h2>
2019-03-27 23:44:14 +00:00
<p>Amazon EC2 images can be created by using the --make-ami switch and an appropriate
kickstart file. All of the work to customize the image is handled by the kickstart.
The example currently included was modified from the cloud-kickstarts version so
that it would work with livemedia-creator.</p>
<p>Example cmdline:</p>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">livemedia-creator</span> <span class="pre">--make-ami</span> <span class="pre">--iso=/path/to/boot.iso</span> <span class="pre">--ks=./docs/fedora-livemedia-ec2.ks</span></code></p>
<p>This will produce an ami-root.img file in the working directory.</p>
<p>At this time I have not tested the image with EC2. Feedback would be welcome.</p>
2021-10-11 22:40:42 +00:00
</section>
<section id="appliance-creation">
<h2>Appliance Creation<a class="headerlink" href="#appliance-creation" title="Permalink to this headline"></a></h2>
2019-03-27 23:44:14 +00:00
<p>livemedia-creator can now replace appliance-tools by using the --make-appliance
switch. This will create the partitioned disk image and an XML file that can be
used with virt-image to setup a virtual system.</p>
<p>The XML is generated using the Mako template from
/usr/share/lorax/appliance/libvirt.xml You can use a different template by
2018-05-12 00:18:21 +00:00
passing <code class="docutils literal notranslate"><span class="pre">--app-template</span> <span class="pre">&lt;template</span> <span class="pre">path&gt;</span></code></p>
<p>Documentation on the Mako template system can be found at the <a class="reference external" href="http://docs.makotemplates.org/en/latest/index.html">Mako site</a></p>
<p>The name of the final output XML is appliance.xml, this can be changed with
2018-05-12 00:18:21 +00:00
<code class="docutils literal notranslate"><span class="pre">--app-file</span> <span class="pre">&lt;file</span> <span class="pre">path&gt;</span></code></p>
<p>The following variables are passed to the template:</p>
<blockquote>
2019-03-27 23:44:14 +00:00
<div><dl>
<dt><code class="docutils literal notranslate"><span class="pre">disks</span></code></dt><dd><p>A list of disk_info about each disk.
Each entry has the following attributes:</p>
2019-03-27 23:44:14 +00:00
<blockquote>
2018-05-12 00:18:21 +00:00
<div><p><code class="docutils literal notranslate"><span class="pre">name</span></code>
base name of the disk image file</p>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">format</span></code>
2019-03-27 23:44:14 +00:00
&quot;raw&quot;</p>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">checksum_type</span></code>
2019-03-27 23:44:14 +00:00
&quot;sha256&quot;</p>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">checksum</span></code>
sha256 checksum of the disk image</p>
</div></blockquote>
</dd>
</dl>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">name</span></code>
2019-03-27 23:44:14 +00:00
Name of appliance, from --app-name argument</p>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">arch</span></code>
Architecture</p>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">memory</span></code>
Memory in KB (from <code class="docutils literal notranslate"><span class="pre">--ram</span></code>)</p>
<p><code class="docutils literal notranslate"><span class="pre">vcpus</span></code>
from <code class="docutils literal notranslate"><span class="pre">--vcpus</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">networks</span></code>
list of networks from the kickstart or []</p>
2018-05-12 00:18:21 +00:00
<p><code class="docutils literal notranslate"><span class="pre">project</span></code>
from <code class="docutils literal notranslate"><span class="pre">--project</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">releasever</span></code>
from <code class="docutils literal notranslate"><span class="pre">--releasever</span></code></p>
</div></blockquote>
<p>The created image can be imported into libvirt using:</p>
<blockquote>
2019-03-27 23:44:14 +00:00
<div><p><code class="docutils literal notranslate"><span class="pre">virt-image</span> <span class="pre">appliance.xml</span></code></p>
</div></blockquote>
2018-05-12 00:18:21 +00:00
<p>You can also create qcow2 appliance images using <code class="docutils literal notranslate"><span class="pre">--image-type=qcow2</span></code>, for example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">livemedia</span><span class="o">-</span><span class="n">creator</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">appliance</span> <span class="o">--</span><span class="n">iso</span><span class="o">=/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">boot</span><span class="o">.</span><span class="n">iso</span> <span class="o">--</span><span class="n">ks</span><span class="o">=./</span><span class="n">docs</span><span class="o">/</span><span class="n">fedora</span><span class="o">-</span><span class="n">minimal</span><span class="o">.</span><span class="n">ks</span> \
2016-11-29 17:27:44 +00:00
<span class="o">--</span><span class="n">image</span><span class="o">-</span><span class="nb">type</span><span class="o">=</span><span class="n">qcow2</span> <span class="o">--</span><span class="n">app</span><span class="o">-</span><span class="n">file</span><span class="o">=</span><span class="n">minimal</span><span class="o">-</span><span class="n">test</span><span class="o">.</span><span class="n">xml</span> <span class="o">--</span><span class="n">image</span><span class="o">-</span><span class="n">name</span><span class="o">=</span><span class="n">minimal</span><span class="o">-</span><span class="n">test</span><span class="o">.</span><span class="n">img</span>
</pre></div>
</div>
2021-10-11 22:40:42 +00:00
</section>
<section id="filesystem-image-creation">
<h2>Filesystem Image Creation<a class="headerlink" href="#filesystem-image-creation" title="Permalink to this headline"></a></h2>
2016-03-18 23:30:48 +00:00
<p>livemedia-creator can be used to create un-partitined filesystem images using
2018-05-12 00:18:21 +00:00
the <code class="docutils literal notranslate"><span class="pre">--make-fsimage</span></code> option. As of version 21.8 this works with both qemu and
2016-03-18 23:30:48 +00:00
no-virt modes of operation. Previously it was only available with no-virt.</p>
<p>Kickstarts should have a single / partition with no extra mountpoints.</p>
<blockquote>
2019-03-27 23:44:14 +00:00
<div><p><code class="docutils literal notranslate"><span class="pre">livemedia-creator</span> <span class="pre">--make-fsimage</span> <span class="pre">--iso=/path/to/boot.iso</span> <span class="pre">--ks=./docs/fedora-minimal.ks</span></code></p>
</div></blockquote>
2018-05-12 00:18:21 +00:00
<p>You can name the output image with <code class="docutils literal notranslate"><span class="pre">--image-name</span></code> and set a label on the filesystem with <code class="docutils literal notranslate"><span class="pre">--fs-label</span></code></p>
2021-10-11 22:40:42 +00:00
</section>
<section id="tar-file-creation">
<h2>TAR File Creation<a class="headerlink" href="#tar-file-creation" title="Permalink to this headline"></a></h2>
2018-05-12 00:18:21 +00:00
<p>The <code class="docutils literal notranslate"><span class="pre">--make-tar</span></code> command can be used to create a tar of the root filesystem. By
default it is compressed using xz, but this can be changed using the
2018-05-12 00:18:21 +00:00
<code class="docutils literal notranslate"><span class="pre">--compression</span></code> and <code class="docutils literal notranslate"><span class="pre">--compress-arg</span></code> options. This option works with both virt and
no-virt install methods.</p>
2018-05-12 00:18:21 +00:00
<p>As with <code class="docutils literal notranslate"><span class="pre">--make-fsimage</span></code> the kickstart should be limited to a single / partition.</p>
<p>For example:</p>
2018-05-12 00:18:21 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">livemedia</span><span class="o">-</span><span class="n">creator</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">tar</span> <span class="o">--</span><span class="n">iso</span><span class="o">=/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">boot</span><span class="o">.</span><span class="n">iso</span> <span class="o">--</span><span class="n">ks</span><span class="o">=./</span><span class="n">docs</span><span class="o">/</span><span class="n">fedora</span><span class="o">-</span><span class="n">minimal</span><span class="o">.</span><span class="n">ks</span> \
2016-11-29 17:27:44 +00:00
<span class="o">--</span><span class="n">image</span><span class="o">-</span><span class="n">name</span><span class="o">=</span><span class="n">fedora</span><span class="o">-</span><span class="n">root</span><span class="o">.</span><span class="n">tar</span><span class="o">.</span><span class="n">xz</span>
</pre></div>
</div>
2021-10-11 22:40:42 +00:00
</section>
<section id="live-image-for-pxe-boot">
<h2>Live Image for PXE Boot<a class="headerlink" href="#live-image-for-pxe-boot" title="Permalink to this headline"></a></h2>
2018-05-12 00:18:21 +00:00
<p>The <code class="docutils literal notranslate"><span class="pre">--make-pxe-live</span></code> command will produce squashfs image containing live root
filesystem that can be used for pxe boot. Directory with results will contain
the live image, kernel image, initrd image and template of pxe configuration
for the images.</p>
2021-10-11 22:40:42 +00:00
</section>
<section id="atomic-live-image-for-pxe-boot">
<h2>Atomic Live Image for PXE Boot<a class="headerlink" href="#atomic-live-image-for-pxe-boot" title="Permalink to this headline"></a></h2>
2018-05-12 00:18:21 +00:00
<p>The <code class="docutils literal notranslate"><span class="pre">--make-ostree-live</span></code> command will produce the same result as <code class="docutils literal notranslate"><span class="pre">--make-pxe-live</span></code>
for installations of Atomic Host. Example kickstart for such an installation
using Atomic installer iso with local repo included in the image can be found
in docs/rhel-atomic-pxe-live.ks.</p>
2018-05-12 00:18:21 +00:00
<p>The PXE images can also be created with <code class="docutils literal notranslate"><span class="pre">--no-virt</span></code> by using the example
2016-05-23 23:55:51 +00:00
kickstart in docs/fedora-atomic-pxe-live-novirt.ks. This also works inside the
mock environment.</p>
2021-10-11 22:40:42 +00:00
</section>
<section id="using-mock-and-no-virt-to-create-images">
2019-03-27 23:44:14 +00:00
<h2>Using Mock and --no-virt to Create Images<a class="headerlink" href="#using-mock-and-no-virt-to-create-images" title="Permalink to this headline"></a></h2>
<p>As of lorax version 22.2 you can use livemedia-creator and anaconda version
2019-03-27 23:44:14 +00:00
22.15 inside of a mock chroot with --make-iso and --make-fsimage.</p>
2015-10-07 18:25:53 +00:00
<div class="admonition note">
2019-03-27 23:44:14 +00:00
<p class="admonition-title">Note</p>
2020-02-12 21:24:33 +00:00
<p>As of mock version 2.0 you no longer need to pass <code class="docutils literal notranslate"><span class="pre">--old-chroot</span></code>. You will,
however, need to pass <code class="docutils literal notranslate"><span class="pre">--enable-network</span></code> so that the mock container can download
packages.</p>
<p>Older versions of mock, between 1.3.4 and 2.0, will need to pass
<code class="docutils literal notranslate"><span class="pre">--old-chroot</span></code> with mock. These versions of mock now default to using
systemd-nspawn which cannot create the needed loop device nodes. Passing
<code class="docutils literal notranslate"><span class="pre">--old-chroot</span></code> will use the old system where <code class="docutils literal notranslate"><span class="pre">/dev/loop*</span></code> is setup for
you.</p>
2015-10-07 18:25:53 +00:00
</div>
<p>On the host system:</p>
<ol class="arabic">
2019-03-27 23:44:14 +00:00
<li><p>yum install -y mock</p></li>
<li><p>Add a user to the mock group to use for running mock. eg. builder</p></li>
<li><p>Create a new /etc/mock/ config file based on the rawhide one, or modify the
existing one so that the following options are setup:</p>
2018-05-12 00:18:21 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">config_opts</span><span class="p">[</span><span class="s1">&#39;chroot_setup_cmd&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;install @buildsys-build anaconda-tui lorax&#39;</span>
2016-05-23 23:55:51 +00:00
<span class="c1"># build results go into /home/builder/results/</span>
<span class="n">config_opts</span><span class="p">[</span><span class="s1">&#39;plugin_conf&#39;</span><span class="p">][</span><span class="s1">&#39;bind_mount_opts&#39;</span><span class="p">][</span><span class="s1">&#39;dirs&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s1">&#39;/home/builder/results&#39;</span><span class="p">,</span><span class="s1">&#39;/results/&#39;</span><span class="p">))</span>
</pre></div>
</div>
2015-10-07 18:25:53 +00:00
<p>If you are creating images for a branched release of Fedora you should also enable
the updates-testing repository so that you get the latest builds in your mock chroot.</p>
</li>
</ol>
<p>The following steps are run as the builder user who is a member of the mock
group.</p>
2015-10-07 18:25:53 +00:00
<ol class="arabic" start="4">
2019-03-27 23:44:14 +00:00
<li><p>Make a directory for results matching the bind mount above
<code class="docutils literal notranslate"><span class="pre">mkdir</span> <span class="pre">~/results/</span></code></p></li>
<li><p>Copy the example kickstarts
<code class="docutils literal notranslate"><span class="pre">cp</span> <span class="pre">/usr/share/docs/lorax/*ks</span> <span class="pre">.</span></code></p></li>
<li><p>Make sure tar and dracut-network are in the %packages section and that the
<code class="docutils literal notranslate"><span class="pre">url</span> <span class="pre">points</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">correct</span> <span class="pre">repo</span></code></p></li>
<li><p>Init the mock
2020-02-12 21:24:33 +00:00
<code class="docutils literal notranslate"><span class="pre">mock</span> <span class="pre">-r</span> <span class="pre">fedora-rawhide-x86_64</span> <span class="pre">--init</span></code></p></li>
2019-03-27 23:44:14 +00:00
<li><p>Copy the kickstart inside the mock
2020-02-12 21:24:33 +00:00
<code class="docutils literal notranslate"><span class="pre">mock</span> <span class="pre">-r</span> <span class="pre">fedora-rawhide-x86_64</span> <span class="pre">--copyin</span> <span class="pre">./fedora-minimal.ks</span> <span class="pre">/root/</span></code></p></li>
2019-03-27 23:44:14 +00:00
<li><p>Make a minimal iso:</p>
2020-02-12 21:24:33 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mock</span> <span class="o">-</span><span class="n">r</span> <span class="n">fedora</span><span class="o">-</span><span class="n">rawhide</span><span class="o">-</span><span class="n">x86_64</span> <span class="o">--</span><span class="n">enable</span><span class="o">-</span><span class="n">network</span> <span class="o">--</span><span class="n">chroot</span> <span class="o">--</span> <span class="n">livemedia</span><span class="o">-</span><span class="n">creator</span> <span class="o">--</span><span class="n">no</span><span class="o">-</span><span class="n">virt</span> \
2016-11-29 17:27:44 +00:00
<span class="o">--</span><span class="n">resultdir</span><span class="o">=/</span><span class="n">results</span><span class="o">/</span><span class="k">try</span><span class="o">-</span><span class="mi">1</span> <span class="o">--</span><span class="n">logfile</span><span class="o">=/</span><span class="n">results</span><span class="o">/</span><span class="n">logs</span><span class="o">/</span><span class="k">try</span><span class="o">-</span><span class="mi">1</span><span class="o">/</span><span class="k">try</span><span class="o">-</span><span class="mf">1.</span><span class="n">log</span> \
<span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">iso</span> <span class="o">--</span><span class="n">ks</span> <span class="o">/</span><span class="n">root</span><span class="o">/</span><span class="n">fedora</span><span class="o">-</span><span class="n">minimal</span><span class="o">.</span><span class="n">ks</span>
</pre></div>
</div>
</li>
</ol>
<p>Results will be in ./results/try-1 and logs under /results/logs/try-1/
including anaconda logs and livemedia-creator logs. The new iso will be
located at ~/results/try-1/images/boot.iso, and the ~/results/try-1/
directory tree will also contain the vmlinuz, initrd, etc.</p>
2021-10-11 22:40:42 +00:00
</section>
<section id="using-mock-and-qemu-to-create-images">
2016-03-18 23:30:48 +00:00
<h2>Using Mock and qemu to Create Images<a class="headerlink" href="#using-mock-and-qemu-to-create-images" title="Permalink to this headline"></a></h2>
<p>Version 25.0 of livemedia-creator switches to using qemu for virtualization.
This allows creation of all image types, and use of the KVM on the host if
/dev/kvm is present in the mock environment.</p>
<p>On the host system:</p>
<ol class="arabic">
2019-03-27 23:44:14 +00:00
<li><p>yum install -y mock</p></li>
<li><p>Add a user to the mock group to use for running mock. eg. builder</p></li>
<li><p>Create a new /etc/mock/ config file based on the rawhide one, or modify the
2016-03-18 23:30:48 +00:00
existing one so that the following options are setup:</p>
2018-05-12 00:18:21 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">config_opts</span><span class="p">[</span><span class="s1">&#39;chroot_setup_cmd&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;install @buildsys-build lorax qemu&#39;</span>
2016-03-18 23:30:48 +00:00
2016-05-23 23:55:51 +00:00
<span class="c1"># build results go into /home/builder/results/</span>
<span class="n">config_opts</span><span class="p">[</span><span class="s1">&#39;plugin_conf&#39;</span><span class="p">][</span><span class="s1">&#39;bind_mount_opts&#39;</span><span class="p">][</span><span class="s1">&#39;dirs&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="s1">&#39;/home/builder/results&#39;</span><span class="p">,</span><span class="s1">&#39;/results/&#39;</span><span class="p">))</span>
2016-03-18 23:30:48 +00:00
</pre></div>
</div>
<p>If you are creating images for a branched release of Fedora you should also enable
the updates-testing repository so that you get the latest builds in your mock chroot.</p>
</li>
</ol>
<p>The following steps are run as the builder user who is a member of the mock
group.</p>
<ol class="arabic" start="4">
2019-03-27 23:44:14 +00:00
<li><p>Make a directory for results matching the bind mount above
<code class="docutils literal notranslate"><span class="pre">mkdir</span> <span class="pre">~/results/</span></code></p></li>
<li><p>Copy the example kickstarts
<code class="docutils literal notranslate"><span class="pre">cp</span> <span class="pre">/usr/share/docs/lorax/*ks</span> <span class="pre">.</span></code></p></li>
<li><p>Make sure tar and dracut-network are in the %packages section and that the
<code class="docutils literal notranslate"><span class="pre">url</span> <span class="pre">points</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">correct</span> <span class="pre">repo</span></code></p></li>
<li><p>Init the mock
2020-02-12 21:24:33 +00:00
<code class="docutils literal notranslate"><span class="pre">mock</span> <span class="pre">-r</span> <span class="pre">fedora-rawhide-x86_64</span> <span class="pre">--init</span></code></p></li>
2019-03-27 23:44:14 +00:00
<li><p>Copy the kickstart inside the mock
2020-02-12 21:24:33 +00:00
<code class="docutils literal notranslate"><span class="pre">mock</span> <span class="pre">-r</span> <span class="pre">fedora-rawhide-x86_64</span> <span class="pre">--copyin</span> <span class="pre">./fedora-minimal.ks</span> <span class="pre">/root/</span></code></p></li>
2019-03-27 23:44:14 +00:00
<li><p>Copy the Anaconda boot.iso inside the mock
2020-02-12 21:24:33 +00:00
<code class="docutils literal notranslate"><span class="pre">mock</span> <span class="pre">-r</span> <span class="pre">fedora-rawhide-x86_64</span> <span class="pre">--copyin</span> <span class="pre">./boot.iso</span> <span class="pre">/root/</span></code></p></li>
2019-03-27 23:44:14 +00:00
<li><p>Make a minimal iso:</p>
2020-02-12 21:24:33 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mock</span> <span class="o">-</span><span class="n">r</span> <span class="n">fedora</span><span class="o">-</span><span class="n">rawhide</span><span class="o">-</span><span class="n">x86_64</span> <span class="o">--</span><span class="n">enable</span><span class="o">-</span><span class="n">network</span> <span class="o">--</span><span class="n">chroot</span> <span class="o">--</span> <span class="n">livemedia</span><span class="o">-</span><span class="n">creator</span> \
2016-11-29 17:27:44 +00:00
<span class="o">--</span><span class="n">resultdir</span><span class="o">=/</span><span class="n">results</span><span class="o">/</span><span class="k">try</span><span class="o">-</span><span class="mi">1</span> <span class="o">--</span><span class="n">logfile</span><span class="o">=/</span><span class="n">results</span><span class="o">/</span><span class="n">logs</span><span class="o">/</span><span class="k">try</span><span class="o">-</span><span class="mi">1</span><span class="o">/</span><span class="k">try</span><span class="o">-</span><span class="mf">1.</span><span class="n">log</span> \
<span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">iso</span> <span class="o">--</span><span class="n">ks</span> <span class="o">/</span><span class="n">root</span><span class="o">/</span><span class="n">fedora</span><span class="o">-</span><span class="n">minimal</span><span class="o">.</span><span class="n">ks</span> <span class="o">--</span><span class="n">iso</span> <span class="o">/</span><span class="n">root</span><span class="o">/</span><span class="n">boot</span><span class="o">.</span><span class="n">iso</span>
2016-03-18 23:30:48 +00:00
</pre></div>
</div>
</li>
</ol>
<p>Results will be in ./results/try-1 and logs under /results/logs/try-1/
including anaconda logs and livemedia-creator logs. The new iso will be
located at ~/results/try-1/images/boot.iso, and the ~/results/try-1/
directory tree will also contain the vmlinuz, initrd, etc.</p>
<p>This will run qemu without kvm support, which is going to be very slow. You can
2018-05-12 00:18:21 +00:00
add <code class="docutils literal notranslate"><span class="pre">mknod</span> <span class="pre">/dev/kvm</span> <span class="pre">c</span> <span class="pre">10</span> <span class="pre">232;</span></code> to create the device node before running lmc.</p>
2021-10-11 22:40:42 +00:00
</section>
<section id="openstack-image-creation">
<h2>OpenStack Image Creation<a class="headerlink" href="#openstack-image-creation" title="Permalink to this headline"></a></h2>
2018-05-12 00:18:21 +00:00
<p>OpenStack supports partitioned disk images so <code class="docutils literal notranslate"><span class="pre">--make-disk</span></code> can be used to
2019-03-27 23:44:14 +00:00
create images for importing into glance, OpenStack's image storage component.
You need to have access to an OpenStack provider that allows image uploads, or
2015-12-04 18:12:19 +00:00
setup your own using the instructions from the <a class="reference external" href="https://www.rdoproject.org/Quickstart">RDO Project</a>.</p>
<p>The example kickstart, fedora-openstack.ks, is only slightly different than the
fedora-minimal.ks one. It adds the cloud-init and cloud-utils-growpart
packages. OpenStack supports setting up the image using cloud-init, and
2019-03-27 23:44:14 +00:00
cloud-utils-growpart will grow the image to fit the instance's disk size.</p>
<p>Create a qcow2 image using the kickstart like this:</p>
<blockquote>
2019-03-27 23:44:14 +00:00
<div><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">livemedia-creator</span> <span class="pre">--make-disk</span> <span class="pre">--iso=/path/to/boot.iso</span> <span class="pre">--ks=/path/to/fedora-openstack.ks</span> <span class="pre">--image-type=qcow2</span></code></p>
</div></blockquote>
<div class="admonition note">
2019-03-27 23:44:14 +00:00
<p class="admonition-title">Note</p>
<p>On the RHEL7 version of lmc <code class="docutils literal notranslate"><span class="pre">--image-type</span></code> isn't supported. You can only create a bare partitioned disk image.</p>
</div>
<p>Import the resulting disk image into the OpenStack system, either via the web UI, or glance on the cmdline:</p>
2018-05-12 00:18:21 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">glance</span> <span class="n">image</span><span class="o">-</span><span class="n">create</span> <span class="o">--</span><span class="n">name</span> <span class="s2">&quot;fedora-openstack&quot;</span> <span class="o">--</span><span class="ow">is</span><span class="o">-</span><span class="n">public</span> <span class="n">true</span> <span class="o">--</span><span class="n">disk</span><span class="o">-</span><span class="nb">format</span> <span class="n">qcow2</span> \
2016-11-29 17:27:44 +00:00
<span class="o">--</span><span class="n">container</span><span class="o">-</span><span class="nb">format</span> <span class="n">bare</span> <span class="o">--</span><span class="n">file</span> <span class="o">./</span><span class="n">fedora</span><span class="o">-</span><span class="n">openstack</span><span class="o">.</span><span class="n">qcow2</span>
</pre></div>
</div>
2019-03-27 23:44:14 +00:00
<p>If qcow2 wasn't used then <code class="docutils literal notranslate"><span class="pre">--disk-format</span></code> should be set to raw.</p>
2021-10-11 22:40:42 +00:00
</section>
<section id="docker-image-creation">
<h2>Docker Image Creation<a class="headerlink" href="#docker-image-creation" title="Permalink to this headline"></a></h2>
<p>Use lmc to create a tarfile as described in the <a class="reference internal" href="#tar-file-creation">TAR File Creation</a> section, but substitute the
fedora-docker.ks example kickstart which removes the requirement for core files and the kernel.</p>
<p>You can then import the tarfile into docker like this (as root):</p>
<blockquote>
2019-03-27 23:44:14 +00:00
<div><p><code class="docutils literal notranslate"><span class="pre">cat</span> <span class="pre">/var/tmp/fedora-root.tar.xz</span> <span class="pre">|</span> <span class="pre">docker</span> <span class="pre">import</span> <span class="pre">-</span> <span class="pre">fedora-root</span></code></p>
</div></blockquote>
<p>And then run bash inside of it:</p>
<blockquote>
2019-03-27 23:44:14 +00:00
<div><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">docker</span> <span class="pre">run</span> <span class="pre">-i</span> <span class="pre">-t</span> <span class="pre">fedora-root</span> <span class="pre">/bin/bash</span></code></p>
</div></blockquote>
2021-10-11 22:40:42 +00:00
</section>
<section id="open-container-initiative-image-creation">
2015-12-04 18:12:19 +00:00
<h2>Open Container Initiative Image Creation<a class="headerlink" href="#open-container-initiative-image-creation" title="Permalink to this headline"></a></h2>
<p>The OCI is a new specification that is still being worked on. You can read more about it at
<a class="reference external" href="https://www.opencontainers.org/">the Open Container Initiative website</a>. You can create
OCI images using the following command:</p>
2018-05-12 00:18:21 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">livemedia</span><span class="o">-</span><span class="n">creator</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">oci</span> <span class="o">--</span><span class="n">oci</span><span class="o">-</span><span class="n">config</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">config</span><span class="o">.</span><span class="n">json</span> <span class="o">--</span><span class="n">oci</span><span class="o">-</span><span class="n">runtime</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">runtime</span><span class="o">.</span><span class="n">json</span> \
2016-11-29 17:27:44 +00:00
<span class="o">--</span><span class="n">iso</span><span class="o">=/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">boot</span><span class="o">.</span><span class="n">iso</span> <span class="o">--</span><span class="n">ks</span><span class="o">=/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">fedora</span><span class="o">-</span><span class="n">minimal</span><span class="o">.</span><span class="n">ks</span>
2015-12-04 18:12:19 +00:00
</pre></div>
</div>
<p>You must provide the config.json and runtime.json files to be included in the bundle,
their specifications can be found <a class="reference external" href="https://github.com/opencontainers/specs">on the OCI github project</a>
output will be in the results directory with a default name of bundle.tar.xz</p>
2019-03-27 23:44:14 +00:00
<p>This will work with <code class="docutils literal notranslate"><span class="pre">--no-virt</span></code> and inside a mock since it doesn't use any
2015-12-04 18:12:19 +00:00
partitioned disk images.</p>
2021-10-11 22:40:42 +00:00
</section>
<section id="vagrant-image-creation">
2015-12-04 18:12:19 +00:00
<h2>Vagrant Image Creation<a class="headerlink" href="#vagrant-image-creation" title="Permalink to this headline"></a></h2>
<p><a class="reference external" href="https://www.vagrantup.com/">Vagrant</a> images can be created using the following command:</p>
2018-05-12 00:18:21 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">livemedia</span><span class="o">-</span><span class="n">creator</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">vagrant</span> <span class="o">--</span><span class="n">vagrant</span><span class="o">-</span><span class="n">metadata</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">metadata</span><span class="o">.</span><span class="n">json</span> \
2016-11-29 17:27:44 +00:00
<span class="o">--</span><span class="n">iso</span><span class="o">=/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">boot</span><span class="o">.</span><span class="n">iso</span> <span class="o">--</span><span class="n">ks</span><span class="o">=/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">fedora</span><span class="o">-</span><span class="n">vagrant</span><span class="o">.</span><span class="n">ks</span>
2015-12-04 18:12:19 +00:00
</pre></div>
</div>
<p>The image created is a <a class="reference external" href="https://github.com/pradels/vagrant-libvirt">vagrant-libvirt</a> provider image and needs to have
vagrant setup with libvirt before you can use it.</p>
2018-05-12 00:18:21 +00:00
<p>The <code class="docutils literal notranslate"><span class="pre">--vagrant-metadata</span></code> file is optional, it will create a minimal one by
2015-12-04 18:12:19 +00:00
default, and if one is passed it will make sure the disk size is setup
2018-05-12 00:18:21 +00:00
correctly. If you pass a <code class="docutils literal notranslate"><span class="pre">--vagrant-vagrantfile</span></code> it will be included in the
2015-12-04 18:12:19 +00:00
image verbatim. By default no vagrantfile is created.</p>
<p>There is an example Vagrant kickstart file in the docs directory that sets up
the vagrant user with the default insecure SSH pubkey and a few useful
utilities.</p>
2018-05-12 00:18:21 +00:00
<p>This also works with <code class="docutils literal notranslate"><span class="pre">--no-virt</span></code>, but will not work inside a mock due to its
2015-12-04 18:12:19 +00:00
use of partitioned disk images and qcow2.</p>
2021-10-11 22:40:42 +00:00
</section>
<section id="creating-uefi-disk-images-with-virt">
2015-12-04 18:12:19 +00:00
<h2>Creating UEFI disk images with virt<a class="headerlink" href="#creating-uefi-disk-images-with-virt" title="Permalink to this headline"></a></h2>
<p>Partitioned disk images can only be created for the same platform as the host system (BIOS or
UEFI). You can use virt to create BIOS images on UEFI systems, and it is also possible
2019-03-27 23:44:14 +00:00
to create UEFI images on BIOS systems using OVMF firmware and qemu.</p>
<p>Install the lorax-lmc-virt package, this will install qemu and the OVMF
firmware files.</p>
2018-05-12 00:18:21 +00:00
<p>Now you can run livemedia-creator with <code class="docutils literal notranslate"><span class="pre">--virt-uefi</span></code> to boot and install using UEFI:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">livemedia</span><span class="o">-</span><span class="n">creator</span> <span class="o">--</span><span class="n">make</span><span class="o">-</span><span class="n">disk</span> <span class="o">--</span><span class="n">virt</span><span class="o">-</span><span class="n">uefi</span> <span class="o">--</span><span class="n">iso</span><span class="o">=/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">boot</span><span class="o">.</span><span class="n">iso</span> \
2016-11-29 17:27:44 +00:00
<span class="o">--</span><span class="n">ks</span><span class="o">=/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">fedora</span><span class="o">-</span><span class="n">minimal</span><span class="o">.</span><span class="n">ks</span>
2015-12-04 18:12:19 +00:00
</pre></div>
</div>
<p>Make sure that the kickstart you are using creates a /boot/efi partition by including this:</p>
2018-05-12 00:18:21 +00:00
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">part</span> <span class="o">/</span><span class="n">boot</span><span class="o">/</span><span class="n">efi</span> <span class="o">--</span><span class="n">fstype</span><span class="o">=</span><span class="s2">&quot;efi&quot;</span> <span class="o">--</span><span class="n">size</span><span class="o">=</span><span class="mi">500</span>
2015-12-04 18:12:19 +00:00
</pre></div>
</div>
2019-03-27 23:44:14 +00:00
<p>Or use <code class="docutils literal notranslate"><span class="pre">reqpart</span></code> in the kickstart and Anaconda will create the required partitions.</p>
2015-12-04 18:12:19 +00:00
<div class="admonition note">
2019-03-27 23:44:14 +00:00
<p class="admonition-title">Note</p>
<p>The --virt-uefi method is currently only supported on the x86_64 architecture.</p>
2015-12-04 18:12:19 +00:00
</div>
2021-10-11 22:40:42 +00:00
</section>
<section id="debugging-problems">
<h2>Debugging problems<a class="headerlink" href="#debugging-problems" title="Permalink to this headline"></a></h2>
2016-03-18 23:30:48 +00:00
<p>Sometimes an installation will get stuck. When using qemu the logs will
be written to ./virt-install.log and most of the time any problems that happen
will be near the end of the file. lmc tries to detect common errors and will
cancel the installation when they happen. But not everything can be caught.
2016-03-18 23:30:48 +00:00
When creating a new kickstart it is helpful to use vnc so that you can monitor
the installation as it happens, and if it gets stuck without lmc detecting the
problem you can switch to tty1 and examine the system directly.</p>
2018-06-04 23:27:56 +00:00
<p>If you suspect problems with %pre or %post sections you can redirect the output
to the terminal and examine it by logging into the VM. eg.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">pre</span>
<span class="n">chvt</span>
<span class="n">exec</span> <span class="o">&lt;</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">tty3</span> <span class="o">&gt;</span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">tty3</span> <span class="mi">2</span><span class="o">&gt;/</span><span class="n">dev</span><span class="o">/</span><span class="n">tty3</span>
<span class="c1">#do stuff</span>
<span class="n">echo</span> <span class="n">hello</span> <span class="n">world</span>
<span class="o">%</span><span class="n">end</span>
</pre></div>
</div>
2016-03-18 23:30:48 +00:00
<p>If it does get stuck the best way to cancel is to use kill -9 on the qemu pid,
lmc will detect that the process died and cleanup.</p>
2019-03-27 23:44:14 +00:00
<p>If lmc didn't handle the cleanup for some reason you can do this:
2018-05-12 00:18:21 +00:00
1. <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">umount</span> <span class="pre">/tmp/lmc-XXXX</span></code> to unmount the iso from its mountpoint.
2. <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">rm</span> <span class="pre">-rf</span> <span class="pre">/tmp/lmc-XXXX</span></code>
3. <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">rm</span> <span class="pre">/var/tmp/lmc-disk-XXXXX</span></code> to remove the disk image.</p>
2016-03-18 23:30:48 +00:00
<p>Note that lmc uses the lmc- prefix for all of its temporary files and
directories to make it easier to find and clean up leftovers.</p>
<p>The logs from the qemu run are stored in virt-install.log, logs from
livemedia-creator are in livemedia.log and program.log</p>
2018-05-12 00:18:21 +00:00
<p>You can add <code class="docutils literal notranslate"><span class="pre">--image-only</span></code> to skip the .iso creation and examine the resulting
disk image. Or you can pass <code class="docutils literal notranslate"><span class="pre">--keep-image</span></code> to keep it around after the iso has
been created.</p>
2018-05-12 00:18:21 +00:00
<p>Cleaning up aborted <code class="docutils literal notranslate"><span class="pre">--no-virt</span></code> installs can sometimes be accomplished by
running the <code class="docutils literal notranslate"><span class="pre">anaconda-cleanup</span></code> script. As of Fedora 18 anaconda is
multi-threaded and it can sometimes become stuck and refuse to exit. When this
happens you can usually clean up by first killing the anaconda process then
2018-05-12 00:18:21 +00:00
running <code class="docutils literal notranslate"><span class="pre">anaconda-cleanup</span></code>.</p>
2021-10-11 22:40:42 +00:00
</section>
<section id="hacking">
<h2>Hacking<a class="headerlink" href="#hacking" title="Permalink to this headline"></a></h2>
<p>Development on this will take place as part of the lorax project, and on the
anaconda-devel-list mailing list, and <a class="reference external" href="https://github.com/rhinstaller/lorax">on github</a></p>
<p>Feedback, enhancements and bugs are welcome. You can use <a class="reference external" href="https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora&amp;component=lorax">bugzilla</a> to
report bugs against the lorax component.</p>
2021-10-11 22:40:42 +00:00
</section>
</section>
2017-11-28 17:18:51 +00:00
</div>
</div>
2021-10-11 22:40:42 +00:00
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
2021-04-23 20:42:41 +00:00
<a href="lorax.html" class="btn btn-neutral float-left" title="Lorax" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
2021-10-11 22:40:42 +00:00
<a href="mkksiso.html" class="btn btn-neutral float-right" title="mkksiso" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
2021-10-11 22:40:42 +00:00
<p>&#169; Copyright 2018, Red Hat, Inc..</p>
</div>
2021-10-11 22:40:42 +00:00
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
2021-04-23 20:42:41 +00:00
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
2021-10-11 22:40:42 +00:00
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
2021-10-11 22:40:42 +00:00
<script>
jQuery(function () {
2018-06-04 23:27:56 +00:00
SphinxRtdTheme.Navigation.enable(true);
});
2021-10-11 22:40:42 +00:00
</script>
</body>
</html>