diff --git a/docs/en-US/advanced-zone-configuration.xml b/docs/en-US/advanced-zone-configuration.xml index 43b9391516e..451b5454eb2 100644 --- a/docs/en-US/advanced-zone-configuration.xml +++ b/docs/en-US/advanced-zone-configuration.xml @@ -84,6 +84,14 @@ These traffic labels will be defined only for the hypervisor selected for the first cluster. For all other hypervisors, the labels can be configured after the zone is created. + (VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify + the corresponding Ethernet port profile names as network traffic label for each traffic type + on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere + Cluster with Nexus 1000v Virtual Switch in the Installation Guide. If you have enabled + VMware dvSwitch in the environment, you must specify the corresponding Switch name as + network traffic label for each traffic type on the physical network. For more information, + see Configuring a VMware Datacenter with VMware Distributed Virtual Switch in the + Installation Guide. Click Next. @@ -219,9 +227,9 @@ Protocol. For XenServer, choose either NFS, iSCSI, - or PreSetup. For KVM, choose NFS, SharedMountPoint, CLVM, and RBD. For vSphere choose either VMFS - (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary depending on - what you choose here. + or PreSetup. For KVM, choose NFS, SharedMountPoint, CLVM, and RBD. For vSphere choose + either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary + depending on what you choose here. @@ -362,7 +370,8 @@ Secondary Storage : - NFS Server. The IP address of the server or fully qualified domain name of the server. + NFS Server. The IP address of the server or fully + qualified domain name of the server. Path. The exported path from the server. diff --git a/docs/en-US/basic-zone-configuration.xml b/docs/en-US/basic-zone-configuration.xml index 965aff3f644..79d4ab8ce1b 100644 --- a/docs/en-US/basic-zone-configuration.xml +++ b/docs/en-US/basic-zone-configuration.xml @@ -22,124 +22,298 @@ under the License. -->
- Basic Zone Configuration - - After you select Basic in the Add Zone wizard and click Next, you will be asked to enter the following details. Then click Next. - - Name. A name for the zone. - DNS 1 and 2. These are DNS servers for use by guest VMs in the zone. These DNS servers will be accessed via the public network you will add later. The public IP addresses for the zone must have a route to the DNS server named here. - Internal DNS 1 and Internal DNS 2. These are DNS servers for use by system VMs in the zone (these are VMs used by &PRODUCT; itself, such as virtual routers, console proxies, and Secondary Storage VMs.) These DNS servers will be accessed via the management traffic network interface of the System VMs. The private IP address you provide for the pods must have a route to the internal DNS server named here. - Hypervisor. (Introduced in version 3.0.1) Choose the hypervisor for the first cluster in the zone. You can add clusters with different hypervisors later, after you finish adding the zone. - Network Offering. Your choice here determines what network services will be available on the network for guest VMs. - - - - - - - Network Offering - Description - - - - - DefaultSharedNetworkOfferingWithSGService - If you want to enable security groups for guest traffic isolation, choose this. (See Using Security Groups to Control Traffic to VMs.) - - - DefaultSharedNetworkOffering - If you do not need security groups, choose this. - - - DefaultSharedNetscalerEIPandELBNetworkOffering - If you have installed a Citrix NetScaler appliance as part of your zone network, and you will be using its Elastic IP and Elastic Load Balancing features, choose this. With the EIP and ELB features, a basic zone with security groups enabled can offer 1:1 static NAT and load balancing. - - - - - - Network Domain. (Optional) If you want to assign a special domain name to the guest VM network, specify the DNS suffix. - Public. A public zone is available to all users. A zone that is not public will be assigned to a particular domain. Only users in that domain will be allowed to create guest VMs in this zone. - + Basic Zone Configuration + + + After you select Basic in the Add Zone wizard and click Next, you will be asked to enter + the following details. Then click Next. + + + Name. A name for the zone. - Choose which traffic types will be carried by the physical network. - The traffic types are management, public, guest, and storage traffic. For more information about the types, roll over the icons to display their tool tips, or see Basic Zone Network Traffic Types. This screen starts out with some traffic types already assigned. To add more, drag and drop traffic types onto the network. You can also change the network name if desired. + + DNS 1 and 2. These are DNS servers for use by guest + VMs in the zone. These DNS servers will be accessed via the public network you will add + later. The public IP addresses for the zone must have a route to the DNS server named + here. - Assign a network traffic label to each traffic type on the physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon. A popup dialog appears where you can type the label, then click OK. - These traffic labels will be defined only for the hypervisor selected for the first cluster. For all other hypervisors, the labels can be configured after the zone is created. + + Internal DNS 1 and Internal DNS 2. These are DNS + servers for use by system VMs in the zone (these are VMs used by &PRODUCT; itself, such + as virtual routers, console proxies, and Secondary Storage VMs.) These DNS servers will + be accessed via the management traffic network interface of the System VMs. The private + IP address you provide for the pods must have a route to the internal DNS server named + here. - Click Next. - (NetScaler only) If you chose the network offering for NetScaler, you have an additional screen to fill out. Provide the requested details to set up the NetScaler, then click Next. - - IP address. The NSIP (NetScaler IP) address of the NetScaler device. - Username/Password. The authentication credentials to access the device. &PRODUCT; uses these credentials to access the device. - Type. NetScaler device type that is being added. It could be NetScaler VPX, NetScaler MPX, or NetScaler SDX. For a comparison of the types, see About Using a NetScaler Load Balancer. - Public interface. Interface of NetScaler that is configured to be part of the public network. - Private interface. Interface of NetScaler that is configured to be part of the private network. - Number of retries. Number of times to attempt a command on the device before considering the operation failed. Default is 2. - Capacity. Number of guest networks/accounts that will share this NetScaler device. - Dedicated. When marked as dedicated, this device will be dedicated to a single account. When Dedicated is checked, the value in the Capacity field has no significance – implicitly, its value is 1. - + + Hypervisor. (Introduced in version 3.0.1) Choose + the hypervisor for the first cluster in the zone. You can add clusters with different + hypervisors later, after you finish adding the zone. - (NetScaler only) Configure the IP range for public traffic. The IPs in this range will be used for the static NAT capability which you enabled by selecting the network offering for NetScaler with EIP and ELB. Enter the following details, then click Add. If desired, you can repeat this step to add more IP ranges. When done, click Next. - - Gateway. The gateway in use for these IP addresses. - Netmask. The netmask associated with this IP range. - VLAN. The VLAN that will be used for public traffic. - Start IP/End IP. A range of IP addresses that are assumed to be accessible from the Internet and will be allocated for access to guest VMs. - + + Network Offering. Your choice here determines what + network services will be available on the network for guest VMs. + + + + + + + Network Offering + Description + + + + + DefaultSharedNetworkOfferingWithSGService + If you want to enable security groups for guest traffic isolation, + choose this. (See Using Security Groups to Control Traffic to + VMs.) + + + DefaultSharedNetworkOffering + If you do not need security groups, choose this. + + + DefaultSharedNetscalerEIPandELBNetworkOffering + If you have installed a Citrix NetScaler appliance as part of your + zone network, and you will be using its Elastic IP and Elastic Load Balancing + features, choose this. With the EIP and ELB features, a basic zone with + security groups enabled can offer 1:1 static NAT and load + balancing. + + + + - In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later. For an overview of what a pod is, see . - To configure the first pod, enter the following, then click Next: - - Pod Name. A name for the pod. - Reserved system gateway. The gateway for the hosts in that pod. - Reserved system netmask. The network prefix that defines the pod's subnet. Use CIDR notation. - Start/End Reserved System IP. The IP range in the management network that &PRODUCT; uses to manage various system VMs, such as Secondary Storage VMs, Console Proxy VMs, and DHCP. For more information, see System Reserved IP Addresses. - + + Network Domain. (Optional) If you want to assign a + special domain name to the guest VM network, specify the DNS suffix. - Configure the network for guest traffic. Provide the following, then click Next: - - Guest gateway. The gateway that the guests should use. - Guest netmask. The netmask in use on the subnet the guests will use. - Guest start IP/End IP. Enter the first and last IP addresses that define a range that &PRODUCT; can assign to guests. - - We strongly recommend the use of multiple NICs. If multiple NICs are used, they may be in a different subnet. - If one NIC is used, these IPs should be in the same CIDR as the pod CIDR. - - - + + Public. A public zone is available to all users. A + zone that is not public will be assigned to a particular domain. Only users in that + domain will be allowed to create guest VMs in this zone. - In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters later. For an overview of what a cluster is, see About Clusters. - To configure the first cluster, enter the following, then click Next: - - Hypervisor. (Version 3.0.0 only; in 3.0.1, this field is read only) Choose the type of hypervisor software that all hosts in this cluster will run. If you choose VMware, additional fields appear so you can give information about a vSphere cluster. For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add Cluster: vSphere. - Cluster name. Enter a name for the cluster. This can be text of your choosing and is not used by &PRODUCT;. - + + + + Choose which traffic types will be carried by the physical network. + The traffic types are management, public, guest, and storage traffic. For more + information about the types, roll over the icons to display their tool tips, or see Basic + Zone Network Traffic Types. This screen starts out with some traffic types already assigned. + To add more, drag and drop traffic types onto the network. You can also change the network + name if desired. + + + Assign a network traffic label to each traffic type on the physical network. These + labels must match the labels you have already defined on the hypervisor host. To assign each + label, click the Edit button under the traffic type icon. A popup dialog appears where you + can type the label, then click OK. + These traffic labels will be defined only for the hypervisor selected for the first + cluster. For all other hypervisors, the labels can be configured after the zone is + created. + + + Click Next. + + + (NetScaler only) If you chose the network offering for NetScaler, you have an additional + screen to fill out. Provide the requested details to set up the NetScaler, then click + Next. + + + IP address. The NSIP (NetScaler IP) address of the + NetScaler device. - In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts later. For an overview of what a host is, see About Hosts. - When you add a hypervisor host to &PRODUCT;, the host must not have any VMs already running. - Before you can configure the host, you need to install the hypervisor software on the host. You will need to know which version of the hypervisor software version is supported by &PRODUCT; and what additional configuration is required to ensure the host will work with &PRODUCT;. To find these installation details, see: - - Citrix XenServer Installation and Configuration - VMware vSphere Installation and Configuration - KVM vSphere Installation and Configuration - - - To configure the first host, enter the following, then click Next: - - Host Name. The DNS name or IP address of the host. - Username. The username is root. - Password. This is the password for the user named above (from your XenServer or KVM install). - Host Tags. (Optional) Any labels that you use to categorize hosts for ease of maintenance. For example, you can set this to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high availability" feature enabled. For more information, see HA-Enabled Virtual Machines as well as HA for Hosts. - + + Username/Password. The authentication credentials + to access the device. &PRODUCT; uses these credentials to access the device. - In a new cluster, &PRODUCT; adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see About Primary Storage. - To configure the first primary storage server, enter the following, then click Next: - - Name. The name of the storage device. - Protocol. For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS, SharedMountPoint,CLVM, or RBD. For vSphere choose either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary depending on what you choose here. - + + Type. NetScaler device type that is being added. It + could be NetScaler VPX, NetScaler MPX, or NetScaler SDX. For a comparison of the types, + see About Using a NetScaler Load Balancer. - + + Public interface. Interface of NetScaler that is + configured to be part of the public network. + + + Private interface. Interface of NetScaler that is + configured to be part of the private network. + + + Number of retries. Number of times to attempt a + command on the device before considering the operation failed. Default is 2. + + + Capacity. Number of guest networks/accounts that + will share this NetScaler device. + + + Dedicated. When marked as dedicated, this device + will be dedicated to a single account. When Dedicated is checked, the value in the + Capacity field has no significance – implicitly, its value is 1. + + + + + (NetScaler only) Configure the IP range for public traffic. The IPs in this range will + be used for the static NAT capability which you enabled by selecting the network offering + for NetScaler with EIP and ELB. Enter the following details, then click Add. If desired, you + can repeat this step to add more IP ranges. When done, click Next. + + + Gateway. The gateway in use for these IP + addresses. + + + Netmask. The netmask associated with this IP + range. + + + VLAN. The VLAN that will be used for public + traffic. + + + Start IP/End IP. A range of IP addresses that are + assumed to be accessible from the Internet and will be allocated for access to guest + VMs. + + + + + In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later. + For an overview of what a pod is, see . + To configure the first pod, enter the following, then click Next: + + + Pod Name. A name for the pod. + + + Reserved system gateway. The gateway for the hosts + in that pod. + + + Reserved system netmask. The network prefix that + defines the pod's subnet. Use CIDR notation. + + + Start/End Reserved System IP. The IP range in the + management network that &PRODUCT; uses to manage various system VMs, such as Secondary + Storage VMs, Console Proxy VMs, and DHCP. For more information, see System Reserved IP + Addresses. + + + + + Configure the network for guest traffic. Provide the following, then click Next: + + + Guest gateway. The gateway that the guests should + use. + + + Guest netmask. The netmask in use on the subnet the + guests will use. + + + Guest start IP/End IP. Enter the first and last IP + addresses that define a range that &PRODUCT; can assign to guests. + + + We strongly recommend the use of multiple NICs. If multiple NICs are used, they + may be in a different subnet. + + + If one NIC is used, these IPs should be in the same CIDR as the pod CIDR. + + + + + + + In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters + later. For an overview of what a cluster is, see About Clusters. + To configure the first cluster, enter the following, then click Next: + + + Hypervisor. (Version 3.0.0 only; in 3.0.1, this + field is read only) Choose the type of hypervisor software that all hosts in this + cluster will run. If you choose VMware, additional fields appear so you can give + information about a vSphere cluster. For vSphere servers, we recommend creating the + cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add + Cluster: vSphere. + + + Cluster name. Enter a name for the cluster. This + can be text of your choosing and is not used by &PRODUCT;. + + + + + In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts + later. For an overview of what a host is, see About Hosts. + + When you add a hypervisor host to &PRODUCT;, the host must not have any VMs already + running. + + Before you can configure the host, you need to install the hypervisor software on the + host. You will need to know which version of the hypervisor software version is supported by + &PRODUCT; and what additional configuration is required to ensure the host will work with + &PRODUCT;. To find these installation details, see: + + + Citrix XenServer Installation and Configuration + + + VMware vSphere Installation and Configuration + + + KVM vSphere Installation and Configuration + + + + To configure the first host, enter the following, then click Next: + + + Host Name. The DNS name or IP address of the + host. + + + Username. The username is root. + + + Password. This is the password for the user named + above (from your XenServer or KVM install). + + + Host Tags. (Optional) Any labels that you use to + categorize hosts for ease of maintenance. For example, you can set this to the cloud's + HA tag (set in the ha.tag global configuration parameter) if you want this host to be + used only for VMs with the "high availability" feature enabled. For more information, + see HA-Enabled Virtual Machines as well as HA for Hosts. + + + + + In a new cluster, &PRODUCT; adds the first primary storage server for you. You can + always add more servers later. For an overview of what primary storage is, see About Primary + Storage. + To configure the first primary storage server, enter the following, then click + Next: + + + Name. The name of the storage device. + + + Protocol. For XenServer, choose either NFS, iSCSI, + or PreSetup. For KVM, choose NFS, SharedMountPoint,CLVM, or RBD. For vSphere choose + either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary + depending on what you choose here. + + + +
diff --git a/docs/en-US/images/edit-traffic-type.png b/docs/en-US/images/edit-traffic-type.png new file mode 100644 index 00000000000..16cda947fdb Binary files /dev/null and b/docs/en-US/images/edit-traffic-type.png differ diff --git a/docs/en-US/images/traffic-type.png b/docs/en-US/images/traffic-type.png new file mode 100644 index 00000000000..10d5ddb25ed Binary files /dev/null and b/docs/en-US/images/traffic-type.png differ diff --git a/docs/en-US/vmware-cluster-config-dvswitch.xml b/docs/en-US/vmware-cluster-config-dvswitch.xml index 311673a0e09..2aeea2a5e5c 100644 --- a/docs/en-US/vmware-cluster-config-dvswitch.xml +++ b/docs/en-US/vmware-cluster-config-dvswitch.xml @@ -75,27 +75,52 @@ 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"]]] + Use this VDS name in the following: + + + The switch name in the Edit traffic label dialog while configuring a public and guest + traffic during zone creation. + During a zone creation, ensure that you select VMware vNetwork Distributed Virtual Switch + when you configure guest and public traffic type. + + + + + + traffic-type.png: virtual switch type + + + + + The Public Traffic vSwitch Type field when you add a VMware VDS-enabled cluster. + + + The switch name in the traffic label while updating the switch type in a zone. + + + Traffic label format in the last case is [["Name of + vSwitch/dvSwitch/EthernetPortProfile"][,"VLAN ID"[,"vSwitch Type"]]] The possible values for traffic labels are: - empty string - dvSwitch0 - dvSwitch0,200 - dvSwitch1,300,vmwaredvs - myEthernetPortProfile,,nexusdvs - dvSwitch0,,vmwaredvs + + empty string + + + dvSwitch0 + + + dvSwitch0,200 + + + dvSwitch1,300,vmwaredvs + + + myEthernetPortProfile,,nexusdvs + + + dvSwitch0,,vmwaredvs + - - - - - - - traffic-label.png: Traffic label specified while zone creation. - - @@ -124,10 +149,10 @@ 2 VLAN ID to be used for this traffic wherever applicable. - 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. + 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. 3 @@ -153,6 +178,7 @@ +
Enabling Virtual Distributed Switch in &PRODUCT; @@ -171,6 +197,10 @@
Configuring Distributed Virtual Switch in &PRODUCT; You can configure VDS by adding the necessary resources while a zone is created. + 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 . + In both these cases, you must specify the following parameters to configure VDS: @@ -179,10 +209,6 @@ 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: