Skip to content

Commit a3272e9

Browse files
mburke5678mburke5678
authored
Merge pull request #80040 from laubai/osdocs-10853-remove-unsupported-kubeletconfig
OSDOCS#10853: Remove unsupported overcommit methods from Managed docs
2 parents 612ab42 + c525c14 commit a3272e9

File tree

5 files changed

+77
-36
lines changed

5 files changed

+77
-36
lines changed

Diff for: ‎_topic_maps/_topic_map_rosa.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1446,6 +1446,7 @@ Topics:
14461446
- Name: Configuring cluster memory to meet container memory and risk requirements
14471447
File: nodes-cluster-resource-configure
14481448
Distros: openshift-rosa
1449+
# TODO: Remove the whole nodes-cluster-overcommit file for OSDOCS-10853?
14491450
- Name: Configuring your cluster to place pods on overcommited nodes
14501451
File: nodes-cluster-overcommit
14511452
Distros: openshift-rosa

Diff for: ‎modules/nodes-cluster-overcommit-project-disable.adoc

+42-11
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,60 @@
77
[id="nodes-cluster-overcommit-project-disable_{context}"]
88
= Disabling overcommitment for a project
99

10+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1011
When enabled, overcommitment can be disabled per-project. For example, you can allow infrastructure components to be configured independently of overcommitment.
12+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1113

12-
.Procedure
14+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
15+
If required by your use case, you can disable overcommitment on any project that is not managed by Red Hat. For a list of projects that cannot be modified, see "Red Hat Managed resources" in _Support_.
1316

14-
To disable overcommitment in a project:
17+
.Prerequisites
18+
* You are logged in to the cluster using an account with cluster administrator or cluster editor permissions.
1519
16-
ifndef::openshift-rosa,openshift-dedicated[]
17-
. Create or edit the namespace object file.
18-
endif::openshift-rosa,openshift-dedicated[]
19-
// Invalid value: "false": field is immutable, try updating the namespace
20-
ifdef::openshift-rosa,openshift-dedicated[]
21-
. Edit the namespace object file.
22-
endif::openshift-rosa,openshift-dedicated[]
20+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
2321

22+
.Procedure
23+
//For OCP and Origin:
24+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
25+
. Create or edit the namespace object file.
2426
. Add the following annotation:
27+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
28+
//For ROSA, ROSA-HCP, OSD:
29+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
30+
. Edit the namespace object file:
31+
.. If you are using the web console:
32+
... Click *Administration* -> *Namespaces* and click the namespace for the project.
33+
... In the *Annotations* section, click the *Edit* button.
34+
... Click *Add more* and enter a new annotation that uses a *Key* of `quota.openshift.io/cluster-resource-override-enabled` and a *Value* of `false`.
35+
... Click *Save*.
36+
ifndef::openshift-rosa,openshift-rosa-hcp[]
37+
.. If you are using the {oc-first}:
38+
... Edit the namespace:
39+
+
40+
[source,terminal]
41+
----
42+
$ oc edit namespace/<project_name>
43+
----
44+
endif::openshift-rosa,openshift-rosa-hcp[]
45+
ifdef::openshift-rosa,openshift-rosa-hcp[]
46+
.. If you are using the ROSA CLI (`rosa`):
47+
... Edit the namespace:
48+
+
49+
[source,terminal]
50+
----
51+
$ rosa edit namespace/<project_name>
52+
----
53+
endif::openshift-rosa,openshift-rosa-hcp[]
54+
... Add the following annotation:
55+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
2556
+
2657
[source,yaml]
2758
----
2859
apiVersion: v1
2960
kind: Namespace
3061
metadata:
3162
annotations:
32-
quota.openshift.io/cluster-resource-override-enabled: "false" <1>
63+
quota.openshift.io/cluster-resource-override-enabled: "false" <.>
3364
# ...
3465
----
35-
<1> Setting this annotation to `false` disables overcommit for this namespace.
66+
<.> Setting this annotation to `false` disables overcommit for this namespace.

Diff for: ‎modules/nodes-cluster-project-overcommit.adoc

+9
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,19 @@
66
[id="nodes-cluster-project-overcommit_{context}"]
77
= Project-level limits
88

9+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
910
To help control overcommit, you can set per-project resource limit ranges,
1011
specifying memory and CPU limits and defaults for a project that overcommit
1112
cannot exceed.
1213

1314
For information on project-level resource limits, see Additional resources.
1415

1516
Alternatively, you can disable overcommitment for specific projects.
17+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
18+
19+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
20+
In {product-title}, overcommitment of project-level resources is enabled by default.
21+
If required by your use case, you can disable overcommitment on projects that are not managed by Red Hat.
22+
23+
For the list of projects that are managed by Red Hat and cannot be modified, see "Red Hat Managed resources" in _Support_.
24+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]

Diff for: ‎nodes/clusters/nodes-cluster-overcommit.adoc

+23-23
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,6 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
10-
11-
12-
13-
149
In an _overcommitted_ state, the sum of the container compute resource requests
1510
and limits exceeds the resources available on the system. For example, you might
1611
want to use overcommitment in development environments where a trade-off of
@@ -24,33 +19,32 @@ The scheduler attempts to optimize the compute resource use across all nodes
2419
in your cluster. It places pods onto specific nodes, taking the pods' compute
2520
resource requests and nodes' available capacity into consideration.
2621

27-
ifndef::openshift-rosa,openshift-dedicated[]
22+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
2823
{product-title} administrators can control the level of overcommit and manage
2924
container density on nodes. You can configure cluster-level overcommit using
3025
the xref:#nodes-cluster-resource-override_nodes-cluster-overcommit[ClusterResourceOverride Operator]
3126
to override the ratio between requests and limits set on developer containers.
3227
In conjunction with xref:#nodes-cluster-node-overcommit_nodes-cluster-overcommit[node overcommit] and
3328
xref:../../applications/deployments/managing-deployment-processes.adoc#deployments-setting-resources_deployment-operations[project memory and CPU limits and defaults], you can adjust the resource limit and request to achieve the desired level of overcommit.
34-
endif::openshift-rosa,openshift-dedicated[]
35-
ifdef::openshift-rosa,openshift-dedicated[]
36-
{product-title} administrators can control the level of overcommit and manage
37-
container density on nodes. You can configure cluster-level overcommit using
38-
the xref:#nodes-cluster-resource-override_nodes-cluster-overcommit[ClusterResourceOverride Operator]
39-
to override the ratio between requests and limits set on developer containers.
40-
In conjunction with xref:#nodes-cluster-node-overcommit_nodes-cluster-overcommit[node overcommit], you can adjust the resource limit and request to achieve the desired level of overcommit.
41-
endif::openshift-rosa,openshift-dedicated[]
4229

4330
[NOTE]
4431
====
4532
In {product-title}, you must enable cluster-level overcommit. Node overcommitment is enabled by default.
4633
See xref:#nodes-cluster-overcommit-node-disable_nodes-cluster-overcommit[Disabling overcommitment for a node].
4734
====
35+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
36+
37+
//ROSA and Dedicated intro
38+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
39+
{product-title} administrators can manage container density on nodes by configuring pod placement behavior and per-project resource limits that overcommit cannot exceed.
40+
41+
Alternatively, administrators can disable project-level resource overcommitment on customer-created namespaces that are not managed by Red Hat.
4842

49-
// The following include statements pull in the module files that comprise
50-
// the assembly. Include any combination of concept, procedure, or reference
51-
// modules required to cover the user story. You can also include other
52-
// assemblies.
43+
For more information about container resource management, see Additional resources.
44+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
5345

46+
//core openshift content
47+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
5448

5549
include::modules/nodes-cluster-overcommit-resource-requests.adoc[leveloffset=+1]
5650

@@ -100,15 +94,21 @@ include::modules/nodes-cluster-overcommit-node-resources.adoc[leveloffset=+2]
10094

10195
include::modules/nodes-cluster-overcommit-node-disable.adoc[leveloffset=+2]
10296

97+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
98+
99+
//ROSA and Dedicated can only do the following, so no ifndef on these
103100
include::modules/nodes-cluster-project-overcommit.adoc[leveloffset=+1]
104101

105102
include::modules/nodes-cluster-overcommit-project-disable.adoc[leveloffset=+2]
106103

107-
ifndef::openshift-rosa,openshift-dedicated[]
108104
[role="_additional-resources"]
109105
[id="nodes-cluster-overcommit-addtl-resources"]
110106
== Additional resources
111-
112-
* xref:../../applications/deployments/managing-deployment-processes.adoc#deployments-triggers_deployment-operations[Setting deployment resources].
113-
* xref:../../nodes/nodes/nodes-nodes-resources-configuring.adoc#nodes-nodes-resources-configuring-setting_nodes-nodes-resources-configuring[Allocating resources for nodes].
114-
endif::openshift-rosa,openshift-dedicated[]
107+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
108+
* xref:../../applications/deployments/managing-deployment-processes.adoc#deployments-triggers_deployment-operations[Setting deployment resources]
109+
* xref:../../nodes/nodes/nodes-nodes-resources-configuring.adoc#nodes-nodes-resources-configuring-setting_nodes-nodes-resources-configuring[Allocating resources for nodes]
110+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
111+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
112+
* xref:../../nodes/clusters/nodes-cluster-limit-ranges.adoc#nodes-cluster-limit-ranges[Restrict resource consumption with limit ranges]
113+
* xref:../../support/troubleshooting/sd-managed-resources.adoc#sd-managed-resources[Red Hat Managed resources]
114+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]

Diff for: ‎support/troubleshooting/sd-managed-resources.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="sd-managed-resources"]
3-
= {product-title} managed resources
3+
= Red{nbsp}Hat managed resources
44
include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: sd-managed-resources
66

@@ -9,7 +9,7 @@ toc::[]
99
[id="sd-managed-resources-overview_{context}"]
1010
== Overview
1111

12-
The following covers all resources managed or protected by the Service Reliability Engineering Platform (SRE-P) Team. Customers should not attempt to modify these resources because doing so can lead to cluster instability.
12+
The following covers all {product-title} resources that are managed or protected by the Service Reliability Engineering Platform (SRE-P) Team. Customers should not attempt to modify these resources because doing so can lead to cluster instability.
1313

1414
[id="sd-managed-resources-all_{context}"]
1515
== Hive managed resources

0 commit comments

Comments
 (0)