Update docs for main

Signed-off-by: kubevirt-bot <kubevirtbot@redhat.com>
2026-04-13 20:31:31 +00:00 · 2024-07-16 11:09:55 +00:00
parent dccc81c7ae
commit db340ef41d
7 changed files with 166 additions and 111 deletions
--- a/main/plugins/kubevirt_vm.html
+++ b/main/plugins/kubevirt_vm.html
@@ -642,6 +642,30 @@ 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-run_strategy"></div>
+    <p class="ansible-option-title"><strong>run_strategy</strong></p>
+    <a class="ansibleOptionLink" href="#parameter-run_strategy" title="Permalink to this option"></a>
+    <p class="ansible-option-type-line">
+      <span class="ansible-option-type">string</span>
+    </p>
+    <p><em class="ansible-option-versionadded">added in kubevirt.core 2.0.0</em></p>
+  </div></td>
+  <td><div class="ansible-option-cell">
+    <p>Specify the <code class='docutils literal notranslate'>RunStrategy</code> of the <code class='docutils literal notranslate'>VirtualMachine</code>.</p>
+    <p>Mutually exclusive with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-running"><span class="std std-ref"><span class="pre">running</span></span></a></strong></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-choices-entry">&#34;Always&#34;</code></p></li>
+      <li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">&#34;Halted&#34;</code></p></li>
+      <li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">&#34;Manual&#34;</code></p></li>
+      <li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">&#34;RerunOnFailure&#34;</code></p></li>
+      <li><p><code class="ansible-value literal notranslate ansible-option-choices-entry">&#34;Once&#34;</code></p></li>
+    </ul>
+
+  </div></td>
+</tr>
+<tr class="row-odd">
  <td><div class="ansible-option-cell">
    <div class="ansibleOptionAnchor" id="parameter-running"></div>
    <p class="ansible-option-title"><strong>running</strong></p>
@@ -652,15 +676,17 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
  </div></td>
  <td><div class="ansible-option-cell">
    <p>Specify whether the <code class='docutils literal notranslate'>VirtualMachine</code> should be running or not.</p>
+    <p>Mutually exclusive with <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-run_strategy"><span class="std std-ref"><span class="pre">run_strategy</span></span></a></strong></code>.</p>
+    <p>Defaults to <code class="ansible-option-value literal notranslate"><a class="reference internal" href="#parameter-running"><span class="std std-ref"><span class="pre">running=yes</span></span></a></code> when <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-running"><span class="std std-ref"><span class="pre">running</span></span></a></strong></code> and <code class="ansible-option literal notranslate"><strong><a class="reference internal" href="#parameter-run_strategy"><span class="std std-ref"><span class="pre">run_strategy</span></span></a></strong></code> are not set.</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-default-bold"><strong>true</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">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-spec"></div>
    <p class="ansible-option-title"><strong>spec</strong></p>
@@ -674,7 +700,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    <p>See <a href='https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec'>https://kubevirt.io/api-reference/main/definitions.html#_v1_virtualmachineinstancespec</a></p>
  </div></td>
 </tr>
-<tr class="row-even">
+<tr class="row-odd">
  <td><div class="ansible-option-cell">
    <div class="ansibleOptionAnchor" id="parameter-state"></div>
    <p class="ansible-option-title"><strong>state</strong></p>
@@ -696,7 +722,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev

  </div></td>
 </tr>
-<tr class="row-odd">
+<tr class="row-even">
  <td><div class="ansible-option-cell">
    <div class="ansibleOptionAnchor" id="parameter-username"></div>
    <p class="ansible-option-title"><strong>username</strong></p>
@@ -710,7 +736,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev
    <p>Can also be specified via <code class="xref std std-envvar literal notranslate">K8S_AUTH_USERNAME</code> environment variable.</p>
  </div></td>
 </tr>
-<tr class="row-even">
+<tr class="row-odd">
  <td><div class="ansible-option-cell">
    <div class="ansibleOptionAnchor" id="parameter-validate_certs"></div>
    <div class="ansibleOptionAnchor" id="parameter-verify_ssl"></div>
@@ -732,7 +758,7 @@ see <a class="reference internal" href="#ansible-collections-kubevirt-core-kubev

  </div></td>
 </tr>
-<tr class="row-odd">
+<tr class="row-even">
  <td><div class="ansible-option-cell">
    <div class="ansibleOptionAnchor" id="parameter-wait"></div>
    <p class="ansible-option-title"><strong>wait</strong></p>
@@ -751,7 +777,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_sleep"></div>
    <p class="ansible-option-title"><strong>wait_sleep</strong></p>
@@ -766,7 +792,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-odd">
+<tr class="row-even">
  <td><div class="ansible-option-cell">
    <div class="ansibleOptionAnchor" id="parameter-wait_timeout"></div>
    <p class="ansible-option-title"><strong>wait_timeout</strong></p>