internet/kubevirt.core
3
0
Fork 0
mirror of https://github.com/kubevirt/kubevirt.core.git synced 2026-07-29 02:44:35 +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-08-27 13:08:03 +00:00
parent eddad74166
commit cd7c574e53
8 changed files with 22 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,4 +1,3 @@
.. Document meta .. Document meta
:orphan: :orphan:
@@ -7,7 +6,7 @@
:trim: :trim:
.. meta:: .. meta::
:antsibull-docs: 2.12.0 :antsibull-docs: 2.13.1
.. Anchors .. Anchors
@@ -51,8 +50,8 @@ Synopsis
- Fetch virtual machines from one or more namespaces with an optional label selector. - Fetch virtual machines from one or more namespaces with an optional label selector.
- Groups by cluster name, namespaces and labels. - Groups by cluster name, namespaces and labels.
- Uses \ :ansval:`\*.kubevirt.[yml|yaml]`\ YAML configuration file to set parameter values. - Uses :ansval:`\*.kubevirt.[yml|yaml]` YAML configuration file to set parameter values.
- By default it uses the active context in \ :emphasis:`~/.kube/config`\ and will return all virtual machines for all namespaces the active user is authorized to access. - By default it uses the active context in :emphasis:`~/.kube/config` and will return all virtual machines for all namespaces the active user is authorized to access.
.. Aliases .. Aliases
@@ -1036,7 +1035,7 @@ Notes
----- -----
.. note:: .. note::
- To avoid SSL certificate validation errors when \ :ansopt:`kubevirt.core.kubevirt#inventory:validate\_certs=yes`\ , the full certificate chain for the API server must be provided via \ :ansopt:`kubevirt.core.kubevirt#inventory:ca\_cert`\ or in the \ :ansopt:`kubevirt.core.kubevirt#inventory:kubeconfig`\ file. - To avoid SSL certificate validation errors when :ansopt:`kubevirt.core.kubevirt#inventory:validate\_certs=yes`\ , the full certificate chain for the API server must be provided via :ansopt:`kubevirt.core.kubevirt#inventory:ca\_cert` or in the :ansopt:`kubevirt.core.kubevirt#inventory:kubeconfig` file.
.. Seealso .. Seealso
@@ -1048,7 +1047,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
# Filename must end with kubevirt.[yml|yaml] # Filename must end with kubevirt.[yml|yaml]
# Authenticate with token and return all virtual machines from all accessible namespaces # Authenticate with token and return all virtual machines from all accessible namespaces
@@ -1076,7 +1074,6 @@ Examples
.. Facts .. Facts
@@ -1091,7 +1088,7 @@ Examples
Authors Authors
~~~~~~~ ~~~~~~~
- KubeVirt.io Project - KubeVirt.io Project
.. hint:: .. hint::
@@ -1101,4 +1098,3 @@ Authors
.. Parsing errors .. Parsing errors

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

@@ -1,4 +1,3 @@
.. Document meta .. Document meta
:orphan: :orphan:
@@ -7,7 +6,7 @@
:trim: :trim:
.. meta:: .. meta::
:antsibull-docs: 2.12.0 :antsibull-docs: 2.13.1
.. Anchors .. Anchors
@@ -755,7 +754,7 @@ Notes
----- -----
.. note:: .. note::
- To avoid SSL certificate validation errors when \ :ansopt:`kubevirt.core.kubevirt\_vm#module:validate\_certs=yes`\ , the full certificate chain for the API server must be provided via \ :ansopt:`kubevirt.core.kubevirt\_vm#module:ca\_cert`\ or in the \ :ansopt:`kubevirt.core.kubevirt\_vm#module:kubeconfig`\ file. - To avoid SSL certificate validation errors when :ansopt:`kubevirt.core.kubevirt\_vm#module:validate\_certs=yes`\ , the full certificate chain for the API server must be provided via :ansopt:`kubevirt.core.kubevirt\_vm#module:ca\_cert` or in the :ansopt:`kubevirt.core.kubevirt\_vm#module:kubeconfig` file.
.. Seealso .. Seealso
@@ -767,7 +766,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
- name: Create a VirtualMachine - name: Create a VirtualMachine
kubevirt.core.kubevirt_vm: kubevirt.core.kubevirt_vm:
state: present state: present
@@ -853,7 +851,6 @@ Examples
.. Facts .. Facts
@@ -945,7 +942,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
Authors Authors
~~~~~~~ ~~~~~~~
- KubeVirt.io Project - KubeVirt.io Project
@@ -953,4 +950,3 @@ Authors
.. Parsing errors .. Parsing errors

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

@@ -1,4 +1,3 @@
.. Document meta .. Document meta
:orphan: :orphan:
@@ -7,7 +6,7 @@
:trim: :trim:
.. meta:: .. meta::
:antsibull-docs: 2.12.0 :antsibull-docs: 2.13.1
.. Anchors .. Anchors
@@ -49,8 +48,8 @@ Synopsis
.. Description .. Description
- Use the Kubernetes Python client to perform read operations on KubeVirt \ :literal:`VirtualMachines`\ . - Use the Kubernetes Python client to perform read operations on KubeVirt :literal:`VirtualMachines`.
- Pass options to find \ :literal:`VirtualMachines`\ as module arguments. - Pass options to find :literal:`VirtualMachines` as module arguments.
- Authenticate using either a config file, certificates, password or token. - Authenticate using either a config file, certificates, password or token.
- Supports check mode. - Supports check mode.
@@ -544,7 +543,7 @@ Notes
----- -----
.. note:: .. note::
- To avoid SSL certificate validation errors when \ :ansopt:`kubevirt.core.kubevirt\_vm\_info#module:validate\_certs=yes`\ , the full certificate chain for the API server must be provided via \ :ansopt:`kubevirt.core.kubevirt\_vm\_info#module:ca\_cert`\ or in the \ :ansopt:`kubevirt.core.kubevirt\_vm\_info#module:kubeconfig`\ file. - To avoid SSL certificate validation errors when :ansopt:`kubevirt.core.kubevirt\_vm\_info#module:validate\_certs=yes`\ , the full certificate chain for the API server must be provided via :ansopt:`kubevirt.core.kubevirt\_vm\_info#module:ca\_cert` or in the :ansopt:`kubevirt.core.kubevirt\_vm\_info#module:kubeconfig` file.
.. Seealso .. Seealso
@@ -556,7 +555,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
- name: Get an existing VirtualMachine - name: Get an existing VirtualMachine
kubevirt.core.kubevirt_vm_info: kubevirt.core.kubevirt_vm_info:
name: testvm name: testvm
@@ -592,7 +590,6 @@ Examples
.. Facts .. Facts
@@ -724,7 +721,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
Authors Authors
~~~~~~~ ~~~~~~~
- KubeVirt.io Project - KubeVirt.io Project
@@ -732,4 +729,3 @@ Authors
.. Parsing errors .. Parsing errors

14
main/_sources/plugins/kubevirt_vmi_info.rst.txt
View File

@@ -1,4 +1,3 @@
.. Document meta .. Document meta
:orphan: :orphan:
@@ -7,7 +6,7 @@
:trim: :trim:
.. meta:: .. meta::
:antsibull-docs: 2.12.0 :antsibull-docs: 2.13.1
.. Anchors .. Anchors
@@ -49,8 +48,8 @@ Synopsis
.. Description .. Description
- Use the Kubernetes Python client to perform read operations on KubeVirt \ :literal:`VirtualMachineInstances`\ . - Use the Kubernetes Python client to perform read operations on KubeVirt :literal:`VirtualMachineInstances`.
- Pass options to find \ :literal:`VirtualMachineInstances`\ as module arguments. - Pass options to find :literal:`VirtualMachineInstances` as module arguments.
- Authenticate using either a config file, certificates, password or token. - Authenticate using either a config file, certificates, password or token.
- Supports check mode. - Supports check mode.
@@ -521,7 +520,7 @@ Notes
----- -----
.. note:: .. note::
- To avoid SSL certificate validation errors when \ :ansopt:`kubevirt.core.kubevirt\_vmi\_info#module:validate\_certs=yes`\ , the full certificate chain for the API server must be provided via \ :ansopt:`kubevirt.core.kubevirt\_vmi\_info#module:ca\_cert`\ or in the \ :ansopt:`kubevirt.core.kubevirt\_vmi\_info#module:kubeconfig`\ file. - To avoid SSL certificate validation errors when :ansopt:`kubevirt.core.kubevirt\_vmi\_info#module:validate\_certs=yes`\ , the full certificate chain for the API server must be provided via :ansopt:`kubevirt.core.kubevirt\_vmi\_info#module:ca\_cert` or in the :ansopt:`kubevirt.core.kubevirt\_vmi\_info#module:kubeconfig` file.
.. Seealso .. Seealso
@@ -533,7 +532,6 @@ Examples
.. code-block:: yaml+jinja .. code-block:: yaml+jinja
- name: Get an existing VirtualMachineInstance - name: Get an existing VirtualMachineInstance
kubevirt.core.kubevirt_vmi_info: kubevirt.core.kubevirt_vmi_info:
name: testvmi name: testvmi
@@ -562,7 +560,6 @@ Examples
.. Facts .. Facts
@@ -694,7 +691,7 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
Authors Authors
~~~~~~~ ~~~~~~~
- KubeVirt.io Project - KubeVirt.io Project
@@ -702,4 +699,3 @@ Authors
.. Parsing errors .. Parsing errors

2
main/plugins/kubevirt.html
View File

@@ -2,7 +2,7 @@
<html class="writer-html5" lang="en" data-content_root="../"> <html class="writer-html5" lang="en" data-content_root="../">
<head> <head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.12.0" name="antsibull-docs" /> <meta content="2.13.1" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances &mdash; KubeVirt Ansible Collection documentation</title> <title>kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances &mdash; KubeVirt Ansible Collection documentation</title>

2
main/plugins/kubevirt_vm.html
View File

@@ -2,7 +2,7 @@
<html class="writer-html5" lang="en" data-content_root="../"> <html class="writer-html5" lang="en" data-content_root="../">
<head> <head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.12.0" name="antsibull-docs" /> <meta content="2.13.1" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kubevirt_vm – Create or delete KubeVirt VirtualMachines &mdash; KubeVirt Ansible Collection documentation</title> <title>kubevirt_vm – Create or delete KubeVirt VirtualMachines &mdash; KubeVirt Ansible Collection documentation</title>

2
main/plugins/kubevirt_vm_info.html
View File

@@ -2,7 +2,7 @@
<html class="writer-html5" lang="en" data-content_root="../"> <html class="writer-html5" lang="en" data-content_root="../">
<head> <head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.12.0" name="antsibull-docs" /> <meta content="2.13.1" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kubevirt_vm_info – Describe KubeVirt VirtualMachines &mdash; KubeVirt Ansible Collection documentation</title> <title>kubevirt_vm_info – Describe KubeVirt VirtualMachines &mdash; KubeVirt Ansible Collection documentation</title>

2
main/plugins/kubevirt_vmi_info.html
View File

@@ -2,7 +2,7 @@
<html class="writer-html5" lang="en" data-content_root="../"> <html class="writer-html5" lang="en" data-content_root="../">
<head> <head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.12.0" name="antsibull-docs" /> <meta content="2.13.1" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kubevirt_vmi_info – Describe KubeVirt VirtualMachineInstances &mdash; KubeVirt Ansible Collection documentation</title> <title>kubevirt_vmi_info – Describe KubeVirt VirtualMachineInstances &mdash; KubeVirt Ansible Collection documentation</title>