explicitly document the version fields for display in the OS Console UI

kiali · Nov 2, 2023 · f3b3759 · f3b3759
1 parent 98ed756
commit f3b3759
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/manifests/kiali-ossm/manifests/kiali.clusterserviceversion.yaml b/manifests/kiali-ossm/manifests/kiali.clusterserviceversion.yaml
@@ -39,6 +39,7 @@ metadata:
             "name": "kiali"
           },
           "spec": {
+            "version": "default",
             "installation_tag": "My Kiali",
             "istio_namespace": "istio-system",
             "deployment": {
@@ -57,6 +58,7 @@ metadata:
             "name": "ossmconsole"
           },
           "spec": {
+            "version": "default",
             "kiali": {
               "serviceName": "",
               "serviceNamespace": "",
@@ -140,6 +142,8 @@ spec:
     url: https://github.com/kiali/kiali
   - name: Operator Source Code
     url: https://github.com/kiali/kiali-operator
+  - name: OpenShift Service Mesh Console Code
+    url: https://github.com/kiali/openshift-servicemesh-plugin
   installModes:
   - type: OwnNamespace
     supported: false
@@ -173,6 +177,11 @@ spec:
       - kind: ConsoleLink
         version: consolelinks.console.openshift.io/v1
       specDescriptors:
+      - displayName: Version
+        description: "The version of the Kiali Server to install. This is specified in the form 'vX.Y'. Check the documentation for the values that are valid and supported. When not specified, or when set to the string 'default', the latest supported version of the Kiali Server will be installed. Default: default"
+        path: version
+        x-descriptors:
+        - 'urn:alm:descriptor:com.tectonic.ui:label'
       - displayName: Kiali Namespace
         description: "The namespace where Kiali and its associated resources will be created. Default: istio-system"
         path: deployment.namespace
@@ -207,6 +216,11 @@ spec:
       - kind: ConfigMap
         version: v1
       specDescriptors:
+      - displayName: Version
+        description: "The version of OSSMC to install. This is specified in the form 'vX.Y'. Check the documentation for the values that are valid and supported. When not specified, or when set to the string 'default', the latest supported version of OSSMC will be installed. You must ensure this value is the same as the spec.version field in the Kiali CR that was used to install the Kiali Server, otherwise you are not guaranteed OSSMC will work properly. Default: default"
+        path: version
+        x-descriptors:
+        - 'urn:alm:descriptor:com.tectonic.ui:label'
       - displayName: Kiali Service Name
         description: "The internal Kiali service that the OS Console will use to proxy API calls. If empty, an attempt will be made to auto-discover it from the Kiali OpenShift Route."
         path: kiali.serviceName