mirror of
https://github.com/kubevirt/kubevirt.core.git
synced 2026-11-21 14:48:37 +00:00
Update docs for main
Signed-off-by: kubevirt-bot <kubevirtbot@redhat.com>
This commit is contained in:
+1
-1
@@ -1,4 +1,4 @@
|
||||
# Sphinx build info version 1
|
||||
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: b7d7f1b29d670bfaabeb3dbef2e0fc5c
|
||||
config: 3d5d6588cccbbabb3b3d6d2af9f338cc
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
||||
+225
-176
@@ -7,17 +7,16 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>KubeVirt Collection for Ansible Release Notes — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@@ -59,84 +58,94 @@
|
||||
<p class="caption" role="heading"><span class="caption-text">General</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-2-3">v2.2.3</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-3-0">v2.3.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#release-summary">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#minor-changes">Minor Changes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-2-2">v2.2.2</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id2">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-2-1">v2.2.1</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id3">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id4">Minor Changes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-2-0">v2.2.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id12">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-1-0">v2.1.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id13">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id14">Minor Changes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-0-0">v2.0.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id17">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id18">Minor Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#breaking-changes-porting-guide">Breaking Changes / Porting Guide</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#bugfixes">Bugfixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-5-0">v1.5.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id24">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#major-changes">Major Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id27">Minor Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id33">Bugfixes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-2-4">v2.2.4</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id5">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-4-0">v1.4.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id35">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id36">Minor Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-2-3">v2.2.3</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id6">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id7">Minor Changes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-2-2">v2.2.2</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id9">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-2-1">v2.2.1</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id10">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id11">Minor Changes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-2-0">v2.2.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id19">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-1-0">v2.1.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id20">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id21">Minor Changes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v2-0-0">v2.0.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id24">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id25">Minor Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#breaking-changes-porting-guide">Breaking Changes / Porting Guide</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id30">Bugfixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-5-0">v1.5.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id32">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#major-changes">Major Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id35">Minor Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id41">Bugfixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-3-2">v1.3.2</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id44">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-3-1">v1.3.1</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id45">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-3-0">v1.3.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id46">Minor Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-4-0">v1.4.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id43">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id44">Minor Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id49">Bugfixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-2-3">v1.2.3</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-3-2">v1.3.2</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id52">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-3-1">v1.3.1</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id53">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-3-0">v1.3.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id54">Minor Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id57">Bugfixes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-2-3">v1.2.3</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id61">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-2-2">v1.2.2</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id54">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id62">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-2-1">v1.2.1</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id55">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id63">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-2-0">v1.2.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id56">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id64">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-1-0">v1.1.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id57">Minor Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id65">Minor Changes</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id58">Release Summary</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id66">Release Summary</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -168,107 +177,119 @@
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="kubevirt-collection-for-ansible-release-notes">
|
||||
<h1><a class="toc-backref" href="#id59" role="doc-backlink">KubeVirt Collection for Ansible Release Notes</a><a class="headerlink" href="#kubevirt-collection-for-ansible-release-notes" title="Link to this heading"></a></h1>
|
||||
<h1><a class="toc-backref" href="#id67" role="doc-backlink">KubeVirt Collection for Ansible Release Notes</a><a class="headerlink" href="#kubevirt-collection-for-ansible-release-notes" title="Link to this heading"></a></h1>
|
||||
<nav class="contents" id="topics">
|
||||
<p class="topic-title">Topics</p>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#kubevirt-collection-for-ansible-release-notes" id="id59">KubeVirt Collection for Ansible Release Notes</a></p>
|
||||
<li><p><a class="reference internal" href="#kubevirt-collection-for-ansible-release-notes" id="id67">KubeVirt Collection for Ansible Release Notes</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#v2-2-3" id="id60">v2.2.3</a></p>
|
||||
<li><p><a class="reference internal" href="#v2-3-0" id="id68">v2.3.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#release-summary" id="id61">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#minor-changes" id="id62">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#release-summary" id="id69">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#minor-changes" id="id70">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#bugfixes" id="id71">Bugfixes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v2-2-2" id="id63">v2.2.2</a></p>
|
||||
<li><p><a class="reference internal" href="#v2-2-4" id="id72">v2.2.4</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id2" id="id64">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id5" id="id73">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v2-2-1" id="id65">v2.2.1</a></p>
|
||||
<li><p><a class="reference internal" href="#v2-2-3" id="id74">v2.2.3</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id3" id="id66">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id4" id="id67">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id6" id="id75">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id7" id="id76">Minor Changes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v2-2-0" id="id68">v2.2.0</a></p>
|
||||
<li><p><a class="reference internal" href="#v2-2-2" id="id77">v2.2.2</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id12" id="id69">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id9" id="id78">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v2-1-0" id="id70">v2.1.0</a></p>
|
||||
<li><p><a class="reference internal" href="#v2-2-1" id="id79">v2.2.1</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id13" id="id71">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id14" id="id72">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id10" id="id80">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id11" id="id81">Minor Changes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v2-0-0" id="id73">v2.0.0</a></p>
|
||||
<li><p><a class="reference internal" href="#v2-2-0" id="id82">v2.2.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id17" id="id74">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id18" id="id75">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id76">Breaking Changes / Porting Guide</a></p></li>
|
||||
<li><p><a class="reference internal" href="#bugfixes" id="id77">Bugfixes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id19" id="id83">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-5-0" id="id78">v1.5.0</a></p>
|
||||
<li><p><a class="reference internal" href="#v2-1-0" id="id84">v2.1.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id24" id="id79">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#major-changes" id="id80">Major Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id27" id="id81">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id33" id="id82">Bugfixes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id20" id="id85">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id21" id="id86">Minor Changes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-4-0" id="id83">v1.4.0</a></p>
|
||||
<li><p><a class="reference internal" href="#v2-0-0" id="id87">v2.0.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id35" id="id84">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id36" id="id85">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id41" id="id86">Bugfixes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id24" id="id88">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id25" id="id89">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#breaking-changes-porting-guide" id="id90">Breaking Changes / Porting Guide</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id30" id="id91">Bugfixes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-3-2" id="id87">v1.3.2</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-5-0" id="id92">v1.5.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id44" id="id88">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id32" id="id93">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#major-changes" id="id94">Major Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id35" id="id95">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id41" id="id96">Bugfixes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-3-1" id="id89">v1.3.1</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-4-0" id="id97">v1.4.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id45" id="id90">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id43" id="id98">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id44" id="id99">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id49" id="id100">Bugfixes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-3-0" id="id91">v1.3.0</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-3-2" id="id101">v1.3.2</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id46" id="id92">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id49" id="id93">Bugfixes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id52" id="id102">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-2-3" id="id94">v1.2.3</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-3-1" id="id103">v1.3.1</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id53" id="id95">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id53" id="id104">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-2-2" id="id96">v1.2.2</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-3-0" id="id105">v1.3.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id54" id="id97">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id54" id="id106">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id57" id="id107">Bugfixes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-2-1" id="id98">v1.2.1</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-2-3" id="id108">v1.2.3</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id55" id="id99">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id61" id="id109">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-2-0" id="id100">v1.2.0</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-2-2" id="id110">v1.2.2</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id56" id="id101">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id62" id="id111">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-1-0" id="id102">v1.1.0</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-2-1" id="id112">v1.2.1</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id57" id="id103">Minor Changes</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id63" id="id113">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-0-0" id="id104">v1.0.0</a></p>
|
||||
<li><p><a class="reference internal" href="#v1-2-0" id="id114">v1.2.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id58" id="id105">Release Summary</a></p></li>
|
||||
<li><p><a class="reference internal" href="#id64" id="id115">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-1-0" id="id116">v1.1.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id65" id="id117">Minor Changes</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p><a class="reference internal" href="#v1-0-0" id="id118">v1.0.0</a></p>
|
||||
<ul>
|
||||
<li><p><a class="reference internal" href="#id66" id="id119">Release Summary</a></p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -276,30 +297,58 @@
|
||||
</ul>
|
||||
</nav>
|
||||
<p>This changelog describes changes after version 1.0.0.</p>
|
||||
<section id="v2-2-3">
|
||||
<h2><a class="toc-backref" href="#id60" role="doc-backlink">v2.2.3</a><a class="headerlink" href="#v2-2-3" title="Link to this heading"></a></h2>
|
||||
<section id="v2-3-0">
|
||||
<h2><a class="toc-backref" href="#id68" role="doc-backlink">v2.3.0</a><a class="headerlink" href="#v2-3-0" title="Link to this heading"></a></h2>
|
||||
<section id="release-summary">
|
||||
<h3><a class="toc-backref" href="#id61" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Link to this heading"></a></h3>
|
||||
<p>This release ensures compatibility with kubernets.core >=5.2.0,<7.0.0. changes.</p>
|
||||
<h3><a class="toc-backref" href="#id69" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Link to this heading"></a></h3>
|
||||
<p>This release adds support for managing VM lifecycle using state=started/stopped/restarted in kubevirt_vm and introduces the default_win_ansible_connection option for the inventory plugin. It also fixes the handling of the user-configured strict option in the inventory plugin and adds compatibility with ansible-core 2.21.</p>
|
||||
</section>
|
||||
<section id="minor-changes">
|
||||
<h3><a class="toc-backref" href="#id62" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Link to this heading"></a></h3>
|
||||
<h3><a class="toc-backref" href="#id70" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>chore(ci): add ansible 2.21 and fix docs build <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/237">#237</a></p></li>
|
||||
<li><p>feat(inventory): add <code class="docutils literal notranslate"><span class="pre">default_win_ansible_connection</span></code> option <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/240">#240</a></p></li>
|
||||
<li><p>feat(kubevirt_vm): add <code class="docutils literal notranslate"><span class="pre">state=started/stopped/restarted</span></code> to manage VM lifecycle <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/242">#242</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="bugfixes">
|
||||
<h3><a class="toc-backref" href="#id71" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>fix: pass user-configured <code class="docutils literal notranslate"><span class="pre">strict</span></code> option to <code class="docutils literal notranslate"><span class="pre">_set_composite_vars</span></code> in kubevirt inventory plugin <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/235">#235</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v2-2-4">
|
||||
<h2><a class="toc-backref" href="#id72" role="doc-backlink">v2.2.4</a><a class="headerlink" href="#v2-2-4" title="Link to this heading"></a></h2>
|
||||
<section id="id5">
|
||||
<h3><a class="toc-backref" href="#id73" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id5" title="Link to this heading"></a></h3>
|
||||
<p>This is a service release with updated versions and dependencies.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v2-2-3">
|
||||
<h2><a class="toc-backref" href="#id74" role="doc-backlink">v2.2.3</a><a class="headerlink" href="#v2-2-3" title="Link to this heading"></a></h2>
|
||||
<section id="id6">
|
||||
<h3><a class="toc-backref" href="#id75" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id6" title="Link to this heading"></a></h3>
|
||||
<p>This release ensures compatibility with kubernets.core >=5.2.0,<7.0.0. changes.</p>
|
||||
</section>
|
||||
<section id="id7">
|
||||
<h3><a class="toc-backref" href="#id76" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id7" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Bump dependency on kubernetes.core and collection version <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/192">#192</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v2-2-2">
|
||||
<h2><a class="toc-backref" href="#id63" role="doc-backlink">v2.2.2</a><a class="headerlink" href="#v2-2-2" title="Link to this heading"></a></h2>
|
||||
<section id="id2">
|
||||
<h3><a class="toc-backref" href="#id64" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id2" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id77" role="doc-backlink">v2.2.2</a><a class="headerlink" href="#v2-2-2" title="Link to this heading"></a></h2>
|
||||
<section id="id9">
|
||||
<h3><a class="toc-backref" href="#id78" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id9" title="Link to this heading"></a></h3>
|
||||
<p>This is a maintenance release to trigger a rebuild. No functional changes.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v2-2-1">
|
||||
<h2><a class="toc-backref" href="#id65" role="doc-backlink">v2.2.1</a><a class="headerlink" href="#v2-2-1" title="Link to this heading"></a></h2>
|
||||
<section id="id3">
|
||||
<h3><a class="toc-backref" href="#id66" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id3" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id79" role="doc-backlink">v2.2.1</a><a class="headerlink" href="#v2-2-1" title="Link to this heading"></a></h2>
|
||||
<section id="id10">
|
||||
<h3><a class="toc-backref" href="#id80" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id10" title="Link to this heading"></a></h3>
|
||||
<p>This release brings some new features and enables compatibility with ansible-core-2.19.
|
||||
The inventory now tries to lookup winrm services for Windows hosts if enabled.
|
||||
The unset_ansible_port option was added to the inventory. It allows to control if the value of ansible_port should be unset if no non-default value was found.
|
||||
@@ -308,8 +357,8 @@ If no namespaces were configured the inventory now tries to use OCP Projects if
|
||||
It is now possible to switch between running and run_strategy with kubevirt_vm.
|
||||
This is a maintenance release with no functional changes compared to version 2.2.0. Only the changelog was fixed.</p>
|
||||
</section>
|
||||
<section id="id4">
|
||||
<h3><a class="toc-backref" href="#id67" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id4" title="Link to this heading"></a></h3>
|
||||
<section id="id11">
|
||||
<h3><a class="toc-backref" href="#id81" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id11" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>chore: Bump supported python and ansible-core versions <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/176">#176</a></p></li>
|
||||
<li><p>feat(inventory): Add unset_ansible_port option <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/173">#173</a></p></li>
|
||||
@@ -322,20 +371,20 @@ This is a maintenance release with no functional changes compared to version 2.2
|
||||
</section>
|
||||
</section>
|
||||
<section id="v2-2-0">
|
||||
<h2><a class="toc-backref" href="#id68" role="doc-backlink">v2.2.0</a><a class="headerlink" href="#v2-2-0" title="Link to this heading"></a></h2>
|
||||
<section id="id12">
|
||||
<h3><a class="toc-backref" href="#id69" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id12" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id82" role="doc-backlink">v2.2.0</a><a class="headerlink" href="#v2-2-0" title="Link to this heading"></a></h2>
|
||||
<section id="id19">
|
||||
<h3><a class="toc-backref" href="#id83" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id19" title="Link to this heading"></a></h3>
|
||||
<p>This release brings some new features and enables compatibility with ansible-core-2.19.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v2-1-0">
|
||||
<h2><a class="toc-backref" href="#id70" role="doc-backlink">v2.1.0</a><a class="headerlink" href="#v2-1-0" title="Link to this heading"></a></h2>
|
||||
<section id="id13">
|
||||
<h3><a class="toc-backref" href="#id71" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id13" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id84" role="doc-backlink">v2.1.0</a><a class="headerlink" href="#v2-1-0" title="Link to this heading"></a></h2>
|
||||
<section id="id20">
|
||||
<h3><a class="toc-backref" href="#id85" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id20" title="Link to this heading"></a></h3>
|
||||
<p>The kubevirt_vmi_info module was added to this collection.</p>
|
||||
</section>
|
||||
<section id="id14">
|
||||
<h3><a class="toc-backref" href="#id72" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id14" title="Link to this heading"></a></h3>
|
||||
<section id="id21">
|
||||
<h3><a class="toc-backref" href="#id86" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id21" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Run integration tests in random namespaces <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/130">#130</a></p></li>
|
||||
<li><p>feat: Add kubevirt_vmi_info module <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/129">#129</a></p></li>
|
||||
@@ -343,48 +392,48 @@ This is a maintenance release with no functional changes compared to version 2.2
|
||||
</section>
|
||||
</section>
|
||||
<section id="v2-0-0">
|
||||
<h2><a class="toc-backref" href="#id73" role="doc-backlink">v2.0.0</a><a class="headerlink" href="#v2-0-0" title="Link to this heading"></a></h2>
|
||||
<section id="id17">
|
||||
<h3><a class="toc-backref" href="#id74" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id17" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id87" role="doc-backlink">v2.0.0</a><a class="headerlink" href="#v2-0-0" title="Link to this heading"></a></h2>
|
||||
<section id="id24">
|
||||
<h3><a class="toc-backref" href="#id88" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id24" title="Link to this heading"></a></h3>
|
||||
<p>The deprecation of the ‘connections’ parameter is continued by dropping support for multiple connections. Inventory configurations with a single connection remain working for now. This backwards compatibility will be dropped in version 3.0.0 of the collection.
|
||||
Inventory source caching is now working and allows to reduce the load on the control plane of a cluster from which an inventory is built.</p>
|
||||
</section>
|
||||
<section id="id18">
|
||||
<h3><a class="toc-backref" href="#id75" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id18" title="Link to this heading"></a></h3>
|
||||
<section id="id25">
|
||||
<h3><a class="toc-backref" href="#id89" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id25" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Several small cleanups <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/122">#122</a></p></li>
|
||||
<li><p>feat(kubevirt_vm): Add support for RunStrategy <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/124">#124</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="breaking-changes-porting-guide">
|
||||
<h3><a class="toc-backref" href="#id76" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Link to this heading"></a></h3>
|
||||
<h3><a class="toc-backref" href="#id90" role="doc-backlink">Breaking Changes / Porting Guide</a><a class="headerlink" href="#breaking-changes-porting-guide" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>chore: Bump version to 2.0.0 <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/125">#125</a></p></li>
|
||||
<li><p>cleanup(inventory): Drop support for multiple connections <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/117">#117</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="bugfixes">
|
||||
<h3><a class="toc-backref" href="#id77" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Link to this heading"></a></h3>
|
||||
<section id="id30">
|
||||
<h3><a class="toc-backref" href="#id91" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id30" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>fix(inventory): Fix inventory source caching <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/119">#119</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v1-5-0">
|
||||
<h2><a class="toc-backref" href="#id78" role="doc-backlink">v1.5.0</a><a class="headerlink" href="#v1-5-0" title="Link to this heading"></a></h2>
|
||||
<section id="id24">
|
||||
<h3><a class="toc-backref" href="#id79" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id24" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id92" role="doc-backlink">v1.5.0</a><a class="headerlink" href="#v1-5-0" title="Link to this heading"></a></h2>
|
||||
<section id="id32">
|
||||
<h3><a class="toc-backref" href="#id93" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id32" title="Link to this heading"></a></h3>
|
||||
<p>Support for stopped VMs, deprecation of the ‘connections’ parameter and many cleanups.</p>
|
||||
</section>
|
||||
<section id="major-changes">
|
||||
<h3><a class="toc-backref" href="#id80" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Link to this heading"></a></h3>
|
||||
<h3><a class="toc-backref" href="#id94" role="doc-backlink">Major Changes</a><a class="headerlink" href="#major-changes" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>chore: Update supported ansible-core versions to >=2.15 <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/105">#105</a></p></li>
|
||||
<li><p>feat,test(inventory): Support listing stopped VMs and major rework of unit tests <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/114">#114</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="id27">
|
||||
<h3><a class="toc-backref" href="#id81" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id27" title="Link to this heading"></a></h3>
|
||||
<section id="id35">
|
||||
<h3><a class="toc-backref" href="#id95" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id35" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Bump e2e software versions <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/109">#109</a></p></li>
|
||||
<li><p>Make kubevirt_vm tests more robust <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/103">#103</a></p></li>
|
||||
@@ -393,21 +442,21 @@ Inventory source caching is now working and allows to reduce the load on the con
|
||||
<li><p>kubevirt_vm integration tests: changed ssh key type to RSA for FIPS mode <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/108">#108</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="id33">
|
||||
<h3><a class="toc-backref" href="#id82" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id33" title="Link to this heading"></a></h3>
|
||||
<section id="id41">
|
||||
<h3><a class="toc-backref" href="#id96" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id41" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>fix(tests,kubevirt_vm): Fix assertion in verify.yml <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/106">#106</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v1-4-0">
|
||||
<h2><a class="toc-backref" href="#id83" role="doc-backlink">v1.4.0</a><a class="headerlink" href="#v1-4-0" title="Link to this heading"></a></h2>
|
||||
<section id="id35">
|
||||
<h3><a class="toc-backref" href="#id84" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id35" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id97" role="doc-backlink">v1.4.0</a><a class="headerlink" href="#v1-4-0" title="Link to this heading"></a></h2>
|
||||
<section id="id43">
|
||||
<h3><a class="toc-backref" href="#id98" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id43" title="Link to this heading"></a></h3>
|
||||
<p>Compatibility with kubernetes.core >=3.1.0,<4.1.0 and some minor enhancements.</p>
|
||||
</section>
|
||||
<section id="id36">
|
||||
<h3><a class="toc-backref" href="#id85" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id36" title="Link to this heading"></a></h3>
|
||||
<section id="id44">
|
||||
<h3><a class="toc-backref" href="#id99" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id44" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Provide links for docsite and improve docs by adding markup <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/95">#95</a></p></li>
|
||||
<li><p>cleanup: Cleanup YAML passed to k8s module <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/88">#88</a></p></li>
|
||||
@@ -415,8 +464,8 @@ Inventory source caching is now working and allows to reduce the load on the con
|
||||
<li><p>feat(kubevirt_vm_info): Set wait_condition based on running <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/91">#91</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="id41">
|
||||
<h3><a class="toc-backref" href="#id86" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id41" title="Link to this heading"></a></h3>
|
||||
<section id="id49">
|
||||
<h3><a class="toc-backref" href="#id100" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id49" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>fix(kubevirt_vm): Set wait_condition based on running <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/89">#89</a></p></li>
|
||||
<li><p>fix: Ensure compatibility with kubernetes.core >=3.10,<4.1.0 <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/100">#100</a></p></li>
|
||||
@@ -424,30 +473,30 @@ Inventory source caching is now working and allows to reduce the load on the con
|
||||
</section>
|
||||
</section>
|
||||
<section id="v1-3-2">
|
||||
<h2><a class="toc-backref" href="#id87" role="doc-backlink">v1.3.2</a><a class="headerlink" href="#v1-3-2" title="Link to this heading"></a></h2>
|
||||
<section id="id44">
|
||||
<h3><a class="toc-backref" href="#id88" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id44" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id101" role="doc-backlink">v1.3.2</a><a class="headerlink" href="#v1-3-2" title="Link to this heading"></a></h2>
|
||||
<section id="id52">
|
||||
<h3><a class="toc-backref" href="#id102" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id52" title="Link to this heading"></a></h3>
|
||||
<p>No functional changes, hotfix release to retrigger the downstream build and to keep in sync with Ansible Automation Hub.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v1-3-1">
|
||||
<h2><a class="toc-backref" href="#id89" role="doc-backlink">v1.3.1</a><a class="headerlink" href="#v1-3-1" title="Link to this heading"></a></h2>
|
||||
<section id="id45">
|
||||
<h3><a class="toc-backref" href="#id90" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id45" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id103" role="doc-backlink">v1.3.1</a><a class="headerlink" href="#v1-3-1" title="Link to this heading"></a></h2>
|
||||
<section id="id53">
|
||||
<h3><a class="toc-backref" href="#id104" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id53" title="Link to this heading"></a></h3>
|
||||
<p>No functional changes, only updates to the shipped documentation.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v1-3-0">
|
||||
<h2><a class="toc-backref" href="#id91" role="doc-backlink">v1.3.0</a><a class="headerlink" href="#v1-3-0" title="Link to this heading"></a></h2>
|
||||
<section id="id46">
|
||||
<h3><a class="toc-backref" href="#id92" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id46" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id105" role="doc-backlink">v1.3.0</a><a class="headerlink" href="#v1-3-0" title="Link to this heading"></a></h2>
|
||||
<section id="id54">
|
||||
<h3><a class="toc-backref" href="#id106" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id54" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>feat: Add append_base_domain option to connections <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/72">#72</a></p></li>
|
||||
<li><p>feat: Give secondary interfaces a higher priority over services <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/76">#76</a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="id49">
|
||||
<h3><a class="toc-backref" href="#id93" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id49" title="Link to this heading"></a></h3>
|
||||
<section id="id57">
|
||||
<h3><a class="toc-backref" href="#id107" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id57" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>feat: Set ansible_connection to winrm for Windows hosts <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/75">#75</a></p></li>
|
||||
<li><p>fix: Explicity set ansible_port <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/70">#70</a></p></li>
|
||||
@@ -456,37 +505,37 @@ Inventory source caching is now working and allows to reduce the load on the con
|
||||
</section>
|
||||
</section>
|
||||
<section id="v1-2-3">
|
||||
<h2><a class="toc-backref" href="#id94" role="doc-backlink">v1.2.3</a><a class="headerlink" href="#v1-2-3" title="Link to this heading"></a></h2>
|
||||
<section id="id53">
|
||||
<h3><a class="toc-backref" href="#id95" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id53" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id108" role="doc-backlink">v1.2.3</a><a class="headerlink" href="#v1-2-3" title="Link to this heading"></a></h2>
|
||||
<section id="id61">
|
||||
<h3><a class="toc-backref" href="#id109" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id61" title="Link to this heading"></a></h3>
|
||||
<p>No functional changes, hotfix release to retrigger the downstream build and to keep in sync with Ansible Automation Hub.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v1-2-2">
|
||||
<h2><a class="toc-backref" href="#id96" role="doc-backlink">v1.2.2</a><a class="headerlink" href="#v1-2-2" title="Link to this heading"></a></h2>
|
||||
<section id="id54">
|
||||
<h3><a class="toc-backref" href="#id97" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id54" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id110" role="doc-backlink">v1.2.2</a><a class="headerlink" href="#v1-2-2" title="Link to this heading"></a></h2>
|
||||
<section id="id62">
|
||||
<h3><a class="toc-backref" href="#id111" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id62" title="Link to this heading"></a></h3>
|
||||
<p>No functional changes, only cleanup of files included in the release tarball and vendoring of documentation fragments.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v1-2-1">
|
||||
<h2><a class="toc-backref" href="#id98" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Link to this heading"></a></h2>
|
||||
<section id="id55">
|
||||
<h3><a class="toc-backref" href="#id99" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id55" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id112" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Link to this heading"></a></h2>
|
||||
<section id="id63">
|
||||
<h3><a class="toc-backref" href="#id113" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id63" title="Link to this heading"></a></h3>
|
||||
<p>Mostly code cleanups and dependency updates to ensure compatibility with KubeVirt >= 1.1.0</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v1-2-0">
|
||||
<h2><a class="toc-backref" href="#id100" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Link to this heading"></a></h2>
|
||||
<section id="id56">
|
||||
<h3><a class="toc-backref" href="#id101" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id56" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id114" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Link to this heading"></a></h2>
|
||||
<section id="id64">
|
||||
<h3><a class="toc-backref" href="#id115" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id64" title="Link to this heading"></a></h3>
|
||||
<p>Not released due to issues in the release process</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="v1-1-0">
|
||||
<h2><a class="toc-backref" href="#id102" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Link to this heading"></a></h2>
|
||||
<section id="id57">
|
||||
<h3><a class="toc-backref" href="#id103" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id57" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id116" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Link to this heading"></a></h2>
|
||||
<section id="id65">
|
||||
<h3><a class="toc-backref" href="#id117" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id65" title="Link to this heading"></a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add kubevirt_vm_info module to describe existing VirtualMachines</p></li>
|
||||
<li><p>inventory: Allow to control creation of additional groups</p></li>
|
||||
@@ -495,9 +544,9 @@ Inventory source caching is now working and allows to reduce the load on the con
|
||||
</section>
|
||||
</section>
|
||||
<section id="v1-0-0">
|
||||
<h2><a class="toc-backref" href="#id104" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Link to this heading"></a></h2>
|
||||
<section id="id58">
|
||||
<h3><a class="toc-backref" href="#id105" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id58" title="Link to this heading"></a></h3>
|
||||
<h2><a class="toc-backref" href="#id118" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Link to this heading"></a></h2>
|
||||
<section id="id66">
|
||||
<h3><a class="toc-backref" href="#id119" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id66" title="Link to this heading"></a></h3>
|
||||
<p>Initial release</p>
|
||||
</section>
|
||||
</section>
|
||||
@@ -513,7 +562,7 @@ Inventory source caching is now working and allows to reduce the load on the con
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
@@ -7,17 +7,16 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Contributing — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@@ -97,7 +96,7 @@
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
+6
-7
@@ -7,17 +7,16 @@
|
||||
|
||||
<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" type="text/css" href="_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@@ -118,7 +117,7 @@
|
||||
<!--start requires_ansible -->
|
||||
<section id="ansible-and-python-version-compatibility">
|
||||
<h2>Ansible and Python version compatibility<a class="headerlink" href="#ansible-and-python-version-compatibility" title="Link to this heading"></a></h2>
|
||||
<p>This collection has been tested against Ansible versions <strong>>=2.16,<=2.20</strong> and Python versions <strong>>=3.10,<=3.14</strong>.</p>
|
||||
<p>This collection has been tested against Ansible versions <strong>>=2.16,<=2.21</strong> and Python versions <strong>>=3.10,<=3.14</strong>.</p>
|
||||
<p>See the <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix">Ansible core support matrix</a> for supported combinations.</p>
|
||||
<!--end requires_ansible -->
|
||||
</section>
|
||||
@@ -237,7 +236,7 @@ ansible-galaxy<span class="w"> </span>collection<span class="w"> </span>install<
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
@@ -6,6 +6,34 @@ KubeVirt Collection for Ansible Release Notes
|
||||
|
||||
This changelog describes changes after version 1.0.0.
|
||||
|
||||
v2.3.0
|
||||
======
|
||||
|
||||
Release Summary
|
||||
---------------
|
||||
|
||||
This release adds support for managing VM lifecycle using state=started/stopped/restarted in kubevirt_vm and introduces the default_win_ansible_connection option for the inventory plugin. It also fixes the handling of the user-configured strict option in the inventory plugin and adds compatibility with ansible-core 2.21.
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- chore(ci): add ansible 2.21 and fix docs build `#237 <https://github.com/kubevirt/kubevirt.core/pull/237>`_
|
||||
- feat(inventory): add ``default_win_ansible_connection`` option `#240 <https://github.com/kubevirt/kubevirt.core/pull/240>`_
|
||||
- feat(kubevirt_vm): add ``state=started/stopped/restarted`` to manage VM lifecycle `#242 <https://github.com/kubevirt/kubevirt.core/pull/242>`_
|
||||
|
||||
Bugfixes
|
||||
--------
|
||||
|
||||
- fix: pass user-configured ``strict`` option to ``_set_composite_vars`` in kubevirt inventory plugin `#235 <https://github.com/kubevirt/kubevirt.core/pull/235>`_
|
||||
|
||||
v2.2.4
|
||||
======
|
||||
|
||||
Release Summary
|
||||
---------------
|
||||
|
||||
This is a service release with updated versions and dependencies.
|
||||
|
||||
v2.2.3
|
||||
======
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ This repository hosts the `kubevirt.core` Ansible Collection, which provides vir
|
||||
<!--start requires_ansible -->
|
||||
## Ansible and Python version compatibility
|
||||
|
||||
This collection has been tested against Ansible versions **>=2.16,<=2.20** and Python versions **>=3.10,<=3.14**.
|
||||
This collection has been tested against Ansible versions **>=2.16,<=2.21** and Python versions **>=3.10,<=3.14**.
|
||||
|
||||
See the [Ansible core support matrix](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix) for supported combinations.
|
||||
<!--end requires_ansible -->
|
||||
|
||||
@@ -12,13 +12,30 @@
|
||||
- All arguments have a specification in `meta/argument_specs.yml`
|
||||
- All playbooks/roles should be focused on compatibility with Ansible Automation Platform
|
||||
|
||||
### Before pushing
|
||||
|
||||
- Run `make format` before committing to auto-format the code. CI rejects unformatted PRs.
|
||||
- CI runs `yamllint`, `ansible-lint` (production profile) and `shellcheck`. Fix any violations before pushing
|
||||
|
||||
## Development environment
|
||||
|
||||
To develop and to run tests you need to install `tox` and `tox-ansible` on
|
||||
your machine.
|
||||
Install `tox` (version 4 or newer) and `tox-ansible`:
|
||||
|
||||
```
|
||||
pip install --user tox tox-ansible
|
||||
pip install --user 'tox>=4' tox-ansible
|
||||
```
|
||||
|
||||
With `--user`, `tox` is in `~/.local/bin`. Put it first on `PATH` before
|
||||
`make` targets that use `tox` (`build-venv`, `test-unit`, `test-sanity`):
|
||||
|
||||
```
|
||||
export PATH="$HOME/.local/bin:$PATH" # whole shell session
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
PATH="$HOME/.local/bin:$PATH" make <target> # command only
|
||||
```
|
||||
|
||||
### Virtualenv for development
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
:trim:
|
||||
|
||||
.. meta::
|
||||
:antsibull-docs: 2.23.0
|
||||
:antsibull-docs: 2.25.0
|
||||
|
||||
.. Anchors
|
||||
|
||||
@@ -443,6 +443,33 @@ Parameters
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-default_win_ansible_connection"></div>
|
||||
<p class="ansible-option-title"><strong>default_win_ansible_connection</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-default_win_ansible_connection" title="Permalink to this option"></a>
|
||||
<p class="ansible-option-type-line">
|
||||
<span class="ansible-option-type">string</span>
|
||||
</p>
|
||||
<p><em class="ansible-option-versionadded">added in kubevirt.core 2.3.0</em></p>
|
||||
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell">
|
||||
<p>Set the default value of <code class='docutils literal notranslate'>ansible_connection</code> when a Windows virtual machines is detected.</p>
|
||||
<p>Common values include <code class="ansible-value literal notranslate">winrm</code>, <code class="ansible-value literal notranslate">ansible.builtin.winrm</code>, <code class="ansible-value literal notranslate">psrp</code>, <code class="ansible-value literal notranslate">ansible.builtin.psrp</code>, <code class="ansible-value literal notranslate">ssh</code>, and <code class="ansible-value literal notranslate">ansible.builtin.ssh</code>.</p>
|
||||
<p>When set to <code class="ansible-value literal notranslate">ssh</code> or <code class="ansible-value literal notranslate">ansible.builtin.ssh</code>, the service port lookup uses SSH port (22) instead of WinRM/PSRP ports (5986/5985).</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>"winrm"</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"ansible.builtin.winrm"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"psrp"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"ansible.builtin.psrp"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"ssh"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"ansible.builtin.ssh"</code></p></li>
|
||||
</ul>
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-groups"></div>
|
||||
<p class="ansible-option-title"><strong>groups</strong></p>
|
||||
@@ -457,7 +484,7 @@ Parameters
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">{}</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-host"></div>
|
||||
<p class="ansible-option-title"><strong>host</strong></p>
|
||||
@@ -472,7 +499,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_HOST</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-host_format"></div>
|
||||
<p class="ansible-option-title"><strong>host_format</strong></p>
|
||||
@@ -487,7 +514,7 @@ Parameters
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">"{namespace}-{name}"</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-impersonate_groups"></div>
|
||||
<p class="ansible-option-title"><strong>impersonate_groups</strong></p>
|
||||
@@ -503,7 +530,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_IMPERSONATE_GROUPS</code> environment variable, e.g. <code class='docutils literal notranslate'>Group1,Group2</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-impersonate_user"></div>
|
||||
<p class="ansible-option-title"><strong>impersonate_user</strong></p>
|
||||
@@ -518,7 +545,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_IMPERSONATE_USER</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups"></div>
|
||||
<p class="ansible-option-title"><strong>keyed_groups</strong></p>
|
||||
@@ -534,7 +561,7 @@ Parameters
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">[]</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/default_value"></div>
|
||||
<p class="ansible-option-title"><strong>default_value</strong></p>
|
||||
@@ -550,7 +577,7 @@ Parameters
|
||||
<p>This option is mutually exclusive with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-keyed_groups/trailing_separator"><span class="std std-ref"><span class="pre">keyed_groups[].trailing_separator</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/key"></div>
|
||||
<p class="ansible-option-title"><strong>key</strong></p>
|
||||
@@ -564,7 +591,7 @@ Parameters
|
||||
<p>The key from input dictionary used to generate groups.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/parent_group"></div>
|
||||
<p class="ansible-option-title"><strong>parent_group</strong></p>
|
||||
@@ -578,7 +605,7 @@ Parameters
|
||||
<p>parent group for keyed group.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/prefix"></div>
|
||||
<p class="ansible-option-title"><strong>prefix</strong></p>
|
||||
@@ -593,7 +620,7 @@ Parameters
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">""</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/separator"></div>
|
||||
<p class="ansible-option-title"><strong>separator</strong></p>
|
||||
@@ -608,7 +635,7 @@ Parameters
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">"_"</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/trailing_separator"></div>
|
||||
<p class="ansible-option-title"><strong>trailing_separator</strong></p>
|
||||
@@ -631,7 +658,7 @@ Parameters
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-kube_secondary_dns"></div>
|
||||
<p class="ansible-option-title"><strong>kube_secondary_dns</strong></p>
|
||||
@@ -651,7 +678,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-kubeconfig"></div>
|
||||
<p class="ansible-option-title"><strong>kubeconfig</strong></p>
|
||||
@@ -668,7 +695,7 @@ Parameters
|
||||
<p>The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-label_selector"></div>
|
||||
<p class="ansible-option-title"><strong>label_selector</strong></p>
|
||||
@@ -682,7 +709,7 @@ Parameters
|
||||
<p>Define a label selector to select a subset of the fetched virtual machines.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-leading_separator"></div>
|
||||
<p class="ansible-option-title"><strong>leading_separator</strong></p>
|
||||
@@ -708,7 +735,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div>
|
||||
<p class="ansible-option-title"><strong>name</strong></p>
|
||||
@@ -722,7 +749,7 @@ Parameters
|
||||
<p>Optional name to assign to the cluster. If not provided, a name is constructed from the server and port.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-namespaces"></div>
|
||||
<p class="ansible-option-title"><strong>namespaces</strong></p>
|
||||
@@ -736,7 +763,7 @@ Parameters
|
||||
<p>List of namespaces. If not specified, will fetch virtual machines from all namespaces the user is authorized to access.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-network_name"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-interface_name"></div>
|
||||
@@ -752,7 +779,7 @@ Parameters
|
||||
<p>In case multiple networks are attached to a virtual machine, define which interface should be returned as primary IP address.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-no_proxy"></div>
|
||||
<p class="ansible-option-title"><strong>no_proxy</strong></p>
|
||||
@@ -770,7 +797,7 @@ Parameters
|
||||
<p>Example value is <code class='docutils literal notranslate'>localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-password"></div>
|
||||
<p class="ansible-option-title"><strong>password</strong></p>
|
||||
@@ -786,7 +813,7 @@ Parameters
|
||||
<p>Please read the description of the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-username"><span class="std std-ref"><span class="pre">username</span></span></a></strong></code> option for a discussion of when this option is applicable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-persist_config"></div>
|
||||
<p class="ansible-option-title"><strong>persist_config</strong></p>
|
||||
@@ -809,7 +836,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-plugin"></div>
|
||||
<p class="ansible-option-title"><strong>plugin</strong></p>
|
||||
@@ -830,7 +857,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy"></div>
|
||||
<p class="ansible-option-title"><strong>proxy</strong></p>
|
||||
@@ -846,7 +873,7 @@ Parameters
|
||||
<p>Please note that this module does not pick up typical proxy settings from the environment (e.g. <code class="xref std std-envvar literal notranslate">HTTP_PROXY</code>).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers"></div>
|
||||
<p class="ansible-option-title"><strong>proxy_headers</strong></p>
|
||||
@@ -861,7 +888,7 @@ Parameters
|
||||
<p>Documentation can be found here <a href='https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers'>https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers</a>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/basic_auth"></div>
|
||||
<p class="ansible-option-title"><strong>basic_auth</strong></p>
|
||||
@@ -876,7 +903,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_PROXY_HEADERS_BASIC_AUTH</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/proxy_basic_auth"></div>
|
||||
<p class="ansible-option-title"><strong>proxy_basic_auth</strong></p>
|
||||
@@ -891,7 +918,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/user_agent"></div>
|
||||
<p class="ansible-option-title"><strong>user_agent</strong></p>
|
||||
@@ -907,7 +934,7 @@ Parameters
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-strict"></div>
|
||||
<p class="ansible-option-title"><strong>strict</strong></p>
|
||||
@@ -928,7 +955,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-unset_ansible_port"></div>
|
||||
<p class="ansible-option-title"><strong>unset_ansible_port</strong></p>
|
||||
@@ -949,7 +976,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-use_extra_vars"></div>
|
||||
<p class="ansible-option-title"><strong>use_extra_vars</strong></p>
|
||||
@@ -983,7 +1010,7 @@ Parameters
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-use_service"></div>
|
||||
<p class="ansible-option-title"><strong>use_service</strong></p>
|
||||
@@ -1004,7 +1031,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-username"></div>
|
||||
<p class="ansible-option-title"><strong>username</strong></p>
|
||||
@@ -1019,7 +1046,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_USERNAME</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-verify_ssl"></div>
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
:trim:
|
||||
|
||||
.. meta::
|
||||
:antsibull-docs: 2.23.0
|
||||
:antsibull-docs: 2.25.0
|
||||
|
||||
.. Anchors
|
||||
|
||||
@@ -16,8 +16,8 @@
|
||||
|
||||
.. Title
|
||||
|
||||
kubevirt_vm -- Create or delete KubeVirt VirtualMachines
|
||||
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
kubevirt_vm -- Manage KubeVirt VirtualMachines
|
||||
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
|
||||
.. Collection note
|
||||
|
||||
@@ -48,7 +48,7 @@ Synopsis
|
||||
|
||||
.. Description
|
||||
|
||||
- Use the Kubernetes Python client to perform create or delete operations on KubeVirt VirtualMachines.
|
||||
- Use the Kubernetes Python client to perform create, delete, start, stop, or restart operations on KubeVirt VirtualMachines.
|
||||
- Pass options to create the VirtualMachine as module arguments.
|
||||
- Authenticate using either a config file, certificates, password or token.
|
||||
- Supports check mode.
|
||||
@@ -320,6 +320,22 @@ Parameters
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-grace_period_seconds"></div>
|
||||
<p class="ansible-option-title"><strong>grace_period_seconds</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-grace_period_seconds" title="Permalink to this option"></a>
|
||||
<p class="ansible-option-type-line">
|
||||
<span class="ansible-option-type">integer</span>
|
||||
</p>
|
||||
<p><em class="ansible-option-versionadded">added in kubevirt.core 2.3.0</em></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell">
|
||||
<p>Specify the grace period in seconds for stopping or restarting the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
|
||||
<p>Only used when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=stopped</span></span></a></code> or <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=restarted</span></span></a></code>.</p>
|
||||
<p>When used with <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=restarted</span></span></a></code>, the only supported values are <code class="ansible-value literal notranslate">null</code> (use the default grace period) and <code class="ansible-value literal notranslate">0</code> (force restart immediately).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-hidden_fields"></div>
|
||||
<p class="ansible-option-title"><strong>hidden_fields</strong></p>
|
||||
@@ -336,7 +352,7 @@ Parameters
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">["metadata.annotations[kubemacpool.io/transaction-timestamp]", "metadata.managedFields"]</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-host"></div>
|
||||
<p class="ansible-option-title"><strong>host</strong></p>
|
||||
@@ -350,7 +366,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_HOST</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-impersonate_groups"></div>
|
||||
<p class="ansible-option-title"><strong>impersonate_groups</strong></p>
|
||||
@@ -365,7 +381,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_IMPERSONATE_GROUPS</code> environment variable, e.g. <code class='docutils literal notranslate'>Group1,Group2</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-impersonate_user"></div>
|
||||
<p class="ansible-option-title"><strong>impersonate_user</strong></p>
|
||||
@@ -379,7 +395,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_IMPERSONATE_USER</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-instancetype"></div>
|
||||
<p class="ansible-option-title"><strong>instancetype</strong></p>
|
||||
@@ -393,7 +409,7 @@ Parameters
|
||||
<p>Only used when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-kubeconfig"></div>
|
||||
<p class="ansible-option-title"><strong>kubeconfig</strong></p>
|
||||
@@ -409,7 +425,7 @@ Parameters
|
||||
<p>The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-labels"></div>
|
||||
<p class="ansible-option-title"><strong>labels</strong></p>
|
||||
@@ -422,7 +438,7 @@ Parameters
|
||||
<p>Specify labels to set on the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div>
|
||||
<p class="ansible-option-title"><strong>name</strong></p>
|
||||
@@ -437,7 +453,7 @@ Parameters
|
||||
<p>Mutually exclusive with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-generate_name"><span class="std std-ref"><span class="pre">generate_name</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-namespace"></div>
|
||||
<p class="ansible-option-title"><strong>namespace</strong></p>
|
||||
@@ -451,7 +467,7 @@ Parameters
|
||||
<p>Specify the namespace of the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-no_proxy"></div>
|
||||
<p class="ansible-option-title"><strong>no_proxy</strong></p>
|
||||
@@ -468,7 +484,7 @@ Parameters
|
||||
<p>Example value is <code class='docutils literal notranslate'>localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-password"></div>
|
||||
<p class="ansible-option-title"><strong>password</strong></p>
|
||||
@@ -483,7 +499,7 @@ Parameters
|
||||
<p>Please read the description of the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-username"><span class="std std-ref"><span class="pre">username</span></span></a></strong></code> option for a discussion of when this option is applicable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-persist_config"></div>
|
||||
<p class="ansible-option-title"><strong>persist_config</strong></p>
|
||||
@@ -505,7 +521,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-preference"></div>
|
||||
<p class="ansible-option-title"><strong>preference</strong></p>
|
||||
@@ -519,7 +535,7 @@ Parameters
|
||||
<p>Only used when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy"></div>
|
||||
<p class="ansible-option-title"><strong>proxy</strong></p>
|
||||
@@ -534,7 +550,7 @@ Parameters
|
||||
<p>Please note that this module does not pick up typical proxy settings from the environment (e.g. <code class="xref std std-envvar literal notranslate">HTTP_PROXY</code>).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers"></div>
|
||||
<p class="ansible-option-title"><strong>proxy_headers</strong></p>
|
||||
@@ -548,7 +564,7 @@ Parameters
|
||||
<p>Documentation can be found here <a href='https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers'>https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers</a>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/basic_auth"></div>
|
||||
<p class="ansible-option-title"><strong>basic_auth</strong></p>
|
||||
@@ -562,7 +578,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_PROXY_HEADERS_BASIC_AUTH</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/proxy_basic_auth"></div>
|
||||
<p class="ansible-option-title"><strong>proxy_basic_auth</strong></p>
|
||||
@@ -576,7 +592,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/user_agent"></div>
|
||||
<p class="ansible-option-title"><strong>user_agent</strong></p>
|
||||
@@ -591,7 +607,7 @@ Parameters
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-run_strategy"></div>
|
||||
<p class="ansible-option-title"><strong>run_strategy</strong></p>
|
||||
@@ -615,7 +631,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-running"></div>
|
||||
<p class="ansible-option-title"><strong>running</strong></p>
|
||||
@@ -636,7 +652,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-spec"></div>
|
||||
<p class="ansible-option-title"><strong>spec</strong></p>
|
||||
@@ -650,7 +666,7 @@ Parameters
|
||||
<p>See <a href='https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec'>https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec</a></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-state"></div>
|
||||
<p class="ansible-option-title"><strong>state</strong></p>
|
||||
@@ -660,19 +676,25 @@ Parameters
|
||||
</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell">
|
||||
<p>Determines if an object should be created, patched, or deleted.</p>
|
||||
<p>Determines if an object should be created, patched, deleted, started, stopped, or restarted.</p>
|
||||
<p>When set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>, an object will be created, if it does not already exist.</p>
|
||||
<p>If set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=absent</span></span></a></code>, an existing object will be deleted.</p>
|
||||
<p>If set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>, an existing object will be patched, if its attributes differ from those specified.</p>
|
||||
<p>If set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=started</span></span></a></code>, it will be ensured that the <code class='docutils literal notranslate'>VirtualMachine</code> is running. Added in version 2.3.0.</p>
|
||||
<p>If set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=stopped</span></span></a></code>, it will be ensured that the <code class='docutils literal notranslate'>VirtualMachine</code> is stopped. Added in version 2.3.0.</p>
|
||||
<p>If set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=restarted</span></span></a></code>, it will be ensured that the <code class='docutils literal notranslate'>VirtualMachine</code> is restarted. Added in version 2.3.0.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"absent"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>"present"</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"restarted"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"started"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"stopped"</code></p></li>
|
||||
</ul>
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-username"></div>
|
||||
<p class="ansible-option-title"><strong>username</strong></p>
|
||||
@@ -686,7 +708,7 @@ Parameters
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_USERNAME</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-verify_ssl"></div>
|
||||
@@ -708,7 +730,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-wait"></div>
|
||||
<p class="ansible-option-title"><strong>wait</strong></p>
|
||||
@@ -727,7 +749,7 @@ Parameters
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-wait_sleep"></div>
|
||||
<p class="ansible-option-title"><strong>wait_sleep</strong></p>
|
||||
@@ -742,7 +764,7 @@ Parameters
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">5</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-wait_timeout"></div>
|
||||
<p class="ansible-option-title"><strong>wait_timeout</strong></p>
|
||||
@@ -866,6 +888,35 @@ Examples
|
||||
namespace: default
|
||||
state: absent
|
||||
|
||||
- name: Start a VirtualMachine
|
||||
kubevirt.core.kubevirt_vm:
|
||||
name: testvm
|
||||
namespace: default
|
||||
state: started
|
||||
wait: true
|
||||
|
||||
- name: Stop a VirtualMachine
|
||||
kubevirt.core.kubevirt_vm:
|
||||
name: testvm
|
||||
namespace: default
|
||||
state: stopped
|
||||
wait: true
|
||||
|
||||
- name: Restart a VirtualMachine
|
||||
kubevirt.core.kubevirt_vm:
|
||||
name: testvm
|
||||
namespace: default
|
||||
state: restarted
|
||||
wait: true
|
||||
|
||||
- name: Force restart a VirtualMachine
|
||||
kubevirt.core.kubevirt_vm:
|
||||
name: testvm
|
||||
namespace: default
|
||||
state: restarted
|
||||
grace_period_seconds: 0
|
||||
wait: true
|
||||
|
||||
|
||||
|
||||
.. Facts
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
:trim:
|
||||
|
||||
.. meta::
|
||||
:antsibull-docs: 2.23.0
|
||||
:antsibull-docs: 2.25.0
|
||||
|
||||
.. Anchors
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
:trim:
|
||||
|
||||
.. meta::
|
||||
:antsibull-docs: 2.23.0
|
||||
:antsibull-docs: 2.25.0
|
||||
|
||||
.. Anchors
|
||||
|
||||
|
||||
@@ -27,6 +27,16 @@ Run unit tests with `tox-ansible` like so:
|
||||
make test-unit
|
||||
```
|
||||
|
||||
`make test-unit` runs the full matrix in parallel. For local development, run
|
||||
one environment instead. If you installed tox with `--user`, put `~/.local/bin`
|
||||
first on `PATH` before running `tox`. See [developing.md](developing.md).
|
||||
|
||||
```
|
||||
tox -e unit-py3.11-2.16 --ansible --conf tox-ansible.ini
|
||||
```
|
||||
|
||||
List available unit envs with `tox -f unit --ansible --conf tox-ansible.ini -l`.
|
||||
|
||||
### Running tests with ansible-test
|
||||
|
||||
In order to test changes with `ansible-test`, it is recommended to bind mount
|
||||
@@ -135,4 +145,3 @@ ansible-playbook -i examples/inventory.kubevirt.yml examples/play-delete.yml
|
||||
# terminate the environment
|
||||
hack/e2e-setup.sh --cleanup
|
||||
```
|
||||
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
@charset "UTF-8";
|
||||
/* Copyright (c) Ansible and contributors */table.documentation-table{border-bottom:1px solid #000;border-right:1px solid #000}table.documentation-table td,table.documentation-table th{padding:4px;border-left:1px solid #000;border-top:1px solid #000}table.documentation-table td.elbow-placeholder{border-left:1px solid #000;border-top:0;width:30px;min-width:30px}table.documentation-table td{vertical-align:top}table.documentation-table td:first-child{white-space:nowrap}table.documentation-table .value-type{font-size:x-small;color:purple;display:inline}table.documentation-table .value-separator{font-size:x-small;display:inline}table.documentation-table .value-required{font-size:x-small;color:red;display:inline}table.documentation-table tr .ansibleOptionLink{display:inline-block;visibility:hidden}table.documentation-table tr .ansibleOptionLink:after{content:"🔗"}table.documentation-table tr:hover .ansibleOptionLink:after{visibility:visible}
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,476 @@
|
||||
// @ts-check
|
||||
|
||||
/**@constructor*/
|
||||
BaseStemmer = function() {
|
||||
/** @protected */
|
||||
this.current = '';
|
||||
this.cursor = 0;
|
||||
this.limit = 0;
|
||||
this.limit_backward = 0;
|
||||
this.bra = 0;
|
||||
this.ket = 0;
|
||||
|
||||
/**
|
||||
* @param {string} value
|
||||
*/
|
||||
this.setCurrent = function(value) {
|
||||
this.current = value;
|
||||
this.cursor = 0;
|
||||
this.limit = this.current.length;
|
||||
this.limit_backward = 0;
|
||||
this.bra = this.cursor;
|
||||
this.ket = this.limit;
|
||||
};
|
||||
|
||||
/**
|
||||
* @return {string}
|
||||
*/
|
||||
this.getCurrent = function() {
|
||||
return this.current;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {BaseStemmer} other
|
||||
*/
|
||||
this.copy_from = function(other) {
|
||||
/** @protected */
|
||||
this.current = other.current;
|
||||
this.cursor = other.cursor;
|
||||
this.limit = other.limit;
|
||||
this.limit_backward = other.limit_backward;
|
||||
this.bra = other.bra;
|
||||
this.ket = other.ket;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {number[]} s
|
||||
* @param {number} min
|
||||
* @param {number} max
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.in_grouping = function(s, min, max) {
|
||||
/** @protected */
|
||||
if (this.cursor >= this.limit) return false;
|
||||
var ch = this.current.charCodeAt(this.cursor);
|
||||
if (ch > max || ch < min) return false;
|
||||
ch -= min;
|
||||
if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return false;
|
||||
this.cursor++;
|
||||
return true;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {number[]} s
|
||||
* @param {number} min
|
||||
* @param {number} max
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.go_in_grouping = function(s, min, max) {
|
||||
/** @protected */
|
||||
while (this.cursor < this.limit) {
|
||||
var ch = this.current.charCodeAt(this.cursor);
|
||||
if (ch > max || ch < min)
|
||||
return true;
|
||||
ch -= min;
|
||||
if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0)
|
||||
return true;
|
||||
this.cursor++;
|
||||
}
|
||||
return false;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {number[]} s
|
||||
* @param {number} min
|
||||
* @param {number} max
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.in_grouping_b = function(s, min, max) {
|
||||
/** @protected */
|
||||
if (this.cursor <= this.limit_backward) return false;
|
||||
var ch = this.current.charCodeAt(this.cursor - 1);
|
||||
if (ch > max || ch < min) return false;
|
||||
ch -= min;
|
||||
if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return false;
|
||||
this.cursor--;
|
||||
return true;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {number[]} s
|
||||
* @param {number} min
|
||||
* @param {number} max
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.go_in_grouping_b = function(s, min, max) {
|
||||
/** @protected */
|
||||
while (this.cursor > this.limit_backward) {
|
||||
var ch = this.current.charCodeAt(this.cursor - 1);
|
||||
if (ch > max || ch < min) return true;
|
||||
ch -= min;
|
||||
if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) return true;
|
||||
this.cursor--;
|
||||
}
|
||||
return false;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {number[]} s
|
||||
* @param {number} min
|
||||
* @param {number} max
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.out_grouping = function(s, min, max) {
|
||||
/** @protected */
|
||||
if (this.cursor >= this.limit) return false;
|
||||
var ch = this.current.charCodeAt(this.cursor);
|
||||
if (ch > max || ch < min) {
|
||||
this.cursor++;
|
||||
return true;
|
||||
}
|
||||
ch -= min;
|
||||
if ((s[ch >>> 3] & (0X1 << (ch & 0x7))) == 0) {
|
||||
this.cursor++;
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {number[]} s
|
||||
* @param {number} min
|
||||
* @param {number} max
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.go_out_grouping = function(s, min, max) {
|
||||
/** @protected */
|
||||
while (this.cursor < this.limit) {
|
||||
var ch = this.current.charCodeAt(this.cursor);
|
||||
if (ch <= max && ch >= min) {
|
||||
ch -= min;
|
||||
if ((s[ch >>> 3] & (0X1 << (ch & 0x7))) != 0) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
this.cursor++;
|
||||
}
|
||||
return false;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {number[]} s
|
||||
* @param {number} min
|
||||
* @param {number} max
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.out_grouping_b = function(s, min, max) {
|
||||
/** @protected */
|
||||
if (this.cursor <= this.limit_backward) return false;
|
||||
var ch = this.current.charCodeAt(this.cursor - 1);
|
||||
if (ch > max || ch < min) {
|
||||
this.cursor--;
|
||||
return true;
|
||||
}
|
||||
ch -= min;
|
||||
if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) == 0) {
|
||||
this.cursor--;
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {number[]} s
|
||||
* @param {number} min
|
||||
* @param {number} max
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.go_out_grouping_b = function(s, min, max) {
|
||||
/** @protected */
|
||||
while (this.cursor > this.limit_backward) {
|
||||
var ch = this.current.charCodeAt(this.cursor - 1);
|
||||
if (ch <= max && ch >= min) {
|
||||
ch -= min;
|
||||
if ((s[ch >>> 3] & (0x1 << (ch & 0x7))) != 0) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
this.cursor--;
|
||||
}
|
||||
return false;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {string} s
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.eq_s = function(s)
|
||||
{
|
||||
/** @protected */
|
||||
if (this.limit - this.cursor < s.length) return false;
|
||||
if (this.current.slice(this.cursor, this.cursor + s.length) != s)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
this.cursor += s.length;
|
||||
return true;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {string} s
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.eq_s_b = function(s)
|
||||
{
|
||||
/** @protected */
|
||||
if (this.cursor - this.limit_backward < s.length) return false;
|
||||
if (this.current.slice(this.cursor - s.length, this.cursor) != s)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
this.cursor -= s.length;
|
||||
return true;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {Among[]} v
|
||||
* @return {number}
|
||||
*/
|
||||
this.find_among = function(v)
|
||||
{
|
||||
/** @protected */
|
||||
var i = 0;
|
||||
var j = v.length;
|
||||
|
||||
var c = this.cursor;
|
||||
var l = this.limit;
|
||||
|
||||
var common_i = 0;
|
||||
var common_j = 0;
|
||||
|
||||
var first_key_inspected = false;
|
||||
|
||||
while (true)
|
||||
{
|
||||
var k = i + ((j - i) >>> 1);
|
||||
var diff = 0;
|
||||
var common = common_i < common_j ? common_i : common_j; // smaller
|
||||
// w[0]: string, w[1]: substring_i, w[2]: result, w[3]: function (optional)
|
||||
var w = v[k];
|
||||
var i2;
|
||||
for (i2 = common; i2 < w[0].length; i2++)
|
||||
{
|
||||
if (c + common == l)
|
||||
{
|
||||
diff = -1;
|
||||
break;
|
||||
}
|
||||
diff = this.current.charCodeAt(c + common) - w[0].charCodeAt(i2);
|
||||
if (diff != 0) break;
|
||||
common++;
|
||||
}
|
||||
if (diff < 0)
|
||||
{
|
||||
j = k;
|
||||
common_j = common;
|
||||
}
|
||||
else
|
||||
{
|
||||
i = k;
|
||||
common_i = common;
|
||||
}
|
||||
if (j - i <= 1)
|
||||
{
|
||||
if (i > 0) break; // v->s has been inspected
|
||||
if (j == i) break; // only one item in v
|
||||
|
||||
// - but now we need to go round once more to get
|
||||
// v->s inspected. This looks messy, but is actually
|
||||
// the optimal approach.
|
||||
|
||||
if (first_key_inspected) break;
|
||||
first_key_inspected = true;
|
||||
}
|
||||
}
|
||||
do {
|
||||
var w = v[i];
|
||||
if (common_i >= w[0].length)
|
||||
{
|
||||
this.cursor = c + w[0].length;
|
||||
if (w.length < 4) return w[2];
|
||||
var res = w[3](this);
|
||||
this.cursor = c + w[0].length;
|
||||
if (res) return w[2];
|
||||
}
|
||||
i = w[1];
|
||||
} while (i >= 0);
|
||||
return 0;
|
||||
};
|
||||
|
||||
// find_among_b is for backwards processing. Same comments apply
|
||||
/**
|
||||
* @param {Among[]} v
|
||||
* @return {number}
|
||||
*/
|
||||
this.find_among_b = function(v)
|
||||
{
|
||||
/** @protected */
|
||||
var i = 0;
|
||||
var j = v.length
|
||||
|
||||
var c = this.cursor;
|
||||
var lb = this.limit_backward;
|
||||
|
||||
var common_i = 0;
|
||||
var common_j = 0;
|
||||
|
||||
var first_key_inspected = false;
|
||||
|
||||
while (true)
|
||||
{
|
||||
var k = i + ((j - i) >> 1);
|
||||
var diff = 0;
|
||||
var common = common_i < common_j ? common_i : common_j;
|
||||
var w = v[k];
|
||||
var i2;
|
||||
for (i2 = w[0].length - 1 - common; i2 >= 0; i2--)
|
||||
{
|
||||
if (c - common == lb)
|
||||
{
|
||||
diff = -1;
|
||||
break;
|
||||
}
|
||||
diff = this.current.charCodeAt(c - 1 - common) - w[0].charCodeAt(i2);
|
||||
if (diff != 0) break;
|
||||
common++;
|
||||
}
|
||||
if (diff < 0)
|
||||
{
|
||||
j = k;
|
||||
common_j = common;
|
||||
}
|
||||
else
|
||||
{
|
||||
i = k;
|
||||
common_i = common;
|
||||
}
|
||||
if (j - i <= 1)
|
||||
{
|
||||
if (i > 0) break;
|
||||
if (j == i) break;
|
||||
if (first_key_inspected) break;
|
||||
first_key_inspected = true;
|
||||
}
|
||||
}
|
||||
do {
|
||||
var w = v[i];
|
||||
if (common_i >= w[0].length)
|
||||
{
|
||||
this.cursor = c - w[0].length;
|
||||
if (w.length < 4) return w[2];
|
||||
var res = w[3](this);
|
||||
this.cursor = c - w[0].length;
|
||||
if (res) return w[2];
|
||||
}
|
||||
i = w[1];
|
||||
} while (i >= 0);
|
||||
return 0;
|
||||
};
|
||||
|
||||
/* to replace chars between c_bra and c_ket in this.current by the
|
||||
* chars in s.
|
||||
*/
|
||||
/**
|
||||
* @param {number} c_bra
|
||||
* @param {number} c_ket
|
||||
* @param {string} s
|
||||
* @return {number}
|
||||
*/
|
||||
this.replace_s = function(c_bra, c_ket, s)
|
||||
{
|
||||
/** @protected */
|
||||
var adjustment = s.length - (c_ket - c_bra);
|
||||
this.current = this.current.slice(0, c_bra) + s + this.current.slice(c_ket);
|
||||
this.limit += adjustment;
|
||||
if (this.cursor >= c_ket) this.cursor += adjustment;
|
||||
else if (this.cursor > c_bra) this.cursor = c_bra;
|
||||
return adjustment;
|
||||
};
|
||||
|
||||
/**
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.slice_check = function()
|
||||
{
|
||||
/** @protected */
|
||||
if (this.bra < 0 ||
|
||||
this.bra > this.ket ||
|
||||
this.ket > this.limit ||
|
||||
this.limit > this.current.length)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {number} c_bra
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.slice_from = function(s)
|
||||
{
|
||||
/** @protected */
|
||||
var result = false;
|
||||
if (this.slice_check())
|
||||
{
|
||||
this.replace_s(this.bra, this.ket, s);
|
||||
result = true;
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* @return {boolean}
|
||||
*/
|
||||
this.slice_del = function()
|
||||
{
|
||||
/** @protected */
|
||||
return this.slice_from("");
|
||||
};
|
||||
|
||||
/**
|
||||
* @param {number} c_bra
|
||||
* @param {number} c_ket
|
||||
* @param {string} s
|
||||
*/
|
||||
this.insert = function(c_bra, c_ket, s)
|
||||
{
|
||||
/** @protected */
|
||||
var adjustment = this.replace_s(c_bra, c_ket, s);
|
||||
if (c_bra <= this.bra) this.bra += adjustment;
|
||||
if (c_bra <= this.ket) this.ket += adjustment;
|
||||
};
|
||||
|
||||
/**
|
||||
* @return {string}
|
||||
*/
|
||||
this.slice_to = function()
|
||||
{
|
||||
/** @protected */
|
||||
var result = '';
|
||||
if (this.slice_check())
|
||||
{
|
||||
result = this.current.slice(this.bra, this.ket);
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* @return {string}
|
||||
*/
|
||||
this.assign_to = function()
|
||||
{
|
||||
/** @protected */
|
||||
return this.current.slice(0, this.limit);
|
||||
};
|
||||
};
|
||||
File diff suppressed because one or more lines are too long
@@ -59,7 +59,7 @@ const Documentation = {
|
||||
Object.assign(Documentation.TRANSLATIONS, catalog.messages);
|
||||
Documentation.PLURAL_EXPR = new Function(
|
||||
"n",
|
||||
`return (${catalog.plural_expr})`
|
||||
`return (${catalog.plural_expr})`,
|
||||
);
|
||||
Documentation.LOCALE = catalog.locale;
|
||||
},
|
||||
@@ -89,7 +89,7 @@ const Documentation = {
|
||||
|
||||
const togglerElements = document.querySelectorAll("img.toggler");
|
||||
togglerElements.forEach((el) =>
|
||||
el.addEventListener("click", (event) => toggler(event.currentTarget))
|
||||
el.addEventListener("click", (event) => toggler(event.currentTarget)),
|
||||
);
|
||||
togglerElements.forEach((el) => (el.style.display = ""));
|
||||
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
|
||||
@@ -98,14 +98,15 @@ const Documentation = {
|
||||
initOnKeyListeners: () => {
|
||||
// only install a listener if it is really needed
|
||||
if (
|
||||
!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
|
||||
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
|
||||
!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS
|
||||
&& !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
|
||||
)
|
||||
return;
|
||||
|
||||
document.addEventListener("keydown", (event) => {
|
||||
// bail for input elements
|
||||
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
|
||||
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName))
|
||||
return;
|
||||
// bail with special keys
|
||||
if (event.altKey || event.ctrlKey || event.metaKey) return;
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
+48
-48
@@ -5,26 +5,26 @@ td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5
|
||||
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
.highlight .hll { background-color: #ffffcc; border: 1px solid #edff00; padding-top: 2px; border-radius: 3px; display: block }
|
||||
.highlight { background: #f8f8f8; }
|
||||
.highlight .c { color: #6A737D; font-style: italic } /* Comment */
|
||||
.highlight .err { color: #A61717; background-color: #E3D2D2; border: 1px solid #F00 } /* Error */
|
||||
.highlight .c { color: #6a737d; font-style: italic } /* Comment */
|
||||
.highlight .err { color: #a61717; background-color: #e3d2d2; border: 1px solid #FF0000 } /* Error */
|
||||
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
|
||||
.highlight .l { color: #032F62 } /* Literal */
|
||||
.highlight .n { color: #333 } /* Name */
|
||||
.highlight .o { color: #666; font-weight: bold } /* Operator */
|
||||
.highlight .l { color: #032f62 } /* Literal */
|
||||
.highlight .n { color: #333333 } /* Name */
|
||||
.highlight .o { color: #666666; font-weight: bold } /* Operator */
|
||||
.highlight .p { font-weight: bold } /* Punctuation */
|
||||
.highlight .ch { color: #6A737D; font-style: italic } /* Comment.Hashbang */
|
||||
.highlight .cm { color: #6A737D; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .ch { color: #6a737d; font-style: italic } /* Comment.Hashbang */
|
||||
.highlight .cm { color: #6a737d; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .cp { color: #007020 } /* Comment.Preproc */
|
||||
.highlight .cpf { color: #6A737D; font-style: italic } /* Comment.PreprocFile */
|
||||
.highlight .c1 { color: #6A737D; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #999; font-weight: bold; font-style: italic; background-color: #FFF0F0 } /* Comment.Special */
|
||||
.highlight .gd { color: #A00000; background-color: #FDD } /* Generic.Deleted */
|
||||
.highlight .cpf { color: #6a737d; font-style: italic } /* Comment.PreprocFile */
|
||||
.highlight .c1 { color: #6a737d; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #999999; font-weight: bold; font-style: italic; background-color: #fff0f0 } /* Comment.Special */
|
||||
.highlight .gd { color: #A00000; background-color: #ffdddd } /* Generic.Deleted */
|
||||
.highlight .ge { font-style: italic } /* Generic.Emph */
|
||||
.highlight .gr { color: #A00 } /* Generic.Error */
|
||||
.highlight .gr { color: #aa0000 } /* Generic.Error */
|
||||
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
||||
.highlight .gi { color: #00A000; background-color: #DFD } /* Generic.Inserted */
|
||||
.highlight .go { color: #333 } /* Generic.Output */
|
||||
.highlight .gp { color: #C65D09; font-weight: bold } /* Generic.Prompt */
|
||||
.highlight .gi { color: #00A000; background-color: #ddffdd } /* Generic.Inserted */
|
||||
.highlight .go { color: #333333 } /* Generic.Output */
|
||||
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
|
||||
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
||||
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
||||
.highlight .gt { color: #0040D0 } /* Generic.Traceback */
|
||||
@@ -34,48 +34,48 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
|
||||
.highlight .kp { color: #007020; font-weight: bold } /* Keyword.Pseudo */
|
||||
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
|
||||
.highlight .kt { color: #902000; font-weight: bold } /* Keyword.Type */
|
||||
.highlight .ld { color: #032F62 } /* Literal.Date */
|
||||
.highlight .ld { color: #032f62 } /* Literal.Date */
|
||||
.highlight .m { color: #208050 } /* Literal.Number */
|
||||
.highlight .s { color: #4070A0 } /* Literal.String */
|
||||
.highlight .s { color: #4070a0 } /* Literal.String */
|
||||
.highlight .na { color: #008080 } /* Name.Attribute */
|
||||
.highlight .nb { color: #0086B3 } /* Name.Builtin */
|
||||
.highlight .nc { color: #458; font-weight: bold } /* Name.Class */
|
||||
.highlight .nb { color: #0086b3 } /* Name.Builtin */
|
||||
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
|
||||
.highlight .no { color: #008080 } /* Name.Constant */
|
||||
.highlight .nd { color: #555; font-weight: bold } /* Name.Decorator */
|
||||
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
|
||||
.highlight .ni { color: #800080; font-weight: bold } /* Name.Entity */
|
||||
.highlight .ne { color: #900; font-weight: bold } /* Name.Exception */
|
||||
.highlight .nf { color: #900; font-weight: bold } /* Name.Function */
|
||||
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
|
||||
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
|
||||
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
|
||||
.highlight .nn { color: #555; font-weight: bold } /* Name.Namespace */
|
||||
.highlight .nx { color: #333 } /* Name.Other */
|
||||
.highlight .py { color: #333 } /* Name.Property */
|
||||
.highlight .nt { color: #22863A; font-weight: bold } /* Name.Tag */
|
||||
.highlight .nv { color: #9960B5; font-weight: bold } /* Name.Variable */
|
||||
.highlight .nn { color: #555555; font-weight: bold } /* Name.Namespace */
|
||||
.highlight .nx { color: #333333 } /* Name.Other */
|
||||
.highlight .py { color: #333333 } /* Name.Property */
|
||||
.highlight .nt { color: #22863a; font-weight: bold } /* Name.Tag */
|
||||
.highlight .nv { color: #9960b5; font-weight: bold } /* Name.Variable */
|
||||
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
|
||||
.highlight .pm { font-weight: bold } /* Punctuation.Marker */
|
||||
.highlight .w { color: #BBB } /* Text.Whitespace */
|
||||
.highlight .mb { color: #099 } /* Literal.Number.Bin */
|
||||
.highlight .mf { color: #099 } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #099 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #099 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #099 } /* Literal.Number.Oct */
|
||||
.highlight .sa { color: #D14 } /* Literal.String.Affix */
|
||||
.highlight .sb { color: #D14 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #D14 } /* Literal.String.Char */
|
||||
.highlight .dl { color: #D14 } /* Literal.String.Delimiter */
|
||||
.highlight .sd { color: #D14; font-style: italic } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #D14 } /* Literal.String.Double */
|
||||
.highlight .se { color: #D14; font-weight: bold } /* Literal.String.Escape */
|
||||
.highlight .sh { color: #D14 } /* Literal.String.Heredoc */
|
||||
.highlight .si { color: #D14; font-style: italic } /* Literal.String.Interpol */
|
||||
.highlight .sx { color: #D14 } /* Literal.String.Other */
|
||||
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
||||
.highlight .mb { color: #009999 } /* Literal.Number.Bin */
|
||||
.highlight .mf { color: #009999 } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #009999 } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #009999 } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #009999 } /* Literal.Number.Oct */
|
||||
.highlight .sa { color: #dd1144 } /* Literal.String.Affix */
|
||||
.highlight .sb { color: #dd1144 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #dd1144 } /* Literal.String.Char */
|
||||
.highlight .dl { color: #dd1144 } /* Literal.String.Delimiter */
|
||||
.highlight .sd { color: #dd1144; font-style: italic } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #dd1144 } /* Literal.String.Double */
|
||||
.highlight .se { color: #dd1144; font-weight: bold } /* Literal.String.Escape */
|
||||
.highlight .sh { color: #dd1144 } /* Literal.String.Heredoc */
|
||||
.highlight .si { color: #dd1144; font-style: italic } /* Literal.String.Interpol */
|
||||
.highlight .sx { color: #dd1144 } /* Literal.String.Other */
|
||||
.highlight .sr { color: #009926 } /* Literal.String.Regex */
|
||||
.highlight .s1 { color: #D14 } /* Literal.String.Single */
|
||||
.highlight .s1 { color: #dd1144 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #990073 } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #999 } /* Name.Builtin.Pseudo */
|
||||
.highlight .fm { color: #06287E; font-weight: bold } /* Name.Function.Magic */
|
||||
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
|
||||
.highlight .fm { color: #06287e; font-weight: bold } /* Name.Function.Magic */
|
||||
.highlight .vc { color: #008080; font-weight: bold } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #008080; font-weight: bold } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #008080; font-weight: bold } /* Name.Variable.Instance */
|
||||
.highlight .vm { color: #BB60D5; font-weight: bold } /* Name.Variable.Magic */
|
||||
.highlight .il { color: #099 } /* Literal.Number.Integer.Long */
|
||||
.highlight .vm { color: #bb60d5; font-weight: bold } /* Name.Variable.Magic */
|
||||
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
|
||||
+115
-57
@@ -41,11 +41,12 @@ if (typeof Scorer === "undefined") {
|
||||
}
|
||||
|
||||
// Global search result kind enum, used by themes to style search results.
|
||||
// prettier-ignore
|
||||
class SearchResultKind {
|
||||
static get index() { return "index"; }
|
||||
static get object() { return "object"; }
|
||||
static get text() { return "text"; }
|
||||
static get title() { return "title"; }
|
||||
static get index() { return "index"; }
|
||||
static get object() { return "object"; }
|
||||
static get text() { return "text"; }
|
||||
static get title() { return "title"; }
|
||||
}
|
||||
|
||||
const _removeChildren = (element) => {
|
||||
@@ -58,6 +59,15 @@ const _removeChildren = (element) => {
|
||||
const _escapeRegExp = (string) =>
|
||||
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
|
||||
|
||||
const _escapeHTML = (text) => {
|
||||
return text
|
||||
.replaceAll("&", "&")
|
||||
.replaceAll("<", "<")
|
||||
.replaceAll(">", ">")
|
||||
.replaceAll('"', """)
|
||||
.replaceAll("'", "'");
|
||||
};
|
||||
|
||||
const _displayItem = (item, searchTerms, highlightTerms) => {
|
||||
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
|
||||
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
||||
@@ -90,25 +100,30 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
|
||||
let linkEl = listItem.appendChild(document.createElement("a"));
|
||||
linkEl.href = linkUrl + anchor;
|
||||
linkEl.dataset.score = score;
|
||||
linkEl.innerHTML = title;
|
||||
linkEl.innerHTML = _escapeHTML(title);
|
||||
if (descr) {
|
||||
listItem.appendChild(document.createElement("span")).innerHTML =
|
||||
" (" + descr + ")";
|
||||
` (${_escapeHTML(descr)})`;
|
||||
// highlight search terms in the description
|
||||
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
|
||||
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
|
||||
}
|
||||
else if (showSearchSummary)
|
||||
if (SPHINX_HIGHLIGHT_ENABLED)
|
||||
// SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js
|
||||
highlightTerms.forEach((term) =>
|
||||
_highlightText(listItem, term, "highlighted"),
|
||||
);
|
||||
} else if (showSearchSummary)
|
||||
fetch(requestUrl)
|
||||
.then((responseData) => responseData.text())
|
||||
.then((data) => {
|
||||
if (data)
|
||||
listItem.appendChild(
|
||||
Search.makeSearchSummary(data, searchTerms, anchor)
|
||||
Search.makeSearchSummary(data, searchTerms, anchor),
|
||||
);
|
||||
// highlight search terms in the summary
|
||||
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
|
||||
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
|
||||
if (SPHINX_HIGHLIGHT_ENABLED)
|
||||
// SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js
|
||||
highlightTerms.forEach((term) =>
|
||||
_highlightText(listItem, term, "highlighted"),
|
||||
);
|
||||
});
|
||||
Search.output.appendChild(listItem);
|
||||
};
|
||||
@@ -117,14 +132,14 @@ const _finishSearch = (resultCount) => {
|
||||
Search.title.innerText = _("Search Results");
|
||||
if (!resultCount)
|
||||
Search.status.innerText = Documentation.gettext(
|
||||
"Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
|
||||
"Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories.",
|
||||
);
|
||||
else
|
||||
Search.status.innerText = Documentation.ngettext(
|
||||
"Search finished, found one page matching the search query.",
|
||||
"Search finished, found ${resultCount} pages matching the search query.",
|
||||
resultCount,
|
||||
).replace('${resultCount}', resultCount);
|
||||
).replace("${resultCount}", resultCount);
|
||||
};
|
||||
const _displayNextItem = (
|
||||
results,
|
||||
@@ -138,7 +153,7 @@ const _displayNextItem = (
|
||||
_displayItem(results.pop(), searchTerms, highlightTerms);
|
||||
setTimeout(
|
||||
() => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
|
||||
5
|
||||
5,
|
||||
);
|
||||
}
|
||||
// search finished, update title and status message
|
||||
@@ -170,9 +185,10 @@ const _orderResultsByScoreThenName = (a, b) => {
|
||||
* This is the same as ``\W+`` in Python, preserving the surrogate pair area.
|
||||
*/
|
||||
if (typeof splitQuery === "undefined") {
|
||||
var splitQuery = (query) => query
|
||||
var splitQuery = (query) =>
|
||||
query
|
||||
.split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
|
||||
.filter(term => term) // remove remaining empty strings
|
||||
.filter((term) => term); // remove remaining empty strings
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -184,16 +200,23 @@ const Search = {
|
||||
_pulse_status: -1,
|
||||
|
||||
htmlToText: (htmlString, anchor) => {
|
||||
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
|
||||
const htmlElement = new DOMParser().parseFromString(
|
||||
htmlString,
|
||||
"text/html",
|
||||
);
|
||||
for (const removalQuery of [".headerlink", "script", "style"]) {
|
||||
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
|
||||
htmlElement.querySelectorAll(removalQuery).forEach((el) => {
|
||||
el.remove();
|
||||
});
|
||||
}
|
||||
if (anchor) {
|
||||
const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
|
||||
const anchorContent = htmlElement.querySelector(
|
||||
`[role="main"] ${anchor}`,
|
||||
);
|
||||
if (anchorContent) return anchorContent.textContent;
|
||||
|
||||
console.warn(
|
||||
`Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
|
||||
`Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`,
|
||||
);
|
||||
}
|
||||
|
||||
@@ -202,7 +225,7 @@ const Search = {
|
||||
if (docContent) return docContent.textContent;
|
||||
|
||||
console.warn(
|
||||
"Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
|
||||
"Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template.",
|
||||
);
|
||||
return "";
|
||||
},
|
||||
@@ -287,12 +310,8 @@ const Search = {
|
||||
const queryTermLower = queryTerm.toLowerCase();
|
||||
|
||||
// maybe skip this "word"
|
||||
// stopwords array is from language_data.js
|
||||
if (
|
||||
stopwords.indexOf(queryTermLower) !== -1 ||
|
||||
queryTerm.match(/^\d+$/)
|
||||
)
|
||||
return;
|
||||
// stopwords set is from language_data.js
|
||||
if (stopwords.has(queryTermLower) || queryTerm.match(/^\d+$/)) return;
|
||||
|
||||
// stem the word
|
||||
let word = stemmer.stemWord(queryTermLower);
|
||||
@@ -304,8 +323,12 @@ const Search = {
|
||||
}
|
||||
});
|
||||
|
||||
if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
|
||||
localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
|
||||
if (SPHINX_HIGHLIGHT_ENABLED) {
|
||||
// SPHINX_HIGHLIGHT_ENABLED is set in sphinx_highlight.js
|
||||
localStorage.setItem(
|
||||
"sphinx_highlight_terms",
|
||||
[...highlightTerms].join(" "),
|
||||
);
|
||||
}
|
||||
|
||||
// console.debug("SEARCH: searching for:");
|
||||
@@ -318,7 +341,13 @@ const Search = {
|
||||
/**
|
||||
* execute search (requires search index to be loaded)
|
||||
*/
|
||||
_performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
|
||||
_performSearch: (
|
||||
query,
|
||||
searchTerms,
|
||||
excludedTerms,
|
||||
highlightTerms,
|
||||
objectTerms,
|
||||
) => {
|
||||
const filenames = Search._index.filenames;
|
||||
const docNames = Search._index.docnames;
|
||||
const titles = Search._index.titles;
|
||||
@@ -334,10 +363,15 @@ const Search = {
|
||||
|
||||
const queryLower = query.toLowerCase().trim();
|
||||
for (const [title, foundTitles] of Object.entries(allTitles)) {
|
||||
if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
|
||||
if (
|
||||
title.toLowerCase().trim().includes(queryLower)
|
||||
&& queryLower.length >= title.length / 2
|
||||
) {
|
||||
for (const [file, id] of foundTitles) {
|
||||
const score = Math.round(Scorer.title * queryLower.length / title.length);
|
||||
const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
|
||||
const score = Math.round(
|
||||
(Scorer.title * queryLower.length) / title.length,
|
||||
);
|
||||
const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
|
||||
normalResults.push([
|
||||
docNames[file],
|
||||
titles[file] !== title ? `${titles[file]} > ${title}` : title,
|
||||
@@ -353,9 +387,9 @@ const Search = {
|
||||
|
||||
// search for explicit entries in index directives
|
||||
for (const [entry, foundEntries] of Object.entries(indexEntries)) {
|
||||
if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
|
||||
if (entry.includes(queryLower) && queryLower.length >= entry.length / 2) {
|
||||
for (const [file, id, isMain] of foundEntries) {
|
||||
const score = Math.round(100 * queryLower.length / entry.length);
|
||||
const score = Math.round((100 * queryLower.length) / entry.length);
|
||||
const result = [
|
||||
docNames[file],
|
||||
titles[file],
|
||||
@@ -376,11 +410,13 @@ const Search = {
|
||||
|
||||
// lookup as object
|
||||
objectTerms.forEach((term) =>
|
||||
normalResults.push(...Search.performObjectSearch(term, objectTerms))
|
||||
normalResults.push(...Search.performObjectSearch(term, objectTerms)),
|
||||
);
|
||||
|
||||
// lookup as search terms in fulltext
|
||||
normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
|
||||
normalResults.push(
|
||||
...Search.performTermsSearch(searchTerms, excludedTerms),
|
||||
);
|
||||
|
||||
// let the scorer override scores with a custom scoring function
|
||||
if (Scorer.score) {
|
||||
@@ -401,7 +437,11 @@ const Search = {
|
||||
// note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
|
||||
let seen = new Set();
|
||||
results = results.reverse().reduce((acc, result) => {
|
||||
let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
|
||||
let resultStr = result
|
||||
.slice(0, 4)
|
||||
.concat([result[5]])
|
||||
.map((v) => String(v))
|
||||
.join(",");
|
||||
if (!seen.has(resultStr)) {
|
||||
acc.push(result);
|
||||
seen.add(resultStr);
|
||||
@@ -413,8 +453,20 @@ const Search = {
|
||||
},
|
||||
|
||||
query: (query) => {
|
||||
const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
|
||||
const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
|
||||
const [
|
||||
searchQuery,
|
||||
searchTerms,
|
||||
excludedTerms,
|
||||
highlightTerms,
|
||||
objectTerms,
|
||||
] = Search._parseQuery(query);
|
||||
const results = Search._performSearch(
|
||||
searchQuery,
|
||||
searchTerms,
|
||||
excludedTerms,
|
||||
highlightTerms,
|
||||
objectTerms,
|
||||
);
|
||||
|
||||
// for debugging
|
||||
//Search.lastresults = results.slice(); // a copy
|
||||
@@ -437,7 +489,7 @@ const Search = {
|
||||
const results = [];
|
||||
|
||||
const objectSearchCallback = (prefix, match) => {
|
||||
const name = match[4]
|
||||
const name = match[4];
|
||||
const fullname = (prefix ? prefix + "." : "") + name;
|
||||
const fullnameLower = fullname.toLowerCase();
|
||||
if (fullnameLower.indexOf(object) < 0) return;
|
||||
@@ -489,9 +541,7 @@ const Search = {
|
||||
]);
|
||||
};
|
||||
Object.keys(objects).forEach((prefix) =>
|
||||
objects[prefix].forEach((array) =>
|
||||
objectSearchCallback(prefix, array)
|
||||
)
|
||||
objects[prefix].forEach((array) => objectSearchCallback(prefix, array)),
|
||||
);
|
||||
return results;
|
||||
},
|
||||
@@ -516,8 +566,14 @@ const Search = {
|
||||
// find documents, if any, containing the query word in their text/title term indices
|
||||
// use Object.hasOwnProperty to avoid mismatching against prototype properties
|
||||
const arr = [
|
||||
{ files: terms.hasOwnProperty(word) ? terms[word] : undefined, score: Scorer.term },
|
||||
{ files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, score: Scorer.title },
|
||||
{
|
||||
files: terms.hasOwnProperty(word) ? terms[word] : undefined,
|
||||
score: Scorer.term,
|
||||
},
|
||||
{
|
||||
files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined,
|
||||
score: Scorer.title,
|
||||
},
|
||||
];
|
||||
// add support for partial matches
|
||||
if (word.length > 2) {
|
||||
@@ -558,7 +614,8 @@ const Search = {
|
||||
// create the mapping
|
||||
files.forEach((file) => {
|
||||
if (!fileMap.has(file)) fileMap.set(file, [word]);
|
||||
else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
|
||||
else if (fileMap.get(file).indexOf(word) === -1)
|
||||
fileMap.get(file).push(word);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -569,11 +626,11 @@ const Search = {
|
||||
|
||||
// as search terms with length < 3 are discarded
|
||||
const filteredTermCount = [...searchTerms].filter(
|
||||
(term) => term.length > 2
|
||||
(term) => term.length > 2,
|
||||
).length;
|
||||
if (
|
||||
wordList.length !== searchTerms.size &&
|
||||
wordList.length !== filteredTermCount
|
||||
wordList.length !== searchTerms.size
|
||||
&& wordList.length !== filteredTermCount
|
||||
)
|
||||
continue;
|
||||
|
||||
@@ -581,10 +638,10 @@ const Search = {
|
||||
if (
|
||||
[...excludedTerms].some(
|
||||
(term) =>
|
||||
terms[term] === file ||
|
||||
titleTerms[term] === file ||
|
||||
(terms[term] || []).includes(file) ||
|
||||
(titleTerms[term] || []).includes(file)
|
||||
terms[term] === file
|
||||
|| titleTerms[term] === file
|
||||
|| (terms[term] || []).includes(file)
|
||||
|| (titleTerms[term] || []).includes(file),
|
||||
)
|
||||
)
|
||||
break;
|
||||
@@ -626,7 +683,8 @@ const Search = {
|
||||
|
||||
let summary = document.createElement("p");
|
||||
summary.classList.add("context");
|
||||
summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
|
||||
summary.textContent =
|
||||
top + text.substr(startWithContext, 240).trim() + tail;
|
||||
|
||||
return summary;
|
||||
},
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
/* Highlighting utilities for Sphinx HTML documentation. */
|
||||
"use strict";
|
||||
|
||||
const SPHINX_HIGHLIGHT_ENABLED = true
|
||||
const SPHINX_HIGHLIGHT_ENABLED = true;
|
||||
|
||||
/**
|
||||
* highlight a given string on a node by wrapping it in
|
||||
@@ -13,9 +13,9 @@ const _highlight = (node, addItems, text, className) => {
|
||||
const parent = node.parentNode;
|
||||
const pos = val.toLowerCase().indexOf(text);
|
||||
if (
|
||||
pos >= 0 &&
|
||||
!parent.classList.contains(className) &&
|
||||
!parent.classList.contains("nohighlight")
|
||||
pos >= 0
|
||||
&& !parent.classList.contains(className)
|
||||
&& !parent.classList.contains("nohighlight")
|
||||
) {
|
||||
let span;
|
||||
|
||||
@@ -30,13 +30,7 @@ const _highlight = (node, addItems, text, className) => {
|
||||
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
const rest = document.createTextNode(val.substr(pos + text.length));
|
||||
parent.insertBefore(
|
||||
span,
|
||||
parent.insertBefore(
|
||||
rest,
|
||||
node.nextSibling
|
||||
)
|
||||
);
|
||||
parent.insertBefore(span, parent.insertBefore(rest, node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
/* There may be more occurrences of search term in this node. So call this
|
||||
* function recursively on the remaining fragment.
|
||||
@@ -46,7 +40,7 @@ const _highlight = (node, addItems, text, className) => {
|
||||
if (isInSVG) {
|
||||
const rect = document.createElementNS(
|
||||
"http://www.w3.org/2000/svg",
|
||||
"rect"
|
||||
"rect",
|
||||
);
|
||||
const bbox = parent.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
@@ -65,7 +59,7 @@ const _highlightText = (thisNode, text, className) => {
|
||||
let addItems = [];
|
||||
_highlight(thisNode, addItems, text, className);
|
||||
addItems.forEach((obj) =>
|
||||
obj.parent.insertAdjacentElement("beforebegin", obj.target)
|
||||
obj.parent.insertAdjacentElement("beforebegin", obj.target),
|
||||
);
|
||||
};
|
||||
|
||||
@@ -73,25 +67,31 @@ const _highlightText = (thisNode, text, className) => {
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
const SphinxHighlight = {
|
||||
|
||||
/**
|
||||
* highlight the search words provided in localstorage in the text
|
||||
*/
|
||||
highlightSearchWords: () => {
|
||||
if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
|
||||
if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
|
||||
|
||||
// get and clear terms from localstorage
|
||||
const url = new URL(window.location);
|
||||
const highlight =
|
||||
localStorage.getItem("sphinx_highlight_terms")
|
||||
|| url.searchParams.get("highlight")
|
||||
|| "";
|
||||
localStorage.removeItem("sphinx_highlight_terms")
|
||||
url.searchParams.delete("highlight");
|
||||
window.history.replaceState({}, "", url);
|
||||
localStorage.getItem("sphinx_highlight_terms")
|
||||
|| url.searchParams.get("highlight")
|
||||
|| "";
|
||||
localStorage.removeItem("sphinx_highlight_terms");
|
||||
// Update history only if '?highlight' is present; otherwise it
|
||||
// clears text fragments (not set in window.location by the browser)
|
||||
if (url.searchParams.has("highlight")) {
|
||||
url.searchParams.delete("highlight");
|
||||
window.history.replaceState({}, "", url);
|
||||
}
|
||||
|
||||
// get individual terms from highlight string
|
||||
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
|
||||
const terms = highlight
|
||||
.toLowerCase()
|
||||
.split(/\s+/)
|
||||
.filter((x) => x);
|
||||
if (terms.length === 0) return; // nothing to do
|
||||
|
||||
// There should never be more than one element matching "div.body"
|
||||
@@ -107,11 +107,11 @@ const SphinxHighlight = {
|
||||
document
|
||||
.createRange()
|
||||
.createContextualFragment(
|
||||
'<p class="highlight-link">' +
|
||||
'<a href="javascript:SphinxHighlight.hideSearchWords()">' +
|
||||
_("Hide Search Matches") +
|
||||
"</a></p>"
|
||||
)
|
||||
'<p class="highlight-link">'
|
||||
+ '<a href="javascript:SphinxHighlight.hideSearchWords()">'
|
||||
+ _("Hide Search Matches")
|
||||
+ "</a></p>",
|
||||
),
|
||||
);
|
||||
},
|
||||
|
||||
@@ -125,7 +125,7 @@ const SphinxHighlight = {
|
||||
document
|
||||
.querySelectorAll("span.highlighted")
|
||||
.forEach((el) => el.classList.remove("highlighted"));
|
||||
localStorage.removeItem("sphinx_highlight_terms")
|
||||
localStorage.removeItem("sphinx_highlight_terms");
|
||||
},
|
||||
|
||||
initEscapeListener: () => {
|
||||
@@ -134,10 +134,15 @@ const SphinxHighlight = {
|
||||
|
||||
document.addEventListener("keydown", (event) => {
|
||||
// bail for input elements
|
||||
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
|
||||
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName))
|
||||
return;
|
||||
// bail with special keys
|
||||
if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
|
||||
if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
|
||||
if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey)
|
||||
return;
|
||||
if (
|
||||
DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
|
||||
&& event.key === "Escape"
|
||||
) {
|
||||
SphinxHighlight.hideSearchWords();
|
||||
event.preventDefault();
|
||||
}
|
||||
|
||||
+27
-10
@@ -7,17 +7,16 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Contributor’s Guidelines — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@@ -53,7 +52,10 @@
|
||||
<p class="caption" role="heading"><span class="caption-text">Developer documentation</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributor’s Guidelines</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributor’s Guidelines</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#before-pushing">Before pushing</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="#development-environment">Development environment</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#virtualenv-for-development">Virtualenv for development</a></li>
|
||||
</ul>
|
||||
@@ -104,12 +106,27 @@
|
||||
<li><p>All arguments have a specification in <code class="docutils literal notranslate"><span class="pre">meta/argument_specs.yml</span></code></p></li>
|
||||
<li><p>All playbooks/roles should be focused on compatibility with Ansible Automation Platform</p></li>
|
||||
</ul>
|
||||
<section id="before-pushing">
|
||||
<h2>Before pushing<a class="headerlink" href="#before-pushing" title="Link to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">format</span></code> before committing to auto-format the code. CI rejects unformatted PRs.</p></li>
|
||||
<li><p>CI runs <code class="docutils literal notranslate"><span class="pre">yamllint</span></code>, <code class="docutils literal notranslate"><span class="pre">ansible-lint</span></code> (production profile) and <code class="docutils literal notranslate"><span class="pre">shellcheck</span></code>. Fix any violations before pushing</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section id="development-environment">
|
||||
<h1>Development environment<a class="headerlink" href="#development-environment" title="Link to this heading"></a></h1>
|
||||
<p>To develop and to run tests you need to install <code class="docutils literal notranslate"><span class="pre">tox</span></code> and <code class="docutils literal notranslate"><span class="pre">tox-ansible</span></code> on
|
||||
your machine.</p>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">pip install --user tox tox-ansible</span>
|
||||
<p>Install <code class="docutils literal notranslate"><span class="pre">tox</span></code> (version 4 or newer) and <code class="docutils literal notranslate"><span class="pre">tox-ansible</span></code>:</p>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">pip install --user 'tox>=4' tox-ansible</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>With <code class="docutils literal notranslate"><span class="pre">--user</span></code>, <code class="docutils literal notranslate"><span class="pre">tox</span></code> is in <code class="docutils literal notranslate"><span class="pre">~/.local/bin</span></code>. Put it first on <code class="docutils literal notranslate"><span class="pre">PATH</span></code> before
|
||||
<code class="docutils literal notranslate"><span class="pre">make</span></code> targets that use <code class="docutils literal notranslate"><span class="pre">tox</span></code> (<code class="docutils literal notranslate"><span class="pre">build-venv</span></code>, <code class="docutils literal notranslate"><span class="pre">test-unit</span></code>, <code class="docutils literal notranslate"><span class="pre">test-sanity</span></code>):</p>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">export PATH="$HOME/.local/bin:$PATH"</span><span class="w"> </span><span class="c1"># whole shell session</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>or</p>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">PATH="$HOME/.local/bin:$PATH" make <target></span><span class="w"> </span><span class="c1"># command only</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<section id="virtualenv-for-development">
|
||||
@@ -135,7 +152,7 @@ be selected as virtualenv in VSCode (<code class="docutils literal notranslate">
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
+5
-6
@@ -6,17 +6,16 @@
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Index — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="#" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@@ -97,7 +96,7 @@
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
+12
-8
@@ -7,17 +7,16 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Welcome to kubevirt.core Collection documentation — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@@ -104,7 +103,7 @@
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="plugins/kubevirt.html">kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="plugins/kubevirt_vm.html">kubevirt_vm – Create or delete KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="plugins/kubevirt_vm.html">kubevirt_vm – Manage KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="plugins/kubevirt_vm_info.html">kubevirt_vm_info – Describe KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="plugins/kubevirt_vmi_info.html">kubevirt_vmi_info – Describe KubeVirt VirtualMachineInstances</a></li>
|
||||
</ul>
|
||||
@@ -123,7 +122,10 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="testing.html#example-config-and-playbooks">Example config and playbooks</a></li>
|
||||
</ul>
|
||||
</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="developing.html">Contributor’s Guidelines</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="developing.html#before-pushing">Before pushing</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="developing.html#development-environment">Development environment</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="developing.html#virtualenv-for-development">Virtualenv for development</a></li>
|
||||
</ul>
|
||||
@@ -145,6 +147,8 @@
|
||||
<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><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-3-0">v2.3.0</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-2-4">v2.2.4</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-2-3">v2.2.3</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-2-2">v2.2.2</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="CHANGELOG.html#v2-2-1">v2.2.1</a></li>
|
||||
@@ -178,7 +182,7 @@
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
Binary file not shown.
@@ -7,17 +7,16 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Plugin Index — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
@@ -49,7 +48,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../README.html">Lean Ansible bindings for KubeVirt</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Plugin Index</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt.html">kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html">kubevirt_vm – Create or delete KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html">kubevirt_vm – Manage KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm_info.html">kubevirt_vm_info – Describe KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vmi_info.html">kubevirt_vmi_info – Describe KubeVirt VirtualMachineInstances</a></li>
|
||||
</ul>
|
||||
@@ -113,7 +112,7 @@
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">modules plugins</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="kubevirt_vm.html">kubevirt_vm – Create or delete KubeVirt VirtualMachines</a><ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="kubevirt_vm.html">kubevirt_vm – Manage KubeVirt VirtualMachines</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html#synopsis">Synopsis</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html#requirements">Requirements</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html#parameters">Parameters</a></li>
|
||||
@@ -164,7 +163,7 @@
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
+70
-44
@@ -4,25 +4,24 @@
|
||||
<html class="writer-html5" lang="en" data-content_root="../">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<meta content="2.23.0" name="antsibull-docs" />
|
||||
<meta content="2.25.0" name="antsibull-docs" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></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="kubevirt_vm – Create or delete KubeVirt VirtualMachines" href="kubevirt_vm.html" />
|
||||
<link rel="next" title="kubevirt_vm – Manage KubeVirt VirtualMachines" href="kubevirt_vm.html" />
|
||||
<link rel="prev" title="Plugin Index" href="index.html" />
|
||||
</head>
|
||||
|
||||
@@ -60,7 +59,7 @@
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html">kubevirt_vm – Create or delete KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html">kubevirt_vm – Manage KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm_info.html">kubevirt_vm_info – Describe KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vmi_info.html">kubevirt_vmi_info – Describe KubeVirt VirtualMachineInstances</a></li>
|
||||
</ul>
|
||||
@@ -507,6 +506,33 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-default_win_ansible_connection"></div>
|
||||
<p class="ansible-option-title"><strong>default_win_ansible_connection</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-default_win_ansible_connection" title="Permalink to this option"></a>
|
||||
<p class="ansible-option-type-line">
|
||||
<span class="ansible-option-type">string</span>
|
||||
</p>
|
||||
<p><em class="ansible-option-versionadded">added in kubevirt.core 2.3.0</em></p>
|
||||
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell">
|
||||
<p>Set the default value of <code class='docutils literal notranslate'>ansible_connection</code> when a Windows virtual machines is detected.</p>
|
||||
<p>Common values include <code class="ansible-value literal notranslate">winrm</code>, <code class="ansible-value literal notranslate">ansible.builtin.winrm</code>, <code class="ansible-value literal notranslate">psrp</code>, <code class="ansible-value literal notranslate">ansible.builtin.psrp</code>, <code class="ansible-value literal notranslate">ssh</code>, and <code class="ansible-value literal notranslate">ansible.builtin.ssh</code>.</p>
|
||||
<p>When set to <code class="ansible-value literal notranslate">ssh</code> or <code class="ansible-value literal notranslate">ansible.builtin.ssh</code>, the service port lookup uses SSH port (22) instead of WinRM/PSRP ports (5986/5985).</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>"winrm"</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"ansible.builtin.winrm"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"psrp"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"ansible.builtin.psrp"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"ssh"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"ansible.builtin.ssh"</code></p></li>
|
||||
</ul>
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-groups"></div>
|
||||
<p class="ansible-option-title"><strong>groups</strong></p>
|
||||
@@ -521,7 +547,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">{}</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-host"></div>
|
||||
<p class="ansible-option-title"><strong>host</strong></p>
|
||||
@@ -536,7 +562,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_HOST</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-host_format"></div>
|
||||
<p class="ansible-option-title"><strong>host_format</strong></p>
|
||||
@@ -551,7 +577,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">"{namespace}-{name}"</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-impersonate_groups"></div>
|
||||
<p class="ansible-option-title"><strong>impersonate_groups</strong></p>
|
||||
@@ -567,7 +593,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_IMPERSONATE_GROUPS</code> environment variable, e.g. <code class='docutils literal notranslate'>Group1,Group2</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-impersonate_user"></div>
|
||||
<p class="ansible-option-title"><strong>impersonate_user</strong></p>
|
||||
@@ -582,7 +608,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_IMPERSONATE_USER</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups"></div>
|
||||
<p class="ansible-option-title"><strong>keyed_groups</strong></p>
|
||||
@@ -598,7 +624,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">[]</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/default_value"></div>
|
||||
<p class="ansible-option-title"><strong>default_value</strong></p>
|
||||
@@ -614,7 +640,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>This option is mutually exclusive with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-keyed_groups/trailing_separator"><span class="std std-ref"><span class="pre">keyed_groups[].trailing_separator</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/key"></div>
|
||||
<p class="ansible-option-title"><strong>key</strong></p>
|
||||
@@ -628,7 +654,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>The key from input dictionary used to generate groups.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/parent_group"></div>
|
||||
<p class="ansible-option-title"><strong>parent_group</strong></p>
|
||||
@@ -642,7 +668,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>parent group for keyed group.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/prefix"></div>
|
||||
<p class="ansible-option-title"><strong>prefix</strong></p>
|
||||
@@ -657,7 +683,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">""</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/separator"></div>
|
||||
<p class="ansible-option-title"><strong>separator</strong></p>
|
||||
@@ -672,7 +698,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">"_"</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyed_groups/trailing_separator"></div>
|
||||
<p class="ansible-option-title"><strong>trailing_separator</strong></p>
|
||||
@@ -695,7 +721,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-kube_secondary_dns"></div>
|
||||
<p class="ansible-option-title"><strong>kube_secondary_dns</strong></p>
|
||||
@@ -715,7 +741,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-kubeconfig"></div>
|
||||
<p class="ansible-option-title"><strong>kubeconfig</strong></p>
|
||||
@@ -732,7 +758,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-label_selector"></div>
|
||||
<p class="ansible-option-title"><strong>label_selector</strong></p>
|
||||
@@ -746,7 +772,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Define a label selector to select a subset of the fetched virtual machines.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-leading_separator"></div>
|
||||
<p class="ansible-option-title"><strong>leading_separator</strong></p>
|
||||
@@ -772,7 +798,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div>
|
||||
<p class="ansible-option-title"><strong>name</strong></p>
|
||||
@@ -786,7 +812,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Optional name to assign to the cluster. If not provided, a name is constructed from the server and port.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-namespaces"></div>
|
||||
<p class="ansible-option-title"><strong>namespaces</strong></p>
|
||||
@@ -800,7 +826,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>List of namespaces. If not specified, will fetch virtual machines from all namespaces the user is authorized to access.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-network_name"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-interface_name"></div>
|
||||
@@ -816,7 +842,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>In case multiple networks are attached to a virtual machine, define which interface should be returned as primary IP address.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-no_proxy"></div>
|
||||
<p class="ansible-option-title"><strong>no_proxy</strong></p>
|
||||
@@ -834,7 +860,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Example value is <code class='docutils literal notranslate'>localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-password"></div>
|
||||
<p class="ansible-option-title"><strong>password</strong></p>
|
||||
@@ -850,7 +876,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Please read the description of the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-username"><span class="std std-ref"><span class="pre">username</span></span></a></strong></code> option for a discussion of when this option is applicable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-persist_config"></div>
|
||||
<p class="ansible-option-title"><strong>persist_config</strong></p>
|
||||
@@ -873,7 +899,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-plugin"></div>
|
||||
<p class="ansible-option-title"><strong>plugin</strong></p>
|
||||
@@ -894,7 +920,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy"></div>
|
||||
<p class="ansible-option-title"><strong>proxy</strong></p>
|
||||
@@ -910,7 +936,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Please note that this module does not pick up typical proxy settings from the environment (e.g. <code class="xref std std-envvar literal notranslate">HTTP_PROXY</code>).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers"></div>
|
||||
<p class="ansible-option-title"><strong>proxy_headers</strong></p>
|
||||
@@ -925,7 +951,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Documentation can be found here <a href='https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers'>https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers</a>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/basic_auth"></div>
|
||||
<p class="ansible-option-title"><strong>basic_auth</strong></p>
|
||||
@@ -940,7 +966,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_PROXY_HEADERS_BASIC_AUTH</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/proxy_basic_auth"></div>
|
||||
<p class="ansible-option-title"><strong>proxy_basic_auth</strong></p>
|
||||
@@ -955,7 +981,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/user_agent"></div>
|
||||
<p class="ansible-option-title"><strong>user_agent</strong></p>
|
||||
@@ -971,7 +997,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-strict"></div>
|
||||
<p class="ansible-option-title"><strong>strict</strong></p>
|
||||
@@ -992,7 +1018,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-unset_ansible_port"></div>
|
||||
<p class="ansible-option-title"><strong>unset_ansible_port</strong></p>
|
||||
@@ -1013,7 +1039,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-use_extra_vars"></div>
|
||||
<p class="ansible-option-title"><strong>use_extra_vars</strong></p>
|
||||
@@ -1047,7 +1073,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-use_service"></div>
|
||||
<p class="ansible-option-title"><strong>use_service</strong></p>
|
||||
@@ -1068,7 +1094,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-username"></div>
|
||||
<p class="ansible-option-title"><strong>username</strong></p>
|
||||
@@ -1083,7 +1109,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_USERNAME</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-verify_ssl"></div>
|
||||
@@ -1120,7 +1146,7 @@ For example, an ansible.cfg entry (further up in the list) is overwritten by an
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>To avoid SSL certificate validation errors when <code class="ansible-option-value docutils literal notranslate"><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_inventory.html#ansible-collections-kubevirt-core-kubevirt-inventory-parameter-validate-certs" title="(in Ansible v13)"><span><span class="pre">validate_certs=yes</span></span></a></code>, the full certificate chain for the API server must be provided via <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_inventory.html#ansible-collections-kubevirt-core-kubevirt-inventory-parameter-ca-cert" title="(in Ansible v13)"><span><span class="pre">ca_cert</span></span></a></strong></code> or in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_inventory.html#ansible-collections-kubevirt-core-kubevirt-inventory-parameter-kubeconfig" title="(in Ansible v13)"><span><span class="pre">kubeconfig</span></span></a></strong></code> file.</p></li>
|
||||
<li><p>To avoid SSL certificate validation errors when <code class="ansible-option-value docutils literal notranslate"><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_inventory.html#ansible-collections-kubevirt-core-kubevirt-inventory-parameter-validate-certs" title="(in Ansible v14)"><span><span class="pre">validate_certs=yes</span></span></a></code>, the full certificate chain for the API server must be provided via <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_inventory.html#ansible-collections-kubevirt-core-kubevirt-inventory-parameter-ca-cert" title="(in Ansible v14)"><span><span class="pre">ca_cert</span></span></a></strong></code> or in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_inventory.html#ansible-collections-kubevirt-core-kubevirt-inventory-parameter-kubeconfig" title="(in Ansible v14)"><span><span class="pre">kubeconfig</span></span></a></strong></code> file.</p></li>
|
||||
<li><p>Inventories are not finalized at this stage, so the auto populated <code class="docutils literal notranslate"><span class="pre">all</span></code> and <code class="docutils literal notranslate"><span class="pre">ungrouped</span></code> groups will only reflect what previous inventory sources explicitly added to them.</p></li>
|
||||
<li><p>Runtime ‘magic variables’ are not available during inventory construction. For example, <code class="docutils literal notranslate"><span class="pre">groups</span></code> and <code class="docutils literal notranslate"><span class="pre">hostvars</span></code> do not exist yet.</p></li>
|
||||
</ul>
|
||||
@@ -1168,13 +1194,13 @@ For example, an ansible.cfg entry (further up in the list) is overwritten by an
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="index.html" class="btn btn-neutral float-left" title="Plugin Index" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="kubevirt_vm.html" class="btn btn-neutral float-right" title="kubevirt_vm – Create or delete KubeVirt VirtualMachines" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="kubevirt_vm.html" class="btn btn-neutral float-right" title="kubevirt_vm – Manage KubeVirt VirtualMachines" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
@@ -4,21 +4,20 @@
|
||||
<html class="writer-html5" lang="en" data-content_root="../">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<meta content="2.23.0" name="antsibull-docs" />
|
||||
<meta content="2.25.0" name="antsibull-docs" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kubevirt_vm – Create or delete KubeVirt VirtualMachines — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
||||
<title>kubevirt_vm – Manage KubeVirt VirtualMachines — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
@@ -50,7 +49,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../README.html">Lean Ansible bindings for KubeVirt</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Plugin Index</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt.html">kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">kubevirt_vm – Create or delete KubeVirt VirtualMachines</a><ul>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">kubevirt_vm – Manage KubeVirt VirtualMachines</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#requirements">Requirements</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
|
||||
@@ -95,7 +94,7 @@
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item"><a href="index.html">Plugin Index</a></li>
|
||||
<li class="breadcrumb-item active">kubevirt_vm – Create or delete KubeVirt VirtualMachines</li>
|
||||
<li class="breadcrumb-item active">kubevirt_vm – Manage KubeVirt VirtualMachines</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="../_sources/plugins/kubevirt_vm.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@@ -105,8 +104,8 @@
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<span class="target" id="ansible-collections-kubevirt-core-kubevirt-vm-module"></span><section id="kubevirt-vm-create-or-delete-kubevirt-virtualmachines">
|
||||
<h1>kubevirt_vm – Create or delete KubeVirt VirtualMachines<a class="headerlink" href="#kubevirt-vm-create-or-delete-kubevirt-virtualmachines" title="Link to this heading"></a></h1>
|
||||
<span class="target" id="ansible-collections-kubevirt-core-kubevirt-vm-module"></span><section id="kubevirt-vm-manage-kubevirt-virtualmachines">
|
||||
<h1>kubevirt_vm – Manage KubeVirt VirtualMachines<a class="headerlink" href="#kubevirt-vm-manage-kubevirt-virtualmachines" title="Link to this heading"></a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/kubevirt/core/">kubevirt.core collection</a>.</p>
|
||||
@@ -130,7 +129,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Use the Kubernetes Python client to perform create or delete operations on KubeVirt VirtualMachines.</p></li>
|
||||
<li><p>Use the Kubernetes Python client to perform create, delete, start, stop, or restart operations on KubeVirt VirtualMachines.</p></li>
|
||||
<li><p>Pass options to create the VirtualMachine as module arguments.</p></li>
|
||||
<li><p>Authenticate using either a config file, certificates, password or token.</p></li>
|
||||
<li><p>Supports check mode.</p></li>
|
||||
@@ -386,6 +385,22 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-grace_period_seconds"></div>
|
||||
<p class="ansible-option-title"><strong>grace_period_seconds</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-grace_period_seconds" title="Permalink to this option"></a>
|
||||
<p class="ansible-option-type-line">
|
||||
<span class="ansible-option-type">integer</span>
|
||||
</p>
|
||||
<p><em class="ansible-option-versionadded">added in kubevirt.core 2.3.0</em></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell">
|
||||
<p>Specify the grace period in seconds for stopping or restarting the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
|
||||
<p>Only used when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=stopped</span></span></a></code> or <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=restarted</span></span></a></code>.</p>
|
||||
<p>When used with <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=restarted</span></span></a></code>, the only supported values are <code class="ansible-value literal notranslate">null</code> (use the default grace period) and <code class="ansible-value literal notranslate">0</code> (force restart immediately).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-hidden_fields"></div>
|
||||
<p class="ansible-option-title"><strong>hidden_fields</strong></p>
|
||||
@@ -402,7 +417,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">["metadata.annotations[kubemacpool.io/transaction-timestamp]", "metadata.managedFields"]</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-host"></div>
|
||||
<p class="ansible-option-title"><strong>host</strong></p>
|
||||
@@ -416,7 +431,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_HOST</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-impersonate_groups"></div>
|
||||
<p class="ansible-option-title"><strong>impersonate_groups</strong></p>
|
||||
@@ -431,7 +446,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_IMPERSONATE_GROUPS</code> environment variable, e.g. <code class='docutils literal notranslate'>Group1,Group2</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-impersonate_user"></div>
|
||||
<p class="ansible-option-title"><strong>impersonate_user</strong></p>
|
||||
@@ -445,7 +460,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_IMPERSONATE_USER</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-instancetype"></div>
|
||||
<p class="ansible-option-title"><strong>instancetype</strong></p>
|
||||
@@ -459,7 +474,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Only used when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-kubeconfig"></div>
|
||||
<p class="ansible-option-title"><strong>kubeconfig</strong></p>
|
||||
@@ -475,7 +490,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-labels"></div>
|
||||
<p class="ansible-option-title"><strong>labels</strong></p>
|
||||
@@ -488,7 +503,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Specify labels to set on the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div>
|
||||
<p class="ansible-option-title"><strong>name</strong></p>
|
||||
@@ -503,7 +518,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Mutually exclusive with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-generate_name"><span class="std std-ref"><span class="pre">generate_name</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-namespace"></div>
|
||||
<p class="ansible-option-title"><strong>namespace</strong></p>
|
||||
@@ -517,7 +532,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Specify the namespace of the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-no_proxy"></div>
|
||||
<p class="ansible-option-title"><strong>no_proxy</strong></p>
|
||||
@@ -534,7 +549,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Example value is <code class='docutils literal notranslate'>localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16</code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-password"></div>
|
||||
<p class="ansible-option-title"><strong>password</strong></p>
|
||||
@@ -549,7 +564,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Please read the description of the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-username"><span class="std std-ref"><span class="pre">username</span></span></a></strong></code> option for a discussion of when this option is applicable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-persist_config"></div>
|
||||
<p class="ansible-option-title"><strong>persist_config</strong></p>
|
||||
@@ -571,7 +586,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-preference"></div>
|
||||
<p class="ansible-option-title"><strong>preference</strong></p>
|
||||
@@ -585,7 +600,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Only used when <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy"></div>
|
||||
<p class="ansible-option-title"><strong>proxy</strong></p>
|
||||
@@ -600,7 +615,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Please note that this module does not pick up typical proxy settings from the environment (e.g. <code class="xref std std-envvar literal notranslate">HTTP_PROXY</code>).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers"></div>
|
||||
<p class="ansible-option-title"><strong>proxy_headers</strong></p>
|
||||
@@ -614,7 +629,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Documentation can be found here <a href='https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers'>https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers</a>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/basic_auth"></div>
|
||||
<p class="ansible-option-title"><strong>basic_auth</strong></p>
|
||||
@@ -628,7 +643,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_PROXY_HEADERS_BASIC_AUTH</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/proxy_basic_auth"></div>
|
||||
<p class="ansible-option-title"><strong>proxy_basic_auth</strong></p>
|
||||
@@ -642,7 +657,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-proxy_headers/user_agent"></div>
|
||||
<p class="ansible-option-title"><strong>user_agent</strong></p>
|
||||
@@ -657,7 +672,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-run_strategy"></div>
|
||||
<p class="ansible-option-title"><strong>run_strategy</strong></p>
|
||||
@@ -681,7 +696,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-running"></div>
|
||||
<p class="ansible-option-title"><strong>running</strong></p>
|
||||
@@ -702,7 +717,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-spec"></div>
|
||||
<p class="ansible-option-title"><strong>spec</strong></p>
|
||||
@@ -716,7 +731,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>See <a href='https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec'>https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec</a></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-state"></div>
|
||||
<p class="ansible-option-title"><strong>state</strong></p>
|
||||
@@ -726,19 +741,25 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
</p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell">
|
||||
<p>Determines if an object should be created, patched, or deleted.</p>
|
||||
<p>Determines if an object should be created, patched, deleted, started, stopped, or restarted.</p>
|
||||
<p>When set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>, an object will be created, if it does not already exist.</p>
|
||||
<p>If set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=absent</span></span></a></code>, an existing object will be deleted.</p>
|
||||
<p>If set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=present</span></span></a></code>, an existing object will be patched, if its attributes differ from those specified.</p>
|
||||
<p>If set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=started</span></span></a></code>, it will be ensured that the <code class='docutils literal notranslate'>VirtualMachine</code> is running. Added in version 2.3.0.</p>
|
||||
<p>If set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=stopped</span></span></a></code>, it will be ensured that the <code class='docutils literal notranslate'>VirtualMachine</code> is stopped. Added in version 2.3.0.</p>
|
||||
<p>If set to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-state"><span class="std std-ref"><span class="pre">state=restarted</span></span></a></code>, it will be ensured that the <code class='docutils literal notranslate'>VirtualMachine</code> is restarted. Added in version 2.3.0.</p>
|
||||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"absent"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-default-bold"><strong>"present"</strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"restarted"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"started"</code></p></li>
|
||||
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">"stopped"</code></p></li>
|
||||
</ul>
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-username"></div>
|
||||
<p class="ansible-option-title"><strong>username</strong></p>
|
||||
@@ -752,7 +773,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_USERNAME</code> environment variable.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
|
||||
<div class="ansibleOptionAnchor" id="parameter-verify_ssl"></div>
|
||||
@@ -774,7 +795,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-wait"></div>
|
||||
<p class="ansible-option-title"><strong>wait</strong></p>
|
||||
@@ -793,7 +814,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even">
|
||||
<tr class="row-odd">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-wait_sleep"></div>
|
||||
<p class="ansible-option-title"><strong>wait_sleep</strong></p>
|
||||
@@ -808,7 +829,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">5</code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd">
|
||||
<tr class="row-even">
|
||||
<td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-wait_timeout"></div>
|
||||
<p class="ansible-option-title"><strong>wait_timeout</strong></p>
|
||||
@@ -830,7 +851,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>To avoid SSL certificate validation errors when <code class="ansible-option-value docutils literal notranslate"><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_module.html#ansible-collections-kubevirt-core-kubevirt-vm-module-parameter-validate-certs" title="(in Ansible v13)"><span><span class="pre">validate_certs=yes</span></span></a></code>, the full certificate chain for the API server must be provided via <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_module.html#ansible-collections-kubevirt-core-kubevirt-vm-module-parameter-ca-cert" title="(in Ansible v13)"><span><span class="pre">ca_cert</span></span></a></strong></code> or in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_module.html#ansible-collections-kubevirt-core-kubevirt-vm-module-parameter-kubeconfig" title="(in Ansible v13)"><span><span class="pre">kubeconfig</span></span></a></strong></code> file.</p></li>
|
||||
<li><p>To avoid SSL certificate validation errors when <code class="ansible-option-value docutils literal notranslate"><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_module.html#ansible-collections-kubevirt-core-kubevirt-vm-module-parameter-validate-certs" title="(in Ansible v14)"><span><span class="pre">validate_certs=yes</span></span></a></code>, the full certificate chain for the API server must be provided via <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_module.html#ansible-collections-kubevirt-core-kubevirt-vm-module-parameter-ca-cert" title="(in Ansible v14)"><span><span class="pre">ca_cert</span></span></a></strong></code> or in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_module.html#ansible-collections-kubevirt-core-kubevirt-vm-module-parameter-kubeconfig" title="(in Ansible v14)"><span><span class="pre">kubeconfig</span></span></a></strong></code> file.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
@@ -918,12 +939,41 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<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">testvm</span>
|
||||
<span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">absent</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">Start a VirtualMachine</span>
|
||||
<span class="w"> </span><span class="nt">kubevirt.core.kubevirt_vm</span><span class="p">:</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">testvm</span>
|
||||
<span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">started</span>
|
||||
<span class="w"> </span><span class="nt">wait</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</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">Stop a VirtualMachine</span>
|
||||
<span class="w"> </span><span class="nt">kubevirt.core.kubevirt_vm</span><span class="p">:</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">testvm</span>
|
||||
<span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">stopped</span>
|
||||
<span class="w"> </span><span class="nt">wait</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</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">Restart a VirtualMachine</span>
|
||||
<span class="w"> </span><span class="nt">kubevirt.core.kubevirt_vm</span><span class="p">:</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">testvm</span>
|
||||
<span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">restarted</span>
|
||||
<span class="w"> </span><span class="nt">wait</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</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">Force restart a VirtualMachine</span>
|
||||
<span class="w"> </span><span class="nt">kubevirt.core.kubevirt_vm</span><span class="p">:</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">testvm</span>
|
||||
<span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
|
||||
<span class="w"> </span><span class="nt">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">restarted</span>
|
||||
<span class="w"> </span><span class="nt">grace_period_seconds</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">0</span>
|
||||
<span class="w"> </span><span class="nt">wait</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
|
||||
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v13)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v14)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd">
|
||||
@@ -1012,7 +1062,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
@@ -4,26 +4,25 @@
|
||||
<html class="writer-html5" lang="en" data-content_root="../">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<meta content="2.23.0" name="antsibull-docs" />
|
||||
<meta content="2.25.0" name="antsibull-docs" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kubevirt_vm_info – Describe KubeVirt VirtualMachines — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></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="kubevirt_vmi_info – Describe KubeVirt VirtualMachineInstances" href="kubevirt_vmi_info.html" />
|
||||
<link rel="prev" title="kubevirt_vm – Create or delete KubeVirt VirtualMachines" href="kubevirt_vm.html" />
|
||||
<link rel="prev" title="kubevirt_vm – Manage KubeVirt VirtualMachines" href="kubevirt_vm.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -50,7 +49,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../README.html">Lean Ansible bindings for KubeVirt</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Plugin Index</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt.html">kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html">kubevirt_vm – Create or delete KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html">kubevirt_vm – Manage KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">kubevirt_vm_info – Describe KubeVirt VirtualMachines</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#requirements">Requirements</a></li>
|
||||
@@ -619,7 +618,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>To avoid SSL certificate validation errors when <code class="ansible-option-value docutils literal notranslate"><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_info_module.html#ansible-collections-kubevirt-core-kubevirt-vm-info-module-parameter-validate-certs" title="(in Ansible v13)"><span><span class="pre">validate_certs=yes</span></span></a></code>, the full certificate chain for the API server must be provided via <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_info_module.html#ansible-collections-kubevirt-core-kubevirt-vm-info-module-parameter-ca-cert" title="(in Ansible v13)"><span><span class="pre">ca_cert</span></span></a></strong></code> or in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_info_module.html#ansible-collections-kubevirt-core-kubevirt-vm-info-module-parameter-kubeconfig" title="(in Ansible v13)"><span><span class="pre">kubeconfig</span></span></a></strong></code> file.</p></li>
|
||||
<li><p>To avoid SSL certificate validation errors when <code class="ansible-option-value docutils literal notranslate"><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_info_module.html#ansible-collections-kubevirt-core-kubevirt-vm-info-module-parameter-validate-certs" title="(in Ansible v14)"><span><span class="pre">validate_certs=yes</span></span></a></code>, the full certificate chain for the API server must be provided via <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_info_module.html#ansible-collections-kubevirt-core-kubevirt-vm-info-module-parameter-ca-cert" title="(in Ansible v14)"><span><span class="pre">ca_cert</span></span></a></strong></code> or in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vm_info_module.html#ansible-collections-kubevirt-core-kubevirt-vm-info-module-parameter-kubeconfig" title="(in Ansible v14)"><span><span class="pre">kubeconfig</span></span></a></strong></code> file.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
@@ -662,7 +661,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
|
||||
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v13)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v14)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd">
|
||||
@@ -784,14 +783,14 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="kubevirt_vm.html" class="btn btn-neutral float-left" title="kubevirt_vm – Create or delete KubeVirt VirtualMachines" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="kubevirt_vm.html" class="btn btn-neutral float-left" title="kubevirt_vm – Manage KubeVirt VirtualMachines" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="kubevirt_vmi_info.html" class="btn btn-neutral float-right" title="kubevirt_vmi_info – Describe KubeVirt VirtualMachineInstances" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
@@ -4,21 +4,20 @@
|
||||
<html class="writer-html5" lang="en" data-content_root="../">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<meta content="2.23.0" name="antsibull-docs" />
|
||||
<meta content="2.25.0" name="antsibull-docs" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>kubevirt_vmi_info – Describe KubeVirt VirtualMachineInstances — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
@@ -50,7 +49,7 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="../README.html">Lean Ansible bindings for KubeVirt</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Plugin Index</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt.html">kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html">kubevirt_vm – Create or delete KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html">kubevirt_vm – Manage KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm_info.html">kubevirt_vm_info – Describe KubeVirt VirtualMachines</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">kubevirt_vmi_info – Describe KubeVirt VirtualMachineInstances</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
||||
@@ -596,7 +595,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>To avoid SSL certificate validation errors when <code class="ansible-option-value docutils literal notranslate"><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vmi_info_module.html#ansible-collections-kubevirt-core-kubevirt-vmi-info-module-parameter-validate-certs" title="(in Ansible v13)"><span><span class="pre">validate_certs=yes</span></span></a></code>, the full certificate chain for the API server must be provided via <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vmi_info_module.html#ansible-collections-kubevirt-core-kubevirt-vmi-info-module-parameter-ca-cert" title="(in Ansible v13)"><span><span class="pre">ca_cert</span></span></a></strong></code> or in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vmi_info_module.html#ansible-collections-kubevirt-core-kubevirt-vmi-info-module-parameter-kubeconfig" title="(in Ansible v13)"><span><span class="pre">kubeconfig</span></span></a></strong></code> file.</p></li>
|
||||
<li><p>To avoid SSL certificate validation errors when <code class="ansible-option-value docutils literal notranslate"><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vmi_info_module.html#ansible-collections-kubevirt-core-kubevirt-vmi-info-module-parameter-validate-certs" title="(in Ansible v14)"><span><span class="pre">validate_certs=yes</span></span></a></code>, the full certificate chain for the API server must be provided via <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vmi_info_module.html#ansible-collections-kubevirt-core-kubevirt-vmi-info-module-parameter-ca-cert" title="(in Ansible v14)"><span><span class="pre">ca_cert</span></span></a></strong></code> or in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/collections/kubevirt/core/kubevirt_vmi_info_module.html#ansible-collections-kubevirt-core-kubevirt-vmi-info-module-parameter-kubeconfig" title="(in Ansible v14)"><span><span class="pre">kubeconfig</span></span></a></strong></code> file.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
@@ -632,7 +631,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
</section>
|
||||
<section id="return-values">
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
|
||||
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v13)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v14)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
||||
<table class="colwidths-auto ansible-option-table docutils align-default" style="width: 100%">
|
||||
<thead>
|
||||
<tr class="row-odd">
|
||||
@@ -761,7 +760,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
+5
-6
@@ -7,17 +7,16 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Collection Versioning Strategy — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@@ -158,7 +157,7 @@ Given a version number MAJOR.MINOR.PATCH, the following is incremented:</p>
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
@@ -7,17 +7,16 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Role Index — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="../_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
@@ -105,7 +104,7 @@
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
+5
-6
@@ -6,18 +6,17 @@
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Search — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<script src="_static/searchtools.js"></script>
|
||||
<script src="_static/language_data.js"></script>
|
||||
@@ -105,7 +104,7 @@
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
+1
-1
File diff suppressed because one or more lines are too long
+12
-6
@@ -7,17 +7,16 @@
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Testing — KubeVirt Ansible Collection documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=41de9001" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/ansible-basic-sphinx-ext.css" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
@@ -123,6 +122,13 @@ is ensured.</p>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">make test-unit</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">test-unit</span></code> runs the full matrix in parallel. For local development, run
|
||||
one environment instead. If you installed tox with <code class="docutils literal notranslate"><span class="pre">--user</span></code>, put <code class="docutils literal notranslate"><span class="pre">~/.local/bin</span></code>
|
||||
first on <code class="docutils literal notranslate"><span class="pre">PATH</span></code> before running <code class="docutils literal notranslate"><span class="pre">tox</span></code>. See <a class="reference internal" href="developing.html"><span class="std std-doc">developing.md</span></a>.</p>
|
||||
<div class="highlight-YAML+Jinja notranslate"><div class="highlight"><pre><span></span><span class="l l-Scalar l-Scalar-Plain">tox -e unit-py3.11-2.16 --ansible --conf tox-ansible.ini</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>List available unit envs with <code class="docutils literal notranslate"><span class="pre">tox</span> <span class="pre">-f</span> <span class="pre">unit</span> <span class="pre">--ansible</span> <span class="pre">--conf</span> <span class="pre">tox-ansible.ini</span> <span class="pre">-l</span></code>.</p>
|
||||
</section>
|
||||
<section id="running-tests-with-ansible-test">
|
||||
<h3>Running tests with ansible-test<a class="headerlink" href="#running-tests-with-ansible-test" title="Link to this heading"></a></h3>
|
||||
@@ -227,7 +233,7 @@ hack/e2e-setup.sh<span class="w"> </span>--cleanup
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2025 Red Hat, Inc..</p>
|
||||
<p>© Copyright 2026 Red Hat, Inc..</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
Reference in New Issue
Block a user