http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/vm-snapshots.xml ---------------------------------------------------------------------- diff --git a/en-US/vm-snapshots.xml b/en-US/vm-snapshots.xml deleted file mode 100644 index 07cb5b5..0000000 --- a/en-US/vm-snapshots.xml +++ /dev/null @@ -1,178 +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-snapshots"> - <title>Virtual Machine Snapshots</title> - <para>(Supported on VMware and XenServer)</para> - <para>In addition to the existing &PRODUCT; ability to snapshot individual VM - volumes, you can 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 hypervisor's 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 on VMware, 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>You should use only &PRODUCT; to create VM snapshots on hosts managed by - &PRODUCT;. Any snapshots that you make directly on the hypervisor 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/SnapshotButton.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>Quiesce VM: check this box if you want to quiesce the file system on the VM - before taking the snapshot. Not supported on XenServer when used with &PRODUCT;-provided primary storage.</para> - <para>When this option is used with &PRODUCT;-provided primary storage, - the quiesce operation is performed by the underlying hypervisor (VMware is supported). - When used with another primary storage vendor's plugin, the quiesce operation is provided according - to the vendor's implementation. - </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> - <para/> - </section> -</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/vm-storage-migration.xml ---------------------------------------------------------------------- diff --git a/en-US/vm-storage-migration.xml b/en-US/vm-storage-migration.xml deleted file mode 100644 index 51c6f34..0000000 --- a/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-docs/blob/f42520a5/en-US/vmware-cluster-config-dvswitch.xml ---------------------------------------------------------------------- diff --git a/en-US/vmware-cluster-config-dvswitch.xml b/en-US/vmware-cluster-config-dvswitch.xml deleted file mode 100644 index 2aeea2a..0000000 --- a/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> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/vmware-install.xml ---------------------------------------------------------------------- diff --git a/en-US/vmware-install.xml b/en-US/vmware-install.xml deleted file mode 100644 index 282cf2e..0000000 --- a/en-US/vmware-install.xml +++ /dev/null @@ -1,928 +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="vmware-install"> - <title>VMware vSphere Installation and Configuration</title> - <para>If you want to use the VMware vSphere hypervisor to run guest virtual machines, install - vSphere on the host(s) in your cloud.</para> - <xi:include href="vmware-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <section id="vmware-preparation-checklist"> - <title>Preparation Checklist for VMware</title> - <para>For a smoother installation, gather the following information before you start:</para> - <itemizedlist> - <listitem> - <para>Information listed in <xref linkend="vmware-vcenter-checklist"/></para> - </listitem> - <listitem> - <para>Information listed in <xref linkend="vmware-network-checklist"/></para> - </listitem> - </itemizedlist> - <section id="vmware-vcenter-checklist"> - <title>vCenter Checklist</title> - <para>You will need the following information about vCenter.</para> - <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>vCenter Requirement</para></entry> - <entry><para>Value</para></entry> - <entry><para>Notes</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>vCenter User</para></entry> - <entry><para/></entry> - <entry><para>This user must have admin privileges.</para></entry> - </row> - <row> - <entry><para>vCenter User Password</para></entry> - <entry><para/></entry> - <entry><para>Password for the above user.</para></entry> - </row> - <row> - <entry><para>vCenter Datacenter Name</para></entry> - <entry><para/></entry> - <entry><para>Name of the datacenter.</para></entry> - </row> - <row> - <entry><para>vCenter Cluster Name</para></entry> - <entry><para/></entry> - <entry><para>Name of the cluster.</para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </section> - <section id="vmware-network-checklist"> - <title>Networking Checklist for VMware</title> - <para>You will need the following information about VLAN.</para> - <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>VLAN Information</para></entry> - <entry><para>Value</para></entry> - <entry><para>Notes</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>ESXi VLAN</para></entry> - <entry><para/></entry> - <entry><para>VLAN on which all your ESXi hypervisors reside.</para></entry> - </row> - <row> - <entry><para>ESXI VLAN IP Address</para></entry> - <entry><para/></entry> - <entry><para>IP Address Range in the ESXi VLAN. One address per Virtual Router is used - from this range.</para></entry> - </row> - <row> - <entry><para>ESXi VLAN IP Gateway</para></entry> - <entry><para/></entry> - <entry><para/></entry> - </row> - <row> - <entry><para>ESXi VLAN Netmask</para></entry> - <entry><para/></entry> - <entry><para/></entry> - </row> - <row> - <entry><para>Management Server VLAN</para></entry> - <entry><para/></entry> - <entry><para>VLAN on which the &PRODUCT; Management server is - installed.</para></entry> - </row> - <row> - <entry><para>Public VLAN</para></entry> - <entry><para/></entry> - <entry><para>VLAN for the Public Network.</para></entry> - </row> - <row> - <entry><para>Public VLAN Gateway</para></entry> - <entry><para/></entry> - <entry><para/></entry> - </row> - <row> - <entry><para>Public VLAN Netmask</para></entry> - <entry><para/></entry> - <entry><para/></entry> - </row> - <row> - <entry><para>Public VLAN IP Address Range</para></entry> - <entry><para/></entry> - <entry><para>Range of Public IP Addresses available for &PRODUCT; use. These addresses - will be used for virtual router on &PRODUCT; to route private traffic to external - networks.</para></entry> - </row> - <row> - <entry><para>VLAN Range for Customer use</para></entry> - <entry><para/></entry> - <entry><para>A contiguous range of non-routable VLANs. One VLAN will be assigned for - each customer.</para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </section> - </section> - <section id="vmware-vsphere-installation-steps"> - <title>vSphere Installation Steps</title> - <orderedlist> - <listitem> - <para>If you haven't already, you'll need to download and purchase vSphere from the VMware - Website (<ulink url="https://www.vmware.com/tryvmware/index.php?p=vmware-vsphere&lp=1"; - >https://www.vmware.com/tryvmware/index.php?p=vmware-vsphere&lp=1</ulink>) and - install it by following the VMware vSphere Installation Guide.</para> - </listitem> - <listitem> - <para>Following installation, perform the following configuration, which are described in - the next few sections:</para> - <informaltable frame="all"> - <tgroup cols="2" align="left" colsep="1" rowsep="1"> - <colspec colname="c1"/> - <colspec colname="c2"/> - <thead> - <row> - <entry><para>Required</para></entry> - <entry><para>Optional</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>ESXi host setup</para></entry> - <entry><para>NIC bonding</para></entry> - </row> - <row> - <entry><para>Configure host physical networking, virtual switch, vCenter Management - Network, and extended port range</para></entry> - <entry><para>Multipath storage</para></entry> - </row> - <row> - <entry><para>Prepare storage for iSCSI</para></entry> - <entry><para/></entry> - </row> - <row> - <entry><para>Configure clusters in vCenter and add hosts to them, or add hosts - without clusters to vCenter</para></entry> - <entry><para/></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </listitem> - </orderedlist> - </section> - <section id="vmware-esxi-host-setup"> - <title>ESXi Host setup</title> - <para>All ESXi hosts should enable CPU hardware virtualization support in BIOS. Please note - hardware virtualization support is not enabled by default on most servers.</para> - </section> - <section id="vmware-physical-host-networking"> - <title>Physical Host Networking</title> - <para>You should have a plan for cabling the vSphere hosts. Proper network configuration is - required before adding a vSphere host to &PRODUCT;. To configure an ESXi host, you can use - vClient to add it as standalone host to vCenter first. Once you see the host appearing in the - vCenter inventory tree, click the host node in the inventory tree, and navigate to the - Configuration tab.</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vmware-physical-network.png"/> - </imageobject> - <textobject> - <phrase>vsphereclient.png: vSphere client</phrase> - </textobject> - </mediaobject> - <para>In the host configuration tab, click the "Hardware/Networking" link to bring up - the networking configuration page as above.</para> - <section id="vmware-physical-host-networking-config-vswitch"> - <title>Configure Virtual Switch</title> - <para>A default virtual switch vSwitch0 is created. &PRODUCT; requires all ESXi hosts in the - cloud to use the same set of virtual switch names. If you change the default virtual switch - name, you will need to configure one or more &PRODUCT; configuration variables as - well.</para> - <section id="vmware-physical-host-networking-config-vswitch-separate-traffic"> - <title>Separating Traffic</title> - <para>&PRODUCT; allows you to use vCenter to configure three separate networks per ESXi - host. These networks are identified by the name of the vSwitch they are connected to. The - allowed networks for configuration are public (for traffic to/from the public internet), - guest (for guest-guest traffic), and private (for management and usually storage traffic). - You can use the default virtual switch for all three, or create one or two other vSwitches - for those traffic types.</para> - <para>If you want to separate traffic in this way you should first create and configure - vSwitches in vCenter according to the vCenter instructions. Take note of the vSwitch names - you have used for each traffic type. You will configure &PRODUCT; to use these - vSwitches.</para> - </section> - <section id="vmware-physical-host-networking-config-vswitch-increasing-port"> - <title>Increasing Ports</title> - <para>By default a virtual switch on ESXi hosts is created with 56 ports. We recommend - setting it to 4088, the maximum number of ports allowed. To do that, click the - "Properties..." link for virtual switch (note this is not the Properties link - for Networking).</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vmware-increase-ports.png"/> - </imageobject> - <textobject> - <phrase>vsphereclient.png: vSphere client</phrase> - </textobject> - </mediaobject> - <para>In vSwitch properties dialog, select the vSwitch and click Edit. You should see the - following dialog:</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vmware-vswitch-properties.png"/> - </imageobject> - <textobject> - <phrase>vsphereclient.png: vSphere client</phrase> - </textobject> - </mediaobject> - <para>In this dialog, you can change the number of switch ports. After you've done - that, ESXi hosts are required to reboot in order for the setting to take effect.</para> - </section> - </section> - <section id="vmware-physical-host-networking-config-vcenter-mgt"> - <title>Configure vCenter Management Network</title> - <para>In the vSwitch properties dialog box, you may see a vCenter management network. This - same network will also be used as the &PRODUCT; management network. &PRODUCT; requires the - vCenter management network to be configured properly. Select the management network item in - the dialog, then click Edit.</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vmware-mgt-network-properties.png"/> - </imageobject> - <textobject> - <phrase>vsphereclient.png: vSphere client</phrase> - </textobject> - </mediaobject> - <para>Make sure the following values are set:</para> - <itemizedlist> - <listitem> - <para>VLAN ID set to the desired ID</para> - </listitem> - <listitem> - <para>vMotion enabled.</para> - </listitem> - <listitem> - <para>Management traffic enabled.</para> - </listitem> - </itemizedlist> - <para>If the ESXi hosts have multiple VMKernel ports, and ESXi is not using the default value - "Management Network" as the management network name, you must follow these - guidelines to configure the management network port group so that &PRODUCT; can find - it:</para> - <itemizedlist> - <listitem> - <para>Use one label for the management network port across all ESXi hosts.</para> - </listitem> - <listitem> - <para>In the &PRODUCT; UI, go to Configuration - Global Settings and set - vmware.management.portgroup to the management network label from the ESXi hosts.</para> - </listitem> - </itemizedlist> - </section> - <section id="vmware-physical-networking-extend-port-console-proxy"> - <title>Extend Port Range for &PRODUCT; Console Proxy</title> - <para>(Applies only to VMware vSphere version 4.x)</para> - <para>You need to extend the range of firewall ports that the console proxy works with on the - hosts. This is to enable the console proxy to work with VMware-based VMs. The default - additional port range is 59000-60000. To extend the port range, log in to the VMware ESX - service console on each host and run the following commands:</para> - <programlisting> -esxcfg-firewall -o 59000-60000,tcp,in,vncextras -esxcfg-firewall -o 59000-60000,tcp,out,vncextras - </programlisting> - </section> - <section id="vmware-physical-networking-config-vsphere-nic-bond"> - <title>Configure NIC Bonding for vSphere</title> - <para>NIC bonding on vSphere hosts may be done according to the vSphere installation - guide.</para> - </section> - </section> - <section id="vmware-vsphere-cluster-config-nexus-vswitch"> - <title>Configuring a vSphere Cluster with Nexus 1000v Virtual Switch</title> - <para>&PRODUCT; supports Cisco Nexus 1000v dvSwitch (Distributed Virtual Switch) for virtual - network configuration in a VMware vSphere environment. This section helps you configure a - vSphere cluster with Nexus 1000v virtual switch in a VMware vCenter environment. For - information on creating a vSphere cluster, see <xref linkend="vmware-install"/></para> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-about"> - <title>About Cisco Nexus 1000v Distributed Virtual Switch</title> - <para>The Cisco Nexus 1000V virtual switch is a software-based virtual machine access switch - for VMware vSphere environments. It can span multiple hosts running VMware ESXi 4.0 and - later. A Nexus virtual switch consists of two components: the Virtual Supervisor Module - (VSM) and the Virtual Ethernet Module (VEM). The VSM is a virtual appliance that acts as the - switch's supervisor. It controls multiple VEMs as a single network device. The VSM is - installed independent of the VEM and is deployed in redundancy mode as pairs or as a - standalone appliance. The VEM is installed on each VMware ESXi server to provide - packet-forwarding capability. It provides each virtual machine with dedicated switch ports. - This VSM-VEM architecture is analogous to a physical Cisco switch's supervisor - (standalone or configured in high-availability mode) and multiple linecards - architecture.</para> - <para>Nexus 1000v switch uses vEthernet port profiles to simplify network provisioning for - virtual machines. There are two types of port profiles: Ethernet port profile and vEthernet - port profile. The Ethernet port profile is applied to the physical uplink ports-the NIC - ports of the physical NIC adapter on an ESXi server. The vEthernet port profile is - associated with the virtual NIC (vNIC) that is plumbed on a guest VM on the ESXi server. The - port profiles help the network administrators define network policies which can be reused - for new virtual machines. The Ethernet port profiles are created on the VSM and are - represented as port groups on the vCenter server.</para> - </section> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-prerequisite-guide"> - <title>Prerequisites and Guidelines</title> - <para>This section discusses prerequisites and guidelines for using Nexus virtual switch in - &PRODUCT;. Before configuring Nexus virtual switch, ensure that your system meets the - following requirements:</para> - <itemizedlist> - <listitem> - <para>A cluster of servers (ESXi 4.1 or later) is configured in the vCenter.</para> - </listitem> - <listitem> - <para>Each cluster managed by &PRODUCT; is the only cluster in its vCenter - datacenter.</para> - </listitem> - <listitem> - <para>A Cisco Nexus 1000v virtual switch is installed to serve the datacenter that - contains the vCenter cluster. This ensures that &PRODUCT; doesn't have to deal with - dynamic migration of virtual adapters or networks across other existing virtual - switches. See <ulink - url="http://www.cisco.com/en/US/docs/switches/datacenter/nexus1000/sw/4_2_1_s_v_1_5_1/install_upgrade/vsm_vem/guide/n1000v_installupgrade.html"; - >Cisco Nexus 1000V Installation and Upgrade Guide</ulink> for guidelines on how to - install the Nexus 1000v VSM and VEM modules.</para> - </listitem> - <listitem> - <para>The Nexus 1000v VSM is not deployed on a vSphere host that is managed by - &PRODUCT;.</para> - </listitem> - <listitem> - <para>When the maximum number of VEM modules per VSM instance is reached, an additional - VSM instance is created before introducing any more ESXi hosts. The limit is 64 VEM - modules for each VSM instance.</para> - </listitem> - <listitem> - <para>&PRODUCT; expects that the Management Network of the ESXi host is configured on the - standard vSwitch and searches for it in the standard vSwitch. Therefore, ensure that you - do not migrate the management network to Nexus 1000v virtual switch during - configuration.</para> - </listitem> - <listitem> - <para>All information given in <xref - linkend="vmware-vsphere-cluster-config-nexus-vswitch-preconfig"/></para> - </listitem> - </itemizedlist> - </section> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-preconfig"> - <title>Nexus 1000v Virtual Switch Preconfiguration</title> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-preconfig-checklist"> - <title>Preparation Checklist</title> - <para>For a smoother configuration of Nexus 1000v switch, gather the following information - before you start:</para> - <itemizedlist> - <listitem> - <para>vCenter credentials</para> - </listitem> - <listitem> - <para>Nexus 1000v VSM IP address</para> - </listitem> - <listitem> - <para>Nexus 1000v VSM Credentials</para> - </listitem> - <listitem> - <para>Ethernet port profile names</para> - </listitem> - </itemizedlist> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-vcenter-credential-checklist"> - <title>vCenter Credentials Checklist</title> - <para>You will need the following information about vCenter:</para> - <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>Nexus vSwitch Requirements</para></entry> - <entry><para>Value</para></entry> - <entry><para>Notes</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>vCenter IP</para></entry> - <entry><para/></entry> - <entry><para>The IP address of the vCenter.</para></entry> - </row> - <row> - <entry><para>Secure HTTP Port Number</para></entry> - <entry><para>443</para></entry> - <entry><para>Port 443 is configured by default; however, you can change the port - if needed.</para></entry> - </row> - <row> - <entry><para>vCenter User ID</para></entry> - <entry><para/></entry> - <entry><para>The vCenter user with administrator-level privileges. The vCenter - User ID is required when you configure the virtual switch in - &PRODUCT;.</para></entry> - </row> - <row> - <entry><para>vCenter Password</para></entry> - <entry><para/></entry> - <entry><para>The password for the vCenter user specified above. The password for - this vCenter user is required when you configure the switch in - &PRODUCT;.</para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </section> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-net-config-checklist"> - <title>Network Configuration Checklist</title> - <para>The following information specified in the Nexus Configure Networking screen is - displayed in the Details tab of the Nexus dvSwitch in the &PRODUCT; UI:</para> - <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>Network Requirements</para></entry> - <entry><para>Value</para></entry> - <entry><para>Notes</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>Control Port Group VLAN ID</para></entry> - <entry><para/></entry> - <entry><para>The VLAN ID of the Control Port Group. The control VLAN is used for - communication between the VSM and the VEMs.</para></entry> - </row> - <row> - <entry><para>Management Port Group VLAN ID</para></entry> - <entry><para/></entry> - <entry><para>The VLAN ID of the Management Port Group. The management VLAN - corresponds to the mgmt0 interface that is used to establish and maintain the - connection between the VSM and VMware vCenter Server.</para></entry> - </row> - <row> - <entry><para>Packet Port Group VLAN ID</para></entry> - <entry><para/></entry> - <entry><para>The VLAN ID of the Packet Port Group. The packet VLAN forwards - relevant data packets from the VEMs to the VSM.</para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - <note> - <para>The VLANs used for control, packet, and management port groups can be the - same.</para> - </note> - <para>For more information, see <ulink - url="http://www.cisco.com/en/US/docs/switches/datacenter/nexus1000/sw/4_2_1_s_v_1_4_b/getting_started/configuration/guide/n1000v_gsg.pdf"; - >Cisco Nexus 1000V Getting Started Guide</ulink>.</para> - </section> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-vsm-config-checklist"> - <title>VSM Configuration Checklist</title> - <para>You will need the following information about network configuration:</para> - <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>VSM Configuration Parameters Value Notes</para></entry> - <entry><para>Value</para></entry> - <entry><para>Notes</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>Admin Name and Password</para></entry> - <entry><para/></entry> - <entry><para>The admin name and password to connect to the VSM appliance. You must - specify these credentials while configuring Nexus virtual - switch.</para></entry> - </row> - <row> - <entry><para>Management IP Address</para></entry> - <entry><para/></entry> - <entry><para>This is the IP address of the VSM appliance. This is the IP address - you specify in the virtual switch IP Address field while configuting Nexus - virtual switch.</para></entry> - </row> - <row> - <entry><para>SSL</para></entry> - <entry><para>Enable</para></entry> - <entry><para>Always enable SSL. SSH is usually enabled by default during the VSM - installation. However, check whether the SSH connection to the VSM is working, - without which &PRODUCT; failes to connect to the VSM.</para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </section> - </section> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-create-port-profile"> - <title>Creating a Port Profile</title> - <itemizedlist> - <listitem> - <para>Whether you create a Basic or Advanced zone configuration, ensure that you always - create an Ethernet port profile on the VSM after you install it and before you create - the zone.</para> - <itemizedlist> - <listitem> - <para>The Ethernet port profile created to represent the physical network or - networks used by an Advanced zone configuration trunk all the VLANs including - guest VLANs, the VLANs that serve the native VLAN, and the - packet/control/data/management VLANs of the VSM.</para> - </listitem> - <listitem> - <para>The Ethernet port profile created for a Basic zone configuration does not - trunk the guest VLANs because the guest VMs do not get their own VLANs provisioned - on their network interfaces in a Basic zone.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>An Ethernet port profile configured on the Nexus 1000v virtual switch should not - use in its set of system VLANs, or any of the VLANs configured or intended to be - configured for use towards VMs or VM resources in the &PRODUCT; environment.</para> - </listitem> - <listitem> - <para>You do not have to create any vEthernet port profiles â &PRODUCT; does that during - VM deployment.</para> - </listitem> - <listitem> - <para>Ensure that you create required port profiles to be used by &PRODUCT; for - different traffic types of &PRODUCT;, such as Management traffic, Guest traffic, - Storage traffic, and Public traffic. The physical networks configured during zone - creation should have a one-to-one relation with the Ethernet port profiles.</para> - </listitem> - </itemizedlist> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vmware-nexus-port-profile.png"/> - </imageobject> - <textobject> - <phrase>vsphereclient.png: vSphere client</phrase> - </textobject> - </mediaobject> - <para>For information on creating a port profile, see <ulink - url="http://www.cisco.com/en/US/docs/switches/datacenter/nexus1000/sw/4_2_1_s_v_1_4_a/port_profile/configuration/guide/n1000v_port_profile.html"; - >Cisco Nexus 1000V Port Profile Configuration Guide</ulink>.</para> - </section> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-assign-nic-adapters"> - <title>Assigning Physical NIC Adapters</title> - <para>Assign ESXi host's physical NIC adapters, which correspond to each physical - network, to the port profiles. In each ESXi host that is part of the vCenter cluster, - observe the physical networks assigned to each port profile and note down the names of the - port profile for future use. This mapping information helps you when configuring physical - networks during the zone configuration on &PRODUCT;. These Ethernet port profile names are - later specified as VMware Traffic Labels for different traffic types when configuring - physical networks during the zone configuration. For more information on configuring - physical networks, see <xref linkend="vmware-vsphere-cluster-config-nexus-vswitch" - />.</para> - </section> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-add-vlan-range"> - <title>Adding VLAN Ranges</title> - <para>Determine the public VLAN, System VLAN, and Guest VLANs to be used by the &PRODUCT;. - Ensure that you add them to the port profile database. Corresponding to each physical - network, add the VLAN range to port profiles. In the VSM command prompt, run the - switchport trunk allowed vlan<range> command to add the VLAN ranges to the port - profile.</para> - <para>For example:</para> - <programlisting>switchport trunk allowed vlan 1,140-147,196-203</programlisting> - <para>In this example, the allowed VLANs added are 1, 140-147, and 196-203</para> - <para>You must also add all the public and private VLANs or VLAN ranges to the switch. This - range is the VLAN range you specify in your zone.</para> - <note> - <para>Before you run the vlan command, ensure that the configuration mode is enabled in - Nexus 1000v virtual switch.</para> - </note> - <para>For example:</para> - <para>If you want the VLAN 200 to be used on the switch, run the following command:</para> - <programlisting>vlan 200</programlisting> - <para>If you want the VLAN range 1350-1750 to be used on the switch, run the following - command:</para> - <programlisting>vlan 1350-1750</programlisting> - <para>Refer to Cisco Nexus 1000V Command Reference of specific product version.</para> - </section> - </section> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-enable"> - <title>Enabling Nexus Virtual Switch in &PRODUCT;</title> - <para>To make a &PRODUCT; deployment Nexus enabled, you must set the vmware.use.nexus.vswitch - parameter true by using the Global Settings page in the &PRODUCT; UI. Unless this parameter - is set to "true" and restart the management server, you cannot see any UI options - specific to Nexus virtual switch, and &PRODUCT; ignores the Nexus virtual switch specific - parameters specified in the AddTrafficTypeCmd, UpdateTrafficTypeCmd, and AddClusterCmd API - calls.</para> - <para>Unless the &PRODUCT; global parameter "vmware.use.nexus.vswitch" is set to - "true", &PRODUCT; by default uses VMware standard vSwitch for virtual network - infrastructure. In this release, &PRODUCT; doesnât support configuring virtual networks in a - deployment with a mix of standard vSwitch and Nexus 1000v virtual switch. The deployment can - have either standard vSwitch or Nexus 1000v virtual switch.</para> - </section> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-config"> - <title>Configuring Nexus 1000v Virtual Switch in &PRODUCT;</title> - <para>You can configure Nexus dvSwitch by adding the necessary resources while the zone is - being created.</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vmware-nexus-add-cluster.png"/> - </imageobject> - <textobject> - <phrase>vsphereclient.png: vSphere client</phrase> - </textobject> - </mediaobject> - <para>After the zone is created, if you want to create an additional cluster along with Nexus - 1000v virtual switch in the existing zone, use the Add Cluster option. For information on - creating a cluster, see <xref linkend="add-clusters-vsphere"/>.</para> - <para>In both these cases, you must specify the following parameters to configure Nexus - virtual switch:</para> - <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, - "cloud.cluster".</para></entry> - </row> - <row> - <entry><para>vCenter Host</para></entry> - <entry><para>Enter the host name or the IP address of the vCenter host where you have - deployed the Nexus virtual switch.</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, - "cloud.dc.VM".</para></entry> - </row> - <row> - <entry><para>Nexus dvSwitch IP Address</para></entry> - <entry><para>The IP address of the VSM component of the Nexus 1000v virtual - switch.</para></entry> - </row> - <row> - <entry><para>Nexus dvSwitch Username</para></entry> - <entry><para>The admin name to connect to the VSM appliance.</para></entry> - </row> - <row> - <entry><para>Nexus dvSwitch Password</para></entry> - <entry><para>The corresponding password for the admin user specified - above.</para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </section> - <section id="vmware-vsphere-cluster-config-nexus-vswitch-remove"> - <title>Removing Nexus Virtual Switch</title> - <orderedlist> - <listitem> - <para>In the vCenter datacenter that is served by the Nexus virtual switch, ensure that - you delete all the hosts in the corresponding cluster.</para> - </listitem> - <listitem> - <para>Log in with Admin permissions to the &PRODUCT; administrator UI.</para> - </listitem> - <listitem> - <para>In the left navigation bar, select Infrastructure.</para> - </listitem> - <listitem> - <para>In the Infrastructure page, click View all under Clusters.</para> - </listitem> - <listitem> - <para>Select the cluster where you want to remove the virtual switch.</para> - </listitem> - <listitem> - <para>In the dvSwitch tab, click the name of the virtual switch.</para> - </listitem> - <listitem> - <para> In the Details page, click Delete Nexus dvSwitch icon. <inlinemediaobject> - <imageobject> - <imagedata fileref="./images/delete-button.png"/> - </imageobject> - <textobject> - <phrase>DeleteButton.png: button to delete dvSwitch</phrase> - </textobject> - </inlinemediaobject> - </para> - <para>Click Yes in the confirmation dialog box.</para> - </listitem> - </orderedlist> - </section> - </section> - <xi:include href="vmware-cluster-config-dvswitch.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> - <section id="vmware-vsphere-iscsi-storage-preparation"> - <title>Storage Preparation for vSphere (iSCSI only)</title> - <para>Use of iSCSI requires preparatory work in vCenter. You must add an iSCSI target and create - an iSCSI datastore.</para> - <para>If you are using NFS, skip this section.</para> - <section id="vmware-vsphere-iscsi-storage-enable-initiator"> - <title>Enable iSCSI initiator for ESXi hosts</title> - <orderedlist> - <listitem> - <para>In vCenter, go to hosts and Clusters/Configuration, and click Storage Adapters link. - You will see:</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vmware-iscsi-initiator.png"/> - </imageobject> - <textobject> - <phrase>vsphereclient.png: vSphere client</phrase> - </textobject> - </mediaobject> - </listitem> - <listitem> - <para>Select iSCSI software adapter and click Properties.</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vmware-iscsi-initiator-properties.png"/> - </imageobject> - <textobject> - <phrase>vsphereclient.png: vSphere client</phrase> - </textobject> - </mediaobject> - </listitem> - <listitem> - <para>Click the Configure... button.</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vmware-iscsi-general.png"/> - </imageobject> - <textobject> - <phrase>vsphereclient.png: vSphere client</phrase> - </textobject> - </mediaobject> - </listitem> - <listitem> - <para>Check Enabled to enable the initiator.</para> - </listitem> - <listitem> - <para>Click OK to save.</para> - </listitem> - </orderedlist> - </section> - <section id="vmware-vsphere-iscsi-storage-add-target"> - <title>Add iSCSI target</title> - <para>Under the properties dialog, add the iSCSI target info:</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vmware-iscsi-target-add.png"/> - </imageobject> - <textobject> - <phrase>vsphereclient.png: vSphere client</phrase> - </textobject> - </mediaobject> - <para>Repeat these steps for all ESXi hosts in the cluster.</para> - </section> - <section id="vmware-vsphere-iscsi-storage-create-datastore"> - <title>Create an iSCSI datastore</title> - <para>You should now create a VMFS datastore. Follow these steps to do so:</para> - <orderedlist> - <listitem> - <para>Select Home/Inventory/Datastores.</para> - </listitem> - <listitem> - <para>Right click on the datacenter node.</para> - </listitem> - <listitem> - <para>Choose Add Datastore... command.</para> - </listitem> - <listitem> - <para>Follow the wizard to create a iSCSI datastore.</para> - </listitem> - </orderedlist> - <para>This procedure should be done on one host in the cluster. It is not necessary to do this - on all hosts.</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/vmware-iscsi-datastore.png"/> - </imageobject> - <textobject> - <phrase>vsphereclient.png: vSphere client</phrase> - </textobject> - </mediaobject> - </section> - <section id="vmware-vsphere-iscsi-storage-multipathing"> - <title>Multipathing for vSphere (Optional)</title> - <para>Storage multipathing on vSphere nodes may be done according to the vSphere installation - guide.</para> - </section> - </section> - <section id="vmware-add-hosts-config-vsphere-cluster"> - <title>Add Hosts or Configure Clusters (vSphere)</title> - <para>Use vCenter to create a vCenter cluster and add your desired hosts to the cluster. You - will later add the entire cluster to &PRODUCT;. (see <xref linkend="add-clusters-vsphere" - />).</para> - </section> - <section id="esxi-patch-install"> - <title>Applying Hotfixes to a VMware vSphere Host</title> - <orderedlist> - <listitem> - <para>Disconnect the VMware vSphere cluster from &PRODUCT;. It should remain disconnected - long enough to apply the hotfix on the host.</para> - <orderedlist numeration="loweralpha"> - <listitem> - <para>Log in to the &PRODUCT; UI as root. </para> - <para>See <xref linkend="log-in"/>.</para> - </listitem> - <listitem> - <para>Navigate to the VMware cluster, click Actions, and select Unmanage.</para> - </listitem> - <listitem> - <para>Watch the cluster status until it shows Unmanaged.</para> - </listitem> - </orderedlist> - </listitem> - <listitem> - <para>Perform the following on each of the ESXi hosts in the cluster:</para> - <orderedlist numeration="loweralpha"> - <listitem> - <para>Move each of the ESXi hosts in the cluster to maintenance mode.</para> - </listitem> - <listitem> - <para>Ensure that all the VMs are migrated to other hosts in that cluster.</para> - </listitem> - <listitem> - <para>If there is only one host in that cluster, shutdown all the VMs and move the host - into maintenance mode.</para> - </listitem> - <listitem> - <para>Apply the patch on the ESXi host.</para> - </listitem> - <listitem> - <para>Restart the host if prompted.</para> - </listitem> - <listitem> - <para>Cancel the maintenance mode on the host.</para> - </listitem> - </orderedlist> - </listitem> - <listitem> - <para>Reconnect the cluster to &PRODUCT;:</para> - <orderedlist numeration="loweralpha"> - <listitem> - <para>Log in to the &PRODUCT; UI as root.</para> - </listitem> - <listitem> - <para>Navigate to the VMware cluster, click Actions, and select Manage.</para> - </listitem> - <listitem> - <para>Watch the status to see that all the hosts come up. It might take several minutes - for the hosts to come up.</para> - <para>Alternatively, verify the host state is properly synchronized and updated in the - &PRODUCT; database.</para> - </listitem> - </orderedlist> - </listitem> - </orderedlist> - </section> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/vmware-requirements.xml ---------------------------------------------------------------------- diff --git a/en-US/vmware-requirements.xml b/en-US/vmware-requirements.xml deleted file mode 100644 index d7a6d70..0000000 --- a/en-US/vmware-requirements.xml +++ /dev/null @@ -1,80 +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="vmware-requirements"> - <title>System Requirements for vSphere Hosts</title> - <section id="vmware-requirements-software"> - <title>Software requirements:</title> - <itemizedlist> - <listitem> - <para>vSphere and vCenter, both version 4.1 or 5.0.</para> - <para>vSphere Standard is recommended. Note however that customers need to consider the CPU constraints in place with vSphere licensing. See <ulink url="http://www.vmware.com/files/pdf/vsphere_pricing.pdf";>http://www.vmware.com/files/pdf/vsphere_pricing.pdf</ulink> and discuss with your VMware sales representative.</para> - <para>vCenter Server Standard is recommended.</para> - </listitem> - <listitem><para>Be sure all the hotfixes provided by the hypervisor vendor are applied. Track the release of hypervisor patches through your hypervisor vendor's support channel, and apply patches as soon as possible after they are released. &PRODUCT; will not track or notify you of required hypervisor patches. It is essential that your hosts are completely up to date with the provided hypervisor patches. The hypervisor vendor is likely to refuse to support any system that is not up to date with patches.</para></listitem> - </itemizedlist> - <warning><title>Apply All Necessary Hotfixes</title><para>The lack of up-do-date hotfixes can lead to data corruption and lost VMs.</para></warning> - </section> - <section id="vmware-requirements-hardware"> - <title>Hardware requirements:</title> - <itemizedlist> - <listitem><para>The host must be certified as compatible with vSphere. See the VMware Hardware Compatibility Guide at <ulink url="http://www.vmware.com/resources/compatibility/search.php";>http://www.vmware.com/resources/compatibility/search.php</ulink>.</para></listitem> - <listitem><para>All hosts must be 64-bit and must support HVM (Intel-VT or AMD-V enabled).</para></listitem> - <listitem><para>All hosts within a cluster must be homogenous. That means the CPUs must be of the same type, count, and feature flags.</para></listitem> - <listitem><para>64-bit x86 CPU (more cores results in better performance)</para></listitem> - <listitem><para>Hardware virtualization support required</para></listitem> - <listitem><para>4 GB of memory</para></listitem> - <listitem><para>36 GB of local disk</para></listitem> - <listitem><para>At least 1 NIC</para></listitem> - <listitem><para>Statically allocated IP Address</para></listitem> - </itemizedlist> - </section> - <section id="vmware-requirements-vcenter"> - <title>vCenter Server requirements:</title> - <itemizedlist> - <listitem><para>Processor - 2 CPUs 2.0GHz or higher Intel or AMD x86 processors. Processor requirements may be higher if the database runs on the same machine.</para></listitem> - <listitem><para>Memory - 3GB RAM. RAM requirements may be higher if your database runs on the same machine.</para></listitem> - <listitem><para>Disk storage - 2GB. Disk requirements may be higher if your database runs on the same machine.</para></listitem> - <listitem><para>Microsoft SQL Server 2005 Express disk requirements. The bundled database requires up to 2GB free disk space to decompress the installation archive.</para></listitem> - <listitem><para>Networking - 1Gbit or 10Gbit.</para></listitem> - </itemizedlist> - <para>For more information, see "vCenter Server and the vSphere Client Hardware Requirements" at <ulink url="http://pubs.vmware.com/vsp40/wwhelp/wwhimpl/js/html/wwhelp.htm#href=install/c_vc_hw.html";>http://pubs.vmware.com/vsp40/wwhelp/wwhimpl/js/html/wwhelp.htm#href=install/c_vc_hw.html</ulink>.</para> - </section> - <section id="vmware-requirements-other"> - <title>Other requirements:</title> - <itemizedlist> - <listitem><para>VMware vCenter Standard Edition 4.1 or 5.0 must be installed and available to manage the vSphere hosts.</para></listitem> - <listitem><para>vCenter must be configured to use the standard port 443 so that it can communicate with the &PRODUCT; Management Server.</para></listitem> - <listitem><para>You must re-install VMware ESXi if you are going to re-use a host from a previous install.</para></listitem> - <listitem><para>&PRODUCT; requires VMware vSphere 4.1 or 5.0. VMware vSphere 4.0 is not supported.</para></listitem> - <listitem><para>All hosts must be 64-bit and must support HVM (Intel-VT or AMD-V enabled). All hosts within a cluster must be homogeneous. That means the CPUs must be of the same type, count, and feature flags.</para></listitem> - <listitem><para>The &PRODUCT; management network must not be configured as a separate virtual network. The &PRODUCT; management network is the same as the vCenter management network, and will inherit its configuration. See <xref linkend="vmware-physical-host-networking-config-vcenter-mgt" />.</para></listitem> - <listitem><para>&PRODUCT; requires ESXi. ESX is not supported.</para></listitem> - <listitem><para>All resources used for &PRODUCT; must be used for &PRODUCT; only. &PRODUCT; cannot share instance of ESXi or storage with other management consoles. Do not share the same storage volumes that will be used by &PRODUCT; with a different set of ESXi servers that are not managed by &PRODUCT;.</para></listitem> - <listitem><para>Put all target ESXi hypervisors in a cluster in a separate Datacenter in vCenter.</para></listitem> - <listitem><para>The cluster that will be managed by &PRODUCT; should not contain any VMs. Do not run the management server, vCenter or any other VMs on the cluster that is designated for &PRODUCT; use. Create a separate cluster for use of &PRODUCT; and make sure that they are no VMs in this cluster.</para></listitem> - <listitem><para>All the required VLANS must be trunked into all network switches that are connected to the ESXi hypervisor hosts. These would include the VLANS for Management, Storage, vMotion, and guest VLANs. The guest VLAN (used in Advanced Networking; see Network Setup) is a contiguous range of VLANs that will be managed by &PRODUCT;. <!-- &PRODUCT; supports Nexus 1000v virtual switch. For more information, see <xref linkend="vmware-vsphere-cluster-config-nexus-vswitch" />.--> </para></listitem> - </itemizedlist> - </section> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/vmware-topology-req.xml ---------------------------------------------------------------------- diff --git a/en-US/vmware-topology-req.xml b/en-US/vmware-topology-req.xml deleted file mode 100644 index cf6ae4d..0000000 --- a/en-US/vmware-topology-req.xml +++ /dev/null @@ -1,38 +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-topology-req"> - <title>VMware Topology Requirements</title> - <itemizedlist> - <listitem> - <para>The Management Server and secondary storage VMs must be able to access vCenter and all - ESXi hosts in the zone. To allow the necessary access through the firewall, keep port 443 - open.</para> - </listitem> - <listitem> - <para>The Management Servers communicate with VMware vCenter servers on port 443 - (HTTPs).</para> - </listitem> - <listitem> - <para>The Management Servers communicate with the System VMs on port 3922 (ssh) on the - management traffic network.</para> - </listitem> - </itemizedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/vmx-settings-dev.xml ---------------------------------------------------------------------- diff --git a/en-US/vmx-settings-dev.xml b/en-US/vmx-settings-dev.xml deleted file mode 100644 index a0fdf7f..0000000 --- a/en-US/vmx-settings-dev.xml +++ /dev/null @@ -1,40 +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="vmx-settings-dev"> - <title>Additional VMX Settings</title> - <para>A VMX (.vmx) file is the primary configuration file for a virtual machine. When a new VM is - created, information on the operating system, disk sizes, and networking is stored in this file. - The VM actively writes to its .vmx file for all the configuration changes. The VMX file is - typically located in the directory where the VM is created. In Windows Vista / Windows 7 / - Windows Server 2008, the default location is C:\Users\<your_user_name>\My - Documents\Virtual Machines\<virtual_machine_name>.vmx. In Linux, vmware-cmd -l lists the - full path to all the registered VMX files. Any manual additions to the .vmx file from ESX/ESXi - are overwritten by the entries stored in the vCenter Server database. Therefore, before you edit - a .vmx file, first remove the VM from the vCenter server's inventory and register the VM again - after editing.</para> - <para>The CloudStack API that supports passing some of the VMX settings is registerTemplate. The - supported parameters are rootDiskController, nicAdapter, and keyboard. In addition to these - existing VMX parameters, you can now use the keyboard.typematicMinDelay parameter in the - registerTemplate API call. This parameter controls the amount of delay for the repeated key - strokes on remote consoles. For more information on keyboard.typematicMinDelay, see <ulink - url=" http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=196"; - >keyboard.typematicMinDelay</ulink>.</para> -</section>
