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

Commit 8833eca

Browse files
committed
fixed typos and made hrq doc more clear
Signed-off-by: unknown <[email protected]>
1 parent eb306ba commit 8833eca

File tree

3 files changed

+24
-16
lines changed

3 files changed

+24
-16
lines changed

docs/user-guide/concepts.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ namespaces are, and _why_ they behave the way they do.
1313
* [Basic concepts](#basic)
1414
* [Parents, children, trees and forests](#basic-trees)
1515
* [Full namespaces and subnamespaces](#basic-subns)
16-
* [Hierarchical Resource Quotas](#hierarchical-resource-quota)
16+
* [Hierarchical resource quotas (HRQs)](#hrq)
1717
* [Policy inheritance and object propagation](#basic-propagation)
1818
* [Tree labels and non-propagated policies](#basic-labels)
1919
* [Exceptions and propagation control](#basic-exceptions)
@@ -221,21 +221,21 @@ probably not a great idea.
221221
You can create a subnamespace from the command line via `kubectl hns create child
222222
-n parent`.
223223

224-
<a name="hierarchical-resource-quota">
224+
<a name="hrq">
225225

226-
### Hierarchical Resource Quotas
226+
### Hierarchical resource quotas (HRQs)
227227

228228
When you want to give some amount of resources to `team-a`, and want them to be able
229-
to distrtibute their resources between themselves, you create a HierarchicalResourceQuota
230-
in namespace `team-a`. any member from `team-a` can create his own HierarchicalResourceQuota
231-
in his subnamespace, and the sum of all reasources from all the subnamespaces of the
229+
to distrtibute their resources between themselves, you create a `HierarchicalResourceQuota`
230+
in namespace `team-a`. Any member from `team-a` can create their own `HierarchicalResourceQuota`
231+
in his subnamespace, and the sum of all resources from all the subnamespaces of the
232232
members wont be over the amount of resources that is configured in
233-
HierarchicalResourceQuota of namespace `team-a`.
233+
`HierarchicalResourceQuota` of namespace `team-a`.
234234

235-
when creating HierarchicalResourceQuota, HNC automatically creates ResourceQuota
235+
when creating `HierarchicalResourceQuota`, HNC automatically creates `ResourceQuota`
236236
with name `local-impl-hrq` and propogates it to all subnamespaces. It monitors
237-
the ResourceQuotas in the namespace tree, and sums up their usage. If there are multiple
238-
HRQs in the tree, the local ResourceQuota will have the combined results of all HRQs
237+
the `ResourceQuotas` in the namespace tree, and sums up their usage. If there are multiple
238+
HRQs in the tree, the local `ResourceQuota` will have the combined results of all HRQs
239239
from the parent namespaces.
240240

241241

docs/user-guide/how-to.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,11 +191,13 @@ destination (descendant) namespace.
191191

192192
### Limit Resources over parent namespaces
193193

194-
HNC has an object called HirarchicalResourceQuota that is similar to ResourceQuota
195-
but across all namespace tree. It allows you to distribute tour resources between
194+
HNC has an object called `HirarchicalResourceQuota` that is similar to `ResourceQuota`
195+
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)
198198

199+
Note: decimal point values cannot be specified in HRQ (you can't do `cpu: 1.5`). see [#292](https://github.com/kubernetes-sigs/hierarchical-namespaces/issues/292)
200+
199201
<a name="use-select"/>
200202

201203
### Select namespaces based on their hierarchies

docs/user-guide/quickstart.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ acme-org
472472
└── [s] team-b
473473
```
474474

475-
You can create a HierarchicalResourceQuota in namespace `acme-org`, and the sum of
475+
You can create a `HierarchicalResourceQuota` in namespace `acme-org`, and the sum of
476476
all subnamespaces resource usage cant go over what is configured in the hrq.
477477

478478
Creating the hrq:
@@ -530,14 +530,18 @@ EOF
530530
```
531531
We get an error:
532532
```
533-
Error from server (Forbidden): error when creating "STDIN": admission webhood "resourcesquotasstatus.hnc.x-k8s.io" denied the request: exceeded hierarchical quota in namespace "acme-org": "acme-org-hrq", requested: services=1, used: services=1, limited: services=1
533+
Error from server (Forbidden):
534+
error when creating "STDIN":
535+
admission webhood "resourcesquotasstatus.hnc.x-k8s.io" denied the request:
536+
exceeded hierarchical quota in namespace "acme-org":
537+
"acme-org-hrq", requested: services=1, used: services=1, limited: services=1
534538
```
535539

536-
to view the hrq usage simply run
540+
To view the HRQ usage, simply run:
537541
```bash
538542
kubectl hns hrq -n acme-org
539543
```
540-
you can also biew in all namespace
544+
you can also view in all namespace:
541545
```bash
542546
kubectl hns hrq --all-namespaces
543547
```
@@ -547,6 +551,8 @@ and you can delete the hrq via simply deleting the CR:
547551
kubectl delete hrq acme-org-hrq -n acme-org
548552
```
549553

554+
Note: decimal point values cannot be specified (you can't do `cpu: 1.5`). see [#292](https://github.com/kubernetes-sigs/hierarchical-namespaces/issues/292)
555+
550556
<a name="subns"/>
551557

552558
### Subnamespaces deep dive

0 commit comments

Comments
 (0)