internet/kubevirt.core
3
0
Fork 0
mirror of https://github.com/kubevirt/kubevirt.core.git synced 2026-05-06 13:22:38 +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
2024-04-25 12:07:33 +00:00
parent 8241b38925
commit f512550b49
5 changed files with 143 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

129
main/CHANGELOG.html
View File

@@ -68,36 +68,36 @@
</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="#id4">Release Summary</a></li>
<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-3-0">v1.3.0</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id5">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id8">Bugfixes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id6">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id9">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="#id12">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="#id13">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-l2"><a class="reference internal" href="#v1-2-2">v1.2.2</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id14">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-l2"><a class="reference internal" href="#v1-2-1">v1.2.1</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id15">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="#id16">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="#id16">Minor Changes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id17">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="#id17">Release Summary</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id18">Release Summary</a></li>
</ul>
</li>
</ul>
@@ -129,58 +129,58 @@
<div itemprop="articleBody">
<section id="kubevirt-collection-for-ansible-release-notes">
<h1><a class="toc-backref" href="#id18" 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="#id19" 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="id18">KubeVirt Collection for Ansible Release Notes</a></p>
<li><p><a class="reference internal" href="#kubevirt-collection-for-ansible-release-notes" id="id19">KubeVirt Collection for Ansible Release Notes</a></p>
<ul>
<li><p><a class="reference internal" href="#v1-3-2" id="id19">v1.3.2</a></p>
<li><p><a class="reference internal" href="#v1-3-2" id="id20">v1.3.2</a></p>
<ul>
<li><p><a class="reference internal" href="#release-summary" id="id20">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id21">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id22">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#release-summary" id="id21">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#minor-changes" id="id22">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#bugfixes" id="id23">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-3-1" id="id23">v1.3.1</a></p>
<li><p><a class="reference internal" href="#v1-3-1" id="id24">v1.3.1</a></p>
<ul>
<li><p><a class="reference internal" href="#id4" id="id24">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id5" id="id25">Release Summary</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-3-0" id="id25">v1.3.0</a></p>
<li><p><a class="reference internal" href="#v1-3-0" id="id26">v1.3.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id5" id="id26">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id8" id="id27">Bugfixes</a></p></li>
<li><p><a class="reference internal" href="#id6" id="id27">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id9" id="id28">Bugfixes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-3" id="id28">v1.2.3</a></p>
<li><p><a class="reference internal" href="#v1-2-3" id="id29">v1.2.3</a></p>
<ul>
<li><p><a class="reference internal" href="#id12" id="id29">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id13" id="id30">Release Summary</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-2" id="id30">v1.2.2</a></p>
<li><p><a class="reference internal" href="#v1-2-2" id="id31">v1.2.2</a></p>
<ul>
<li><p><a class="reference internal" href="#id13" id="id31">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id14" id="id32">Release Summary</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-1" id="id32">v1.2.1</a></p>
<li><p><a class="reference internal" href="#v1-2-1" id="id33">v1.2.1</a></p>
<ul>
<li><p><a class="reference internal" href="#id14" id="id33">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id15" id="id34">Release Summary</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-2-0" id="id34">v1.2.0</a></p>
<li><p><a class="reference internal" href="#v1-2-0" id="id35">v1.2.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id15" id="id35">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id16" id="id36">Release Summary</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-1-0" id="id36">v1.1.0</a></p>
<li><p><a class="reference internal" href="#v1-1-0" id="id37">v1.1.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id16" id="id37">Minor Changes</a></p></li>
<li><p><a class="reference internal" href="#id17" id="id38">Minor Changes</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#v1-0-0" id="id38">v1.0.0</a></p>
<li><p><a class="reference internal" href="#v1-0-0" id="id39">v1.0.0</a></p>
<ul>
<li><p><a class="reference internal" href="#id17" id="id39">Release Summary</a></p></li>
<li><p><a class="reference internal" href="#id18" id="id40">Release Summary</a></p></li>
</ul>
</li>
</ul>
@@ -189,43 +189,44 @@
</nav>
<p>This changelog describes changes after version 1.0.0.</p>
<section id="v1-3-2">
<h2><a class="toc-backref" href="#id19" role="doc-backlink">v1.3.2</a><a class="headerlink" href="#v1-3-2" title="Link to this heading"></a></h2>
<h2><a class="toc-backref" href="#id20" role="doc-backlink">v1.3.2</a><a class="headerlink" href="#v1-3-2" title="Link to this heading"></a></h2>
<section id="release-summary">
<h3><a class="toc-backref" href="#id20" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id21" role="doc-backlink">Release Summary</a><a class="headerlink" href="#release-summary" 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 id="minor-changes">
<h3><a class="toc-backref" href="#id21" 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="#id22" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#minor-changes" title="Link to this heading"></a></h3>
<ul class="simple">
<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>
<li><p>docs: Use proper type for connections parameter <a class="reference external" href="https://github.com/kubevirt/kubevirt.core/pull/90">#90</a></p></li>
<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="bugfixes">
<h3><a class="toc-backref" href="#id22" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" title="Link to this heading"></a></h3>
<h3><a class="toc-backref" href="#id23" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#bugfixes" 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>
</ul>
</section>
</section>
<section id="v1-3-1">
<h2><a class="toc-backref" href="#id23" role="doc-backlink">v1.3.1</a><a class="headerlink" href="#v1-3-1" title="Link to this heading"></a></h2>
<section id="id4">
<h3><a class="toc-backref" href="#id24" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id4" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id24" role="doc-backlink">v1.3.1</a><a class="headerlink" href="#v1-3-1" title="Link to this heading"></a></h2>
<section id="id5">
<h3><a class="toc-backref" href="#id25" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id5" 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="#id25" role="doc-backlink">v1.3.0</a><a class="headerlink" href="#v1-3-0" title="Link to this heading"></a></h2>
<section id="id5">
<h3><a class="toc-backref" href="#id26" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id5" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id26" role="doc-backlink">v1.3.0</a><a class="headerlink" href="#v1-3-0" title="Link to this heading"></a></h2>
<section id="id6">
<h3><a class="toc-backref" href="#id27" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id6" 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="id8">
<h3><a class="toc-backref" href="#id27" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id8" title="Link to this heading"></a></h3>
<section id="id9">
<h3><a class="toc-backref" href="#id28" role="doc-backlink">Bugfixes</a><a class="headerlink" href="#id9" 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>
@@ -234,37 +235,37 @@
</section>
</section>
<section id="v1-2-3">
<h2><a class="toc-backref" href="#id28" role="doc-backlink">v1.2.3</a><a class="headerlink" href="#v1-2-3" title="Link to this heading"></a></h2>
<section id="id12">
<h3><a class="toc-backref" href="#id29" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id12" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id29" role="doc-backlink">v1.2.3</a><a class="headerlink" href="#v1-2-3" title="Link to this heading"></a></h2>
<section id="id13">
<h3><a class="toc-backref" href="#id30" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id13" 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="#id30" role="doc-backlink">v1.2.2</a><a class="headerlink" href="#v1-2-2" title="Link to this heading"></a></h2>
<section id="id13">
<h3><a class="toc-backref" href="#id31" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id13" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id31" role="doc-backlink">v1.2.2</a><a class="headerlink" href="#v1-2-2" title="Link to this heading"></a></h2>
<section id="id14">
<h3><a class="toc-backref" href="#id32" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id14" 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="#id32" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Link to this heading"></a></h2>
<section id="id14">
<h3><a class="toc-backref" href="#id33" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id14" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id33" role="doc-backlink">v1.2.1</a><a class="headerlink" href="#v1-2-1" title="Link to this heading"></a></h2>
<section id="id15">
<h3><a class="toc-backref" href="#id34" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id15" title="Link to this heading"></a></h3>
<p>Mostly code cleanups and dependency updates to ensure compatibility with KubeVirt &gt;= 1.1.0</p>
</section>
</section>
<section id="v1-2-0">
<h2><a class="toc-backref" href="#id34" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Link to this heading"></a></h2>
<section id="id15">
<h3><a class="toc-backref" href="#id35" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id15" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id35" role="doc-backlink">v1.2.0</a><a class="headerlink" href="#v1-2-0" title="Link to this heading"></a></h2>
<section id="id16">
<h3><a class="toc-backref" href="#id36" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id16" 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="#id36" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Link to this heading"></a></h2>
<section id="id16">
<h3><a class="toc-backref" href="#id37" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id16" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id37" role="doc-backlink">v1.1.0</a><a class="headerlink" href="#v1-1-0" title="Link to this heading"></a></h2>
<section id="id17">
<h3><a class="toc-backref" href="#id38" role="doc-backlink">Minor Changes</a><a class="headerlink" href="#id17" 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>
@@ -273,9 +274,9 @@
</section>
</section>
<section id="v1-0-0">
<h2><a class="toc-backref" href="#id38" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Link to this heading"></a></h2>
<section id="id17">
<h3><a class="toc-backref" href="#id39" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id17" title="Link to this heading"></a></h3>
<h2><a class="toc-backref" href="#id39" role="doc-backlink">v1.0.0</a><a class="headerlink" href="#v1-0-0" title="Link to this heading"></a></h2>
<section id="id18">
<h3><a class="toc-backref" href="#id40" role="doc-backlink">Release Summary</a><a class="headerlink" href="#id18" title="Link to this heading"></a></h3>
<p>Initial release</p>
</section>
</section>

1
main/_sources/CHANGELOG.rst.txt
View File

@@ -19,6 +19,7 @@ Minor Changes
- cleanup: Cleanup YAML passed to k8s module `#88 <https://github.com/kubevirt/kubevirt.core/pull/88>`_
- docs: Use proper type for connections parameter `#90 <https://github.com/kubevirt/kubevirt.core/pull/90>`_
- feat(kubevirt_vm_info): Set wait_condition based on running `#91 <https://github.com/kubevirt/kubevirt.core/pull/91>`_
Bugfixes
--------

45
main/_sources/plugins/kubevirt_vm_info.rst.txt
View File

@@ -417,6 +417,28 @@ Parameters
</tr>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-running"></div>
<p class="ansible-option-title"><strong>running</strong></p>
<a class="ansibleOptionLink" href="#parameter-running" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">boolean</span>
</p>
<p><em class="ansible-option-versionadded">added in kubevirt.core 1.4.0</em></p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify whether the VirtualMachine should be running.</p>
<p>This affects the ready condition to wait for.</p>
<p>This requires <code class='docutils literal notranslate'>wait</code> and is only used when <em>wait=yes</em>.</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">false</code></p></li>
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">true</code></p></li>
</ul>
</div></td>
</tr>
<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>
@@ -430,7 +452,7 @@ Parameters
<p>Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the <a href='../../community/okd/k8s_auth_module.html' class='module'>community.okd.k8s_auth</a> module, as that might do what you need.</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>
@@ -451,7 +473,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"></div>
<p class="ansible-option-title"><strong>wait</strong></p>
@@ -462,15 +484,17 @@ Parameters
</div></td>
<td><div class="ansible-option-cell">
<p>Whether to wait for the VirtualMachine to end up in the ready state.</p>
<p>By default this is waiting for the VirtualMachine to be up and running.</p>
<p>Modify this behavior by setting <code class='docutils literal notranslate'>running</code>.</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>false</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">false</code></p></li>
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">true</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-wait_sleep"></div>
<p class="ansible-option-title"><strong>wait_sleep</strong></p>
@@ -485,7 +509,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-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-wait_timeout"></div>
<p class="ansible-option-title"><strong>wait_timeout</strong></p>
@@ -547,12 +571,19 @@ Examples
label_selectors:
- app=test
- name: Wait until the VirtualMachine is Ready
- name: Wait until the VirtualMachine is running
kubevirt.core.kubevirt_vm_info:
name: testvm
namespace: default
wait: true
- name: Wait until the VirtualMachine is stopped
kubevirt.core.kubevirt_vm_info:
name: testvm
namespace: default
running: false
wait: true
@@ -599,7 +630,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>The VirtualMachine(s) that exists</p>
<p>The VirtualMachine(s) that exist(s)</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
</div></td>
</tr>

45
main/plugins/kubevirt_vm_info.html
View File

@@ -483,6 +483,28 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</tr>
<tr class="row-even">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-running"></div>
<p class="ansible-option-title"><strong>running</strong></p>
<a class="ansibleOptionLink" href="#parameter-running" title="Permalink to this option"></a>
<p class="ansible-option-type-line">
<span class="ansible-option-type">boolean</span>
</p>
<p><em class="ansible-option-versionadded">added in kubevirt.core 1.4.0</em></p>
</div></td>
<td><div class="ansible-option-cell">
<p>Specify whether the VirtualMachine should be running.</p>
<p>This affects the ready condition to wait for.</p>
<p>This requires <code class='docutils literal notranslate'>wait</code> and is only used when <em>wait=yes</em>.</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">false</code></p></li>
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">true</code></p></li>
</ul>
</div></td>
</tr>
<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>
@@ -496,7 +518,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<p>Please note that this only works with clusters configured to use HTTP Basic Auth. If your cluster has a different form of authentication (e.g. OAuth2 in OpenShift), this option will not work as expected and you should look into the <a href='../../community/okd/k8s_auth_module.html' class='module'>community.okd.k8s_auth</a> module, as that might do what you need.</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>
@@ -517,7 +539,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"></div>
<p class="ansible-option-title"><strong>wait</strong></p>
@@ -528,15 +550,17 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-cell">
<p>Whether to wait for the VirtualMachine to end up in the ready state.</p>
<p>By default this is waiting for the VirtualMachine to be up and running.</p>
<p>Modify this behavior by setting <code class='docutils literal notranslate'>running</code>.</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>false</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">false</code></p></li>
<li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">true</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-wait_sleep"></div>
<p class="ansible-option-title"><strong>wait_sleep</strong></p>
@@ -551,7 +575,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-even">
<tr class="row-odd">
<td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-wait_timeout"></div>
<p class="ansible-option-title"><strong>wait_timeout</strong></p>
@@ -599,11 +623,18 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<span class="w"> </span><span class="nt">label_selectors</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">app=test</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">Wait until the VirtualMachine is Ready</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">Wait until the VirtualMachine is running</span>
<span class="w"> </span><span class="nt">kubevirt.core.kubevirt_vm_info</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">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">Wait until the VirtualMachine is stopped</span>
<span class="w"> </span><span class="nt">kubevirt.core.kubevirt_vm_info</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">running</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</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>
@@ -642,7 +673,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</p>
</div></td>
<td><div class="ansible-option-cell">
<p>The VirtualMachine(s) that exists</p>
<p>The VirtualMachine(s) that exist(s)</p>
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
</div></td>
</tr>

2
main/searchindex.js
View File

File diff suppressed because one or more lines are too long