Skip to content

Commit fd17825

Browse files
authored
Merge pull request #30901 from adellape/channel_callout
2 parents 922ec15 + eaf7753 commit fd17825

5 files changed

+14
-10
lines changed

modules/olm-changing-update-channel.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
The subscription of an installed Operator specifies an update channel, which is used to track and receive updates for the Operator. To upgrade the Operator to start tracking and receiving updates from a newer channel, you can change the update channel in the subscription.
99

10-
The names of update channels in a subscription can differ between Operators, but the naming scheme should follow a common convention within a given Operator. For example, channel names might follow a minor release update stream for the application provided by the Operator (`1.2`, `1.3`) or a simple release frequency (`stable`, `fast`).
10+
The names of update channels in a subscription can differ between Operators, but the naming scheme should follow a common convention within a given Operator. For example, channel names might follow a minor release update stream for the application provided by the Operator (`1.2`, `1.3`) or a release frequency (`stable`, `fast`).
1111

1212
[NOTE]
1313
====

modules/olm-dependency-resolution-preferences.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ There are two rules that govern catalog preference:
3737
[id="olm-dependency-catalog-ordering_{context}"]
3838
== Channel ordering
3939

40-
An Operator package in a catalog is a collection of update channels that a user can subscribe to in a {product-title} cluster. Channels can be used to provide a particular stream of updates for a minor release (`1.2`, `1.3`) or a simple release frequency (`stable`, `fast`).
40+
An Operator package in a catalog is a collection of update channels that a user can subscribe to in a {product-title} cluster. Channels can be used to provide a particular stream of updates for a minor release (`1.2`, `1.3`) or a release frequency (`stable`, `fast`).
4141

4242
It is likely that a dependency might be satisfied by Operators in the same package, but different channels. For example, version `1.2` of an Operator might exist in both the `stable` and `fast` channels.
4343

modules/olm-installing-from-operatorhub-using-cli.adoc

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -114,15 +114,16 @@ metadata:
114114
name: <subscription_name>
115115
namespace: openshift-operators <1>
116116
spec:
117-
channel: alpha
118-
name: <operator_name> <2>
119-
source: redhat-operators <3>
120-
sourceNamespace: openshift-marketplace <4>
117+
channel: <channel_name> <2>
118+
name: <operator_name> <3>
119+
source: redhat-operators <4>
120+
sourceNamespace: openshift-marketplace <5>
121121
----
122122
<1> For `AllNamespaces` install mode usage, specify the `openshift-operators` namespace. Otherwise, specify the relevant single namespace for `SingleNamespace` install mode usage.
123-
<2> Name of the Operator to subscribe to.
124-
<3> Name of the catalog source that provides the Operator.
125-
<4> Namespace of the catalog source. Use `openshift-marketplace` for the default OperatorHub catalog sources.
123+
<2> Name of the channel to subscribe to.
124+
<3> Name of the Operator to subscribe to.
125+
<4> Name of the catalog source that provides the Operator.
126+
<5> Namespace of the catalog source. Use `openshift-marketplace` for the default OperatorHub catalog sources.
126127

127128
. Create the `Subscription` object:
128129
+

modules/olm-subscription.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,6 @@ spec:
2626

2727
This `Subscription` object defines the name and namespace of the Operator, as well as the catalog from which the Operator data can be found. The channel, such as `alpha`, `beta`, or `stable`, helps determine which Operator stream should be installed from the catalog source.
2828

29+
The names of channels in a subscription can differ between Operators, but the naming scheme should follow a common convention within a given Operator. For example, channel names might follow a minor release update stream for the application provided by the Operator (`1.2`, `1.3`) or a release frequency (`stable`, `fast`).
30+
2931
In addition to being easily visible from the {product-title} web console, it is possible to identify when there is a newer version of an Operator available by inspecting the status of the related subscription. The value associated with the `currentCSV` field is the newest version that is known to OLM, and `installedCSV` is the version that is installed on the cluster.

operators/user/olm-installing-operators-in-namespace.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
2626
include::modules/olm-installing-from-operatorhub-using-cli.adoc[leveloffset=+1]
2727
.Additional resources
2828

29-
* xref:../../operators/understanding/olm/olm-understanding-operatorgroups.adoc#olm-operatorgroups-about_olm-understanding-operatorgroups[About Operator groups]
29+
* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-operatorgroups-about_olm-understanding-olm[Operator groups]
30+
* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-subscription_olm-understanding-olm[Channel names]
3031

3132
include::modules/olm-installing-specific-version-cli.adoc[leveloffset=+1]
3233
.Additional resources

0 commit comments

Comments
 (0)