fixes everywhere
Project: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/repo Commit: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/commit/09182f65 Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/tree/09182f65 Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/diff/09182f65 Branch: refs/heads/master Commit: 09182f65b21c2f215717fed57b30f2e2ba1181ec Parents: b928236 Author: Sebastien Goasguen <run...@gmail.com> Authored: Fri Feb 7 15:24:16 2014 +0100 Committer: Sebastien Goasguen <run...@gmail.com> Committed: Fri Feb 7 15:24:16 2014 +0100 ---------------------------------------------------------------------- source/aws_interface.rst | 62 +- source/best_practices.rst | 4 +- source/building_from_source.rst | 3 - source/choosing_deployment_architecture.rst | 157 ------ source/choosing_hypervisor.rst | 45 ++ source/config_params.rst | 294 ++-------- source/configuration.rst | 259 +++------ source/hypervisor_installation.rst | 684 ++++++----------------- source/index.rst | 9 +- source/installation.rst | 46 +- source/optional_installation.rst | 5 +- source/ui.rst | 7 +- 12 files changed, 388 insertions(+), 1187 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/aws_interface.rst ---------------------------------------------------------------------- diff --git a/source/aws_interface.rst b/source/aws_interface.rst index b611feb..2a24b99 100644 --- a/source/aws_interface.rst +++ b/source/aws_interface.rst @@ -6,7 +6,6 @@ "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY @@ -16,7 +15,7 @@ Amazon Web Services Interface -============================ +============================= Amazon Web Services Compatible Interface ---------------------------------------- @@ -29,14 +28,9 @@ CloudStack, listening on a different port. The Amazon Web Services (AWS) compatible interface provides the EC2 SOAP and Query APIs as well as the S3 REST API. -.. note:: This service was previously enabled by separate software called -CloudBridge. It is now fully integrated with the CloudStack management -server. +.. note:: This service was previously enabled by separate software called CloudBridge. It is now fully integrated with the CloudStack management server. -.. warning:: The compatible interface for the EC2 Query API and the S3 API are Work -In Progress. The S3 compatible API offers a way to store data on the -management server file system, it is not an implementation of the S3 -backend. +.. warning:: The compatible interface for the EC2 Query API and the S3 API are Work In Progress. The S3 compatible API offers a way to store data on the management server file system, it is not an implementation of the S3 backend. Limitations @@ -92,14 +86,14 @@ prior to using it. the Amazon service offerings. You can do this through the CloudStack UI as described in the Administration Guide. -.. warning:: Be sure you have included the Amazon default service offering, m1.small. As well as any EC2 instance types that you will use. + .. warning:: Be sure you have included the Amazon default service offering, m1.small. As well as any EC2 instance types that you will use. #. If you did not already do so when you set the configuration parameter in step `1 <#set-global-config>`__, restart the Management Server. -:: + :: # service cloudstack-management restart @@ -147,29 +141,25 @@ instance type API name.| Modifying the AWS API Port ~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. note:: (Optional) The AWS API listens for requests on port 7080. If you prefer -AWS API to listen on another port, you can change it as follows: +.. note:: (Optional) The AWS API listens for requests on port 7080. If you prefer AWS API to listen on another port, you can change it as follows: -#. + #. - Edit the files /etc/cloudstack/management/server.xml, - /etc/cloudstack/management/server-nonssl.xml, and - /etc/cloudstack/management/server-ssl.xml. + Edit the files ``/etc/cloudstack/management/server.xml``, + ``/etc/cloudstack/management/server-nonssl.xml``, and + ``/etc/cloudstack/management/server-ssl.xml``. -#. + #. - In each file, find the tag <Service name="Catalina7080">. Under this - tag, locate <Connector executor="tomcatThreadPool-internal" port= - ....<. + In each file, find the tag <Service name="Catalina7080">. Under this tag, locate <Connector executor="tomcatThreadPool-internal" port= ....<. -#. + #. - Change the port to whatever port you want to use, then save the - files. + Change the port to whatever port you want to use, then save the files. -#. + #. - Restart the Management Server. + Restart the Management Server. If you re-install CloudStack, you will have to re-enable the services and if need be update the port. @@ -235,26 +225,18 @@ commands. If you find that commands are not completing due to timeouts, you can specify a custom timeouts. You can add the following optional command-line parameters to any CloudStack-supported EC2 command: -.. code:: bash - - --connection-timeout TIMEOUT - -Specifies a connection timeout (in seconds). Example: +Specifies a connection timeout (in seconds) .. code:: bash + + --connection-timeout TIMEOUT - --connection-timeout 30 +Specifies a request timeout (in seconds) .. code:: bash --request-timeout TIMEOUT -Specifies a request timeout (in seconds). Example: - -.. code:: bash - - --request-timeout 45 - Example: .. code:: bash @@ -504,9 +486,7 @@ Example 1. An EC2 Boto example | -Second is an S3 example. Replace the Access and Secret keys with your -own, as well as the endpoint of the service. Be sure to also update the -file paths to something that exists on your machine. +Second is an S3 example. The S3 interface in CloudStack is obsolete. If you need an S3 interface you should look at systems like RiakCS, Ceph or GlusterFS. This example is here for completeness and can be adapted to other S3 endpoint. Example 2. An S3 Boto Example http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/best_practices.rst ---------------------------------------------------------------------- diff --git a/source/best_practices.rst b/source/best_practices.rst index e39d1e4..a3174d5 100644 --- a/source/best_practices.rst +++ b/source/best_practices.rst @@ -123,4 +123,6 @@ Maintenance Best Practices (per-host-limit). Once a cluster reaches this number of VMs, use the CloudStack UI to disable allocation to the cluster. -.. warning:: The lack of up-do-date hotfixes can lead to data corruption and lost VMs. Be sure all the hotfixes provided by the hypervisor vendor are applied. Track the release of hypervisor patches through your hypervisor vendorâs support channel, and apply patches as soon as possible after they are released. CloudStack will not track or notify you of required hypervisor patches. It is essential that your hosts are completely up to date with the provided hypervisor patches. The hypervisor vendor is likely to refuse to support any system that is not up to date with patches. +.. warning:: The lack of up-do-date hotfixes can lead to data corruption and lost VMs. + +Be sure all the hotfixes provided by the hypervisor vendor are applied. Track the release of hypervisor patches through your hypervisor vendorâs support channel, and apply patches as soon as possible after they are released. CloudStack will not track or notify you of required hypervisor patches. It is essential that your hosts are completely up to date with the provided hypervisor patches. The hypervisor vendor is likely to refuse to support any system that is not up to date with patches. http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/building_from_source.rst ---------------------------------------------------------------------- diff --git a/source/building_from_source.rst b/source/building_from_source.rst index af85d28..49afd9c 100644 --- a/source/building_from_source.rst +++ b/source/building_from_source.rst @@ -428,9 +428,6 @@ other non-Open Source Software (nonoss) plugins, you'll need to download a few components on your own and follow a slightly different procedure to build from source. -Why Non-OSS? ------------- - .. warning:: Some of the plugins supported by CloudStack cannot be distributed with CloudStack for licensing reasons. In some cases, some of the required libraries/JARs are under a proprietary license. In other cases, the required libraries may be under a license that's not compatible with `Apache's licensing guidelines for third-party products <http://www.apache.org/legal/resolved.html#category-x>`__. #. http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/choosing_deployment_architecture.rst ---------------------------------------------------------------------- diff --git a/source/choosing_deployment_architecture.rst b/source/choosing_deployment_architecture.rst index 7874f64..b3ede21 100644 --- a/source/choosing_deployment_architecture.rst +++ b/source/choosing_deployment_architecture.rst @@ -175,163 +175,6 @@ This diagram illustrates the differences between NIC bonding and Multipath I/O (MPIO). NIC bonding configuration involves only one network. MPIO involves two separate networks. -CloudStack supports many popular hypervisors. Your cloud can consist -entirely of hosts running a single hypervisor, or you can use multiple -hypervisors. Each cluster of hosts must run the same hypervisor. - -You might already have an installed base of nodes running a particular -hypervisor, in which case, your choice of hypervisor has already been -made. If you are starting from scratch, you need to decide what -hypervisor software best suits your needs. A discussion of the relative -advantages of each hypervisor is outside the scope of our documentation. -However, it will help you to know which features of each hypervisor are -supported by CloudStack. The following table provides this information. - -Feature - -XenServer 6.0.2 - -vSphere 4.1/5.0 - -KVM - RHEL 6.2 - -OVM 2.3 - -Bare Metal - -Network Throttling - -Yes - -Yes - -No - -No - -N/A - -Security groups in zones that use basic networking - -Yes - -No - -Yes - -No - -No - -iSCSI - -Yes - -Yes - -Yes - -Yes - -N/A - -FibreChannel - -Yes - -Yes - -Yes - -No - -N/A - -Local Disk - -Yes - -Yes - -Yes - -No - -Yes - -HA - -Yes - -Yes (Native) - -Yes - -Yes - -N/A - -Snapshots of local disk - -Yes - -Yes - -Yes - -No - -N/A - -Local disk as data disk - -No - -No - -No - -No - -N/A - -Work load balancing - -No - -DRS - -No - -No - -N/A - -Manual live migration of VMs from host to host - -Yes - -Yes - -Yes - -Yes - -N/A - -Conserve management traffic IP address by using link local network to -communicate with virtual router - -Yes - -No - -Yes - -Yes - -N/A - .. |1000-foot-view.png: Overview of CloudStack| image:: ./_static/images/1000-foot-view.png .. |basic-deployment.png: Basic two-machine deployment| image:: ./_static/images/basic-deployment.png http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/choosing_hypervisor.rst ---------------------------------------------------------------------- diff --git a/source/choosing_hypervisor.rst b/source/choosing_hypervisor.rst new file mode 100644 index 0000000..2df9425 --- /dev/null +++ b/source/choosing_hypervisor.rst @@ -0,0 +1,45 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information# + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +Choosing a Hypervisor +===================== + +CloudStack supports many popular hypervisors. Your cloud can consist +entirely of hosts running a single hypervisor, or you can use multiple +hypervisors. Each cluster of hosts must run the same hypervisor. + +You might already have an installed base of nodes running a particular +hypervisor, in which case, your choice of hypervisor has already been +made. If you are starting from scratch, you need to decide what +hypervisor software best suits your needs. A discussion of the relative +advantages of each hypervisor is outside the scope of our documentation. +However, it will help you to know which features of each hypervisor are +supported by CloudStack. The following table provides this information. + +====================================================================================================== =============== =============== ============== =========== +Feature XenServer 6.0.2 vSphere 4.1/5.0 KVM - RHEL 6.2 Bare Metal +====================================================================================================== =============== =============== ============== =========== +Network Throttling Yes Yes No N/A +Security groups in zones that use basic networking Yes No Yes No +iSCSI Yes Yes Yes N/A +FibreChannel Yes Yes Yes N/A +Local Disk Yes Yes Yes Yes +HA Yes Yes (Native) Yes N/A +Snapshots of local disk Yes Yes Yes N/A +Local disk as data disk No No No N/A +Work load balancing No DRS No N/A +Manual live migration of VMs from host to host Yes Yes Yes N/A +Conserve management traffic IP address by using link local network to communicate with virtual router Yes No Yes N/A +====================================================================================================== =============== =============== ============== =========== \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/config_params.rst ---------------------------------------------------------------------- diff --git a/source/config_params.rst b/source/config_params.rst index 521a5d9..a206dd9 100644 --- a/source/config_params.rst +++ b/source/config_params.rst @@ -33,74 +33,18 @@ The documentation for each CloudStack feature should direct you to the names of the applicable parameters. The following table shows a few of the more useful parameters. -Field - -Value - -management.network.cidr - -A CIDR that describes the network that the management CIDRs reside on. -This variable must be set for deployments that use vSphere. It is -recommended to be set for other deployments as well. Example: -192.168.3.0/24. - -xen.setup.multipath - -For XenServer nodes, this is a true/false variable that instructs -CloudStack to enable iSCSI multipath on the XenServer Hosts when they -are added. This defaults to false. Set it to true if you would like -CloudStack to enable multipath. - -If this is true for a NFS-based deployment multipath will still be -enabled on the XenServer host. However, this does not impact NFS -operation and is harmless. - -secstorage.allowed.internal.sites - -This is used to protect your internal network from rogue attempts to -download arbitrary files using the template download feature. This is a -comma-separated list of CIDRs. If a requested URL matches any of these -CIDRs the Secondary Storage VM will use the private network interface to -fetch the URL. Other URLs will go through the public interface. We -suggest you set this to 1 or 2 hardened internal machines where you keep -your templates. For example, set it to 192.168.1.66/32. - -use.local.storage - -Determines whether CloudStack will use storage that is local to the Host -for data disks, templates, and snapshots. By default CloudStack will not -use this storage. You should change this to true if you want to use -local storage and you understand the reliability and feature drawbacks -to choosing local storage. - -host - -This is the IP address of the Management Server. If you are using -multiple Management Servers you should enter a load balanced IP address -that is reachable via the private network. - -default.page.size - -Maximum number of items per page that can be returned by a CloudStack -API command. The limit applies at the cloud level and can vary from -cloud to cloud. You can override this with a lower value on a particular -API call by using the page and pagesize API command parameters. For more -information, see the Developer's Guide. Default: 500. - -ha.tag - -The label you want to use throughout the cloud to designate certain -hosts as dedicated HA hosts. These hosts will be used only for -HA-enabled VMs that are restarting due to the failure of another host. -For example, you could set this to ha\_host. Specify the ha.tag value as -a host tag when you add a new host to the cloud. - -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. +================================= ================================================================================ +Field Value +================================= ================================================================================ +management.network.cidr A CIDR that describes the network that the management CIDRs reside on. This variable must be set for deployments that use vSphere. It is recommended to be set for other deployments as well. Example: 192.168.3.0/24. +xen.setup.multipath For XenServer nodes, this is a true/false variable that instructs CloudStack to enable iSCSI multipath on the XenServer Hosts when they are added. This defaults to false. Set it to true if you would like CloudStack to enable multipath.If this is true for a NFS-based deployment multipath will still be enabled on the XenServer host. However, this does not impact NFS operation and is harmless. +secstorage.allowed.internal.sites This is used to protect your internal network from rogue attempts to download arbitrary files using the template download feature. This is a comma-separated list of CIDRs. If a requested URL matches any of these CIDRs the Secondary Storage VM will use the private network interface to fetch the URL. Other URLs will go through the public interface. We suggest you set this to 1 or 2 hardened internal machines where you keep your templates. For example, set it to 192.168.1.66/32. +use.local.storage Determines whether CloudStack will use storage that is local to the Host for data disks, templates, and snapshots. By default CloudStack will not use this storage. You should change this to true if you want to use local storage and you understand the reliability and feature drawbacks to choosing local storage. +host This is the IP address of the Management Server. If you are using multiple Management Servers you should enter a load balanced IP address that is reachable via the private network. +default.page.size Maximum number of items per page that can be returned by a CloudStack API command. The limit applies at the cloud level and can vary from cloud to cloud. You can override this with a lower value on a particular API call by using the page and pagesize API command parameters. For more information, see the Developer's Guide. Default: 500. +ha.tag The label you want to use throughout the cloud to designate certain hosts as dedicated HA hosts. These hosts will be used only for HA-enabled VMs that are restarting due to the failure of another host. For example, you could set this to ha\_host. Specify the ha.tag value asa host tag when you add a new host to the cloud. +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 --------------------------------------- @@ -188,189 +132,37 @@ The following global configuration parameters have been made more granular. The parameters are listed under three different scopes: account, cluster, and zone. -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. - -account - -use.system.public.ips - -If true and if an account has one or more dedicated public IP ranges, -IPs are acquired from the system pool after all the IPs dedicated to the -account have been consumed. - -account - -use.system.guest.vlans - -If true and if an account has one or more dedicated guest VLAN ranges, -VLANs are allocated from the system pool after all the VLANs dedicated -to the account have been consumed. - -cluster - -cluster.storage.allocated.capacity.notificationthreshold - -The percentage, as a value between 0 and 1, of allocated storage -utilization above which alerts are sent that the storage is below the -threshold. - -cluster - -cluster.storage.capacity.notificationthreshold - -The percentage, as a value between 0 and 1, of storage utilization above -which alerts are sent that the available storage is below the threshold. - -cluster - -cluster.cpu.allocated.capacity.notificationthreshold - -The percentage, as a value between 0 and 1, of cpu utilization above -which alerts are sent that the available CPU is below the threshold. - -cluster - -cluster.memory.allocated.capacity.notificationthreshold - -The percentage, as a value between 0 and 1, of memory utilization above -which alerts are sent that the available memory is below the threshold. - -cluster - -cluster.cpu.allocated.capacity.disablethreshold - -The percentage, as a value between 0 and 1, of CPU utilization above -which allocators will disable that cluster from further usage. Keep the -corresponding notification threshold lower than this value to be -notified beforehand. - -cluster - -cluster.memory.allocated.capacity.disablethreshold - -The percentage, as a value between 0 and 1, of memory utilization above -which allocators will disable that cluster from further usage. Keep the -corresponding notification threshold lower than this value to be -notified beforehand. - -cluster - -cpu.overprovisioning.factor - -Used for CPU over-provisioning calculation; the available CPU will be -the mathematical product of actualCpuCapacity and -cpu.overprovisioning.factor. - -cluster - -mem.overprovisioning.factor - -Used for memory over-provisioning calculation. - -cluster - -vmware.reserve.cpu - -Specify whether or not to reserve CPU when not over-provisioning; In -case of CPU over-provisioning, CPU is always reserved. - -cluster - -vmware.reserve.mem - -Specify whether or not to reserve memory when not over-provisioning; In -case of memory over-provisioning memory is always reserved. - -zone - -pool.storage.allocated.capacity.disablethreshold - -The percentage, as a value between 0 and 1, of allocated storage -utilization above which allocators will disable that pool because the -available allocated storage is below the threshold. - -zone - -pool.storage.capacity.disablethreshold - -The percentage, as a value between 0 and 1, of storage utilization above -which allocators will disable the pool because the available storage -capacity is below the threshold. - -zone - -storage.overprovisioning.factor - -Used for storage over-provisioning calculation; available storage will -be the mathematical product of actualStorageSize and -storage.overprovisioning.factor. - -zone - -network.throttling.rate - -Default data transfer rate in megabits per second allowed in a network. - -zone - -guest.domain.suffix - -Default domain name for VMs inside a virtual networks with a router. - -zone - -router.template.xen - -Name of the default router template on Xenserver. - -zone - -router.template.kvm - -Name of the default router template on KVM. - -zone - -router.template.vmware - -Name of the default router template on VMware. - -zone - -enable.dynamic.scale.vm - -Enable or diable dynamically scaling of a VM. - -zone - -use.external.dns - -Bypass internal DNS, and use the external DNS1 and DNS2 - -zone - -blacklisted.routes - -Routes that are blacklisted cannot be used for creating static routes -for a VPC Private Gateway. - +======== ========================================================= ====================================================================================================================================== +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. +account use.system.public.ips If true and if an account has one or more dedicated public IP ranges, IPs are acquired from the system pool after all the IPs dedicated to the account have been consumed. +account use.system.guest.vlans If true and if an account has one or more dedicated guest VLAN ranges, VLANs are allocated from the system pool after all the VLANs dedicated to the account have been consumed. +cluster cluster.storage.allocated.capacity.notificationthreshold The percentage, as a value between 0 and 1, of allocated storage utilization above which alerts are sent that the storage is below the threshold. +cluster cluster.storage.capacity.notificationthreshold The percentage, as a value between 0 and 1, of storage utilization above which alerts are sent that the available storage is below the threshold. +cluster cluster.cpu.allocated.capacity.notificationthreshold The percentage, as a value between 0 and 1, of cpu utilization above which alerts are sent that the available CPU is below the threshold. +cluster cluster.memory.allocated.capacity.notificationthreshold The percentage, as a value between 0 and 1, of memory utilization above which alerts are sent that the available memory is below the threshold. +cluster cluster.cpu.allocated.capacity.disablethreshold The percentage, as a value between 0 and 1, of CPU utilization above which allocators will disable that cluster from further usage. Keep the corresponding notification threshold lower than this value to be notified beforehand. +cluster cluster.memory.allocated.capacity.disablethreshold The percentage, as a value between 0 and 1, of memory utilization above which allocators will disable that cluster from further usage. Keep the corresponding notification threshold lower than this value to be notified beforehand. +cluster cpu.overprovisioning.factor Used for CPU over-provisioning calculation; the available CPU will be + the mathematical product of actualCpuCapacity and cpu.overprovisioning.factor. +cluster mem.overprovisioning.factor Used for memory over-provisioning calculation. +cluster vmware.reserve.cpu Specify whether or not to reserve CPU when not over-provisioning; In case of CPU over-provisioning, CPU is always reserved. +cluster vmware.reserve.mem Specify whether or not to reserve memory when not over-provisioning; In case of memory over-provisioning memory is always reserved. +zone pool.storage.allocated.capacity.disablethreshold The percentage, as a value between 0 and 1, of allocated storage utilization above which allocators will disable that pool because the + available allocated storage is below the threshold. +zone pool.storage.capacity.disablethreshold The percentage, as a value between 0 and 1, of storage utilization above which allocators will disable the pool because the available storage capacity is below the threshold. +zone storage.overprovisioning.factor Used for storage over-provisioning calculation; available storage will be the mathematical product of actualStorageSize and storage.overprovisioning.factor. +zone network.throttling.rate Default data transfer rate in megabits per second allowed in a network. +zone guest.domain.suffix Default domain name for VMs inside a virtual networks with a router. +zone router.template.xen Name of the default router template on Xenserver. +zone router.template.kvm Name of the default router template on KVM. +zone router.template.vmware Name of the default router template on VMware. +zone enable.dynamic.scale.vm Enable or diable dynamically scaling of a VM. +zone use.external.dns Bypass internal DNS, and use the external DNS1 and DNS2 +zone blacklisted.routes Routes that are blacklisted cannot be used for creating static routes for a VPC Private Gateway. +======== ========================================================= ====================================================================================================================================== .. |1000-foot-view.png: Overview of CloudStack| image:: ./_static/images/1000-foot-view.png http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/configuration.rst ---------------------------------------------------------------------- diff --git a/source/configuration.rst b/source/configuration.rst index 166af36..75bcd19 100644 --- a/source/configuration.rst +++ b/source/configuration.rst @@ -431,13 +431,14 @@ Basic Zone Configuration **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 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. + =============================================== =================================================================================================================== + - @@ -640,11 +641,8 @@ Basic Zone Configuration 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 @@ -896,11 +894,8 @@ Advanced Zone Configuration always add more hosts later. For an overview of what a host is, see `Section 2.5, âAbout Hostsâ <#about-hosts>`__. - Note - - - When you deploy CloudStack, the hypervisor host must not have any VMs - already running. + .. note:: 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 @@ -967,110 +962,78 @@ Advanced Zone Configuration 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. - - - + =================== ================================================================== + NFS - - **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. + **Server.** The IP address or DNS name of the storage device. - The tag sets on primary storage across clusters in a Zone must be - identical. For example, if cluster A provides primary storage that - has tags T1 and T2, all other clusters in the Zone must also - provide primary storage that has tags T1 and T2. + - - iSCSI + **Path.** The exported path from the server. - - + - - **Server.** The IP address or DNS name of the storage device. + **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. - **Target IQN.** The IQN of the target. For example, - iqn.1986-03.com.sun:02:01ec9bb549-1271378984. + - - - + **Target IQN.** The IQN of the target. For example, + iqn.1986-03.com.sun:02:01ec9bb549-1271378984. - **Lun.** The LUN number. For example, 3. + - - - + **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. + - - The tag sets on primary storage across clusters in a Zone must be - identical. For example, if cluster A provides primary storage that - has tags T1 and T2, all other clusters in the Zone must also - provide primary storage that has tags T1 and T2. + **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. - - + - - **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. + 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. + - - The tag sets on primary storage across clusters in a Zone must be - identical. For example, if cluster A provides primary storage that - has tags T1 and T2, all other clusters in the Zone must also - provide primary storage that has tags T1 and T2. + **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 - - SharedMountPoint + **Server.** The IP address or DNS name of the vCenter server. - - + - - **Path.** The path on each host that is where this primary - storage is mounted. For example, "/mnt/primary". + **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. - - The tag sets on primary storage across clusters in a Zone must be - identical. For example, if cluster A provides primary storage that - has tags T1 and T2, all other clusters in the Zone must also - provide primary storage that has tags T1 and T2. - - 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. + =================== ========================================================== The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that @@ -1393,9 +1356,8 @@ Adding a Host supported, as well as crucial additional steps to configure the 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. + .. warning:: Be sure you have performed the additional CloudStack-specific configuration steps described in the hypervisor installation section + for your particular hypervisor. #. @@ -1419,8 +1381,7 @@ 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. +.. warning:: Make sure the hypervisor host does not have any VMs already running before you add it to CloudStack. Configuration requirements: @@ -1453,12 +1414,7 @@ pool. # 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. +.. 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. With all hosts added to the XenServer pool, run the cloud-setup-bond script. This script will complete the configuration and setup of the @@ -1618,13 +1574,9 @@ of that procedure. You can add primary storage servers at any time, such 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. +.. 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. -.. note:: Primary storage can also be added at the zone level through the -CloudStack API (adding zone-level primary storage is not yet supported -through the CloudStack UI). +.. note:: Primary storage can also be added at the zone level through the CloudStack API (adding zone-level primary storage is not yet supported through the CloudStack UI). Once primary storage has been added at the zone level, it can be managed through the CloudStack UI. @@ -1762,27 +1714,11 @@ through the CloudStack UI. 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). - -Note - +.. 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). -At this time, a custom storage plug-in, such as the SolidFire storage -plug-in, can only be leveraged for data disks (through Disk Offerings). +.. note:: At this time, a custom storage plug-in, such as the SolidFire storage plug-in, can only be leveraged for data disks (through Disk Offerings). -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. +.. 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. Adding primary storage that is based on the SolidFire plug-in enables CloudStack to provide hard quality-of-service (QoS) guarantees. @@ -1873,53 +1809,6 @@ example, '=' is represented as '%3D')] by (Min IOPS \* clusterDefaultBurstIopsPercentOfMaxIops parameter) (can be a decimal value)] -Example URL to add primary storage to CloudStack based on the SolidFire -plug-in (note that URL encoding is used with the value of the url key, -so '%3A' equals ':','%3B' equals ';' (';' is a key/value pair delimiter -for the url field) and '%3D' equals '='): - -http://127.0.0.1:8080/client/api? - -command=createStoragePool - -&scope=zone - -&zoneId=cf4e6ddf-8ae7-4194-8270-d46733a52b55 - -&name=SolidFire\_121258566 - -&url= - -MVIP%3D192.168.138.180%3A443 - -%3BSVIP%3D192.168.56.7 - -%3BclusterAdminUsername%3Dadmin - -%3BclusterAdminPassword%3Dpassword - -%3BclusterDefaultMinIops%3D200 - -%3BclusterDefaultMaxIops%3D300 - -%3BclusterDefaultBurstIopsPercentOfMaxIops%3D2.5 - -&provider=SolidFire - -&tags=SolidFire\_SAN\_1 - -&capacityIops=4000000 - -&capacityBytes=2251799813685248 - -&hypervisor=Any - -&response=json - -&apiKey=VrrkiZQWFFgSdA6k3DYtoKLcrgQJjZXoSWzicHXt8rYd9Bl47p8L39p0p8vfDpiljtlcMLn\_jatMSqCWv5Cs-Q - -&signature=wqf8KzcPpY2JmT1Sxk%2F%2BWbgX3l8%3D - Add Secondary Storage --------------------- @@ -1960,8 +1849,7 @@ When you create a new zone, the first secondary storage is added as part 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. +.. warning:: Ensure that nothing is stored on the server. Adding the server to CloudStack will destroy any existing data. #. @@ -2012,18 +1900,15 @@ CloudStack will destroy any existing data. for zone-based storage, and the others for region-wide storage. 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. + .. warning:: 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 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. + .. 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. -
