diff --git a/docs/en-US/changed-API-commands-4.2 b/docs/en-US/changed-API-commands-4.2 new file mode 100644 index 00000000000..cbaa2e3fa92 --- /dev/null +++ b/docs/en-US/changed-API-commands-4.2 @@ -0,0 +1,107 @@ + + +%BOOK_ENTITIES; +]> + +
+ Changed API Commands in 4.2 + + + + + Parameter Name + Description + + + + + updateResourceLimit + + Added the following resource types to the resourcetype + request parameter to set the limits: + + + CPU + + + RAM + + + primary storage + + + secondary storage + + + network rate + + + + + + updateResourceCount + + Added the following resource types to the resourcetype + request parameter to set the limits: + + + CPU + + + RAM + + + primary storage + + + secondary storage + + + network rate + + + + + + listResourceLimits + + Added the following resource types to the resourcetype + request parameter: + + + CPU + + + RAM + + + primary storage + + + secondary storage + + + network rate + + + + + + + +
diff --git a/docs/en-US/limit-accounts-domains.xml b/docs/en-US/limit-accounts-domains.xml new file mode 100644 index 00000000000..64a886ef796 --- /dev/null +++ b/docs/en-US/limit-accounts-domains.xml @@ -0,0 +1,387 @@ + + +%BOOK_ENTITIES; +]> + + +
+ Limiting Resource Usage + In addition to VMs, volumes, and snapshots, &PRODUCT; allows you limit resource types, such + as CPU, RAM, Primary storage, Secondary storage, and Network Rate. + Previously in &PRODUCT;, resource usage limit was imposed based on the resource count, that + is, restrict a user or domain on the basis of the number of VMs, volumes, or snapshots used. A + new set of resource types has been added to the existing pool of resources (VMs, Volumes, and + Snapshots) to support the customization model—need-basis usage, such as large VM or small + VM. The new resource types are now broadly classified as CPU, RAM, Primary storage, Secondary + storage, and Network Rate. &PRODUCT; now allows the root administrator to impose resource usage + limit by the following resource types for Domain, Project and Accounts. + + + CPUs + + + Memory (RAM) + + + Primary Storage (Volumes) + + + Secondary Storage (Snapshots, Templates, ISOs) + + + Network Rate (Mbps) + + + To control the behaviour of this feature, the following configuration parameters have been + added: + + + + + Parameter Name + Description + + + + + max.account.cpus + Maximum number of CPU cores that can be used for an account. + Default is 40. + + + max.account.ram (MB) + Maximum RAM that can be used for an account. + Default is 40960. + + + max.account.primary.storage (GB) + Maximum primary storage space that can be used for an account. + Default is 20*10. + + + + max.account.secondary.storage (GB) + Maximum secondary storage space that can be used for an account. + Default is 20*20. + + + max.account.network.rate (Mbps) + Maximum network rate that can be used for an account. + Default is 200. + + + max.project.cpus + + Maximum number of CPU cores that can be used for an account. + Default is 40. + + + + max.project.ram (MB) + + Maximum RAM that can be used for an account. + Default is 40960. + + + + max.project.primary.storage (GB) + + Maximum primary storage space that can be used for an account. + Default is 20*10. + + + + max.project.secondary.storage (GB) + + Maximum secondary storage space that can be used for an account. + Default is 20*20. + + + + max.project.network.rate (Mbps) + + Maximum network rate that can be used for an account. + Default is 200. + + + + + +
+ User Permission + The root administrator, domain administrators and users are able to list resources. Ensure + that proper logs are maintained in the vmops.log and + api.log files. + + + The root admin will have the privilege to list and update resource limits. + + + The domain administrators are allowed to list and change these resource limits only + for the sub-domains and accounts under their own domain or the sub-domains. + + + Normal users would have privilege to list resource limits. Use the listResourceLimits + API. + + +
+
+ Use Cases and Considerations + + + When you refer to Primary or Seconday storage space, it implies that the stated size + of the volume and not the physical size— the actual consumed size on disk in case of + thin provisioning. + + + If admin reduces the resource limit for an account and set it to less than the + resources currently consumed by that account, the existing VMs/templates/volumes are + destroyed. Using those resources, limits are imposed if the user under that account tries + to execute a new operation. For example, the existing behavior in the case of a VM are: + + + migrateVirtualMachine: The users under that account will be able to migrate the + running VM into any other host without facing any limit issue. + + + recoverVirtualMachine: Destroyed VMs cannot be recovered. + + + + + For any resource type, if a domain has limit X, sub-domain or accounts under that + domain can have there own limits, but at any point of time the sum of resource allocated + to sub-domain or accounts under the domain should never exceed the value X. + For example, if a domain has the CPU limit of 40 and sub-domain D1 and account A1 can + have limits of 30 each, but at any point of time the resource allocated to D1 and A1 + should not exceed the limit 40. + + + If any operation needs to pass through two of more resource limit check, then the + lower of 2 limits will be enforced, For e.g. if an account has VM limit of 10 and CPU + limit of 20 and user under that account requests 5 VMs of 4 CPUs each, after this user can + deploy 5 more VMs(because VM limit is 10) but user has exausted his CPU limit and cannot + deploy any more instance. + + +
+
+ Per-Domain Limits + &PRODUCT; allows the configuration of limits on a domain basis. With a domain limit in + place, all users still have their account limits. They are additionally limited, as a group, + to not exceed the resource limits set on their domain. Domain limits aggregate the usage of + all accounts in the domain as well as all accounts in all sub-domains of that domain. Limits + set at the root domain level apply to the sum of resource usage by the accounts in all domains + and sub-domains below that root domain. + To set a domain limit: + + + Log in to the &PRODUCT; UI. + + + In the left navigation tree, click Domains. + + + Select the domain you want to modify. The current domain limits are displayed. + A value of -1 shows that there is no limit in place. + + + Click the Edit button + + + + + editbutton.png: edits the settings. + + + + + Edit the following as per your requirement: + + + + + Parameter Name + Description + + + + + Instance Limits + The number of instances that can be used in a domain. + + + Public IP Limits + + The number of public IP addresses that can be used in a + domain. + + + Volume Limits + The number of disk volumes that can be created in a domain. + + + + Snapshot Limits + The number of snapshots that can be created in a domain. + + + Template Limits + The number of templates that can be registered in a + domain. + + + VPC limits + The number of VPCs that can be created in a domain. + + + CPU limits + + The number of CPU cores that can be used for a domain. + + + + Memory limits (MB) + + The number of RAM that can be used for a domain. + + + + Primary Storage limits (GB) + + The primary storage space that can be used for a domain. + + + + Secondary Storage limits (GB) + + The secondary storage space that can be used for a domain. + + + + + + + Click Apply. + +
+
+ Default Account Resource Limits + You can limit resource use by accounts. The default limits are set by using global + configuration parameters, and they affect all accounts within a cloud. The relevant parameters + are those beginning with max.account, for example: max.account.snapshots. + To override a default limit for a particular account, set a per-account resource + limit. + + + Log in to the &PRODUCT; UI. + + + In the left navigation tree, click Accounts. + + + Select the account you want to modify. The current limits are displayed. + A value of -1 shows that there is no limit in place. + + + Click the Edit button. + + + + + editbutton.png: edits the settings + + + + + Edit the following as per your requirement: + + + + + Parameter Name + Description + + + + + Instance Limits + The number of instances that can be used in an account. + The default is 20. + + + Public IP Limits + + The number of public IP addresses that can be used in an + account. + The default is 20. + + + Volume Limits + The number of disk volumes that can be created in an account. + The default is 20. + + + Snapshot Limits + The number of snapshots that can be created in an account. + The default is 20. + + + Template Limits + The number of templates that can be registered in an + account. + The default is 20. + + + VPC limits + The number of VPCs that can be created in an account. + The default is 20. + + + CPU limits + + The number of CPU cores that can be used for an account. + The default is 40. + + + Memory limits (MB) + + The number of RAM that can be used for an account. + The default is 40960. + + + Primary Storage limits (GB) + + The primary storage space that can be used for an account. + The default is 200. + + + Secondary Storage limits (GB) + + The secondary storage space that can be used for an account. + The default is 400. + + + + + + Click Apply. + +
+
diff --git a/docs/en-US/work-with-usage.xml b/docs/en-US/work-with-usage.xml index 00a7fb5df81..c40b1e25b49 100644 --- a/docs/en-US/work-with-usage.xml +++ b/docs/en-US/work-with-usage.xml @@ -21,16 +21,18 @@ specific language governing permissions and limitations under the License. --> - - Working with Usage - The Usage Server is an optional, separately-installed part of &PRODUCT; that provides aggregated usage records which you can use to create billing integration for &PRODUCT;. The Usage Server works by taking data from the events log and creating summary usage records that you can access using the listUsageRecords API call. - The usage records show the amount of resources, such as VM run time or template storage - space, consumed by guest instances. - The Usage Server runs at least once per day. It can be configured to run multiple times per day. - - - - - + Working with Usage + The Usage Server is an optional, separately-installed part of &PRODUCT; that provides + aggregated usage records which you can use to create billing integration for &PRODUCT;. The + Usage Server works by taking data from the events log and creating summary usage records that + you can access using the listUsageRecords API call. + The usage records show the amount of resources, such as VM run time or template storage + space, consumed by guest instances. + The Usage Server runs at least once per day. It can be configured to run multiple times per + day. + + + +