489 lines
		
	
	
		
			24 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			489 lines
		
	
	
		
			24 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| 
 | |
| 
 | |
| <!DOCTYPE html>
 | |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 | |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 | |
| <head>
 | |
|   <meta charset="utf-8">
 | |
|   
 | |
|   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 | |
|   
 | |
|   <title>Lorax — Lorax 25.6 documentation</title>
 | |
|   
 | |
| 
 | |
|   
 | |
|   
 | |
| 
 | |
|   
 | |
| 
 | |
|   
 | |
|   
 | |
|     
 | |
| 
 | |
|   
 | |
| 
 | |
|   
 | |
|   
 | |
|     <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
 | |
|   
 | |
| 
 | |
|   
 | |
| 
 | |
|   
 | |
|     <link rel="top" title="Lorax 25.6 documentation" href="index.html"/>
 | |
|         <link rel="next" title="livemedia-creator" href="livemedia-creator.html"/>
 | |
|         <link rel="prev" title="Introduction to Lorax" href="intro.html"/> 
 | |
| 
 | |
|   
 | |
|   <script src="_static/js/modernizr.min.js"></script>
 | |
| 
 | |
| </head>
 | |
| 
 | |
| <body class="wy-body-for-nav" role="document">
 | |
| 
 | |
|   <div class="wy-grid-for-nav">
 | |
| 
 | |
|     
 | |
|     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
 | |
|       <div class="wy-side-scroll">
 | |
|         <div class="wy-side-nav-search">
 | |
|           
 | |
| 
 | |
|           
 | |
|             <a href="index.html" class="icon icon-home"> Lorax
 | |
|           
 | |
| 
 | |
|           
 | |
|           </a>
 | |
| 
 | |
|           
 | |
|             
 | |
|             
 | |
|               <div class="version">
 | |
|                 25.6
 | |
|               </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>
 | |
| 
 | |
|           
 | |
|         </div>
 | |
| 
 | |
|         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 | |
|           
 | |
|             
 | |
|             
 | |
|                 <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>
 | |
| <li class="toctree-l1 current"><a class="current reference internal" href="">Lorax</a><ul>
 | |
| <li class="toctree-l2"><a class="reference internal" href="#lorax-cmdline-arguments">lorax cmdline arguments</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="#quickstart">Quickstart</a></li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="#how-it-works">How it works</a><ul>
 | |
| <li class="toctree-l3"><a class="reference internal" href="#runtime-install-tmpl">runtime-install.tmpl</a></li>
 | |
| <li class="toctree-l3"><a class="reference internal" href="#runtime-postinstall-tmpl">runtime-postinstall.tmpl</a></li>
 | |
| <li class="toctree-l3"><a class="reference internal" href="#runtime-cleanup-tmpl">runtime-cleanup.tmpl</a></li>
 | |
| <li class="toctree-l3"><a class="reference internal" href="#the-squashfs-filesystem">The squashfs filesystem</a></li>
 | |
| <li class="toctree-l3"><a class="reference internal" href="#iso-creation">iso creation</a></li>
 | |
| </ul>
 | |
| </li>
 | |
| <li class="toctree-l2"><a class="reference internal" href="#custom-templates">Custom Templates</a></li>
 | |
| </ul>
 | |
| </li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="livemedia-creator.html">livemedia-creator</a></li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="product-images.html">Product and Updates Images</a></li>
 | |
| <li class="toctree-l1"><a class="reference internal" href="modules.html">pylorax</a></li>
 | |
| </ul>
 | |
| 
 | |
|             
 | |
|           
 | |
|         </div>
 | |
|       </div>
 | |
|     </nav>
 | |
| 
 | |
|     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 | |
| 
 | |
|       
 | |
|       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 | |
|         <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">
 | |
|           
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| 
 | |
| <div role="navigation" aria-label="breadcrumbs navigation">
 | |
|   <ul class="wy-breadcrumbs">
 | |
|     <li><a href="index.html">Docs</a> »</li>
 | |
|       
 | |
|     <li>Lorax</li>
 | |
|       <li class="wy-breadcrumbs-aside">
 | |
|         
 | |
|           
 | |
|             <a href="_sources/lorax.txt" rel="nofollow"> View page source</a>
 | |
|           
 | |
|         
 | |
|       </li>
 | |
|   </ul>
 | |
|   <hr/>
 | |
| </div>
 | |
|           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 | |
|            <div itemprop="articleBody">
 | |
|             
 | |
|   <div class="section" id="lorax">
 | |
| <h1>Lorax<a class="headerlink" href="#lorax" title="Permalink to this headline">¶</a></h1>
 | |
| <table class="docutils field-list" frame="void" rules="none">
 | |
| <col class="field-name" />
 | |
| <col class="field-body" />
 | |
| <tbody valign="top">
 | |
| <tr class="field-odd field"><th class="field-name">Authors:</th><td class="field-body">Brian C. Lane <<a class="reference external" href="mailto:bcl%40redhat.com">bcl<span>@</span>redhat<span>.</span>com</a>></td>
 | |
| </tr>
 | |
| </tbody>
 | |
| </table>
 | |
| <p>“I am the Lorax.  I speak for the trees [and images].”</p>
 | |
| <p>The <a class="reference external" href="https://github.com/rhinstaller/lorax">lorax</a> tool is used to create the
 | |
| <a class="reference external" href="https://github.com/rhinstaller/anaconda">Anaconda</a> installer boot.iso as
 | |
| well as the basic release tree, and .treeinfo metadata file. Its dependencies
 | |
| are fairly light-weight because it needs to be able to run in a mock chroot
 | |
| environment. It is best to run lorax from the same release as is being targeted
 | |
| because the templates may have release specific logic in them. eg. Use the
 | |
| rawhide version to build the boot.iso for rawhide, along with the rawhide
 | |
| repositories.</p>
 | |
| <div class="section" id="lorax-cmdline-arguments">
 | |
| <h2>lorax cmdline arguments<a class="headerlink" href="#lorax-cmdline-arguments" title="Permalink to this headline">¶</a></h2>
 | |
| <p>Create the Anaconda boot.iso</p>
 | |
| <pre class="literal-block">
 | |
| usage: lorax [-h] -p PRODUCT -v VERSION -r RELEASE [-s REPOSITORY]
 | |
|              [--repo REPOSITORY] [-m REPOSITORY] [-t VARIANT] [-b URL]
 | |
|              [--isfinal] [-c CONFIGFILE] [--proxy HOST] [-i PACKAGE]
 | |
|              [--buildarch ARCH] [--volid VOLID] [--macboot] [--nomacboot]
 | |
|              [--noupgrade] [--logfile LOGFILE] [--tmp TMP]
 | |
|              [--cachedir CACHEDIR] [--workdir WORKDIR] [--force]
 | |
|              [--add-template ADD_TEMPLATES]
 | |
|              [--add-template-var ADD_TEMPLATE_VARS]
 | |
|              [--add-arch-template ADD_ARCH_TEMPLATES]
 | |
|              [--add-arch-template-var ADD_ARCH_TEMPLATE_VARS] [--noverify]
 | |
|              [--sharedir SHAREDIR] [--enablerepo [repo]]
 | |
|              [--disablerepo [repo]] [-V]
 | |
|              OUTPUTDIR
 | |
| </pre>
 | |
| <dl class="docutils">
 | |
| <dt>Positional arguments:</dt>
 | |
| <dd><table class="first last docutils option-list" frame="void" rules="none">
 | |
| <col class="option" />
 | |
| <col class="description" />
 | |
| <tbody valign="top">
 | |
| <tr><td class="option-group">
 | |
| <kbd>outputdir</kbd></td>
 | |
| <td>Output directory</td></tr>
 | |
| </tbody>
 | |
| </table>
 | |
| </dd>
 | |
| <dt>Options:</dt>
 | |
| <dd><table class="first last docutils option-list" frame="void" rules="none">
 | |
| <col class="option" />
 | |
| <col class="description" />
 | |
| <tbody valign="top">
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">-p</span>, <span class="option">--product</span></kbd></td>
 | |
| <td>product name</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">-v</span>, <span class="option">--version</span></kbd></td>
 | |
| <td>version identifier</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">-r</span>, <span class="option">--release</span></kbd></td>
 | |
| <td>release information</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">-s=[]</span>, <span class="option">--source=[]</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>source repository (may be listed multiple times)</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">--repo=[]</span></kbd></td>
 | |
| <td>source dnf repository file</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">-m=[]</span>, <span class="option">--mirrorlist=[]</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>mirrorlist repository (may be listed multiple times)</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">-t</span>, <span class="option">--variant</span></kbd></td>
 | |
| <td>variant name</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">-b=your distribution provided bug reporting tool</span>, <span class="option">--bugurl=your distribution provided bug reporting tool</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>bug reporting URL for the product</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">--isfinal=False</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>Undocumented</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">-c=/etc/lorax/lorax.conf</span>, <span class="option">--config=/etc/lorax/lorax.conf</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>config file</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">--proxy</span></kbd></td>
 | |
| <td>repo proxy url:port</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">-i=[]</span>, <span class="option">--installpkgs=[]</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>package glob to install before runtime-install.tmpl runs. (may be listed multiple times)</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">--buildarch</span></kbd></td>
 | |
| <td>build architecture</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">--volid</span></kbd></td>
 | |
| <td>volume id</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">--macboot=True</span></kbd></td>
 | |
| <td>Undocumented</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">--nomacboot=True</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>Undocumented</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">--noupgrade=True</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>Undocumented</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">--logfile=./lorax.log</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>Path to logfile</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">--tmp=/var/tmp</span></kbd></td>
 | |
| <td>Top level temporary directory</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">--cachedir</span></kbd></td>
 | |
| <td>DNF cache directory. Default is a temporary dir.</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">--workdir</span></kbd></td>
 | |
| <td>Work directory, overrides –tmp. Default is a temporary dir under /var/tmp</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">--force=False</span></kbd></td>
 | |
| <td>Run even when the destination directory exists</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">--add-template=[]</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>Additional template for runtime image</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">--add-template-var=[]</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>Set variable for runtime image template</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">--add-arch-template=[]</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>Additional template for architecture-specific image</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">--add-arch-template-var=[]</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>Set variable for architecture-specific image</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">--noverify=True</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>Do not verify the install root</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">--sharedir</span></kbd></td>
 | |
| <td>Directory containing all the templates. Overrides config file sharedir</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">--enablerepo=[]</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>Names of repos to enable</td></tr>
 | |
| <tr><td class="option-group" colspan="2">
 | |
| <kbd><span class="option">--disablerepo=[]</span></kbd></td>
 | |
| </tr>
 | |
| <tr><td> </td><td>Names of repos to disable</td></tr>
 | |
| <tr><td class="option-group">
 | |
| <kbd><span class="option">-V</span></kbd></td>
 | |
| <td>show program’s version number and exit</td></tr>
 | |
| </tbody>
 | |
| </table>
 | |
| </dd>
 | |
| </dl>
 | |
| </div>
 | |
| <div class="section" id="quickstart">
 | |
| <h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h2>
 | |
| <p>Run this as root to create a boot.iso in <tt class="docutils literal"><span class="pre">./results/</span></tt>:</p>
 | |
| <div class="highlight-python"><div class="highlight"><pre><span></span>dnf install lorax
 | |
| setenforce 0
 | |
| lorax -p Fedora -v 23 -r 23 \
 | |
| -s http://dl.fedoraproject.org/pub/fedora/linux/releases/23/Everything/x86_64/os/ \
 | |
| -s http://dl.fedoraproject.org/pub/fedora/linux/updates/23/x86_64/ \
 | |
| ./results/
 | |
| setenforce 1
 | |
| </pre></div>
 | |
| </div>
 | |
| <p>You can add your own repos with <tt class="docutils literal"><span class="pre">-s</span></tt> and packages with higher NVRs will
 | |
| override the ones in the distribution repositories.</p>
 | |
| <p>Under <tt class="docutils literal"><span class="pre">./results/</span></tt> will be the release tree files: .discinfo, .treeinfo, everything that
 | |
| goes onto the boot.iso, the pxeboot directory, and the boot.iso under <tt class="docutils literal"><span class="pre">./images/</span></tt>.</p>
 | |
| </div>
 | |
| <div class="section" id="how-it-works">
 | |
| <h2>How it works<a class="headerlink" href="#how-it-works" title="Permalink to this headline">¶</a></h2>
 | |
| <p>Lorax uses <a class="reference external" href="https://github.com/rpm-software-management/dnf">dnf</a> to install
 | |
| packages into a temporary directory, sets up configuration files, it then
 | |
| removes unneeded files to save space, and creates a squashfs filesystem of the
 | |
| files.  The iso is then built using a generic initramfs and the kernel from the
 | |
| selected repositories.</p>
 | |
| <p>To drive these processes Lorax uses a custom template system, based on <a class="reference external" href="http://www.makotemplates.org/">Mako
 | |
| templates</a> with the addition of custom
 | |
| commands (documented in <a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner" title="pylorax.ltmpl.LoraxTemplateRunner"><tt class="xref py py-class docutils literal"><span class="pre">pylorax.ltmpl.LoraxTemplateRunner</span></tt></a>). Mako
 | |
| supports <tt class="docutils literal"><span class="pre">%if/%endif</span></tt> blocks as well as free-form python code inside <tt class="docutils literal"><span class="pre"><%</span>
 | |
| <span class="pre">%></span></tt> tags and variable substitution with <tt class="docutils literal"><span class="pre">${}</span></tt>. The default templates are
 | |
| shipped with lorax in <tt class="docutils literal"><span class="pre">/usr/share/lorax/templates.d/99-generic/</span></tt> and use the
 | |
| <tt class="docutils literal"><span class="pre">.tmpl</span></tt> extension.</p>
 | |
| <div class="section" id="runtime-install-tmpl">
 | |
| <h3>runtime-install.tmpl<a class="headerlink" href="#runtime-install-tmpl" title="Permalink to this headline">¶</a></h3>
 | |
| <p>The <tt class="docutils literal"><span class="pre">runtime-install.tmpl</span></tt> template lists packages to be installed using the
 | |
| <tt class="docutils literal"><span class="pre">installpkg</span></tt> command.  This template is fairly simple, installing common packages and
 | |
| architecture specific packages. It must end with the <tt class="docutils literal"><span class="pre">run_pkg_transaction</span></tt>
 | |
| command which tells dnf to download and install the packages.</p>
 | |
| </div>
 | |
| <div class="section" id="runtime-postinstall-tmpl">
 | |
| <h3>runtime-postinstall.tmpl<a class="headerlink" href="#runtime-postinstall-tmpl" title="Permalink to this headline">¶</a></h3>
 | |
| <p>The <tt class="docutils literal"><span class="pre">runtime-postinstall.tmpl</span></tt> template is where the system configuration
 | |
| happens. The installer environment is similar to a normal running system, but
 | |
| needs some special handling. Configuration files are setup, systemd is told to
 | |
| start the anaconda.target instead of a default system target, and a number of
 | |
| unneeded services are disabled, some of which can interfere with the
 | |
| installation. A number of template commands are used here:</p>
 | |
| <ul class="simple">
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.append" title="pylorax.ltmpl.LoraxTemplateRunner.append"><tt class="xref py py-func docutils literal"><span class="pre">append</span></tt></a> to add text to a file.</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.chmod" title="pylorax.ltmpl.LoraxTemplateRunner.chmod"><tt class="xref py py-func docutils literal"><span class="pre">chmod</span></tt></a> changes the file’s mode.</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.gconfset" title="pylorax.ltmpl.LoraxTemplateRunner.gconfset"><tt class="xref py py-func docutils literal"><span class="pre">gconfset</span></tt></a> runs gconfset.</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.install" title="pylorax.ltmpl.LoraxTemplateRunner.install"><tt class="xref py py-func docutils literal"><span class="pre">install</span></tt></a> to install a file into the installroot.</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.mkdir" title="pylorax.ltmpl.LoraxTemplateRunner.mkdir"><tt class="xref py py-func docutils literal"><span class="pre">mkdir</span></tt></a> makes a new directory.</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.move" title="pylorax.ltmpl.LoraxTemplateRunner.move"><tt class="xref py py-func docutils literal"><span class="pre">move</span></tt></a> to move a file into the installroot</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.replace" title="pylorax.ltmpl.LoraxTemplateRunner.replace"><tt class="xref py py-func docutils literal"><span class="pre">replace</span></tt></a> does text substitution in a file</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.remove" title="pylorax.ltmpl.LoraxTemplateRunner.remove"><tt class="xref py py-func docutils literal"><span class="pre">remove</span></tt></a> deletes a file</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.runcmd" title="pylorax.ltmpl.LoraxTemplateRunner.runcmd"><tt class="xref py py-func docutils literal"><span class="pre">runcmd</span></tt></a> run arbitrary commands.</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.symlink" title="pylorax.ltmpl.LoraxTemplateRunner.symlink"><tt class="xref py py-func docutils literal"><span class="pre">symlink</span></tt></a> creates a symlink</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.systemctl" title="pylorax.ltmpl.LoraxTemplateRunner.systemctl"><tt class="xref py py-func docutils literal"><span class="pre">systemctl</span></tt></a> runs systemctl in the installroot</li>
 | |
| </ul>
 | |
| </div>
 | |
| <div class="section" id="runtime-cleanup-tmpl">
 | |
| <h3>runtime-cleanup.tmpl<a class="headerlink" href="#runtime-cleanup-tmpl" title="Permalink to this headline">¶</a></h3>
 | |
| <p>The <tt class="docutils literal"><span class="pre">runtime-cleanup.tmpl</span></tt> template is used to remove files that aren’t strictly needed
 | |
| by the installation environment. In addition to the <tt class="docutils literal"><span class="pre">remove</span></tt> template command it uses:</p>
 | |
| <ul class="simple">
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.removepkg" title="pylorax.ltmpl.LoraxTemplateRunner.removepkg"><tt class="xref py py-func docutils literal"><span class="pre">removepkg</span></tt></a>
 | |
| remove all of a specific package’s contents. A package may be pulled in as a dependency, but
 | |
| not really used. eg. sound support.</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.removefrom" title="pylorax.ltmpl.LoraxTemplateRunner.removefrom"><tt class="xref py py-func docutils literal"><span class="pre">removefrom</span></tt></a>
 | |
| Removes some files from a package. A file glob can be used, or the –allbut option to
 | |
| remove everything except a select few.</li>
 | |
| <li><a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.removekmod" title="pylorax.ltmpl.LoraxTemplateRunner.removekmod"><tt class="xref py py-func docutils literal"><span class="pre">removekmod</span></tt></a>
 | |
| Removes kernel modules</li>
 | |
| </ul>
 | |
| </div>
 | |
| <div class="section" id="the-squashfs-filesystem">
 | |
| <h3>The squashfs filesystem<a class="headerlink" href="#the-squashfs-filesystem" title="Permalink to this headline">¶</a></h3>
 | |
| <p>After <tt class="docutils literal"><span class="pre">runtime-*.tmpl</span></tt> templates have finished their work lorax creates an
 | |
| empty ext4 filesystem, copies the remaining files to it, and makes a squashfs
 | |
| filesystem of it. This file is the / of the boot.iso’s installer environment
 | |
| and is what is in the LiveOS/squashfs.img file on the iso.</p>
 | |
| </div>
 | |
| <div class="section" id="iso-creation">
 | |
| <h3>iso creation<a class="headerlink" href="#iso-creation" title="Permalink to this headline">¶</a></h3>
 | |
| <p>The iso creation is handled by another set of templates. The one used depends
 | |
| on the architecture that the iso is being created for. They are also stored in
 | |
| <tt class="docutils literal"><span class="pre">/usr/share/lorax/templates.d/99-generic</span></tt> and are named after the arch, like
 | |
| <tt class="docutils literal"><span class="pre">x86.tmpl</span></tt> and <tt class="docutils literal"><span class="pre">aarch64.tmpl</span></tt>. They handle creation of the tree, copying
 | |
| configuration template files, configuration variable substitution, treeinfo
 | |
| metadata (via the <a class="reference internal" href="pylorax.html#pylorax.ltmpl.LoraxTemplateRunner.treeinfo" title="pylorax.ltmpl.LoraxTemplateRunner.treeinfo"><tt class="xref py py-func docutils literal"><span class="pre">treeinfo</span></tt></a>
 | |
| template command). Kernel and initrd are copied from the installroot to their
 | |
| final locations and then mkisofs is run to create the boot.iso</p>
 | |
| </div>
 | |
| </div>
 | |
| <div class="section" id="custom-templates">
 | |
| <h2>Custom Templates<a class="headerlink" href="#custom-templates" title="Permalink to this headline">¶</a></h2>
 | |
| <p>The default set of templates and configuration files from the lorax-generic-templates package
 | |
| are shipped in the <tt class="docutils literal"><span class="pre">/usr/share/lorax/templates.d/99-generic/</span></tt> directory. You can
 | |
| make a copy of them and place them into another directory under <tt class="docutils literal"><span class="pre">templates.d</span></tt>
 | |
| and they will be used instead if their sort order is below all other directories. This
 | |
| allows multiple packages to ship lorax templates without conflict. You can (and probably
 | |
| should) select the specific template directory by passing <tt class="docutils literal"><span class="pre">--sharedir</span></tt> to lorax.</p>
 | |
| </div>
 | |
| </div>
 | |
| 
 | |
| 
 | |
|            </div>
 | |
|           </div>
 | |
|           <footer>
 | |
|   
 | |
|     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 | |
|       
 | |
|         <a href="livemedia-creator.html" class="btn btn-neutral float-right" title="livemedia-creator" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
 | |
|       
 | |
|       
 | |
|         <a href="intro.html" class="btn btn-neutral" title="Introduction to Lorax" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 | |
|       
 | |
|     </div>
 | |
|   
 | |
| 
 | |
|   <hr/>
 | |
| 
 | |
|   <div role="contentinfo">
 | |
|     <p>
 | |
|         © Copyright 2015, Red Hat, Inc..
 | |
| 
 | |
|     </p>
 | |
|   </div>
 | |
|   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 
 | |
| 
 | |
| </footer>
 | |
| 
 | |
|         </div>
 | |
|       </div>
 | |
| 
 | |
|     </section>
 | |
| 
 | |
|   </div>
 | |
|   
 | |
| 
 | |
| 
 | |
|   
 | |
| 
 | |
|     <script type="text/javascript">
 | |
|         var DOCUMENTATION_OPTIONS = {
 | |
|             URL_ROOT:'./',
 | |
|             VERSION:'25.6',
 | |
|             COLLAPSE_INDEX:false,
 | |
|             FILE_SUFFIX:'.html',
 | |
|             HAS_SOURCE:  true
 | |
|         };
 | |
|     </script>
 | |
|       <script type="text/javascript" src="_static/jquery.js"></script>
 | |
|       <script type="text/javascript" src="_static/underscore.js"></script>
 | |
|       <script type="text/javascript" src="_static/doctools.js"></script>
 | |
| 
 | |
|   
 | |
| 
 | |
|   
 | |
|   
 | |
|     <script type="text/javascript" src="_static/js/theme.js"></script>
 | |
|   
 | |
| 
 | |
|   
 | |
|   
 | |
|   <script type="text/javascript">
 | |
|       jQuery(function () {
 | |
|           SphinxRtdTheme.StickyNav.enable();
 | |
|       });
 | |
|   </script>
 | |
|    
 | |
| 
 | |
| </body>
 | |
| </html> |