internet/kubevirt.core
3
0
Fork 0
mirror of https://github.com/kubevirt/kubevirt.core.git synced 2026-05-08 22:32:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for main

Browse Source 
Signed-off-by: kubevirt-bot <kubevirtbot@redhat.com>
This commit is contained in:
kubevirt-bot
2023-08-10 14:54:30 +00:00
parent 5db07ef9fb
commit 9d7460b24e
17 changed files with 144 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
main/plugins/kubevirt_vm.html
View File

@@ -7,6 +7,7 @@
<title>kubevirt_vm – Create or delete KubeVirt VirtualMachines on Kubernetes &mdash; Kubevirt Ansible Collection documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/antsibull-minimal.css" type="text/css" />
<link rel="stylesheet" href="../_static/ansible-basic-sphinx-ext.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
@@ -112,16 +113,16 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#synopsis" id="id41">Synopsis</a></p></li>
<li><p><a class="reference internal" href="#requirements" id="id42">Requirements</a></p></li>
<li><p><a class="reference internal" href="#parameters" id="id43">Parameters</a></p></li>
<li><p><a class="reference internal" href="#notes" id="id44">Notes</a></p></li>
<li><p><a class="reference internal" href="#examples" id="id45">Examples</a></p></li>
<li><p><a class="reference internal" href="#return-values" id="id46">Return Values</a></p></li>
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
<li><p><a class="reference internal" href="#notes" id="id4">Notes</a></p></li>
<li><p><a class="reference internal" href="#examples" id="id5">Examples</a></p></li>
<li><p><a class="reference internal" href="#return-values" id="id6">Return Values</a></p></li>
</ul>
</nav>
<section id="synopsis">
<h2><a class="toc-backref" href="#id41" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink 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>Pass options to create the VirtualMachine as module arguments.</p></li>
@@ -130,7 +131,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</ul>
</section>
<section id="requirements">
<span id="ansible-collections-kubevirt-core-kubevirt-vm-module-requirements"></span><h2><a class="toc-backref" href="#id42" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
<span id="ansible-collections-kubevirt-core-kubevirt-vm-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
<p>The below requirements are needed on the host that executes this module.</p>
<ul class="simple">
<li><p>python &gt;= 3.6</p></li>
@@ -141,7 +142,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</ul>
</section>
<section id="parameters">
<h2><a class="toc-backref" href="#id43" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h2>
<table class="ansible-option-table docutils align-default" style="width: 100%">
<thead>
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
@@ -169,7 +170,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<a class="ansibleOptionLink" href="#parameter-api_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
<td><div class="ansible-option-cell"><p>Use this to set the API version of KubeVirt.</p>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <a href="#id1"><span class="problematic" id="id2">:ansible-option-default:`&quot;kubevirt.io/v1&quot;`</span></a></p>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">&quot;kubevirt.io/v1&quot;</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
@@ -261,9 +262,9 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<p>If not specified, the default policy for the object type will be used. This may vary across object types.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
<ul class="simple">
<li><p><a href="#id3"><span class="problematic" id="id4">:ansible-option-choices-entry:`&quot;Foreground&quot;`</span></a></p></li>
<li><p><a href="#id5"><span class="problematic" id="id6">:ansible-option-choices-entry:`&quot;Background&quot;`</span></a></p></li>
<li><p><a href="#id7"><span class="problematic" id="id8">:ansible-option-choices-entry:`&quot;Orphan&quot;`</span></a></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;Foreground&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;Background&quot;</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;Orphan&quot;</span></code></p></li>
</ul>
</div></td>
</tr>
@@ -274,8 +275,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">yes</span></code>, and <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>, an existing object will be replaced.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
<ul class="simple">
<li><p><a href="#id9"><span class="problematic" id="id10">:ansible-option-choices-entry-default:`false`</span></a> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><a href="#id11"><span class="problematic" id="id12">:ansible-option-choices-entry:`true`</span></a></p></li>
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul>
</div></td>
</tr>
@@ -383,8 +384,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<p>The fix for this k8s python library is here: <a class="reference external" href="https://github.com/kubernetes-client/python-base/pull/169">https://github.com/kubernetes-client/python-base/pull/169</a></p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
<ul class="simple">
<li><p><a href="#id13"><span class="problematic" id="id14">:ansible-option-choices-entry:`false`</span></a></p></li>
<li><p><a href="#id15"><span class="problematic" id="id16">:ansible-option-choices-entry:`true`</span></a></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul>
</div></td>
</tr>
@@ -444,8 +445,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<td><div class="ansible-option-cell"><p>Specify whether the VirtualMachine should be running.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
<ul class="simple">
<li><p><a href="#id17"><span class="problematic" id="id18">:ansible-option-choices-entry:`false`</span></a></p></li>
<li><p><a href="#id19"><span class="problematic" id="id20">:ansible-option-choices-entry-default:`true`</span></a> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">true</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul>
</div></td>
</tr>
@@ -464,8 +465,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<td><div class="ansible-option-cell"><p>Determines if an object should be created, patched, or deleted. When set to <code class="docutils literal notranslate"><span class="pre">present</span></code>, an object will be created, if it does not already exist. If set to <code class="docutils literal notranslate"><span class="pre">absent</span></code>, an existing object will be deleted. If set to <code class="docutils literal notranslate"><span class="pre">present</span></code>, an existing object will be patched, if its attributes differ from those specified using <em>resource_definition</em> or <em>src</em>.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
<ul class="simple">
<li><p><a href="#id21"><span class="problematic" id="id22">:ansible-option-choices-entry:`&quot;absent&quot;`</span></a></p></li>
<li><p><a href="#id23"><span class="problematic" id="id24">:ansible-option-choices-entry-default:`&quot;present&quot;`</span></a> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">&quot;absent&quot;</span></code></p></li>
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">&quot;present&quot;</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
</ul>
</div></td>
</tr>
@@ -486,8 +487,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<td><div class="ansible-option-cell"><p>Whether or not to verify the API server’s SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
<ul class="simple">
<li><p><a href="#id25"><span class="problematic" id="id26">:ansible-option-choices-entry:`false`</span></a></p></li>
<li><p><a href="#id27"><span class="problematic" id="id28">:ansible-option-choices-entry:`true`</span></a></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul>
</div></td>
</tr>
@@ -498,8 +499,8 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<td><div class="ansible-option-cell"><p>Whether to wait for the VirtualMachine to end up in the ready state.</p>
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
<ul class="simple">
<li><p><a href="#id29"><span class="problematic" id="id30">:ansible-option-choices-entry-default:`false`</span></a> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><a href="#id31"><span class="problematic" id="id32">:ansible-option-choices-entry:`true`</span></a></p></li>
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
</ul>
</div></td>
</tr>
@@ -509,7 +510,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-cell"><p>Number of seconds to sleep between checks.</p>
<p>Ignored if <code class="docutils literal notranslate"><span class="pre">wait</span></code> is not set.</p>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <a href="#id33"><span class="problematic" id="id34">:ansible-option-default:`5`</span></a></p>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">5</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
@@ -518,14 +519,14 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-cell"><p>How long in seconds to wait for the resource to end up in the desired state.</p>
<p>Ignored if <code class="docutils literal notranslate"><span class="pre">wait</span></code> is not set.</p>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <a href="#id35"><span class="problematic" id="id36">:ansible-option-default:`120`</span></a></p>
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">120</span></code></p>
</div></td>
</tr>
</tbody>
</table>
</section>
<section id="notes">
<h2><a class="toc-backref" href="#id44" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Notes</a><a class="headerlink" href="#notes" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul class="simple">
@@ -534,7 +535,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div>
</section>
<section id="examples">
<h2><a class="toc-backref" href="#id45" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></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">Create 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">state</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">present</span>
@@ -621,7 +622,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div>
</section>
<section id="return-values">
<h2><a class="toc-backref" href="#id46" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this heading"></a></h2>
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible v8)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<table class="ansible-option-table docutils align-default" style="width: 100%">
<thead>
@@ -644,7 +645,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Whether the VirtualMachine was changed</p>
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <a href="#id37"><span class="problematic" id="id38">:ansible-rv-sample-value:`true`</span></a></p>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">true</span></code></p>
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
@@ -653,7 +654,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>elapsed time of task in seconds</p>
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> when <code class="docutils literal notranslate"><span class="pre">wait</span></code> is true</p>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <a href="#id39"><span class="problematic" id="id40">:ansible-rv-sample-value:`48`</span></a></p>
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">48</span></code></p>
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">