Skip to content

Commit c4a3108

Browse files
authored
Merge pull request #2657 from ahardin-rh/followup-PR2596
Follow-up edits to PR#2596
2 parents 9803b1f + e96db8e commit c4a3108

File tree

1 file changed

+42
-24
lines changed

1 file changed

+42
-24
lines changed

Diff for: admin_guide/multiproject_quota.adoc

+42-24
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[admin-guide-muliproject-quota]]
2-
= Multi-Project Quotas
2+
= Setting Multi-Project Quotas
33
{product-author}
44
{product-version}
55
:data-uri:
@@ -13,17 +13,28 @@ toc::[]
1313

1414
== Overview
1515

16-
A multi-project quota, defined by a `*ClusterResourceQuota*` object, allows xref:../admin_guide/quota.adoc#admin-guide-quota[quota]
17-
to be shared across multiple projects. Resources used in each selected project
18-
will be aggregated and that aggregate will be used to limit resources across
19-
all the selected projects.
16+
A multi-project quota, defined by a `*ClusterResourceQuota*` object, allows
17+
xref:../admin_guide/quota.adoc#admin-guide-quota[quotas] to be shared across
18+
multiple projects. Resources used in each selected project will be aggregated
19+
and that aggregate will be used to limit resources across all the selected
20+
projects.
2021

2122
[[multi-project-quotas-selecting-projects]]
22-
=== Selecting Projects
23+
== Selecting Projects
2324

2425
Projects can be selected based on either annotation selection, label selection, or both.
25-
For example, `oc create clusterquota for-user --project-annotation-selector openshift.io/requester=<user-name> --hard pods=10 --hard secrets=20`
26-
creates:
26+
For example:
27+
28+
====
29+
----
30+
$ oc create clusterquota for-user \
31+
--project-annotation-selector openshift.io/requester=<user-name> \
32+
--hard pods=10 \
33+
--hard secrets=20
34+
----
35+
====
36+
37+
creates:
2738

2839
====
2940
[source,yaml]
@@ -59,25 +70,32 @@ status:
5970
pods: "1"
6071
secrets: "9"
6172
----
62-
<1> The ResourceQuotaSpec object that will be enforced over the selected projects
63-
<2> A simple key/value selector for annotations
64-
<3> A label selector that can be used to select projects
65-
<4> A per-namespace map that describes current quota usage in each selected project
66-
<5> The aggregate usage across all selected projects
73+
<1> The `*ResourceQuotaSpec*` object that will be enforced over the selected projects.
74+
<2> A simple key/value selector for annotations.
75+
<3> A label selector that can be used to select projects.
76+
<4> A per-namespace map that describes current quota usage in each selected project.
77+
<5> The aggregate usage across all selected projects.
6778
====
6879

69-
This multi-project quota document will control all projects requested by `"<user-name>"` using the default
70-
project request endpoint. He will be limited to ten pods and twenty secrets.
80+
This multi-project quota document controls all projects requested by
81+
*<user-name>* using the default project request endpoint. You are limited to 10
82+
pods and 20 secrets.
7183

7284

7385
[[multi-project-quotas-viewing-applicable-clusterresourcequotas]]
74-
=== Viewing Applicable ClusterResourceQuotas
86+
== Viewing Applicable `*ClusterResourceQuotas*`
87+
88+
A project administrator is not allowed to create or modify the multi-project
89+
quota that limits his or her project, but the administrator is allowed to view the
90+
multi-project quota documents that are applied to his or her project. The
91+
project administrator can do this via the `*AppliedClusterResourceQuota*`
92+
resource.
7593

76-
A project-admin is not allowed to create or modify the multi-project quota that limits
77-
him, but he is allowed to view the multi-project quota documents are applied to his project.
78-
He can do this via the `*AppliedClusterResourceQuota*` resource.
94+
----
95+
$ oc describe AppliedClusterResourceQuota
96+
----
7997

80-
`oc describe AppliedClusterResourceQuota` produces:
98+
produces:
8199

82100
====
83101
----
@@ -97,9 +115,9 @@ secrets 9 20
97115

98116

99117
[[multi-project-quotas-selection-granularity]]
100-
=== Selection Granularity
118+
== Selection Granularity
101119

102-
Because of the locking consideration when claiming quota allocations, the
103-
number of active projects selected by a multi-project quota is an important consideration.
120+
Due to the locking consideration when claiming quota allocations, the number of
121+
active projects selected by a multi-project quota is an important consideration.
104122
Selecting more than 100 projects under a single multi-project quota may have
105-
deleterious effects on API server responsiveness in those projects.
123+
detrimental effects on API server responsiveness in those projects.

0 commit comments

Comments
 (0)