Skip to content

Commit

Permalink
Fix README.md links
Browse files Browse the repository at this point in the history
Add information about the events created by AAQ

Signed-off-by: bmordeha <bmordeha@redhat.com>
  • Loading branch information
Barakmor1 committed Oct 8, 2024
1 parent d1a88f4 commit 3fa2ef8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ KubeVirt is an operator that enables the deployment and management of virtual ma
containerized applications.

As an administrator of a multi-tenant cluster running Virtual Machines with
[KubeVirt](https://github.com/kubevirt/kubevirt?tab=readme-ov-file#introduction,
[KubeVirt](https://github.com/kubevirt/kubevirt?tab=readme-ov-file#introduction),
I expect tenants to be billed only for the resources they explicitly request in the VM object.
However, this presents specific challenges with resource quotas:

Expand Down Expand Up @@ -131,6 +131,7 @@ These new quotas are controller-based rather than admission-based. Here’s how
there is sufficient room for the pod according to the quota.
3. Quotas Update: If there is enough room, the scheduling gate is removed from
the pod, and the quotas used status is updated accordingly.
If not, an event is created explaining why the quota doesn't allow the pod's creation.

***Warning***: Pods that set `.spec.nodeName` are not allowed to use in any namespace where AAQ Operates.
For more information please see [this discussion](https://github.com/kubernetes/enhancements/issues/3521#issuecomment-2016957473).
Expand Down Expand Up @@ -209,7 +210,7 @@ which handles the heavy lifting.
```
For an example of sidecar implementation using the libsidecar library,
refer to [https://github.com/kubevirt/application-aware-quota/tree/main/example_sidecars/label-sidecar).
refer to [this link](https://github.com/kubevirt/application-aware-quota/tree/main/example_sidecars/label-sidecar).
### Deploy it on your cluster
Expand Down
2 changes: 1 addition & 1 deletion docs/openshift-virtualization-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ The applicationAwareConfig object within the HyperConverged resource's spec allo
* `VirtualResources` - Counts compute resources based on the VM's specifications, using the VM's RAM size for memory and virtual CPUs for processing.
* `DedicatedVirtualResources` (default) - Similar to VirtualResources, but separates resource tracking for VM-associated pods by adding a `/vmi` suffix to CPU and memory resource names (e.g., `requests.cpu/vmi`, `limits.memory/vmi`), distinguishing them from other pods.
* `namespaceSelector` - determines in which namespaces AAQ's scheduling gate will be added to pods at creation time.
This field follows the standard selector format.
This field follows the standard selector format. if a namespace selector is not being defined, AAQ would target namespaces with the `application-aware-quota/enable-gating` label as default.
* `allowApplicationAwareClusterResourceQuota` (default = false) - Set to true to enable the creation and management of AAQ's cluster quotas.

Example CLI command to configure AAQ:
Expand Down

0 comments on commit 3fa2ef8

Please sign in to comment.