Skip to content

Commit 3b2ce89

Browse files
authored
Merge pull request #68498 from mburke5678/service-mesh-reorg-smcp-on-aws
Reorg Service Mesh -> Config SMCP -> Install on ROSA
2 parents 6318b12 + 9e58993 commit 3b2ce89

10 files changed

+207
-110
lines changed

modules/ossm-about-smcp.adoc

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,16 @@ The control plane includes Istiod, Ingress and Egress Gateways, and other compon
1212
This basic installation is configured based on the default {product-title} settings and is not designed for production use. Use this default installation to verify your installation, and then configure your `ServiceMeshControlPlane` settings for your environment.
1313
====
1414

15-
[NOTE]
16-
====
17-
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 Installing {SMProductShortName} on Red Hat OpenShift Service on AWS for additional requirements before deploying your SMCP in a ROSA environment.
18-
====
19-
15+
ifndef::openshift-rosa,openshift-dedicated[]
2016
[NOTE]
2117
====
2218
The {SMProductShortName} documentation uses `istio-system` as the example project, but you can deploy the service mesh to any project.
2319
====
20+
endif::openshift-rosa,openshift-dedicated[]
2421

2522
ifdef::openshift-rosa[]
2623
If you are deploying the control plane for use on {product-rosa}, see the Red Hat Knowledgebase article link:https://access.redhat.com/solutions/6529231[OpenShift service mesh operator Istio basic not starting due to authentication errors], which discusses adding a new project and starting pods.
2724
endif::openshift-rosa[]
2825
ifdef::openshift-dedicated[]
2926
If you are deploying the control plane for use on {product-dedicated}, see the Red Hat Knowledgebase article link:https://access.redhat.com/solutions/6529231[OpenShift service mesh operator Istio basic not starting due to authentication errors], which discusses adding a new project and starting pods.
30-
endif::openshift-dedicated[]
27+
endif::openshift-dedicated[]

modules/ossm-control-plane-cli.adoc

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ endif::openshift-rosa,openshift-dedicated[]
2929
$ oc new-project istio-system
3030
----
3131
+
32+
ifdef::openshift-rosa,openshift-dedicated[]
33+
The `ServiceMeshControlPlane` resource must be installed in the `istio-system` project, separate from your microservices and Operators.
34+
endif::openshift-rosa,openshift-dedicated[]
35+
36+
ifndef::openshift-rosa,openshift-dedicated[]
3237
. Create a `ServiceMeshControlPlane` file named `istio-installation.yaml` using the following example. The version of the {SMProductShortName} control plane determines the features available regardless of the version of the Operator.
3338
+
3439
.Example version {MaistraVersion} istio-installation.yaml
@@ -56,6 +61,49 @@ spec:
5661
grafana:
5762
enabled: true
5863
----
64+
endif::openshift-rosa,openshift-dedicated[]
65+
ifdef::openshift-rosa,openshift-dedicated[]
66+
. Create a `ServiceMeshControlPlane` file named `istio-installation.yaml` using the following example. The version of the {SMProductShortName} control plane determines the features available regardless of the version of the Operator.
67+
+
68+
.Example `ServiceMeshControlPlane` resource
69+
[source,yaml, subs="attributes,verbatim"]
70+
----
71+
apiVersion: maistra.io/v2
72+
kind: ServiceMeshControlPlane
73+
metadata:
74+
name: basic
75+
namespace: istio-system
76+
spec:
77+
version: v{MaistraVersion}
78+
security:
79+
identity:
80+
type: ThirdParty <1>
81+
tracing:
82+
type: Jaeger
83+
sampling: 10000
84+
policy:
85+
type: Istiod
86+
addons:
87+
grafana:
88+
enabled: true
89+
jaeger:
90+
install:
91+
storage:
92+
type: Memory
93+
kiali:
94+
enabled: true
95+
prometheus:
96+
enabled: true
97+
telemetry:
98+
type: Istiod
99+
----
100+
ifdef::openshift-rosa[]
101+
<1> Specifies a required setting for {product-rosa}.
102+
endif::openshift-rosa[]
103+
ifdef::openshift-dedicated[]
104+
<1> Specifies a required setting for {product-dedicated}.
105+
endif::openshift-dedicated[]
106+
endif::openshift-rosa,openshift-dedicated[]
59107
+
60108
. Run the following command to deploy the {SMProductShortName} control plane, where `<istio_installation.yaml>` includes the full path to your file.
61109
+

modules/ossm-control-plane-web.adoc

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,16 @@ endif::openshift-rosa,openshift-dedicated[]
2727
.. Navigate to *Home* -> *Projects*.
2828
+
2929
.. Click *Create Project*.
30+
ifndef::openshift-rosa,openshift-dedcated[]
3031
+
3132
.. In the *Name* field, enter `istio-system`. The `ServiceMeshControlPlane` resource must be installed in a project that is separate from your microservices and Operators.
3233
+
3334
These steps use `istio-system` as an example, but you can deploy your {SMProductShortName} control plane in any project as long as it is separate from the project that contains your services.
35+
endif::openshift-rosa,openshift-dedcated[]
36+
ifdef::openshift-rosa,openshift-dedcated[]
37+
+
38+
.. In the *Name* field, enter `istio-system`. The `ServiceMeshControlPlane` resource must be installed in the `istio-system` project, separate from your microservices and Operators.
39+
endif::openshift-rosa,openshift-dedcated[]
3440
+
3541
.. Click *Create*.
3642

@@ -39,13 +45,18 @@ These steps use `istio-system` as an example, but you can deploy your {SMProduct
3945
. Click the {SMProductName} Operator, then click *Istio Service Mesh Control Plane*.
4046

4147
. On the *Istio Service Mesh Control Plane* tab, click *Create ServiceMeshControlPlane*.
42-
43-
. On the *Create ServiceMeshControlPlane* page:
4448
+
4549
--
4650
.. Accept the default {SMProductShortName} control plane version to take advantage of the features available in the most current version of the product. The version of the control plane determines the features available regardless of the version of the Operator.
4751

48-
.. Click *Create*.
52+
ifdef::openshift-rosa[]
53+
.. Add the `spec.security.identity.type.ThirdParty` field, required by {product-rosa}.
54+
endif::openshift-rosa[]
55+
ifdef::openshift-dedicated[]
56+
.. Add the `spec.security.identity.type.ThirdParty` field, required by {product-dedicated}.
57+
endif::openshift-dedicated[]
58+
+
59+
.. Click *Create*.
4960
--
5061
+
5162
The Operator creates pods, services, and {SMProductShortName} control plane components based on your configuration parameters. You can configure `ServiceMeshControlPlane` settings at a later time.

modules/ossm-customize-smmr-cluster-wide.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
// This module is included in the following assemblies:
2-
//
3-
// * service_mesh/v2x/ossm-create-smcp.adoc
1+
////
2+
This module is included in the following assemblies:
3+
* service_mesh/v2x/ossm-create-smcp.adoc
4+
////
45

56
:_mod-docs-content-type: CONCEPT
67
[id="ossm-customize-smrr-cluster-wide_{context}"]

modules/ossm-deploy-cluster-wide-control-plane-cli.adoc

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
// This module is included in the following assemblies:
2-
// * service_mesh/v2x/ossm-create-smcp.adoc
3-
//
1+
////
2+
This module is included in the following assemblies:
3+
* service_mesh/v2x/ossm-create-smcp.adoc
4+
////
45

56
:_mod-docs-content-type: PROCEDURE
67
[id="ossm-deploy-cluster-wide-control-plane-cli_{context}"]
@@ -28,8 +29,9 @@ endif::openshift-rosa,openshift-dedicated[]
2829
$ oc new-project istio-system
2930
----
3031

31-
. Create a `ServiceMeshControlPlane` file named `istio-installation.yaml` using the following example.
32+
. Create a `ServiceMeshControlPlane` file named `istio-installation.yaml` using the following example:
3233
+
34+
ifndef::openshift-rosa,openshift-dedicated[]
3335
.Example version {MaistraVersion} istio-installation.yaml
3436
[source,yaml, subs="attributes,verbatim"]
3537
----
@@ -42,6 +44,31 @@ spec:
4244
version: v{MaistraVersion}
4345
mode: ClusterWide
4446
----
47+
endif::openshift-rosa,openshift-dedicated[]
48+
ifdef::openshift-rosa,openshift-dedicated[]
49+
.Example `ServiceMeshControlPlane` resource
50+
[source,yaml, subs="attributes,verbatim"]
51+
----
52+
apiVersion: maistra.io/v2
53+
kind: ServiceMeshControlPlane
54+
metadata:
55+
name: basic
56+
namespace: istio-system
57+
spec:
58+
version: v{MaistraVersion}
59+
mode: ClusterWide <1>
60+
security:
61+
identity:
62+
type: ThirdParty <2>
63+
----
64+
<1> Specifies that the resource is for a cluster-wide deployment.
65+
ifdef::openshift-rosa[]
66+
<2> Specifies a required setting for {product-rosa}.
67+
endif::openshift-rosa[]
68+
ifdef::openshift-dedicated[]
69+
<2> Specifies a required setting for {product-dedicated}.
70+
endif::openshift-dedicated[]
71+
endif::openshift-rosa,openshift-dedicated[]
4572

4673
. Run the following command to deploy the {SMProductShortName} control plane:
4774
+

modules/ossm-deploy-cluster-wide-control-plane-console.adoc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ These steps use `istio-system` as an example. You can deploy the {SMProductShort
4040

4141
. Click *YAML view*. The version of the {SMProductShortName} control plane determines the features available regardless of the version of the Operator.
4242

43+
ifndef::openshift-rosa,openshift-dedicated[]
4344
. Modify the `spec.mode` field of the YAML file to specify `ClusterWide`.
4445
+
4546
.Example version {MaistraVersion} istio-installation.yaml
@@ -55,6 +56,51 @@ spec:
5556
version: v{MaistraVersion}
5657
mode: ClusterWide
5758
----
59+
endif::openshift-rosa,openshift-dedicated[]
60+
ifdef::openshift-rosa,openshift-dedicated[]
61+
. Modify the `spec.mode` field and add the `spec.security.identity.type.ThirdParty` field:
62+
+
63+
.Example `ServiceMeshControlPlane` resource
64+
[source,yaml, subs="attributes,verbatim"]
65+
----
66+
apiVersion: maistra.io/v2
67+
kind: ServiceMeshControlPlane
68+
metadata:
69+
name: basic
70+
namespace: istio-system
71+
spec:
72+
version: v{MaistraVersion}
73+
mode: ClusterWide <1>
74+
security:
75+
identity:
76+
type: ThirdParty <2>
77+
tracing:
78+
type: Jaeger
79+
sampling: 10000
80+
policy:
81+
type: Istiod
82+
addons:
83+
grafana:
84+
enabled: true
85+
jaeger:
86+
install:
87+
storage:
88+
type: Memory
89+
kiali:
90+
enabled: true
91+
prometheus:
92+
enabled: true
93+
telemetry:
94+
type: Istiod
95+
----
96+
<1> Specifies that the resource is for a cluster-wide deployment.
97+
ifdef::openshift-rosa[]
98+
<2> Specifies a required setting for {product-rosa}.
99+
endif::openshift-rosa[]
100+
ifdef::openshift-dedicated[]
101+
<2> Specifies a required setting for {product-dedicated}.
102+
endif::openshift-dedicated[]
103+
endif::openshift-rosa,openshift-dedicated[]
58104

59105
. Click *Create*. The Operator creates pods, services, and {SMProductShortName} control plane components based on your configuration parameters. The operator also creates the `ServiceMeshMemberRoll` if it does not exist as part of the default configuration.
60106

modules/ossm-install-rosa.adoc

Lines changed: 0 additions & 86 deletions
This file was deleted.

0 commit comments

Comments
 (0)