Skip to content

Commit 31be630

Browse files
rhesloprheslop
authored
Merge pull request #111679 from rheslop/main-cnv-62019
Add UI information about AAQ operator
2 parents f2557f8 + 242c43a commit 31be630

7 files changed

Lines changed: 247 additions & 17 deletions

‎modules/virt-creating-vm-quotas-web.adoc‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="virt-creating-vm-quotas-web_{context}"]
7+
= Creating virtual machine quotas using the web console
8+
9+
[role="_abstract"]
10+
You can create Application Aware Quota (AAQ) quotas that limit virtual machine resource consumption by using the guided form in the {product-title} web console. The form is the recommended approach for simple virtualization quota use cases.
11+
12+
.Prerequisites
13+
14+
* You have cluster administrator privileges.
15+
* The Application Aware Quota operator is enabled in your cluster. See xref:virt-enabling-aaq-operator_{context}[Enabling the Application Aware Quota operator].
16+
* The project where you want to create the quota exists.
17+
18+
.Procedure
19+
20+
. In the {product-title} web console, click *Virtualization* -> *Quotas*.
21+
22+
. Click *Create quota*.
23+
24+
. In the dropdown menu, select *With form*.
25+
+
26+
The create quota form is displayed.
27+
28+
. Enter a name for your quota in the *Name* field.
29+
+
30+
The name must be unique within the project.
31+
32+
. Select the project where you want to apply this quota.
33+
+
34+
By default, the current project is selected. You can click the dropdown to select a different project if needed.
35+
+
36+
[NOTE]
37+
====
38+
If a Kubernetes `ResourceQuota` already exists in the selected project, an alert is displayed with a link to view the existing ResourceQuota. You can still create the AAQ quota, but both quotas will apply to the project.
39+
====
40+
41+
. Configure CPU, memory, and VMI limits for the quota:
42+
+
43+
The fields displayed vary based on the selected quota calculation method. For example:
44+
+
45+
* For the `Virtual resources` or `Dedicated virtual resources` quota calculation method, the quotas exclude pod overhead:
46+
** Use the *vCPU allocation* field to set the maximum number of virtual CPUs permitted for all VMs in the project, excluding infrastructure overhead.
47+
** Use the *Virtual memory allocation* field to set the maximum memory capacity, in GiB, excluding infrastructure overhead.
48+
** Use the *VMI limits* field to set the maximum number of virtual machine instances.
49+
* For the `Virtual Machine Instance (VMI) pod usage` quota calculation method, the quotas include pod overhead:
50+
** Use the *CPU allocation* field to set the maximum number of CPU cores for pods that run VM workloads
51+
** Use the *Memory allocation* field to set the maximum memory capacity, in GiB, for pods that run VM workloads.
52+
** Use the *VMI limits* field to set the maximum number of virtual machine instances.
53+
+
54+
[NOTE]
55+
====
56+
Live migration overhead is excluded from the `Virtual Machine Instance (VMI) pod usage` quota calculation method.
57+
====
58+
59+
. Review the configuration and click *Create*.
60+
+
61+
The quota is created and you are redirected to the quota details page. The new quota is now active and enforcing resource limits on virtual machines in the selected project.
62+
63+
.Verification
64+
65+
. In the {product-title} web console, click *Virtualization* -> *Quotas*.
66+
67+
. In the quotas list, locate your newly created quota.
68+
69+
. Verify that the quota name is displayed in the list with the correct project and resource limits configured.
70+
71+
. Click the quota name to open its details page and confirm all settings are correct.

‎modules/virt-enabling-aaq-operator.adoc‎

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,37 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/virtual_machines/advanced_vm_management/virt-understanding-aaq-operator.adoc
3+
// * virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="virt-enabling-aaq-operator_{context}"]
7-
= Enabling the AAQ Operator
7+
= Enabling the Application Aware Quota Operator
88

99
[role="_abstract"]
10-
To deploy the AAQ Operator, set the `enableApplicationAwareQuota` field value to `true` in the `HyperConverged` custom resource (CR).
10+
Enable the Application Aware Quota (AAQ) operator to manage resource quotas to extend native resource management capabilities. Enabling AAQ from the web console eliminates the need to manually edit the HyperConverged custom resource by using the CLI.
1111

1212
.Prerequisites
13-
* You have access to the cluster as a user with `cluster-admin` privileges.
14-
* You have installed the OpenShift CLI (`oc`).
13+
14+
* You have cluster administrator privileges.
15+
* The OpenShift Virtualization operator is installed and running.
1516
1617
.Procedure
17-
* Set the `enableApplicationAwareQuota` field value to `true` in the `HyperConverged` CR by running the following command:
18+
19+
. In the {product-title} web console, click *Virtualization* -> *Settings*.
20+
21+
. Under *Resource Management*, toggle the *Application Aware Quotas (AAQ)* to On.
22+
+
23+
The operator deployment begins automatically. The status changes from *Disabled* to *Enabled* after the operator pods are running.
24+
25+
. Optional: Click the *Edit* icon next to the *Quota calculation method* field to change the calculation method.
1826
+
19-
[source,terminal,subs="attributes+"]
20-
----
21-
$ oc patch {HCOCliKind} kubevirt-hyperconverged -n {CNVNamespace} \
22-
--type json -p '[{"op": "add", "path": "/spec/enableApplicationAwareQuota", "value": true}]'
23-
----
27+
A modal dialog is displayed with the following options:
28+
29+
** *Virtual resources*: Measures only the virtual CPU and memory allocated to virtual machines (VMs), excluding pod runtime overhead. This is the default option for virtualization workloads.
30+
** *Virtual Machine Instance (VMI) pod usage*: Measures the total virtual CPU and memory consumption of the VM pod, including both the virtual machine and pod runtime overhead.
31+
** *Dedicated virtual resources*: Measures the virtual CPU and memory resources assigned to virtual machines and their associated pods, tracking quota usage separately for each type.
32+
33+
. Select your preferred quota calculation method and click *Save*.
34+
35+
.Verification
36+
37+
. Verify that a new *Quotas* option is displayed in the left navigation menu under *Virtualization*. This indicates that AAQ is ready for quota creation and management.

‎modules/virt-managing-quota-details-web.adoc‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="virt-managing-quota-details-web_{context}"]
7+
= Managing virtual machine quota details using the web console
8+
9+
[role="_abstract"]
10+
The quota details page in the {product-title} web console provides information about an Application Aware Quota (AAQ), including resource limits, current usage, and visualizations of how quota capacity is being consumed.
11+
12+
[NOTE]
13+
====
14+
Cluster scoped quotas show only the YAML definition due to the complexity that these quotas require.
15+
====
16+
17+
.Prerequisites
18+
19+
* You have cluster administrator privileges.
20+
* The Application Aware Quota operator is enabled in your cluster.
21+
* An Application Aware Quota exists in your cluster.
22+
23+
.Procedure
24+
25+
. In the {product-title} web console, click *Virtualization* -> *Quotas*.
26+
27+
. Click the quota name to open the *Quota details* view.
28+
+
29+
The *Quota details* view displays visual indicators, quota metadata, and tabulated data:
30+
+
31+
* Circular utilization charts visually represent resource consumption in your project
32+
* The *Details* element provides metadata such as the Quota name, scope, applied labels and project.
33+
* The *Quota details* element provides a tabulated views that display the current and maximum utilization of each resource type.
34+
+
35+
[NOTE]
36+
====
37+
If a Kubernetes `ResourceQuota` also exists in the same project as this AAQ quota, an alert is displayed at the top of the details page with a link to view the ResourceQuota. Both quotas apply simultaneously to the project.
38+
====
39+
40+
. Optional: Click the *YAML* tab to review the resource configuration of the quota.
41+
42+
. Optional: Use the *Actions* panel to edit or delete the quota.

‎modules/virt-managing-quotas-list-web.adoc‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="virt-managing-quotas-list-web_{context}"]
7+
= Managing virtual machine quotas using the list view
8+
9+
[role="_abstract"]
10+
The Application Aware Quota (AAQ) quotas page in the {product-title} web console provides a centralized view of all quotas managed by the AAQ operator. From this page, you can view quota status, usage, and perform management actions such as editing and deleting quotas.
11+
12+
.Prerequisites
13+
14+
* You have cluster administrator privileges.
15+
* The Application Aware Quota operator is enabled in your cluster.
16+
* At least one Application Aware Quota exists in a namespace that matches the label selector configured in the HyperConverged Operator (HCO).
17+
18+
.Procedure
19+
20+
. In the {product-title} web console, click *Virtualization* -> *Quotas*.
21+
+
22+
The quotas list view is displayed, showing all project-scoped AAQ quotas by default.
23+
24+
. Click the *Cluster-scoped quotas* tab to view cluster scoped quotas.
25+
+
26+
This tab is displayed only if cluster-scoped quotas have been defined in your cluster.
27+
+
28+
[NOTE]
29+
====
30+
Cluster-scoped quotas can only be created or edited using YAML. The form-based creation option is not available for cluster-scoped quotas due to their complexity.
31+
====
32+
33+
. To view detailed information about a specific quota, click the quota name to open the quota details page.
34+
35+
. To edit a quota, click the Options menu {kebab} at the end of the quota row
36+
.. Select *Edit quota*.
37+
+
38+
The edit form is displayed with the current quota configuration.
39+
.. Click *Save* after you have completed modifying the resource limits.
40+
+
41+
[NOTE]
42+
====
43+
If the quota was initially created with advanced settings via YAML, clicking *Edit quota* opens the YAML editor instead of the form.
44+
====
45+
46+
. To delete a quota, click the Options menu {kebab} at the end of the quota row and select *Delete quota*. A confirmation dialog is displayed.
47+
.. Click *Delete* to remove the quota.
48+
+
49+
[WARNING]
50+
====
51+
Deleting a quota removes all resource enforcement for the quota. Virtual machines in the affected project are no longer subject to the quota limits.
52+
====
53+
54+
. To create a new quota from the list view, click *Create quota*.
55+
.. Select an option from the dropdown menu:
56+
+
57+
** *With form*: Opens the form-based creation experience for simple VM quota use cases.
58+
** *With YAML*: Opens the YAML editor for advanced quota configurations that include pod limits or other resource types.

‎modules/virt-setting-resource-quota-limits-for-vms.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/virtual_machines/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc
3+
// * virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="virt-setting-resource-quota-limits-for-vms_{context}"]
7-
= Setting resource quota limits for virtual machines
7+
= Setting resource quota limits for virtual machines by using the CLI
88

99
[role="_abstract"]
1010
By default, {VirtProductName} automatically manages CPU and memory limits for virtual machines (VMs) if a namespace enforces resource quotas that require limits to be set. The memory limit is automatically set to twice the requested memory and the CPU limit is set to one per vCPU.
@@ -48,9 +48,9 @@ spec:
4848
+
4949
where
5050
+
51-
spec.template.spec.domain.memory.guest:: Specifies the actual amount of RAM that is shown to the guest operating system (OS) in the VM.
51+
spec.template.spec.domain.memory.guest:: Specifies the actual amount of RAM that is shown to the guest operating system in the VM.
5252
+
53-
spec.template.spec.domain.resources.limits.memory:: Specifies the hard limit for total memory consumption by the `virt-launcher` pod that hosts the VM. This limit must account for the guest OS RAM plus the hypervisor overhead.
53+
spec.template.spec.domain.resources.limits.memory:: Specifies the hard limit for total memory consumption by the `virt-launcher` pod that hosts the VM. This limit must account for the guest operating system RAM plus the hypervisor runtime resource consumption.
5454
+
5555
This example configuration is supported because the `spec.template.spec.domain.resources.limits.memory` value is at least `100Mi` larger than the `spec.template.spec.domain.memory.guest` value.
5656

‎modules/virt-understanding-aaq-operator.adoc‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="virt-understanding-aaq-operator_{context}"]
7+
= Understanding the Application Aware Quota Operator
8+
9+
[role="_abstract"]
10+
The Application Aware Quota (AAQ) operator extends Kubernetes native `ResourceQuota` to measure virtual machine (VM) resource consumption in mixed pod and VM environments.
11+
12+
AAQ provides quota enforcement designed for virtualization workloads:
13+
14+
Kubernetes ResourceQuota:: Measures and enforces resource limits at the pod level. When applied to VMs, it measures the entire VM pod's resource consumption, including hypervisor overhead and pod infrastructure, which does not reflect actual VM resource allocation.
15+
16+
Application Aware Quota (AAQ):: Extends ResourceQuota functionality to accurately measure and enforce VM resource consumption. AAQ understands the virtualization layer and can measure actual virtual CPU and memory allocated to VMs, separate from pod overhead.
17+
18+
AAQ supports two types of quotas:
19+
20+
Project-scoped quotas:: Apply resource limits to a specific namespace or project. These are the most common use case for virtualization workloads.
21+
22+
Cluster-scoped quotas:: Apply resource limits across the entire cluster. These are useful for advanced scenarios where you need cluster-wide resource enforcement.
23+
24+
When you enable AAQ, you must configure a quota calculation method. This setting determines how AAQ measures VM resource consumption across your cluster:
25+
26+
Virtual resources:: Measures only the virtual CPU and memory allocated to virtual machines (VMs), excluding pod runtime overhead. This is the default option for virtualization workloads.
27+
28+
Virtual Machine Instance (VMI) pod usage:: Measures the total virtual CPU and memory consumption of the VM pod, including both the virtual machine and pod runtime overhead.
29+
30+
Dedicated virtual resources:: Measures the virtual CPU and memory resources assigned to virtual machines and their associated pods, tracking quota usage separately for each type.

‎virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,23 @@ Create and manage resource quotas for virtual machines.
1313

1414
include::modules/virt-setting-resource-quota-limits-for-vms.adoc[leveloffset=+1]
1515

16+
include::modules/virt-understanding-aaq-operator.adoc[leveloffset=+1]
17+
18+
include::modules/virt-enabling-aaq-operator.adoc[leveloffset=+1]
19+
20+
include::modules/virt-creating-vm-quotas-web.adoc[leveloffset=+1]
21+
22+
include::modules/virt-managing-quotas-list-web.adoc[leveloffset=+1]
23+
24+
include::modules/virt-managing-quota-details-web.adoc[leveloffset=+1]
25+
26+
[id="additional-resources_virt-working-with-resource-quotas-for-vms"]
1627
[role="_additional-resources"]
17-
[id="additional-resources_{context}"]
1828
== Additional resources
1929
* xref:../../../applications/quotas/quotas-setting-per-project.adoc#quotas-setting-per-project[Resource quotas per project]
20-
* xref:../../../applications/quotas/quotas-setting-across-multiple-projects.adoc#quotas-setting-across-multiple-projects[Resource quotas across multiple projects]
30+
* xref:../../../applications/quotas/quotas-setting-across-multiple-projects.adoc#quotas-setting-across-multiple-projects[Resource quotas across many projects]
31+
* xref:../../../virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc#virt-understanding-aaq-operator_virt-working-with-resource-quotas-for-vms[Understanding the Application Aware Quota operator]
32+
* xref:../../../virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc#virt-enabling-aaq-operator_virt-working-with-resource-quotas-for-vms[Enabling the Application Aware Quota operator]
33+
* xref:../../../virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc#virt-creating-vm-quotas-web_virt-working-with-resource-quotas-for-vms[Creating virtual machine quotas using the web console]
34+
* xref:../../../virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc#virt-managing-quotas-list-web_virt-working-with-resource-quotas-for-vms[Managing virtual machine quotas using the list view]
35+
* xref:../../../virt/managing_vms/advanced_vm_management/virt-working-with-resource-quotas-for-vms.adoc#virt-managing-quota-details-web_virt-working-with-resource-quotas-for-vms[Managing virtual machine quota details using the web console]

0 commit comments

Comments
 (0)