Skip to content

Commit 554ead8

Browse files
OSSM-9336
1 parent 10b082a commit 554ead8

6 files changed

+69
-1
lines changed

modules/ossm-about-deployment-and-update-strategies.adoc

-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
:_mod-docs-content-type: Concept
55
[id="ossm-about-deployment-and-update-strategies_{context}"]
66
= About update strategies
7-
:context: ossm-about-deployment-and-update-strategies
87

98
The update strategy affects how the update process is performed. For each mesh, you select one of two strategies:
109

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// Module included in the following assemblies:
2+
//
3+
// update/ossm-updating-openshift-service-mesh.adoc
4+
5+
:_mod-docs-content-type: Concept
6+
[id="ossm-about-operator-update-process_{context}"]
7+
= About Operator update process
8+
9+
The {SMProduct} Operator will upgrade automatically to the latest available version based on the selected channel when the *approval strategy* field is set to `Automatic` (default). If the *approval strategy* field is set to `Manual`, OLM will generate an update request, which a cluster administrator must approve to update the Operator to the latest version.
10+
11+
The Operator update process does not automatically update the {istio} control plane unless the `{istio}` resource version is set to an alias (for example, `vX.Y-latest`) and the `updateStrategy` is set to `InPlace`. This triggers a control plane update when a new version is available in the Operator. By default, the Operator will not update the {istio} control plane unless the `{istio}` resource is updated with a new version.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Module included in the following assemblies:
2+
//
3+
// update/ossm-updating-openshift-service-mesh.adoc
4+
5+
:_mod-docs-content-type: Concept
6+
[id="ossm-understanding-operator-updates-and-channels_{context}"]
7+
= Understanding Operator updates and channels
8+
9+
The {olm-first} manages Operators and their associated services using channels to organise and distribute updates. Channels are a way to group related updates together.
10+
11+
To ensure that your {SMProduct} stays current with the latest security patches, bug fixes, and software updates, keep the {SMProduct} Operator up to date. The upgrade process depends on the configured channel and approval strategy.
12+
13+
OLM provides the following channels for the {SMProduct} Operator:
14+
15+
* *Stable* channel: tracks the most recent version of the {SMProduct} 3 Operator and the latest supported version of {istio}. This channel enables upgrades to new operator versions and corresponding {istio} updates as soon as they are released. Use the stable channel to stay current with the latest features, bug fixes, and security updates.
16+
17+
* *Versioned* channel: restricts updates to patch-level releases within a specific minor version. For example, `stable-3.0` provides access to the latest `{SMProductVersion}` patch version. When a new patch release becomes available, you can upgrade the Operator to the newer patch version. To move to a newer minor release, you must manually switch to a different channel. You can use a versioned channel to maintain a consistent minor version while applying only patch updates.
18+
19+
[NOTE]
20+
====
21+
You can find the *update strategy* field in the *Install Operator* section and under the sub-section *update approval*. The default value for the *update strategy* is `Automatic`.
22+
====
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Module included in the following assemblies:
2+
//
3+
// update/ossm-updating-openshift-service-mesh.adoc
4+
5+
:_mod-docs-content-type: Concept
6+
[id="ossm-understanding-sm-istio-versions_{context}"]
7+
= Understanding Service Mesh and Istio versions
8+
9+
The most current {SMProduct} Operator version is {SMProductVersion}. This version supports the features listed in the "{SMProductShortName} {SMProductVersion} feature support tables". The {SMProduct} Operator includes additional {istio} releases for upgrades but supports only the latest {istio} version available for each Operator version. See the "{SMProductShortName} version support tables" to identify the supported {istio} version for each Operator release.
+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Module included in the following assemblies:
2+
//
3+
// update/ossm-updating-openshift-service-mesh.adoc
4+
5+
:_mod-docs-content-type: Concept
6+
[id="ossm-understanding-versioning_{context}"]
7+
= Understanding versioning
8+
9+
{product-title} follows Semantic Versioning for all product releases. Semantic Versioning uses a three-part version number in the format `X.Y.Z` to communicate the nature of changes in each release.
10+
11+
X (Major version):: indicates significant updates that may include breaking changes, such as architectural shifts, API changes, or schema modifications.
12+
13+
Y (Minor version):: introduces new features and enhancements while maintaining backward compatibility.
14+
15+
Z (Patch version or z-stream release):: delivers critical bug fixes and security updates, such as Common Vulnerabilities and Exposures (CVEs) resolutions. Patch versions do not include new features.
16+

update/ossm-updating-openshift-service-mesh.adoc

+11
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ toc::[]
88

99
The strategy you use to deploy a service mesh affects how you can update the mesh.
1010

11+
include::modules/ossm-understanding-versioning.adoc[leveloffset=+1]
12+
include::modules/ossm-understanding-sm-istio-versions.adoc[leveloffset=+1]
13+
14+
[role="_additional-resources"]
15+
.Additional resources
16+
17+
* xref:../ossm-release-notes/ossm-release-notes-feature-support-tables.adoc#ossm-release-notes-feature-support-tables[{SMProductShortName} {SMProductVersion} feature support tables]
18+
* xref:../ossm-release-notes/ossm-release-notes-version-support-tables.adoc#ossm-release-notes-version-support-tables[Service Mesh version support tables]
19+
20+
include::modules/ossm-understanding-operator-updates-and-channels.adoc[leveloffset=+1]
21+
include::modules/ossm-about-operator-update-process.adoc[leveloffset=+2]
1122
include::modules/ossm-about-deployment-and-update-strategies.adoc[leveloffset=+1]
1223
include::modules/ossm-about-inplace-strategy.adoc[leveloffset=+1]
1324
include::modules/ossm-select-inplace-strategy.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)