http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/using-netscaler-load-balancers.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/using-netscaler-load-balancers.xml b/docs/tmp/en-US/xml/using-netscaler-load-balancers.xml new file mode 100644 index 0000000..c77a139 --- /dev/null +++ b/docs/tmp/en-US/xml/using-netscaler-load-balancers.xml @@ -0,0 +1,122 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="using-netscaler-load-balancers" lang="en-US"> + <!-- 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. + --> <title>About Using a NetScaler Load Balancer</title> + <para> + Citrix NetScaler is supported as an external network element for load balancing in zones that use advanced networking (also called advanced zones). Set up an external load balancer when you want to provide load balancing through means other than &PRODUCT;âs provided virtual router. + </para> + <para> + The NetScaler can be set up in direct (outside the firewall) mode. It must be added before any load balancing rules are deployed on guest VMs in the zone. + </para> + <para> + The functional behavior of the NetScaler with &PRODUCT; is the same as described in the &PRODUCT; documentation for using an F5 external load balancer. The only exception is that the F5 supports routing domains, and NetScaler does not. NetScaler can not yet be used as a firewall. + </para> + <para> + The Citrix NetScaler comes in three varieties. The following table summarizes how these variants are treated in &PRODUCT;. + </para> + <informaltable> + <tgroup align="left" cols="3" colsep="1" rowsep="1"> + <thead> + <row> + <entry> + <para> + NetScaler ADC Type + </para> + </entry> + <entry> + <para> + Description of Capabilities + </para> + </entry> + <entry> + <para> + &PRODUCT; 3.0.3 Supported Features + </para> + </entry> + + </row> + + </thead> + <tbody> + <row> + <entry> + <para> + MPX + </para> + </entry> + <entry> + <para> + Physical appliance. Capable of deep packet inspection. Can act as application firewall and load balancer + </para> + </entry> + <entry> + <para> + In advanced zones, load balancer functionality fully supported without limitation. In basic zones, static NAT, elastic IP (EIP), and elastic load balancing (ELB) are also provided + </para> + </entry> + + </row> + <row> + <entry> + <para> + VPX + </para> + </entry> + <entry> + <para> + Virtual appliance. Can run as VM on XenServer, ESXi, and Hyper-V hypervisors. Same functionality as MPX + </para> + </entry> + <entry> + <para> + Supported only on ESXi. Same functional support as for MPX. &PRODUCT; will treat VPX and MPX as the same device type + </para> + </entry> + + </row> + <row> + <entry> + <para> + SDX + </para> + </entry> + <entry> + <para> + Physical appliance. Can create multiple fully isolated VPX instances on a single appliance to support multi-tenant usage + </para> + </entry> + <entry> + <para> + &PRODUCT; will dynamically provision, configure, and manage the lifecycle of VPX instances on the SDX. Provisioned instances are added into &PRODUCT; automatically â no manual configuration by the administrator is required. Once a VPX instance is added into &PRODUCT;, it is treated the same as a VPX on an ESXi host. + </para> + </entry> + + </row> + + </tbody> + + </tgroup> + + </informaltable> +</section> + +
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/using-sshkeys.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/using-sshkeys.xml b/docs/tmp/en-US/xml/using-sshkeys.xml new file mode 100644 index 0000000..c54d5e3 --- /dev/null +++ b/docs/tmp/en-US/xml/using-sshkeys.xml @@ -0,0 +1,193 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="using-sshkeys" lang="en-US"> + <!-- 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. + --> <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 numbet>/?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> + + http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/using-swift-for-secondary-storage.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/using-swift-for-secondary-storage.xml b/docs/tmp/en-US/xml/using-swift-for-secondary-storage.xml new file mode 100644 index 0000000..40e2d2b --- /dev/null +++ b/docs/tmp/en-US/xml/using-swift-for-secondary-storage.xml @@ -0,0 +1,32 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="using-swift-for-secondary-storage" lang="en-US"> + <!-- 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. + --> <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/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/using-vpn-with-mac.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/using-vpn-with-mac.xml b/docs/tmp/en-US/xml/using-vpn-with-mac.xml new file mode 100644 index 0000000..718a0c4 --- /dev/null +++ b/docs/tmp/en-US/xml/using-vpn-with-mac.xml @@ -0,0 +1,29 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="using-vpn-with-mac" lang="en-US"> + <!-- 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. + --> <title>Using VPN with Mac OS X</title> + <para> + In Mac OS X, in Network Preferences - Advanced, make sure Send all traffic over VPN connection is not checked. + </para> +</section> + + http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/using-vpn-with-windows.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/using-vpn-with-windows.xml b/docs/tmp/en-US/xml/using-vpn-with-windows.xml new file mode 100644 index 0000000..4aee0fd --- /dev/null +++ b/docs/tmp/en-US/xml/using-vpn-with-windows.xml @@ -0,0 +1,92 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="using-vpn-with-windows" lang="en-US"> + <!-- 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. + --> <title>Using 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> + <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 1 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 1. + </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 1. + </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 1. + </para> + </listitem> + + </orderedlist> +</section> + + http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/vcenter-maintenance-mode.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/vcenter-maintenance-mode.xml b/docs/tmp/en-US/xml/vcenter-maintenance-mode.xml new file mode 100644 index 0000000..80ca3ff --- /dev/null +++ b/docs/tmp/en-US/xml/vcenter-maintenance-mode.xml @@ -0,0 +1,74 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="vcenter-maintenance-mode" lang="en-US"> + <!-- 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. + --> <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 are migrated back to it and new VMs can be added. + </para> + </listitem> + + </orderedlist> + </listitem> + + </orderedlist> +</section> + + http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/verifying-source.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/verifying-source.xml b/docs/tmp/en-US/xml/verifying-source.xml new file mode 100644 index 0000000..832cdec --- /dev/null +++ b/docs/tmp/en-US/xml/verifying-source.xml @@ -0,0 +1,81 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="sect-source-verify" lang="en-US"> + <!-- 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. + --> <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/dev/incubator/cloudstack/KEYS";>KEYS</ulink> file. + </para> + <para> + You next need to import those keys, which you can do by running the following command: +<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.1-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, the &PRODUCT; provides a number of cryptographic hashes to aid in assurance of validity of the downloaded release. You can verify this hash by executing the following command: +<programlisting><prompt>$</prompt> <command>gpg</command> --print-md MD5 apache-cloudstack-4.0.1-incubating-src.tar.bz2 | <command>diff</command> - apache-cloudstack-4.0.1-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.1-incubating-src.tar.bz2 | <command>diff</command> - apache-cloudstack-4.0.1-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/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/virtual-machine-usage-record-format.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/virtual-machine-usage-record-format.xml b/docs/tmp/en-US/xml/virtual-machine-usage-record-format.xml new file mode 100644 index 0000000..bffbd29 --- /dev/null +++ b/docs/tmp/en-US/xml/virtual-machine-usage-record-format.xml @@ -0,0 +1,107 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="virtual-machine-usage-record-format" lang="en-US"> + <!-- 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. + --> <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/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/virtual-machines.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/virtual-machines.xml b/docs/tmp/en-US/xml/virtual-machines.xml new file mode 100644 index 0000000..3b2641a --- /dev/null +++ b/docs/tmp/en-US/xml/virtual-machines.xml @@ -0,0 +1,34 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<chapter id="virtual-machines" lang="en-US"> + <!-- 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. + --> <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="changing-vm-name-os-group.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"; /> + <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/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/virtual-router.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/virtual-router.xml b/docs/tmp/en-US/xml/virtual-router.xml new file mode 100644 index 0000000..4e885ca --- /dev/null +++ b/docs/tmp/en-US/xml/virtual-router.xml @@ -0,0 +1,32 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="virtual-router" lang="en-US"> + <!-- 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. + --> <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> +</section> + + http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/vlan-allocation-eg.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/vlan-allocation-eg.xml b/docs/tmp/en-US/xml/vlan-allocation-eg.xml new file mode 100644 index 0000000..2d50a7d --- /dev/null +++ b/docs/tmp/en-US/xml/vlan-allocation-eg.xml @@ -0,0 +1,162 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="vlan-allocation-eg" lang="en-US"> + <!-- 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. + --> <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 align="left" cols="3" 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/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/vlan-provisioning.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/vlan-provisioning.xml b/docs/tmp/en-US/xml/vlan-provisioning.xml new file mode 100644 index 0000000..bdb2396 --- /dev/null +++ b/docs/tmp/en-US/xml/vlan-provisioning.xml @@ -0,0 +1,35 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="vlan-provisioning" lang="en-US"> + <!-- 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. + --> <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> +</section> + + http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/vm-lifecycle.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/vm-lifecycle.xml b/docs/tmp/en-US/xml/vm-lifecycle.xml new file mode 100644 index 0000000..0078628 --- /dev/null +++ b/docs/tmp/en-US/xml/vm-lifecycle.xml @@ -0,0 +1,62 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="vm-lifecycle" lang="en-US"> + <!-- 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. + --> <title>VM Lifecycle</title> + <para> + Virtual machines can be in the following states: + </para> + <mediaobject> + <imageobject> + <imagedata fileref="./images/basic-deployment.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/incubator-cloudstack/blob/92d4b214/docs/tmp/en-US/xml/vm-storage-migration.xml ---------------------------------------------------------------------- diff --git a/docs/tmp/en-US/xml/vm-storage-migration.xml b/docs/tmp/en-US/xml/vm-storage-migration.xml new file mode 100644 index 0000000..b4c372b --- /dev/null +++ b/docs/tmp/en-US/xml/vm-storage-migration.xml @@ -0,0 +1,42 @@ +<?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 "Installation_Guide.ent"> +%BOOK_ENTITIES; +]> +<section id="vm-storage-migration" lang="en-US"> + <!-- 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. + --> <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. See Detaching and Moving Volumes <xref linkend="detach-move-volumes" />. + </para> + </note> + <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> + <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> + +
