1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-06 06:46:26 +01:00
Files
openshift-docs/modules/ossm-control-plane-deploy.adoc

138 lines
4.2 KiB
Plaintext

// Module included in the following assemblies:
//
// * service_mesh/v2x/installing-ossm.adoc
[id="ossm-control-plane-deploy_{context}"]
= Deploying the {ProductName} control plane
////
TODO - Flesh out how multitenancy affects this, link to control plate template topic.
////
The `ServiceMeshControlPlane` resource defines the configuration to be used during installation.
You can deploy a basic installation of the {ProductShortName} control plane by using the {product-title} web console or from the command line using the `oc` client tool.
To get started, deploy the basic installation with the following steps. You can customize the `ServiceMeshControlPlane` resource later.
[id="ossm-control-plane-deploy-operatorhub_{context}"]
== Deploying the control plane from the web console
Follow this procedure to deploy a basic {ProductName} control plane by using the web console.
.Prerequisites
* The {ProductName} Operator must be installed.
* Review the instructions for how to customize the {ProductName} installation.
* An account with the `cluster-admin` role.
.Procedure
. Log in to the {product-title} web console as a user with the `cluster-admin` role.
. Create a project named `istio-system`.
.. Navigate to *Home* -> *Projects*.
.. Click *Create Project*.
.. Enter `istio-system` in the *Name* field.
.. Click *Create*.
. Navigate to *Operators* -> *Installed Operators*.
. In the Project menu, select `istio-system`. You may have to wait a few moments for the Operators to be copied to the new project.
. Click the {ProductName} Operator, then click *Istio Service Mesh Control Plane*.
. On the *Istio Service Mesh Control Plane* page, click *Create ServiceMeshControlPlane*.
. On the *Create ServiceMeshControlPlane* page, you can modify the default `ServiceMeshControlPlane` template with the form, or select the YAML view to customize your installation.
. Click *Create* to create the control plane. The Operator creates pods, services, and {ProductShortName} control plane components based on your configuration parameters.
. Click the *Istio Service Mesh Control Plane* tab.
. Click the name of the new control plane.
. Click the *Resources* tab to see the {ProductName} control plane resources the Operator created and configured.
[id="ossm-control-plane-deploy-cli_{context}"]
== Deploying the control plane from the CLI
Follow this procedure to deploy a basic {ProductName} control plane the command line.
.Prerequisites
* The {ProductName} Operator must be installed.
* Review the instructions for how to customize the {ProductName} installation.
* An account with the `cluster-admin` role.
* Access to the OpenShift CLI (`oc`).
.Procedure
. Log in to the {product-title} CLI as a user with the `cluster-admin` role.
+
[source,terminal]
----
$ oc login https://{HOSTNAME}:6443
----
+
. Create a project named `istio-system`.
+
[source,terminal]
----
$ oc new-project istio-system
----
+
. Create a `ServiceMeshControlPlane` file named `istio-installation.yaml` using the following example in "Customize the {ProductName} installation". For production deployments you _must_ customize the default link:https://github.com/maistra/istio-operator/blob/maistra-2.0/deploy/examples/maistra_v2_servicemeshcontrolplane_cr_auth.yaml[template].
+
.Example version 2.0 istio-installation.yaml
[source,yaml]
----
apiVersion: maistra.io/v2
kind: ServiceMeshControlPlane
metadata:
name: basic
namespace: openshift-operators
spec:
version: v2.0
tracing:
type: Jaeger
sampling: 10000
addons:
jaeger:
name: jaeger
install:
storage:
type: Memory
kiali:
enabled: true
name: kiali
grafana:
enabled: true
----
+
. Run the following command to deploy the control plane, where `<istio_installation.yaml>` includes the full path to your file.
+
[source,terminal]
----
$ oc create -n istio-system -f <istio_installation.yaml>
----
+
. Execute the following command to see the status of the control plane installation.
+
[source,terminal]
----
$ oc get smcp -n istio-system
----
+
The installation has finished successfully when the `STATUS` column is `ComponentsReady`.
+
----
NAME READY STATUS PROFILES VERSION AGE IMAGE REGISTRY
basic 9/9 ComponentsReady ["default"] 2.0.0 3m31s
----