Skip to content

Commit e41e8a3

Browse files
committed
OSSMDOC-522: Update installation for ROSA.
1 parent 3d0084a commit e41e8a3

File tree

2 files changed

+96
-2
lines changed

2 files changed

+96
-2
lines changed

modules/ossm-install-rosa.adoc

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
////
2+
This module included in the following assemblies:
3+
* service_mesh/v2/ossm-create-smcp.adoc
4+
////
5+
6+
:_content-type: REFERENCE
7+
[id="ossm-install-rosa_{context}"]
8+
= Installing on Red Hat OpenShift Service on AWS (ROSA)
9+
10+
Starting with version 2.2, {SMProductName} supports installation on Red Hat OpenShift Service on AWS (ROSA). This section documents the additional requirements when installing Service Mesh on this platform.
11+
12+
[id="ossm-install-rosa-location_{context}"]
13+
== Installation location
14+
15+
You must create a new namespace, for example `istio-system`, when installing {SMProductName} and creating the `ServiceMeshControlPlane`.
16+
17+
[id="ossm-install-rosa-smcp_{context}"]
18+
== Required control plane configuration
19+
20+
The default configuration in the `ServiceMeshControlPlane` file does not work on a ROSA cluster. You must modify the default SMCP and set `spec.security.identity.type=ThirdParty` when installing on Red Hat OpenShift Service on AWS.
21+
22+
.Example `ServiceMeshControlPlane` resource for ROSA
23+
[source,yaml]
24+
----
25+
apiVersion: maistra.io/v2
26+
kind: ServiceMeshControlPlane
27+
metadata:
28+
name: basic
29+
namespace: istio-system
30+
spec:
31+
version: v2.1
32+
security:
33+
identity:
34+
type: ThirdParty #required setting for ROSA
35+
tracing:
36+
type: Jaeger
37+
sampling: 10000
38+
policy:
39+
type: Istiod
40+
addons:
41+
grafana:
42+
enabled: true
43+
jaeger:
44+
install:
45+
storage:
46+
type: Memory
47+
kiali:
48+
enabled: true
49+
prometheus:
50+
enabled: true
51+
telemetry:
52+
type: Istiod
53+
----
54+
55+
[id="ossm-install-rosa-kiali-config_{context}"]
56+
== Restrictions on Kiali configuration
57+
58+
Red Hat OpenShift Service on AWS places additional restrictions on where you can create resources and does not let you create the Kiali resource in a Red Hat managed namespace.
59+
60+
This means that the following common settings for `spec.deployment.accessible_namespaces` are not allowed in a ROSA cluster:
61+
62+
* `['**']` (all namespaces)
63+
* `default`
64+
* `codeready-*`
65+
* `openshift-*`
66+
* `redhat-*`
67+
68+
The validation error message provides a complete list of all the restricted namespaces.
69+
70+
.Example `Kiali` resource for ROSA
71+
[source,yaml]
72+
----
73+
apiVersion: kiali.io/v1alpha1
74+
kind: Kiali
75+
metadata:
76+
name: kiali
77+
namespace: istio-system
78+
spec:
79+
auth:
80+
strategy: openshift
81+
deployment:
82+
accessible_namespaces: #restricted setting for ROSA
83+
- istio-system
84+
image_pull_policy: ''
85+
ingress_enabled: true
86+
namespace: istio-system
87+
----

service_mesh/v2x/ossm-create-smcp.adoc

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,16 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
You can deploy a basic installation of the `ServiceMeshControlPlane` by using either the {product-title} web console or from the command line using the `oc` client tool.
9+
You can deploy a basic installation of the `ServiceMeshControlPlane`(SMCP) by using either the {product-title} web console or from the command line using the `oc` client tool.
1010

1111
[NOTE]
1212
====
13-
This basic installation is configured based on the default OpenShift settings and is not designed for production use. Use this default installation to verify your installation, and then configure your `ServiceMeshControlPlane` for your environment.
13+
This basic installation is configured based on the default OpenShift settings and is not designed for production use. Use this default installation to verify your installation, and then configure your `ServiceMeshControlPlane` for your environment.
14+
====
15+
16+
[NOTE]
17+
====
18+
Red Hat OpenShift Service on AWS (ROSA) places additional restrictions on where you can create resources and as a result the default deployment does not work. See xref:../../service_mesh/v2x/ossm-create-smcp.adoc#ossm-install-rosa_ossm-create-smcp[Installing Service Mesh on Red Hat OpenShift Service on AWS] for additional requirements before deploying your SMCP in a ROSA environment.
1419
====
1520

1621
[NOTE]
@@ -26,6 +31,8 @@ include::modules/ossm-validate-smcp-cli.adoc[leveloffset=+1]
2631

2732
include::modules/ossm-validate-smcp-kiali.adoc[leveloffset=+1]
2833

34+
include::modules/ossm-install-rosa.adoc[leveloffset=+1]
35+
2936
[role="_additional-resources"]
3037
== Additional resources
3138

0 commit comments

Comments
 (0)