Skip to content
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

Jump to bottom

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

Merged
merged 1 commit into from
Nov 2, 2023
Merged

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

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
74 changes: 33 additions & 41 deletions manifests/kiali-community/1.77.0/manifests/kiali.v1.77.0.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,13 @@ metadata:
"name": "kiali"
},
"spec": {
"installation_tag": "My Kiali",
"version": "default",
"istio_namespace": "istio-system",
"deployment": {
"namespace": "istio-system",
"logger": {
"log_level": "info"
},
"view_only_mode": false
},
"server": {
"web_root": "/mykiali"
}
}
},
Expand All @@ -45,10 +44,10 @@ metadata:
"name": "ossmconsole"
},
"spec": {
"version": "default",
"kiali": {
"serviceName": "",
"serviceNamespace": "",
"servicePort": 0
"serviceNamespace": ""
}
}
}
Expand Down Expand Up @@ -80,12 +79,7 @@ spec:

### Accessing the UI

The Kiali operator can expose the Kiali UI as a Route on OpenShift
or Ingress on Kubernetes.

On OpenShift, the default root context path is '/' and on Kubernetes it is
'/kiali' though you can change this by configuring the 'web_root' setting in
the Kiali CR.
By default, the Kiali operator exposes the Kiali UI as an OpenShift Route.

If on OpenShift, you can create an OSSMConsole CR to have the operator
install the OpenShift ServiceMesh Console plugin to the OpenShift Console
Expand All @@ -99,22 +93,12 @@ spec:
Custom Resource (CR), see
[the kiali.io docs](https://kiali.io/docs/configuration/kialis.kiali.io/).

Note that the Kiali operator can be told to restrict Kiali's access to
specific namespaces, or can provide to Kiali cluster-wide access to all
namespaces.

## Prerequisites for enabling this Operator

Today Kiali works with Istio. So before you install Kiali, you must have
already installed Istio.
If you already have Kiali in your Istio environment and you want to
install Kiali via the Kiali Operator, uninstall the installed Kiali first.

When you install Kiali in a non-OpenShift Kubernetes environment, the
authentication strategy will default to `token`.

If you wish to use the `openid` authentication strategy, you must have an
OpenID Connect available and accessible to Kiali.
icon:
- base64data: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIyLjAuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCAxMjgwIDEyODAiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgMCAwIDEyODAgMTI4MDsiIHhtbDpzcGFjZT0icHJlc2VydmUiPgo8c3R5bGUgdHlwZT0idGV4dC9jc3MiPgoJLnN0MHtmaWxsOiMwMTMxNDQ7fQoJLnN0MXtmaWxsOiMwMDkzREQ7fQo8L3N0eWxlPgo8Zz4KCTxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik04MTAuOSwxODAuOWMtMjUzLjYsMC00NTkuMSwyMDUuNS00NTkuMSw0NTkuMXMyMDUuNSw0NTkuMSw0NTkuMSw0NTkuMVMxMjcwLDg5My42LDEyNzAsNjQwCgkJUzEwNjQuNSwxODAuOSw4MTAuOSwxODAuOXogTTgxMC45LDEwMjkuMmMtMjE1LDAtMzg5LjItMTc0LjMtMzg5LjItMzg5LjJjMC0yMTUsMTc0LjMtMzg5LjIsMzg5LjItMzg5LjJTMTIwMC4xLDQyNSwxMjAwLjEsNjQwCgkJUzEwMjUuOSwxMDI5LjIsODEwLjksMTAyOS4yeiIvPgoJPHBhdGggY2xhc3M9InN0MSIgZD0iTTY1My4zLDI4NGMtMTM2LjQsNjAuNS0yMzEuNiwxOTcuMS0yMzEuNiwzNTZjMCwxNTguOCw5NS4yLDI5NS41LDIzMS42LDM1NmM5OC40LTg3LjEsMTYwLjQtMjE0LjMsMTYwLjQtMzU2CgkJQzgxMy43LDQ5OC4zLDc1MS42LDM3MS4xLDY1My4zLDI4NHoiLz4KCTxwYXRoIGNsYXNzPSJzdDEiIGQ9Ik0zNTEuOCw2NDBjMC0xMDkuOCwzOC42LTIxMC41LDEwMi44LTI4OS41Yy0zOS42LTE4LjItODMuNi0yOC4zLTEzMC0yOC4zQzE1MC45LDMyMi4yLDEwLDQ2NC41LDEwLDY0MAoJCXMxNDAuOSwzMTcuOCwzMTQuNiwzMTcuOGM0Ni4zLDAsOTAuNC0xMC4xLDEzMC0yOC4zQzM5MC4zLDg1MC41LDM1MS44LDc0OS44LDM1MS44LDY0MHoiLz4KPC9nPgo8L3N2Zz4K
mediatype: image/svg+xml
Expand Down Expand Up @@ -142,6 +126,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
Expand Down Expand Up @@ -172,27 +158,33 @@ spec:
version: oauth.openshift.io/v1
- kind: Route
version: route.openshift.io/v1
- kind: ConsoleLink
version: consolelinks.console.openshift.io/v1
specDescriptors:
- displayName: Authentication Strategy
description: "Determines how a user is to log into Kiali. Default: openshift (when deployed in OpenShift); token (when deployed in other Kubernetes clusters)"
path: auth.strategy
- 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:text'
- displayName: Istio Namespace
description: "The namespace where the Istio control plane is installed. Default: istio-system"
path: deployment.istio_namespace
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
- 'urn:alm:descriptor:com.tectonic.ui:text'
- displayName: Log Level
description: "Determines the priority levels of log messages Kiali will output. Typical values are 'info', 'debug', or 'trace'. Default: info"
path: deployment.logger.log_level
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:label'
- 'urn:alm:descriptor:com.tectonic.ui:select:info'
- 'urn:alm:descriptor:com.tectonic.ui:select:debug'
- 'urn:alm:descriptor:com.tectonic.ui:select:trace'
- 'urn:alm:descriptor:com.tectonic.ui:select:warn'
- 'urn:alm:descriptor:com.tectonic.ui:select:error'
- displayName: View Only Mode
description: "When true, Kiali will be in 'view only' mode, allowing the user to view and retrieve management and monitoring data for the service mesh, but not allow the user to modify the service mesh. Default: false"
path: deployment.view_only_mode
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:booleanSwitch'
- displayName: Web Root
description: "Defines the root context path for the Kiali console, API endpoints and readiness/liveness probes. Default: / (when deployed on OpenShift; /kiali (when deployed on Kubernetes)"
path: server.web_root
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:label'
- name: ossmconsoles.kiali.io
group: kiali.io
description: A configuration file for a OpenShift Service Mesh Console installation.
Expand All @@ -207,6 +199,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:text'
- 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
Expand All @@ -217,11 +214,6 @@ spec:
path: kiali.serviceNamespace
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:text'
- displayName: Kiali Service Port
description: "The internal port used by the Kiali service for the API. If empty, an attempt will be made to auto-discover it from the Kiali OpenShift Route."
path: kiali.servicePort
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:text'
apiservicedefinitions: {}
install:
strategy: deployment
Expand Down
55 changes: 28 additions & 27 deletions manifests/kiali-ossm/manifests/kiali.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,12 @@ metadata:
"name": "kiali"
},
"spec": {
"installation_tag": "My Kiali",
"version": "default",
"istio_namespace": "istio-system",
"deployment": {
"logger": {
"log_level": "debug"
"log_level": "info"
},
"namespace": "istio-system",
"view_only_mode": false
}
}
Expand All @@ -57,10 +56,10 @@ metadata:
"name": "ossmconsole"
},
"spec": {
"version": "default",
"kiali": {
"serviceName": "",
"serviceNamespace": "",
"servicePort": 0
"serviceNamespace": ""
}
}
}
Expand Down Expand Up @@ -94,9 +93,6 @@ spec:

By default, the Kiali operator exposes the Kiali UI as an OpenShift Route.

The default root context path is '/' though you can change
this by configuring the 'web_root' setting in the Kiali CR.

If on OpenShift, you can create an OSSMConsole CR to have the operator
install the OpenShift ServiceMesh Console plugin to the OpenShift Console
thus providing an interface directly integrated with the OpenShift Console.
Expand Down Expand Up @@ -140,6 +136,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
Expand Down Expand Up @@ -173,26 +171,30 @@ spec:
- kind: ConsoleLink
version: consolelinks.console.openshift.io/v1
specDescriptors:
- displayName: Kiali Namespace
description: "The namespace where Kiali and its associated resources will be created. Default: istio-system"
path: deployment.namespace
- 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: Verbose Mode
description: "Determines the priority levels of log messages Kiali will output. Typical values are '3' for INFO and higher priority messages, '4' for DEBUG and higher priority messages (this makes the logs more noisy). Default: 3"
path: deployment.verbose_mode
- 'urn:alm:descriptor:com.tectonic.ui:text'
- displayName: Istio Namespace
description: "The namespace where the Istio control plane is installed. Default: istio-system"
path: deployment.istio_namespace
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:label'
- 'urn:alm:descriptor:com.tectonic.ui:text'
- displayName: Log Level
description: "Determines the priority levels of log messages Kiali will output. Typical values are 'info', 'debug', or 'trace'. Default: info"
path: deployment.logger.log_level
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:select:info'
- 'urn:alm:descriptor:com.tectonic.ui:select:debug'
- 'urn:alm:descriptor:com.tectonic.ui:select:trace'
- 'urn:alm:descriptor:com.tectonic.ui:select:warn'
- 'urn:alm:descriptor:com.tectonic.ui:select:error'
- displayName: View Only Mode
description: "When true, Kiali will be in 'view only' mode, allowing the user to view and retrieve management and monitoring data for the service mesh, but not allow the user to modify the service mesh. Default: false"
path: deployment.view_only_mode
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:booleanSwitch'
- displayName: Web Root
description: "Defines the root context path for the Kiali console, API endpoints and readiness/liveness probes. Default: /"
path: server.web_root
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:label'
- name: ossmconsoles.kiali.io
group: kiali.io
description: A configuration file for a OpenShift Service Mesh Console installation.
Expand All @@ -207,6 +209,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:text'
- 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
Expand All @@ -217,11 +224,6 @@ spec:
path: kiali.serviceNamespace
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:text'
- displayName: Kiali Service Port
description: "The internal port used by the Kiali service for the API. If empty, an attempt will be made to auto-discover it from the Kiali OpenShift Route."
path: kiali.servicePort
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:text'
apiservicedefinitions: {}
install:
strategy: deployment
Expand Down Expand Up @@ -535,7 +537,6 @@ spec:
- configmaps
- endpoints
- pods/log
- pods/proxy
verbs:
- get
- list
Expand Down