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-02-26 16:27:59 +00:00
parent 86db612b6b
commit f9ae00832d
20 changed files with 79 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
main/.buildinfo
View File

@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f6790ae2bb1bd5725b622405d2f45290
config: e00b3ef4fe776812a561b8e0c8dd1e8a
tags: 645f666f9bcd5a90fca523b33c5a78b7

2
main/CHANGELOG.html
View File

@@ -155,7 +155,7 @@
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

2
main/CONTRIBUTING.html
View File

@@ -98,7 +98,7 @@
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

10
main/README.html
View File

@@ -49,7 +49,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Lean Ansible bindings for KubeVirt</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#ansible-version-compatibility">Ansible version compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ansible-and-python-version-compatibility">Ansible and Python version compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="#included-content">Included content</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#plugins">Plugins</a></li>
</ul>
@@ -116,9 +116,9 @@
<!--end build_status -->
<p>This repository hosts the <code class="docutils literal notranslate"><span class="pre">kubevirt.core</span></code> Ansible Collection, which provides virtual machine operations and inventory source for use with Ansible.</p>
<!--start requires_ansible-->
<section id="ansible-version-compatibility">
<h2>Ansible version compatibility<a class="headerlink" href="#ansible-version-compatibility" title="Link to this heading"></a></h2>
<p>This collection has been tested against following Ansible versions: <strong>&gt;=2.14.0</strong>.</p>
<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 following Ansible versions <strong>&gt;=2.14.0</strong> and the following Python versions <strong>&gt;=3.11.0,&lt;3.12.0</strong>.</p>
<!--end requires_ansible-->
</section>
<section id="included-content">
@@ -231,7 +231,7 @@ ansible-galaxy<span class="w"> </span>collection<span class="w"> </span>install<
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

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

@@ -6,9 +6,9 @@
This repository hosts the `kubevirt.core` Ansible Collection, which provides virtual machine operations and inventory source for use with Ansible.
<!--start requires_ansible-->
## Ansible version compatibility
## Ansible and Python version compatibility
This collection has been tested against following Ansible versions: **>=2.14.0**.
This collection has been tested against following Ansible versions **>=2.14.0** and the following Python versions **>=3.11.0,<3.12.0**.
<!--end requires_ansible-->
## Included content

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

@@ -7,7 +7,7 @@
:trim:
.. meta::
:antsibull-docs: 2.5.0
:antsibull-docs: 2.7.0
.. Anchors
@@ -848,34 +848,32 @@ Examples
# Filename must end with kubevirt.[yml|yaml]
# Authenticate with token, and return all VirtualMachineInstances for all accessible namespaces
plugin: kubevirt.core.kubevirt
connections:
- host: https://192.168.64.4:8443
api_key: xxxxxxxxxxxxxxxx
validate_certs: false
- name: Authenticate with token and return all VirtualMachineInstances for all accessible namespaces
plugin: kubevirt.core.kubevirt
connections:
- host: https://192.168.64.4:8443
api_key: xxxxxxxxxxxxxxxx
validate_certs: false
# Use default config (~/.kube/config) file and active context, and return VirtualMachineInstances
# from namespace testing with interfaces connected to network bridge-network
plugin: kubevirt.core.kubevirt
connections:
- namespaces:
- testing
network_name: bridge-network
- name: Use default ~/.kube/config and return VirtualMachineInstances from namespace testing with interfaces connected to network bridge-network
plugin: kubevirt.core.kubevirt
connections:
- namespaces:
- testing
network_name: bridge-network
# Use default config (~/.kube/config) file and active context, and return VirtualMachineInstances
# from namespace testing with label app=test
plugin: kubevirt.core.kubevirt
connections:
- namespaces:
- testing
label_selector: app=test
- name: Use default ~/.kube/config and return VirtualMachineInstances from namespace testing with label app=test
plugin: kubevirt.core.kubevirt
connections:
- namespaces:
- testing
label_selector: app=test
# Use a custom config file, and a specific context.
plugin: kubevirt.core.kubevirt
connections:
- kubeconfig: /path/to/config
context: 'awx/192-168-64-4:8443/developer'
- name: Use a custom config file and a specific context
plugin: kubevirt.core.kubevirt
connections:
- kubeconfig: /path/to/config
context: 'awx/192-168-64-4:8443/developer'

4
main/_sources/plugins/kubevirt_vm.rst.txt
View File

@@ -7,7 +7,7 @@
:trim:
.. meta::
:antsibull-docs: 2.5.0
:antsibull-docs: 2.7.0
.. Anchors
@@ -825,7 +825,7 @@ Examples
ssh_authorized_keys:
- ssh-ed25519 AAAA...
name: cloudinit
wait: yes
wait: true
- name: Delete a VirtualMachine
kubevirt.core.kubevirt_vm:

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

@@ -7,7 +7,7 @@
:trim:
.. meta::
:antsibull-docs: 2.5.0
:antsibull-docs: 2.7.0
.. Anchors
@@ -550,7 +550,7 @@ Examples
kubevirt.core.kubevirt_vm_info:
name: testvm
namespace: default
wait: yes
wait: true

2
main/developing.html
View File

@@ -115,7 +115,7 @@
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

2
main/genindex.html
View File

@@ -98,7 +98,7 @@
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

4
main/index.html
View File

@@ -92,7 +92,7 @@
<p class="caption" role="heading"><span class="caption-text">User documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="README.html">Lean Ansible bindings for KubeVirt</a><ul>
<li class="toctree-l2"><a class="reference internal" href="README.html#ansible-version-compatibility">Ansible version compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="README.html#ansible-and-python-version-compatibility">Ansible and Python version compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="README.html#included-content">Included content</a></li>
<li class="toctree-l2"><a class="reference internal" href="README.html#using-this-collection">Using this collection</a></li>
<li class="toctree-l2"><a class="reference internal" href="README.html#code-of-conduct">Code of Conduct</a></li>
@@ -157,7 +157,7 @@
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

2
main/plugins/index.html
View File

@@ -151,7 +151,7 @@
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

52
main/plugins/kubevirt.html
View File

@@ -2,7 +2,7 @@
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.5.0" name="antsibull-docs" />
<meta content="2.7.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kubevirt – KubeVirt inventory source &mdash; Kubevirt Ansible Collection documentation</title>
@@ -891,34 +891,32 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="c1"># Filename must end with kubevirt.[yml|yaml]</span>
<span class="c1"># Authenticate with token, and return all VirtualMachineInstances for all accessible namespaces</span>
<span class="nt">plugin</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubevirt.core.kubevirt</span>
<span class="nt">connections</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">host</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://192.168.64.4:8443</span>
<span class="w"> </span><span class="nt">api_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">xxxxxxxxxxxxxxxx</span>
<span class="w"> </span><span class="nt">validate_certs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</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">Authenticate with token and return all VirtualMachineInstances for all accessible namespaces</span>
<span class="w"> </span><span class="nt">plugin</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubevirt.core.kubevirt</span>
<span class="w"> </span><span class="nt">connections</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">host</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://192.168.64.4:8443</span>
<span class="w"> </span><span class="nt">api_key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">xxxxxxxxxxxxxxxx</span>
<span class="w"> </span><span class="nt">validate_certs</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
<span class="c1"># Use default config (~/.kube/config) file and active context, and return VirtualMachineInstances</span>
<span class="c1"># from namespace testing with interfaces connected to network bridge-network</span>
<span class="nt">plugin</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubevirt.core.kubevirt</span>
<span class="nt">connections</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">namespaces</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">testing</span>
<span class="w"> </span><span class="nt">network_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bridge-network</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">Use default ~/.kube/config and return VirtualMachineInstances from namespace testing with interfaces connected to network bridge-network</span>
<span class="w"> </span><span class="nt">plugin</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubevirt.core.kubevirt</span>
<span class="w"> </span><span class="nt">connections</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">namespaces</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">testing</span>
<span class="w"> </span><span class="nt">network_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">bridge-network</span>
<span class="c1"># Use default config (~/.kube/config) file and active context, and return VirtualMachineInstances</span>
<span class="c1"># from namespace testing with label app=test</span>
<span class="nt">plugin</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubevirt.core.kubevirt</span>
<span class="nt">connections</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">namespaces</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">testing</span>
<span class="w"> </span><span class="nt">label_selector</span><span class="p">:</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">Use default ~/.kube/config and return VirtualMachineInstances from namespace testing with label app=test</span>
<span class="w"> </span><span class="nt">plugin</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubevirt.core.kubevirt</span>
<span class="w"> </span><span class="nt">connections</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">namespaces</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">testing</span>
<span class="w"> </span><span class="nt">label_selector</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">app=test</span>
<span class="c1"># Use a custom config file, and a specific context.</span>
<span class="nt">plugin</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubevirt.core.kubevirt</span>
<span class="nt">connections</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">kubeconfig</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/config</span>
<span class="w"> </span><span class="nt">context</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;awx/192-168-64-4:8443/developer&#39;</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">Use a custom config file and a specific context</span>
<span class="w"> </span><span class="nt">plugin</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">kubevirt.core.kubevirt</span>
<span class="w"> </span><span class="nt">connections</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">kubeconfig</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/path/to/config</span>
<span class="w"> </span><span class="nt">context</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;awx/192-168-64-4:8443/developer&#39;</span>
</pre></div>
</div>
<section id="authors">
@@ -945,7 +943,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

6
main/plugins/kubevirt_vm.html
View File

@@ -2,7 +2,7 @@
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.5.0" name="antsibull-docs" />
<meta content="2.7.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kubevirt_vm – Create or delete KubeVirt VirtualMachines on Kubernetes &mdash; Kubevirt Ansible Collection documentation</title>
@@ -876,7 +876,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<span class="w"> </span><span class="no">ssh_authorized_keys:</span>
<span class="w"> </span><span class="no">- ssh-ed25519 AAAA...</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">cloudinit</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">yes</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">Delete a VirtualMachine</span>
<span class="w"> </span><span class="nt">kubevirt.core.kubevirt_vm</span><span class="p">:</span>
@@ -977,7 +977,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

6
main/plugins/kubevirt_vm_info.html
View File

@@ -2,7 +2,7 @@
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta content="2.5.0" name="antsibull-docs" />
<meta content="2.7.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kubevirt_vm_info – Describe VirtualMachines on Kubernetes &mdash; Kubevirt Ansible Collection documentation</title>
@@ -601,7 +601,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<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">yes</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>
@@ -736,7 +736,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

2
main/releasing.html
View File

@@ -159,7 +159,7 @@ Given a version number MAJOR.MINOR.PATCH, the following is incremented:</p>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

2
main/roles/index.html
View File

@@ -106,7 +106,7 @@
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

2
main/search.html
View File

@@ -106,7 +106,7 @@
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

2
main/searchindex.js
View File

File diff suppressed because one or more lines are too long

2
main/testing.html
View File

@@ -135,7 +135,7 @@ hack/e2e-setup.sh<span class="w"> </span>--cleanup
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023 Red Hat, Inc..</p>
<p>&#169; Copyright 2024 Red Hat, Inc..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a