Skip to content

Commit

Permalink
Postsubmit site update from 6712548
Browse files Browse the repository at this point in the history
Signed-off-by: kubevirt-bot <[email protected]>
  • Loading branch information
kubevirt-bot committed Dec 10, 2024
1 parent ffadaf8 commit 8f5b2d2
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 50 deletions.
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

59 changes: 10 additions & 49 deletions storage/clone_api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2396,21 +2396,6 @@

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#future-roadmap" class="md-nav__link">
<span class="md-ellipsis">
Future roadmap
</span>
</a>

<nav class="md-nav" aria-label="Future roadmap">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#using-clones-as-a-golden-vm-image" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -2918,21 +2903,6 @@

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#future-roadmap" class="md-nav__link">
<span class="md-ellipsis">
Future roadmap
</span>
</a>

<nav class="md-nav" aria-label="Future roadmap">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#using-clones-as-a-golden-vm-image" class="md-nav__link">
<span class="md-ellipsis">
Expand Down Expand Up @@ -2979,8 +2949,11 @@


<h1 id="clone-api">Clone API<a class="headerlink" href="#clone-api" title="Permanent link">&para;</a></h1>
<p>The <code>clone.kubevirt.io</code> API Group defines resources for cloning KubeVirt objects. Currently, the only supported cloning
type is <code>VirtualMachine</code>, but more types are planned to be supported in the future (see future roadmap below).</p>
<p>The <code>clone.kubevirt.io</code> API Group defines resources for cloning KubeVirt objects.</p>
<p>This API has two main use-cases:
* Cloning a Virtual Machine.
* Creating "golden snapshots" that would be used as a template for creating new VMs
(see <a href="#using-clones-as-a-golden-vm-image">Using clones as a "golden VM image"</a> below).</p>
<p>Please bear in mind that the clone API is in version <code>v1alpha1</code>. This means that this API is not fully stable
yet and that APIs may change in the future.</p>
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">&para;</a></h2>
Expand Down Expand Up @@ -3039,8 +3012,7 @@ <h4 id="source-target">Source &amp; Target<a class="headerlink" href="#source-ta
<ul>
<li>
<p>Currently, the only supported kinds are <code>VirtualMachine</code> (of <code>kubevirt.io</code> api group) and <code>VirtualMachineSnapshot</code> (
of <code>snapshot.kubevirt.io</code> api group), but more types are expected to be supported in the future.
See "future roadmap" below for more info.</p>
of <code>snapshot.kubevirt.io</code> api group), but more types are expected to be supported in the future.</p>
</li>
<li>
<p>The target name is <strong>optional</strong>. If unspecified, the clone controller will generate a name for the target automatically.</p>
Expand Down Expand Up @@ -3121,42 +3093,31 @@ <h3 id="creating-a-virtualmachineclone-object">Creating a VirtualMachineClone ob
<p>After the clone is finished, the target can be inspected:
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>kubectl<span class="w"> </span>get<span class="w"> </span>vm<span class="w"> </span>vm-clone-target<span class="w"> </span>-o<span class="w"> </span>yaml
</code></pre></div></p>
<h2 id="future-roadmap">Future roadmap<a class="headerlink" href="#future-roadmap" title="Permanent link">&para;</a></h2>
<p>The clone API is in an early alpha version and may change dramatically. There are many improvements and features
that are expected to be added, the most significant goals are:</p>
<ul>
<li>Add more supported source types like <code>VirtualMachineInstace</code> in the future.</li>
<li>Add a cross-namespace clone support. This needs to be supported for snapshots / restores first.</li>
</ul>
<h3 id="using-clones-as-a-golden-vm-image">Using clones as a "golden VM image"<a class="headerlink" href="#using-clones-as-a-golden-vm-image" title="Permanent link">&para;</a></h3>
<p>One of the great things that could be accomplished with the clone API when the source is of kind <code>VirtualMachineSnapshot</code>
is to create "golden VM images" (a.k.a. Templates / Bookmark VMs / etc). In other words, the following
workflow would be available:</p>
workflow is available:</p>
<p><strong>Create a golden image</strong></p>
<ul>
<li>
<p>Create a VM</p>
</li>
<li>
<p>Prepare a "golden VM" environment</p>
</li>
<li>
<p>This can mean different things in different contexts. For example, write files, install applications, apply configurations,
or anything else.</p>
<p>Prepare a "golden VM" environment. This can mean different things in different contexts.
For example, add certain users, install a database, configure it in a certain way, etc.</p>
</li>
<li>
<p>Snapshot the VM</p>
</li>
<li>
<p>Delete the VM</p>
<p>Optional: Delete the VM</p>
</li>
</ul>
<p>Then, this "golden image" can be duplicated as many times as needed. To instantiate a VM from the snapshot:</p>
<ul>
<li>Create a Clone object where the source would point to the previously taken snapshot</li>
<li>Create as many VMs you need</li>
</ul>
<p>This feature is still under discussions and may be implemented differently then explained here.</p>



Expand Down

0 comments on commit 8f5b2d2

Please sign in to comment.