Skip to content

Commit

Permalink
Reorg Service Mesh -> Config SMCP -> Install on ROSA
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Burke committed Apr 19, 2024
1 parent 83bd2dc commit 9e58993
Show file tree
Hide file tree
Showing 10 changed files with 207 additions and 110 deletions.
9 changes: 3 additions & 6 deletions modules/ossm-about-smcp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,16 @@ The control plane includes Istiod, Ingress and Egress Gateways, and other compon
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.
====

[NOTE]
====
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.
====

ifndef::openshift-rosa,openshift-dedicated[]
[NOTE]
====
The {SMProductShortName} documentation uses `istio-system` as the example project, but you can deploy the service mesh to any project.
====
endif::openshift-rosa,openshift-dedicated[]

ifdef::openshift-rosa[]
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.
endif::openshift-rosa[]
ifdef::openshift-dedicated[]
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.
endif::openshift-dedicated[]
endif::openshift-dedicated[]
48 changes: 48 additions & 0 deletions modules/ossm-control-plane-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ endif::openshift-rosa,openshift-dedicated[]
$ oc new-project istio-system
----
+
ifdef::openshift-rosa,openshift-dedicated[]
The `ServiceMeshControlPlane` resource must be installed in the `istio-system` project, separate from your microservices and Operators.
endif::openshift-rosa,openshift-dedicated[]

ifndef::openshift-rosa,openshift-dedicated[]
. 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.
+
.Example version {MaistraVersion} istio-installation.yaml
Expand Down Expand Up @@ -56,6 +61,49 @@ spec:
grafana:
enabled: true
----
endif::openshift-rosa,openshift-dedicated[]
ifdef::openshift-rosa,openshift-dedicated[]
. 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.
+
.Example `ServiceMeshControlPlane` resource
[source,yaml, subs="attributes,verbatim"]
----
apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
name: basic
namespace: istio-system
spec:
version: v{MaistraVersion}
security:
identity:
type: ThirdParty <1>
tracing:
type: Jaeger
sampling: 10000
policy:
type: Istiod
addons:
grafana:
enabled: true
jaeger:
install:
storage:
type: Memory
kiali:
enabled: true
prometheus:
enabled: true
telemetry:
type: Istiod
----
ifdef::openshift-rosa[]
<1> Specifies a required setting for {product-rosa}.
endif::openshift-rosa[]
ifdef::openshift-dedicated[]
<1> Specifies a required setting for {product-dedicated}.
endif::openshift-dedicated[]
endif::openshift-rosa,openshift-dedicated[]
+
. Run the following command to deploy the {SMProductShortName} control plane, where `<istio_installation.yaml>` includes the full path to your file.
+
Expand Down
17 changes: 14 additions & 3 deletions modules/ossm-control-plane-web.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,16 @@ endif::openshift-rosa,openshift-dedicated[]
.. Navigate to *Home* -> *Projects*.
+
.. Click *Create Project*.
ifndef::openshift-rosa,openshift-dedcated[]
+
.. In the *Name* field, enter `istio-system`. The `ServiceMeshControlPlane` resource must be installed in a project that is separate from your microservices and Operators.
+
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.
endif::openshift-rosa,openshift-dedcated[]
ifdef::openshift-rosa,openshift-dedcated[]
+
.. In the *Name* field, enter `istio-system`. The `ServiceMeshControlPlane` resource must be installed in the `istio-system` project, separate from your microservices and Operators.
endif::openshift-rosa,openshift-dedcated[]
+
.. Click *Create*.

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

. On the *Istio Service Mesh Control Plane* tab, click *Create ServiceMeshControlPlane*.

. On the *Create ServiceMeshControlPlane* page:
+
--
.. 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.

.. Click *Create*.
ifdef::openshift-rosa[]
.. Add the `spec.security.identity.type.ThirdParty` field, required by {product-rosa}.
endif::openshift-rosa[]
ifdef::openshift-dedicated[]
.. Add the `spec.security.identity.type.ThirdParty` field, required by {product-dedicated}.
endif::openshift-dedicated[]
+
.. Click *Create*.
--
+
The Operator creates pods, services, and {SMProductShortName} control plane components based on your configuration parameters. You can configure `ServiceMeshControlPlane` settings at a later time.
Expand Down
7 changes: 4 additions & 3 deletions modules/ossm-customize-smmr-cluster-wide.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// This module is included in the following assemblies:
//
// * service_mesh/v2x/ossm-create-smcp.adoc
////
This module is included in the following assemblies:
* service_mesh/v2x/ossm-create-smcp.adoc
////

:_mod-docs-content-type: CONCEPT
[id="ossm-customize-smrr-cluster-wide_{context}"]
Expand Down
35 changes: 31 additions & 4 deletions modules/ossm-deploy-cluster-wide-control-plane-cli.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// This module is included in the following assemblies:
// * service_mesh/v2x/ossm-create-smcp.adoc
//
////
This module is included in the following assemblies:
* service_mesh/v2x/ossm-create-smcp.adoc
////

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

. Create a `ServiceMeshControlPlane` file named `istio-installation.yaml` using the following example.
. Create a `ServiceMeshControlPlane` file named `istio-installation.yaml` using the following example:
+
ifndef::openshift-rosa,openshift-dedicated[]
.Example version {MaistraVersion} istio-installation.yaml
[source,yaml, subs="attributes,verbatim"]
----
Expand All @@ -42,6 +44,31 @@ spec:
version: v{MaistraVersion}
mode: ClusterWide
----
endif::openshift-rosa,openshift-dedicated[]
ifdef::openshift-rosa,openshift-dedicated[]
.Example `ServiceMeshControlPlane` resource
[source,yaml, subs="attributes,verbatim"]
----
apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
name: basic
namespace: istio-system
spec:
version: v{MaistraVersion}
mode: ClusterWide <1>
security:
identity:
type: ThirdParty <2>
----
<1> Specifies that the resource is for a cluster-wide deployment.
ifdef::openshift-rosa[]
<2> Specifies a required setting for {product-rosa}.
endif::openshift-rosa[]
ifdef::openshift-dedicated[]
<2> Specifies a required setting for {product-dedicated}.
endif::openshift-dedicated[]
endif::openshift-rosa,openshift-dedicated[]

. Run the following command to deploy the {SMProductShortName} control plane:
+
Expand Down
46 changes: 46 additions & 0 deletions modules/ossm-deploy-cluster-wide-control-plane-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ These steps use `istio-system` as an example. You can deploy the {SMProductShort

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

ifndef::openshift-rosa,openshift-dedicated[]
. Modify the `spec.mode` field of the YAML file to specify `ClusterWide`.
+
.Example version {MaistraVersion} istio-installation.yaml
Expand All @@ -55,6 +56,51 @@ spec:
version: v{MaistraVersion}
mode: ClusterWide
----
endif::openshift-rosa,openshift-dedicated[]
ifdef::openshift-rosa,openshift-dedicated[]
. Modify the `spec.mode` field and add the `spec.security.identity.type.ThirdParty` field:
+
.Example `ServiceMeshControlPlane` resource
[source,yaml, subs="attributes,verbatim"]
----
apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
name: basic
namespace: istio-system
spec:
version: v{MaistraVersion}
mode: ClusterWide <1>
security:
identity:
type: ThirdParty <2>
tracing:
type: Jaeger
sampling: 10000
policy:
type: Istiod
addons:
grafana:
enabled: true
jaeger:
install:
storage:
type: Memory
kiali:
enabled: true
prometheus:
enabled: true
telemetry:
type: Istiod
----
<1> Specifies that the resource is for a cluster-wide deployment.
ifdef::openshift-rosa[]
<2> Specifies a required setting for {product-rosa}.
endif::openshift-rosa[]
ifdef::openshift-dedicated[]
<2> Specifies a required setting for {product-dedicated}.
endif::openshift-dedicated[]
endif::openshift-rosa,openshift-dedicated[]

. 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.

Expand Down
86 changes: 0 additions & 86 deletions modules/ossm-install-rosa.adoc

This file was deleted.

Loading

0 comments on commit 9e58993

Please sign in to comment.