Document foreman_resource_quota plugin

Author: maximiliankolb

guides/common/assembly_limiting-resources.adoc

@@ -0,0 +1,17 @@
+include::modules/con_limiting-resources.adoc[]
+
+include::modules/proc_installing-the-resource-quota-plugin.adoc[leveloffset=+1]
+
+include::modules/con_managing-resource-quotas.adoc[leveloffset=+1]
+
+include::modules/proc_creating-a-resource-quota.adoc[leveloffset=+2]
+
+include::modules/proc_editing-a-resource-quota.adoc[leveloffset=+2]
+
+include::modules/proc_deleting-a-resource-quota.adoc[leveloffset=+2]
+
+include::modules/con_assigning-resource-quotas-to-users.adoc[leveloffset=+1]
+
+include::modules/proc_assigning-resource-quotas-to-a-user.adoc[leveloffset=+2]
+
+include::modules/proc_assigning-resource-quotas-to-a-user-group.adoc[leveloffset=+2]

guides/common/modules/con_assigning-resource-quotas-to-users.adoc

@@ -0,0 +1,8 @@
+[id="assigning-resource-quotas-to-users"]
+= Assigning resource quotas to users
+
+You can assign resource quotas to users or user groups.
+If a user has a resource quota assigned to, they can select it during host provisioning.
+You can use the `resource_quota` filter in the {ProjectWebUI} to view users or user groups with assigned resource quotas.
+
+If you want to introduce resource quotas to your organization, you can also start by assigning resource quotas to users and user groups but set the limit to optional.

guides/common/modules/con_limiting-resources.adoc

@@ -0,0 +1,18 @@
+[id="limiting-resources"]
+= Limiting resources
+
+You can use the Resource Quota plugin to limit users' access to resources.
+
+Supported resource types::
+* CPU {endash} limit the number of CPU cores
+* Memory {endash} limit the amnount of memory
+* Disk {endash} limit the amount of disk space
+
+Supported compute resources::
+* VMware
+* libvirt
+
+Configuration options::
+* *Global Resource Quota no action* {endash} {Project} will not limit the resource consumption if a resource quota is exceeded.
+* *Resource Quota optional assignment* {endash} {Project} will not enforce selecting a resource quota during host provisioning.
+The global setting overwrites user-specific and user group-specific configuration options.

guides/common/modules/con_managing-resource-quotas.adoc

@@ -0,0 +1,5 @@
+[id="managing-resource-quotas"]
+= Managing resource quotas
+
+You can create, edit, and delete resource quotas in {ProjectWebUI}.
+To view resource quotas, navigate to *Configure* > *Resource Quotas*.

guides/common/modules/proc_assigning-resource-quotas-to-a-user-group.adoc

@@ -0,0 +1,10 @@
+[id="assigning-resource-quotas-to-a-user-group"]
+= Assigning resource quotas to a user group
+
+You can assign resource quotas to a user group to limit the resource consumption of that {Project} user group.
+All users of the user group share the pool of resources.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Administer* > *User Groups*.
+. On the *Resource Quota* tab, assign resource quotas to the user group.
+. Click *Submit* to assign resource quotas to a user group.

guides/common/modules/proc_assigning-resource-quotas-to-a-user.adoc

@@ -0,0 +1,13 @@
+[id="assigning-resource-quotas-to-a-user"]
+= Assigning resource quotas to a user
+
+You can assign resource quotas to a user to limit the resource consumption of that {Project} user.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Administer* > *Users*.
+. Select a user.
+. On the *Resource Quota* tab, assign resource quotas to the user.
+. If you want to make the usage of resource quotas optional, select the *Optional Assignment* checkbox.
++
+This means that {Project} will not prevent users from consuming more resources than their assigned quota.
+. Click *Submit* to assign resource quotas to a user.

guides/common/modules/proc_creating-a-resource-quota.adoc

@@ -0,0 +1,11 @@
+[id="creating-a-resource-quota"]
+= Creating a resource quota
+
+Create a resource quota to limit the resource consumption of a {Project} user.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Configure* > *Resource Quotas*.
+. Click *Create resource quota*.
++
+Follow the wizard in the {ProjectWebUI}.
+. Click *Create resource quota* to submit the resouce quota to {Project}.

guides/common/modules/proc_deleting-a-resource-quota.adoc

@@ -0,0 +1,8 @@
+[id="deleting-a-resource-quota"]
+= Deleting a resource quota
+
+You can delete a resource quota from {Project}.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Configure* > *Resource Quotas*.
+. In the *Actions* column, click *Delete* for your resource quota.

guides/common/modules/proc_editing-a-resource-quota.adoc

@@ -0,0 +1,10 @@
+[id="editing-a-resource-quota"]
+= Editing a resource quota
+
+You can edit a resource quota to adjust available resources to {Project} users.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Configure* > *Resource Quotas*.
+. Select your resource quota.
+. Adjust the *CPU cores*, *Memory*, or *Disk space* and click *Apply* to submit your changes to {Project}.
+. Click *Create resource quota* to submit the resouce quota to {Project}.

guides/common/modules/proc_installing-the-resource-quota-plugin.adoc

@@ -0,0 +1,12 @@
+[id="installing-the-resource-quota-plugin"]
+= Installing the Resource Quota plugin
+
+Use the following procedure to install the Resource Quota plugin.
+
+.Procedure
+* Install the plugin on your {ProjectServer}:
++
+[options="nowrap", subs="+quotes,verbatim,attributes"]
+----
+# {foreman-installer} --enable-foreman-plugin-resource-quota
+----

guides/doc-Administering_Project/master.adoc

@@ -60,6 +60,8 @@ include::common/assembly_logging-and-reporting-problems.adoc[leveloffset=+1]
 
 include::common/assembly_monitoring-resources.adoc[leveloffset=+1]
 
+include::common/assembly_limiting-resources.adoc[leveloffset=+1]
+
 include::common/assembly_using-foreman-webhooks.adoc[leveloffset=+1]
 
 include::common/assembly_searching-and-bookmarking.adoc[leveloffset=+1]