You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ke...@apache.org on 2013/10/02 21:13:27 UTC
[22/51] [partial] Removing docs from 4.2 as they are now in their own
repo
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/using-sshkeys.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/using-sshkeys.xml b/docs/en-US/using-sshkeys.xml
deleted file mode 100644
index f34dfa0..0000000
--- a/docs/en-US/using-sshkeys.xml
+++ /dev/null
@@ -1,112 +0,0 @@
-<?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="using-sshkeys">
- <title>Using SSH Keys for Authentication</title>
- <para>In addition to the username and password authentication, &PRODUCT; supports using SSH keys to log in to the cloud infrastructure for additional security. You can use the createSSHKeyPair API to generate the SSH keys.</para>
- <para>Because each cloud user has their own SSH key, one cloud user cannot log in to another cloud user's instances unless they share their SSH key files. Using a single SSH key pair, you can manage multiple instances.</para>
- <section id="create-ssh-template">
- <title> Creating an Instance Template that Supports SSH Keys</title>
- <para>Create a instance template that supports SSH Keys.</para>
- <orderedlist>
- <listitem><para>Create a new instance by using the template provided by cloudstack.</para>
- <para>For more information on creating a new instance, see </para>
- </listitem>
- <listitem><para>Download the cloudstack script from <ulink url="http://sourceforge.net/projects/cloudstack/files/SSH%20Key%20Gen%20Script/">The SSH Key Gen Script</ulink>to the instance you have created.</para>
- <programlisting>wget http://downloads.sourceforge.net/project/cloudstack/SSH%20Key%20Gen%20Script/cloud-set-guest-sshkey.in?r=http%3A%2F%2Fsourceforge.net%2Fprojects%2Fcloudstack%2Ffiles%2FSSH%2520Key%2520Gen%2520Script%2F&ts=1331225219&use_mirror=iweb</programlisting>
- </listitem>
- <listitem><para>Copy the file to /etc/init.d.</para>
- <programlisting>cp cloud-set-guest-sshkey.in /etc/init.d/</programlisting>
- </listitem>
- <listitem><para>Give the necessary permissions on the script:</para>
- <programlisting>chmod +x /etc/init.d/cloud-set-guest-sshkey.in</programlisting>
- </listitem>
- <listitem><para>Run the script while starting up the operating system:</para>
- <programlisting>chkconfig --add cloud-set-guest-sshkey.in</programlisting>
- </listitem>
- <listitem><para>Stop the instance.</para>
- </listitem>
- </orderedlist>
- </section>
- <section id="create-ssh-keypair">
- <title>Creating the SSH Keypair</title>
- <para>You must make a call to the createSSHKeyPair api method. You can either use the &PRODUCT; Python API library or the curl commands to make the call to the cloudstack api.</para>
- <para>For example, make a call from the cloudstack server to create a SSH keypair called "keypair-doc" for the admin account in the root domain:</para>
- <note><para>Ensure that you adjust these values to meet your needs. If you are making the API call from a different server, your URL/PORT will be different, and you will need to use the API keys.</para></note>
- <orderedlist>
- <listitem><para>Run the following curl command:</para>
- <programlisting>curl --globoff "http://localhost:8096/?command=createSSHKeyPair&name=keypair-doc&account=admin&domainid=5163440e-c44b-42b5-9109-ad75cae8e8a2"</programlisting>
- <para>The output is something similar to what is given below:</para>
- <programlisting><?xml version="1.0" encoding="ISO-8859-1"?><createsshkeypairresponse cloud-stack-version="3.0.0.20120228045507"><keypair><name>keypair-doc</name><fingerprint>f6:77:39:d5:5e:77:02:22:6a:d8:7f:ce:ab:cd:b3:56</fingerprint><privatekey>-----BEGIN RSA PRIVATE KEY-----
-MIICXQIBAAKBgQCSydmnQ67jP6lNoXdX3noZjQdrMAWNQZ7y5SrEu4wDxplvhYci
-dXYBeZVwakDVsU2MLGl/K+wefwefwefwefwefJyKJaogMKn7BperPD6n1wIDAQAB
-AoGAdXaJ7uyZKeRDoy6wA0UmF0kSPbMZCR+UTIHNkS/E0/4U+6lhMokmFSHtu
-mfDZ1kGGDYhMsdytjDBztljawfawfeawefawfawfawQQDCjEsoRdgkduTy
-QpbSGDIa11Jsc+XNDx2fgRinDsxXI/zJYXTKRhSl/LIPHBw/brW8vzxhOlSOrwm7
-VvemkkgpAkEAwSeEw394LYZiEVv395ar9MLRVTVLwpo54jC4tsOxQCBlloocK
-lYaocpk0yBqqOUSBawfIiDCuLXSdvBo1Xz5ICTM19vgvEp/+kMuECQBzm
-nVo8b2Gvyagqt/KEQo8wzH2THghZ1qQ1QRhIeJG2aissEacF6bGB2oZ7Igim5L14
-4KR7OeEToyCLC2k+02UCQQCrniSnWKtDVoVqeK/zbB32JhW3Wullv5p5zUEcd
-KfEEuzcCUIxtJYTahJ1pvlFkQ8anpuxjSEDp8x/18bq3
------END RSA PRIVATE KEY-----
-</privatekey></keypair></createsshkeypairresponse></programlisting></listitem>
- <listitem><para>Copy the key data into a file. The file looks like this:</para>
- <programlisting>-----BEGIN RSA PRIVATE KEY-----
-MIICXQIBAAKBgQCSydmnQ67jP6lNoXdX3noZjQdrMAWNQZ7y5SrEu4wDxplvhYci
-dXYBeZVwakDVsU2MLGl/K+wefwefwefwefwefJyKJaogMKn7BperPD6n1wIDAQAB
-AoGAdXaJ7uyZKeRDoy6wA0UmF0kSPbMZCR+UTIHNkS/E0/4U+6lhMokmFSHtu
-mfDZ1kGGDYhMsdytjDBztljawfawfeawefawfawfawQQDCjEsoRdgkduTy
-QpbSGDIa11Jsc+XNDx2fgRinDsxXI/zJYXTKRhSl/LIPHBw/brW8vzxhOlSOrwm7
-VvemkkgpAkEAwSeEw394LYZiEVv395ar9MLRVTVLwpo54jC4tsOxQCBlloocK
-lYaocpk0yBqqOUSBawfIiDCuLXSdvBo1Xz5ICTM19vgvEp/+kMuECQBzm
-nVo8b2Gvyagqt/KEQo8wzH2THghZ1qQ1QRhIeJG2aissEacF6bGB2oZ7Igim5L14
-4KR7OeEToyCLC2k+02UCQQCrniSnWKtDVoVqeK/zbB32JhW3Wullv5p5zUEcd
-KfEEuzcCUIxtJYTahJ1pvlFkQ8anpuxjSEDp8x/18bq3
------END RSA PRIVATE KEY-----</programlisting></listitem>
- <listitem><para>Save the file.</para></listitem>
- </orderedlist>
- </section>
- <section id="creating-ssh-instance">
- <title>Creating an Instance</title>
- <para>After you save the SSH keypair file, you must create an instance by using the template that you created at <xref linkend="create-ssh-template"/>. Ensure that you use the same SSH key name that you created at <xref linkend="create-ssh-keypair"/>.</para>
- <note><para>You cannot create the instance by using the GUI at this time and associate the instance with the newly created SSH keypair.</para></note>
- <para>A sample curl command to create a new instance is:</para>
- <programlisting>curl --globoff http://localhost:<port number>/?command=deployVirtualMachine\&zoneId=1\&serviceOfferingId=18727021-7556-4110-9322-d625b52e0813\&templateId=e899c18a-ce13-4bbf-98a9-625c5026e0b5\&securitygroupids=ff03f02f-9e3b-48f8-834d-91b822da40c5\&account=admin\&domainid=1\&keypair=keypair-doc</programlisting>
- <para>Substitute the template, service offering and security group IDs (if you are using the security group feature) that are in your cloud environment.</para>
- </section>
- <section id="logging-in-ssh">
- <title>Logging In Using the SSH Keypair</title>
- <para>To test your SSH key generation is successful, check whether you can log in to the cloud setup.</para>
- <para>For exaple, from a Linux OS, run:</para>
- <programlisting>ssh -i ~/.ssh/keypair-doc <ip address></programlisting>
- <para>The -i parameter tells the ssh client to use a ssh key found at ~/.ssh/keypair-doc.</para>
- </section>
- <section id="reset-ssh">
- <title>Resetting SSH Keys</title>
- <para>With the API command resetSSHKeyForVirtualMachine, a user can set or reset the SSH keypair
- assigned to a virtual machine. A lost or compromised SSH keypair
- can be changed, and the user can access the VM by using the new keypair. Just create or register a
- new keypair, then call resetSSHKeyForVirtualMachine.</para>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/using-swift-for-secondary-storage.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/using-swift-for-secondary-storage.xml b/docs/en-US/using-swift-for-secondary-storage.xml
deleted file mode 100644
index 329cf81..0000000
--- a/docs/en-US/using-swift-for-secondary-storage.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?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="using-swift-for-secondary-storage">
- <title>Using Swift for Secondary Storage</title>
- <para>&PRODUCT; supports OpenStack Object Storage (<ulink url="http://swift.openstack.org/"> Swift</ulink>) for secondary storage. When using Swift, you configure Swift storage for the entire &PRODUCT;, then set up NFS secondary storage for each zone as usual. The NFS storage in each zone acts as a staging area through which all templates and other secondary storage data pass before being forwarded to Swift. The Swift storage acts as a cloud-wide resource, making templates and other data available to any zone in the cloud. There is no hierarchy in the Swift storage, just one Swift container per storage object. Any secondary storage in the whole cloud can pull a container from Swift at need. It is not necessary to copy templates and snapshots from one zone to another, as would be required when using zone NFS alone. Everything is available everywhere</para>
- <para>Swift storage must be set up before you add NFS secondary storage to zones. This is accomplished through some additional configuration steps on a fresh Management Server installation, before you add the first zone. The procedure is described in Adding a Zone in the Advanced Installation Guide.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/using-vpn-with-mac.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/using-vpn-with-mac.xml b/docs/en-US/using-vpn-with-mac.xml
deleted file mode 100644
index 7696824..0000000
--- a/docs/en-US/using-vpn-with-mac.xml
+++ /dev/null
@@ -1,41 +0,0 @@
-<?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="using-vpn-with-mac">
- <title>Using Remote Access VPN with Mac OS X</title>
- <para>First, be sure you've configured the VPN settings in your &PRODUCT; install. This section is only concerned with connecting via Mac OS X to your VPN.</para>
- <para>Note, these instructions were written on Mac OS X 10.7.5. They may differ slightly in older or newer releases of Mac OS X.</para>
- <orderedlist>
- <listitem><para>On your Mac, open System Preferences and click Network.</para></listitem>
- <listitem><para>Make sure Send all traffic over VPN connection is not checked.</para></listitem>
- <listitem><para>If your preferences are locked, you'll need to click the lock in the bottom left-hand corner to make any changes and provide your administrator credentials.</para></listitem>
- <listitem><para>You will need to create a new network entry. Click the plus icon on the bottom left-hand side and you'll see a dialog that says "Select the interface and enter a name for the new service." Select VPN from the Interface drop-down menu, and "L2TP over IPSec" for the VPN Type. Enter whatever you like within the "Service Name" field.</para></listitem>
- <listitem><para>You'll now have a new network interface with the name of whatever you put in the "Service Name" field. For the purposes of this example, we'll assume you've named it "CloudStack." Click on that interface and provide the IP address of the interface for your VPN under the Server Address field, and the user name for your VPN under Account Name.</para></listitem>
- <listitem><para>Click Authentication Settings, and add the user's password under User Authentication and enter the pre-shared IPSec key in the Shared Secret field under Machine Authentication. Click OK.</para></listitem>
- <listitem><para>You may also want to click the "Show VPN status in menu bar" but that's entirely optional.</para></listitem>
- <listitem><para>Now click "Connect" and you will be connected to the CloudStack VPN.</para></listitem>
- </orderedlist>
-
-
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/using-vpn-with-windows.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/using-vpn-with-windows.xml b/docs/en-US/using-vpn-with-windows.xml
deleted file mode 100644
index 82e556c..0000000
--- a/docs/en-US/using-vpn-with-windows.xml
+++ /dev/null
@@ -1,42 +0,0 @@
-<?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="using-vpn-with-windows">
- <title>Using Remote Access VPN with Windows</title>
- <para>The procedure to use VPN varies by Windows version. Generally, the user must edit the VPN properties and make sure that the default route is not the VPN. The following steps are for Windows L2TP clients on Windows Vista. The commands should be similar for other Windows versions.</para>
- <orderedlist>
- <listitem id="source-nat"><para>Log in to the &PRODUCT; UI and click on the source NAT IP for the account. The VPN tab should display the IPsec preshared key. Make a note of this and the source NAT IP. The UI also lists one or more users and their passwords. Choose one of these users, or, if none exists, add a user and password.</para></listitem>
- <listitem><para>On the Windows box, go to Control Panel, then select Network and Sharing center. Click Setup a connection or network.</para></listitem>
- <listitem><para>In the next dialog, select No, create a new connection.</para></listitem>
- <listitem><para>In the next dialog, select Use my Internet Connection (VPN).</para></listitem>
- <listitem><para>In the next dialog, enter the source NAT IP from step <xref linkend="source-nat"/> and give the connection a name. Check Don't connect now.</para></listitem>
- <listitem><para>In the next dialog, enter the user name and password selected in step <xref linkend="source-nat"/>.</para></listitem>
- <listitem><para>Click Create.</para></listitem>
- <listitem><para>Go back to the Control Panel and click Network Connections to see the new connection. The connection is not active yet.</para></listitem>
- <listitem><para>Right-click the new connection and select Properties. In the Properties dialog, select the Networking tab.</para></listitem>
- <listitem><para>In Type of VPN, choose L2TP IPsec VPN, then click IPsec settings. Select Use preshared key. Enter the preshared key from step <xref linkend="source-nat"/>.</para></listitem>
- <listitem><para>The connection is ready for activation. Go back to Control Panel -> Network Connections and double-click the created connection.</para></listitem>
- <listitem><para>Enter the user name and password from step <xref linkend="source-nat"/>.</para></listitem>
- </orderedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/vcenter-maintenance-mode.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vcenter-maintenance-mode.xml b/docs/en-US/vcenter-maintenance-mode.xml
deleted file mode 100644
index d36dd7c..0000000
--- a/docs/en-US/vcenter-maintenance-mode.xml
+++ /dev/null
@@ -1,41 +0,0 @@
-<?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="vcenter-maintenance-mode">
- <title>vCenter and Maintenance Mode</title>
- <para>To enter maintenance mode on a vCenter host, both vCenter and &PRODUCT; must be used in concert. &PRODUCT; and vCenter have separate maintenance modes that work closely together.</para>
- <orderedlist>
- <listitem><para>Place the host into &PRODUCT;'s "scheduled maintenance" mode. This does not invoke the vCenter maintenance mode, but only causes VMs to be migrated off the host</para>
- <para>When the &PRODUCT; maintenance mode is requested, the host first moves into the Prepare for Maintenance state. In this state it cannot be the target of new guest VM starts. Then all VMs will be migrated off the server. Live migration will be used to move VMs off the host. This allows the guests to be migrated to other hosts with no disruption to the guests. After this migration is completed, the host will enter the Ready for Maintenance mode.</para></listitem>
- <listitem><para>Wait for the "Ready for Maintenance" indicator to appear in the UI.</para></listitem>
- <listitem><para>Now use vCenter to perform whatever actions are necessary to maintain the host. During this time, the host cannot be the target of new VM allocations.</para></listitem>
- <listitem><para>When the maintenance tasks are complete, take the host out of maintenance mode as follows:</para>
- <orderedlist numeration="loweralpha">
- <listitem><para>First use vCenter to exit the vCenter maintenance mode.</para>
- <para>This makes the host ready for &PRODUCT; to reactivate it.</para></listitem>
- <listitem><para>Then use &PRODUCT;'s administrator UI to cancel the &PRODUCT; maintenance mode</para>
- <para>When the host comes back online, the VMs that were migrated off of it may be migrated back to it manually and new VMs can be added.</para></listitem>
- </orderedlist></listitem>
- </orderedlist>
-
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/verifying-source.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/verifying-source.xml b/docs/en-US/verifying-source.xml
deleted file mode 100644
index b20b9bb..0000000
--- a/docs/en-US/verifying-source.xml
+++ /dev/null
@@ -1,82 +0,0 @@
-<?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="sect-source-verify">
- <title>Verifying the downloaded release</title>
- <para>
- There are a number of mechanisms to check the authenticity and validity of a
- downloaded release.
- </para>
- <section id="sect-source-verify-keys">
- <title>Getting the KEYS</title>
- <para>
- To enable you to verify the GPG signature, you will need to download the
- <ulink url="http://www.apache.org/dist/incubator/cloudstack/KEYS">KEYS</ulink>
- file.
- </para>
- <para>
- You next need to import those keys, which you can do by running:
- <programlisting><prompt>#</prompt> <command>gpg</command> --import KEYS</programlisting>
- </para>
- </section>
- <section id="sect-source-verify-gpg">
- <title>GPG</title>
- <para>
- The &PRODUCT; project provides a detached GPG signature of the release.
- To check the signature, run the following command:
- <programlisting><prompt>$</prompt> <command>gpg</command> --verify apache-cloudstack-4.0.0-incubating-src.tar.bz2.asc</programlisting>
- </para>
- <para>
- If the signature is valid you will see a line of output that contains 'Good signature'.
- </para>
- </section>
- <section id="sect-source-verify-md5">
- <title>MD5</title>
- <para>
- In addition to the cryptographic signature, &PRODUCT; has an MD5 checksum
- that you can use to verify the download matches the release.
- You can verify this hash by executing the following command:
- <programlisting><prompt>$</prompt> <command>gpg</command> --print-md MD5 apache-cloudstack-4.0.0-incubating-src.tar.bz2 | <command>diff</command> - apache-cloudstack-4.0.0-incubating-src.tar.bz2.md5</programlisting>
- </para>
- <para>
- If this successfully completes you should see no output. If there is any output from them,
- then there is a difference between the hash you generated locally and the hash that has been
- pulled from the server.
- </para>
- </section>
- <section id="sect-source-verify-sha512">
- <title>SHA512</title>
- <para>
- In addition to the MD5 hash, the &PRODUCT; project provides a SHA512
- cryptographic hash to aid in assurance of the validity of the downloaded
- release. You can verify this hash by executing the following command:
- <programlisting><prompt>$</prompt> <command>gpg</command> --print-md SHA512 apache-cloudstack-4.0.0-incubating-src.tar.bz2 | <command>diff</command> - apache-cloudstack-4.0.0-incubating-src.tar.bz2.sha</programlisting>
- </para>
- <para>
- If this command successfully completes you should see no output. If there is any output from them,
- then there is a difference between the hash you generated locally and the hash that has been
- pulled from the server.
- </para>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/virtual-machine-usage-record-format.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/virtual-machine-usage-record-format.xml b/docs/en-US/virtual-machine-usage-record-format.xml
deleted file mode 100644
index ac8fec9..0000000
--- a/docs/en-US/virtual-machine-usage-record-format.xml
+++ /dev/null
@@ -1,45 +0,0 @@
-<?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="virtual-machine-usage-record-format">
- <title>Virtual Machine Usage Record Format</title>
- <para>For running and allocated virtual machine usage, the following fields exist in a usage record:</para>
- <itemizedlist>
- <listitem><para>account – name of the account</para></listitem>
- <listitem><para>accountid – ID of the account</para></listitem>
- <listitem><para>domainid – ID of the domain in which this account resides</para></listitem>
- <listitem><para>zoneid – Zone where the usage occurred</para></listitem>
- <listitem><para>description – A string describing what the usage record is tracking</para></listitem>
- <listitem><para>usage – String representation of the usage, including the units of usage (e.g. 'Hrs' for VM running time)</para></listitem>
- <listitem><para>usagetype – A number representing the usage type (see Usage Types)</para></listitem>
- <listitem><para>rawusage – A number representing the actual usage in hours</para></listitem>
- <listitem><para>virtualMachineId – The ID of the virtual machine</para></listitem>
- <listitem><para>name – The name of the virtual machine</para></listitem>
- <listitem><para>offeringid – The ID of the service offering</para></listitem>
- <listitem><para>templateid – The ID of the template or the ID of the parent template. The parent template value is present when the current template was created from a volume.</para></listitem>
- <listitem><para>usageid – Virtual machine</para></listitem>
- <listitem><para>type – Hypervisor</para></listitem>
- <listitem><para>startdate, enddate – The range of time for which the usage is aggregated; see Dates in the Usage Record</para></listitem>
- </itemizedlist>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/virtual-machines.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/virtual-machines.xml b/docs/en-US/virtual-machines.xml
deleted file mode 100644
index 8d88478..0000000
--- a/docs/en-US/virtual-machines.xml
+++ /dev/null
@@ -1,42 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter 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.
--->
-<chapter id="virtual-machines">
- <title>Working With Virtual Machines</title>
- <xi:include href="about-working-with-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="best-practices-for-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="vm-lifecycle.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="creating-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="accessing-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="stopping-and-starting-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="host-allocation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="vm-snapshots.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="changing-vm-name-os-group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="append-displayname-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="changing-service-offering-for-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <section id="reset-volume-on-reboot-vm">
- <title>Resetting the Virtual Machine Root Volume on Reboot</title>
- <para>For secure environments, and to ensure that VM state is not persisted across reboots,
- you can reset the root disk. For more information, see <xref linkend="reset-vm-reboot"/>.</para>
- </section>
- <xi:include href="manual-live-migration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="deleting-vms.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="working-with-iso.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/virtual-router.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/virtual-router.xml b/docs/en-US/virtual-router.xml
deleted file mode 100644
index c9b403b..0000000
--- a/docs/en-US/virtual-router.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-<?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="virtual-router">
- <title>Virtual Router</title>
- <para>The virtual router is a type of System Virtual Machine. The virtual router is one of the most frequently used service providers in &PRODUCT;. The end user has no direct access to the virtual router. Users can ping the virtual router and take actions that affect it (such as setting up port forwarding), but users do not have SSH access into the virtual router.</para>
- <para>There is no mechanism for the administrator to log in to the virtual router. Virtual routers can be restarted by administrators, but this will interrupt public network access and other services for end users. A basic test in debugging networking issues is to attempt to ping the virtual router from a guest VM. Some of the characteristics of the virtual router are determined by its associated system service offering..</para>
- <xi:include href="configure-virtual-router.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="upgrade-virtual-router-with-service-offering.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="best-practices-virtual-router.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/vlan-allocation-eg.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vlan-allocation-eg.xml b/docs/en-US/vlan-allocation-eg.xml
deleted file mode 100644
index 3ffd166..0000000
--- a/docs/en-US/vlan-allocation-eg.xml
+++ /dev/null
@@ -1,71 +0,0 @@
-<?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="vlan-allocation-eg">
- <title>VLAN Allocation Example</title>
- <para>VLANs are required for public and guest traffic. The following is an example of a VLAN
- allocation scheme:</para>
- <informaltable>
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry><para>VLAN IDs</para></entry>
- <entry><para>Traffic type</para></entry>
- <entry><para>Scope</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>less than 500</para></entry>
- <entry><para>Management traffic. Reserved for administrative purposes.</para></entry>
- <entry><para>&PRODUCT; software can access this, hypervisors, system VMs.</para></entry>
- </row>
- <row>
- <entry><para>500-599</para></entry>
- <entry><para>VLAN carrying public traffic.</para></entry>
- <entry><para>&PRODUCT; accounts.</para></entry>
- </row>
- <row>
- <entry><para>600-799</para></entry>
- <entry><para>VLANs carrying guest traffic.</para></entry>
- <entry><para>&PRODUCT; accounts. Account-specific VLAN is chosen from this
- pool.</para></entry>
- </row>
- <row>
- <entry><para>800-899</para></entry>
- <entry><para>VLANs carrying guest traffic.</para></entry>
- <entry><para>&PRODUCT; accounts. Account-specific VLAN chosen by &PRODUCT; admin to assign
- to that account.</para></entry>
- </row>
- <row>
- <entry><para>900-999</para></entry>
- <entry><para>VLAN carrying guest traffic</para></entry>
- <entry><para>&PRODUCT; accounts. Can be scoped by project, domain, or all
- accounts.</para></entry>
- </row>
- <row>
- <entry><para>greater than 1000</para></entry>
- <entry><para>Reserved for future use</para></entry>
- <entry></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/vlan-assign-isolated-nw.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vlan-assign-isolated-nw.xml b/docs/en-US/vlan-assign-isolated-nw.xml
deleted file mode 100644
index 424ecd2..0000000
--- a/docs/en-US/vlan-assign-isolated-nw.xml
+++ /dev/null
@@ -1,66 +0,0 @@
-<?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="vlan-assign-isolated-nw">
- <title>Assigning VLANs to Isolated Networks</title>
- <para>&PRODUCT; provides you the ability to control VLAN assignment to Isolated networks. As a
- Root admin, you can assign a VLAN ID when a network is created, just the way it's done for
- Shared networks.</para>
- <para>The former behaviour also is supported — VLAN is randomly allocated to a network from
- the VNET range of the physical network when the network turns to Implemented state. The VLAN is
- released back to the VNET pool when the network shuts down as a part of the Network Garbage
- Collection. The VLAN can be re-used either by the same network when it is implemented again, or
- by any other network. On each subsequent implementation of a network, a new VLAN can be
- assigned.</para>
- <para>Only the Root admin can assign VLANs because the regular users or domain admin are not aware
- of the physical network topology. They cannot even view what VLAN is assigned to a
- network.</para>
- <para>To enable you to assign VLANs to Isolated networks,</para>
- <orderedlist>
- <listitem>
- <para>Create a network offering by specifying the following:</para>
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Guest Type</emphasis>: Select Isolated.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Specify VLAN</emphasis>: Select the option.</para>
- </listitem>
- </itemizedlist>
- <para condition="install">For more information, see <xref linkend="creating-network-offerings"
- />.</para>
- <para condition="admin">For more information, see the &PRODUCT; Installation Guide.</para>
- </listitem>
- <listitem>
- <para>Using this network offering, create a network.</para>
- <para>You can create a VPC tier or an Isolated network.</para>
- </listitem>
- <listitem>
- <para>Specify the VLAN when you create the network.</para>
- <para>When VLAN is specified, a CIDR and gateway are assigned to this network and the state is
- changed to Setup. In this state, the network will not be garbage collected.</para>
- </listitem>
- </orderedlist>
- <note>
- <para>You cannot change a VLAN once it's assigned to the network. The VLAN remains with the
- network for its entire life cycle.</para>
- </note>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/vlan-provisioning.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vlan-provisioning.xml b/docs/en-US/vlan-provisioning.xml
deleted file mode 100644
index 2d1a49e..0000000
--- a/docs/en-US/vlan-provisioning.xml
+++ /dev/null
@@ -1,46 +0,0 @@
-<?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="vlan-provisioning">
- <title>VLAN Provisioning</title>
- <para>&PRODUCT; automatically creates and destroys interfaces bridged to VLANs on the hosts. In
- general the administrator does not need to manage this process.</para>
- <para>&PRODUCT; manages VLANs differently based on hypervisor type. For XenServer or KVM, the
- VLANs are created on only the hosts where they will be used and then they are destroyed when all
- guests that require them have been terminated or moved to another host.</para>
- <para>For vSphere the VLANs are provisioned on all hosts in the cluster even if there is no guest
- running on a particular Host that requires the VLAN. This allows the administrator to perform
- live migration and other functions in vCenter without having to create the VLAN on the
- destination Host. Additionally, the VLANs are not removed from the Hosts when they are no longer
- needed.</para>
- <para>You can use the same VLANs on different physical networks provided that each physical
- network has its own underlying layer-2 infrastructure, such as switches. For example, you can
- specify VLAN range 500 to 1000 while deploying physical networks A and B in an Advanced zone
- setup. This capability allows you to set up an additional layer-2 physical infrastructure on a
- different physical NIC and use the same set of VLANs if you run out of VLANs. Another advantage
- is that you can use the same set of IPs for different customers, each one with their own routers
- and the guest networks on different physical NICs.</para>
- <xi:include href="vlan-allocation-eg.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="non-contiguous-vlan.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="vlan-assign-isolated-nw.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/vm-lifecycle.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vm-lifecycle.xml b/docs/en-US/vm-lifecycle.xml
deleted file mode 100644
index 15d9f7d..0000000
--- a/docs/en-US/vm-lifecycle.xml
+++ /dev/null
@@ -1,43 +0,0 @@
-<?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="vm-lifecycle">
- <title>VM Lifecycle</title>
- <para>Virtual machines can be in the following states:</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/vm-lifecycle.png" />
- </imageobject>
- <textobject><phrase>basic-deployment.png: Basic two-machine &PRODUCT; deployment</phrase></textobject>
- </mediaobject>
- <para>Once a virtual machine is destroyed, it cannot be recovered. All the resources used by the virtual machine will be reclaimed by the system. This includes the virtual machine’s IP address.</para>
- <para>A stop will attempt to gracefully shut down the operating system, which typically involves terminating all the running applications. If the operation system cannot be stopped, it will be forcefully terminated. This has the same effect as pulling the power cord to a physical machine.</para>
- <para>A reboot is a stop followed by a start.</para>
- <para>&PRODUCT; preserves the state of the virtual machine hard disk until the machine is destroyed.</para>
- <para>A running virtual machine may fail because of hardware or network issues. A failed virtual machine is in the down state.</para>
- <para>The system places the virtual machine into the down state if it does not receive the heartbeat from the hypervisor for three minutes.</para>
- <para>The user can manually restart the virtual machine from the down state.</para>
- <para>The system will start the virtual machine from the down state automatically if the virtual machine is marked as HA-enabled.</para>
-</section>
-
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/vm-snapshots.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vm-snapshots.xml b/docs/en-US/vm-snapshots.xml
deleted file mode 100644
index 3e72fe4..0000000
--- a/docs/en-US/vm-snapshots.xml
+++ /dev/null
@@ -1,148 +0,0 @@
-<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter 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="vm-snapshots">
- <title>Virtual Machine Snapshots for VMware</title>
- <para>(VMware hosts only)
- In addition to the existing &PRODUCT; ability to snapshot individual VM volumes,
- you can now take a VM snapshot to preserve all the VM's data volumes as well as (optionally) its CPU/memory state.
- This is useful for quick restore of a VM.
- For example, you can snapshot a VM, then make changes such as software upgrades.
- If anything goes wrong, simply restore the VM to its previous state using the previously saved VM snapshot.
- </para>
- <para>The snapshot is created using the VMware native snapshot facility. The VM snapshot
- includes not only the data volumes, but optionally also whether the VM is running or
- turned off (CPU state) and the memory contents. The snapshot is stored in &PRODUCT;'s
- primary storage.</para>
- <para>VM snapshots can have a parent/child relationship.
- Each successive snapshot of the same VM is the child of the snapshot that came before it.
- Each time you take an additional snapshot of the same VM, it saves only the differences
- between the current state of the VM and the state stored in the most recent previous snapshot.
- The previous snapshot becomes a parent, and the new snapshot is its child.
- It is possible to create a long chain of these parent/child snapshots,
- which amount to a "redo" record leading from the current state of the VM back to the
- original.</para>
- <para>If you need more information about VM snapshots, check out the VMware documentation
- and the VMware Knowledge Base, especially
- <ulink url="http://kb.vmware.com/selfservice/microsites/search.do?cmd=displayKC&externalId=1015180">Understanding virtual machine snapshots</ulink>.</para>
- <section id="vm-snapshot-restrictions">
- <title>Limitations on VM Snapshots</title>
- <itemizedlist>
- <listitem><para>If a VM has some stored snapshots, you can't attach new volume to the VM
- or delete any existing volumes.
- If you change the volumes on the VM, it would become impossible to restore the VM snapshot
- which was created with the previous volume structure.
- If you want to attach a volume to such a VM, first delete its snapshots.
- </para></listitem>
- <listitem><para>VM snapshots which include both data volumes and memory can't be kept if you change the VM's
- service offering. Any existing VM snapshots of this type will be discarded.</para></listitem>
- <listitem>
- <para>You can't make a VM snapshot at the same time as you are taking a volume
- snapshot.</para>
- </listitem>
- <listitem>
- <para>The "quiesce" option is not supported. This option is provided by the underlying
- VMware snapshot facility so that you can choose whether to quiesce the file system
- on a running virtual machine before taking the snapshot. In &PRODUCT;, the quiesce option is always
- set to false; the file system is not quiesced before taking a snapshot of a running VM.
- </para>
- </listitem>
- <listitem><para>You should use only &PRODUCT; to create VM snapshots on VMware hosts managed by &PRODUCT;.
- Any snapshots that you make directly on vSphere will not be tracked in &PRODUCT;.</para></listitem>
- </itemizedlist>
- </section>
- <section id="vm-snapshot-configure">
- <title>Configuring VM Snapshots</title>
- <para>The cloud administrator can use global configuration variables to control the behavior of VM snapshots.
- To set these variables, go through the Global Settings area of the &PRODUCT; UI.</para>
- <informaltable>
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <thead>
- <row>
- <entry><para>Configuration Setting Name</para></entry>
- <entry><para>Description</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>vmsnapshots.max</para></entry>
- <entry><para>The maximum number of VM snapshots that can be saved for any given virtual machine in the cloud.
- The total possible number of VM snapshots in the cloud is (number of VMs) * vmsnapshots.max.
- If the number of snapshots for any VM ever hits the maximum, the older ones are removed
- by the snapshot expunge job.
- </para></entry>
- </row>
- <row>
- <entry><para>vmsnapshot.create.wait</para></entry>
- <entry><para>Number of seconds to wait for a snapshot job to succeed before declaring failure and issuing an error.</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
- <section id="vm-snapshot-usage">
- <title>Using VM Snapshots</title>
- <para>To create a VM snapshot using the &PRODUCT; UI:</para>
- <orderedlist>
- <listitem><para>Log in to the &PRODUCT; UI as a user or administrator.</para></listitem>
- <listitem><para>Click Instances.</para></listitem>
- <listitem><para>Click the name of the VM you want to snapshot.</para></listitem>
- <listitem><para>Click the Take VM Snapshot button.
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="./images/VMSnapshotButton.png" format="PNG"/>
- </imageobject>
- </inlinemediaobject></para>
- <note><para>If a snapshot is already in progress, then clicking this button will have no effect.</para></note><para/>
- </listitem>
- <listitem><para>Provide a name and description. These will be displayed in the VM Snapshots list.</para></listitem>
- <listitem><para>(For running VMs only) If you want to include the VM's memory in the snapshot, click the
- Memory checkbox. This saves the CPU and memory state of the virtual machine. If you
- don't check this box, then only the current state of the VM disk is saved. Checking
- this box makes the snapshot take longer.</para></listitem>
- <listitem><para>Click OK.</para></listitem>
- </orderedlist>
- <para>To delete a snapshot or restore a VM to the state saved in a particular snapshot:</para>
- <orderedlist>
- <listitem><para>Navigate to the VM as described in the earlier steps.</para></listitem>
- <listitem><para>Click View VM Snapshots.</para></listitem>
- <listitem><para>In the list of snapshots, click the name of the snapshot you want to work with.</para></listitem>
- <listitem><para>Depending on what you want to do:</para>
- <para>To delete the snapshot, click the Delete button.
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="./images/delete-button.png" format="PNG"/>
- </imageobject>
- </inlinemediaobject></para>
- <para>To revert to the snapshot, click the Revert button.
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="./images/revert-vm.png" format="PNG"/>
- </imageobject>
- </inlinemediaobject></para>
- </listitem>
- </orderedlist>
- <note><para>VM snapshots are deleted automatically when a VM is destroyed.
- You don't have to manually delete the snapshots in this case.</para></note>
- </section>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/vm-storage-migration.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vm-storage-migration.xml b/docs/en-US/vm-storage-migration.xml
deleted file mode 100644
index 51c6f34..0000000
--- a/docs/en-US/vm-storage-migration.xml
+++ /dev/null
@@ -1,48 +0,0 @@
-<?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="vm-storage-migration">
- <title>VM Storage Migration</title>
- <para>Supported in XenServer, KVM, and VMware.</para>
- <note><para>This procedure is different from moving disk volumes from one VM to another as described in
- <xref linkend="detach-move-volumes"/>.</para></note>
- <para/>
- <para>You can migrate a virtual machine’s root disk volume or any additional data disk volume from one storage pool to another in the same zone.</para>
- <para>You can use the storage migration feature to achieve some commonly desired administration goals, such as balancing the load on storage pools and increasing the reliability of virtual machines by moving them away from any storage pool that is experiencing issues.</para>
- <para>On XenServer and VMware, live migration of VM storage is enabled through &PRODUCT;
- support for XenMotion and vMotion.
- Live storage migration allows VMs to be moved from one host to another, where the VMs are
- not located on storage shared between the two hosts. It provides the option to live
- migrate a VM’s disks along with the VM itself. It is possible to migrate a VM from one
- XenServer resource pool / VMware cluster to another, or to migrate a VM whose disks are on
- local storage, or even to migrate a VM’s disks from one storage repository to another, all
- while the VM is running.</para>
- <note><para>Because of a limitation in VMware, live migration of storage for a VM is allowed only
- if the source and target storage pool are accessible to the source host; that is, the host
- where the VM is running when the live migration operation is requested.</para></note>
- <para/>
- <xi:include href="migrate-datadisk-volume-new-storage-pool.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="migrate-vm-rootvolume-volume-new-storage-pool.xml"
- xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</section>
http://git-wip-us.apache.org/repos/asf/cloudstack/blob/78517ee5/docs/en-US/vmware-cluster-config-dvswitch.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vmware-cluster-config-dvswitch.xml b/docs/en-US/vmware-cluster-config-dvswitch.xml
deleted file mode 100644
index 2aeea2a..0000000
--- a/docs/en-US/vmware-cluster-config-dvswitch.xml
+++ /dev/null
@@ -1,283 +0,0 @@
-<?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="vmware-cluster-config-dvswitch">
- <title>Configuring a VMware Datacenter with VMware Distributed Virtual Switch</title>
- <para>&PRODUCT; supports VMware vNetwork Distributed Switch (VDS) for virtual network
- configuration in a VMware vSphere environment. This section helps you configure VMware VDS in a
- &PRODUCT; deployment. Each vCenter server instance can support up to 128 VDS instances and each
- VDS instance can manage up to 500 VMware hosts.</para>
- <section id="about-dvswitch">
- <title>About VMware Distributed Virtual Switch</title>
- <para>VMware VDS is an aggregation of host-level virtual switches on a VMware vCenter server.
- VDS abstracts the configuration of individual virtual switches that span across a large number
- of hosts, and enables centralized provisioning, administration, and monitoring for your entire
- datacenter from a centralized interface. In effect, a VDS acts as a single virtual switch at
- the datacenter level and manages networking for a number of hosts in a datacenter from a
- centralized VMware vCenter server. Each VDS maintains network runtime state for VMs as they
- move across multiple hosts, enabling inline monitoring and centralized firewall services. A
- VDS can be deployed with or without Virtual Standard Switch and a Nexus 1000V virtual
- switch.</para>
- </section>
- <section id="prereq-dvswitch">
- <title>Prerequisites and Guidelines</title>
- <itemizedlist>
- <listitem>
- <para>VMware VDS is supported only on Public and Guest traffic in &PRODUCT;.</para>
- </listitem>
- <listitem>
- <para>VMware VDS does not support multiple VDS per traffic type. If a user has many VDS
- switches, only one can be used for Guest traffic and another one for Public
- traffic.</para>
- </listitem>
- <listitem>
- <para>Additional switches of any type can be added for each cluster in the same zone. While
- adding the clusters with different switch type, traffic labels is overridden at the
- cluster level.</para>
- </listitem>
- <listitem>
- <para>Management and Storage network does not support VDS. Therefore, use Standard Switch
- for these networks.</para>
- </listitem>
- <listitem>
- <para>When you remove a guest network, the corresponding dvportgroup will not be removed on
- the vCenter. You must manually delete them on the vCenter.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section id="preconfig-checklist-vds">
- <title>Preparation Checklist</title>
- <para>For a smoother configuration of VMware VDS, note down the VDS name you have added in the
- datacenter before you start:</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/vds-name.png"/>
- </imageobject>
- <textobject>
- <phrase>vds-name.png: Name of the dvSwitch as specified in the vCenter.</phrase>
- </textobject>
- </mediaobject>
- <para>Use this VDS name in the following:</para>
- <itemizedlist>
- <listitem>
- <para>The switch name in the Edit traffic label dialog while configuring a public and guest
- traffic during zone creation.</para>
- <para>During a zone creation, ensure that you select VMware vNetwork Distributed Virtual Switch
- when you configure guest and public traffic type.</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/traffic-type.png"/>
- </imageobject>
- <textobject>
- <phrase>traffic-type.png: virtual switch type</phrase>
- </textobject>
- </mediaobject>
- </listitem>
- <listitem>
- <para>The Public Traffic vSwitch Type field when you add a VMware VDS-enabled cluster. </para>
- </listitem>
- <listitem>
- <para>The switch name in the traffic label while updating the switch type in a zone.</para>
- </listitem>
- </itemizedlist>
- <para>Traffic label format in the last case is [["Name of
- vSwitch/dvSwitch/EthernetPortProfile"][,"VLAN ID"[,"vSwitch Type"]]]</para>
- <para>The possible values for traffic labels are:</para>
- <itemizedlist>
- <listitem>
- <para>empty string</para>
- </listitem>
- <listitem>
- <para>dvSwitch0</para>
- </listitem>
- <listitem>
- <para> dvSwitch0,200</para>
- </listitem>
- <listitem>
- <para>dvSwitch1,300,vmwaredvs</para>
- </listitem>
- <listitem>
- <para>myEthernetPortProfile,,nexusdvs</para>
- </listitem>
- <listitem>
- <para>dvSwitch0,,vmwaredvs</para>
- </listitem>
- </itemizedlist>
- <informaltable frame="all">
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1"/>
- <colspec colname="c2"/>
- <colspec colname="c3"/>
- <thead>
- <row>
- <entry><para>Fields</para></entry>
- <entry><para>Name</para></entry>
- <entry><para>Description</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>1</para></entry>
- <entry><para>Represents the name of the virtual / distributed virtual switch at
- vCenter.</para></entry>
- <entry><para>The default value depends on the type of virtual switch:</para>
- <para><emphasis role="bold">vSwitch0</emphasis>: If type of virtual switch is VMware
- vNetwork Standard virtual switch </para>
- <para><emphasis role="bold">dvSwitch0</emphasis>: If type of virtual switch is VMware
- vNetwork Distributed virtual switch</para>
- <para><emphasis role="bold">epp0</emphasis>: If type of virtual switch is Cisco Nexus
- 1000v Distributed virtual switch</para></entry>
- </row>
- <row>
- <entry><para>2</para></entry>
- <entry><para>VLAN ID to be used for this traffic wherever applicable.</para></entry>
- <entry><para>This field would be used for only public traffic as of now. In case of
- guest traffic this field would be ignored and could be left empty for guest traffic.
- By default empty string would be assumed which translates to untagged VLAN for that
- specific traffic type.</para></entry>
- </row>
- <row>
- <entry><para>3</para></entry>
- <entry><para>Type of virtual switch. Specified as string.</para></entry>
- <entry><para>Possible valid values are vmwaredvs, vmwaresvs, nexusdvs. </para>
- <para><emphasis role="bold">vmwaresvs</emphasis>: Represents VMware vNetwork Standard
- virtual switch</para>
- <para><emphasis role="bold">vmwaredvs</emphasis>: Represents VMware vNetwork
- distributed virtual switch</para>
- <para><emphasis role="bold">nexusdvs</emphasis>: Represents Cisco Nexus 1000v
- distributed virtual switch.</para>
- <para>If nothing specified (left empty), zone-level default virtual switch would be
- defaulted, based on the value of global parameter you specify. </para>
- <para>Following are the global configuration parameters:</para>
- <para><emphasis role="bold">vmware.use.dvswitch</emphasis>: Set to true to enable any
- kind (VMware DVS and Cisco Nexus 1000v) of distributed virtual switch in a &PRODUCT;
- deployment. If set to false, the virtual switch that can be used in that &PRODUCT;
- deployment is Standard virtual switch. </para>
- <para><emphasis role="bold">vmware.use.nexus.vswitch</emphasis>: This parameter is
- ignored if vmware.use.dvswitch is set to false. Set to true to enable Cisco Nexus
- 1000v distributed virtual switch in a &PRODUCT; deployment.</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
-
- </section>
- <section id="enable-dvswitch">
- <title>Enabling Virtual Distributed Switch in &PRODUCT;</title>
- <para>To make a &PRODUCT; deployment VDS enabled, set the vmware.use.dvswitch parameter to true
- by using the Global Settings page in the &PRODUCT; UI and restart the Management Server.
- Unless you enable the vmware.use.dvswitch parameter, you cannot see any UI options specific to
- VDS, and &PRODUCT; ignores the VDS-specific parameters that you specify. Additionally,
- &PRODUCT; uses VDS for virtual network infrastructure if the value of vmware.use.dvswitch
- parameter is true and the value of vmware.use.nexus.dvswitch parameter is false. Another
- global parameter that defines VDS configuration is vmware.ports.per.dvportgroup. This is the
- default number of ports per VMware dvPortGroup in a VMware environment. Default value is 256.
- This number directly associated with the number of guest network you can create.</para>
- <para>&PRODUCT; supports orchestration of virtual networks in a deployment with a mix of Virtual
- Distributed Switch, Standard Virtual Switch and Nexus 1000v Virtual Switch. </para>
- </section>
- <section id="config-dvswitch">
- <title>Configuring Distributed Virtual Switch in &PRODUCT;</title>
- <para>You can configure VDS by adding the necessary resources while a zone is created.</para>
- <para>Alternatively, at the cluster level, you can create an additional cluster with VDS enabled
- in the existing zone. Use the Add Cluster option. For information as given in <xref
- linkend="add-clusters-vsphere"/>.</para>
- <para>In both these cases, you must specify the following parameters to configure VDS:</para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="./images/dvSwitch-config.png"/>
- </imageobject>
- <textobject>
- <phrase>dvSwitchConfig.png: Configuring dvSwitch</phrase>
- </textobject>
- </mediaobject>
- <informaltable frame="all">
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1"/>
- <colspec colname="c2"/>
- <thead>
- <row>
- <entry><para>Parameters</para></entry>
- <entry><para>Description</para></entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>Cluster Name</para></entry>
- <entry><para>Enter the name of the cluster you created in vCenter. For example,
- "cloudcluster".</para></entry>
- </row>
- <row>
- <entry><para>vCenter Host</para></entry>
- <entry><para>Enter the name or the IP address of the vCenter host where you have
- deployed the VMware VDS.</para></entry>
- </row>
- <row>
- <entry><para>vCenter User name</para></entry>
- <entry><para>Enter the username that &PRODUCT; should use to connect to vCenter. This
- user must have all administrative privileges.</para></entry>
- </row>
- <row>
- <entry><para>vCenter Password</para></entry>
- <entry><para>Enter the password for the user named above.</para></entry>
- </row>
- <row>
- <entry><para>vCenter Datacenter</para></entry>
- <entry><para>Enter the vCenter datacenter that the cluster is in. For example,
- "clouddcVM".</para></entry>
- </row>
- <row>
- <entry><para>Override Public Traffic</para></entry>
- <entry><para>Enable this option to override the zone-wide public traffic for the cluster
- you are creating. </para></entry>
- </row>
- <row>
- <entry><para>Public Traffic vSwitch Type</para></entry>
- <entry><para>This option is displayed only if you enable the Override Public Traffic
- option. Select VMware vNetwork Distributed Virtual Switch. </para>
- <para>If the vmware.use.dvswitch global parameter is true, the default option will be
- VMware vNetwork Distributed Virtual Switch.</para></entry>
- </row>
- <row>
- <entry><para>Public Traffic vSwitch Name</para></entry>
- <entry><para>Name of virtual switch to be used for the public traffic.</para></entry>
- </row>
- <row>
- <entry><para>Override Guest Traffic</para></entry>
- <entry><para>Enable the option to override the zone-wide guest traffic for the cluster
- you are creating.</para></entry>
- </row>
- <row>
- <entry><para>Guest Traffic vSwitch Type</para></entry>
- <entry><para>This option is displayed only if you enable the Override Guest Traffic
- option. Select VMware vNetwork Distributed Virtual Switch. </para>
- <para>If the vmware.use.dvswitch global parameter is true, the default option will be
- VMware vNetwork Distributed Virtual Switch.</para></entry>
- </row>
- <row>
- <entry><para>Guest Traffic vSwitch Name</para></entry>
- <entry><para>Name of virtual switch to be used for guest traffic.</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
-</section>