You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by pd...@apache.org on 2015/11/17 14:14:03 UTC
[1/3] cloudstack-docs-admin git commit: change version to 4.6
Repository: cloudstack-docs-admin
Updated Branches:
refs/heads/master 4442b4aa1 -> e3b936778
change version to 4.6
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/bd2719b9
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/tree/bd2719b9
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/diff/bd2719b9
Branch: refs/heads/master
Commit: bd2719b9128665ee3ab9db6f326547a20ffd8cd9
Parents: 4442b4a
Author: Pierre-Luc Dion <pd...@apache.org>
Authored: Tue Nov 17 07:37:45 2015 -0500
Committer: Pierre-Luc Dion <pd...@apache.org>
Committed: Tue Nov 17 07:37:45 2015 -0500
----------------------------------------------------------------------
source/_global.rst | 8 ++++----
source/conf.py | 4 ++--
2 files changed, 6 insertions(+), 6 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/bd2719b9/source/_global.rst
----------------------------------------------------------------------
diff --git a/source/_global.rst b/source/_global.rst
index 0a358f8..28428e3 100644
--- a/source/_global.rst
+++ b/source/_global.rst
@@ -22,7 +22,7 @@
.. _CloudStack Apidocs: http://cloudstack.apache.org/docs/api/
.. Latest version systemvm template URL
-.. |sysvm64-url-xen| replace:: http://cloudstack.apt-get.eu/systemvm/4.5/systemvm64template-4.5-xen.vhd.bz2
-.. |sysvm64-url-kvm| replace:: http://cloudstack.apt-get.eu/systemvm/4.5/systemvm64template-4.5-kvm.qcow2.bz2
-.. |sysvm64-url-vmware| replace:: http://cloudstack.apt-get.eu/systemvm/4.5/systemvm64template-4.5-vmware.ova
-.. |sysvm64-url-hyperv| replace:: http://cloudstack.apt-get.eu/systemvm/4.5/systemvm64template-4.5-hyperv.vhd.zip
+.. |sysvm64-url-xen| replace:: http://cloudstack.apt-get.eu/systemvm/4.6/systemvm64template-4.6.0-xen.vhd.bz2
+.. |sysvm64-url-kvm| replace:: http://cloudstack.apt-get.eu/systemvm/4.6/systemvm64template-4.6.0-kvm.qcow2.bz2
+.. |sysvm64-url-vmware| replace:: http://cloudstack.apt-get.eu/systemvm/4.6/systemvm64template-4.6.0-vmware.ova
+.. |sysvm64-url-hyperv| replace:: http://cloudstack.apt-get.eu/systemvm/4.6/systemvm64template-4.6.0-hyperv.vhd.zip
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/bd2719b9/source/conf.py
----------------------------------------------------------------------
diff --git a/source/conf.py b/source/conf.py
index 1754468..8bd2267 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -60,9 +60,9 @@ copyright = u'2015, Apache Software Foundation'
# built documents.
#
# The short X.Y version.
-version = '4.5'
+version = '4.6'
# The full version, including alpha/beta/rc tags.
-release = '4.5.0'
+release = '4.6.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
[3/3] cloudstack-docs-admin git commit: update gitignore
Posted by pd...@apache.org.
update gitignore
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/e3b93677
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/tree/e3b93677
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/diff/e3b93677
Branch: refs/heads/master
Commit: e3b936778022f526d9767b3a40514f0e2ab1ac51
Parents: f619cc4
Author: Pierre-Luc Dion <pd...@apache.org>
Authored: Tue Nov 17 08:12:08 2015 -0500
Committer: Pierre-Luc Dion <pd...@apache.org>
Committed: Tue Nov 17 08:12:08 2015 -0500
----------------------------------------------------------------------
.gitignore | 1 +
1 file changed, 1 insertion(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/e3b93677/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index e955aad..292a64e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -28,3 +28,4 @@
Icon?
ehthumbs.db
Thumbs.db
+sphinx_bootstrap_theme/__init__.pyc
[2/3] cloudstack-docs-admin git commit: fix formating and add to
index. close #30
Posted by pd...@apache.org.
fix formating and add to index. close #30
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/f619cc46
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/tree/f619cc46
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/diff/f619cc46
Branch: refs/heads/master
Commit: f619cc46a1c4a0a428b80c1855a30a846a3adaa9
Parents: bd2719b
Author: Pierre-Luc Dion <pd...@apache.org>
Authored: Tue Nov 17 08:10:49 2015 -0500
Committer: Pierre-Luc Dion <pd...@apache.org>
Committed: Tue Nov 17 08:10:49 2015 -0500
----------------------------------------------------------------------
source/index.rst | 9 ++
source/plugins/quota.rst | 189 ++++++++++++++++++++++++++++++++++++++++++
2 files changed, 198 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/f619cc46/source/index.rst
----------------------------------------------------------------------
diff --git a/source/index.rst b/source/index.rst
index 08bd75d..e7a7a4b 100644
--- a/source/index.rst
+++ b/source/index.rst
@@ -162,6 +162,15 @@ System Reliability and Availability
reliability
+Plugins
+-------
+
+.. toctree::
+ :maxdepth: 2
+
+ plugins/quota
+
+
Tuning
------
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-admin/blob/f619cc46/source/plugins/quota.rst
----------------------------------------------------------------------
diff --git a/source/plugins/quota.rst b/source/plugins/quota.rst
new file mode 100644
index 0000000..66f0e0e
--- /dev/null
+++ b/source/plugins/quota.rst
@@ -0,0 +1,189 @@
+.. 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.
+
+
+Quota Plugin
+=============
+
+Quota service, while allowing for scalability, will make sure that the cloud is
+not exploited by attacks, careless use and program errors. To address this
+problem, employ the quota-enforcement service that allows resource
+usage within certain bounds as defined by policies and available quotas for
+various entities. Quota service extends the functionality of usage server to
+provide a measurement for the resources used by the accounts and domains using a
+common unit referred to as cloud currency in this document. It can be configured
+to ensure that your usage won’t exceed the budget allocated to accounts/domain
+in cloud currency. It will let user know how much of the cloud resources he is
+using. It will help the cloud admins, if they want, to ensure that a user does
+not go beyond his allocated quota. Per usage cycle if an account is found to be
+exceeding its quota then it is locked. Locking an account means that it will not
+be able to initiate a new resource allocation request, whether it is more
+storage or an additional ip. To unlock an account you need to add more credit to it.
+In case you want the locking to be disabled on global or on account scope those
+provisions are also provided. Needless to say quota service as well as any action
+on the account is configurable.
+
+Enabling the Quota Service
+----------------------------
+
+Before installing and configuring the quota service you need to make sure that
+the Usage Server has been installed. This requires extra steps beyond just
+installing the CloudStack software. See Installing the Usage Server (Optional)
+in the Advanced Installation Guide.
+
+#. enable.usage.server: Set to true to enable usage server.
+
+The quota plugin is disabled by default. To enable it goto Global Settings and
+set the following global configuration to true:
+
+#. quota.enable.service
+
+By default Quota service does not lock the accounts that have exceeded the quota
+usage. To enable quota service to lock accounts set the following global
+configuration to true:
+
+#. quota.enable.enforcement
+
+The other configurations that are there for quota service are as:
+
+#. quota.currency.symbol : The symbol that is used before any currency
+ figure in various quota forms and reports.
+#. quota.usage.smtp.host: Quota SMTP host for sending quota alerts.
+#. quota.usage.smtp.port: Quota SMTP port.
+#. quota.usage.smtp.user: Quota SMTP user.
+#. quota.usage.smtp.password: Quota SMTP password.
+#. quota.usage.smtp.sender: Quota SMTP alert sender email address.
+#. quota.usage.smtp.useAuth: If true, use secure SMTP authentication when sending emails.
+#. quota.usage.smtp.connection.timeout: Quota SMTP server connection timeout duration.
+
+There are several configuration variables that are inherited from usage server,
+these are listed below:
+
+#. usage.aggregation.timezone
+
+All these are described in details in Usage Server documentation.
+
+Restart the Management Server and the Usage Server to enable the set configuration
+values.
+
+.. code:: bash
+
+ service cloudstack-management restart
+ service cloudstack-usage restart
+
+Once the quota service is running it will calculate the quota balance for each account.
+The quota usage is calculated as per the quota tariff provided by the site administrator.
+
+
+Quota Tariff
+-------------
+
+The following table shows all quota types for which you can specify tariff.
+
+.. cssclass:: table-striped table-bordered table-hover
+
++------------------+-----------------------------------+-------------------------+
+| Type ID | Type Name | Tariff Description |
+| | | |
++==================+===================================+=========================+
+| 1 | RUNNING\_VM | One month of running |
+| | | Compute-Month |
++------------------+-----------------------------------+-------------------------+
+| 2 | ALLOCATED\_VM | One month of allocated |
+| | | VM |
++------------------+-----------------------------------+-------------------------+
+| 3 | IP\_ADDRESS | Quota for a month of |
+| | | allocated IP |
++------------------+-----------------------------------+-------------------------+
+| 4 | NETWORK\_BYTES\_SENT | Quota for 1GB bytes sent|
++------------------+-----------------------------------+-------------------------+
+| 5 | NETWORK\_BYTES\_RECEIVED | Quota for 1GB bytes sent|
++------------------+-----------------------------------+-------------------------+
+| 6 | VOLUME | Quota for 1 GB of |
+| | | Volume use for a month |
++------------------+-----------------------------------+-------------------------+
+| 7 | TEMPLATE | Quota for 1 GB of |
+| | |Template use for a month |
++------------------+-----------------------------------+-------------------------+
+| 8 | ISO | Quota for 1 GB of |
+| | | ISO use for a month |
++------------------+-----------------------------------+-------------------------+
+| 9 | SNAPSHOT | Quota for 1 GB of |
+| | |SNAPSHOT use for a month |
++------------------+-----------------------------------+-------------------------+
+| 11 | LOAD\_BALANCER\_POLICY | Quota for load balancer |
+| | | policy month |
++------------------+-----------------------------------+-------------------------+
+| 12 | PORT\_FORWARDING\_RULE |Quota for port forwarding|
+| | | policy month |
++------------------+-----------------------------------+-------------------------+
+| 13 | NETWORK\_OFFERING | Quota for network |
+| | | Offering for a month |
++------------------+-----------------------------------+-------------------------+
+| 14 | VPN\_USERS | Quota for VPN usage |
+| | | for a month |
++------------------+-----------------------------------+-------------------------+
+| 15 | CPU\_CLOCK\_RATE | The tariff for using |
+| | | 1 CPU i100 MHz clock |
++------------------+-----------------------------------+-------------------------+
+| 16 | CPU\_NUMBER | The quota tariff for |
+| | | using 1 virtual CPU. |
++------------------+-----------------------------------+-------------------------+
+| 17 | MEMORY | The quota tariff for |
+| | | using 1MB RAM size. |
++------------------+-----------------------------------+-------------------------+
+
+The quota tariff can be listed using listQuotaTariff API.
+
+quotaTariff: Lists all quota tariff plans
+
+The tariff for each of the above can be set by using the updateQuotaTariff API.
+
+Quota Credits
+-------------
+
+The quota credit (quotaCredit) API lets you add or remove quota currency credits to
+an account. With this API you can also control the quota enforcement policy at
+account level. This will enable you to have some accounts where the quota policy is
+not enforced. The overall quota enforcement is controlled by the quota.enable.enforcement
+global setting.
+
+In addition to above the quota API lets you can fine tune the alert generation by specifying
+the quota threshold for each account. If not explictly stated, the threshold is taken as 80%
+of the last deposit.
+
+Quota Balance
+--------------
+
+Quota balance API states the start balance and end balance(optional) from a start date
+to end date (optional).
+
+Quota Statement
+----------------
+
+Quota statement for a period consist of the quota usage under various quota types for
+the given period from a start date to an end date.
+
+Quota Monthly Statement
+------------------------
+
+Quota service emails the monthly quota statement for the last month at the beginning of
+each month. For this service to work properly you need to ensure that the usage server
+is running.
+
+Quota Alert Management
+-----------------------
+
+Quota module also provides APIs to customize various email templates that are used to
+alert account owners about quota going down below threshold and quota getting over.
+
+
+All the above functionality is also available via quota UI plugin.