Updated Branches: refs/heads/4.3 d4e5dca07 -> c6069b1d0
CLOUDSTACK-1001 hyper V documentation draft in progress Project: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/commit/c6069b1d Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/tree/c6069b1d Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-docs/diff/c6069b1d Branch: refs/heads/4.3 Commit: c6069b1d0bb0b286236aacb70e316747249b4e7e Parents: d4e5dca Author: Radhika PC <radhika.puthiyet...@citrix.com> Authored: Thu Jan 16 14:06:06 2014 +0530 Committer: Radhika PC <radhika.puthiyet...@citrix.com> Committed: Thu Jan 16 14:24:20 2014 +0530 ---------------------------------------------------------------------- en-US/hyperv-agent-install.xml | 48 +++++++++++++++ en-US/hyperv-checklist.xml | 113 ++++++++++++++++++++++++++++++++++ en-US/hyperv-host-add.xml | 91 +++++++++++++++++++++++++++ en-US/hyperv-install-network.xml | 29 +++++++++ en-US/hyperv-install-storage.xml | 42 +++++++++++++ en-US/hyperv-install.xml | 36 +++++++++++ en-US/hyperv-requirements.xml | 83 +++++++++++++++++++++++++ en-US/images/add-cifs.png | Bin 0 -> 15692 bytes en-US/images/cifs-primary.png | Bin 0 -> 32016 bytes en-US/images/cifs-ss.png | Bin 0 -> 33303 bytes 10 files changed, 442 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/c6069b1d/en-US/hyperv-agent-install.xml ---------------------------------------------------------------------- diff --git a/en-US/hyperv-agent-install.xml b/en-US/hyperv-agent-install.xml new file mode 100644 index 0000000..5580b90 --- /dev/null +++ b/en-US/hyperv-agent-install.xml @@ -0,0 +1,48 @@ +<?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="hyperv-agent-install"> + <title>Installing the &PRODUCT; Agent on a Hyper-V Host</title> + <para>&PRODUCT; Agent helps &PRODUCT; perform operations on the Hyper-V hosts. Therefore, each + Hyper-V host must have the &PRODUCT; Agent installed on it. &PRODUCT; Agent runs as a Windows + service. This Agent communicates with the Management Server and controls all the instances on + the host. Install the &PRODUCT; Agent on each host using the following steps.</para> + <orderedlist> + <listitem> + <para>Download the CloudStack Agent for Hyper-V from <ulink + url=" + http://repo-ccp.citrix.com/releases/ASF/hyperv/4.3/CloudPlatform-4.3-01-hypervagent.msi"; + >CloudStack Hyper-V Agent</ulink>.</para> + <para>You should have a file in the form of + âCloudPlatform-<version>-N-hypervagent.msiâ.</para> + </listitem> + <listitem> + <para>Run the installer.</para> + </listitem> + <listitem> + <para>Provide the Hyper-V admin credentials when prompted.</para> + <para>When the agent installation is finished, the agent runs as a service on the host + machine.</para> + </listitem> + </orderedlist> +</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/c6069b1d/en-US/hyperv-checklist.xml ---------------------------------------------------------------------- diff --git a/en-US/hyperv-checklist.xml b/en-US/hyperv-checklist.xml new file mode 100644 index 0000000..78545cd --- /dev/null +++ b/en-US/hyperv-checklist.xml @@ -0,0 +1,113 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/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="hyperv-checklist"> + <title>Preparation Checklist for Hyper-V</title> + <para>For a smoother installation, gather the following information before you start:</para> + <informaltable frame="all"> + <tgroup cols="3" align="left" colsep="1" rowsep="1"> + <colspec colname="c1" colwidth="1.22*"/> + <colspec colname="c2" colwidth="1.0*"/> + <colspec colname="c3" colwidth="6.05*"/> + <thead> + <row> + <entry><para>Hyper-V Requirements</para></entry> + <entry><para>Value</para></entry> + <entry><para>Description</para></entry> + </row> + </thead> + <tbody> + <row> + <entry><para>Server Roles</para></entry> + <entry><para>Hyper-V</para></entry> + <entry><para>After the Windows Server 2012 R2 installation, ensure that Hyper-V is selected from Server + Roles. For more information, see <ulink + url="http://technet.microsoft.com/en-us/library/jj134187.aspx#BKMK_Step2";>Installing + Hyper-V</ulink>.</para></entry> + </row> + <row> + <entry><para>Server Roles</para></entry> + <entry><para>File and Storage Services</para></entry> + <entry><para>After the Windows Server 2012 R2 installation, ensure that File and Storage Services is + selected from Server Roles to create an SMB file share. For more information, see + <ulink url="http://technet.microsoft.com/en-us/library/jj134187.aspx#BKMK_Step3"; + >Creating an SMB File Share Using Server Manager</ulink>.</para></entry> + </row> + <row> + <entry><para>Share Location</para></entry> + <entry><para>New folders in the /Share directory</para></entry> + <entry><para>The location of the file share for the Hyper-V deployment will be the new folder created in + the \Shares on the selected volume. You can create sub-folders for both &PRODUCT; + Primary and Secondary storage within the share location.</para> + <para>When you select the profile for the file shares, ensure that you select SMB Share + -Applications. This creates the file shares with settings appropriate for + Hyper-V.</para></entry> + </row> + <row> + <entry><para>Preferred DNS Server</para></entry> + <entry><para>The IP address of the Active Directory domain.</para></entry> + <entry><para>While adding an Hyper-V host to the domain, use the domain IP as the DNS + server.</para></entry> + </row> + <row> + <entry><para>Domain and Hosts</para></entry> + <entry><para/></entry> + <entry><para>Hosts should be part of the Active Directory domain.</para></entry> + </row> + <row> + <entry><para>Hyper-V Users</para></entry> + <entry><para>Full control</para></entry> + <entry><para>Full control on the SMB File share.</para></entry> + </row> + <row> + <entry><para>Virtual Switch</para></entry> + <entry><para/></entry> + <entry><para>If you are using Hyper-V 2012 R2, manually create an external virtual switch + before adding the host to &PRODUCT;. If the Hyper-V host is added to the Hyper-V + manager, select the host, then click Virtual Switch Manager, then New Virtual Switch. + In the External Network, select the desired NIC adapter and click Apply. </para> + <para>If you are using Windows 2012 R2, virtual switch is created + automatically.</para></entry> + </row> + <row> + <entry><para>Virtual Switch Name</para></entry> + <entry><para/></entry> + <entry><para>Take a note of the name of the virtual switch. You need to specify that when + configuring &PRODUCT; physical network labels.</para></entry> + </row> + <row> + <entry><para>Hyper-V Admin User</para></entry> + <entry><para/></entry> + <entry><para>Add the Hyper-V administrator to the Hyper-V Administrators + group.</para></entry> + </row> + <row> + <entry><para>Delegation</para></entry> + <entry><para/></entry> + <entry><para>Enable Delegation to the Microsoft Virtual System Migration + service.</para></entry> + </row> + </tbody> + </tgroup> + </informaltable> +</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/c6069b1d/en-US/hyperv-host-add.xml ---------------------------------------------------------------------- diff --git a/en-US/hyperv-host-add.xml b/en-US/hyperv-host-add.xml new file mode 100644 index 0000000..144c829 --- /dev/null +++ b/en-US/hyperv-host-add.xml @@ -0,0 +1,91 @@ +<?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="hyperv-host-add"> + <title>Adding a Hyper-V Host</title> + <orderedlist> + <listitem> + <para>Before adding a host to the &PRODUCT; configuration, ensure that you install Hyper-V on + the host.</para> + <para/> + <warning> + <para>Be sure you have performed the additional &PRODUCT;-specific configuration steps + described in the Hyper-V installation section.</para> + </warning> + </listitem> + <listitem> + <para>If you have not already done so, install Hyper-V on the host. You will need to know + which version of the hypervisor software version is supported by &PRODUCT; and what + additional configuration is required to ensure the host will work with &PRODUCT;. For more + information, see the Prerequisites section in the Installation Guide.</para> + </listitem> + <listitem> + <para>Log in to the &PRODUCT; UI as administrator.</para> + </listitem> + <listitem> + <para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the + zone in which you want to add the host.</para> + </listitem> + <listitem> + <para>Click the Compute tab. In the Clusters node, click View All.</para> + </listitem> + <listitem> + <para>Click the cluster where you want to add the host.</para> + </listitem> + <listitem> + <para>Click View Hosts.</para> + </listitem> + <listitem> + <para>Click Add Host.</para> + </listitem> + <listitem> + <para>Provide the following information.</para> + <itemizedlist> + <listitem> + <para><emphasis role="bold">Host Name</emphasis>: The DNS name or IP address of the host. + </para> + </listitem> + <listitem> + <para><emphasis role="bold">Username</emphasis>: Usually root. Specify domain name in the + path. For example, domain 1/ admin.</para> + </listitem> + <listitem> + <para><emphasis role="bold">Password</emphasis>: This is the password for the user named + above.</para> + </listitem> + <listitem> + <para><emphasis role="bold">Host Tags</emphasis> (Optional). Any labels that you use to + categorize hosts for ease of maintenance. For example, you can set to the cloud's HA tag + (set in the ha.tag global configuration parameter) if you want this host to be used only + for VMs with the "high availability" feature enabled. For more information, see + HA-Enabled Virtual Machines as well as HA for Hosts.</para> + </listitem> + </itemizedlist> + <para>There may be a slight delay while the host is provisioned. It should automatically + display in the UI. </para> + </listitem> + <listitem> + <para>Repeat for additional hosts. </para> + </listitem> + </orderedlist> +</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/c6069b1d/en-US/hyperv-install-network.xml ---------------------------------------------------------------------- diff --git a/en-US/hyperv-install-network.xml b/en-US/hyperv-install-network.xml new file mode 100644 index 0000000..5387b5d --- /dev/null +++ b/en-US/hyperv-install-network.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 "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="hyperv-install-network"> + <title>Physical Network Configuration for Hyper-V</title> + <para>You should have a plan for how the hosts will be cabled and which physical NICs will carry + what types of traffic. By default, &PRODUCT; will use the device that is used for the default + route.</para> +</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/c6069b1d/en-US/hyperv-install-storage.xml ---------------------------------------------------------------------- diff --git a/en-US/hyperv-install-storage.xml b/en-US/hyperv-install-storage.xml new file mode 100644 index 0000000..391a126 --- /dev/null +++ b/en-US/hyperv-install-storage.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 "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="hyperv-install-storage"> + <title>Storage Preparation for Hyper-V (Optional)</title> + <para>&PRODUCT; allows administrators to set up shared Primary Storage and Secondary Storage that + uses CIFS.</para> + <orderedlist> + <listitem> + <para>Create a CIFS storage and expose it over smb3.</para> + </listitem> + <listitem> + <para>Add the storage to an Active Directory domain.</para> + <para>The CIFS storage and host need not be in the same domain. However, the storage should be + accessible from the Management Server with the domain user privileges. </para> + </listitem> + <listitem> + <para>While adding storage to &PRODUCT;, ensure that the correct domain, and credentials are + supplied. This user should be able to access the storage from the Management Server.</para> + </listitem> + </orderedlist> +</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/c6069b1d/en-US/hyperv-install.xml ---------------------------------------------------------------------- diff --git a/en-US/hyperv-install.xml b/en-US/hyperv-install.xml new file mode 100644 index 0000000..384c026 --- /dev/null +++ b/en-US/hyperv-install.xml @@ -0,0 +1,36 @@ +<?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="hyperv-install"> + <title>Installing Hyper-V for &PRODUCT;</title> + <para>If you want to use Hyper-V hypervisor to run guest virtual machines, install Hyper-V on the + hosts in your cloud. The instructions in this section doesn't duplicate Hyper-V Installation + documentation. It provides the &PRODUCT;-specific steps that are needed to prepare a Hyper-V + host to work with &PRODUCT;.</para> + <xi:include href="hyperv-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="hyperv-checklist.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="hyperv-install-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="hyperv-agent-install.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="hyperv-install-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="hyperv-install-storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> +</chapter> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/c6069b1d/en-US/hyperv-requirements.xml ---------------------------------------------------------------------- diff --git a/en-US/hyperv-requirements.xml b/en-US/hyperv-requirements.xml new file mode 100644 index 0000000..504f2cf --- /dev/null +++ b/en-US/hyperv-requirements.xml @@ -0,0 +1,83 @@ +<?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="hyperv-requirements"> + <title>System Requirements for Hyper-V Hypervisor Hosts</title> + <para/> + <section id="hyperv-supported-os"> + <title>Supported Operating Systems for Hyper-V Hosts</title> + <itemizedlist> + <listitem> + <para>Windows Server 2012 R2 Standard</para> + </listitem> + <listitem> + <para>Windows Server 2012 R2 Datacenter</para> + </listitem> + <listitem> + <para>Hyper-V 2012 R2</para> + </listitem> + </itemizedlist> + </section> + <section id="hyperv-hardware-req"> + <title>Minimum System Requirements for Hyper-V Hosts</title> + <itemizedlist> + <listitem> + <para>1.4 GHz 64-bit processor with hardware-assisted virtualization.</para> + </listitem> + <listitem> + <para>800 MB of RAM</para> + </listitem> + <listitem> + <para>32 GB of disk space</para> + </listitem> + <listitem> + <para>Gigabit (10/100/1000baseT) Ethernet adapter</para> + </listitem> + </itemizedlist> + </section> + <section id="storage"> + <title>Supported Storage</title> + <itemizedlist> + <listitem> + <para>Primary Storage: Server Message Block (SMB) Version 3, Local</para> + </listitem> + <listitem> + <para>Secondary Storage: SMB</para> + </listitem> + </itemizedlist> + </section> + <section id="other-prereq"> + <title>Miscellaneous Prerequisites</title> + <itemizedlist> + <listitem> + <para>Domain-joined hosts. This is needed for Live Migration.</para> + </listitem> + <listitem> + <para>Permissions are given as given in <xref linkend="hyperv-checklist"/>.</para> + </listitem> + <listitem> + <para>Pure Hyper-V zones</para> + </listitem> + </itemizedlist> + </section> +</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/c6069b1d/en-US/images/add-cifs.png ---------------------------------------------------------------------- diff --git a/en-US/images/add-cifs.png b/en-US/images/add-cifs.png new file mode 100644 index 0000000..9081f77 Binary files /dev/null and b/en-US/images/add-cifs.png differ http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/c6069b1d/en-US/images/cifs-primary.png ---------------------------------------------------------------------- diff --git a/en-US/images/cifs-primary.png b/en-US/images/cifs-primary.png new file mode 100644 index 0000000..4189980 Binary files /dev/null and b/en-US/images/cifs-primary.png differ http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/c6069b1d/en-US/images/cifs-ss.png ---------------------------------------------------------------------- diff --git a/en-US/images/cifs-ss.png b/en-US/images/cifs-ss.png new file mode 100644 index 0000000..5098095 Binary files /dev/null and b/en-US/images/cifs-ss.png differ
