Next set of Admin guide files-setting resource limits for projects
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/f323b959 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/f323b959 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/f323b959 Branch: refs/heads/maven-to-rpm Commit: f323b959631907871ffb5d02ca5c7f4cb2e28359 Parents: 3643fc9 Author: Radhika PC <[email protected]> Authored: Thu Oct 4 13:04:34 2012 +0530 Committer: Hugo Trippaers <[email protected]> Committed: Sat Oct 6 00:30:26 2012 +0200 ---------------------------------------------------------------------- docs/en-US/re-install-hosts.xml | 26 +++++ docs/en-US/set-global-project-resource-limits.xml | 82 ++++++++++++++ docs/en-US/set-per-project-resource-limits.xml | 55 ++++++++++ docs/en-US/set-projects-creator-permissions.xml | 91 +++++++++------- docs/en-US/set-resource-limits-for-projects.xml | 32 ++++++ 5 files changed, 248 insertions(+), 38 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f323b959/docs/en-US/re-install-hosts.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/re-install-hosts.xml b/docs/en-US/re-install-hosts.xml new file mode 100644 index 0000000..b8092ad --- /dev/null +++ b/docs/en-US/re-install-hosts.xml @@ -0,0 +1,26 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ +<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> +%BOOK_ENTITIES; +]> +<!-- 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. +--> +<section id="re-install-hosts"> + <title>Re-Installing Hosts</title> + <para>You can re-install a host after placing it in maintenance mode and then removing it. If a + host is down and cannot be placed in maintenance mode, it should still be removed before the + re-install.</para> +</section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f323b959/docs/en-US/set-global-project-resource-limits.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/set-global-project-resource-limits.xml b/docs/en-US/set-global-project-resource-limits.xml new file mode 100644 index 0000000..d91942a --- /dev/null +++ b/docs/en-US/set-global-project-resource-limits.xml @@ -0,0 +1,82 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ +<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> +%BOOK_ENTITIES; +]> +<!-- 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. +--> +<section id="set-global-project-resource-limits"> + <title>Setting the Global Project Resource Limits</title> + <orderedlist> + <listitem> + <para>Log in as administrator to the &PRODUCT; UI.</para> + </listitem> + <listitem> + <para>In the left navigation, click Global Settings.</para> + </listitem> + <listitem> + <para>In the search box, type max.projects and click the search button.</para> + </listitem> + <listitem> + <para>In the search results, you will see the parameters you can use to set per-project + maximum resource amounts that apply to all projects in the cloud. No project can have more + resources, but an individual project can have lower limits. Click the edit button to set + each parameter. <inlinemediaobject> + <imageobject> + <imagedata fileref="./images/edit-icon.png"/> + </imageobject> + <textobject> + <phrase>editbutton.png: Edits parameters</phrase> + </textobject> + </inlinemediaobject></para> + <informaltable> + <tgroup cols="2" align="left" colsep="1" rowsep="1"> + <tbody> + <row> + <entry><para>max.project.public.ips</para></entry> + <entry><para>Maximum number of public IP addresses that can be owned by any project in + the cloud. See About Public IP Addresses.</para></entry> + </row> + <row> + <entry><para>max.project.snapshots</para></entry> + <entry><para>Maximum number of snapshots that can be owned by any project in the + cloud. See Working with Snapshots.</para></entry> + </row> + <row> + <entry><para>max.project.templates</para></entry> + <entry><para>Maximum number of templates that can be owned by any project in the + cloud. See Working with Templates.</para></entry> + </row> + <row> + <entry><para>max.project.uservms</para></entry> + <entry><para>Maximum number of guest virtual machines that can be owned by any project + in the cloud. See Working With Virtual Machines.</para></entry> + </row> + <row> + <entry><para>max.project.volumes</para></entry> + <entry><para>Maximum number of data volumes that can be owned by any project in the + cloud. See Working with Volumes.</para></entry> + </row> + </tbody> + </tgroup> + </informaltable> + </listitem> + <listitem> + <para>Restart the Management Server.</para> + <programlisting># service cloud-management restart</programlisting> + </listitem> + </orderedlist> +</section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f323b959/docs/en-US/set-per-project-resource-limits.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/set-per-project-resource-limits.xml b/docs/en-US/set-per-project-resource-limits.xml new file mode 100644 index 0000000..a0f64ea --- /dev/null +++ b/docs/en-US/set-per-project-resource-limits.xml @@ -0,0 +1,55 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ +<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> +%BOOK_ENTITIES; +]> +<!-- 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. +--> +<section id="set-per-project-resource-limits"> + <title>Setting Per-Project Resource Limits</title> + <para>The &PRODUCT; root administrator or the domain administrator of the domain where the project + resides can set new resource limits for an individual project. The project owner can set + resource limits only if the owner is also a domain or root administrator.</para> + <para>The new limits must be below the global default limits set by the &PRODUCT; administrator + (as described in <xref linkend="set-resource-limits-for-projects"/>). If the project already + owns more of a given type of resource than the new maximum, the resources are not affected; + however, the project can not add any new resources of that type until the total drops below the + new limit.</para> + <orderedlist> + <listitem> + <para>Log in as administrator to the &PRODUCT; UI.</para> + </listitem> + <listitem> + <para>In the left navigation, click Projects.</para> + </listitem> + <listitem> + <para>In Select View, choose Projects.</para> + </listitem> + <listitem> + <para>Click the name of the project you want to work with.</para> + </listitem> + <listitem> + <para>Click the Resources tab. This tab lists the current maximum amount that the project is + allowed to own for each type of resource.</para> + </listitem> + <listitem> + <para>Type new values for one or more resources.</para> + </listitem> + <listitem> + <para>Click Apply.</para> + </listitem> + </orderedlist> +</section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f323b959/docs/en-US/set-projects-creator-permissions.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/set-projects-creator-permissions.xml b/docs/en-US/set-projects-creator-permissions.xml index 1d9309f..9b272f6 100644 --- a/docs/en-US/set-projects-creator-permissions.xml +++ b/docs/en-US/set-projects-creator-permissions.xml @@ -3,45 +3,60 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> %BOOK_ENTITIES; ]> - <!-- 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. + 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. --> - <section id="set-projects-creator-permissions"> - <title>Setting Project Creator Permissions</title> - <para>You can configure &PRODUCT; to allow any user to create a new project, or you can restrict that ability to just &PRODUCT; administrators.</para> - <orderedlist> - <listitem><para>Log in as administrator to the &PRODUCT; UI.</para></listitem> - <listitem><para>In the left navigation, click Global Settings.</para></listitem> - <listitem><para>In the search box, type allow.user.create.projects.</para></listitem> - <listitem><para>Click the edit button to set the parameter. <inlinemediaobject> - <imageobject> - <imagedata fileref="./images/edit-icon.png" /> - </imageobject> - <textobject><phrase>editbutton.png: Edits parameters</phrase></textobject> - </inlinemediaobject></para><informaltable> - <tgroup cols="2" align="left" colsep="1" rowsep="1"> - <tbody> - <row> - <entry><para>allow.user.create.projects</para></entry> - <entry><para>Set to true to allow end users to create projects. Set to false if you want only the &PRODUCT; root administrator and domain administrators to create projects.</para></entry> - </row> - </tbody></tgroup></informaltable></listitem> - <listitem><para>Restart the Management Server.</para><programlisting># service cloud-management restart</programlisting></listitem> - </orderedlist> + <title>Setting Project Creator Permissions</title> + <para>You can configure &PRODUCT; to allow any user to create a new project, or you can restrict + that ability to just &PRODUCT; administrators.</para> + <orderedlist> + <listitem> + <para>Log in as administrator to the &PRODUCT; UI.</para> + </listitem> + <listitem> + <para>In the left navigation, click Global Settings.</para> + </listitem> + <listitem> + <para>In the search box, type allow.user.create.projects.</para> + </listitem> + <listitem> + <para>Click the edit button to set the parameter.<inlinemediaobject> + <imageobject> + <imagedata fileref="./images/edit-icon.png"/> + </imageobject> + <textobject> + <phrase>editbutton.png: Edits parameters</phrase> + </textobject> + </inlinemediaobject></para> + <informaltable> + <tgroup cols="2" align="left" colsep="1" rowsep="1"> + <tbody> + <row> + <entry><para>allow.user.create.projects</para></entry> + <entry><para>Set to true to allow end users to create projects. Set to false if you + want only the &PRODUCT; root administrator and domain administrators to create + projects.</para></entry> + </row> + </tbody> + </tgroup> + </informaltable> + </listitem> + <listitem> + <para>Restart the Management Server.</para> + <programlisting># service cloud-management restart</programlisting> + </listitem> + </orderedlist> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f323b959/docs/en-US/set-resource-limits-for-projects.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/set-resource-limits-for-projects.xml b/docs/en-US/set-resource-limits-for-projects.xml new file mode 100644 index 0000000..669ca25 --- /dev/null +++ b/docs/en-US/set-resource-limits-for-projects.xml @@ -0,0 +1,32 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ +<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> +%BOOK_ENTITIES; +]> +<!-- 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. +--> +<section id="set-resource-limits-for-projects"> + <title>Setting Resource Limits for Projects</title> + <para>The &PRODUCT; administrator can set global default limits to control the amount of resources + that can be owned by each project in the cloud. This serves to prevent uncontrolled usage of + resources such as snapshots, IP addresses, and virtual machine instances. Domain administrators + can override these resource limits for individual projects with their domains, as long as the + new limits are below the global defaults set by the &PRODUCT; root administrator. The root + administrator can also set lower resource limits for any project in the cloud</para> + <xi:include href="set-per-project-resource-limits.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="set-global-project-resource-limits.xml" + xmlns:xi="http://www.w3.org/2001/XInclude"/> +</section>
