Return-Path: X-Original-To: apmail-cloudstack-commits-archive@www.apache.org Delivered-To: apmail-cloudstack-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id CDB6D10B43 for ; Wed, 28 May 2014 06:45:08 +0000 (UTC) Received: (qmail 58746 invoked by uid 500); 28 May 2014 06:45:06 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 58652 invoked by uid 500); 28 May 2014 06:45:06 -0000 Mailing-List: contact commits-help@cloudstack.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 58428 invoked by uid 99); 28 May 2014 06:45:06 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 28 May 2014 06:45:06 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id D7DE494BEAA; Wed, 28 May 2014 06:45:05 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: sebgoa@apache.org To: commits@cloudstack.apache.org Date: Wed, 28 May 2014 06:45:11 -0000 Message-Id: <502ea4b2dd7c48da9e270dfa5932f1bc@git.apache.org> In-Reply-To: <165c30e7d5094ad9a6b60ed0b4d696c9@git.apache.org> References: <165c30e7d5094ad9a6b60ed0b4d696c9@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [7/8] cleaned up formatting in all the files and removed the deprecated 'managing_networks.rst' file: This closes #13 http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/f58c8b9f/source/configuration.rst ---------------------------------------------------------------------- diff --git a/source/configuration.rst b/source/configuration.rst index 0f0c3c8..08865d6 100644 --- a/source/configuration.rst +++ b/source/configuration.rst @@ -13,60 +13,49 @@ specific language governing permissions and limitations under the License. + Configuring your CloudStack Installation ======================================== This section tells how to add regions, zones, pods, clusters, hosts, storage, and networks to your cloud. If you are unfamiliar with these -entities, please begin by looking through `*Cloud Infrastructure Concepts* `_. +entities, please begin by looking through `*Cloud Infrastructure Concepts* +`_. + Overview of Provisioning Steps ------------------------------ After the Management Server is installed and running, you can add the compute resources for it to manage. For an overview of how a CloudStack -cloud infrastructure is organized, see `“Cloud Infrastructure Overview” `_. +cloud infrastructure is organized, see `“Cloud Infrastructure Overview” +`_. To provision the cloud infrastructure, or to scale it up at any time, follow these procedures: -#. - - Define regions (optional). See :ref:`adding-regions`. - -#. - - Add a zone to the region. See :ref:`adding-a-zone`. - -#. +#. Define regions (optional). See :ref:`adding-regions`. - Add more pods to the zone (optional). See :ref:`adding-a-pod`. +#. Add a zone to the region. See :ref:`adding-a-zone`. -#. +#. Add more pods to the zone (optional). See :ref:`adding-a-pod`. - Add more clusters to the pod (optional). See :ref:`adding-a-cluster`. +#. Add more clusters to the pod (optional). See :ref:`adding-a-cluster`. -#. +#. Add more hosts to the cluster (optional). See :ref:`adding-a-host`. - Add more hosts to the cluster (optional). See :ref:`adding-a-host`. +#. Add primary storage to the cluster. See :ref:`add-primary-storage`. -#. +#. Add secondary storage to the zone. See :ref:`add-secondary-storage`. - Add primary storage to the cluster. See :ref:`add-primary-storage`. - -#. - - Add secondary storage to the zone. See :ref:`add-secondary-storage`. - -#. - - Initialize and test the new cloud. See :ref:`initialize-and-test`. +#. Initialize and test the new cloud. See :ref:`initialize-and-test`. When you have finished these steps, you will have a deployment with the following basic structure: |provisioning-overview.png: Conceptual overview of a basic deployment| + .. _adding-regions: Adding Regions (optional) @@ -76,6 +65,7 @@ Grouping your cloud resources into geographic regions is an optional step when provisioning the cloud. For an overview of regions, see `“About Regions” `_. + The First Region: The Default Region ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -85,15 +75,14 @@ region is assigned the region ID of 1. You can change the name or URL of the default region by displaying the region in the CloudStack UI and clicking the Edit button. + Adding a Region ~~~~~~~~~~~~~~~ Use these steps to add a second region in addition to the default region. -#. - - Each region has its own CloudStack instance. Therefore, the first +#. Each region has its own CloudStack instance. Therefore, the first step of creating a new region is to install the Management Server software, on one or more nodes, in the geographic area where you want to set up the new region. Use the steps in the Installation guide. @@ -106,94 +95,65 @@ region. # cloudstack-setup-databases cloud:@localhost --deploy-as=root: -e -m -k -r -#. - - By the end of the installation procedure, the Management Server +#. By the end of the installation procedure, the Management Server should have been started. Be sure that the Management Server installation was successful and complete. -#. - - Now add the new region to region 1 in CloudStack. - - #. +#. Now add the new region to region 1 in CloudStack. - Log in to CloudStack in the first region as root administrator + #. Log in to CloudStack in the first region as root administrator (that is, log in to :8080/client). - #. + #. In the left navigation bar, click Regions. - In the left navigation bar, click Regions. + #. Click Add Region. In the dialog, fill in the following fields: - #. - - Click Add Region. In the dialog, fill in the following fields: - - - - - ID. A unique identifying number. Use the same number you set in + - ID. A unique identifying number. Use the same number you set in the database during Management Server installation in the new region; for example, 2. - - - - Name. Give the new region a descriptive name. - - - + - Name. Give the new region a descriptive name. - Endpoint. The URL where you can log in to the Management Server + - Endpoint. The URL where you can log in to the Management Server in the new region. This has the format :8080/client. -#. - - Now perform the same procedure in reverse. Log in to region 2, and +#. Now perform the same procedure in reverse. Log in to region 2, and add region 1. -#. - - Copy the account, user, and domain tables from the region 1 database +#. Copy the account, user, and domain tables from the region 1 database to the region 2 database. In the following commands, it is assumed that you have set the root password on the database, which is a CloudStack recommended best practice. Substitute your own MySQL root password. - #. - - First, run this command to copy the contents of the database: + #. First, run this command to copy the contents of the database: .. sourcecode:: bash - # mysqldump -u root -p -h cloud account user domain > region1.sql + # mysqldump -u root -p -h cloud account user domain > region1.sql - #. - - Then run this command to put the data onto the region 2 database: + #. Then run this command to put the data onto the region 2 database: .. sourcecode:: bash - # mysql -u root -p -h cloud < region1.sql - -#. + # mysql -u root -p -h cloud < region1.sql - Remove project accounts. Run these commands on the region 2 database: +#. Remove project accounts. Run these commands on the region 2 database: .. sourcecode:: bash - # mysql> delete from account where type = 5; - -#. + # mysql> delete from account where type = 5; - Set the default zone as null: +#. Set the default zone as null: .. sourcecode:: bash - # mysql> update account set default_zone_id = null; + # mysql> update account set default_zone_id = null; -#. +#. Restart the Management Servers in region 2. - Restart the Management Servers in region 2. Adding Third and Subsequent Regions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -202,101 +162,74 @@ To add the third region, and subsequent additional regions, the steps are similar to those for adding the second region. However, you must repeat certain steps additional times for each additional region: -#. - - Install CloudStack in each additional region. Set the region ID for +#. Install CloudStack in each additional region. Set the region ID for each region during the database setup step. .. sourcecode:: bash cloudstack-setup-databases cloud:@localhost --deploy-as=root: -e -m -k -r -#. - - Once the Management Server is running, add your new region to all +#. Once the Management Server is running, add your new region to all existing regions by repeatedly using the Add Region button in the UI. For example, if you were adding region 3: - #. - - Log in to CloudStack in the first region as root administrator + #. Log in to CloudStack in the first region as root administrator (that is, log in to :8080/client), and add a region with ID 3, the name of region 3, and the endpoint :8080/client. - #. - - Log in to CloudStack in the second region as root administrator + #. Log in to CloudStack in the second region as root administrator (that is, log in to :8080/client), and add a region with ID 3, the name of region 3, and the endpoint :8080/client. -#. - - Repeat the procedure in reverse to add all existing regions to the +#. Repeat the procedure in reverse to add all existing regions to the new region. For example, for the third region, add the other two existing regions: - #. - - Log in to CloudStack in the third region as root administrator + #. Log in to CloudStack in the third region as root administrator (that is, log in to :8080/client). - #. - - Add a region with ID 1, the name of region 1, and the endpoint + #. Add a region with ID 1, the name of region 1, and the endpoint :8080/client. - #. - - Add a region with ID 2, the name of region 2, and the endpoint + #. Add a region with ID 2, the name of region 2, and the endpoint :8080/client. -#. - - Copy the account, user, and domain tables from any existing region's +#. Copy the account, user, and domain tables from any existing region's database to the new region's database. In the following commands, it is assumed that you have set the root password on the database, which is a CloudStack recommended best practice. Substitute your own MySQL root password. - #. - - First, run this command to copy the contents of the database: + #. First, run this command to copy the contents of the database: .. sourcecode:: bash - # mysqldump -u root -p -h cloud account user domain > region1.sql + # mysqldump -u root -p -h cloud account user domain > region1.sql - #. - - Then run this command to put the data onto the new region's + #. Then run this command to put the data onto the new region's database. For example, for region 3: .. sourcecode:: bash - # mysql -u root -p -h cloud < region1.sql - -#. + # mysql -u root -p -h cloud < region1.sql - Remove project accounts. Run these commands on the region 3 database: +#. Remove project accounts. Run these commands on the region 3 database: .. sourcecode:: bash - mysql> delete from account where type = 5; - -#. + mysql> delete from account where type = 5; - Set the default zone as null: +#. Set the default zone as null: .. sourcecode:: bash - mysql> update account set default_zone_id = null; + mysql> update account set default_zone_id = null; -#. +#. Restart the Management Servers in the new region. - Restart the Management Servers in the new region. Deleting a Region ~~~~~~~~~~~~~~~~~ @@ -305,25 +238,16 @@ Log in to each of the other regions, navigate to the one you want to delete, and click Remove Region. For example, to remove the third region in a 3-region cloud: -#. - - Log in to :8080/client. - -#. +#. Log in to :8080/client. - In the left navigation bar, click Regions. +#. In the left navigation bar, click Regions. -#. +#. Click the name of the region you want to delete. - Click the name of the region you want to delete. +#. Click the Remove Region button. -#. +#. Repeat these steps for :8080/client. - Click the Remove Region button. - -#. - - Repeat these steps for :8080/client. .. _adding-a-zone: @@ -334,75 +258,48 @@ When you add a new zone, you will be prompted to configure the zone’s physical network and add the first pod, cluster, host, primary storage, and secondary storage. -#. - - Log in to the CloudStack UI as the root administrator. See `“Log In to the UI” `_. - -#. - - In the left navigation, choose Infrastructure. - -#. +#. Log in to the CloudStack UI as the root administrator. See `“Log In to the UI” `_. - On Zones, click View More. +#. In the left navigation, choose Infrastructure. -#. +#. On Zones, click View More. - Click Add Zone. The zone creation wizard will appear. +#. Click Add Zone. The zone creation wizard will appear. -#. +#. Choose one of the following network types: - Choose one of the following network types: - - - - - **Basic.** For AWS-style networking. Provides a single network + - **Basic.** For AWS-style networking. Provides a single network where each VM instance is assigned an IP directly from the network. Guest isolation can be provided through layer-3 means such as security groups (IP address source filtering). - - - - **Advanced.** For more sophisticated network topologies. This + - **Advanced.** For more sophisticated network topologies. This network model provides the most flexibility in defining guest networks and providing custom network offerings such as firewall, VPN, or load balancer support. -#. - - The rest of the steps differ depending on whether you chose Basic or +#. The rest of the steps differ depending on whether you chose Basic or Advanced. Continue with the steps that apply to you: - - - - `“Basic Zone Configuration” <#basic-zone-configuration>`_ + - `“Basic Zone Configuration” <#basic-zone-configuration>`_ - - + - `“Advanced Zone Configuration” <#advanced-zone-configuration>`_ - `“Advanced Zone Configuration” <#advanced-zone-configuration>`_ Basic Zone Configuration ~~~~~~~~~~~~~~~~~~~~~~~~ -#. - - After you select Basic in the Add Zone wizard and click Next, you +#. 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. - - - + - **Name.** A name for the zone. - **DNS 1 and 2.** These are DNS servers for use by guest VMs in the + - **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 + - **Internal DNS 1 and Internal DNS 2.** These are DNS servers for use by system VMs in the zone (these are VMs used by CloudStack itself, such as virtual routers, console proxies, and Secondary Storage VMs.) These DNS servers will be accessed via the @@ -410,41 +307,31 @@ Basic Zone Configuration 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.** (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 + - **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. + 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 + - **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 + - **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. -#. - - Choose which traffic types will be carried by the physical network. +#. 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 @@ -453,9 +340,7 @@ Basic Zone Configuration 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 +#. 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 @@ -465,155 +350,99 @@ Basic Zone Configuration for the first cluster. For all other hypervisors, the labels can be configured after the zone is created. -#. - - Click Next. +#. Click Next. -#. - - (NetScaler only) If you chose the network offering for NetScaler, you +#. (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 + - **IP address.** The NSIP (NetScaler IP) address of the NetScaler device. - - - - **Username/Password.** The authentication credentials to access + - **Username/Password.** The authentication credentials to access the device. CloudStack uses these credentials to access the device. - - - - **Type.** NetScaler device type that is being added. It could be + - **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 + - **Public interface.** Interface of NetScaler that is configured to be part of the public network. - - - - **Private interface.** Interface of NetScaler that is configured + - **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 + - **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 + - **Capacity.** Number of guest networks/accounts that will share this NetScaler device. - - - - **Dedicated.** When marked as dedicated, this device will be + - **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 +#. (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. + - **Gateway.** The gateway in use for these IP addresses. - - + - **Netmask.** The netmask associated with this IP range. - **Netmask.** The netmask associated with this IP range. + - **VLAN.** The VLAN that will be used for public traffic. - - - - **VLAN.** The VLAN that will be used for public traffic. - - - - - **Start IP/End IP.** A range of IP addresses that are assumed to + - **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, CloudStack adds the first pod for you. You can always +#. In a new zone, CloudStack adds the first pod for you. You can always add more pods later. For an overview of what a pod is, see `“About Pods” `_. To configure the first pod, enter the following, then click Next: - - - - **Pod Name.** A name for the pod. + - **Pod Name.** A name for the pod. - - - - **Reserved system gateway.** The gateway for the hosts in that + - **Reserved system gateway.** The gateway for the hosts in that pod. - - - - **Reserved system netmask.** The network prefix that defines the + - **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 + - **Start/End Reserved System IP.** The IP range in the management network that CloudStack 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 +#. Configure the network for guest traffic. Provide the following, then click Next: - - - - **Guest gateway.** The gateway that the guests should use. + - **Guest gateway.** The gateway that the guests should use. - - - - **Guest netmask.** The netmask in use on the subnet the guests + - **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 + - **Guest start IP/End IP.** Enter the first and last IP addresses that define a range that CloudStack can assign to guests. - - - - We strongly recommend the use of multiple NICs. If multiple + - 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 + - If one NIC is used, these IPs should be in the same CIDR as the pod CIDR. -#. - - In a new pod, CloudStack adds the first cluster for you. You can +#. In a new pod, CloudStack 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 + - **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 @@ -621,21 +450,16 @@ Basic Zone Configuration vCenter and then adding the entire cluster to CloudStack. See Add Cluster: vSphere. - - - - **Cluster name.** Enter a name for the cluster. This can be text + - **Cluster name.** Enter a name for the cluster. This can be text of your choosing and is not used by CloudStack. -#. - - In a new cluster, CloudStack adds the first host for you. You can +#. In a new cluster, CloudStack adds the first host for you. You can always add more hosts later. For an overview of what a host is, see About Hosts. - .. note:: - - When you add a hypervisor host to CloudStack, the host must not have - any VMs already running. + .. note:: + When you add a hypervisor host to CloudStack, 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 @@ -643,85 +467,58 @@ Basic Zone Configuration additional configuration is required to ensure the host will work with CloudStack. To find these installation details, see: - - - - Citrix XenServer Installation and Configuration - - - + - Citrix XenServer Installation and Configuration - VMware vSphere Installation and Configuration + - VMware vSphere Installation and Configuration - - - - KVM 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. - - - + - **Host Name.** The DNS name or IP address of the host. - **Username.** The username is root. + - **Username.** The username is root. - - - - **Password.** This is the password for the user named above (from + - **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 + - **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, CloudStack adds the first primary storage server +#. In a new cluster, CloudStack 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. - **Name.** The name of the storage device. - - - - - **Protocol.** For XenServer, choose either NFS, iSCSI, or + - **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. + Advanced Zone Configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -#. - - After you select Advanced in the Add Zone wizard and click Next, you +#. After you select Advanced 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. + - **Name.** A name for the zone. - - - - **DNS 1 and 2.** These are DNS servers for use by guest VMs in the + - **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 + - **Internal DNS 1 and Internal DNS 2.** These are DNS servers for use by system VMs in the zone(these are VMs used by CloudStack itself, such as virtual routers, console proxies,and Secondary Storage VMs.) These DNS servers will be accessed via the @@ -729,50 +526,39 @@ Advanced Zone Configuration private IP address you provide for the pods must have a route to the internal DNS server named here. - - - - **Network Domain.** (Optional) If you want to assign a special + - **Network Domain.** (Optional) If you want to assign a special domain name to the guest VM network, specify the DNS suffix. - - - - **Guest CIDR.** This is the CIDR that describes the IP addresses + - **Guest CIDR.** This is the CIDR that describes the IP addresses in use in the guest virtual networks in this zone. For example, 10.1.1.0/24. As a matter of good practice you should set different CIDRs for different zones. This will make it easier to set up VPNs between networks in different zones. - - - - **Hypervisor.** (Introduced in version 3.0.1) Choose the + - **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. - - - - **Public.** A public zone is available to all users. A zone that + - **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. -#. - - Choose which traffic types will be carried by the physical network. +#. 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 `“Advanced Zone Network Traffic Types” `_. This screen - starts out with one network already configured. If you have multiple - physical networks, you need to add more. Drag and drop traffic types - onto a greyed-out network and it will become active. You can move the + their tool tips, or see `“Advanced Zone Network Traffic Types” + `_. + This screenstarts out with one network already configured. If you have + multiple physical networks, you need to add more. Drag and drop traffic + types onto a greyed-out network and it will become active. You can move the traffic icons from one network to another; for example, if the default traffic types shown for Network 1 do not match your actual setup, you can move them down. You can also change the network names if desired. -#. - - (Introduced in version 3.0.1) Assign a network traffic label to each +#. (Introduced in version 3.0.1) Assign a network traffic label to each traffic type on each 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 within @@ -794,79 +580,53 @@ Advanced Zone Configuration Configuring a VMware Datacenter with VMware Distributed Virtual Switch in the Installation Guide. -#. - - Click Next. +#. Click Next. -#. - - Configure the IP range for public Internet traffic. Enter the +#. Configure the IP range for public Internet traffic. Enter the following details, then click Add. If desired, you can repeat this step to add more public Internet IP ranges. When done, click Next. - - - - **Gateway.** The gateway in use for these IP addresses. + - **Gateway.** The gateway in use for these IP addresses. - - + - **Netmask.** The netmask associated with this IP range. - **Netmask.** The netmask associated with this IP range. + - **VLAN.** The VLAN that will be used for public traffic. - - - - **VLAN.** The VLAN that will be used for public traffic. - - - - - **Start IP/End IP.** A range of IP addresses that are assumed to + - **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 networks. -#. - - In a new zone, CloudStack adds the first pod for you. You can always - add more pods later. For an overview of what a pod is, see - `“About Pods” `_. +#. In a new zone, CloudStack adds the first pod for you. You can always + add more pods later. For an overview of what a pod is, see `“About Pods” + `_. To configure the first pod, enter the following, then click Next: - - - - **Pod Name.** A name for the pod. - - - + - **Pod Name.** A name for the pod. - **Reserved system gateway.** The gateway for the hosts in that + - **Reserved system gateway.** The gateway for the hosts in that pod. - - - - **Reserved system netmask.** The network prefix that defines the + - **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 + - **Start/End Reserved System IP.** The IP range in the management network that CloudStack uses to manage various system VMs, such as Secondary Storage VMs, Console Proxy VMs, and DHCP. For more - information, see `“System Reserved IP Addresses” `_. + information, see `“System Reserved IP Addresses” + `_. -#. - - Specify a range of VLAN IDs to carry guest traffic for each physical +#. Specify a range of VLAN IDs to carry guest traffic for each physical network (see VLAN Allocation Example ), then click Next. -#. - - In a new pod, CloudStack adds the first cluster for you. You can +#. In a new pod, CloudStack adds the first cluster for you. You can always add more clusters later. For an overview of what a cluster is, - see `“About Clusters” `_. + 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 + - **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 @@ -874,21 +634,16 @@ Advanced Zone Configuration vCenter and then adding the entire cluster to CloudStack. See Add Cluster: vSphere . - - - - **Cluster name.** Enter a name for the cluster. This can be text + - **Cluster name.** Enter a name for the cluster. This can be text of your choosing and is not used by CloudStack. -#. - - In a new cluster, CloudStack adds the first host for you. You can +#. In a new cluster, CloudStack adds the first host for you. You can always add more hosts later. For an overview of what a host is, see `“About Hosts” `_. .. note:: - - When you deploy CloudStack, the hypervisor host must not have any VMs - already running. + When you deploy CloudStack, the hypervisor 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 @@ -896,36 +651,22 @@ Advanced Zone Configuration additional configuration is required to ensure the host will work with CloudStack. To find these installation details, see: - - - - Citrix XenServer Installation for CloudStack + - Citrix XenServer Installation for CloudStack - - + - VMware vSphere Installation and Configuration - VMware vSphere Installation and Configuration - - - - - KVM Installation and Configuration + - KVM 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.** Usually root. + - **Host Name.** The DNS name or IP address of the host. - - + - **Username.** Usually root. - **Password.** This is the password for the user named above (from + - **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 + - **Host Tags.** (Optional) Any labels that you use to categorize hosts for ease of maintenance. For example, you can set to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high @@ -933,102 +674,67 @@ Advanced Zone Configuration HA-Enabled Virtual Machines as well as HA for Hosts, both in the Administration Guide. -#. - - In a new cluster, CloudStack adds the first primary storage server +#. In a new cluster, CloudStack 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” `_. + 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. + - **Name.** The name of the storage device. - - - - **Protocol.** For XenServer, choose either NFS, iSCSI, or + - **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. =================== =========================================================================== - NFS - - - **Server.** The IP address or DNS name of the storage device. - - - - - **Path.** The exported path from the server. - - - - - **Tags (optional).** The comma-separated list of tags for this - storage device. It should be an equivalent set or superset of - the tags on your disk offerings. - - iSCSI - - - **Server.** The IP address or DNS name of the storage device. + NFS - **Server.** The IP address or DNS name of the storage device. - - + - **Path.** The exported path from the server. - **Target IQN.** The IQN of the target. For example, - iqn.1986-03.com.sun:02:01ec9bb549-1271378984. + - **Tags (optional).** The comma-separated list of tags for this + storage device. It should be an equivalent set or superset of + the tags on your disk offerings. - - + iSCSI - **Server.** The IP address or DNS name of the storage device. - **Lun.** The LUN number. For example, 3. + - **Target IQN.** The IQN of the target. For example, + iqn.1986-03.com.sun:02:01ec9bb549-1271378984. - - + - **Lun.** The LUN number. For example, 3. - **Tags (optional).** The comma-separated list of tags for this - storage device. It should be an equivalent set or superset of - the tags on your disk offerings. + - **Tags (optional).** The comma-separated list of tags for this + storage device. It should be an equivalent set or superset of + the tags on your disk offerings. - preSetup - + preSetup - **Server.** The IP address or DNS name of the storage device. - **Server.** The IP address or DNS name of the storage device. + - **SR Name-Label.** Enter the name-label of the SR that has been + set up outside CloudStack. - - + - **Tags (optional).** The comma-separated list of tags for this + storage device. It should be an equivalent set or superset of + the tags on your disk offerings. - **SR Name-Label.** Enter the name-label of the SR that has been - set up outside CloudStack. + SharedMountPoint - **Path.** The path on each host that is where this primary + storage is mounted. For example, "/mnt/primary". - - + - **Tags (optional).** The comma-separated list of tags for this + storage device. It should be an equivalent set or superset of + the tags on your disk offerings. - **Tags (optional).** The comma-separated list of tags for this - storage device. It should be an equivalent set or superset of - the tags on your disk offerings. + VMFS - **Server.** The IP address or DNS name of the vCenter server. - SharedMountPoint - + - **Path.** A combination of the datacenter name and the + datastore name. The format is "/" datacenter name "/" datastore + name. For example, "/cloud.dc.VM/cluster1datastore". - **Path.** The path on each host that is where this primary - storage is mounted. For example, "/mnt/primary". - - - - - **Tags (optional).** The comma-separated list of tags for this - storage device. It should be an equivalent set or superset of - the tags on your disk offerings. - - VMFS - - - **Server.** The IP address or DNS name of the vCenter server. - - - - - **Path.** A combination of the datacenter name and the - datastore name. The format is "/" datacenter name "/" datastore - name. For example, "/cloud.dc.VM/cluster1datastore". - - - - - **Tags (optional).** The comma-separated list of tags for this - storage device. It should be an equivalent set or superset of - the tags on your disk offerings. + - **Tags (optional).** The comma-separated list of tags for this + storage device. It should be an equivalent set or superset of + the tags on your disk offerings. =================== =========================================================================== @@ -1037,27 +743,21 @@ Advanced Zone Configuration has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. -#. - - In a new zone, CloudStack adds the first secondary storage server for - you. For an overview of what secondary storage is, see `“About Secondary Storage” `_. +#. In a new zone, CloudStack adds the first secondary storage server for + you. For an overview of what secondary storage is, see `“About Secondary Storage” + `_. Before you can fill out this screen, you need to prepare the secondary storage by setting up NFS shares and installing the latest CloudStack System VM template. See Adding Secondary Storage : - - - - **NFS Server.** The IP address of the server or fully qualified + - **NFS Server.** The IP address of the server or fully qualified domain name of the server. - - - - **Path.** The exported path from the server. + - **Path.** The exported path from the server. -#. +#. Click Launch. - Click Launch. .. _adding-a-pod: @@ -1067,51 +767,33 @@ Adding a Pod When you created a new zone, CloudStack adds the first pod for you. You can add more pods at any time using the procedure in this section. -#. +#. Log in to the CloudStack UI. See `“Log In to the UI” + `_. - Log in to the CloudStack UI. See `“Log In to the UI” `_. - -#. - - In the left navigation, choose Infrastructure. In Zones, click View +#. In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone to which you want to add a pod. -#. - - Click the Compute and Storage tab. In the Pods node of the diagram, +#. Click the Compute and Storage tab. In the Pods node of the diagram, click View All. -#. - - Click Add Pod. - -#. +#. Click Add Pod. - Enter the following details in the dialog. +#. Enter the following details in the dialog. - - + - **Name.** The name of the pod. - **Name.** The name of the pod. + - **Gateway.** The gateway for the hosts in that pod. - - - - **Gateway.** The gateway for the hosts in that pod. - - - - - **Netmask.** The network prefix that defines the pod's subnet. Use + - **Netmask.** The network prefix that defines the pod's subnet. Use CIDR notation. - - - - **Start/End Reserved System IP.** The IP range in the management + - **Start/End Reserved System IP.** The IP range in the management network that CloudStack uses to manage various system VMs, such as Secondary Storage VMs, Console Proxy VMs, and DHCP. For more information, see System Reserved IP Addresses. -#. +#. Click OK. - Click OK. .. _adding-a-cluster: @@ -1122,45 +804,31 @@ You need to tell CloudStack about the hosts that it will manage. Hosts exist inside clusters, so before you begin adding hosts to the cloud, you must add at least one cluster. + Add Cluster: KVM or XenServer ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ These steps assume you have already installed the hypervisor on the hosts and logged in to the CloudStack UI. -#. - - In the left navigation, choose Infrastructure. In Zones, click View +#. In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone in which you want to add the cluster. -#. - - Click the Compute tab. - -#. - - In the Clusters node of the diagram, click View All. - -#. - - Click Add Cluster. +#. Click the Compute tab. -#. +#. In the Clusters node of the diagram, click View All. - Choose the hypervisor type for this cluster. +#. Click Add Cluster. -#. +#. Choose the hypervisor type for this cluster. - Choose the pod in which you want to create the cluster. +#. Choose the pod in which you want to create the cluster. -#. - - Enter a name for the cluster. This can be text of your choosing and +#. Enter a name for the cluster. This can be text of your choosing and is not used by CloudStack. -#. +#. Click OK. - Click OK. Add Cluster: vSphere ~~~~~~~~~~~~~~~~~~~~ @@ -1177,109 +845,71 @@ For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding the entire cluster to CloudStack. Follow these requirements: -- - - Do not put more than 8 hosts in a vSphere cluster - -- +- Do not put more than 8 hosts in a vSphere cluster - Make sure the hypervisor hosts do not have any VMs already running +- Make sure the hypervisor hosts do not have any VMs already running before you add them to CloudStack. To add a vSphere cluster to CloudStack: -#. - - Create the cluster of hosts in vCenter. Follow the vCenter +#. Create the cluster of hosts in vCenter. Follow the vCenter instructions to do this. You will create a cluster that looks something like this in vCenter. |vsphereclient.png: vSphere client| -#. - - Log in to the UI. +#. Log in to the UI. -#. - - In the left navigation, choose Infrastructure. In Zones, click View +#. In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone in which you want to add the cluster. -#. - - Click the Compute tab, and click View All on Pods. Choose the pod to +#. Click the Compute tab, and click View All on Pods. Choose the pod to which you want to add the cluster. -#. - - Click View Clusters. - -#. - - Click Add Cluster. - -#. +#. Click View Clusters. - In Hypervisor, choose VMware. +#. Click Add Cluster. -#. +#. In Hypervisor, choose VMware. - Provide the following information in the dialog. The fields below +#. 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 + - **Cluster Name**: Enter the name of the cluster you created in vCenter. For example, "cloud.cluster.2.2.1" - - - - **vCenter Username**: Enter the username that CloudStack should + - **vCenter Username**: Enter the username that CloudStack should use to connect to vCenter. This user must have all the administrative privileges. - - - - **CPU overcommit ratio**: Enter the CPU overcommit ratio for the + - **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. - - - - **RAM overcommit ratio**: Enter the RAM overcommit ratio for the + - **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 Host**: Enter the hostname or IP address of the vCenter + - **vCenter Host**: Enter the hostname or IP address of the vCenter server. - - + - **vCenter Password**: Enter the password for the user named above. - **vCenter Password**: Enter the password for the user named above. - - - - - **vCenter Datacenter**: Enter the vCenter datacenter that the + - **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 + - **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 + - **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. @@ -1287,29 +917,19 @@ To add a vSphere cluster to CloudStack: 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 + - Nexus dvSwitch IP Address: The IP address of the Nexus VSM appliance. - - - - Nexus dvSwitch Username: The username required to access the + - Nexus dvSwitch Username: The username required to access the Nexus VSM appliance. - - - - Nexus dvSwitch Password: The password associated with the + - Nexus dvSwitch Password: The password associated with the username specified above. - - - - **Override Guest Traffic**: Enable this option to override the + - **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 + - **Guest Traffic vSwitch Type**: This option is displayed only if you enable the Override Guest Traffic option. Select a desirable switch. @@ -1319,34 +939,25 @@ To add a vSphere cluster to CloudStack: 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 + - Nexus dvSwitch IP Address: The IP address of the Nexus VSM appliance. - - - - Nexus dvSwitch Username: The username required to access the + - Nexus dvSwitch Username: The username required to access the Nexus VSM appliance. - - - - Nexus dvSwitch Password: The password associated with the + - Nexus dvSwitch Password: The password associated with the username specified above. - - - - There might be a slight delay while the cluster is provisioned. It + - There might be a slight delay while the cluster is provisioned. It will automatically display in the UI. + .. _adding-a-host: Adding a Host ------------- -#. - - Before adding a host to the CloudStack configuration, you must first +#. Before adding a host to the CloudStack configuration, you must first install your chosen hypervisor on the host. CloudStack can manage hosts running VMs under a variety of hypervisors. @@ -1358,21 +969,17 @@ Adding a Host hypervisor hosts for use with CloudStack. .. warning:: - - Be sure you have performed the additional CloudStack-specific configuration steps described in the hypervisor installation section for your particular hypervisor. - -#. + Be sure you have performed the additional CloudStack-specific + configuration steps described in the hypervisor installation section for + your particular hypervisor. - Now add the hypervisor host to CloudStack. The technique to use +#. Now add the hypervisor host to CloudStack. The technique to use varies depending on the hypervisor. - - + - :ref:`adding-a-host-xenserver-kvm` - :ref:`adding-a-host-xenserver-kvm` + - :ref:`adding-a-host-vsphere` - - - - :ref:`adding-a-host-vsphere` .. _adding-a-host-xenserver-kvm: @@ -1381,30 +988,26 @@ Adding a Host (XenServer or KVM) XenServer and KVM hosts can be added to a cluster at any time. + Requirements for XenServer and KVM Hosts ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. warning:: - - Make sure the hypervisor host does not have any VMs already running before you add it to CloudStack. + Make sure the hypervisor host does not have any VMs already running before + you add it to CloudStack. Configuration requirements: -- - - Each cluster must contain only hosts with the identical hypervisor. - -- +- Each cluster must contain only hosts with the identical hypervisor. - For XenServer, do not put more than 8 hosts in a cluster. +- For XenServer, do not put more than 8 hosts in a cluster. -- - - For KVM, do not put more than 16 hosts in a cluster. +- For KVM, do not put more than 16 hosts in a cluster. For hardware requirements, see the installation section for your hypervisor in the CloudStack Installation Guide. + XenServer Host Additional Requirements '''''''''''''''''''''''''''''''''''''' @@ -1417,107 +1020,76 @@ pool. .. sourcecode:: bash - # xe pool-join master-address=[master IP] master-username=root master-password=[your password] + # xe pool-join master-address=[master IP] master-username=root master-password=[your password] .. note:: - - When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text. + When copying and pasting a command, be sure the command has pasted as a + single line before executing. Some document viewers may introduce unwanted + line breaks in copied text. With all hosts added to the XenServer pool, run the cloud-setup-bond script. This script will complete the configuration and setup of the bonds on the new hosts in the cluster. -#. - - Copy the script from the Management Server in +#. Copy the script from the Management Server in /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver/cloud-setup-bonding.sh to the master host and ensure it is executable. -#. - - Run the script: +#. Run the script: .. sourcecode:: bash - # ./cloud-setup-bonding.sh + # ./cloud-setup-bonding.sh + KVM Host Additional Requirements '''''''''''''''''''''''''''''''' -- - - If shared mountpoint storage is in use, the administrator should +- If shared mountpoint storage is in use, the administrator should ensure that the new host has all the same mountpoints (with storage mounted) as the other hosts in the cluster. -- - - Make sure the new host has the same network configuration (guest, +- Make sure the new host has the same network configuration (guest, private, and public network) as other hosts in the cluster. -- - - If you are using OpenVswitch bridges edit the file agent.properties +- If you are using OpenVswitch bridges edit the file agent.properties on the KVM host and set the parameter network.bridge.type to openvswitch before adding the host to CloudStack + Adding a XenServer or KVM Host ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -#. - - If you have not already done so, install the hypervisor software on +#. If you have not already done so, install the hypervisor software on the host. You will need to know which version of the hypervisor software version is supported by CloudStack and what additional configuration is required to ensure the host will work with CloudStack. To find these installation details, see the appropriate section for your hypervisor in the CloudStack Installation Guide. -#. +#. Log in to the CloudStack UI as administrator. - Log in to the CloudStack UI as administrator. - -#. - - In the left navigation, choose Infrastructure. In Zones, click View +#. In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone in which you want to add the host. -#. - - Click the Compute tab. In the Clusters node, click View All. - -#. - - Click the cluster where you want to add the host. - -#. +#. Click the Compute tab. In the Clusters node, click View All. - Click View Hosts. +#. Click the cluster where you want to add the host. -#. +#. Click View Hosts. - Click Add Host. +#. Click Add Host. -#. +#. Provide the following information. - Provide the following information. + - Host Name. The DNS name or IP address of the host. - - + - Username. Usually root. - Host Name. The DNS name or IP address of the host. - - - - - Username. Usually root. - - - - - Password. This is the password for the user from your XenServer or + - Password. This is the password for the user from your XenServer or KVM install). - - - - Host Tags (Optional). Any labels that you use to categorize hosts + - Host Tags (Optional). Any labels that you use to categorize hosts for ease of maintenance. For example, you can set to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high @@ -1527,9 +1099,8 @@ Adding a XenServer or KVM Host There may be a slight delay while the host is provisioned. It should automatically display in the UI. -#. +#. Repeat for additional hosts. - Repeat for additional hosts. .. _adding-a-host-vsphere: @@ -1540,6 +1111,7 @@ For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding the entire cluster to CloudStack. See Add Cluster: vSphere. + .. _add-primary-storage: Add Primary Storage @@ -1550,33 +1122,24 @@ System Requirements for Primary Storage Hardware requirements: -- - - Any standards-compliant iSCSI, SMB, or NFS server that is supported +- Any standards-compliant iSCSI, SMB, or NFS server that is supported by the underlying hypervisor. -- - - The storage server should be a machine with a large number of disks. +- The storage server should be a machine with a large number of disks. The disks should ideally be managed by a hardware RAID controller. -- - - Minimum required capacity depends on your needs. +- Minimum required capacity depends on your needs. When setting up primary storage, follow these restrictions: -- - - Primary storage cannot be added until a host has been added to the +- Primary storage cannot be added until a host has been added to the cluster. -- - - If you do not provision shared primary storage, you must set the +- If you do not provision shared primary storage, you must set the global configuration parameter system.vm.local.storage.required to true, or else you will not be able to start VMs. + Adding Primary Storage ~~~~~~~~~~~~~~~~~~~~~~ @@ -1586,126 +1149,81 @@ as when adding a new cluster or adding more servers to an existing cluster. .. warning:: + When using preallocated storage for primary storage, be sure there is + nothing on the storage (ex. you have an empty SAN volume or an empty NFS + share). Adding the storage to CloudStack will destroy any existing data. - When using preallocated storage for primary storage, be sure there is nothing on the storage (ex. you have an empty SAN volume or an empty NFS share). Adding the storage to CloudStack will destroy any existing data. - -#. - - Log in to the CloudStack UI (see `“Log In to the UI” `_). +#. Log in to the CloudStack UI (see `“Log In to the UI” `_). -#. - - In the left navigation, choose Infrastructure. In Zones, click View +#. In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone in which you want to add the primary storage. -#. - - Click the Compute tab. +#. Click the Compute tab. -#. +#. In the Primary Storage node of the diagram, click View All. - In the Primary Storage node of the diagram, click View All. +#. Click Add Primary Storage. -#. - - Click Add Primary Storage. - -#. - - Provide the following information in the dialog. The information +#. Provide the following information in the dialog. The information required varies depending on your choice in Protocol. - - - - **Scope.** Indicate whether the storage is available to all hosts + - **Scope.** Indicate whether the storage is available to all hosts in the zone or only to hosts in a single cluster. - - - - **Pod.** (Visible only if you choose Cluster in the Scope field.) + - **Pod.** (Visible only if you choose Cluster in the Scope field.) The pod for the storage device. - - - - **Cluster.** (Visible only if you choose Cluster in the Scope + - **Cluster.** (Visible only if you choose Cluster in the Scope field.) The cluster for the storage device. - - - - **Name.** The name of the storage device. - - - + - **Name.** The name of the storage device. - **Protocol.** For XenServer, choose either NFS, iSCSI, or + - **Protocol.** For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or NFS. For Hyper-V, choose SMB. - - - - **Server (for NFS, iSCSI, or PreSetup).** The IP address or DNS + - **Server (for NFS, iSCSI, or PreSetup).** The IP address or DNS name of the storage device. - - - - **Server (for VMFS).** The IP address or DNS name of the vCenter + - **Server (for VMFS).** The IP address or DNS name of the vCenter server. - - - - **Path (for NFS).** In NFS this is the exported path from the + - **Path (for NFS).** In NFS this is the exported path from the server. - - - - **Path (for VMFS).** In vSphere this is a combination of the + - **Path (for VMFS).** In vSphere this is a combination of the datacenter name and the datastore name. The format is "/" datacenter name "/" datastore name. For example, "/cloud.dc.VM/cluster1datastore". - - - - **Path (for SharedMountPoint).** With KVM this is the path on each + - **Path (for SharedMountPoint).** With KVM this is the path on each host that is where this primary storage is mounted. For example, "/mnt/primary". - - - - **SMB Username** (for SMB/CIFS): Applicable only if you select + - **SMB Username** (for SMB/CIFS): Applicable only if you select SMB/CIFS provider. The username of the account which has the necessary permissions to the SMB shares. The user must be part of the Hyper-V administrator group. - - - - **SMB Password** (for SMB/CIFS): Applicable only if you select + - **SMB Password** (for SMB/CIFS): Applicable only if you select SMB/CIFS provider. The password associated with the account. - - - - **SMB Domain**\ (for SMB/CIFS): Applicable only if you select + - **SMB Domain**\ (for SMB/CIFS): Applicable only if you select SMB/CIFS provider. The Active Directory domain that the SMB share is a part of. - - - - **SR Name-Label (for PreSetup).** Enter the name-label of the SR + - **SR Name-Label (for PreSetup).** Enter the name-label of the SR that has been set up outside CloudStack. - - - - **Target IQN (for iSCSI).** In iSCSI this is the IQN of the + - **Target IQN (for iSCSI).** In iSCSI this is the IQN of the target. For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984. - - - - **Lun # (for iSCSI).** In iSCSI this is the LUN number. For + - **Lun # (for iSCSI).** In iSCSI this is the LUN number. For example, 3. - - - - **Tags (optional).** The comma-separated list of tags for this + - **Tags (optional).** The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.. @@ -1714,21 +1232,23 @@ cluster. has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2. -#. +#. Click OK. - Click OK. Configuring a Storage Plug-in ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. note:: - - Primary storage that is based on a custom plug-in (ex. SolidFire) must be added through the CloudStack API (described later in this section). There is no - support at this time through the CloudStack UI to add this type of primary storage (although most of its features are available through the CloudStack UI). + Primary storage that is based on a custom plug-in (ex. SolidFire) must be + added through the CloudStack API (described later in this section). There + is no support at this time through the CloudStack UI to add this type of + primary storage (although most of its features are available through the + CloudStack UI). .. note:: - - The SolidFire storage plug-in for CloudStack is part of the standard CloudStack install. There is no additional work required to add this component. + The SolidFire storage plug-in for CloudStack is part of the standard + CloudStack install. There is no additional work required to add this + component. Adding primary storage that is based on the SolidFire plug-in enables CloudStack to provide hard quality-of-service (QoS) guarantees. @@ -1745,38 +1265,22 @@ The createStoragePool API has been augmented to support plugable storage providers. The following is a list of parameters to use when adding storage to CloudStack that is based on the SolidFire plug-in: -- - - command=createStoragePool - -- - - scope=zone - -- - - zoneId=[your zone id] +- command=createStoragePool -- +- scope=zone - name=[name for primary storage] +- zoneId=[your zone id] -- +- name=[name for primary storage] - hypervisor=Any +- hypervisor=Any -- +- provider=SolidFire - provider=SolidFire - -- - - capacityIops=[whole number of IOPS from the SAN to give to +- capacityIops=[whole number of IOPS from the SAN to give to CloudStack] -- - - capacityBytes=[whole number of bytes from the SAN to give to +- capacityBytes=[whole number of bytes from the SAN to give to CloudStack] The url parameter is somewhat unique in that its value can contain @@ -1785,40 +1289,27 @@ additional key/value pairs. url=[key/value pairs detailed below (values are URL encoded; for example, '=' is represented as '%3D')] -- - - MVIP%3D[Management Virtual IP Address] (can be suffixed with :[port +- MVIP%3D[Management Virtual IP Address] (can be suffixed with :[port number]) -- - - SVIP%3D[Storage Virtual IP Address] (can be suffixed with :[port +- SVIP%3D[Storage Virtual IP Address] (can be suffixed with :[port number]) -- +- clusterAdminUsername%3D[cluster admin's username] - clusterAdminUsername%3D[cluster admin's username] +- clusterAdminPassword%3D[cluster admin's password] -- - - clusterAdminPassword%3D[cluster admin's password] - -- - - clusterDefaultMinIops%3D[Min IOPS (whole number) to set for a volume; +- clusterDefaultMinIops%3D[Min IOPS (whole number) to set for a volume; used if Min IOPS is not specified by administrator or user] -- - - clusterDefaultMaxIops%3D[Max IOPS (whole number) to set for a volume; +- clusterDefaultMaxIops%3D[Max IOPS (whole number) to set for a volume; used if Max IOPS is not specified by administrator or user] -- - - clusterDefaultBurstIopsPercentOfMaxIops%3D[Burst IOPS is determined +- clusterDefaultBurstIopsPercentOfMaxIops%3D[Burst IOPS is determined by (Min IOPS \* clusterDefaultBurstIopsPercentOfMaxIops parameter) (can be a decimal value)] + .. _add-secondary-storage: Add Secondary Storage @@ -1827,33 +1318,22 @@ Add Secondary Storage System Requirements for Secondary Storage ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- +- NFS storage appliance or Linux NFS server - NFS storage appliance or Linux NFS server +- SMB/CIFS (Hyper-V) -- - - SMB/CIFS (Hyper-V) - -- - - (Optional) OpenStack Object Storage (Swift) (see +- (Optional) OpenStack Object Storage (Swift) (see http://swift.openstack.org) -- - - 100GB minimum capacity - -- +- 100GB minimum capacity - A secondary storage device must be located in the same zone as the +- A secondary storage device must be located in the same zone as the guest VMs it serves. -- - - Each Secondary Storage server must be available to all hosts in the +- Each Secondary Storage server must be available to all hosts in the zone. + Adding Secondary Storage ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1862,50 +1342,34 @@ of that procedure. You can add secondary storage servers at any time to add more servers to an existing zone. .. warning:: + Ensure that nothing is stored on the server. Adding the server to + CloudStack will destroy any existing data. - Ensure that nothing is stored on the server. Adding the server to CloudStack will destroy any existing data. - -#. - - To prepare for the zone-based Secondary Staging Store, you should +#. To prepare for the zone-based Secondary Staging Store, you should have created and mounted an NFS share during Management Server - installation. See `“Prepare NFS Shares” `_. + installation. See `“Prepare NFS Shares” + `_. If you are using an Hyper-V host, ensure that you have created a SMB share. -#. - - Make sure you prepared the system VM template during Management - Server installation. See `“Prepare the System VM Template” `_. - -#. - - Log in to the CloudStack UI as root administrator. - -#. - - In the left navigation bar, click Infrastructure. - -#. +#. Make sure you prepared the system VM template during Management + Server installation. See `“Prepare the System VM Template” + `_. - In Secondary Storage, click View All. +#. Log in to the CloudStack UI as root administrator. -#. +#. In the left navigation bar, click Infrastructure. - Click Add Secondary Storage. +#. In Secondary Storage, click View All. -#. +#. Click Add Secondary Storage. - Fill in the following fields: +#. Fill in the following fields: - - + - Name. Give the storage a descriptive name. - Name. Give the storage a descriptive name. - - - - - Provider. Choose S3, Swift, NFS, or CIFS then fill in the related + - Provider. Choose S3, Swift, NFS, or CIFS then fill in the related fields which appear. The fields will vary depending on the storage provider; for more information, consult the provider's documentation (such as the S3 or Swift website). NFS can be used @@ -1913,47 +1377,36 @@ add more servers to an existing zone. For Hyper-V, select SMB/CIFS. .. warning:: - - Heterogeneous Secondary Storage is not supported in Regions. You can use only a single NFS, S3, or Swift account per region. - - - + Heterogeneous Secondary Storage is not supported in Regions. You can + use only a single NFS, S3, or Swift account per region. - Create NFS Secondary Staging Store. This box must always be + - Create NFS Secondary Staging Store. This box must always be checked. .. warning:: - - Even if the UI allows you to uncheck this box, do not do so. This checkbox and the three fields below it must be filled in. Even when Swift or S3 is used as the secondary storage provider, an NFS staging storage in each zone is still required. + Even if the UI allows you to uncheck this box, do not do so. This + checkbox and the three fields below it must be filled in. Even when + Swift or S3 is used as the secondary storage provider, an NFS staging + storage in each zone is still required. - - - - Zone. The zone where the NFS Secondary Staging Store is to be + - Zone. The zone where the NFS Secondary Staging Store is to be located. - - - - **SMB Username**: Applicable only if you select SMB/CIFS provider. + - **SMB Username**: Applicable only if you select SMB/CIFS provider. The username of the account which has the necessary permissions to the SMB shares. The user must be part of the Hyper-V administrator group. - - - - **SMB Password**: Applicable only if you select SMB/CIFS provider. + - **SMB Password**: Applicable only if you select SMB/CIFS provider. The password associated with the account. - - - - **SMB Domain**: Applicable only if you select SMB/CIFS provider. + - **SMB Domain**: Applicable only if you select SMB/CIFS provider. The Active Directory domain that the SMB share is a part of. - - - - NFS server. The name of the zone's Secondary Staging Store. + - NFS server. The name of the zone's Secondary Staging Store. - - + - Path. The path to the zone's Secondary Staging Store. - Path. The path to the zone's Secondary Staging Store. Adding an NFS Secondary Staging Store for Each Zone ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1962,42 +1415,25 @@ Every zone must have at least one NFS store provisioned; multiple NFS servers are allowed per zone. To provision an NFS Staging Store for a zone: -#. - - Log in to the CloudStack UI as root administrator. - -#. - - In the left navigation bar, click Infrastructure. +#. Log in to the CloudStack UI as root administrator. -#. +#. In the left navigation bar, click Infrastructure. - In Secondary Storage, click View All. +#. In Secondary Storage, click View All. -#. +#. In Select View, choose Secondary Staging Store. - In Select View, choose Secondary Staging Store. +#. Click the Add NFS Secondary Staging Store button. -#. +#. Fill out the dialog box fields, then click OK: - Click the Add NFS Secondary Staging Store button. - -#. - - Fill out the dialog box fields, then click OK: - - - - - Zone. The zone where the NFS Secondary Staging Store is to be + - Zone. The zone where the NFS Secondary Staging Store is to be located. - - - - NFS server. The name of the zone's Secondary Staging Store. + - NFS server. The name of the zone's Secondary Staging Store. - - + - Path. The path to the zone's Secondary Staging Store. - Path. The path to the zone's Secondary Staging Store. .. _initialize-and-test: @@ -2009,64 +1445,42 @@ initialization. This can take 30 minutes or more, depending on the speed of your network. When the initialization has completed successfully, the administrator's Dashboard should be displayed in the CloudStack UI. -#. - - Verify that the system is ready. In the left navigation bar, select +#. Verify that the system is ready. In the left navigation bar, select Templates. Click on the CentOS 5.5 (64bit) no Gui (KVM) template. Check to be sure that the status is "Download Complete." Do not proceed to the next step until this status is displayed. -#. - - Go to the Instances tab, and filter by My Instances. - -#. - - Click Add Instance and follow the steps in the wizard. - - #. +#. Go to the Instances tab, and filter by My Instances. - Choose the zone you just added. +#. Click Add Instance and follow the steps in the wizard. - #. + #. Choose the zone you just added. - In the template selection, choose the template to use in the VM. + #. In the template selection, choose the template to use in the VM. If this is a fresh installation, likely only the provided CentOS template is available. - #. - - Select a service offering. Be sure that the hardware you have + #. Select a service offering. Be sure that the hardware you have allows starting the selected service offering. - #. - - In data disk offering, if desired, add another data disk. This is + #. In data disk offering, if desired, add another data disk. This is a second volume that will be available to but not mounted in the guest. For example, in Linux on XenServer you will see /dev/xvdb in the guest after rebooting the VM. A reboot is not required if you have a PV-enabled OS kernel in use. - #. - - In default network, choose the primary network for the guest. In a + #. In default network, choose the primary network for the guest. In a trial installation, you would have only one option here. - #. - - Optionally give your VM a name and a group. Use any descriptive + #. Optionally give your VM a name and a group. Use any descriptive text you would like. - #. - - Click Launch VM. Your VM will be created and started. It might + #. Click Launch VM. Your VM will be created and started. It might take some time to download the template and complete the VM startup. You can watch the VM’s progress in the Instances screen. -#. - - To use the VM, click the View Console button. |ConsoleButton.png: +#. To use the VM, click the View Console button. |ConsoleButton.png: button to launch a console| For more information about using VMs, including instructions for how @@ -2114,6 +1528,7 @@ ha.tag The label you want to use throughout the clou vmware.vcenter.session.timeout Determines the vCenter session timeout value by using this parameter. The default value is 20 minutes. Increase the timeout value to avoid timeout errors in VMware deployments because certain VMware operations take more than 20 minutes. ================================= ================================================================================ + Setting Global Configuration Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -2121,39 +1536,26 @@ Use the following steps to set global configuration parameters. These values will be the defaults in effect throughout your CloudStack deployment. -#. - - Log in to the UI as administrator. - -#. - - In the left navigation bar, click Global Settings. - -#. +#. Log in to the UI as administrator. - In Select View, choose one of the following: +#. In the left navigation bar, click Global Settings. - - +#. In Select View, choose one of the following: - Global Settings. This displays a list of the parameters with brief + - Global Settings. This displays a list of the parameters with brief descriptions and current values. - - - - Hypervisor Capabilities. This displays a list of hypervisor + - Hypervisor Capabilities. This displays a list of hypervisor versions with the maximum number of guests supported for each. -#. - - Use the search box to narrow down the list to those you are +#. Use the search box to narrow down the list to those you are interested in. -#. - - In the Actions column, click the Edit icon to modify a value. If you +#. In the Actions column, click the Edit icon to modify a value. If you are viewing Hypervisor Capabilities, you must click the name of the hypervisor first to display the editing screen. + Setting Local Configuration Parameters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -2161,37 +1563,24 @@ Use the following steps to set local configuration parameters for an account, zone, cluster, or primary storage. These values will override the global configuration settings. -#. - - Log in to the UI as administrator. +#. Log in to the UI as administrator. -#. - - In the left navigation bar, click Infrastructure or Accounts, +#. In the left navigation bar, click Infrastructure or Accounts, depending on where you want to set a value. -#. - - Find the name of the particular resource that you want to work with. +#. Find the name of the particular resource that you want to work with. For example, if you are in Infrastructure, click View All on the Zones, Clusters, or Primary Storage area. -#. - - Click the name of the resource where you want to set a limit. - -#. - - Click the Settings tab. +#. Click the name of the resource where you want to set a limit. -#. +#. Click the Settings tab. - Use the search box to narrow down the list to those you are +#. Use the search box to narrow down the list to those you are interested in. -#. +#. In the Actions column, click the Edit icon to modify a value. - In the Actions column, click the Edit icon to modify a value. Granular Global Configuration Parameters ---------------------------------------- @@ -2201,7 +1590,7 @@ granular. The parameters are listed under three different scopes: account, cluster, and zone. ======== ========================================================= ====================================================================================================================================== -Field Field Value +Field Field Value ======== ========================================================= ====================================================================================================================================== account remote.access.vpn.client.iprange The range of IPs to be allocated to remotely access the VPN clients. The first IP in the range is used by the VPN server. account allow.public.user.templates If false, users will not be able to create public templates.