Skip to content
This repository was archived by the owner on Apr 17, 2025. It is now read-only.

Commit 9e8da52

Browse files
committed
few more syntax fixes for the hrq doc
Signed-off-by: unknown <[email protected]>
1 parent 60c541b commit 9e8da52

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

docs/user-guide/concepts.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -268,13 +268,10 @@ company-a-restrictions (has HRQ)
268268
This way each individual can fairly and securely distribute their resources across
269269
their members.
270270

271-
when creating `HierarchicalResourceQuota`, HNC automatically creates `ResourceQuota`
272-
with name `local-impl-hrq` and propogates it to all subnamespaces. It monitors
273-
the `ResourceQuotas` in the namespace tree, and sums up their usage. If there are multiple
274-
HRQs in the tree, the local `ResourceQuota` will have the combined results of all HRQs
275-
from the parent namespaces.
276-
277-
271+
To implement hierarchical quotas, HNC automatically creates `ResourceQuota` objects in each
272+
affected namespace. These objects should not be modified or relied on by users, as they only
273+
track the resources from individual namespaces, not the entire tree. To inspect hierarchical
274+
quotas, look at the HRQ objects, or use the `kubectl hrq` command.
278275

279276
<a name="basic-propagation">
280277

docs/user-guide/how-to.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This document describes common tasks you might want to accomplish using HNC.
1010
* [Create a subnamespace](#use-subns-create)
1111
* [Inspect namespace hierarchies](#use-inspect)
1212
* [Propagating policies across namespaces](#use-propagate)
13-
* [Limit Resources over parent namespaces](#use-hrq)
13+
* [Apply hierarchical resource quotas (HRQs)](#use-hrq)
1414
* [Select namespaces based on their hierarchies](#use-select)
1515
* [Delete a subnamespace](#use-subns-delete)
1616
* [Organize full namespaces into a hierarchy](#use-full)
@@ -191,7 +191,7 @@ destination (descendant) namespace.
191191

192192
### Limit Resources over parent namespaces
193193

194-
HNC has an object called `HirarchicalResourceQuota` that is similar to `ResourceQuota`
194+
HNC has an object called `HirarchicalResourceQuota` which is a drop-in replacement for `ResourceQuota`
195195
but across all the namespaces in a hierarchy. It allows you to distribute your resources between
196196
teams, and those teams can distribute their resources between their subteams...
197197
[learn how it works](concepts.md#hierarchical-resource-quota) or see an [quickstart example](quickstart.md#hrq)

0 commit comments

Comments
 (0)