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-11-08 15:05:08 +00:00
parent f59811d949
commit 69898a5a2f
5 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
main/README.html
View File

@@ -118,7 +118,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>&gt;=2.15,&lt;=2.17</strong> and Python versions <strong>&gt;=3.9,&lt;=3.12</strong>.</p>
<p>This collection has been tested against Ansible versions <strong>&gt;=2.15,&lt;=2.18</strong> and Python versions <strong>&gt;=3.9,&lt;=3.13</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>

2
main/_sources/README.md.txt
View File

@@ -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.15,<=2.17** and Python versions **>=3.9,<=3.12**.
This collection has been tested against Ansible versions **>=2.15,<=2.18** and Python versions **>=3.9,<=3.13**.
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 -->

20
main/_sources/plugins/kubevirt.rst.txt
View File

@@ -283,7 +283,7 @@ Parameters
</div></td>
<td><div class="ansible-option-cell">
<p>Prefix to use for cache plugin files/tables</p>
<p>Prefix to use for cache plugin files/tables.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">&#34;ansible_inventory_&#34;</code></p>
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
<ul class="simple">
@@ -318,7 +318,7 @@ Parameters
</div></td>
<td><div class="ansible-option-cell">
<p>Cache duration in seconds</p>
<p>Cache duration in seconds.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">3600</code></p>
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
<ul class="simple">
@@ -561,7 +561,7 @@ Parameters
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>The key from input dictionary used to generate groups</p>
<p>The key from input dictionary used to generate groups.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -575,7 +575,7 @@ Parameters
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>parent group for keyed group</p>
<p>parent group for keyed group.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -589,7 +589,7 @@ Parameters
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>A keyed group name will start with this prefix</p>
<p>A keyed group name will start with this prefix.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">&#34;&#34;</code></p>
</div></td>
</tr>
@@ -604,7 +604,7 @@ Parameters
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>separator used to build the keyed group name</p>
<p>separator used to build the keyed group name.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">&#34;_&#34;</code></p>
</div></td>
</tr>
@@ -620,7 +620,7 @@ Parameters
</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Set this option to <code class="ansible-value literal notranslate">False</code> to omit the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-keyed_groups/separator"><span class="std std-ref"><span class="pre">keyed_groups[].separator</span></span></a></strong></code> after the host variable when the value is an empty string.</p>
<p>Set this option to <code class="ansible-value literal notranslate">false</code> to omit the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-keyed_groups/separator"><span class="std std-ref"><span class="pre">keyed_groups[].separator</span></span></a></strong></code> after the host variable when the value is an empty string.</p>
<p>This option is mutually exclusive with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-keyed_groups/default_value"><span class="std std-ref"><span class="pre">keyed_groups[].default_value</span></span></a></strong></code>.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
@@ -694,10 +694,10 @@ Parameters
</div></td>
<td><div class="ansible-option-cell">
<p>Use in conjunction with keyed_groups.</p>
<p>Use in conjunction with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-keyed_groups"><span class="std std-ref"><span class="pre">keyed_groups</span></span></a></strong></code>.</p>
<p>By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore.</p>
<p>This is because the default prefix is "" and the default separator is "_".</p>
<p>Set this option to False to omit the leading underscore (or other separator) if no prefix is given.</p>
<p>This is because the default prefix is <code class="ansible-value literal notranslate">""</code> and the default separator is <code class="ansible-value literal notranslate">"_"</code>.</p>
<p>Set this option to <code class="ansible-value literal notranslate">false</code> to omit the leading underscore (or other separator) if no prefix is given.</p>
<p>If the group name is derived from a mapping the separator is still used to concatenate the items.</p>
<p>To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>

20
main/plugins/kubevirt.html
View File

@@ -347,7 +347,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-cell">
<p>Prefix to use for cache plugin files/tables</p>
<p>Prefix to use for cache plugin files/tables.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">&#34;ansible_inventory_&#34;</code></p>
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
<ul class="simple">
@@ -382,7 +382,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-cell">
<p>Cache duration in seconds</p>
<p>Cache duration in seconds.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">3600</code></p>
<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
<ul class="simple">
@@ -625,7 +625,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>The key from input dictionary used to generate groups</p>
<p>The key from input dictionary used to generate groups.</p>
</div></td>
</tr>
<tr class="row-even">
@@ -639,7 +639,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>parent group for keyed group</p>
<p>parent group for keyed group.</p>
</div></td>
</tr>
<tr class="row-odd">
@@ -653,7 +653,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>A keyed group name will start with this prefix</p>
<p>A keyed group name will start with this prefix.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">&#34;&#34;</code></p>
</div></td>
</tr>
@@ -668,7 +668,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>separator used to build the keyed group name</p>
<p>separator used to build the keyed group name.</p>
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-value literal notranslate ansible-option-default">&#34;_&#34;</code></p>
</div></td>
</tr>
@@ -684,7 +684,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>Set this option to <code class="ansible-value literal notranslate">False</code> to omit the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-keyed_groups/separator"><span class="std std-ref"><span class="pre">keyed_groups[].separator</span></span></a></strong></code> after the host variable when the value is an empty string.</p>
<p>Set this option to <code class="ansible-value literal notranslate">false</code> to omit the <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-keyed_groups/separator"><span class="std std-ref"><span class="pre">keyed_groups[].separator</span></span></a></strong></code> after the host variable when the value is an empty string.</p>
<p>This option is mutually exclusive with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-keyed_groups/default_value"><span class="std std-ref"><span class="pre">keyed_groups[].default_value</span></span></a></strong></code>.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
@@ -758,10 +758,10 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
</div></td>
<td><div class="ansible-option-cell">
<p>Use in conjunction with keyed_groups.</p>
<p>Use in conjunction with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-keyed_groups"><span class="std std-ref"><span class="pre">keyed_groups</span></span></a></strong></code>.</p>
<p>By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore.</p>
<p>This is because the default prefix is "" and the default separator is "_".</p>
<p>Set this option to False to omit the leading underscore (or other separator) if no prefix is given.</p>
<p>This is because the default prefix is <code class="ansible-value literal notranslate">""</code> and the default separator is <code class="ansible-value literal notranslate">"_"</code>.</p>
<p>Set this option to <code class="ansible-value literal notranslate">false</code> to omit the leading underscore (or other separator) if no prefix is given.</p>
<p>If the group name is derived from a mapping the separator is still used to concatenate the items.</p>
<p>To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>

2
main/searchindex.js
View File

File diff suppressed because one or more lines are too long