Skip to content

Update documentation to maistra 0.3.0: MAISTRA-78 #12589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update documentation to maistra 0.3.0: MAISTRA-78 #12589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions servicemesh-install/topics/install-prerequisites.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
Before you can install {ProductName}, you must meet the following prerequisites:

* Possess an active {product-title} subscription on your Red Hat account. If you do not have a subscription, contact your sales representative for more information.
* Install {product-title} version 3.10, or higher. For more information about the system and environment requirements, see the https://access.redhat.com/documentation/en-us/openshift_container_platform/3.10/html/installing_clusters/install-config-install-prerequisites#system-requirements[OpenShift Container Platform documentation].
* Install the version of the {product-title} command line utility (the `oc` client tool) that matches your {product-title} version and add it to your path. For example, if you have {product-title} 3.10 you must have the matching `oc` client version 3.10. For installation instructions, see the {product-title} https://access.redhat.com/documentation/en-us/openshift_container_platform/3.10/html-single/cli_reference/#installing-the-cli[Command Line Reference] document.
* Install {product-title} version 3.11, or higher. For more information about the system and environment requirements, see the https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/installing_clusters/install-config-install-prerequisites#system-requirements[OpenShift Container Platform documentation].
* Install the version of the {product-title} command line utility (the `oc` client tool) that matches your {product-title} version and add it to your path. For example, if you have {product-title} 3.11 you must have the matching `oc` client version 3.11. For installation instructions, see the {product-title} https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html-single/cli_reference/#installing-the-cli[Command Line Reference] document.


[[preparing-openshift-installation]]
Expand All @@ -23,7 +23,7 @@ The community version of Istio will inject the sidecar by default if you have la

To enable the automatic injection of the {ProductShortName} sidecar you must first modify the master configuration on each master to include support for webhooks and signing of Certificate Signing Requests (CSRs).

Make the following changes on each master within your {product-title} 3.10 installation:
Make the following changes on each master within your {product-title} 3.11 installation:

. Change to the directory containing the master configuration file (for example, /etc/origin/master/master-config.yaml).
. Create a file named `master-config.patch` with the following contents:
Expand All @@ -33,14 +33,14 @@ admissionConfig:
pluginConfig:
MutatingAdmissionWebhook:
configuration:
apiVersion: v1
disable: false
kind: DefaultAdmissionConfig
apiVersion: apiserver.config.k8s.io/v1alpha1
kubeConfigFile: /dev/null
kind: WebhookAdmission
ValidatingAdmissionWebhook:
configuration:
apiVersion: v1
disable: false
kind: DefaultAdmissionConfig
apiVersion: apiserver.config.k8s.io/v1alpha1
kubeConfigFile: /dev/null
kind: WebhookAdmission
```
+
. In the same directory, issue the following commands to apply the patch to the `master-config.yaml` file:
Expand All @@ -57,7 +57,7 @@ $ master-restart controllers

To run the Elasticsearch application, you must make a change to the kernel configuration on each node. This change is handled through the `sysctl` service.

Make the following changes on each node within your {product-title} 3.10 installation:
Make the following changes on each node within your {product-title} 3.11 installation:

. Create a file named `/etc/sysctl.d/99-elasticsearch.conf` with the following contents:
+
Expand Down
2 changes: 1 addition & 1 deletion servicemesh-install/topics/install-supported-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The following are the only supported configurations for the {ProductName} {ProductVersion}:

* Red Hat {product-title} version 3.10
* Red Hat {product-title} version 3.11
+
[NOTE]
====
Expand Down
25 changes: 10 additions & 15 deletions servicemesh-install/topics/install.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ spec:
authentication: true
community: false
prefix: openshift-istio-tech-preview/
version: 0.2.0
version: 0.3.0
jaeger:
prefix: distributed-tracing-tech-preview/
version: 1.7.0
Expand All @@ -35,7 +35,7 @@ spec:
username: username
password: password
prefix: openshift-istio-tech-preview/
version: v0.7.2
version: v0.8.1
launcher:
openshift:
user: user
Expand Down Expand Up @@ -101,7 +101,7 @@ If `deployment_type=openshift` the default value is `openshift-istio-tech-previe
|`version`
|Any valid Docker tag
|Docker tag to use with Istio images.
|`0.2.0`
|`0.3.0`
|===

.Jaeger parameters
Expand Down Expand Up @@ -152,9 +152,9 @@ If `deployment_type=openshift` the default value is `distributed-tracing-tech-pr
|version
|valid Kiali tag
|Which Docker tag to use with Kiali images.
|The default value is `v0.7.2` if `deployment_type=origin`.
|The default value is `v0.8.1` if `deployment_type=origin`.

The default value is `0.7.2` if `deployment_type=openshift`.
The default value is `0.8.1` if `deployment_type=openshift`.
|===

.Launcher parameters
Expand Down Expand Up @@ -206,14 +206,14 @@ Add an overview of Operators
////
The {ProductShortName} installation process introduces a Kubernetes _operator_ to manage the installation of the control plane within the `istio-system` namespace. This operator defines and monitors a custom resource related to the deployment, update, and deletion of the control plane.

You can find the https://github.com/Maistra/openshift-ansible/tree/maistra-0.2.0-ocp-3.1.0-istio-1.0.2/istio[operator templates on GitHub].
You can find the https://github.com/Maistra/openshift-ansible/tree/maistra-0.3/istio[operator templates on GitHub].

[NOTE]
====
You *must* name the custom resource `istio-installation`, that is, the metadata value for `name` must be `istio-installation` and you *must* install it into the `istio-operator` namespace that is created by the operator.
====

The following commands install the {ProductShortName} operator into an existing {product-title} 3.10 installation; you can run them from any host with access to the cluster. Ensure that you are logged in as a cluster admin before executing these commands.
The following commands install the {ProductShortName} operator into an existing {product-title} 3.11 installation; you can run them from any host with access to the cluster. Ensure that you are logged in as a cluster admin before executing these commands.

```
$ oc new-project istio-operator
Expand All @@ -230,16 +230,11 @@ The OpenShift Master Public URL must be configured to match the public URL of yo

The previous commands create a new deployment within the `istio-operator` project and run the operator responsible for managing the state of the {ProductName} control plane through the custom resource.

. To verify that the operator is installed correctly, execute the following command:
+
```
$ oc get pods -n istio-operator
```
+
. You can access the logs from the `istio-operator` pod with the following command, replacing `<pod name>` with the name of the pod you discovered.
. To verify that the operator is installed correctly, access the logs from the operator pod by running the following command:

+
```
$ oc logs -n istio-operator <pod name>
$ oc logs -n istio-operator $(oc -n istio-operator get pods -l name=istio-operator --output=jsonpath={.items..metadata.name})
```
+
While your exact environment may be different from the example, you should see output that looks similar to the following example:
Expand Down
2 changes: 1 addition & 1 deletion servicemesh-install/topics/tutorial-bookinfo.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ There are three versions of the reviews microservice:
[[installing-bookinfo-application]]
== Installing the Bookinfo application

The following steps describe deploying and running the Bookinfo tutorial on OpenShift Container Platform 3.10 with {ProductShortName} {ProductVersion}.
The following steps describe deploying and running the Bookinfo tutorial on OpenShift Container Platform 3.11 with {ProductShortName} {ProductVersion}.

[NOTE]
====
Expand Down
2 changes: 1 addition & 1 deletion servicemesh-install/topics/tutorial-grafana.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This tutorial uses {ProductShortName} and the `bookinfo` tutorial to demonstrate

Prerequisites:

* {product-title} 3.10 or higher installed.
* {product-title} 3.11 or higher installed.
* {ProductName} {ProductVersion} installed.
* `Bookinfo` demonstration application installed.

Expand Down
2 changes: 1 addition & 1 deletion servicemesh-install/topics/tutorial-jaeger-tracing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This tutorial uses {ProductShortName} and the `bookinfo` tutorial to demonstrate

Prerequisites:

* {product-title} 3.10 or higher installed.
* {product-title} 3.11 or higher installed.
* {ProductName} {ProductVersion} installed.
* `Bookinfo` demonstration application installed.

Expand Down
4 changes: 2 additions & 2 deletions servicemesh-install/topics/tutorial-kiali.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This tutorial uses {ProductShortName} and the `bookinfo` tutorial to demonstrate

Prerequisites:

* {product-title} 3.10 or higher installed.
* {product-title} 3.11 or higher installed.
* {ProductName} {ProductVersion} installed.
* Kiali parameters specified in the custom resource file.
* `Bookinfo` demonstration application installed.
Expand Down Expand Up @@ -83,4 +83,4 @@ Click the Distributed Tracing link in the left navigation. On this page you can
[[removing-kiali-tutorial]]
== Removing the Kiali tutorial

The procedure for removing the Kiali tutorial is the same as removing the Bookinfo tutorial.
The procedure for removing the Kiali tutorial is the same as removing the Bookinfo tutorial.
2 changes: 1 addition & 1 deletion servicemesh-install/topics/tutorial-prometheus.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This tutorial uses {ProductShortName} and the `bookinfo` tutorial to demonstrate

Prerequisites:

* {product-title} 3.10 or higher installed.
* {product-title} 3.11 or higher installed.
* {ProductName} {ProductVersion} installed.
* `Bookinfo` demonstration application installed.

Expand Down
2 changes: 1 addition & 1 deletion servicemesh-install/topics/tutorial-rhoar-missions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In addition to the `bookinfo` based tutorials, there are are four {ProductShortN

Prerequisites:

* OpenShift Container Catalog 3.10 or higher installed.
* OpenShift Container Catalog 3.11 or higher installed.
* {ProductName} {ProductVersion} installed.
* Launcher parameters specified in the custom resource file.

Expand Down