You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by se...@apache.org on 2014/02/07 15:24:16 UTC
[1/2] fixes everywhere
Updated Branches:
refs/heads/master b92823652 -> 09182f65b
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/hypervisor_installation.rst
----------------------------------------------------------------------
diff --git a/source/hypervisor_installation.rst b/source/hypervisor_installation.rst
index 0bc547e..cd89b7a 100644
--- a/source/hypervisor_installation.rst
+++ b/source/hypervisor_installation.rst
@@ -100,11 +100,9 @@ The material in this section doesn't duplicate KVM installation docs. It
provides the CloudStack-specific steps that are needed to prepare a KVM
host to work with CloudStack.
-.. warning:: Before continuing, make sure that you have applied the latest updates to
-your host.
+.. warning:: Before continuing, make sure that you have applied the latest updates to your host.
-.. warning:: It is NOT recommended to run services on this host not controlled by
-CloudStack.
+.. warning:: It is NOT recommended to run services on this host not controlled by CloudStack.
The procedure for installing a KVM Hypervisor Host is:
@@ -285,8 +283,7 @@ Here are some examples:
guest.cpu.mode=host-passthrough
-.. note:: host-passthrough may lead to migration failure,if you have this
-problem,you should use host-model or custom
+.. note:: host-passthrough may lead to migration failure,if you have this problem,you should use host-model or custom
Install and Configure libvirt
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -339,7 +336,7 @@ cloudstack-agent and should already be installed.
On Ubuntu: modify ``/etc/default/libvirt-bin``
- Add "-l" to the following line::
+ Add "-l" to the following line
.. code:: bash
@@ -473,12 +470,9 @@ ensure the Agent has all the required permissions.
Configure the network bridges
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. warning:: This is a very important section, please make sure you read this
-thoroughly.
+.. warning:: This is a very important section, please make sure you read this thoroughly.
-.. note:: This section details how to configure bridges using the native
-implementation in Linux. Please refer to the next section if you intend
-to use OpenVswitch
+.. note:: This section details how to configure bridges using the native implementation in Linux. Please refer to the next section if you intend to use OpenVswitch
In order to forward traffic to your instances you will need at least two
bridges: *public* and *private*.
@@ -514,8 +508,7 @@ VLAN's:
On VLAN 100 we give the Hypervisor the IP-Address 192.168.42.11/24 with
the gateway 192.168.42.1
-.. note:: The Hypervisor and Management server don't have to be in the same
-subnet!
+.. note:: The Hypervisor and Management server don't have to be in the same subnet!
Configuring the network bridges
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -523,9 +516,7 @@ Configuring the network bridges
It depends on the distribution you are using how to configure these,
below you'll find examples for RHEL/CentOS and Ubuntu.
-.. note:: The goal is to have two bridges called 'cloudbr0' and 'cloudbr1' after
-this section. This should be used as a guideline only. The exact
-configuration will depend on your network layout.
+.. note:: The goal is to have two bridges called 'cloudbr0' and 'cloudbr1' after this section. This should be used as a guideline only. The exact configuration will depend on your network layout.
Configure in RHEL or CentOS
'''''''''''''''''''''''''''
@@ -639,9 +630,7 @@ We do the same for cloudbr1
With this configuration you should be able to restart the network,
although a reboot is recommended to see if everything works properly.
-.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the
-machine in case you made a configuration error and the network stops
-functioning!
+.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the machine in case you made a configuration error and the network stops functioning!
Configure in Ubuntu
'''''''''''''''''''
@@ -688,15 +677,12 @@ Modify the interfaces file to look like this:
With this configuration you should be able to restart the network,
although a reboot is recommended to see if everything works properly.
-.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the
-machine in case you made a configuration error and the network stops
-functioning!
+.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the machine in case you made a configuration error and the network stops functioning!
Configure the network using OpenVswitch
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. warning:: This is a very important section, please make sure you read this
-thoroughly.
+.. warning:: This is a very important section, please make sure you read this thoroughly.
In order to forward traffic to your instances you will need at least two
bridges: *public* and *private*.
@@ -745,8 +731,7 @@ VLAN's:
On VLAN 100 we give the Hypervisor the IP-Address 192.168.42.11/24 with
the gateway 192.168.42.1
-.. note:: The Hypervisor and Management server don't have to be in the same
-subnet!
+.. note:: The Hypervisor and Management server don't have to be in the same subnet!
Configuring the network bridges
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -754,9 +739,7 @@ Configuring the network bridges
It depends on the distribution you are using how to configure these,
below you'll find examples for RHEL/CentOS.
-.. note:: The goal is to have three bridges called 'mgmt0', 'cloudbr0' and
-'cloudbr1' after this section. This should be used as a guideline only.
-The exact configuration will depend on your network layout.
+.. note:: The goal is to have three bridges called 'mgmt0', 'cloudbr0' and 'cloudbr1' after this section. This should be used as a guideline only. The exact configuration will depend on your network layout.
Configure OpenVswitch
'''''''''''''''''''''
@@ -862,9 +845,7 @@ We now have to configure the three VLAN bridges:
With this configuration you should be able to restart the network,
although a reboot is recommended to see if everything works properly.
-.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the
-machine in case you made a configuration error and the network stops
-functioning!
+.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the machine in case you made a configuration error and the network stops functioning!
Configuring the firewall
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -959,8 +940,7 @@ To open the required ports, execute the following commands:
$ ufw allow proto tcp from any to any port 49152:49216
-.. note:: By default UFW is not enabled on Ubuntu. Executing these commands with
-the firewall disabled does not enable the firewall.
+.. note:: By default UFW is not enabled on Ubuntu. Executing these commands with the firewall disabled does not enable the firewall.
Add the host to CloudStack
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -976,85 +956,17 @@ Hypervisor Support for Primary Storage
The following table shows storage options and parameters for different
hypervisors.
-VMware vSphere
-
-Citrix XenServer
-
-KVM
-
-Hyper-V
-
-****Format for Disks, Templates, and Snapshots****
-
-VMDK
-
-VHD
-
-QCOW2
-
-VHD
-
-Snapshots are not supported.
-
-**iSCSI support**
-
-VMFS
-
-Clustered LVM
-
-Yes, via Shared Mountpoint
-
-No
-
-**Fiber Channel support**
-
-VMFS
-
-Yes, via Existing SR
-
-Yes, via Shared Mountpoint
-
-No
-
-**NFS support**
-
-Y
-
-Y
-
-Y
-
-No
-
-**Local storage support**
-
-Y
-
-Y
-
-Y
-
-Y
-
-**Storage over-provisioning**
-
-NFS and iSCSI
-
-NFS
-
-NFS
-
-No
-
-**SMB/CIFS**
-
-No
-
-No
-
-No
-
-Yes
+================================================== ============= ==================== ========================== =======
+Primary Storage Type vSphere XenServer KVM Hyper-V
+================================================== ============= ==================== ========================== =======
+****Format for Disks, Templates, and Snapshots**** VMDK VHD QCOW2 VHD
+**iSCSI support** VMFS CLVM Yes, via Shared Mountpoint No
+**Fiber Channel support** VMFS Yes, via Existing SR Yes, via Shared Mountpoint No
+**NFS support** Yes Yes Yes No
+**Local storage support** Yes Yes Yes Yes
+**Storage over-provisioning** NFS and iSCSI NFS NFS No
+**SMB/CIFS** No No No Yes
+================================================== ============= ==================== ========================== =======
XenServer uses a clustered LVM system to store VM images on iSCSI and
Fiber Channel volumes and does not support over-provisioning in the
@@ -1175,8 +1087,7 @@ System Requirements for XenServer Hosts
When you deploy CloudStack, the hypervisor host must not have any VMs
already running
-.. warning:: The lack of up-do-date hotfixes can lead to data corruption and lost
-VMs.
+.. warning:: The lack of up-do-date hotfixes can lead to data corruption and lost VMs.
XenServer Installation Steps
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1197,37 +1108,6 @@ XenServer Installation Steps
versions, you will need to create an account and look through the
download archives.
-#.
-
- After installation, perform the following configuration steps, which
- are described in the next few sections:
-
- Optional
-
- `Section 8.2.3, “Configure XenServer dom0
- Memory” <#config-xenserver-dom0-memory>`__
-
- `Section 8.2.7, “Install CloudStack XenServer Support Package
- (CSP)” <#xenserver-support-pkg-installation>`__
-
- `Section 8.2.4, “Username and
- Password” <#xenserver-username-password>`__
-
- Set up SR if not using NFS, iSCSI, or local disk; see `Section 8.2.8,
- “Primary Storage Setup for
- XenServer” <#xenserver-primary-storage-setup>`__
-
- `Section 8.2.5, “Time Synchronization” <#xenserver-time-sync>`__
-
- `Section 8.2.9, “iSCSI Multipath Setup for XenServer
- (Optional)” <#xenserver-iscsi-multipath-setup>`__
-
- `Section 8.2.6.1, “Getting and Deploying a
- License” <#xenserver-get-deploy-license>`__
-
- `Section 8.2.10, “Physical Networking Setup for
- XenServer” <#xenserver-physical-network-setup>`__
-
Configure XenServer dom0 Memory
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1813,8 +1693,7 @@ hosts. The actual upgrade is described in XenServer documentation, but
there are some additional steps you must perform before and after the
upgrade.
-.. note:: Be sure the hardware is certified compatible with the new version of
-XenServer.
+.. note:: Be sure the hardware is certified compatible with the new version of XenServer.
To upgrade XenServer:
@@ -1946,25 +1825,14 @@ To upgrade XenServer:
management server to this host, in the directory locations shown
below:
- Copy this Management Server file...
-
- ...to this location on the XenServer host
-
- /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver/xenserver60/NFSSR.py
-
- /opt/xensource/sm/NFSSR.py
-
- /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver/setupxenserver.sh
-
- /opt/xensource/bin/setupxenserver.sh
-
- /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver/make\_migratable.sh
-
- /opt/xensource/bin/make\_migratable.sh
-
- /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver/cloud-clean-vlan.sh
-
- /opt/xensource/bin/cloud-clean-vlan.sh
+ ================================================================================= =======================================
+ Copy this Management Server file To this location on the XenServer host
+ ================================================================================= =======================================
+ /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver/xenserver60/NFSSR.py /opt/xensource/sm/NFSSR.py
+ /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver/setupxenserver.sh /opt/xensource/bin/setupxenserver.sh
+ /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver/make\_migratable.sh /opt/xensource/bin/make\_migratable.sh
+ /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver/cloud-clean-vlan.sh /opt/xensource/bin/cloud-clean-vlan.sh
+ ================================================================================= =======================================
#.
@@ -1979,7 +1847,7 @@ To upgrade XenServer:
.. code:: bash
- mv: cannot stat `/etc/cron.daily/logrotate': No such file or directory
+ mv: cannot stat `/etc/cron.daily/logrotate`: No such file or directory
#.
@@ -1990,9 +1858,7 @@ To upgrade XenServer:
# for pbd in `xe pbd-list currently-attached=false| grep ^uuid | awk '{print $NF}'`; do xe pbd-plug uuid=$pbd ; done
- .. note:: If you add a host to this XenServer pool, you need to
- migrate all VMs on this host to other hosts, and eject this host
- from XenServer pool.
+ .. note:: If you add a host to this XenServer pool, you need to migrate all VMs on this host to other hosts, and eject this host from XenServer pool.
#.
@@ -2247,23 +2113,6 @@ Hyper-V Installation Steps
Add the domain user to the following groups on the Hyper-V host:
Hyper-V Administrators and Local Administrators.
-#.
-
- After installation, perform the following configuration tasks, which
- are described in the next few sections.
-
-Required
-
-Optional
-
-`Section 8.3.4, “Installing the CloudStack Agent on a Hyper-V
-Host” <#hyperv-agent-install>`__
-
-`Section 8.3.6, “Storage Preparation for Hyper-V
-(Optional)” <#hyperv-install-storage>`__
-
-`Section 8.3.5, “Physical Network Configuration for
-Hyper-V” <#hyperv-install-network>`__
Installing the CloudStack Agent on a Hyper-V Host
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -2279,9 +2128,7 @@ CloudStack Management Server communicates with Hyper-V Agent by using
HTTPS. For secure communication between the Management Server and the
host, install a self-signed certificate on port 8250.
-.. note:: The Agent installer automatically perform this operation. You have not
-selected this option during the Agent installation, it can also be done
-manually as given in step 1.
+.. note:: The Agent installer automatically perform this operation. You have not selected this option during the Agent installation, it can also be done manually as given in step 1.
#.
@@ -2408,11 +2255,7 @@ Software requirements:
hypervisor vendor is likely to refuse to support any system that is
not up to date with patches.
-Apply All Necessary Hotfixes
-----------------------------
-
-The lack of up-do-date hotfixes can lead to data corruption and lost
-VMs.
+.. warning:: Apply All Necessary Hotfixes. The lack of up-do-date hotfixes can lead to data corruption and lost VMs.
Hardware requirements:
^^^^^^^^^^^^^^^^^^^^^^
@@ -2457,8 +2300,8 @@ Hardware requirements:
Statically allocated IP Address
-vCenter Server requirements
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+vCenter Server requirements:
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
@@ -2581,74 +2424,38 @@ vCenter Checklist
You will need the following information about vCenter.
-vCenter Requirement
-
-Value
-
-Notes
-
-vCenter User
-
-This user must have admin privileges.
-
-vCenter User Password
-
-Password for the above user.
-
-vCenter Datacenter Name
-
-Name of the datacenter.
-
-vCenter Cluster Name
-
-Name of the cluster.
+======================== =====================================
+vCenter Requirement Notes
+======================== =====================================
+vCenter User This user must have admin privileges.
+vCenter User Password Password for the above user.
+vCenter Datacenter Name Name of the datacenter.
+vCenter Cluster Name Name of the cluster.
+======================== =====================================
Networking Checklist for VMware
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You will need the following information about VLAN.
-VLAN Information
-
-Value
-
-Notes
-
-ESXi VLAN
-
-VLAN on which all your ESXi hypervisors reside.
-
-ESXI VLAN IP Address
-
-IP Address Range in the ESXi VLAN. One address per Virtual Router is
-used from this range.
-
+============================ ==========================================================================================
+VLAN Information Notes
+============================ ==========================================================================================
+ESXi VLAN VLAN on which all your ESXi hypervisors reside.
+ESXI VLAN IP Address IP Address Range in the ESXi VLAN. One address per Virtual Router is used from this range.
ESXi VLAN IP Gateway
-
ESXi VLAN Netmask
-
-Management Server VLAN
-
-VLAN on which the CloudStack Management server is installed.
-
-Public VLAN
-
-VLAN for the Public Network.
-
+Management Server VLAN VLAN on which the CloudStack Management server is installed.
+Public VLAN VLAN for the Public Network.
Public VLAN Gateway
-
Public VLAN Netmask
+Public VLAN IP Address Range Range of Public IP Addresses available for CloudStack use. These
+ addresses will be used for virtual router on CloudStack to route private
+ traffic to external networks.
+VLAN Range for Customer use A contiguous range of non-routable VLANs. One VLAN will be assigned for
+ each customer.
+============================ ==========================================================================================
-Public VLAN IP Address Range
-
-Range of Public IP Addresses available for CloudStack use. These
-addresses will be used for virtual router on CloudStack to route private
-traffic to external networks.
-
-VLAN Range for Customer use
-
-A contiguous range of non-routable VLANs. One VLAN will be assigned for
-each customer.
vSphere Installation Steps
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -2665,23 +2472,14 @@ vSphere Installation Steps
Following installation, perform the following configuration, which
are described in the next few sections:
- Required
-
- Optional
-
- ESXi host setup
-
- NIC bonding
-
- Configure host physical networking, virtual switch, vCenter
- Management Network, and extended port range
-
- Multipath storage
-
+ ====================================================================================================== ===================
+ Required Optional
+ ====================================================================================================== ===================
+ ESXi host setup NIC bonding
+ Configure host physical networking,virtual switch, vCenter Management Network, and extended port range Multipath storage
Prepare storage for iSCSI
-
- Configure clusters in vCenter and add hosts to them, or add hosts
- without clusters to vCenter
+ Configure clusters in vCenter and add hosts to them, or add hosts without clusters to vCenter
+ ====================================================================================================== ===================
ESXi Host setup
~~~~~~~~~~~~~~~
@@ -2700,7 +2498,7 @@ to vCenter first. Once you see the host appearing in the vCenter
inventory tree, click the host node in the inventory tree, and navigate
to the Configuration tab.
-|vsphereclient.png: vSphere client|
+|vspherephysicalnetwork.png: vSphere client|
In the host configuration tab, click the "Hardware/Networking" link to
bring up the networking configuration page as above.
@@ -2737,12 +2535,12 @@ recommend setting it to 4088, the maximum number of ports allowed. To do
that, click the "Properties..." link for virtual switch (note this is
not the Properties link for Networking).
-|vsphereclient.png: vSphere client|
+|vsphereincreaseports.png: vSphere client|
In vSwitch properties dialog, select the vSwitch and click Edit. You
should see the following dialog:
-|vsphereclient.png: vSphere client|
+|vspherevswitchproperties.png: vSphere client|
In this dialog, you can change the number of switch ports. After you've
done that, ESXi hosts are required to reboot in order for the setting to
@@ -2757,7 +2555,7 @@ management network. CloudStack requires the vCenter management network
to be configured properly. Select the management network item in the
dialog, then click Edit.
-|vsphereclient.png: vSphere client|
+|vspheremgtnetwork.png: vSphere client|
Make sure the following values are set:
@@ -2930,32 +2728,17 @@ vCenter Credentials Checklist
You will need the following information about vCenter:
-Nexus vSwitch Requirements
-
-Value
-
-Notes
-
-vCenter IP
-
-The IP address of the vCenter.
+============================= ========= =============================================================================
+Nexus vSwitch Requirements Value Notes
+============================= ========= =============================================================================
+vCenter IP The IP address of the vCenter.
+Secure HTTP Port Number 443 Port 443 is configured by default; however, you can change the port if needed.
+vCenter User ID The vCenter user with administrator-level privileges. The vCenter User ID is
+ required when you configure the virtual switch in CloudStack.
+vCenter Password The password for the vCenter user specified above. The password for this
+ vCenter user is required when you configure the switch in CloudStack.
+============================= ========= =============================================================================
-Secure HTTP Port Number
-
-443
-
-Port 443 is configured by default; however, you can change the port if
-needed.
-
-vCenter User ID
-
-The vCenter user with administrator-level privileges. The vCenter User
-ID is required when you configure the virtual switch in CloudStack.
-
-vCenter Password
-
-The password for the vCenter user specified above. The password for this
-vCenter user is required when you configure the switch in CloudStack.
Network Configuration Checklist
'''''''''''''''''''''''''''''''
@@ -2964,30 +2747,16 @@ The following information specified in the Nexus Configure Networking
screen is displayed in the Details tab of the Nexus dvSwitch in the
CloudStack UI:
-Network Requirements
-
-Value
-
-Notes
-
-Control Port Group VLAN ID
-
-The VLAN ID of the Control Port Group. The control VLAN is used for
-communication between the VSM and the VEMs.
-
-Management Port Group VLAN ID
+**Control Port Group VLAN ID**
+ The VLAN ID of the Control Port Group. The control VLAN is used for communication between the VSM and the VEMs.
-The VLAN ID of the Management Port Group. The management VLAN
-corresponds to the mgmt0 interface that is used to establish and
-maintain the connection between the VSM and VMware vCenter Server.
+**Management Port Group VLAN ID**
+ The VLAN ID of the Management Port Group. The management VLAN corresponds to the mgmt0 interface that is used to establish and maintain the connection between the VSM and VMware vCenter Server.
-Packet Port Group VLAN ID
+**Packet Port Group VLAN ID**
+ The VLAN ID of the Packet Port Group. The packet VLAN forwards relevant data packets from the VEMs to the VSM.
-The VLAN ID of the Packet Port Group. The packet VLAN forwards relevant
-data packets from the VEMs to the VSM.
-
-.. note:: The VLANs used for control, packet, and management port groups can be
-the same.
+.. note:: The VLANs used for control, packet, and management port groups can be the same.
For more information, see `Cisco Nexus 1000V Getting Started
Guide <http://www.cisco.com/en/US/docs/switches/datacenter/nexus1000/sw/4_2_1_s_v_1_4_b/getting_started/configuration/guide/n1000v_gsg.pdf>`__.
@@ -2995,30 +2764,14 @@ Guide <http://www.cisco.com/en/US/docs/switches/datacenter/nexus1000/sw/4_2_1_s_
VSM Configuration Checklist
'''''''''''''''''''''''''''
-You will need the following information about network configuration:
-
-VSM Configuration Parameters Value Notes
-
-Value
-
-Notes
-
-Admin Name and Password
-
-The admin name and password to connect to the VSM appliance. You must
-specify these credentials while configuring Nexus virtual switch.
-
-Management IP Address
-
-This is the IP address of the VSM appliance. This is the IP address you
-specify in the virtual switch IP Address field while configuting Nexus
-virtual switch.
-
-SSL
-
-Enable
+You will need the following VSM configuration parameters:
-Always enable SSL. SSH is usually enabled by default during the VSM
+**Admin Name and Password**
+ The admin name and password to connect to the VSM appliance. You must specify these credentials while configuring Nexus virtual switch.
+**Management IP Address**
+ This is the IP address of the VSM appliance. This is the IP address you specify in the virtual switch IP Address field while configuting Nexus virtual switch.
+**SSL**
+ Should be set to Enable.Always enable SSL. SSH is usually enabled by default during the VSM
installation. However, check whether the SSH connection to the VSM is
working, without which CloudStack failes to connect to the VSM.
@@ -3066,7 +2819,7 @@ Creating a Port Profile
traffic. The physical networks configured during zone creation should
have a one-to-one relation with the Ethernet port profiles.
-|vsphereclient.png: vSphere client|
+|vmwarenexusportprofile.png: vSphere client|
For information on creating a port profile, see `Cisco Nexus 1000V Port
Profile Configuration
@@ -3107,8 +2860,7 @@ In this example, the allowed VLANs added are 1, 140-147, and 196-203
You must also add all the public and private VLANs or VLAN ranges to the
switch. This range is the VLAN range you specify in your zone.
-.. note:: Before you run the vlan command, ensure that the configuration mode is
-enabled in Nexus 1000v virtual switch.
+.. note:: Before you run the vlan command, ensure that the configuration mode is enabled in Nexus 1000v virtual switch.
For example:
@@ -3153,7 +2905,7 @@ Configuring Nexus 1000v Virtual Switch in CloudStack
You can configure Nexus dvSwitch by adding the necessary resources while
the zone is being created.
-|vsphereclient.png: vSphere client|
+|vmwarenexusaddcluster.png: vmware nexus add cluster|
After the zone is created, if you want to create an additional cluster
along with Nexus 1000v virtual switch in the existing zone, use the Add
@@ -3163,45 +2915,19 @@ Cluster option. For information on creating a cluster, see
In both these cases, you must specify the following parameters to
configure Nexus virtual switch:
-Parameters
+========================= =======================================================================================================================
+Parameters Description
+========================= =======================================================================================================================
+Cluster Name Enter the name of the cluster you created in vCenter. For example,"cloud.cluster".
+vCenter Host Enter the host name or the IP address of the vCenter host where you have deployed the Nexus virtual switch.
+vCenter User name Enter the username that CloudStack should use to connect to vCenter. This user must have all administrative privileges.
+vCenter Password Enter the password for the user named above.
+vCenter Datacenter Enter the vCenter datacenter that the cluster is in. For example, "cloud.dc.VM".
+Nexus dvSwitch IP Address The IP address of the VSM component of the Nexus 1000v virtual switch.
+Nexus dvSwitch Username The admin name to connect to the VSM appliance.
+Nexus dvSwitch Password The corresponding password for the admin user specified above.
+========================= =======================================================================================================================
-Description
-
-Cluster Name
-
-Enter the name of the cluster you created in vCenter. For example,
-"cloud.cluster".
-
-vCenter Host
-
-Enter the host name or the IP address of the vCenter host where you have
-deployed the Nexus virtual switch.
-
-vCenter User name
-
-Enter the username that CloudStack should use to connect to vCenter.
-This user must have all administrative privileges.
-
-vCenter Password
-
-Enter the password for the user named above.
-
-vCenter Datacenter
-
-Enter the vCenter datacenter that the cluster is in. For example,
-"cloud.dc.VM".
-
-Nexus dvSwitch IP Address
-
-The IP address of the VSM component of the Nexus 1000v virtual switch.
-
-Nexus dvSwitch Username
-
-The admin name to connect to the VSM appliance.
-
-Nexus dvSwitch Password
-
-The corresponding password for the admin user specified above.
Removing Nexus Virtual Switch
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -3353,62 +3079,46 @@ The possible values for traffic labels are:
dvSwitch0,,vmwaredvs
-Fields
-Name
+The three fields to fill in are:
-Description
+-
-1
+ Name of the virtual / distributed virtual switch at vCenter.
-Represents the name of the virtual / distributed virtual switch at
-vCenter.
+ The default value depends on the type of virtual switch:
-The default value depends on the type of virtual switch:
+ **vSwitch0**: If type of virtual switch is VMware vNetwork Standard virtual switch
-**vSwitch0**: If type of virtual switch is VMware vNetwork Standard
-virtual switch
+ **dvSwitch0**: If type of virtual switch is VMware vNetwork Distributed virtual switch
-**dvSwitch0**: If type of virtual switch is VMware vNetwork Distributed
-virtual switch
+ **epp0**: If type of virtual switch is Cisco Nexus 1000v Distributed virtual switch
-**epp0**: If type of virtual switch is Cisco Nexus 1000v Distributed
-virtual switch
+-
-2
+ VLAN ID to be used for this traffic wherever applicable.
-VLAN ID to be used for this traffic wherever applicable.
+ This field would be used for only public traffic as of now. In case of guest traffic this field would be ignored and could be left empty for guest traffic. By default empty string would be assumed which translates to untagged VLAN for that specific traffic type.
-This field would be used for only public traffic as of now. In case of
-guest traffic this field would be ignored and could be left empty for
-guest traffic. By default empty string would be assumed which translates
-to untagged VLAN for that specific traffic type.
+-
-3
+ Type of virtual switch. Specified as string.
-Type of virtual switch. Specified as string.
+ Possible valid values are vmwaredvs, vmwaresvs, nexusdvs.
-Possible valid values are vmwaredvs, vmwaresvs, nexusdvs.
+ **vmwaresvs**: Represents VMware vNetwork Standard virtual switch
-**vmwaresvs**: Represents VMware vNetwork Standard virtual switch
+ **vmwaredvs**: Represents VMware vNetwork distributed virtual switch
-**vmwaredvs**: Represents VMware vNetwork distributed virtual switch
+ **nexusdvs**: Represents Cisco Nexus 1000v distributed virtual switch.
-**nexusdvs**: Represents Cisco Nexus 1000v distributed virtual switch.
+ If nothing specified (left empty), zone-level default virtual switchwould be defaulted, based on the value of global parameter you specify.
-If nothing specified (left empty), zone-level default virtual switch
-would be defaulted, based on the value of global parameter you specify.
+ Following are the global configuration parameters:
-Following are the global configuration parameters:
+ **vmware.use.dvswitch**: Set to true to enable any kind (VMware DVS and Cisco Nexus 1000v) of distributed virtual switch in a CloudStack deployment. If set to false, the virtual switch that can be used in that CloudStack deployment is Standard virtual switch.
-**vmware.use.dvswitch**: Set to true to enable any kind (VMware DVS and
-Cisco Nexus 1000v) of distributed virtual switch in a CloudStack
-deployment. If set to false, the virtual switch that can be used in that
-CloudStack deployment is Standard virtual switch.
-
-**vmware.use.nexus.vswitch**: This parameter is ignored if
-vmware.use.dvswitch is set to false. Set to true to enable Cisco Nexus
-1000v distributed virtual switch in a CloudStack deployment.
+ **vmware.use.nexus.vswitch**: This parameter is ignored if vmware.use.dvswitch is set to false. Set to true to enable Cisco Nexus 1000v distributed virtual switch in a CloudStack deployment.
Enabling Virtual Distributed Switch in CloudStack
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -3447,67 +3157,22 @@ configure VDS:
|dvSwitchConfig.png: Configuring dvSwitch|
-Parameters
-
-Description
-
-Cluster Name
-
-Enter the name of the cluster you created in vCenter. For example,
-"cloudcluster".
+================================= ===================================================================================================================
+Parameters Description
+================================= ===================================================================================================================
+Cluster Name Enter the name of the cluster you created in vCenter. For example, "cloudcluster".
+vCenter Host Enter the name or the IP address of the vCenter host where you have deployed the VMware VDS.
+vCenter User name Enter the username that CloudStack should use to connect to vCenter. This user must have all administrative privileges.
+vCenter Password Enter the password for the user named above.
+vCenter Datacenter Enter the vCenter datacenter that the cluster is in. For example, "clouddcVM".
+Override Public Traffic Enable this option to override the zone-wide public traffic for the cluster you are creating.
+Public Traffic vSwitch Type This option is displayed only if you enable the Override Public Traffic option. Select VMware vNetwork Distributed Virtual Switch. If the vmware.use.dvswitch global parameter is true, the default option will be VMware vNetwork Distributed Virtual Switch.
+Public Traffic vSwitch Name Name of virtual switch to be used for the public traffic.
+Override Guest Traffic Enable the option to override the zone-wide guest traffic for the cluster you are creating.
+Guest Traffic vSwitch Type This option is displayed only if you enable the Override Guest Traffic option. Select VMware vNetwork Distributed Virtual Switch. If the vmware.use.dvswitch global parameter is true, the default option will be VMware vNetwork Distributed Virtual Switch.
+Guest Traffic vSwitch Name Name of virtual switch to be used for guest traffic.
+================================= ===================================================================================================================
-vCenter Host
-
-Enter the name or the IP address of the vCenter host where you have
-deployed the VMware VDS.
-
-vCenter User name
-
-Enter the username that CloudStack should use to connect to vCenter.
-This user must have all administrative privileges.
-
-vCenter Password
-
-Enter the password for the user named above.
-
-vCenter Datacenter
-
-Enter the vCenter datacenter that the cluster is in. For example,
-"clouddcVM".
-
-Override Public Traffic
-
-Enable this option to override the zone-wide public traffic for the
-cluster you are creating.
-
-Public Traffic vSwitch Type
-
-This option is displayed only if you enable the Override Public Traffic
-option. Select VMware vNetwork Distributed Virtual Switch.
-
-If the vmware.use.dvswitch global parameter is true, the default option
-will be VMware vNetwork Distributed Virtual Switch.
-
-Public Traffic vSwitch Name
-
-Name of virtual switch to be used for the public traffic.
-
-Override Guest Traffic
-
-Enable the option to override the zone-wide guest traffic for the
-cluster you are creating.
-
-Guest Traffic vSwitch Type
-
-This option is displayed only if you enable the Override Guest Traffic
-option. Select VMware vNetwork Distributed Virtual Switch.
-
-If the vmware.use.dvswitch global parameter is true, the default option
-will be VMware vNetwork Distributed Virtual Switch.
-
-Guest Traffic vSwitch Name
-
-Name of virtual switch to be used for guest traffic.
Storage Preparation for vSphere (iSCSI only)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -3525,19 +3190,19 @@ Enable iSCSI initiator for ESXi hosts
In vCenter, go to hosts and Clusters/Configuration, and click Storage
Adapters link. You will see:
- |vsphereclient.png: vSphere client|
+ |vmwareiscsiinitiator.png: iscsi initiator|
#.
Select iSCSI software adapter and click Properties.
- |vsphereclient.png: vSphere client|
+ |vmwareiscsiinitiatorproperties.png: iscsi initiator properties|
#.
Click the Configure... button.
- |vsphereclient.png: vSphere client|
+ |vmwareiscsigeneral.png: iscsi general|
#.
@@ -3552,8 +3217,8 @@ Add iSCSI target
Under the properties dialog, add the iSCSI target info:
-|vsphereclient.png: vSphere client|
-
+|vmwareiscsitargetadd.png: iscsi target add|
+
Repeat these steps for all ESXi hosts in the cluster.
Create an iSCSI datastore
@@ -3580,7 +3245,7 @@ You should now create a VMFS datastore. Follow these steps to do so:
This procedure should be done on one host in the cluster. It is not
necessary to do this on all hosts.
-|vsphereclient.png: vSphere client|
+|vmwareiscsidatastore.png: iscsi datastore|
Multipathing for vSphere (Optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -3753,11 +3418,9 @@ to the KVM installation. The material in this section doesn't duplicate
KVM installation docs. It provides the CloudStack-specific steps that
are needed to prepare a KVM host to work with CloudStack.
-.. warning:: Before continuing, make sure that you have applied the latest updates to
-your host.
+.. warning:: Before continuing, make sure that you have applied the latest updates to your host.
-.. warning:: It is NOT recommended to run services on this host not controlled by
-CloudStack.
+.. warning:: It is NOT recommended to run services on this host not controlled by CloudStack.
The procedure for installing an LXC Host is:
@@ -3935,7 +3598,7 @@ cloudstack-agent and should already be installed.
On Ubuntu: modify ``/etc/default/libvirt-bin``
- Add "-l" to the following line::
+ Add "-l" to the following line
.. code:: bash
@@ -4069,12 +3732,9 @@ ensure the Agent has all the required permissions.
Configure the network bridges
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. warning:: This is a very important section, please make sure you read this
-thoroughly.
+.. warning:: This is a very important section, please make sure you read this thoroughly.
-.. note:: This section details how to configure bridges using the native
-implementation in Linux. Please refer to the next section if you intend
-to use OpenVswitch
+.. note:: This section details how to configure bridges using the native implementation in Linux. Please refer to the next section if you intend to use OpenVswitch
In order to forward traffic to your instances you will need at least two
bridges: *public* and *private*.
@@ -4110,8 +3770,7 @@ VLAN's:
On VLAN 100 we give the Hypervisor the IP-Address 192.168.42.11/24 with
the gateway 192.168.42.1
-.. note:: The Hypervisor and Management server don't have to be in the same
-subnet!
+.. note:: The Hypervisor and Management server don't have to be in the same subnet!
Configuring the network bridges
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -4119,9 +3778,7 @@ Configuring the network bridges
It depends on the distribution you are using how to configure these,
below you'll find examples for RHEL/CentOS and Ubuntu.
-.. note:: The goal is to have two bridges called 'cloudbr0' and 'cloudbr1' after
-this section. This should be used as a guideline only. The exact
-configuration will depend on your network layout.
+.. note:: The goal is to have two bridges called 'cloudbr0' and 'cloudbr1' after this section. This should be used as a guideline only. The exact configuration will depend on your network layout.
Configure in RHEL or CentOS
'''''''''''''''''''''''''''
@@ -4235,9 +3892,7 @@ We do the same for cloudbr1
With this configuration you should be able to restart the network,
although a reboot is recommended to see if everything works properly.
-.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the
-machine in case you made a configuration error and the network stops
-functioning!
+.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the machine in case you made a configuration error and the network stops functioning!
Configure in Ubuntu
'''''''''''''''''''
@@ -4284,9 +3939,7 @@ Modify the interfaces file to look like this:
With this configuration you should be able to restart the network,
although a reboot is recommended to see if everything works properly.
-.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the
-machine in case you made a configuration error and the network stops
-functioning!
+.. warning:: Make sure you have an alternative way like IPMI or ILO to reach the machine in case you made a configuration error and the network stops functioning!
Configuring the firewall
~~~~~~~~~~~~~~~~~~~~~~~~
@@ -4405,6 +4058,17 @@ the host!
.. |change-password.png: button to change a user's password| image:: ./_static/images/change-password.png
.. |provisioning-overview.png: Conceptual overview of a basic deployment| image:: ./_static/images/provisioning-overview.png
.. |vsphereclient.png: vSphere client| image:: ./_static/images/vsphere-client.png
+.. |vspherephysicalnetwork.png: vSphere client| image:: ./_static/images/vmware-physical-network.png
+.. |vsphereincreaseports.png: vSphere client| image:: ./_static/images/vmware-increase-ports.png
+.. |vspherevswitchproperties.png: vSphere client| image:: ./_static/images/vmware-vswitch-properties.png
+.. |vspheremgtnetwork.png: vSphere client| image:: ./_static/images/vmware-mgt-network-properties.png
+.. |vmwarenexusportprofile.png: vSphere client| image:: ./_static/images/vmware-nexus-port-profile.png
+.. |vmwarenexusaddcluster.png: vmware nexus add cluster| image:: ./_static/images/vmware-nexus-add-cluster.png
+.. |vmwareiscsiinitiator.png: iscsi initiator| image:: ./_static/images/vmware-iscsi-initiator.png
+.. |vmwareiscsiinitiatorproperties.png: iscsi initiator properties| image:: ./_static/images/vmware-iscsi-initiator-properties.png
+.. |vmwareiscsigeneral.png: iscsi general| image:: ./_static/images/vmware-iscsi-general.png
+.. |vmwareiscsitargetadd.png: iscsi target add| image:: ./_static/images/vmware-iscsi-target-add.png
+.. |vmwareiscsidatastore.png: iscsi datastore| image:: ./_static/images/vmware-iscsi-datastore.png
.. |addcluster.png: add a cluster| image:: ./_static/images/add-cluster.png
.. |ConsoleButton.png: button to launch a console| image:: ./_static/images/console-icon.png
.. |DeleteButton.png: button to delete dvSwitch| image:: ./_static/images/delete-button.png
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/index.rst
----------------------------------------------------------------------
diff --git a/source/index.rst b/source/index.rst
index 46a6b39..f36663f 100644
--- a/source/index.rst
+++ b/source/index.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
@@ -95,6 +94,13 @@ Choosing a Deployment Architecture
choosing_deployment_architecture
+Choosing a Hypervisor
+----------------------
+.. toctree::
+ :maxdepth: 2
+
+ choosing_hypervisor
+
Amazon Web Services Interface
-----------------------------
.. toctree::
@@ -137,4 +143,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
-
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/installation.rst
----------------------------------------------------------------------
diff --git a/source/installation.rst b/source/installation.rst
index 3e68a98..b3dd5ed 100644
--- a/source/installation.rst
+++ b/source/installation.rst
@@ -369,11 +369,11 @@ node.
::
- yum install ntp
+ yum install ntp
::
- apt-get install openntpd
+ apt-get install openntpd
#.
@@ -387,9 +387,7 @@ The first step in installation, whether you are installing the
Management Server on one host or many, is to install the software on a
single node.
-.. note:: If you are planning to install the Management Server on multiple nodes
-for high availability, do not proceed to the additional nodes yet. That
-step will come later.
+.. note:: If you are planning to install the Management Server on multiple nodes for high availability, do not proceed to the additional nodes yet. That step will come later.
The CloudStack Management server can be installed using either RPM or
DEB packages. These packages will depend on everything you need to run
@@ -420,11 +418,9 @@ installed on the hypervisor hosts.
Before setting up the Management Server, download vhd-util from
`vhd-util <http://download.cloud.com.s3.amazonaws.com/tools/vhd-util>`__.
-If the Management Server is RHEL or CentOS, copy vhd-util to
-/usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver.
+If the Management Server is RHEL or CentOS, copy vhd-util to `/usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver`
-If the Management Server is Ubuntu, copy vhd-util to
-/usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver.
+If the Management Server is Ubuntu, copy vhd-util to `/usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver`
Install the database server
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -454,11 +450,11 @@ Node” <#management-server-install-db-external>`__.
::
- yum install mysql-server
+ yum install mysql-server
::
- apt-get install mysql-server
+ apt-get install mysql-server
#.
@@ -505,13 +501,13 @@ Node” <#management-server-install-db-external>`__.
(CentOS and RHEL only; not required on Ubuntu)
-.. warning:: On RHEL and CentOS, MySQL does not set a root password by default. It is very strongly recommended that you set a root password as a security precaution.
+ .. warning:: On RHEL and CentOS, MySQL does not set a root password by default. It is very strongly recommended that you set a root password as a security precaution.
-Run the following command to secure your installation. You can answer "Y" to all questions.
+ Run the following command to secure your installation. You can answer "Y" to all questions.
-::
+ ::
- mysql_secure_installation
+ mysql_secure_installation
#.
@@ -562,7 +558,7 @@ Run the following command to secure your installation. You can answer "Y" to all
Set SELinux to permissive starting immediately, without requiring
a system reboot.
- ::
+ ::
$ setenforce permissive
@@ -626,7 +622,7 @@ Run the following command to secure your installation. You can answer "Y" to all
When this script is finished, you should see a message like
“Successfully initialized the database.”
-.. note:: If the script is unable to connect to the MySQL database, check the "localhost" loopback address in ``/etc/hosts``. It should be pointing to the IPv4 loopback address "127.0.0.1" and not the IPv6 loopback address ::1. Alternatively, reconfigure MySQL to bind to the IPv6 loopback interface.
+ .. note:: If the script is unable to connect to the MySQL database, check the "localhost" loopback address in ``/etc/hosts``. It should be pointing to the IPv4 loopback address "127.0.0.1" and not the IPv6 loopback address ::1. Alternatively, reconfigure MySQL to bind to the IPv6 loopback interface.
#.
@@ -715,9 +711,9 @@ Management Server Node” <#management-server-install-db-local>`__.
(CentOS and RHEL only; not required on Ubuntu)
-.. warning:: On RHEL and CentOS, MySQL does not set a root password by default. It is very strongly recommended that you set a root password as a security precaution. Run the following command to secure your installation. You can answer "Y" to all questions except "Disallow root login remotely?". Remote root login is required to set up the databases.
+ .. warning:: On RHEL and CentOS, MySQL does not set a root password by default. It is very strongly recommended that you set a root password as a security precaution. Run the following command to secure your installation. You can answer "Y" to all questions except "Disallow root login remotely?". Remote root login is required to set up the databases.
-::
+ ::
mysql_secure_installation
@@ -740,7 +736,7 @@ Management Server Node” <#management-server-install-db-local>`__.
Edit the /etc/sysconfig/iptables file and add the following line
at the beginning of the INPUT chain.
- ::
+ ::
-A INPUT -p tcp --dport 3306 -j ACCEPT
@@ -748,7 +744,7 @@ Management Server Node” <#management-server-install-db-local>`__.
Now reload the iptables rules.
- ::
+ ::
service iptables restart
@@ -948,9 +944,7 @@ Cloud Infrastructure Overview). Both of these can be NFS shares. This
section tells how to set up the NFS shares before adding the storage to
CloudStack.
-NFS is not the only option for primary or secondary storage. For
-example, you may use Ceph RBD, GlusterFS, iSCSI, and others. The choice
-of storage system will depend on the choice of hypervisor and whether
+.. note:: NFS is not the only option for primary or secondary storage. For example, you may use Ceph RBD, GlusterFS, iSCSI, and others. The choice of storage system will depend on the choice of hypervisor and whether
you are dealing with primary or secondary storage.
The requirements for primary and secondary storage are described in:
@@ -1184,7 +1178,7 @@ operating system version.
Be sure NFS and rpcbind are running. The commands might be
different depending on your OS. For example:
- ::
+ ::
# service rpcbind start
# service nfs start
@@ -1198,7 +1192,7 @@ operating system version.
directories. For example, substitute your own management server
name:
- ::
+ ::
# mkdir /primary
# mount -t nfs <management-server-name>:/export/primary
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/optional_installation.rst
----------------------------------------------------------------------
diff --git a/source/optional_installation.rst b/source/optional_installation.rst
index 2be7c11..387c86f 100644
--- a/source/optional_installation.rst
+++ b/source/optional_installation.rst
@@ -49,7 +49,7 @@ Steps to Install the Usage Server
#.
- Run ./install.sh.
+ Run ./install.sh (NOT VALID, NEED CORRECTION)
.. code:: bash
@@ -102,8 +102,7 @@ standby node that receives all write operations from the master and
applies them to a local, redundant copy of the database. The following
steps are a guide to implementing MySQL replication.
-.. note:: Creating a replica is not a backup solution. You should develop a backup
-procedure for the MySQL data that is distinct from replication.
+.. note:: Creating a replica is not a backup solution. You should develop a backup procedure for the MySQL data that is distinct from replication.
#.
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/09182f65/source/ui.rst
----------------------------------------------------------------------
diff --git a/source/ui.rst b/source/ui.rst
index c247531..d2c8abe 100644
--- a/source/ui.rst
+++ b/source/ui.rst
@@ -257,12 +257,7 @@ call to the cloudstack api.
For example, make a call from the cloudstack server to create a SSH
keypair called "keypair-doc" for the admin account in the root domain:
-Note
-
-
-Ensure that you adjust these values to meet your needs. If you are
-making the API call from a different server, your URL/PORT will be
-different, and you will need to use the API keys.
+.. note:: Ensure that you adjust these values to meet your needs. If you are making the API call from a different server, your URL/PORT will be different, and you will need to use the API keys.
#.
[2/2] git commit: fixes everywhere
Posted by se...@apache.org.
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 <ru...@gmail.com>
Authored: Fri Feb 7 15:24:16 2014 +0100
Committer: Sebastien Goasguen <ru...@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.
-