mirror of
https://github.com/kubevirt/kubevirt.core.git
synced 2026-04-12 11:50:55 +00:00
267 lines
20 KiB
HTML
267 lines
20 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Lean Ansible bindings for KubeVirt — Kubevirt Ansible Collection documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/ansible-basic-sphinx-ext.css" type="text/css" />
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/sphinx_highlight.js"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Plugin Index" href="plugins/index.html" />
|
||
<link rel="prev" title="Welcome to kubevirt.core Collection documentation" href="index.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">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home">
|
||
Kubevirt Ansible Collection
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Lean Ansible bindings for KubeVirt</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#code-of-conduct">Code of Conduct</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#communication">Communication</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#contributing-to-this-collection">Contributing to this collection</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#collection-maintenance">Collection maintenance</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#governance">Governance</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#tested-with-ansible">Tested with Ansible</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#external-requirements">External requirements</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#supported-connections">Supported connections</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#included-content">Included content</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#using-this-collection">Using this collection</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#installing-the-collection-from-ansible-galaxy">Installing the Collection from Ansible Galaxy</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#release-notes">Release notes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#roadmap">Roadmap</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#more-information">More information</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#licensing">Licensing</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="roles/index.html">Role Index</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="developing.html">Contributor’s Guidelines</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Collection Versioning Strategy</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">General</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="CHANGELOG.html">Changelog</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">Kubevirt Ansible Collection</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">Lean Ansible bindings for KubeVirt</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/README.md.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">
|
||
|
||
<section id="lean-ansible-bindings-for-kubevirt">
|
||
<h1>Lean Ansible bindings for KubeVirt<a class="headerlink" href="#lean-ansible-bindings-for-kubevirt" title="Permalink to this heading"></a></h1>
|
||
<!-- Add CI and code coverage badges here. Samples included below. -->
|
||
<p><a class="reference external" href="https://github.com/kubevirt/kubevirt.core/actions"><img alt="CI" src="https://github.com/kubevirt/kubevirt.core/workflows/CI/badge.svg?event=push" /></a></p>
|
||
<!-- Describe the collection and why a user would want to use it. What does the collection do? -->
|
||
<p>This repo hosts the kubevirt.core Ansible Collection.</p>
|
||
<p>The collection includes an inventory plugin for Ansible to automate the management of VMs running on KubeVirt.</p>
|
||
<section id="code-of-conduct">
|
||
<h2>Code of Conduct<a class="headerlink" href="#code-of-conduct" title="Permalink to this heading"></a></h2>
|
||
<p>We follow the <a class="reference external" href="https://docs.ansible.com/ansible/devel/community/code_of_conduct.html">Ansible Code of Conduct</a> in all our interactions within this project.</p>
|
||
<p>If you encounter abusive behavior, please refer to the <a class="reference external" href="https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations">policy violations</a> section of the Code for information on how to raise a complaint.</p>
|
||
</section>
|
||
<section id="communication">
|
||
<h2>Communication<a class="headerlink" href="#communication" title="Permalink to this heading"></a></h2>
|
||
<!--List available communication channels. In addition to channels specific to your collection, we also recommend to use the following ones.-->
|
||
<p>We announce releases and important changes through Ansible’s <a class="reference external" href="https://github.com/ansible/community/wiki/News#the-bullhorn">The Bullhorn newsletter</a>. Be sure you are <a class="reference external" href="https://eepurl.com/gZmiEP">subscribed</a>.</p>
|
||
<p>Join us in the <code class="docutils literal notranslate"><span class="pre">#ansible</span></code> (general use questions and support), <code class="docutils literal notranslate"><span class="pre">#ansible-community</span></code> (community and collection development questions), and other <a class="reference external" href="https://docs.ansible.com/ansible/devel/community/communication.html#irc-channels">IRC channels</a>.</p>
|
||
<p>We take part in the global quarterly <a class="reference external" href="https://github.com/ansible/community/wiki/Contributor-Summit">Ansible Contributor Summit</a> virtually or in-person. Track <a class="reference external" href="https://eepurl.com/gZmiEP">The Bullhorn newsletter</a> and join us.</p>
|
||
<p>For more information about communication, refer to the <a class="reference external" href="https://docs.ansible.com/ansible/devel/community/communication.html">Ansible Communication guide</a>.</p>
|
||
</section>
|
||
<section id="contributing-to-this-collection">
|
||
<h2>Contributing to this collection<a class="headerlink" href="#contributing-to-this-collection" title="Permalink to this heading"></a></h2>
|
||
<!--Describe how the community can contribute to your collection. At a minimum, fill up and include the CONTRIBUTING.md file containing how and where users can create issues to report problems or request features for this collection. List contribution requirements, including preferred workflows and necessary testing, so you can benefit from community PRs. If you are following general Ansible contributor guidelines, you can link to - [Ansible Community Guide](https://docs.ansible.com/ansible/devel/community/index.html). List the current maintainers (contributors with write or higher access to the repository). The following can be included:-->
|
||
<p>The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.</p>
|
||
<p>We are actively accepting new contributors.</p>
|
||
<p>Any kind of contribution is very welcome.</p>
|
||
<p>You don’t know how to start? Refer to our <a class="reference internal" href="CONTRIBUTING.html"><span class="std std-doc">contribution guide</span></a>!</p>
|
||
<p>We use the following guidelines:</p>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="CONTRIBUTING.html"><span class="std std-doc">CONTRIBUTING.md</span></a></p></li>
|
||
<li><p><a class="reference internal" href="#REVIEW_CHECKLIST.md"><span class="xref myst">REVIEW_CHECKLIST.md</span></a></p></li>
|
||
<li><p><a class="reference external" href="https://docs.ansible.com/ansible/latest/community/index.html">Ansible Community Guide</a></p></li>
|
||
<li><p><a class="reference external" href="https://docs.ansible.com/ansible/devel/dev_guide/index.html">Ansible Development Guide</a></p></li>
|
||
<li><p><a class="reference external" href="https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections">Ansible Collection Development Guide</a></p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="collection-maintenance">
|
||
<h2>Collection maintenance<a class="headerlink" href="#collection-maintenance" title="Permalink to this heading"></a></h2>
|
||
<p>The current maintainers are listed in the <a class="reference internal" href="#MAINTAINERS"><span class="xref myst">MAINTAINERS</span></a> file. If you have questions or need help, feel free to mention them in the proposals.</p>
|
||
<p>To learn how to maintain / become a maintainer of this collection, refer to the <a class="reference internal" href="#MAINTAINING.md"><span class="xref myst">Maintainer guidelines</span></a>.</p>
|
||
</section>
|
||
<section id="governance">
|
||
<h2>Governance<a class="headerlink" href="#governance" title="Permalink to this heading"></a></h2>
|
||
<!--Describe how the collection is governed. Here can be the following text:-->
|
||
<p>The process of decision making in this collection is based on discussing and finding consensus among participants.</p>
|
||
<p>Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let’s discuss it!</p>
|
||
</section>
|
||
<section id="tested-with-ansible">
|
||
<h2>Tested with Ansible<a class="headerlink" href="#tested-with-ansible" title="Permalink to this heading"></a></h2>
|
||
<!-- List the versions of Ansible the collection has been tested with. Must match what is in galaxy.yml. -->
|
||
</section>
|
||
<section id="external-requirements">
|
||
<h2>External requirements<a class="headerlink" href="#external-requirements" title="Permalink to this heading"></a></h2>
|
||
<!-- List any external resources the collection depends on, for example minimum versions of an OS, libraries, or utilities. Do not list other Ansible collections here. -->
|
||
<ul class="simple">
|
||
<li><p>python >= 3.6</p></li>
|
||
</ul>
|
||
<p>Python libraries:</p>
|
||
<ul class="simple">
|
||
<li><p>kubernetes</p></li>
|
||
<li><p>PyYaml</p></li>
|
||
<li><p>jsonpatch</p></li>
|
||
<li><p>jinja2</p></li>
|
||
</ul>
|
||
<section id="supported-connections">
|
||
<h3>Supported connections<a class="headerlink" href="#supported-connections" title="Permalink to this heading"></a></h3>
|
||
<!-- Optional. If your collection supports only specific connection types (such as HTTPAPI, netconf, or others), list them here. -->
|
||
</section>
|
||
</section>
|
||
<section id="included-content">
|
||
<h2>Included content<a class="headerlink" href="#included-content" title="Permalink to this heading"></a></h2>
|
||
<!-- Galaxy will eventually list the module docs within the UI, but until that is ready, you may need to either describe your plugins etc here, or point to an external docsite to cover that information. -->
|
||
</section>
|
||
<section id="using-this-collection">
|
||
<h2>Using this collection<a class="headerlink" href="#using-this-collection" title="Permalink to this heading"></a></h2>
|
||
<!--Include some quick examples that cover the most common use cases for your collection content. It can include the following examples of installation and upgrade (change NAMESPACE.COLLECTION_NAME correspondingly):-->
|
||
<section id="installing-the-collection-from-ansible-galaxy">
|
||
<h3>Installing the Collection from Ansible Galaxy<a class="headerlink" href="#installing-the-collection-from-ansible-galaxy" title="Permalink to this heading"></a></h3>
|
||
<p>Before using this collection, you need to install it with the Ansible Galaxy command-line tool:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ansible-galaxy<span class="w"> </span>collection<span class="w"> </span>install<span class="w"> </span>kubevirt.core
|
||
</pre></div>
|
||
</div>
|
||
<p>You can also include it in a <code class="docutils literal notranslate"><span class="pre">requirements.yml</span></code> file and install it with <code class="docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">-r</span> <span class="pre">requirements.yml</span></code>, using the format:</p>
|
||
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span>
|
||
<span class="nt">collections</span><span class="p">:</span>
|
||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubevirt.core</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the <code class="docutils literal notranslate"><span class="pre">ansible</span></code> package. To upgrade the collection to the latest available version, run the following command:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ansible-galaxy<span class="w"> </span>collection<span class="w"> </span>install<span class="w"> </span>kubevirt.core<span class="w"> </span>--upgrade
|
||
</pre></div>
|
||
</div>
|
||
<p>You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version <code class="docutils literal notranslate"><span class="pre">0.1.0</span></code>:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ansible-galaxy<span class="w"> </span>collection<span class="w"> </span>install<span class="w"> </span>kubevirt.core:<span class="o">==</span><span class="m">0</span>.1.0
|
||
</pre></div>
|
||
</div>
|
||
<p>See <a class="reference external" href="https://docs.ansible.com/ansible/devel/user_guide/collections_using.html">Ansible Using collections</a> for more details.</p>
|
||
</section>
|
||
</section>
|
||
<section id="release-notes">
|
||
<h2>Release notes<a class="headerlink" href="#release-notes" title="Permalink to this heading"></a></h2>
|
||
<p>See the <a class="reference external" href="https://github.com/ansible-collections/REPONAMEHERE/tree/main/CHANGELOG.rst">changelog</a>.</p>
|
||
</section>
|
||
<section id="roadmap">
|
||
<h2>Roadmap<a class="headerlink" href="#roadmap" title="Permalink to this heading"></a></h2>
|
||
<!-- Optional. Include the roadmap for this collection, and the proposed release/versioning strategy so users can anticipate the upgrade/update cycle. -->
|
||
</section>
|
||
<section id="more-information">
|
||
<h2>More information<a class="headerlink" href="#more-information" title="Permalink to this heading"></a></h2>
|
||
<!-- List out where the user can find additional information, such as working group meeting times, slack/IRC channels, or documentation for the product this collection automates. At a minimum, link to: -->
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="https://github.com/ansible-collections/overview">Ansible Collection overview</a></p></li>
|
||
<li><p><a class="reference external" href="https://docs.ansible.com/ansible/devel/user_guide/index.html">Ansible User guide</a></p></li>
|
||
<li><p><a class="reference external" href="https://docs.ansible.com/ansible/devel/dev_guide/index.html">Ansible Developer guide</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst">Ansible Collections Checklist</a></p></li>
|
||
<li><p><a class="reference external" href="https://docs.ansible.com/ansible/devel/community/code_of_conduct.html">Ansible Community code of conduct</a></p></li>
|
||
<li><p><a class="reference external" href="https://us19.campaign-archive.com/home/?u=56d874e027110e35dea0e03c1&amp;id=d6635f5420">The Bullhorn (the Ansible Contributor newsletter)</a></p></li>
|
||
<li><p><a class="reference external" href="https://github.com/ansible-collections/news-for-maintainers">News for Maintainers</a></p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="licensing">
|
||
<h2>Licensing<a class="headerlink" href="#licensing" title="Permalink to this heading"></a></h2>
|
||
<!-- Include the appropriate license information here and a pointer to the full licensing details. If the collection contains modules migrated from the ansible/ansible repo, you must use the same license that existed in the ansible/ansible repo. See the GNU license example below. -->
|
||
<p>GNU General Public License v3.0 or later.</p>
|
||
<p>See <a class="reference internal" href="#./LICENSE"><span class="xref myst">LICENSE</span></a> to see the full text.</p>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to kubevirt.core Collection documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="plugins/index.html" class="btn btn-neutral float-right" title="Plugin Index" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2023 Red Hat, Inc..</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |