diff --git a/docs/en-US/Release_Notes.xml b/docs/en-US/Release_Notes.xml index ca1e19251e3..8fde51ca251 100644 --- a/docs/en-US/Release_Notes.xml +++ b/docs/en-US/Release_Notes.xml @@ -369,7 +369,7 @@ under the License. -
+
Known Issues in 4.2.0 @@ -544,7 +544,7 @@ under the License.
- + Upgrade Instructions This section contains upgrade instructions from prior versions of CloudStack to Apache CloudStack 4.2.0. We include instructions on upgrading to Apache CloudStack from pre-Apache @@ -552,7 +552,7 @@ under the License. made while CloudStack was in the Apache Incubator. If you run into any issues during upgrades, please feel free to ask questions on users@cloudstack.apache.org or dev@cloudstack.apache.org. -
+
Upgrade from 4.x.x to 4.2.0 This section will guide you from &PRODUCT; 4.0.x versions to &PRODUCT; 4.2.0. Any steps that are hypervisor-specific will be called out with a note. @@ -579,7 +579,7 @@ under the License. url="http://cloudstack.apache.org/downloads.html" >http://cloudstack.apache.org/downloads.html for package repositories supplied by community members. You will need them for step - or step . + or step . Instructions for creating packages from the &PRODUCT; source are in the Installation Guide. @@ -630,7 +630,7 @@ under the License. If you are using Ubuntu, follow this procedure to upgrade your packages. If not, - skip to step . + skip to step . Community Packages This section assumes you're using the community supplied packages for &PRODUCT;. @@ -656,7 +656,7 @@ under the License. Now update your apt package list: $ sudo apt-get update - + Now that you have the repository configured, it's time to install the cloudstack-management package. This will pull in any other dependencies you need. @@ -780,7 +780,7 @@ service cloudstack-agent restart - + If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If not, skip to step . @@ -789,7 +789,7 @@ service cloudstack-agent restart If you've created your own packages and yum repository, substitute your own URL for the ones used in these examples. - + The first order of business will be to change the yum repository for each system with &PRODUCT; packages. This means all management servers, and any hosts that have @@ -811,7 +811,7 @@ gpgcheck=0 If you're using your own package repository, change this line to read as appropriate for your 4.2.0 repository. - + Now that you have the repository configured, it's time to install the cloudstack-management package by upgrading the older cloud-client package. @@ -889,7 +889,7 @@ Done restarting router(s).
-
+
Upgrade from 3.0.2 to 4.2.0 This section will guide you from Citrix CloudStack 3.0.2 to Apache CloudStack 4.2.0. Sections that are hypervisor-specific will be called out with a note. @@ -898,7 +898,7 @@ Done restarting router(s). The following upgrade instructions apply only if you're using VMware hosts. If you're not using VMware hosts, skip this step and move on to . + linkend="stopping-usageservers"/>. In each zone that includes VMware hosts, you need to add a new system VM template. @@ -984,7 +984,7 @@ Done restarting router(s). - + Stop all Usage Servers if running. Run this on all Usage Server hosts. # service cloud-usage stop @@ -1483,7 +1483,7 @@ service cloudstack-agent start issues are seen, try clearing your browser cache and reloading the UI page.
-
+
Upgrade from 2.2.14 to 4.2.0 @@ -1707,7 +1707,7 @@ service cloudstack-agent restart If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If - not, skip to step . + not, skip to step . Community Packages This section assumes you're using the community supplied packages for &PRODUCT;. @@ -1770,7 +1770,7 @@ service cloudstack-agent start - + If you have made changes to your existing copy of the file components.xml in your previous-version CloudStack installation, the changes will be preserved in the upgrade. However, you need to do the following steps to place these changes in a new version of @@ -6755,7 +6755,7 @@ service cloudstack-agent start source, or check the Apache CloudStack downloads page at http://cloudstack.apache.org/downloads.html for package repositories supplied - by community members. You will need them for step + by community members. You will need them for step or step . Instructions for creating packages from the &PRODUCT; source are in the Installation @@ -6805,7 +6805,7 @@ service cloudstack-agent start PlainTextUserAuthenticator works the same way MD5UserAuthenticator worked prior to 4.1. - + If you are using Ubuntu, follow this procedure to upgrade your packages. If not, skip to step . @@ -6814,7 +6814,7 @@ service cloudstack-agent start If you've created your own packages and APT repository, substitute your own URL for the ones used in these examples. - + The first order of business will be to change the sources list for each system with &PRODUCT; packages. This means all management servers, and any hosts that have @@ -6839,7 +6839,7 @@ service cloudstack-agent start dependencies you need. $ sudo apt-get install cloudstack-management - + You will need to manually install the cloudstack-agent package: $ sudo apt-get install cloudstack-agent @@ -6886,7 +6886,7 @@ service cloudstack-agent restart If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If - not, skip to step . + not, skip to step . Community Packages This section assumes you're using the community supplied packages for &PRODUCT;. @@ -6920,7 +6920,7 @@ gpgcheck=0 cloud-client package. $ sudo yum upgrade cloud-client - + For KVM hosts, you will need to upgrade the cloud-agent package, similarly installing the new version as cloudstack-agent. @@ -6949,7 +6949,7 @@ service cloudstack-agent start - + Once you've upgraded the packages on your management servers, you'll need to restart the system VMs. Make sure port 8096 is open in your local host firewall to do this. @@ -6979,7 +6979,7 @@ Done restarting router(s).
-
+
Upgrade from 3.0.2 to 4.1.0 This section will guide you from Citrix CloudStack 3.0.2 to Apache CloudStack 4.1.0. Sections that are hypervisor-specific will be called out with a note. @@ -6988,7 +6988,7 @@ Done restarting router(s). The following upgrade instructions apply only if you're using VMware hosts. If you're not using VMware hosts, skip this step and move on to . + linkend="stopping-usageservers"/>. In each zone that includes VMware hosts, you need to add a new system VM template. @@ -7074,7 +7074,7 @@ Done restarting router(s). - + Stop all Usage Servers if running. Run this on all Usage Server hosts. # service cloud-usage stop @@ -7097,16 +7097,16 @@ Done restarting router(s). the community provided yum/apt repositories to gain access to the &PRODUCT; binaries. - + If you are using Ubuntu, follow this procedure to upgrade your packages. If not, - skip to step . + skip to step . Community Packages This section assumes you're using the community supplied packages for &PRODUCT;. If you've created your own packages and APT repository, substitute your own URL for the ones used in these examples. - + The first order of business will be to change the sources list for each system with &PRODUCT; packages. This means all management servers, and any hosts that have @@ -7125,13 +7125,13 @@ Done restarting router(s). Now update your apt package list: $ sudo apt-get update - + Now that you have the repository configured, it's time to install the cloudstack-management package. This will pull in any other dependencies you need. $ sudo apt-get install cloudstack-management - + You will need to manually install the cloudstack-agent package: $ sudo apt-get install cloudstack-agent @@ -7176,16 +7176,16 @@ service cloudstack-agent restart - + If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If - not, skip to step . + not, skip to step . Community Packages This section assumes you're using the community supplied packages for &PRODUCT;. If you've created your own packages and yum repository, substitute your own URL for the ones used in these examples. - + The first order of business will be to change the yum repository for each system with &PRODUCT; packages. This means all management servers, and any hosts that have @@ -7206,13 +7206,13 @@ gpgcheck=0 If you're using your own package repository, change this line to read as appropriate for your 4.1.0 repository. - + Now that you have the repository configured, it's time to install the cloudstack-management package by upgrading the older cloud-client package. $ sudo yum upgrade cloud-client - + For KVM hosts, you will need to upgrade the cloud-agent package, similarly installing the new version as cloudstack-agent. @@ -7241,7 +7241,7 @@ service cloudstack-agent start - + If you have made changes to your copy of /etc/cloud/management/components.xml the changes will be preserved in the upgrade. However, you need to do the following steps to place these @@ -7693,16 +7693,16 @@ service cloudstack-agent start the community provided yum/apt repositories to gain access to the &PRODUCT; binaries. - + If you are using Ubuntu, follow this procedure to upgrade your packages. If not, - skip to step . + skip to step . Community Packages This section assumes you're using the community supplied packages for &PRODUCT;. If you've created your own packages and APT repository, substitute your own URL for the ones used in these examples. - + The first order of business will be to change the sources list for each system with &PRODUCT; packages. This means all management servers, and any hosts that have @@ -7721,13 +7721,13 @@ service cloudstack-agent start Now update your apt package list: $ sudo apt-get update - + Now that you have the repository configured, it's time to install the cloudstack-management package. This will pull in any other dependencies you need. $ sudo apt-get install cloudstack-management - + On KVM hosts, you will need to manually install the cloudstack-agent package: $ sudo apt-get install cloudstack-agent @@ -7772,16 +7772,16 @@ service cloudstack-agent restart - + If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If - not, skip to step . + not, skip to step . Community Packages This section assumes you're using the community supplied packages for &PRODUCT;. If you've created your own packages and yum repository, substitute your own URL for the ones used in these examples. - + The first order of business will be to change the yum repository for each system with &PRODUCT; packages. This means all management servers, and any hosts that have @@ -7802,13 +7802,13 @@ gpgcheck=0 If you're using your own package repository, change this line to read as appropriate for your 4.1.0 repository. - + Now that you have the repository configured, it's time to install the cloudstack-management package by upgrading the older cloud-client package. $ sudo yum upgrade cloud-client - + For KVM hosts, you will need to upgrade the cloud-agent package, similarly installing the new version as cloudstack-agent. @@ -7837,7 +7837,7 @@ service cloudstack-agent start - + If you have made changes to your existing copy of the file components.xml in your previous-version CloudStack installation, the changes will be preserved in the upgrade. However, you need to do the following steps to place these changes in a new version of diff --git a/docs/en-US/images/vds-name.png b/docs/en-US/images/vds-name.png new file mode 100644 index 00000000000..bf5b4fcf35c Binary files /dev/null and b/docs/en-US/images/vds-name.png differ diff --git a/docs/en-US/vmware-cluster-config-dvswitch.xml b/docs/en-US/vmware-cluster-config-dvswitch.xml index a3250f4f380..98bee0e066a 100644 --- a/docs/en-US/vmware-cluster-config-dvswitch.xml +++ b/docs/en-US/vmware-cluster-config-dvswitch.xml @@ -20,11 +20,11 @@ under the License. -->
- 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. + Configuring a VMware Datacenter 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. @@ -41,30 +41,55 @@ 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 is supported only on Public and Guest traffic in &PRODUCT;. 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. + + 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. + Management and Storage network does not support VDS. Therefore, use Standard Switch for these networks. + + When you remove a guest network, the corresponding dvportgroup will not be removed on + the vCenter. You must manually delete them on the vCenter. +
+
+ Preparation Checklist + For a smoother configuration of VMware VDS, note down the VDS name you have added in the + datacenter before you start: + + + + + + vds-name.png: Name of the dvSwitch as specified in the vCenter. + + + Use this VDS name when you specify the switch name in the traffic label while creating the + zone. Traffic label format is [["Name of vSwitch/dvSwitch/EthernetPortProfile"][,"VLAN + ID"[,"vSwitch Type"]]] +
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. + 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. This number directly + associated with the number of guest network you can create. &PRODUCT; supports orchestration of virtual networks in a deployment with a mix of Virtual Distributed Switch, Standard Virtual Switch and Nexus 1000v Virtual Switch.
@@ -97,12 +122,12 @@ Cluster Name Enter the name of the cluster you created in vCenter. For example, - "cloud.cluster". + "cloudcluster". vCenter Host - Enter the name or the IP address of the vCenter host where you have deployed the VMware - VDS. + Enter the name or the IP address of the vCenter host where you have + deployed the VMware VDS. vCenter User name @@ -116,7 +141,7 @@ vCenter Datacenter Enter the vCenter datacenter that the cluster is in. For example, - "cloud.dc.VM". + "clouddcVM". Override Public Traffic @@ -154,40 +179,5 @@
-
- Removing VMware Virtual Switch - - - In the vCenter datacenter that is served by the VDS, 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 fd88fc7c0cb..282cf2ec6e2 100644 --- a/docs/en-US/vmware-install.xml +++ b/docs/en-US/vmware-install.xml @@ -406,7 +406,7 @@ esxcfg-firewall -o 59000-60000,tcp,out,vncextras before you start: - vCenter Credentials + vCenter credentials Nexus 1000v VSM IP address