Skip to content

Commit aaa126e

Browse files
authored
Merge pull request #64481 from stevsmit/OSDOCS-7702
Updates cluster capabilities docs with optional IR disablement
2 parents 601dbe7 + 360ba03 commit aaa126e

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed

installing/cluster-capabilities.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ include::modules/cluster-samples-operator.adoc[leveloffset=+2]
8080
.Additional resources
8181
* xref:../openshift_images/configuring-samples-operator.adoc#configuring-samples-operator[Configuring the Cluster Samples Operator]
8282
83+
include::modules/cluster-image-registry-operator.adoc[leveloffset=+2]
84+
85+
[role="_additional-resources"]
86+
.Additional resources
87+
* xref:../registry/configuring-registry-operator.adoc#configuring-registry-operator[Image Registry Operator in {product-title}]
88+
8389
[role="_additional-resources"]
8490
[id="additional-resources_{context}"]
8591
== Additional resources

modules/cluster-image-registry-operator.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,28 @@
11
// Module included in the following assemblies:
22
//
33
// * operators/operator-reference.adoc
4+
// * installing/cluster-capabilities.adoc
5+
6+
// operators/operator-reference.adoc
7+
ifeval::["{context}" == "cluster-operators-ref"]
8+
:operator-ref:
9+
endif::[]
10+
11+
// installing/cluster-capabilities.adoc
12+
ifeval::["{context}" == "cluster-capabilities"]
13+
:cluster-caps:
14+
endif::[]
415

516
[id="cluster-image-registry-operator_{context}"]
617
= Cluster Image Registry Operator
718

819
[discrete]
920
== Purpose
1021

22+
ifdef::cluster-caps[]
23+
The Cluster Image Registry Operator provides features for the `ImageRegistry` capability.
24+
endif::[]
25+
1126
The Cluster Image Registry Operator manages a singleton instance of the {product-registry}. It manages all configuration of the registry, including creating storage.
1227

1328
On initial start up, the Operator creates a default `image-registry` resource instance based on the configuration detected in the cluster. This indicates what cloud storage type to use based on the cloud provider.
@@ -16,6 +31,10 @@ If insufficient information is available to define a complete `image-registry` r
1631

1732
The Cluster Image Registry Operator runs in the `openshift-image-registry` namespace and it also manages the registry instance in that location. All configuration and workload resources for the registry reside in that namespace.
1833

34+
ifdef::cluster-caps[]
35+
If you disable the `ImageRegistry` capability, you can reduce the overall resource footprint of {product-title} in Telco environments. Depending on your deployment, you can disable this component if you do not need it.
36+
endif::[]
37+
1938
[discrete]
2039
== Project
2140

snippets/capabilities-table.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ The following table describes the `baselineCapabilitySet` values.
1919
|`v4.13`
2020
|Specify this option when you want to enable the default capabilities for {product-title} 4.13. By specifying `v4.13`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.13 are `baremetal`, `marketplace`, `openshift-samples`, `Console`, `Insights`, `Storage`, `CSISnapshot` and `NodeTuning`.
2121

22+
|`v4.14`
23+
|Specify this option when you want to enable the default capabilities for {product-title} 4.14. By specifying `v4.14`, capabilities that are introduced in newer versions of {product-title} are not enabled. The default capabilities in {product-title} 4.14 are `baremetal`, `marketplace`, `openshift-samples`, `Console`, `Insights`, `Storage`, `CSISnapshot`, `NodeTuning`, and `ImageRegistry`.
24+
2225
// TODO: Add `Build` and `DeploymentConfig` to the list for 4.14.
2326

2427
|`None`

0 commit comments

Comments
 (0)