Skip to content

OSSM-10597 Arrange the release notes assembly for 3.1 #99636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 25, 2025
Merged

OSSM-10597 Arrange the release notes assembly for 3.1 #99636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions _topic_maps/_topic_map.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ Name: Release Notes
Dir: ossm-release-notes
Distros: openshift-service-mesh
Topics:
- Name: Service Mesh 3.x release notes
- Name: Service Mesh 3.1 release notes
File: ossm-release-notes
- Name: Service Mesh 3.x version support tables
- Name: Service Mesh 3.1 version support tables
File: ossm-release-notes-version-support-tables
- Name: Service Mesh 3.x feature support tables
- Name: Service Mesh 3.1 feature support tables
File: ossm-release-notes-feature-support-tables
---
Name: Migrating from Service Mesh 2 to Service Mesh 3
Expand Down
2 changes: 1 addition & 1 deletion modules/ossm-release-notes-observability-features.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ Module included in the following assemblies:
| NA
|===

. While Grafana is not included as part of {SMProduct}, the preconfigured dashboards for Grafana maintained by the Istio community can be use with {SMProduct} under a Developer Preview scope. These are best used as a starting point for building your own dashboards.
. While Grafana is not included as part of {SMProduct}, you can use the preconfigured dashboards for Grafana maintained by the {istio} community with {SMProduct} under a Developer Preview scope.
106 changes: 1 addition & 105 deletions modules/ossm-release-notes-supported-versions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,108 +91,4 @@ See the following table for information about {SMProduct} 3.1.0 supported versio
|Kiali Operator
|2.11.1

|===

See the following table for information about {SMProduct} 3.0.3 supported versions.

== {SMProduct} 3.0.3 supported versions

[cols="1,1"]
|===
| Feature | Supported versions

|{SMProduct} 3 Operator
|3.0.3

|{SMProduct} `Istio` control plane resource
|1.24.6

|{ocp-product-title}
|4.14 and later

| Envoy proxy
| 1.32.6

| `IstioCNI` resource
| 1.24.6 ^[1]^

|Kiali Operator
|2.4.7

|===

. The `Istio` control plane and `IstioCNI` resources can be upgraded in any order, as long as their version difference is within one minor version.

See the following table for information about {SMProduct} 3.0.2 supported versions.

== {SMProduct} 3.0.2 supported versions

[cols="1,1"]
|===
| Feature | Supported versions

|{SMProduct} 3 Operator
|3.0.2

|{SMProduct} `Istio` control plane resource
|1.24.5

|{ocp-product-title}
|4.14 and later

| Envoy proxy
| 1.32.6

| `IstioCNI` resource
| 1.24.5 ^[1]^
|===

See the following table for information about {SMProduct} 3.0.1 supported versions.

== {SMProduct} 3.0.1 supported versions

[cols="1,1"]
|===
| Feature | Supported versions

|{SMProduct} 3 Operator
|3.0.1

|{SMProduct} `Istio` control plane resource
|1.24.4

|{ocp-product-title}
|4.14 and later

| Envoy proxy
| 1.32.4

| `IstioCNI` resource
| 1.24.4 ^[1]^
|===

See the following table for information about {SMProduct} 3.0.0 supported versions.

== {SMProduct} 3.0.0 supported versions

[cols="1,1"]
|===
| Feature | Supported versions

|{SMProduct} 3 Operator
|3.0.0

|{SMProduct} `Istio` control plane resource
|1.24.3

|{ocp-product-title}
|4.14 and later

| Envoy proxy
| 1.32.4

| `IstioCNI` resource
| 1.24.3 ^[1]^
|===

//note to self for post GA: might be worth having Envoy proxy and IstioCNI attributes.
|===
11 changes: 7 additions & 4 deletions ossm-release-notes/ossm-release-notes-feature-support-tables.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Developer Preview (DP) features are not supported by Red Hat in any way and are
Not available (NA) features might not be available with {SMProductName} 3.

include::modules/ossm-release-notes-sail-operator-apis.adoc[leveloffset=+1]

include::modules/ossm-release-notes-istio-deployment-lifecycle.adoc[leveloffset=+1]

[role="_additional-resources"]
Expand All @@ -28,15 +29,17 @@ include::modules/ossm-release-notes-istio-deployment-lifecycle.adoc[leveloffset=
* xref:../install/ossm-istioctl-tool.adoc#ossm-support-for-istioctl_ossm-istioctl-tool[Support for Istioctl]

include::modules/ossm-release-notes-istio-traffic-management.adoc[leveloffset=+1]

include::modules/ossm-release-notes-kubernetes-gateway-api.adoc[leveloffset=+1]

include::modules/ossm-release-notes-security-features.adoc[leveloffset=+1]

include::modules/ossm-release-notes-observability-features.adoc[leveloffset=+1]

include::modules/ossm-release-notes-consoles-and-dashboards.adoc[leveloffset=+1]

include::modules/ossm-release-notes-extensibility-features.adoc[leveloffset=+1]

include::modules/ossm-release-notes-istio-ambient-mode.adoc[leveloffset=+1]

// commented out in case it is needed for GA
//[role="_additional-resources"]
//[id="additional-resources_{context}"]
//.Additional resources

36 changes: 7 additions & 29 deletions ossm-release-notes/ossm-release-notes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,25 @@ include::_attributes/common-attributes.adoc[]

toc::[]

{SMProductName} release notes contain information about new features and enhancements, deprecated features, technology preview features, bug fixes, and known issues. They contain a set of tables for supported component versions and Istio features, and are organized by {SMProduct} version.
The {SMProductName} release notes provide details about new features and enhancements, deprecated features, technology preview features, fixed issues, and known issues. The release notes also include tables for supported component versions and {istio} features, organized by {SMProduct} version.

[NOTE]
====
For additional information about the {SMProductName} life cycle and supported platforms, refer to the link:https://access.redhat.com/support/policy/updates/openshift_operators[{ocp-short-name} Operator Life Cycles].
====

//03/25/2025:
//Gwynne is rotating off Service Mesh. For next writer and CS: Continue to refine the IA for rel notes. The structure and IA will likely make more sense as there are more z-streams and versions released, making it easier to see how best to lay rel notes out in docs.redhat. Should anything be its own tile to make it easier to find for users?

include::modules/ossm-release-notes-3-1-2.adoc[leveloffset=+1]

include::modules/ossm-release-notes-3-1-1.adoc[leveloffset=+1]

include::modules/ossm-release-notes-3-1-new-features-enhancements.adoc[leveloffset=+1]

include::modules/ossm-release-notes-3-1-technology-preview-features.adoc[leveloffset=+1]

include::modules/ossm-release-notes-3-1-fixed-issues.adoc[leveloffset=+1]

include::modules/ossm-release-notes-3-1-known-issues.adoc[leveloffset=+1]

include::modules/ossm-release-notes-3-1-deprecated-features.adoc[leveloffset=+1]

[role="_additional-resources"]
Expand All @@ -32,28 +35,3 @@ include::modules/ossm-release-notes-3-1-deprecated-features.adoc[leveloffset=+1]
* xref:../install/ossm-istio-ambient-mode.adoc#ossm-istio-ambient-mode[Istio ambient mode]
* link:https://istio.io/latest/docs/ops/configuration/traffic-management/dns-proxy/#address-auto-allocation[Address auto-allocation]
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_mesh/3.0/html/migrating_from_service_mesh_2_to_service_mesh_3/ossm-migrating-from-service-mesh-2-to-3[Migrating from Service Mesh 2 to Service Mesh 3]

include::modules/ossm-release-notes-3-0-3.adoc[leveloffset=+1]
include::modules/ossm-release-notes-3-0-2.adoc[leveloffset=+1]
include::modules/ossm-release-notes-3-0-1.adoc[leveloffset=+1]
include::modules/ossm-release-notes-3-0-new-features.adoc[leveloffset=+1]
include::modules/ossm-release-notes-3-0-known-issues.adoc[leveloffset=+1]
include::modules/ossm-release-notes-3-0-deprecated-removed-features.adoc[leveloffset=+1]

//only GA release notes should appear since Service Mesh is versioned. Readdress in IA post GA.
//include::snippets/technology-preview.adoc[]

//include::modules/ossm-release-3-0-TP-1.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="additional-resources-release-notes_{context}"]
== Additional resources

* xref:../ossm-release-notes/ossm-release-notes-version-support-tables.adoc#ossm-release-notes-version-support-tables[Service Mesh version support]
* xref:../ossm-release-notes/ossm-release-notes-feature-support-tables.adoc#ossm-release-notes-feature-support-tables[Service Mesh 3.0 feature support tables]
* xref:../migrating/ossm-migrating-from-service-mesh-2-to-3.adoc#ossm-migrating-from-service-mesh-2-to-3[Migrating from {smproductshortname} 2 to {smproductshortname} 3]
* xref:../migrating/checklists/ossm-migrating-read-me.adoc#ossm-migrating-read-me[Important information to know if you are migrating from {SMProduct} 2.6]
* xref:../migrating/checklists/ossm-migrating-read-me.adoc#ossm-migrating-read-me-support-for-istioctl_ossm-migrating-read-me[Support for Istioctl]
* xref:../update/ossm-updating-openshift-service-mesh.adoc#about-revisionbased-strategy_ossm-performing-inplace-update[About RevisionBased strategy]
* xref:../observability/ossm-observability-service-mesh.adoc#ossm-observability-service-mesh[{observabilitylongname} and {smproductshortname}]
* xref:../observability/kiali/ossm-kiali.adoc#ossm-kiali[Using {kialiproduct}]