blurb on spec.version (#819)

kiali · Sep 27, 2024 · 998e67d · 998e67d
1 parent 621515a
commit 998e67d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/content/en/docs/Installation/installation-guide/creating-updating-kiali-cr.md b/content/en/docs/Installation/installation-guide/creating-updating-kiali-cr.md
@@ -68,16 +68,17 @@ Status:
     Namespace:      istio-system
   Environment:
     Is Kubernetes:       true
-    Kubernetes Version:  1.21.2
-    Operator Version:    v1.40.0
+    Kubernetes Version:  1.27.3
+    Operator Version:    v1.89.0
   Progress:
-    Duration:  0:00:16
-    Message:   5. Creating core resources
+    Duration:    0:00:16
+    Message:     5. Creating core resources
+  Spec Version:  default
 Events:        <none>
 ```
 
 {{% alert color="warning" %}}
-*Never* manually edit resources created by the Kiali Operator, only the Kiali CR.
+*Never* manually edit resources created by the Kiali Operator; only edit the Kiali CR.
 {{% /alert %}}
 
 You may want to check the [example install page]({{< relref "example-install"

diff --git a/...ent/en/docs/Installation/installation-guide/creating-updating-ossmconsole-cr.md b/...ent/en/docs/Installation/installation-guide/creating-updating-ossmconsole-cr.md
@@ -22,6 +22,11 @@ The Kiali Operator watches the _OSSMConsole Custom Resource_ ([OSSMConsole CR](/
 
 With the Kiali Operator and Kial Server installed and running, you can install the OSSMC plugin in one of two ways - either via the OpenShift Console or via the "oc" CLI. Both methods are described below. You choose the method you want to use.
 
+{{% alert color="warning" %}}
+You should specify the `spec.version` field of the OSSMConsole CR, and its value must be the same version as that of the Kiali Server (i.e. it must match the `spec.version` of the Kiali Server's Kiali CR). Normally, you can just set `spec.version` to `default` which tells the Kiali Operator to install OSSMC whose version is the same as that of the operator itself. Alternatively, you may specify one of the
+[supported versions](https://github.com/kiali/kiali-operator/blob/master/playbooks/ossmconsole-default-supported-images.yml) in the format `vX.Y`.
+{{% /alert %}}
+
 ### Installing via OpenShift Console
 
 From the Kiali Operator details page in the OpenShift Console, create an instance of the "OpenShift Service Mesh Console" resource. Accept the defaults on the installation form and press "Create".
@@ -39,6 +44,8 @@ kind: OSSMConsole
 metadata:
   namespace: openshift-operators
   name: ossmconsole
+spec:
+  version: default
 EOM
 ```