Skip to content

Commit 29acd25

Browse files
authored
Merge pull request #60979 from dfitzmau/OSDOCS-6205
OSDOCS-6205: Added note for default OperatorHub source pods
2 parents b2d81c6 + 24489a5 commit 29acd25

File tree

2 files changed

+50
-4
lines changed

2 files changed

+50
-4
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * admin/olm-cs-podsched.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="disabling-catalogsource-objects_{context}"]
7+
= Disabling default CatalogSource objects at a local level
8+
9+
You can apply persistent changes to a `CatalogSource` object, such as catalog source pods, at a local level, by disabling a default `CatalogSource` object. Consider the default configuration in situations where the default `CatalogSource` object's configuration does not meet your organization's needs. By default, if you modify fields in the `spec.grpcPodConfig` section of the `CatalogSource` object, the Marketplace Operator automatically reverts these changes.
10+
11+
The Marketplace Operator, `openshift-marketplace`, manages the default custom resources (CRs) of the `OperatorHub`. The `OperatorHub` manages `CatalogSource` objects.
12+
13+
To apply persistent changes to `CatalogSource` object, you must first disable a default `CatalogSource` object.
14+
15+
.Procedure
16+
17+
* To disable all the default `CatalogSource` objects at a local level, enter the following command:
18+
+
19+
[source,terminal]
20+
----
21+
$ oc patch operatorhub cluster -p '{"spec": {"disableAllDefaultSources": true}}' --type=merge
22+
----
23+
+
24+
[NOTE]
25+
====
26+
You can also configure the default `OperatorHub` CR to either disable all `CatalogSource` objects or disable a specific object.
27+
====

operators/admin/olm-cs-podsched.adoc

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,51 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
When an Operator Lifecycle Manager (OLM) catalog source of source type `grpc` defines a `spec.image`, the Catalog Operator creates a pod that serves the defined image content. By default, this pod defines the following in its spec:
9+
When an Operator Lifecycle Manager (OLM) catalog source of source type `grpc` defines a `spec.image`, the Catalog Operator creates a pod that serves the defined image content. By default, this pod defines the following in its specification:
1010

11-
* Only the `kubernetes.io/os=linux` node selector
12-
* No priority class name
13-
* No tolerations
11+
* Only the `kubernetes.io/os=linux` node selector.
12+
* The default priority class name: `system-cluster-critical`.
13+
* No tolerations.
1414
1515
As an administrator, you can override these values by modifying fields in the `CatalogSource` object's optional `spec.grpcPodConfig` section.
1616

17+
[IMPORTANT]
18+
====
19+
The Marketplace Operator, `openshift-marketplace`, manages the default `OperatorHub` custom resource's (CR). This CR manages `CatalogSource` objects. If you attempt to modify fields in the `CatalogSource` object’s `spec.grpcPodConfig` section, the Marketplace Operator automatically reverts these modifications.By default, if you modify fields in the `spec.grpcPodConfig` section of the `CatalogSource` object, the Marketplace Operator automatically reverts these changes.
20+
21+
To apply persistent changes to `CatalogSource` object, you must first disable a default `CatalogSource` object.
22+
====
23+
1724
[role="_additional-resources"]
1825
.Additional resources
1926

2027
* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-catalogsource_olm-understanding-olm[OLM concepts and resources -> Catalog source]
2128
29+
include::modules/disabling-catalogsource-objects.adoc[leveloffset=+1]
30+
31+
[role="_additional-resources"]
32+
.Additional resources
33+
34+
* xref:../../operators/understanding/olm-understanding-operatorhub.adoc#olm-operatorhub-arch-operatorhub_crd_olm-understanding-operatorhub[OperatorHub custom resource]
35+
36+
* xref:../../operators/admin/olm-restricted-networks.html#olm-restricted-networks-operatorhub_olm-restricted-networks[Disabling the default OperatorHub catalog sources]
37+
2238
include::modules/olm-node-selector.adoc[leveloffset=+1]
39+
2340
[role="_additional-resources"]
2441
.Additional resources
2542

2643
* xref:../../nodes/scheduling/nodes-scheduler-node-selectors.adoc#nodes-scheduler-node-selectors[Placing pods on specific nodes using node selectors]
2744
2845
include::modules/olm-priority-class-name.adoc[leveloffset=+1]
46+
2947
[role="_additional-resources"]
3048
.Additional resources
3149

3250
* xref:../../nodes/pods/nodes-pods-priority.adoc#admin-guide-priority-preemption-priority-class_nodes-pods-priority[Pod priority classes]
3351
3452
include::modules/olm-tolerations.adoc[leveloffset=+1]
53+
3554
[role="_additional-resources"]
3655
.Additional resources
3756

0 commit comments

Comments
 (0)