Skip to content

Commit 5c8437e

Browse files
authored
Merge pull request #28040 from neal-timpe/ossmdoc-189
OSSMDOC-189
2 parents 36419dd + acada7c commit 5c8437e

8 files changed

+54
-19
lines changed

modules/ossm-cr-example.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ The following table lists the specifications for the `ServiceMeshControlPlane` r
183183
|Name |Description |Configurable parameters
184184

185185
|addons
186-
|Addons is used to configure additional features beyond core control plane components, such as visualization, or metric storage.
186+
|Addon is used to configure additional features beyond core control plane components, such as visualization, or metric storage.
187187
|`3scale`, `grafana`, `jaeger`, `kiali`, and `prometheus`.
188188

189189
|cluster
@@ -246,7 +246,7 @@ ControlPlaneStatus represents the current state of your service mesh.
246246
|Not configurable
247247

248248
|conditions
249-
|Represents the latest available observations of the object’s current state. `Reconciled` indicates whether the operator has finished reconciling the actual state of deployed components with the the configuration in the `ServiceMeshControlPlane` resource. `Installed` indicates whether the control plane has been installed. `Ready` indicates whether all control plane components are ready
249+
|Represents the latest available observations of the object’s current state. `Reconciled` indicates whether the operator has finished reconciling the actual state of deployed components with the configuration in the `ServiceMeshControlPlane` resource. `Installed` indicates whether the control plane has been installed. `Ready` indicates whether all control plane components are ready
250250
|string
251251

252252
|components

modules/ossm-document-attributes-1x.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
:ProductName: Red Hat OpenShift Service Mesh
1313
:ProductShortName: Service Mesh
1414
:ProductRelease:
15-
:ProductVersion: 1.1.10
15+
:ProductVersion: 1.1.11
1616
:MaistraVersion: 1.1
1717
:product-build:
1818
:DownloadURL: registry.redhat.io

modules/ossm-document-attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
:ProductName: Red Hat OpenShift Service Mesh
1313
:ProductShortName: Service Mesh
1414
:ProductRelease:
15-
:ProductVersion: 2.0.0
15+
:ProductVersion: 2.0.1
1616
:MaistraVersion: 2.0
1717
:product-build:
1818
:DownloadURL: registry.redhat.io

modules/ossm-rn-fixed-issues.adoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,21 @@ The following issues been resolved in the current release:
1919
[id="ossm-rn-fixed-issues-ossm_{context}"]
2020
== {ProductShortName} fixed issues
2121

22+
* link:https://issues.redhat.com/browse/MAISTRA-2010[MAISTRA-2010] AuthorizationPolicy does not support `request.regex.headers` field. The `validatingwebhook` rejects any AuthorizationPolicy with the field, and even if you disable that, Pilot tries to validate it using the same code, and it does not work.
23+
24+
* link:https://issues.jboss.org/browse/MAISTRA-1979[MAISTRA-1979] _Migration to 2.0_ The conversion webhook drops the following important fields when converting `SMCP.status` from v2 to v1:
25+
26+
** conditions
27+
** components
28+
** observedGeneration
29+
** annotations
30+
+
31+
Upgrading the operator to 2.0 might break client tools that read the SMCP status using the maistra.io/v1 version of the resource.
32+
+
33+
This also causes the READY and STATUS columns to be empty when you run `oc get servicemeshcontrolplanes.v1.maistra.io`.
34+
2235
* link:https://issues.redhat.com/browse/MAISTRA-1983[MAISTRA-1983] Upgrading to 2.0.0 with an existing invalid `ServiceMeshControlPlane` cannot easily be repaired. The invalid items in the `ServiceMeshControlPlane` resource caused an unrecoverable error. The fix makes the errors recoverable. You can delete the invalid resource and replace it with a new one or edit the resource to fix the errors. For more information about editing your resource, see [Configuring the Red Hat OpenShift Service Mesh installation].
2336

2437
* link:https://issues.redhat.com/browse/MAISTRA-1502[Maistra-1502] As a result of CVEs fixes in version 1.0.10, the Istio dashboards are not available from the *Home Dashboard* menu in Grafana. The Istio dashboards still exist. To access them, click the *Dashboard* menu in the navigation panel and select the *Manage* tab.
2538

2639
* link:https://bugzilla.redhat.com/show_bug.cgi?id=1821432[Bug 1821432] Toggle controls in {product-title} Control Resource details page do not update the CR correctly. UI Toggle controls in the Service Mesh Control Plane (SMCP) Overview page in the {product-title} web console sometimes update the wrong field in the resource. To update a SMCP, edit the YAML content directly or update the resource from the command line instead of clicking the toggle controls.
27-

modules/ossm-rn-known-issues.adoc

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ These limitations exist in {ProductName}:
2626

2727
These are the known issues in {ProductName}:
2828

29-
* link:https://issues.redhat.com/browse/MAISTRA-2010[MAISTRA-2010] AuthorizationPolicy does not support `request.regex.headers` field. The `validatingwebhook` rejects any AuthorizationPolicy with the field, and even if you disable that, Pilot tries to validate it using the same code, and it does not work. The issue was fixed in 1.1, but not 2.0.
30-
3129
* link:https://issues.jboss.org/browse/MAISTRA-1088[MAISTRA-1088]/link:https://issues.jboss.org/browse/MAISTRA-1621[MAISTRA-1621] 2.0 Migration Issues
3230
** Gateways created in a non-control plane namespace will not be automatically deleted. Users will need to manually delete these resources after removing the gateway definition from the SMCP spec.
3331
** Prometheus scraping (`spec.addons.prometheus.scrape` set to `true`) does not work when mTLS is enabled. Additionally, Kiali displays extraneous graph data when mTLS is disabled.
@@ -57,17 +55,6 @@ spec:
5755

5856
* link:https://github.com/istio/istio/issues/14743[Istio-14743] Due to limitations in the version of Istio that this release of {ProductName} is based on, there are several applications that are currently incompatible with {ProductShortName}. See the linked community issue for details.
5957

60-
* link:https://issues.jboss.org/browse/MAISTRA-1979[MAISTRA-1979] _Migration to 2.0_ The conversion webhook drops the following important fields when converting SMCP.status from v2 to v1:
61-
62-
** conditions
63-
** components
64-
** observedGeneration
65-
** annotations
66-
+
67-
This means that upgrading the operator to 2.0 might break client tools that read the SMCP status using the maistra.io/v1 version of the resource.
68-
+
69-
This also causes the READY and STATUS columns to be empty when you run `oc get servicemeshcontrolplanes.v1.maistra.io`.
70-
7158
* link:https://issues.jboss.org/browse/MAISTRA-1947[MAISTRA-1947] _Technology Preview_ Updates to ServiceMeshExtensions are not applied. The workaround is to remove and recreate the ServiceMeshExtensions.
7259

7360
* link:https://issues.jboss.org/browse/MAISTRA-858[MAISTRA-858] The following Envoy log messages describing link:https://www.envoyproxy.io/docs/envoy/latest/intro/deprecated[deprecated options and configurations associated with Istio 1.1.x] are expected:

modules/ossm-rn-new-features-1x.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ Result – If changed, describe the current user experience
3636
|1.0.0
3737
|===
3838

39+
== New features {ProductName} 1.1.11
40+
41+
This release of {ProductName} addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.
42+
3943
== New features {ProductName} 1.1.10
4044

4145
This release of {ProductName} addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.

modules/ossm-rn-new-features.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Result – If changed, describe the current user experience
2424
|Component |Version
2525

2626
|Istio
27-
|1.6.5
27+
|1.6.14
2828

2929
|Jaeger
3030
|1.20.0
@@ -36,6 +36,10 @@ Result – If changed, describe the current user experience
3636
|2.0.0
3737
|===
3838

39+
== New features {ProductName} 2.0.1
40+
41+
This release of {ProductName} addresses Common Vulnerabilities and Exposures (CVEs) and bug fixes.
42+
3943
== New features {ProductName} 2.0
4044

4145
This release of {ProductName} adds support for Istio 1.6.5, Jaeger 1.20.0, Kiali 1.24.2, and the 3scale Istio Adapter 2.0 and OpenShift Container Platform 4.6.

modules/ossm-vs-istio.adoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,34 @@ The upstream Istio community installation automatically injects the sidecar into
3939

4040
{ProductName} does not automatically inject the sidecar to any pods, but requires you to opt in to injection using an annotation without labeling projects. This method requires fewer privileges and does not conflict with other OpenShift capabilities such as builder pods. To enable automatic injection you specify the `sidecar.istio.io/inject` annotation as described in the Automatic sidecar injection section.
4141

42+
[id="ossm-rbac_{context}"]
43+
== Istio Role Based Access Control features
44+
45+
Istio Role Based Access Control (RBAC) provides a mechanism you can use to control access to a service. You can identify subjects by user name or by specifying a set of properties and apply access controls accordingly.
46+
47+
The upstream Istio community installation includes options to perform exact header matches, match wildcards in headers, or check for a header containing a specific prefix or suffix.
48+
49+
{ProductName} extends the ability to match request headers by using a regular expression. Specify a property key of `request.regex.headers` with a regular expression.
50+
51+
.Upstream Istio community matching request headers example
52+
[source,yaml]
53+
----
54+
apiVersion: security.istio.io/v1beta1
55+
kind: AuthorizationPolicy
56+
metadata:
57+
name: httpbin-usernamepolicy
58+
spec:
59+
action: ALLOW
60+
rules:
61+
- when:
62+
- key: 'request.regex.headers[username]'
63+
values:
64+
- "allowed.*"
65+
selector:
66+
matchLabels:
67+
app: httpbin
68+
----
69+
4270
[id="ossm-openssl_{context}"]
4371
== OpenSSL
4472

0 commit comments

Comments
 (0)