almalinux/lorax
13
0
Fork 0
Code Issues Pull Requests Releases Activity
f112a0cbc7
lorax/docs/html/composer-cli.html

268 lines
12 KiB
HTML
Raw Normal View History

Update the generated html docs
2018-05-16 20:15:10 +00:00
<!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">
New lorax documentation - 28.14.43 Related: rhbz#1826479
2020-04-27 23:33:01 +00:00
<title>composer-cli &mdash; Lorax 28.14.42 documentation</title>
Update the generated html docs
2018-05-16 20:15:10 +00:00
New lorax documentation - 28.14.33 Related: rhbz#1761653
2019-11-11 19:46:04 +00:00
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
Update the generated html docs
2018-05-16 20:15:10 +00:00
New lorax documentation - 28.14.33 Related: rhbz#1761653
2019-11-11 19:46:04 +00:00
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
Update the generated html docs
2018-05-16 20:15:10 +00:00
New lorax documentation - 28.14.33 Related: rhbz#1761653
2019-11-11 19:46:04 +00:00
Update the generated html docs
2018-05-16 20:15:10 +00:00
New lorax documentation - 28.14.25 Related: rhbz#1687743
2019-03-27 19:25:06 +00:00
New lorax documentation - 28.14.33 Related: rhbz#1761653
2019-11-11 19:46:04 +00:00
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
Update the generated html docs
2018-05-16 20:15:10 +00:00
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Product and Updates Images" href="product-images.html" />
<link rel="prev" title="lorax-composer" href="lorax-composer.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
New lorax documentation - 28.14.33 Related: rhbz#1761653
2019-11-11 19:46:04 +00:00
<div class="wy-side-nav-search" >
Update the generated html docs
2018-05-16 20:15:10 +00:00
<a href="index.html" class="icon icon-home"> Lorax
</a>
<div class="version">
New lorax documentation - 28.14.43 Related: rhbz#1826479
2020-04-27 23:33:01 +00:00
28.14.42
Update the generated html docs
2018-05-16 20:15:10 +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>
</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"><a class="reference internal" href="lorax.html">Lorax</a></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="lorax-composer.html">lorax-composer</a></li>
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
<li class="toctree-l1 current"><a class="current reference internal" href="#">composer-cli</a><ul>
New lorax documentation - 28.14.43 Related: rhbz#1826479
2020-04-27 23:33:01 +00:00
<li class="toctree-l2"><a class="reference internal" href="#composer-cli-cmdline-arguments">composer-cli cmdline arguments</a></li>
Update the generated html docs
2018-05-16 20:15:10 +00:00
<li class="toctree-l2"><a class="reference internal" href="#edit-a-blueprint">Edit a Blueprint</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build-an-image">Build an image</a></li>
<li class="toctree-l2"><a class="reference internal" href="#monitor-the-build-status">Monitor the build status</a></li>
<li class="toctree-l2"><a class="reference internal" href="#download-the-image">Download the image</a></li>
</ul>
</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" 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> &raquo;</li>
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
<li>composer-cli</li>
Update the generated html docs
2018-05-16 20:15:10 +00:00
<li class="wy-breadcrumbs-aside">
<a href="_sources/composer-cli.rst.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">
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
<div class="section" id="composer-cli">
<h1>composer-cli<a class="headerlink" href="#composer-cli" title="Permalink to this headline"></a></h1>
New lorax documentation - 28.14.43 Related: rhbz#1826479
2020-04-27 23:33:01 +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>
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
<p><code class="docutils literal notranslate"><span class="pre">composer-cli</span></code> is used to interact with the <code class="docutils literal notranslate"><span class="pre">lorax-composer</span></code> API server, managing blueprints, exploring available packages, and building new images.</p>
Update the generated html docs
2018-05-16 20:15:10 +00:00
<p>It requires <a class="reference external" href="lorax-composer.html">lorax-composer</a> to be installed on the
local system, and the user running it needs to be a member of the <code class="docutils literal notranslate"><span class="pre">weldr</span></code>
group. They do not need to be root, but all of the <a class="reference external" href="lorax-composer.html#security">security precautions</a> apply.</p>
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
<div class="section" id="composer-cli-cmdline-arguments">
<h2>composer-cli cmdline arguments<a class="headerlink" href="#composer-cli-cmdline-arguments" title="Permalink to this headline"></a></h2>
Update the generated html docs
2018-05-16 20:15:10 +00:00
</div>
<div class="section" id="edit-a-blueprint">
<h2>Edit a Blueprint<a class="headerlink" href="#edit-a-blueprint" title="Permalink to this headline"></a></h2>
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
<p>Start out by listing the available blueprints using <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">blueprints</span>
<span class="pre">list</span></code>, pick one and save it to the local directory by running <code class="docutils literal notranslate"><span class="pre">composer-cli</span>
Update the generated html docs
2018-05-16 20:15:10 +00:00
<span class="pre">blueprints</span> <span class="pre">save</span> <span class="pre">http-server</span></code>. If there are no blueprints available you can
copy one of the examples <a class="reference external" href="https://github.com/weldr/lorax/tree/master/tests/pylorax/blueprints/">from the test suite</a>.</p>
New lorax documentation - 28.14.2
2018-07-20 23:27:17 +00:00
<p>Edit the file (it will be saved with a .toml extension) and change the
Update the generated html docs
2018-05-16 20:15:10 +00:00
description, add a package or module to it. Send it back to the server by
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
running <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">blueprints</span> <span class="pre">push</span> <span class="pre">http-server.toml</span></code>. You can verify that it was
saved by viewing the changelog - <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">blueprints</span> <span class="pre">changes</span> <span class="pre">http-server</span></code>.</p>
Update the generated html docs
2018-05-16 20:15:10 +00:00
</div>
<div class="section" id="build-an-image">
<h2>Build an image<a class="headerlink" href="#build-an-image" title="Permalink to this headline"></a></h2>
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
<p>Build a <code class="docutils literal notranslate"><span class="pre">qcow2</span></code> disk image from this blueprint by running <code class="docutils literal notranslate"><span class="pre">composer-cli</span>
Update the generated html docs
2018-05-16 20:15:10 +00:00
<span class="pre">compose</span> <span class="pre">start</span> <span class="pre">http-server</span> <span class="pre">qcow2</span></code>. It will print a UUID that you can use to
keep track of the build. You can also cancel the build if needed.</p>
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
<p>The available types of images is displayed by <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">compose</span> <span class="pre">types</span></code>.
New lorax documentation - 28.14.30 Related: rhbz#1709594
2019-06-27 18:54:34 +00:00
Currently this consists of: alibaba, ami, ext4-filesystem, google, live-iso,
openstack, partitioned-disk, qcow2, tar, vhd, vmdk</p>
Update the generated html docs
2018-05-16 20:15:10 +00:00
</div>
<div class="section" id="monitor-the-build-status">
<h2>Monitor the build status<a class="headerlink" href="#monitor-the-build-status" title="Permalink to this headline"></a></h2>
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
<p>Monitor it using <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">compose</span> <span class="pre">status</span></code>, which will show the status of
Update the generated html docs
2018-05-16 20:15:10 +00:00
all the builds on the system. You can view the end of the anaconda build logs
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
once it is in the <code class="docutils literal notranslate"><span class="pre">RUNNING</span></code> state using <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">compose</span> <span class="pre">log</span> <span class="pre">UUID</span></code>
Update the generated html docs
2018-05-16 20:15:10 +00:00
where UUID is the UUID returned by the start command.</p>
<p>Once the build is in the <code class="docutils literal notranslate"><span class="pre">FINISHED</span></code> state you can download the image.</p>
</div>
<div class="section" id="download-the-image">
<h2>Download the image<a class="headerlink" href="#download-the-image" title="Permalink to this headline"></a></h2>
New lorax documentation - 28.14.17 Related: rhbz#1639132
2018-10-30 16:35:18 +00:00
<p>Downloading the final image is done with <code class="docutils literal notranslate"><span class="pre">composer-cli</span> <span class="pre">compose</span> <span class="pre">image</span> <span class="pre">UUID</span></code> and it will
Update the generated html docs
2018-05-16 20:15:10 +00:00
save the qcow2 image as <code class="docutils literal notranslate"><span class="pre">UUID-disk.qcow2</span></code> which you can then use to boot a VM like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">qemu</span><span class="o">-</span><span class="n">kvm</span> <span class="o">--</span><span class="n">name</span> <span class="n">test</span><span class="o">-</span><span class="n">image</span> <span class="o">-</span><span class="n">m</span> <span class="mi">1024</span> <span class="o">-</span><span class="n">hda</span> <span class="o">./</span><span class="n">UUID</span><span class="o">-</span><span class="n">disk</span><span class="o">.</span><span class="n">qcow2</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="product-images.html" class="btn btn-neutral float-right" title="Product and Updates Images" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
New lorax documentation - 28.14.33 Related: rhbz#1761653
2019-11-11 19:46:04 +00:00
<a href="lorax-composer.html" class="btn btn-neutral float-left" title="lorax-composer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
Update the generated html docs
2018-05-16 20:15:10 +00:00
</div>
<hr/>
<div role="contentinfo">
<p>
New lorax documentation - 28.14.33 Related: rhbz#1761653
2019-11-11 19:46:04 +00:00
&copy; Copyright 2018-2019, Red Hat, Inc.
Update the generated html docs
2018-05-16 20:15:10 +00:00
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/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">
jQuery(function () {
New lorax documentation - 28.13
2018-06-04 23:50:39 +00:00
SphinxRtdTheme.Navigation.enable(true);
Update the generated html docs
2018-05-16 20:15:10 +00:00
});
New lorax documentation - 28.14.33 Related: rhbz#1761653
2019-11-11 19:46:04 +00:00
</script>
Update the generated html docs
2018-05-16 20:15:10 +00:00
</body>
</html>
Reference in New Issue Copy Permalink