diff --git a/docs/en-US/Book_Info.xml b/docs/en-US/Book_Info.xml index c125ab8de2b..0ab84c40d9b 100644 --- a/docs/en-US/Book_Info.xml +++ b/docs/en-US/Book_Info.xml @@ -27,7 +27,7 @@ &PRODUCT; Guide Revised August 9, 2012 10:48 pm Pacific Apache CloudStack - 4.0.0-incubating + 4.0.0 1 diff --git a/docs/en-US/add-clusters-vsphere.xml b/docs/en-US/add-clusters-vsphere.xml index 6b2dff2a595..c3a0902be8f 100644 --- a/docs/en-US/add-clusters-vsphere.xml +++ b/docs/en-US/add-clusters-vsphere.xml @@ -71,38 +71,106 @@ In Hypervisor, choose VMware. - Provide the following information in the dialog. The fields below make reference to + Provide the following information in the dialog. The fields below make reference to the values from vCenter. + + + + + + addcluster.png: add a cluster + + - Cluster Name. Enter the name of the cluster you created in vCenter. For example, - "cloud.cluster.2.2.1" + Cluster Name: Enter the name of the cluster you + created in vCenter. For example, "cloud.cluster.2.2.1" - vCenter Host. Enter the hostname or IP address of the vCenter server. + vCenter Username: Enter the username that &PRODUCT; + should use to connect to vCenter. This user must have all the administrative + privileges. - vCenter Username. Enter the username that &PRODUCT; should use to connect to - vCenter. This user must have all administrative privileges. + CPU overcommit ratio: Enter the CPU overcommit + ratio for the cluster. The value you enter determines the CPU consumption of each VM in + the selected cluster. By increasing the over-provisioning ratio, more resource capacity + will be used. If no value is specified, the value is defaulted to 1, which implies no + over-provisioning is done. - vCenter Password. Enter the password for the user named above + RAM overcommit ratio: Enter the RAM overcommit + ratio for the cluster. The value you enter determines the memory consumption of each VM + in the selected cluster. By increasing the over-provisioning ratio, more resource + capacity will be used. If no value is specified, the value is defaulted to 1, which + implies no over-provisioning is done. - vCenter Datacenter. Enter the vCenter datacenter that the cluster is in. For - example, "cloud.dc.VM". + vCenter Host: Enter the hostname or IP address of + the vCenter server. + + + vCenter Password: Enter the password for the user + named above. + + + vCenter Datacenter: Enter the vCenter datacenter + that the cluster is in. For example, "cloud.dc.VM". + + + Override Public Traffic: Enable this option to + override the zone-wide public traffic for the cluster you are creating. + + + Public Traffic vSwitch Type: This option is + displayed only if you enable the Override Public Traffic option. Select a desirable + switch. If the vmware.use.dvswitch global parameter is true, the default option will be + VMware vNetwork Distributed Virtual Switch. + If you have enabled Nexus dvSwitch in the environment, the following parameters for + dvSwitch configuration are displayed: + + + Nexus dvSwitch IP Address: The IP address of the Nexus VSM appliance. + + + Nexus dvSwitch Username: The username required to access the Nexus VSM + appliance. + + + Nexus dvSwitch Password: The password associated with the username specified + above. + + + + + Override Guest Traffic: Enable this option to + override the zone-wide guest traffic for the cluster you are creating. + + + Guest Traffic vSwitch Type: This option is + displayed only if you enable the Override Guest Traffic option. Select a desirable + switch. + If the vmware.use.dvswitch global parameter is true, the default option will be + VMware vNetwork Distributed Virtual Switch. + If you have enabled Nexus dvSwitch in the environment, the following parameters for + dvSwitch configuration are displayed: + + + Nexus dvSwitch IP Address: The IP address of the Nexus VSM appliance. + + + Nexus dvSwitch Username: The username required to access the Nexus VSM + appliance. + + + Nexus dvSwitch Password: The password associated with the username specified + above. + + - - - - - - addcluster.png: add cluster - - There might be a slight delay while the cluster is provisioned. It will - automatically display in the UI + automatically display in the UI. diff --git a/docs/en-US/images/add-cluster.png b/docs/en-US/images/add-cluster.png index 383f375ebed..4b24ec721d8 100644 Binary files a/docs/en-US/images/add-cluster.png and b/docs/en-US/images/add-cluster.png differ diff --git a/docs/en-US/images/dvswitch-config.png b/docs/en-US/images/dvswitch-config.png new file mode 100644 index 00000000000..edce6e8b90e Binary files /dev/null and b/docs/en-US/images/dvswitch-config.png differ diff --git a/docs/en-US/images/dvswitchconfig.png b/docs/en-US/images/dvswitchconfig.png new file mode 100644 index 00000000000..55b1ef7daf3 Binary files /dev/null and b/docs/en-US/images/dvswitchconfig.png differ diff --git a/docs/en-US/vmware-cluster-config-dvswitch.xml b/docs/en-US/vmware-cluster-config-dvswitch.xml new file mode 100644 index 00000000000..dfbaca11627 --- /dev/null +++ b/docs/en-US/vmware-cluster-config-dvswitch.xml @@ -0,0 +1,193 @@ + + +%BOOK_ENTITIES; +]> + + +
+ Configuring a vSphere Cluster with VMware Distributed Virtual Switch + &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. +
+ About VMware Distributed Virtual Switch + 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. +
+
+ Prerequisites and Guidelines + + + Do not attempt to configure VDS by altering VMware traffic label when configuring + physical networks. This will only work for Standard Virtual Switch and should not be + distributed. + + + 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. + + + Management and Storage network does not support VDS. Therefore, use Standard Switch + for these networks. + + +
+
+ Enabling Virtual Distributed Switch in &PRODUCT; + 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 given in the AddClusterCmd API call. + 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. + &PRODUCT; supports configuring virtual networks in a deployment with a mix of Virtual + Distributed Switch, Standard Virtual Switch and Nexus 1000v Virtual Switch. +
+
+ Configuring Distributed Virtual Switch in &PRODUCT; + You can configure VDS by adding the necessary resources while a zone is created. + + + + + + dvSwitchConfig.png: Configuring dvSwitch + + + Alternatively, you can create an additional cluster with VDS enabled in the existing zone. + Use the Add Cluster option. For information as given in . + In both these cases, you must specify the following parameters to configure VDS: + + + + + + + Parameters + Description + + + + + Cluster Name + Enter the name of the cluster you created in vCenter. For example, + "cloud.cluster". + + + vCenter Host + Enter the host name or the IP address of the vCenter host where you have + deployed the Nexus virtual switch. + + + vCenter User name + Enter the username that &PRODUCT; should use to connect to vCenter. This + user must have all administrative privileges. + + + vCenter Password + Enter the password for the user named above. + + + vCenter Datacenter + Enter the vCenter datacenter that the cluster is in. For example, + "cloud.dc.VM". + + + Override Public Traffic + Enable this option to override the zone-wide public traffic for the cluster + you are creating. + + + Public Traffic vSwitch Type + This option is displayed only if you enable the Override Public Traffic + option. Select VMware vNetwork Distributed Virtual Switch. + If the vmware.use.dvswitch global parameter is true, the default option will be + VMware vNetwork Distributed Virtual Switch. + + + Public Traffic vSwitch Name + Specify a name to identify the switch. + + + Override Guest Traffic + Enable the option to override the zone-wide guest traffic for the cluster + you are creating. + + + Guest Traffic vSwitch Type + This option is displayed only if you enable the Override Guest Traffic + option. Select VMware vNetwork Distributed Virtual Switch. + If the vmware.use.dvswitch global parameter is true, the default option will be + VMware vNetwork Distributed Virtual Switch. + + + Guest Traffic vSwitch Name + Specify a name to identify the switch. + + + + +
+
+ Removing Nexus Virtual Switch + + + In the vCenter datacenter that is served by the VMware dvSwitch, ensure that you + delete all the hosts in the corresponding cluster. + + + Log in with Admin permissions to the &PRODUCT; administrator UI. + + + In the left navigation bar, select Infrastructure. + + + In the Infrastructure page, click View all under Clusters. + + + Select the cluster where you want to remove the virtual switch. + + + In the VMware dvSwitch tab, click the name of the virtual switch. + + + In the Details page, click Delete VMware dvSwitch icon. + + + + + DeleteButton.png: button to delete dvSwitch + + + + Click Yes in the confirmation dialog box. + + +
+
diff --git a/docs/en-US/vmware-install.xml b/docs/en-US/vmware-install.xml index 467e1358638..fd88fc7c0cb 100644 --- a/docs/en-US/vmware-install.xml +++ b/docs/en-US/vmware-install.xml @@ -327,282 +327,439 @@ esxcfg-firewall -o 59000-60000,tcp,out,vncextras guide. - + + Log in with Admin permissions to the &PRODUCT; administrator UI. + + + In the left navigation bar, select Infrastructure. + + + In the Infrastructure page, click View all under Clusters. + + + Select the cluster where you want to remove the virtual switch. + + + In the dvSwitch tab, click the name of the virtual switch. + + + In the Details page, click Delete Nexus dvSwitch icon. + + + + + DeleteButton.png: button to delete dvSwitch + + + + Click Yes in the confirmation dialog box. + + + + +
Storage Preparation for vSphere (iSCSI only) Use of iSCSI requires preparatory work in vCenter. You must add an iSCSI target and create