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/24 20:03:05 UTC
[3/3] git commit: lots of cleanup of the admin guide
lots of cleanup of the admin guide
Project: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/commit/767f408f
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/tree/767f408f
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/diff/767f408f
Branch: refs/heads/master
Commit: 767f408f1b212f9fd8a9c94b564bc9d2ef287644
Parents: 077f90f
Author: Sebastien Goasguen <ru...@gmail.com>
Authored: Mon Feb 24 14:02:43 2014 -0500
Committer: Sebastien Goasguen <ru...@gmail.com>
Committed: Mon Feb 24 14:02:43 2014 -0500
----------------------------------------------------------------------
source/accounts.rst | 226 ++--
source/events.rst | 1053 +-----------------
source/index.rst | 35 +-
source/management.rst | 123 ++-
source/parameters.rst | 375 -------
source/projects.rst | 93 +-
source/provisioning.rst | 2176 -------------------------------------
source/reliability.rst | 98 +-
source/service_offerings.rst | 46 +-
source/systemvm.rst | 42 +-
source/troubleshooting.rst | 409 -------
source/tuning.rst | 4 +-
source/ui.rst | 90 +-
source/usage.rst | 743 +++++++++++--
14 files changed, 1130 insertions(+), 4383 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/767f408f/source/accounts.rst
----------------------------------------------------------------------
diff --git a/source/accounts.rst b/source/accounts.rst
index be12676..a223b62 100644
--- a/source/accounts.rst
+++ b/source/accounts.rst
@@ -21,14 +21,14 @@ Accounts, Users, and Domains
---------------------------------
Accounts
-''''''''
+~~~~~~~~
An account typically represents a customer of the service provider or a
department in a large organization. Multiple users can exist in an
account.
Domains
-'''''''
+~~~~~~~
Accounts are grouped by domains. Domains usually contain multiple
accounts that have some logical relationship to each other and a set of
@@ -41,7 +41,7 @@ types of user accounts: root administrator, domain administrator, and
user.
Users
-'''''
+~~~~~
Users are like aliases in the account. Users in the same account are not
isolated from each other, but they are isolated from users in other
@@ -60,21 +60,21 @@ or delete other administrators, and change the password for any user in
the system.
Domain Administrators
-'''''''''''''''''''''
+~~~~~~~~~~~~~~~~~~~~~~
Domain administrators can perform administrative operations for users
who belong to that domain. Domain administrators do not have visibility
into physical servers or other domains.
Root Administrator
-''''''''''''''''''
+~~~~~~~~~~~~~~~~~~~
Root administrators have complete access to the system, including
managing templates, service offerings, customer care administrators, and
domains
Resource Ownership
-''''''''''''''''''
+~~~~~~~~~~~~~~~~~~~
Resources belong to the account, not individual users in that account.
For example, billing, resource limits, and so on are maintained by the
@@ -87,7 +87,7 @@ administrator can do the same for VMs within the domain from one account
to any other account in the domain or any of its sub-domains.
Dedicating Resources to Accounts and Domains
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------------------------
The root administrator can dedicate resources to a specific domain or
account that needs private infrastructure for additional security or
@@ -120,7 +120,7 @@ There are several types of dedication available:
shared infrastructure.
How to Dedicate a Zone, Cluster, Pod, or Host to an Account or Domain
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+----------------------------------------------------------------------
For explicit dedication: When deploying a new zone, pod, cluster, or
host, the root administrator can click the Dedicated checkbox, then
@@ -140,17 +140,17 @@ resources are not available. Whenever a user creates a VM based on this
service offering, it is allocated on one of the dedicated hosts.
How to Use Dedicated Hosts
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
To use an explicitly dedicated host, use the explicit-dedicated type of
-affinity group (see `Section 10.7.1, “Affinity
+affinity group (see `“Affinity
Groups” <#affinity-groups>`__). For example, when creating a new VM, an
end user can choose to place it on dedicated infrastructure. This
operation will succeed only if some infrastructure has already been
assigned as dedicated to the user's account or domain.
Behavior of Dedicated Hosts, Clusters, Pods, and Zones
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The administrator can live migrate VMs away from dedicated hosts if
desired, whether the destination is a host reserved for a different
@@ -180,85 +180,181 @@ with system VMs or virtual routers can be used for preferred implicit
dedication.
Using an LDAP Server for User Authentication
-'''''''''''''''''''''''''''''''''''''''''''''''''
-
-You can use an external LDAP server such as Microsoft Active Directory or
-OpenLDAP to authentication Cloudstack end users.
-
-In order to do this you must:
+-------------------------------------------------
+
+You can use an external LDAP server such as Microsoft Active Directory
+or ApacheDS to authenticate CloudStack end-users. Just map CloudStack
+accounts to the corresponding LDAP accounts using a query filter. The
+query filter is written using the query syntax of the particular LDAP
+server, and can include special wildcard characters provided by
+CloudStack for matching common values such as the user’s email address
+and name. CloudStack will search the external LDAP directory tree
+starting at a specified base directory and return the distinguished name
+(DN) and password of the matching user. This information along with the
+given password is used to authenticate the user..
To set up LDAP authentication in CloudStack, call the CloudStack API
command ldapConfig and provide the following:
-- Set your LDAP configuration within Cloudstack
-- Create Cloudstack accounts for LDAP Users
+-
-To setup LDAP authentication in Cloudstack, open the global settings page and
-search for LDAP.
+ Hostname or IP address and listening port of the LDAP server
-Set ldap.base to match your servers base directory.
+-
-Review the defaults for the following and ensure they match your schema:
+ Base directory and query filter
- - ldap.email.attribute
- - ldap.firstname.attribute
- - ldap.lastname.attribute
- - ldap.username.attribute
- - ldap.user.object
+-
-Optionally you can set the following:
+ Search user DN credentials, which give CloudStack permission to
+ search on the LDAP server
--
+-
- If you do not want to use anonymous binding you can set ldap.bind.principle
- and ldap.bind.password as credentials for your LDAP server that will grant
- Cloudstack permission to perform a search on the LDAP server.
+ SSL keystore and password, if SSL is used
--
+Example LDAP Configuration Commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- For SSL support set ldap.truststore to a path on the file system where your
- trusted store is located. Along with this set ldap.truststore.password as
- the password that unlocks the truststore.
+To understand the examples in this section, you need to know the basic
+concepts behind calling the CloudStack API, which are explained in the
+Developer’s Guide.
--
+The following shows an example invocation of ldapConfig with an ApacheDS
+LDAP server
+
+.. code:: bash
+
+ http://127.0.0.1:8080/client/api?command=ldapConfig&hostname=127.0.0.1&searchbase=ou%3Dtesting%2Co%3Dproject&queryfilter=%28%26%28uid%3D%25u%29%29&binddn=cn%3DJohn+Singh%2Cou%3Dtesting%2Co%project&bindpass=secret&port=10389&ssl=true&truststore=C%3A%2Fcompany%2Finfo%2Ftrusted.ks&truststorepass=secret&response=json&apiKey=YourAPIKey&signature=YourSignatureHash
+
+The command must be URL-encoded. Here is the same example without the
+URL encoding:
+
+.. code:: bash
+
+ http://127.0.0.1:8080/client/api?command=ldapConfig
+ &hostname=127.0.0.1
+ &searchbase=ou=testing,o=project
+ &queryfilter=(&(%uid=%u))
+ &binddn=cn=John+Singh,ou=testing,o=project
+ &bindpass=secret
+ &port=10389
+ &ssl=true
+ &truststore=C:/company/info/trusted.ks
+ &truststorepass=secret
+ &response=json
+ &apiKey=YourAPIKey&signature=YourSignatureHash
+
+The following shows a similar command for Active Directory. Here, the
+search base is the testing group within a company, and the users are
+matched up based on email address.
+
+.. code:: bash
+
+ http://10.147.29.101:8080/client/api?command=ldapConfig&hostname=10.147.28.250&searchbase=OU%3Dtesting%2CDC%3Dcompany&queryfilter=%28%26%28mail%3D%25e%29%29 &binddn=CN%3DAdministrator%2COU%3Dtesting%2CDC%3Dcompany&bindpass=1111_aaaa&port=389&response=json&apiKey=YourAPIKey&signature=YourSignatureHash
+
+The next few sections explain some of the concepts you will need to know
+when filling out the ldapConfig parameters.
+
+Search Base
+~~~~~~~~~~~~~~~~~~
+
+An LDAP query is relative to a given node of the LDAP directory tree,
+called the search base. The search base is the distinguished name (DN)
+of a level of the directory tree below which all users can be found. The
+users can be in the immediate base directory or in some subdirectory.
+The search base may be equivalent to the organization, group, or domain
+name. The syntax for writing a DN varies depending on which LDAP server
+you are using. A full discussion of distinguished names is outside the
+scope of our documentation. The following table shows some examples of
+search bases to find users in the testing department..
+
+LDAP Server
+
+Example Search Base DN
+
+ApacheDS
+
+ou=testing,o=project
+
+Active Directory
+
+OU=testing, DC=company
+
+Query Filter
+~~~~~~~~~~~~~~~~~~~
+
+The query filter is used to find a mapped user in the external LDAP
+server. The query filter should uniquely map the CloudStack user to LDAP
+user for a meaningful authentication. For more information about query
+filter syntax, consult the documentation for your LDAP server.
+
+The CloudStack query filter wildcards are:
+
+Query Filter Wildcard
+
+Description
+
+%u
+
+User name
+
+%e
+
+Email address
+
+%n
+
+First and last name
+
+The following examples assume you are using Active Directory, and refer
+to user attributes from the Active Directory schema.
+
+If the CloudStack user name is the same as the LDAP user ID:
+
+.. code:: bash
+
+ (uid=%u)
+
+If the CloudStack user name is the LDAP display name:
+
+.. code:: bash
- If you wish to filter down the user set that is granted access to Cloudstack
- via the LDAP attribute memberof you can do so using
- ldap.search.group.principle
+ (displayName=%u)
-Finally, you can add your LDAP server. To do so select LDAP Configuration from
-the views section within global settings. Click on "Configure LDAP" and fill
-in your server's hostname and port.
+To find a user by email address:
-Example LDAP Configuration for Active Directory
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. code:: bash
-This shows the configuration settings required for using ActiveDirectory.
+ (mail=%e)
-- samAccountName - Logon name
-- mail - Email Address
-- cn - Real name
+Search User Bind DN
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-Along with this the ldap.user.object name needs to be modified, by default
-ActiveDirectory uses the value "user" for this.
+The bind DN is the user on the external LDAP server permitted to search
+the LDAP directory within the defined search base. When the DN is
+returned, the DN and passed password are used to authenticate the
+CloudStack user with an LDAP bind. A full discussion of bind DNs is
+outside the scope of our documentation. The following table shows some
+examples of bind DNs.
-Map the following attributes accordingly as shown below:
+LDAP Server
-.. image:: ./_static/images/add-ldap-configuration-ad.png
+Example Bind DN
-Example LDAP Configuration for OpenLDAP
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ApacheDS
-This shows the configuration settings required for using OpenLDAP.
-The default values supplied are suited for OpenLDAP.
+cn=Administrator,dc=testing,ou=project,ou=org
-- uid - Login Name
-- mail - Email Address
-- cn - Real name
+Active Directory
-Along with this the ldap.user.object name needs to be modified, by default
-OpenLDAP uses the value "inetOrgPerson" for this.
+CN=Administrator, OU=testing, DC=company, DC=com
-Map the following attributes accordingly as shown below:
+SSL Keystore Path and Password
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. image:: ./_static/images/add-ldap-configuration-openldap.png
\ No newline at end of file
+If the LDAP server requires SSL, you need to enable it in the ldapConfig
+command by setting the parameters ssl, truststore, and truststorepass.
+Before enabling SSL for ldapConfig, you need to get the certificate
+which the LDAP server is using and add it to a trusted keystore. You
+will need to know the path to the keystore and the password.
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/767f408f/source/events.rst
----------------------------------------------------------------------
diff --git a/source/events.rst b/source/events.rst
index 3e48460..22d9ee0 100644
--- a/source/events.rst
+++ b/source/events.rst
@@ -14,11 +14,8 @@
under the License.
-Events
-======
-
-Events
-------------
+Event Notification
+===================
An event is essentially a significant or meaningful change in the state
of both virtual and physical resources associated with a cloud
@@ -29,7 +26,7 @@ state change of virtual or physical resources, an action performed by an
user (action events), or policy based events (alerts).
Event Logs
-~~~~~~~~~~~~~~~~~~
+-----------
There are two types of events logged in the CloudStack Event Log.
Standard events log the success or failure of an event and can be used
@@ -42,8 +39,8 @@ information on the status of a pending job or can be used to identify a
job that is hanging or has not started. The following sections provide
more information on these events..
-Event Notification
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+Notification
+------------
Event notification framework provides a means for the Management Server
components to publish and subscribe to CloudStack events. Event
@@ -68,7 +65,7 @@ events, usage events) and the additional category of resource state
change events, are published on to the events bus.
Use Cases
-'''''''''
+~~~~~~~~~
The following are some of the use cases:
@@ -94,7 +91,7 @@ The following are some of the use cases:
multi-tenancy, authentication, and authorization issues.
Configuration
-'''''''''''''
+~~~~~~~~~~~~~
As a CloudStack administrator, perform the following one-time
configuration to enable event notification framework. At run time no
@@ -156,7 +153,7 @@ changes can control the behaviour.
Restart the Management Server.
Standard Events
-~~~~~~~~~~~~~~~~~~~~~~~
+----------------
The events log records three types of standard events.
@@ -189,7 +186,7 @@ The events log records three types of standard events.
successfully performed
Long Running Job Events
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------
The events log records three types of standard events.
@@ -222,7 +219,7 @@ The events log records three types of standard events.
successfully performed
Event Log Queries
-~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------
Database logs can be queried from the user interface. The list of events
captured by the system includes:
@@ -253,7 +250,7 @@ captured by the system includes:
User login and logout
Deleting and Archiving Events and Alerts
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------------------
CloudStack provides you the ability to delete or archive the existing
alerts and events that you no longer want to implement. You can
@@ -288,7 +285,7 @@ API. They are maintained in the database for auditing or compliance
purposes.
Permissions
-^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~
Consider the following:
@@ -303,7 +300,7 @@ Consider the following:
events.
Procedure
-^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~
#.
@@ -331,12 +328,16 @@ Procedure
Click OK.
+
+TroubleShooting
+===============
+
Working with Server Logs
-------------------------------
+------------------------
The CloudStack Management Server logs all web site, middle tier, and
database activities for diagnostics purposes in
-/var/log/cloudstack/management/. The CloudStack logs a variety of error
+`/var/log/cloudstack/management/`. The CloudStack logs a variety of error
messages. We recommend this command to find the problematic output in
the Management Server log:.
@@ -364,27 +365,27 @@ job 1076 with the following grep:
grep "job-1076)" management-server.log
-The CloudStack Agent Server logs its activities in
-/var/log/cloudstack/agent/.
+The CloudStack Agent Server logs its activities in `/var/log/cloudstack/agent/`.
+
Data Loss on Exported Primary Storage
--------------------------------------------
+-------------------------------------
Symptom
-'''''''
+~~~~~~~
Loss of existing data on primary storage which has been exposed as a
Linux NFS server export on an iSCSI volume.
Cause
-'''''
+~~~~~
It is possible that a client from outside the intended pool has mounted
the storage. When this occurs, the LVM is wiped and all data in the
volume is lost
Solution
-''''''''
+~~~~~~~~
When setting up LUN exports, restrict the range of IP addresses that are
allowed access by specifying a subnet mask. For example:
@@ -396,7 +397,7 @@ allowed access by specifying a subnet mask. For example:
Adjust the above command to suit your deployment needs.
More Information
-''''''''''''''''
+~~~~~~~~~~~~~~~~
See the export procedure in the "Secondary Storage" section of the
CloudStack Installation Guide
@@ -405,18 +406,18 @@ Recovering a Lost Virtual Router
--------------------------------------
Symptom
-'''''''
+~~~~~~~
A virtual router is running, but the host is disconnected. A virtual
router no longer functions as expected.
Cause
-'''''
+~~~~~
The Virtual router is lost or down.
Solution
-''''''''
+~~~~~~~~
If you are sure that a virtual router is down forever, or no longer
functions as expected, destroy it. You must create one afresh while
@@ -450,44 +451,39 @@ Maintenance mode not working on vCenter
---------------------------------------------
Symptom
-'''''''
+~~~~~~~
Host was placed in maintenance mode, but still appears live in vCenter.
Cause
-'''''
+~~~~~~
The CloudStack administrator UI was used to place the host in scheduled
maintenance mode. This mode is separate from vCenter's maintenance mode.
Solution
-''''''''
+~~~~~~~~
Use vCenter to place the host in maintenance mode.
-More Information
-''''''''''''''''
-
-See `Section 11.2, “Scheduled Maintenance and Maintenance Mode for
-Hosts” <#scheduled-maintenance-maintenance-mode-hosts>`__
Unable to deploy VMs from uploaded vSphere template
---------------------------------------------------------
Symptom
-'''''''
+~~~~~~~~
When attempting to create a VM, the VM will not deploy.
Cause
-'''''
+~~~~~
If the template was created by uploading an OVA file that was created
using vSphere Client, it is possible the OVA contained an ISO image. If
it does, the deployment of VMs from the template will fail.
Solution
-''''''''
+~~~~~~~~
Remove the ISO and re-upload the template.
@@ -495,7 +491,7 @@ Unable to power on virtual machine on VMware
--------------------------------------------------
Symptom
-'''''''
+~~~~~~~
Virtual machine does not power on. You might see errors like:
@@ -512,7 +508,7 @@ Virtual machine does not power on. You might see errors like:
Unable to access Virtual machine configuration
Cause
-'''''
+~~~~~
A known issue on VMware machines. ESX hosts lock certain critical
virtual machine files and file systems to prevent concurrent changes.
@@ -521,7 +517,7 @@ off. When a virtual machine attempts to power on, it can not access
these critical files, and the virtual machine is unable to power on.
Solution
-''''''''
+~~~~~~~~
See the following:
@@ -532,13 +528,13 @@ Load balancer rules fail after changing network offering
--------------------------------------------------------------
Symptom
-'''''''
+~~~~~~~
After changing the network offering on a network, load balancer rules
stop working.
Cause
-'''''
+~~~~~
Load balancing rules were created while using a network service offering
that includes an external load balancer device such as NetScaler, and
@@ -546,976 +542,9 @@ later the network service offering changed to one that uses the
CloudStack virtual router.
Solution
-''''''''
+~~~~~~~~
Create a firewall rule on the virtual router for each of your existing
load balancing rules so that they continue to function.
-The following time zone identifiers are accepted by CloudStack. There
-are several places that have a time zone as a required or optional
-parameter. These include scheduling recurring snapshots, creating a
-user, and specifying the usage time zone in the Configuration table.
-
-Etc/GMT+12
-
-Etc/GMT+11
-
-Pacific/Samoa
-
-Pacific/Honolulu
-
-US/Alaska
-
-America/Los\_Angeles
-
-Mexico/BajaNorte
-
-US/Arizona
-
-US/Mountain
-
-America/Chihuahua
-
-America/Chicago
-
-America/Costa\_Rica
-
-America/Mexico\_City
-
-Canada/Saskatchewan
-
-America/Bogota
-
-America/New\_York
-
-America/Caracas
-
-America/Asuncion
-
-America/Cuiaba
-
-America/Halifax
-
-America/La\_Paz
-
-America/Santiago
-
-America/St\_Johns
-
-America/Araguaina
-
-America/Argentina/Buenos\_Aires
-
-America/Cayenne
-
-America/Godthab
-
-America/Montevideo
-
-Etc/GMT+2
-
-Atlantic/Azores
-
-Atlantic/Cape\_Verde
-
-Africa/Casablanca
-
-Etc/UTC
-
-Atlantic/Reykjavik
-
-Europe/London
-
-CET
-
-Europe/Bucharest
-
-Africa/Johannesburg
-
-Asia/Beirut
-
-Africa/Cairo
-
-Asia/Jerusalem
-
-Europe/Minsk
-
-Europe/Moscow
-
-Africa/Nairobi
-
-Asia/Karachi
-
-Asia/Kolkata
-
-Asia/Bangkok
-
-Asia/Shanghai
-
-Asia/Kuala\_Lumpur
-
-Australia/Perth
-
-Asia/Taipei
-
-Asia/Tokyo
-
-Asia/Seoul
-
-Australia/Adelaide
-
-Australia/Darwin
-
-Australia/Brisbane
-
-Australia/Canberra
-
-Pacific/Guam
-
-Pacific/Auckland
-
-Types
-
-Events
-
-VM
-
-VM.CREATE
-
-VM.DESTROY
-
-VM.START
-
-VM.STOP
-
-VM.REBOOT
-
-VM.UPDATE
-
-VM.UPGRADE
-
-VM.DYNAMIC.SCALE
-
-VM.RESETPASSWORD
-
-VM.RESETSSHKEY
-
-VM.MIGRATE
-
-VM.MOVE
-
-VM.RESTORE
-
-Domain Router
-
-ROUTER.CREATE
-
-ROUTER.DESTROY
-
-ROUTER.START
-
-ROUTER.STOP
-
-ROUTER.REBOOT
-
-ROUTER.HA
-
-ROUTER.UPGRADE
-
-Console proxy
-
-PROXY.CREATE
-
-PROXY.DESTROY
-
-PROXY.START
-
-PROXY.STOP
-
-PROXY.REBOOT
-
-PROXY.HA
-
-VNC Console Events
-
-VNC.CONNECT
-
-VNC.DISCONNECT
-
-Network Events
-
-NET.IPASSIGN
-
-NET.IPRELEASE
-
-PORTABLE.IPASSIGN
-
-PORTABLE.IPRELEASE
-
-NET.RULEADD
-
-NET.RULEDELETE
-
-NET.RULEMODIFY
-
-NETWORK.CREATE
-
-NETWORK.DELETE
-
-NETWORK.UPDATE
-
-FIREWALL.OPEN
-
-FIREWALL.CLOSE
-
-NIC Events
-
-NIC.CREATE
-
-NIC.DELETE
-
-NIC.UPDATE
-
-NIC.DETAIL.ADD
-
-NIC.DETAIL.UPDATE
-
-NIC.DETAIL.REMOVE
-
-Load Balancers
-
-LB.ASSIGN.TO.RULE
-
-LB.REMOVE.FROM.RULE
-
-LB.CREATE
-
-LB.DELETE
-
-LB.STICKINESSPOLICY.CREATE
-
-LB.STICKINESSPOLICY.DELETE
-
-LB.HEALTHCHECKPOLICY.CREATE
-
-LB.HEALTHCHECKPOLICY.DELETE
-
-LB.UPDATE
-
-Global Load Balancer rules
-
-GLOBAL.LB.ASSIGN
-
-GLOBAL.LB.REMOVE
-
-GLOBAL.LB.CREATE
-
-GLOBAL.LB.DELETE
-
-GLOBAL.LB.UPDATE
-
-Account events
-
-ACCOUNT.ENABLE
-
-ACCOUNT.DISABLE
-
-ACCOUNT.CREATE
-
-ACCOUNT.DELETE
-
-ACCOUNT.UPDATE
-
-ACCOUNT.MARK.DEFAULT.ZONE
-
-UserVO Events
-
-USER.LOGIN
-
-USER.LOGOUT
-
-USER.CREATE
-
-USER.DELETE
-
-USER.DISABLE
-
-USER.UPDATE
-
-USER.ENABLE
-
-USER.LOCK
-
-Registering SSH keypair events
-
-REGISTER.SSH.KEYPAIR
-
-Register for user API and secret keys
-
-REGISTER.USER.KEY
-
-Template Events
-
-TEMPLATE.CREATE
-
-TEMPLATE.DELETE
-
-TEMPLATE.UPDATE
-
-TEMPLATE.DOWNLOAD.START
-
-TEMPLATE.DOWNLOAD.SUCCESS
-
-TEMPLATE.DOWNLOAD.FAILED
-
-TEMPLATE.COPY
-
-TEMPLATE.EXTRACT
-
-TEMPLATE.UPLOAD
-
-TEMPLATE.CLEANUP
-
-Volume Events
-
-VOLUME.CREATE
-
-VOLUME.DELETE
-
-VOLUME.ATTACH
-
-VOLUME.DETACH
-
-VOLUME.EXTRACT
-
-VOLUME.UPLOAD
-
-VOLUME.MIGRATE
-
-VOLUME.RESIZE
-
-VOLUME.DETAIL.UPDATE
-
-VOLUME.DETAIL.ADD
-
-VOLUME.DETAIL.REMOVE
-
-Domains
-
-DOMAIN.CREATE
-
-DOMAIN.DELETE
-
-DOMAIN.UPDATE
-
-Snapshots
-
-SNAPSHOT.CREATE
-
-SNAPSHOT.DELETE
-
-SNAPSHOTPOLICY.CREATE
-
-SNAPSHOTPOLICY.UPDATE
-
-SNAPSHOTPOLICY.DELETE
-
-ISO
-
-ISO.CREATE
-
-ISO.DELETE
-
-ISO.COPY
-
-ISO.ATTACH
-
-ISO.DETACH
-
-ISO.EXTRACT
-
-ISO.UPLOAD
-
-SSVM
-
-SSVM.CREATE
-
-SSVM.DESTROY
-
-SSVM.START
-
-SSVM.STOP
-
-SSVM.REBOOT
-
-SSVM.HA
-
-Service Offerings
-
-SERVICE.OFFERING.CREATE
-
-SERVICE.OFFERING.EDIT
-
-SERVICE.OFFERING.DELETE
-
-Disk Offerings
-
-DISK.OFFERING.CREATE
-
-DISK.OFFERING.EDIT
-
-DISK.OFFERING.DELETE
-
-Network offerings
-
-NETWORK.OFFERING.CREATE
-
-NETWORK.OFFERING.ASSIGN
-
-NETWORK.OFFERING.EDIT
-
-NETWORK.OFFERING.REMOVE
-
-NETWORK.OFFERING.DELETE
-
-Pods
-
-POD.CREATE
-
-POD.EDIT
-
-POD.DELETE
-
-Zones
-
-ZONE.CREATE
-
-ZONE.EDIT
-
-ZONE.DELETE
-
-VLANs/IP ranges
-
-VLAN.IP.RANGE.CREATE
-
-VLAN.IP.RANGE.DELETE
-
-VLAN.IP.RANGE.DEDICATE
-
-VLAN.IP.RANGE.RELEASE
-
-STORAGE.IP.RANGE.CREATE
-
-STORAGE.IP.RANGE.DELETE
-
-STORAGE.IP.RANGE.UPDATE
-
-Configuration Table
-
-CONFIGURATION.VALUE.EDIT
-
-Security Groups
-
-SG.AUTH.INGRESS
-
-SG.REVOKE.INGRESS
-
-SG.AUTH.EGRESS
-
-SG.REVOKE.EGRESS
-
-SG.CREATE
-
-SG.DELETE
-
-SG.ASSIGN
-
-SG.REMOVE
-
-Host
-
-HOST.RECONNECT
-
-Maintenance
-
-MAINT.CANCEL
-
-MAINT.CANCEL.PS
-
-MAINT.PREPARE
-
-MAINT.PREPARE.PS
-
-VPN
-
-VPN.REMOTE.ACCESS.CREATE
-
-VPN.REMOTE.ACCESS.DESTROY
-
-VPN.USER.ADD
-
-VPN.USER.REMOVE
-
-VPN.S2S.VPN.GATEWAY.CREATE
-
-VPN.S2S.VPN.GATEWAY.DELETE
-
-VPN.S2S.CUSTOMER.GATEWAY.CREATE
-
-VPN.S2S.CUSTOMER.GATEWAY.DELETE
-
-VPN.S2S.CUSTOMER.GATEWAY.UPDATE
-
-VPN.S2S.CONNECTION.CREATE
-
-VPN.S2S.CONNECTION.DELETE
-
-VPN.S2S.CONNECTION.RESET
-
-Network
-
-NETWORK.RESTART
-
-Custom certificates
-
-UPLOAD.CUSTOM.CERTIFICATE
-
-OneToOnenat
-
-STATICNAT.ENABLE
-
-STATICNAT.DISABLE
-
-ZONE.VLAN.ASSIGN
-
-ZONE.VLAN.RELEASE
-
-Projects
-
-PROJECT.CREATE
-
-PROJECT.UPDATE
-
-PROJECT.DELETE
-
-PROJECT.ACTIVATE
-
-PROJECT.SUSPEND
-
-PROJECT.ACCOUNT.ADD
-
-PROJECT.INVITATION.UPDATE
-
-PROJECT.INVITATION.REMOVE
-
-PROJECT.ACCOUNT.REMOVE
-
-Network as a Service
-
-NETWORK.ELEMENT.CONFIGURE
-
-Physical Network Events
-
-PHYSICAL.NETWORK.CREATE
-
-PHYSICAL.NETWORK.DELETE
-
-PHYSICAL.NETWORK.UPDATE
-
-Physical Network Service Provider Events
-
-SERVICE.PROVIDER.CREATE
-
-SERVICE.PROVIDER.DELETE
-
-SERVICE.PROVIDER.UPDATE
-
-Physical Network Traffic Type Events
-
-TRAFFIC.TYPE.CREATE
-
-TRAFFIC.TYPE.DELETE
-
-TRAFFIC.TYPE.UPDATE
-
-External network device events
-
-PHYSICAL.LOADBALANCER.ADD
-
-PHYSICAL.LOADBALANCER.DELETE
-
-PHYSICAL.LOADBALANCER.CONFIGURE
-
-External switch management device events
-
-For example: Cisco Nexus 1000v Virtual Supervisor Module.
-
-SWITCH.MGMT.ADD
-
-SWITCH.MGMT.DELETE
-
-SWITCH.MGMT.CONFIGURE
-
-SWITCH.MGMT.ENABLE
-
-SWITCH.MGMT.DISABLE
-
-PHYSICAL.FIREWALL.ADD
-
-PHYSICAL.FIREWALL.DELETE
-
-PHYSICAL.FIREWALL.CONFIGURE
-
-VPC
-
-VPC.CREATE
-
-VPC.UPDATE
-
-VPC.DELETE
-
-VPC.RESTART
-
-Network ACL
-
-NETWORK.ACL.CREATE
-
-NETWORK.ACL.DELETE
-
-NETWORK.ACL.REPLACE
-
-NETWORK.ACL.ITEM.CREATE
-
-NETWORK.ACL.ITEM.UPDATE
-
-NETWORK.ACL.ITEM.DELETE
-
-VPC offerings
-
-VPC.OFFERING.CREATE
-
-VPC.OFFERING.UPDATE
-
-VPC.OFFERING.DELETE
-
-Private gateway
-
-PRIVATE.GATEWAY.CREATE
-
-PRIVATE.GATEWAY.DELETE
-
-Static routes
-
-STATIC.ROUTE.CREATE
-
-STATIC.ROUTE.DELETE
-
-Tag-related events
-
-CREATE\_TAGS
-
-DELETE\_TAGS
-
-Meta data-related events
-
-CREATE\_RESOURCE\_DETAILS
-
-DELETE\_RESOURCE\_DETAILS
-
-VM snapshot events
-
-VMSNAPSHOT.CREATE
-
-VMSNAPSHOT.DELETE
-
-VMSNAPSHOT.REVERTTO
-
-External network device events
-
-PHYSICAL.NVPCONTROLLER.ADD
-
-PHYSICAL.NVPCONTROLLER.DELETE
-
-PHYSICAL.NVPCONTROLLER.CONFIGURE
-
-AutoScale
-
-COUNTER.CREATE
-
-COUNTER.DELETE
-
-CONDITION.CREATE
-
-CONDITION.DELETE
-
-AUTOSCALEPOLICY.CREATE
-
-AUTOSCALEPOLICY.UPDATE
-
-AUTOSCALEPOLICY.DELETE
-
-AUTOSCALEVMPROFILE.CREATE
-
-AUTOSCALEVMPROFILE.DELETE
-
-AUTOSCALEVMPROFILE.UPDATE
-
-AUTOSCALEVMGROUP.CREATE
-
-AUTOSCALEVMGROUP.DELETE
-
-AUTOSCALEVMGROUP.UPDATE
-
-AUTOSCALEVMGROUP.ENABLE
-
-AUTOSCALEVMGROUP.DISABLE
-
-PHYSICAL.DHCP.ADD
-
-PHYSICAL.DHCP.DELETE
-
-PHYSICAL.PXE.ADD
-
-PHYSICAL.PXE.DELETE
-
-AG.CREATE
-
-AG.DELETE
-
-AG.ASSIGN
-
-AG.REMOVE
-
-VM.AG.UPDATE
-
-INTERNALLBVM.START
-
-INTERNALLBVM.STOP
-
-HOST.RESERVATION.RELEASE
-
-Dedicated guest vlan range
-
-GUESTVLANRANGE.DEDICATE
-
-GUESTVLANRANGE.RELEASE
-
-PORTABLE.IP.RANGE.CREATE
-
-PORTABLE.IP.RANGE.DELETE
-
-PORTABLE.IP.TRANSFER
-
-Dedicated Resources
-
-DEDICATE.RESOURCE
-
-DEDICATE.RESOURCE.RELEASE
-
-VM.RESERVATION.CLEANUP
-
-UCS.ASSOCIATEPROFILE
-
-UCS.DISASSOCIATEPROFILE
-
-The following is the list of alert type numbers. The current alerts can
-be found by calling listAlerts.
-
-.. code:: bash
-
- MEMORY = 0 // Available Memory below configured threshold
-
-.. code:: bash
-
- CPU = 1 // Unallocated CPU below configured threshold
-
-.. code:: bash
-
- STORAGE =2 // Available Storage below configured threshold
-
-.. code:: bash
-
- STORAGE_ALLOCATED = 3 // Remaining unallocated Storage is below configured threshold
-
-.. code:: bash
-
- PUBLIC_IP = 4 // Number of unallocated virtual network public IPs is below configured threshold
-
-.. code:: bash
-
- PRIVATE_IP = 5 // Number of unallocated private IPs is below configured threshold
-
-.. code:: bash
-
- SECONDARY_STORAGE = 6 // Available Secondary Storage in availability zone is below configured threshold
-
-.. code:: bash
-
- HOST = 7 // Host related alerts like host disconnected
-
-.. code:: bash
-
- USERVM = 8 // User VM stopped unexpectedly
-
-.. code:: bash
-
- DOMAIN_ROUTER = 9 // Domain Router VM stopped unexpectedly
-
-.. code:: bash
-
- CONSOLE_PROXY = 10 // Console Proxy VM stopped unexpectedly
-
-.. code:: bash
-
- ROUTING = 11 // Lost connection to default route (to the gateway)
-
-.. code:: bash
-
- STORAGE_MISC = 12 // Storage issue in system VMs
-
-.. code:: bash
-
- USAGE_SERVER = 13 // No usage server process running
-
-.. code:: bash
-
- MANAGMENT_NODE = 14 // Management network CIDR is not configured originally
-
-.. code:: bash
-
- DOMAIN_ROUTER_MIGRATE = 15 // Domain Router VM Migration was unsuccessful
-
-.. code:: bash
-
- CONSOLE_PROXY_MIGRATE = 16 // Console Proxy VM Migration was unsuccessful
-
-.. code:: bash
-
- USERVM_MIGRATE = 17 // User VM Migration was unsuccessful
-
-.. code:: bash
-
- VLAN = 18 // Number of unallocated VLANs is below configured threshold in availability zone
-
-.. code:: bash
-
- SSVM = 19 // SSVM stopped unexpectedly
-
-.. code:: bash
-
- USAGE_SERVER_RESULT = 20 // Usage job failed
-
-.. code:: bash
-
- STORAGE_DELETE = 21 // Failed to delete storage pool
-
-.. code:: bash
-
- UPDATE_RESOURCE_COUNT = 22 // Failed to update the resource count
-
-.. code:: bash
-
- USAGE_SANITY_RESULT = 23 // Usage Sanity Check failed
-
-.. code:: bash
-
- DIRECT_ATTACHED_PUBLIC_IP = 24 // Number of unallocated shared network IPs is low in availability zone
-
-.. code:: bash
-
- LOCAL_STORAGE = 25 // Remaining unallocated Local Storage is below configured threshold
-
-.. code:: bash
-
- RESOURCE_LIMIT_EXCEEDED = 26 //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only
-
-.. |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
-.. |infrastructure\_overview.png: Nested organization of a zone| image:: ./_static/images/infrastructure-overview.png
-.. |region-overview.png: Nested structure of a region.| image:: ./_static/images/region-overview.png
-.. |zone-overview.png: Nested structure of a simple zone.| image:: ./_static/images/zone-overview.png
-.. |pod-overview.png: Nested structure of a simple pod| image:: ./_static/images/pod-overview.png
-.. |cluster-overview.png: Structure of a simple cluster| image:: ./_static/images/cluster-overview.png
-.. |dedicate-resource-button.png: button to dedicate a zone, pod, cluster, or host| image:: ./_static/images/dedicate-resource-button.png
-.. |change-password.png: button to change a user's password| image:: ./_static/images/change-password.png
-.. |searchbutton.png: Searches projects| image:: ./_static/images/search-button.png
-.. |editbutton.png: Edits parameters| image:: ./_static/images/edit-icon.png
-.. |deletebutton.png: Removes a project| image:: ./_static/images/delete-button.png
-.. |deletebutton.png: suspends a project| image:: ./_static/images/suspend-icon.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
-.. |addcluster.png: add a cluster| image:: ./_static/images/add-cluster.png
-.. |ConsoleButton.png: button to launch a console| image:: ./_static/images/console-icon.png
-.. |basic-deployment.png: Basic two-machine CloudStack deployment| image:: ./_static/images/vm-lifecycle.png
-.. |image20| image:: ./_static/images/view-console-button.png
-.. |change-affinity-button.png: button to assign an affinity group to a virtual machine| image:: ./_static/images/change-affinity-button.png
-.. |image22| image:: ./_static/images/SnapshotButton.png
-.. |image23| image:: ./_static/images/delete-button.png
-.. |image24| image:: ./_static/images/revert-vm.png
-.. |StopButton.png: button to stop a VM| image:: ./_static/images/stop-instance-icon.png
-.. |EditButton.png: button to edit the properties of a VM| image:: ./_static/images/edit-icon.png
-.. |ChangeServiceButton.png: button to change the service of a VM| image:: ./_static/images/change-service-icon.png
-.. |Migrateinstance.png: button to migrate an instance| image:: ./_static/images/migrate-instance.png
-.. |Destroyinstance.png: button to destroy an instance| image:: ./_static/images/destroy-instance.png
-.. |iso.png: depicts adding an iso image| image:: ./_static/images/iso-icon.png
-.. |enable-disable.png: button to enable or disable zone, pod, or cluster.| image:: ./_static/images/enable-disable.png
-.. |image32| image:: ./_static/images/enable-disable.png
-.. |edit-icon.png: button to edit the VLAN range.| image:: ./_static/images/edit-icon.png
-.. |sysmanager.png: System Image Manager| image:: ./_static/images/sysmanager.png
-.. |software-license.png: Depicts hiding the EULA page.| image:: ./_static/images/software-license.png
-.. |change-admin-password.png: Depicts changing the administrator password| image:: ./_static/images/change-admin-password.png
-.. |AttachDiskButton.png: button to attach a volume| image:: ./_static/images/attach-disk-icon.png
-.. |DetachDiskButton.png: button to detach a volume| image:: ./_static/images/detach-disk-icon.png
-.. |Migrateinstance.png: button to migrate a volume| image:: ./_static/images/migrate-instance.png
-.. |Migrateinstance.png: button to migrate a VM or volume| image:: ./_static/images/migrate-instance.png
-.. |resize-volume-icon.png: button to display the resize volume option.| image:: ./_static/images/resize-volume-icon.png
-.. |resize-volume.png: option to resize a volume.| image:: ./_static/images/resize-volume.png
-.. |image43| image:: ./_static/images/SnapshotButton.png
-.. |editbutton.png: edits the settings.| image:: ./_static/images/edit-icon.png
-.. |editbutton.png: edits the settings| image:: ./_static/images/edit-icon.png
-.. |guest-traffic-setup.png: Depicts a guest traffic setup| image:: ./_static/images/guest-traffic-setup.png
-.. |networksinglepod.png: diagram showing logical view of network in a pod| image:: ./_static/images/network-singlepod.png
-.. |networksetupzone.png: Depicts network setup in a single zone| image:: ./_static/images/network-setup-zone.png
-.. |addguestnetwork.png: Add Guest network setup in a single zone| image:: ./_static/images/add-guest-network.png
-.. |remove-nic.png: button to remove a NIC| image:: ./_static/images/remove-nic.png
-.. |set-default-nic.png: button to set a NIC as default one.| image:: ./_static/images/set-default-nic.png
-.. |EditButton.png: button to edit a network| image:: ./_static/images/edit-icon.png
-.. |edit-icon.png: button to edit a network| image:: ./_static/images/edit-icon.png
-.. |addAccount-icon.png: button to assign an IP range to an account.| image:: ./_static/images/addAccount-icon.png
-.. |eip-ns-basiczone.png: Elastic IP in a NetScaler-enabled Basic Zone.| image:: ./_static/images/eip-ns-basiczone.png
-.. |add-ip-range.png: adding an IP range to a network.| image:: ./_static/images/add-ip-range.png
-.. |httpaccess.png: allows inbound HTTP access from anywhere| image:: ./_static/images/http-access.png
-.. |autoscaleateconfig.png: Configuring AutoScale| image:: ./_static/images/autoscale-config.png
-.. |EnableDisable.png: button to enable or disable AutoScale.| image:: ./_static/images/enable-disable-autoscale.png
-.. |gslb.png: GSLB architecture| image:: ./_static/images/gslb.png
-.. |gslb-add.png: adding a gslb rule| image:: ./_static/images/add-gslb.png
-.. |ReleaseIPButton.png: button to release an IP| image:: ./_static/images/release-ip-icon.png
-.. |enabledisablenat.png: button to enable/disable NAT| image:: ./_static/images/enable-disable.png
-.. |egress-firewall-rule.png: adding an egress firewall rule| image:: ./_static/images/egress-firewall-rule.png
-.. |EnableVPNButton.png: button to enable a VPN| image:: ./_static/images/vpn-icon.png
-.. |vpn-icon.png: button to enable VPN| image:: ./_static/images/vpn-icon.png
-.. |addvpncustomergateway.png: adding a customer gateway.| image:: ./_static/images/add-vpn-customer-gateway.png
-.. |edit.png: button to edit a VPN customer gateway| image:: ./_static/images/edit-icon.png
-.. |delete.png: button to remove a VPN customer gateway| image:: ./_static/images/delete-button.png
-.. |createvpnconnection.png: creating a VPN connection to the customer gateway.| image:: ./_static/images/create-vpn-connection.png
-.. |remove-vpn.png: button to remove a VPN connection| image:: ./_static/images/remove-vpn.png
-.. |reset-vpn.png: button to reset a VPN connection| image:: ./_static/images/reset-vpn.png
-.. |mutltier.png: a multi-tier setup.| image:: ./_static/images/multi-tier-app.png
-.. |add-vpc.png: adding a vpc.| image:: ./_static/images/add-vpc.png
-.. |add-tier.png: adding a tier to a vpc.| image:: ./_static/images/add-tier.png
-.. |replace-acl-icon.png: button to replace an ACL list| image:: ./_static/images/replace-acl-icon.png
-.. |add-new-gateway-vpc.png: adding a private gateway for the VPC.| image:: ./_static/images/add-new-gateway-vpc.png
-.. |replace-acl-icon.png: button to replace the default ACL behaviour.| image:: ./_static/images/replace-acl-icon.png
-.. |add-vm-vpc.png: adding a VM to a vpc.| image:: ./_static/images/add-vm-vpc.png
-.. |addvm-tier-sharednw.png: adding a VM to a VPC tier and shared network.| image:: ./_static/images/addvm-tier-sharednw.png
-.. |release-ip-icon.png: button to release an IP.| image:: ./_static/images/release-ip-icon.png
-.. |enable-disable.png: button to enable Static NAT.| image:: ./_static/images/enable-disable.png
-.. |select-vmstatic-nat.png: selecting a tier to apply staticNAT.| image:: ./_static/images/select-vm-staticnat-vpc.png
-.. |vpc-lb.png: Configuring internal LB for VPC| image:: ./_static/images/vpc-lb.png
-.. |del-tier.png: button to remove a tier| image:: ./_static/images/del-tier.png
-.. |remove-vpc.png: button to remove a VPC| image:: ./_static/images/remove-vpc.png
-.. |edit-icon.png: button to edit a VPC| image:: ./_static/images/edit-icon.png
-.. |restart-vpc.png: button to restart a VPC| image:: ./_static/images/restart-vpc.png
-.. |vr-upgrade.png: Button to upgrade VR to use the new template.| image:: ./_static/images/vr-upgrade.png
-
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/767f408f/source/index.rst
----------------------------------------------------------------------
diff --git a/source/index.rst b/source/index.rst
index ade3a59..4f9c460 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -31,13 +31,6 @@ Managing Accounts, Users and Domains
accounts
-User Services
---------------
-.. toctree::
- :maxdepth: 2
-
- user_services
-
User Interface
--------------
.. toctree::
@@ -52,14 +45,6 @@ Using Projects to Organize User Resources
projects
-Steps to Provision your Cloud Infrastructure
---------------------------------------------
-
-.. toctree::
- :maxdepth: 2
-
- provisioning
-
Service Offerings
-----------------
@@ -148,14 +133,6 @@ Managing the Cloud
management
-Setting Configuration Parameters
---------------------------------
-
-.. toctree::
- :maxdepth: 2
-
- parameters
-
CloudStack API
--------------
@@ -172,16 +149,8 @@ Tuning
tuning
-Troubleshooting
----------------
-
-.. toctree::
- :maxdepth: 2
-
- troubleshooting
-
-Events
-------
+Events and Troubleshooting
+--------------------------
.. toctree::
:maxdepth: 2
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/767f408f/source/management.rst
----------------------------------------------------------------------
diff --git a/source/management.rst b/source/management.rst
index a68f4a2..4385605 100644
--- a/source/management.rst
+++ b/source/management.rst
@@ -256,9 +256,121 @@ same alerts to external SNMP or Syslog management software. This is
useful if you prefer to use an SNMP or Syslog manager to monitor your
cloud.
-The alerts which can be sent are listed in `Appendix C,
-*Alerts* <#alerts>`__. You can also display the most up to date list by
-calling the API command listAlerts.
+The alerts which can be sent are:
+
+The following is the list of alert type numbers. The current alerts can
+be found by calling listAlerts.
+
+::
+
+ MEMORY = 0 // Available Memory below configured threshold
+
+::
+
+ CPU = 1 // Unallocated CPU below configured threshold
+
+::
+
+ STORAGE =2 // Available Storage below configured threshold
+
+::
+
+ STORAGE_ALLOCATED = 3 // Remaining unallocated Storage is below configured threshold
+
+::
+
+ PUBLIC_IP = 4 // Number of unallocated virtual network public IPs is below configured threshold
+
+::
+
+ PRIVATE_IP = 5 // Number of unallocated private IPs is below configured threshold
+
+::
+
+ SECONDARY_STORAGE = 6 // Available Secondary Storage in availability zone is below configured threshold
+
+::
+
+ HOST = 7 // Host related alerts like host disconnected
+
+::
+
+ USERVM = 8 // User VM stopped unexpectedly
+
+::
+
+ DOMAIN_ROUTER = 9 // Domain Router VM stopped unexpectedly
+
+::
+
+ CONSOLE_PROXY = 10 // Console Proxy VM stopped unexpectedly
+
+::
+
+ ROUTING = 11 // Lost connection to default route (to the gateway)
+
+::
+
+ STORAGE_MISC = 12 // Storage issue in system VMs
+
+::
+
+ USAGE_SERVER = 13 // No usage server process running
+
+::
+
+ MANAGMENT_NODE = 14 // Management network CIDR is not configured originally
+
+::
+
+ DOMAIN_ROUTER_MIGRATE = 15 // Domain Router VM Migration was unsuccessful
+
+::
+
+ CONSOLE_PROXY_MIGRATE = 16 // Console Proxy VM Migration was unsuccessful
+
+::
+
+ USERVM_MIGRATE = 17 // User VM Migration was unsuccessful
+
+::
+
+ VLAN = 18 // Number of unallocated VLANs is below configured threshold in availability zone
+
+::
+
+ SSVM = 19 // SSVM stopped unexpectedly
+
+::
+
+ USAGE_SERVER_RESULT = 20 // Usage job failed
+
+::
+
+ STORAGE_DELETE = 21 // Failed to delete storage pool
+
+::
+
+ UPDATE_RESOURCE_COUNT = 22 // Failed to update the resource count
+
+::
+
+ USAGE_SANITY_RESULT = 23 // Usage Sanity Check failed
+
+::
+
+ DIRECT_ATTACHED_PUBLIC_IP = 24 // Number of unallocated shared network IPs is low in availability zone
+
+::
+
+ LOCAL_STORAGE = 25 // Remaining unallocated Local Storage is below configured threshold
+
+::
+
+ RESOURCE_LIMIT_EXCEEDED = 26 //Generated when the resource limit exceeds the limit. Currently used for recurring snapshots only
+
+
+You can also display the most up to date list by calling the API command ``listAlerts``.
SNMP Alert Details
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -315,8 +427,7 @@ alerts from CloudStack:
Syslog manager. To specify multiple external managers, separate the
IP addresses and other configuration values with commas (,).
- .. note:: The recommended maximum number of SNMP or Syslog managers is 20 for
- each.
+ .. note:: The recommended maximum number of SNMP or Syslog managers is 20 for each.
The following example shows how to configure two SNMP managers at IP
addresses 10.1.1.1 and 10.1.1.2. Substitute your own IP addresses,
@@ -373,7 +484,7 @@ Deleting an SNMP or Syslog Manager
To remove an external SNMP manager or Syslog manager so that it no
longer receives alerts from CloudStack, remove the corresponding entry
-from the file /etc/cloudstack/management/log4j-cloud.xml.
+from the file ``/etc/cloudstack/management/log4j-cloud.xml``.
Customizing the Network Domain Name
-----------------------------------------
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/767f408f/source/parameters.rst
----------------------------------------------------------------------
diff --git a/source/parameters.rst b/source/parameters.rst
deleted file mode 100644
index 9e5dfc9..0000000
--- a/source/parameters.rst
+++ /dev/null
@@ -1,375 +0,0 @@
-.. 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.
-
-
-Setting Configuration Parameters
-================================
-
-19.1. About Configuration Parameters
-------------------------------------
-
-CloudStack provides a variety of settings you can use to set limits,
-configure features, and enable or disable features in the cloud. Once
-your Management Server is running, you might need to set some of these
-configuration parameters, depending on what optional features you are
-setting up. You can set default values at the global level, which will
-be in effect throughout the cloud unless you override them at a lower
-level. You can make local settings, which will override the global
-configuration parameter values, at the level of an account, zone,
-cluster, or primary storage.
-
-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.
-
-Setting Global Configuration Parameters
----------------------------------------------
-
-Use the following steps to set global configuration parameters. These
-values will be the defaults in effect throughout your CloudStack
-deployment.
-
-#.
-
- Log in to the UI as administrator.
-
-#.
-
- In the left navigation bar, click Global Settings.
-
-#.
-
- In Select View, choose one of the following:
-
- -
-
- Global Settings. This displays a list of the parameters with brief
- descriptions and current values.
-
- -
-
- Hypervisor Capabilities. This displays a list of hypervisor
- versions with the maximum number of guests supported for each.
-
-#.
-
- Use the search box to narrow down the list to those you are
- interested in.
-
-#.
-
- In the Actions column, click the Edit icon to modify a value. If you
- are viewing Hypervisor Capabilities, you must click the name of the
- hypervisor first to display the editing screen.
-
-Setting Local Configuration Parameters
---------------------------------------------
-
-Use the following steps to set local configuration parameters for an
-account, zone, cluster, or primary storage. These values will override
-the global configuration settings.
-
-#.
-
- Log in to the UI as administrator.
-
-#.
-
- In the left navigation bar, click Infrastructure or Accounts,
- depending on where you want to set a value.
-
-#.
-
- Find the name of the particular resource that you want to work with.
- For example, if you are in Infrastructure, click View All on the
- Zones, Clusters, or Primary Storage area.
-
-#.
-
- Click the name of the resource where you want to set a limit.
-
-#.
-
- Click the Settings tab.
-
-#.
-
- Use the search box to narrow down the list to those you are
- interested in.
-
-#.
-
- In the Actions column, click the Edit icon to modify a value.
-
-Granular Global Configuration Parameters
-----------------------------------------------
-
-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.
-
-
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/767f408f/source/projects.rst
----------------------------------------------------------------------
diff --git a/source/projects.rst b/source/projects.rst
index 374ce2d..6d788dd 100644
--- a/source/projects.rst
+++ b/source/projects.rst
@@ -106,45 +106,26 @@ and set up the invitations feature in CloudStack.
configuration parameters related to project invitations. Click the
edit button to set each parameter.
- Configuration Parameters
+ +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Configuration Parameters | Description |
+ +============================+=======================================================================================================================================================+
+ | project.invite.required | Set to true to turn on the invitations feature. |
+ +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | project.email.sender | The email address to show in the From field of invitation emails. |
+ +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | project.invite.timeout | Amount of time to allow for a new member to respond to the invitation. |
+ +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | project.smtp.host | Name of the host that acts as an email server to handle invitations. |
+ +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | project.smtp.password | (Optional) Password required by the SMTP server. You must also set project.smtp.username and set project.smtp.useAuth to true. |
+ +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | project.smtp.port | SMTP server’s listening port. |
+ +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | project.smtp.useAuth | Set to true if the SMTP server requires a username and password. |
+ +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | project.smtp.username | (Optional) User name required by the SMTP server for authentication. You must also set project.smtp.password and set project.smtp.useAuth to true.. |
+ +----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
- Description
-
- project.invite.required
-
- Set to true to turn on the invitations feature.
-
- project.email.sender
-
- The email address to show in the From field of invitation emails.
-
- project.invite.timeout
-
- Amount of time to allow for a new member to respond to the
- invitation.
-
- project.smtp.host
-
- Name of the host that acts as an email server to handle invitations.
-
- project.smtp.password
-
- (Optional) Password required by the SMTP server. You must also set
- project.smtp.username and set project.smtp.useAuth to true.
-
- project.smtp.port
-
- SMTP server’s listening port.
-
- project.smtp.useAuth
-
- Set to true if the SMTP server requires a username and password.
-
- project.smtp.username
-
- (Optional) User name required by the SMTP server for authentication.
- You must also set project.smtp.password and set project.smtp.useAuth
- to true..
#.
@@ -235,30 +216,18 @@ Setting the Global Project Resource Limits
project can have lower limits. Click the edit button to set each
parameter. |editbutton.png: Edits parameters|
- max.project.public.ips
-
- Maximum number of public IP addresses that can be owned by any
- project in the cloud. See About Public IP Addresses.
-
- max.project.snapshots
-
- Maximum number of snapshots that can be owned by any project in the
- cloud. See Working with Snapshots.
-
- max.project.templates
-
- Maximum number of templates that can be owned by any project in the
- cloud. See Working with Templates.
-
- max.project.uservms
-
- Maximum number of guest virtual machines that can be owned by any
- project in the cloud. See Working With Virtual Machines.
-
- max.project.volumes
+ +--------------------------+------------------------------------------------------------------------------------------------------------------------------+
+ | max.project.public.ips | Maximum number of public IP addresses that can be owned by any project in the cloud. See About Public IP Addresses. |
+ +--------------------------+------------------------------------------------------------------------------------------------------------------------------+
+ | max.project.snapshots | Maximum number of snapshots that can be owned by any project in the cloud. See Working with Snapshots. |
+ +--------------------------+------------------------------------------------------------------------------------------------------------------------------+
+ | max.project.templates | Maximum number of templates that can be owned by any project in the cloud. See Working with Templates. |
+ +--------------------------+------------------------------------------------------------------------------------------------------------------------------+
+ | max.project.uservms | Maximum number of guest virtual machines that can be owned by any project in the cloud. See Working With Virtual Machines. |
+ +--------------------------+------------------------------------------------------------------------------------------------------------------------------+
+ | max.project.volumes | Maximum number of data volumes that can be owned by any project in the cloud. See Working with Volumes. |
+ +--------------------------+------------------------------------------------------------------------------------------------------------------------------+
- Maximum number of data volumes that can be owned by any project in
- the cloud. See Working with Volumes.
#.
@@ -291,7 +260,7 @@ or you can restrict that ability to just CloudStack administrators.
Click the edit button to set the parameter. |editbutton.png: Edits
parameters|
- allow.user.create.projects
+ ``allow.user.create.projects``
Set to true to allow end users to create projects. Set to false if
you want only the CloudStack root administrator and domain