CLOUDSTACK-871. DOC. Document changing a VM's base image.

This commit is contained in:
Jessica 2013-08-08 21:00:42 -07:00
parent 535e74d86e
commit dd4c2362be
2 changed files with 42 additions and 0 deletions

View File

@ -0,0 +1,41 @@
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>
<!-- Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="update-iso-vm">
<!-- CLOUDSTACK-667 -->
<title>Changing a VM's Base Image</title>
<para>Every VM is created from a base image, which is a template or ISO which has been
created and stored in &PRODUCT;. Both cloud administrators and end users can create and
modify templates, ISOs, and VMs.</para>
<para>In &PRODUCT;, you can change an
existing VM's base image. For example, suppose there is a template based
on a particular operating system, and the OS vendor releases a software patch. The
administrator or user naturally wants to apply the patch and then make sure existing VMs
start using it. Whether a software update is involved or not, it's also possible to simply
switch a VM from its current template to any other desired template.</para>
<para>To change a VM's base image, call the restoreVirtualMachine API command and pass in the virtual machine
ID and a new template ID. The template ID parameter may refer to either a template or an
ISO. When this call occurs, the VM's root disk is first destroyed, then a new root disk is
created from the source designated in the template ID parameter. The new root disk is
attached to the VM, and now the VM is based on the new template.</para>
</section>

View File

@ -29,4 +29,5 @@
<para>ISO images may be stored in the system and made available with a privacy level similar to templates. ISO images are classified as either bootable or not bootable. A bootable ISO image is one that contains an OS image. &PRODUCT; allows a user to boot a guest VM off of an ISO image. Users can also attach ISO images to guest VMs. For example, this enables installing PV drivers into Windows. ISO images are not hypervisor-specific.</para>
<xi:include href="add-iso.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="attach-iso-to-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="update-iso-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>