[doc] catsrc priority #40
Conversation
| weight: 2 | ||
| --- | ||
|
|
||
| As part of the SAT dependency resolver, OLM can choose from a wide range of catalogs to resolve dependencies. CatalogSource is a CR that defines where the catalog comes from and, therefore, can infer the amount of confidence cluster administrators or operator subscribers would want to rely on certain catalogs. OLM would like to explicitly weight catalogs for the dependency resolver so that certain catalogs can be priorities. The default CatalogSources such as Red Hat, Certified, and community catalogs will be assigned default priorities and subject to changes. |
There was a problem hiding this comment.
the SAT dependency resolver
The translation of dependency resolution problems into SAT is an implementation detail. Leaving that out may help to avoid confusing some readers.
a wide range of catalogs
It's important to be specific about which catalogs are used for dependency resolution. If someone is reading this section of the documentation, they will want to know that dependencies are satisfied from any of the CatalogSources in the same namespace as a Subscription plus any CatalogSources in the configurable global namespace.
Side note: The default global namespace should be more upstream-friendly. It's currently "openshift-operator-lifecycle-manager."
OLM would like to explicitly weight catalogs
I wouldn't say that OLM is weighting catalogs -- it's honoring explicit priorities set by users. Also, I think it would be helpful in general to avoid using "weight" interchangeably with "priority," and to instead use "priority" everywhere that catalog preferences are discussed.
default CatalogSources such as Red Hat, Certified, and community catalogs
This, and the other mention of these specific catalogs, belongs in the OpenShift docs, not here.
There was a problem hiding this comment.
yeah, but the so-called openshift doc lives on the google dive, somehow our code is opensource for those parts as well. we might want to redefine a new place for some of those docs
|
|
||
| Priority field, if specified, is used to rank CatalogSources that contain operators to supply dependencies and prioritize certain catalogs based on their rankings. The CatalogSource Priority for supplying dependencies has the following properties: | ||
| - The higher the value, the higher the priority. | ||
| - The default priorities for Red Hat, Certified, Marketplace and Community CatalogSources are -100,-200,-300, -400 respectively. To make a CatalogSource ranked behind all provided catalogs, cluster admins should assign the catalog with a priority value lower than -400. |
| 1. The CatalogSource of the installing operator. | ||
| 2. The CatalogSource carrying a higher `priority` integer value. | ||
| 3. The CatalogSource in the same namespace as the installing operator. | ||
| 4. Lexicographic order of the CatalogSource name. |
There was a problem hiding this comment.
Increasing lexicographic order, right?
|
|
||
| As part of the SAT dependency resolver, OLM can choose from a wide range of catalogs to resolve dependencies. CatalogSource is a CR that defines where the catalog comes from and, therefore, can infer the amount of confidence cluster administrators or operator subscribers would want to rely on certain catalogs. OLM would like to explicitly weight catalogs for the dependency resolver so that certain catalogs can be priorities. The default CatalogSources such as Red Hat, Certified, and community catalogs will be assigned default priorities and subject to changes. | ||
|
|
||
| ```yaml |
There was a problem hiding this comment.
How useful is it to include this sample manifest?
There was a problem hiding this comment.
Im not sure how else to show the extra field. i mean it is better than say .spec.priority right.
Bowenislandsong
force-pushed
the
catsrc_weighting
branch
2 times, most recently
from
2eeabf5 to
4d995ae
Compare
This commit adds a description for catsrc priority for the dependency resolution.
Bowenislandsong
force-pushed
the
catsrc_weighting
branch
from
24fa882 to
4395c44
Compare
|
Yes - closing since this is now covered in the dependency resolution doc. |
This commit adds a description for catsrc priority for the dependency resolution.