Skip to content

Commit

Permalink
Update docs for main
Browse files Browse the repository at this point in the history
Signed-off-by: kubevirt-bot <[email protected]>
  • Loading branch information
kubevirt-bot committed Jul 3, 2024
1 parent d084370 commit d0e2045
Show file tree
Hide file tree
Showing 10 changed files with 109 additions and 107 deletions.
141 changes: 71 additions & 70 deletions main/CHANGELOG.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions main/_sources/CHANGELOG.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Major Changes
-------------

- chore: Update supported ansible-core versions to >=2.15 `#105 <https://github.com/kubevirt/kubevirt.core/pull/105>`_
- feat,test(inventory): Support listing stopped VMs and major rework of unit tests `#114 <https://github.com/kubevirt/kubevirt.core/pull/114>`_

Minor Changes
-------------
Expand Down
24 changes: 12 additions & 12 deletions main/_sources/plugins/kubevirt.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
.. Title
kubevirt -- Inventory source for KubeVirt VirtualMachines
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
kubevirt -- Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note
Expand Down Expand Up @@ -49,7 +49,7 @@ Synopsis

.. Description
- Fetch running \ :literal:`VirtualMachineInstances`\ for 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, namespace and labels.
- Uses the \ :ref:`kubernetes.core.kubectl <ansible_collections.kubernetes.core.kubectl_module>`\ connection plugin to access the Kubernetes cluster.
- Uses \ :ansval:`\*.kubevirt.[yml|yaml]`\ YAML configuration file to set parameter values.
Expand Down Expand Up @@ -352,7 +352,7 @@ Parameters

</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Override the base domain used to construct host names of <code class='docutils literal notranslate'>VirtualMachines</code>. Used in case of <code class='docutils literal notranslate'>kubesecondarydns</code> or <code class='docutils literal notranslate'>Services</code> of type <code class='docutils literal notranslate'>NodePort</code> if <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-connections/append_base_domain"><span class="std std-ref"><span class="pre">connections.append_base_domain</span></span></a></strong></code> is set.</p>
<p>Override the base domain used to construct host names. Used in case of <code class='docutils literal notranslate'>kubesecondarydns</code> or <code class='docutils literal notranslate'>Services</code> of type <code class='docutils literal notranslate'>NodePort</code> if <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-connections/append_base_domain"><span class="std std-ref"><span class="pre">connections.append_base_domain</span></span></a></strong></code> is set.</p>
</div></td>
</tr>
<tr class="row-odd">
Expand Down Expand Up @@ -428,7 +428,7 @@ Parameters

</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Enable the creation of groups from labels on <code class='docutils literal notranslate'>VirtualMachines</code>.</p>
<p>Enable the creation of groups from labels on <code class='docutils literal notranslate'>VirtualMachines</code> and <code class='docutils literal notranslate'>VirtualMachineInstances</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>
Expand Down Expand Up @@ -496,7 +496,7 @@ Parameters

</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Define a label selector to select a subset of the fetched <code class='docutils literal notranslate'>VirtualMachineInstances</code>.</p>
<p>Define a label selector to select a subset of the fetched virtual machines.</p>
</div></td>
</tr>
<tr class="row-even">
Expand Down Expand Up @@ -524,7 +524,7 @@ Parameters

</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>List of namespaces. If not specified, will fetch all <code class='docutils literal notranslate'>VirtualMachineInstances</code> for all namespaces the user is authorized to access.</p>
<p>List of namespaces. If not specified, will fetch virtual machines from all namespaces the user is authorized to access.</p>
</div></td>
</tr>
<tr class="row-even">
Expand All @@ -540,7 +540,7 @@ Parameters

</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>In case multiple networks are attached to a <code class='docutils literal notranslate'>VirtualMachineInstance</code>, define which interface should be returned as primary IP address.</p>
<p>In case multiple networks are attached to a virtual machine, define which interface should be returned as primary IP address.</p>
</div></td>
</tr>
<tr class="row-odd">
Expand Down Expand Up @@ -568,7 +568,7 @@ Parameters

</div></td>
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell">
<p>Enable the use of <code class='docutils literal notranslate'>Services</code> to establish an SSH connection to the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
<p>Enable the use of <code class='docutils literal notranslate'>Services</code> to establish an SSH connection to a virtual machine.</p>
<p>Services are only used if no <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-connections/network_name"><span class="std std-ref"><span class="pre">connections.network_name</span></span></a></strong></code> was provided.</p>
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
<ul class="simple">
Expand Down Expand Up @@ -884,21 +884,21 @@ Examples

# Filename must end with kubevirt.[yml|yaml]

- name: Authenticate with token and return all VirtualMachineInstances for all accessible namespaces
- name: Authenticate with token and return all virtual machines from all accessible namespaces
plugin: kubevirt.core.kubevirt
connections:
- host: https://192.168.64.4:8443
api_key: xxxxxxxxxxxxxxxx
validate_certs: false

- name: Use default ~/.kube/config and return VirtualMachineInstances from namespace testing connected to network bridge-network
- name: Use default ~/.kube/config and return virtual machines from namespace testing 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 label app=test
- name: Use default ~/.kube/config and return virtual machines from namespace testing with label app=test
plugin: kubevirt.core.kubevirt
connections:
- namespaces:
Expand Down
2 changes: 1 addition & 1 deletion main/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h1>Welcome to kubevirt.core Collection documentation<a class="headerlink" href=
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugins/index.html">Plugin Index</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plugins/kubevirt.html">kubevirt – Inventory source for KubeVirt VirtualMachines</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/kubevirt.html">kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/kubevirt_vm.html">kubevirt_vm – Create or delete KubeVirt VirtualMachines</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins/kubevirt_vm_info.html">kubevirt_vm_info – Describe KubeVirt VirtualMachines</a></li>
</ul>
Expand Down
Binary file modified main/objects.inv
Binary file not shown.
8 changes: 4 additions & 4 deletions main/plugins/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="kubevirt – Inventory source for KubeVirt VirtualMachines" href="kubevirt.html" />
<link rel="next" title="kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances" href="kubevirt.html" />
<link rel="prev" title="Lean Ansible bindings for KubeVirt" href="../README.html" />
</head>

Expand All @@ -50,7 +50,7 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../README.html">Lean Ansible bindings for KubeVirt</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Plugin Index</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kubevirt.html">kubevirt – Inventory source for KubeVirt VirtualMachines</a></li>
<li class="toctree-l2"><a class="reference internal" href="kubevirt.html">kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances</a></li>
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm.html">kubevirt_vm – Create or delete KubeVirt VirtualMachines</a></li>
<li class="toctree-l2"><a class="reference internal" href="kubevirt_vm_info.html">kubevirt_vm_info – Describe KubeVirt VirtualMachines</a></li>
</ul>
Expand Down Expand Up @@ -98,7 +98,7 @@ <h1>Plugin Index<a class="headerlink" href="#plugin-index" title="Link to this h
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">inventory plugins</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="kubevirt.html">kubevirt – Inventory source for KubeVirt VirtualMachines</a><ul>
<li class="toctree-l1"><a class="reference internal" href="kubevirt.html">kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kubevirt.html#synopsis">Synopsis</a></li>
<li class="toctree-l2"><a class="reference internal" href="kubevirt.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="kubevirt.html#parameters">Parameters</a></li>
Expand Down Expand Up @@ -146,7 +146,7 @@ <h1>Plugin Index<a class="headerlink" href="#plugin-index" title="Link to this h
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../README.html" class="btn btn-neutral float-left" title="Lean Ansible bindings for KubeVirt" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="kubevirt.html" class="btn btn-neutral float-right" title="kubevirt – Inventory source for KubeVirt VirtualMachines" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="kubevirt.html" class="btn btn-neutral float-right" title="kubevirt – Inventory source for KubeVirt VirtualMachines and VirtualMachineInstances" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
Loading

0 comments on commit d0e2045

Please sign in to comment.