kiali

README

= Kiali image:https://travis-ci.org/kiali/kiali.svg["Build Status", link="https://travis-ci.org/kiali/kiali"]
:toc: macro
:toc-title:

toc::[]

== Introduction

Kiali provides answers to the question _What are the microservices in my Istio service mesh doing?_

image::https://kiali.org/assets/img/kiali-graph.png[Kiali Graph]

=== Description

A Microservice Architecture breaks up the monolith into many smaller pieces that are composed together. Patterns to secure the communication between services like fault tolerance (via timeout, retry, circuit breaking, etc.) have come up as well as distributed tracing to be able to see where calls are going.

A service mesh can now provide these services on a platform level and frees the application writers from those tasks. Routing decisions are done at the mesh level.

Kiali works with Istio to visualise the service mesh topology, features like circuit breakers or request rates.

Kiali also includes Jaeger Tracing to provide distributed tracing out of the box.

=== Getting Started

If you are not a developer but just want to run something to see Kiali, then go to https://kiali.org for some instructions.

You could also try to use our hack script to quickly install OpenShift, Istio, and Kiali like this:

```
wget https://raw.githubusercontent.com/kiali/kiali/master/hack/cluster-openshift.sh
sh cluster-openshift.sh --kiali-enabled true up
```

If you do not already have an Istio-enabled application to test with, you can install one using the link:hack/istio/README.adoc[Bookinfo Demo install script] provided here as a convenience.

There are other demo applications to choose from as well: link:./DEMOS.adoc[see some examples].

=== Docker Image

Kiali is published as a docker image on https://hub.docker.com/r/kiali/kiali[Docker hub at kiali/kiali]

=== License and Copyright

See the link:./LICENSE[LICENSE file].

== Building

[NOTE]
These build instructions assume you have the following installed on your system: (1) link:http://golang.org/doc/install[Go Programming Language] which must be at least version 1.8.3, (2) link:http://git-scm.com/book/en/v2/Getting-Started-Installing-Git[git], (3) link:https://docs.docker.com/installation/[Docker], and (4) make. To run Kiali on OpenShift after you build it, it is assumed you have a running OpenShift environment available to you. If you do not, you can find a set of link:#setting-up-openshift[instructions on how to set up OpenShift below]. To run Kiali on Kubernetes after you built it, it is assumed you have a running Kubernetes environment available to you.

To build Kiali:

* Clone this repository inside a GOPATH. These instructions will use the example GOPATH of "/source/kiali/kiali" but you can use whatever you want. Just change the first line of the below instructions to use your GOPATH.

[source,shell]
----
export GOPATH=/source/kiali/kiali
mkdir -p $GOPATH
cd $GOPATH
mkdir -p src/github.com/kiali
cd src/github.com/kiali
git clone git@github.com:kiali/kiali
export PATH=${PATH}:${GOPATH}/bin
----

* Install Glide - the Go dependency management tool that Kiali uses to build itself

[source,shell]
----
cd ${GOPATH}/src/github.com/kiali/kiali
make dep-install
----

* Tell the dependency manager tool to update the Kiali dependencies
[NOTE]
You should only run this command if you add, remove, or modify a dependency. If you are simply git cloning and building from source, you should skip this step.

[source,shell]
----
cd ${GOPATH}/src/github.com/kiali/kiali
make dep-update
----

* Build Kiali

[source,shell]
----
cd ${GOPATH}/src/github.com/kiali/kiali
make build
----

* At this point you can run the Kiali tests

[source,shell]
----
cd ${GOPATH}/src/github.com/kiali/kiali
make test
----

== Running

[NOTE]
If you want to quickly get up and running to play with Kiali and do not wish to git clone the repository, or build anything, see https://kiali.org for instructions. If you do not have a cluster environment (e.g. OpenShift) yet, grab the link:https://raw.githubusercontent.com/kiali/kiali/master/hack/cluster-openshift.sh[cluster-openshift.sh] convenience script and run it to quickly start an OpenShift cluster environment with Istio installed. If you do not have a service mesh to test with, grab the link:https://raw.githubusercontent.com/kiali/kiali/master/hack/istio/install-bookinfo-demo.sh[install-bookinfo-demo.sh] convenience script to download and install the Istio Bookinfo Demo service mesh.

=== Secrets

*Note*: There is a secret variable in the configuration called *TOKEN_SECRET*, be careful with this secret.

=== Running on OpenShift

==== Setting up OpenShift

The following section assumes that the user has link:https://github.com/openshift/origin[OpenShift Origin] installed.

The link:https://docs.openshift.org/latest/welcome/index.html[OpenShift Origin Documentation] will outline all the steps required.

==== Building the Docker Image

Create the Kiali docker image through the "docker-build" make target:

[source,shell]
----
cd ${GOPATH}/src/github.com/kiali/kiali
make docker-build
----

==== Deploying Kiali to OpenShift

[NOTE]
Before deploying and running Kiali, you must first install and deploy link:https://istio.io[Istio]. *Required Istio Version: 0.8+*. There are a few places that you can reference in order to learn how to do this such as link:https://github.com/redhat-developer-demos/istio-tutorial[here], link:https://blog.openshift.com/evaluate-istio-openshift/[here], and link:https://istio.io/docs/setup/kubernetes/quick-start.html[here].

[NOTE]
The following make targets assume that the `oc` command is available in the user's PATH and that the user is logged in. If you have `istiooc` instead, create a symlink in your PATH pointing `oc` to your `istiooc` binary.

The deploy and undeploy commands are automated in the Makefile. The following will undeploy an old installation of Kiali, if available, and deploy a new one:
----
make openshift-deploy
----

==== Undeploying Kiali from OpenShift

If you want to remove Kiali from your OpenShift environment, you can do so by running the following command:

[source,shell]
----
make openshift-undeploy
----

==== Reloading Kiali image in OpenShift

If you already have Kiali installed but you want to recreate the pod with a new docker image, you can run the following command:

[source,shell]
----
make openshift-reload-image
----

=== Running on Kubernetes

==== Setting up Kubernetes

The following section assumes that the user has link:https://github.com/kubernetes/kubernetes[Kubernetes] installed.

==== Building the Docker Image

Create the Kiali docker image through the "docker-build" make target:

[source,shell]
----
cd ${GOPATH}/src/github.com/kiali/kiali
make docker-build
----

Note that if you are using minikube, you can build the docker image and push it directly into the minikube docker daemon using the alternative make target `minikube-docker`:

[source,shell]
----
cd ${GOPATH}/src/github.com/kiali/kiali
make minikube-docker
----

==== Deploying Kiali to Kubernetes

[NOTE]
Before deploying and running Kiali, you must first install and deploy link:https://istio.io[Istio]. *Required Istio Version: 0.8+*. There are a few places that you can reference in order to learn how to do this such as link:https://github.com/redhat-developer-demos/istio-tutorial[here], link:https://blog.openshift.com/evaluate-istio-openshift/[here], and link:https://istio.io/docs/setup/kubernetes/quick-start.html[here].

[NOTE]
The following make targets assume that the `kubectl` command is available in the user's PATH.

[NOTE]
In order to deploy on Kubernetes and to be able to access the deployed service, you must ensure you have Ingress support. If you are using minikube, you need to run `minikube addons enable ingress` and add `kiali` as a hostname in your `/etc/hosts` via something like this command: `echo "$(minikube ip) kiali" | sudo tee -a /etc/hosts`

The deploy and undeploy commands are automated in the Makefile. The following will undeploy an old installation of Kiali, if available, and deploy a new one:
----
make k8s-deploy
----

==== Undeploying Kiali from Kubernetes

If you want to remove Kiali from your Kubernetes environment, you can do so by running the following command:

[source,shell]
----
make k8s-undeploy
----

==== Reloading Kiali image in Kubernetes

If you already have Kiali installed but you want to recreate the pod with a new docker image, you can run the following command:

[source,shell]
----
make k8s-reload-image
----

=== Running Standalone

Sometimes you may want to run Kiali outside of any container environment, perhaps for debugging purposes. To do this, run:

[source,shell]
----
cd ${GOPATH}/src/github.com/kiali/kiali
make install
make run
----

The "install" target installs the Kiali executable in your GOPATH /bin directory so you can run it outside of the Makefile:

[source,shell]
----
cd ${GOPATH}/src/github.com/kiali/kiali
make install
${GOPATH}/bin/kiali -config <your-config-file>
----

== Environment Variables

Many configuration settings can optionally be set via environment variables. If one of the environment variables below are set, they serve as the default value for its associated YAML configuration setting. The following are currently supported:

[cols="1a,1a"]
|===
|Environment Variable Name|Description and YAML Setting

|`IDENTITY_CERT_FILE`
|Certificate file used to identify the file server. If set, you must go over https to retrieve content from the file server.
[source,yaml]
----
identity:
  cert_file: VALUE
----

|`IDENTITY_PRIVATE_KEY_FILE`
|Private key file used to identify the server. If set, you must go over https to retrieve content from the file server.
[source,yaml]
----
identity:
  private_key_file: VALUE
----

|`SERVER_ADDRESS`
|Where the http server is bound to.
[source,yaml]
----
server:
  address: VALUE
----

|`SERVER_PORT`
|Where the http server is listening.
[source,yaml]
----
server:
  port: VALUE
----

|`SERVER_CREDENTIALS_USERNAME`
|If this (and password) is set, these credentials are required in order to get content from the server.
[source,yaml]
----
server:
  credentials:
    username: VALUE
----

|`SERVER_CREDENTIALS_PASSWORD`
|If this (and username) is set, these credentials are required in order to get content from the server.
[source,yaml]
----
server:
  credentials:
    password: VALUE
----

|`SERVER_CORS_ALLOW_ALL`
|When true, allows the web console to send requests to other domains other than where the console came from. Typically used for development environments only.
[source,yaml]
----
server:
  cors_allow_all: (true\|false)
----

|`SERVER_STATIC_CONTENT_ROOT_DIRECTORY`
|The file server will serve all static content found under this root directory.
[source,yaml]
----
server:
  static_content_root_directory: VALUE
----

|`IN_CLUSTER`
|The annotation used by Istio in a Deployment template. If in_cluster is false then you need to set environments: `KUBERNETES_SERVICE_HOST`, `KUBERNETES_SERVICE_PORT` (Local development mode : oc proxy --port KUBERNETES_SERVICE_PORT ). (default is `true`)
[source,yaml]
----
in_cluster: (true\|false)
----

|`SERVICE_FILTER_LABEL_NAME`
|Label name which all resources of a service are group by. (default is `app`)
[source,yaml]
----
service_filter_label_name: VALUE
----

|`PROMETHEUS_SERVICE_URL`
|The URL used to access and query the Prometheus Server. It must be accessible from Kiali pod. (default is `http://prometheus.istio-system:9090`)
[source,yaml]
----
external_services:
  prometheus_service_url: VALUE
----

|`ISTIO_SIDECAR_ANNOTATION`
|The annotation used by Istio in a Deployment template.
[source,yaml]
----
external_services:
  istio:
    istio_sidecar_annotation: VALUE
----

|`ISTIO_IDENTITY_DOMAIN`
|The annotation used by Istio how Identity Domain. (default is `svc.cluster.local`)
[source,yaml]
----
external_services:
  istio:
    istio_identity_domain: VALUE
----

|`ISTIO_URL_SERVICE_VERSION`
|The Service of Istio to check version. (default is `http://istio-pilot:9093/version`)
[source,yaml]
----
external_services:
  istio:
    istio_url_service_version: VALUE
----


|`GRAFANA_DISPLAY_LINK`
|When true, a link to Grafana will be displayed for more metrics.
[source,yaml]
----
external_services:
  grafana:
    display_link: (true\|false)
----

|`GRAFANA_URL`
|The URL to the Grafana server. When not set, the URL may be automatically detected from OpenShift or Kubernetes API.
[source,yaml]
----
external_services:
  grafana:
    url: VALUE
----

|`GRAFANA_SERVICE_NAMESPACE`
|The Kubernetes namespace that holds the Grafana service. This configuration is ignored if `GRAFANA_URL` is set. (default is `istio-system`)
[source,yaml]
----
external_services:
  grafana:
    service_namespace: VALUE
----

|`GRAFANA_SERVICE`
|The OpenShift route name or the Kubernetes service name for Grafana. This configuration is ignored if `GRAFANA_URL` is set. (default is `grafana`)
[source,yaml]
----
external_services:
  grafana:
    service: VALUE
----

|`GRAFANA_DASHBOARD`
|The name of the Grafana dashboard used as a landing page. (default is `istio-dashboard`)
[source,yaml]
----
external_services:
  grafana:
    dashboard: VALUE
----

|`GRAFANA_VAR_SERVICE_SOURCE`
|The name of the Grafana variable that controls service sources, as defined in the configured `GRAFANA_DASHBOARD`. (default is `var-source`)
[source,yaml]
----
external_services:
  grafana:
    var_service_source: VALUE
----

|`GRAFANA_VAR_SERVICE_DEST`
|The name of the Grafana variable that controls service destinations, as defined in the configured `GRAFANA_DASHBOARD`. (default is `var-http_destination`)
[source,yaml]
----
external_services:
  grafana:
    var_service_dest: VALUE
----

|`JAEGER_URL`
|The URL to the Jaeger server. When not set, the URL may be automatically detected from OpenShift or Kubernetes API.
[source,yaml]
----
external_services:
  jaeger:
    url: VALUE
----

|`JAEGER_SERVICE_NAMESPACE`
|The Kubernetes namespace that holds the Jaeger service. This configuration is ignored if `JAEGER_URL` is set. (default is `istio-system`)
[source,yaml]
----
external_services:
  jaeger:
    service_namespace: VALUE
----

|`JAEGER_SERVICE`
|The OpenShift route name or the Kubernetes service name for Jaeger. This configuration is ignored if `JAEGER_URL` is set. (default is `jaeger-query`)
[source,yaml]
----
external_services:
  jaeger:
    service: VALUE
----

|`TOKEN_SECRET`
|The token secret for generate. This configuration is ignored if `TOKEN_SECRET` is set. (default is `kiali`)
[source,yaml]
----
token:
  secret: VALUE
----
|`TOKEN_EXPIRATION_AT`
|The token expired in VALUE seconds. This configuration is ignored if `TOKEN_EXPIRATION_AT` is set. (default is 10 hours => 36000)
[source,yaml]
----
token:
  expiration_hours: VALUE
----
|===

== Additional Notes

=== Running the UI Outside the Core

When developing the http://github.com/kiali/kiali-ui[Kiali UI] you will find it useful to run it outside of the core to make it easier to update the UI code and see the changes without having to recompile. The prefered approach for this is to use a proxy on the UI to mount the core. The process is described https://github.com/kiali/kiali-ui#developing[here].

To connect with the backend and avoid the javascript prompt requesting authentication you need to send the requests with a specific header.
[source]
----
X-Auth-Type-Kiali-UI: 1
----
The response will contain the header
[source]
----
WWW-Authenticate: xBasic realm="Kiali"
----
Otherwise the header will be
[source]
----
WWW-Authenticate: Basic realm="Kiali"
----

=== Running A Locally Built UI Inside the Core

If you are developing the UI on your local machine but you want to see it deployed and running inside of the core server, you can do so by setting the environment variable CONSOLE_VERSION to the value "local" when building the docker image via the `docker-build` target. By default, your UI's build/ directory is assumed to be in a directory called `kiali-ui` that is a peer directory of the GOPATH root directory for the core server. If it is not, you can set the environment variable CONSOLE_LOCAL_DIR to the value of the path of the root directory for the UI such that `$CONSOLE_LOCAL_DIR/build` contains the generated build files for the UI.

For example, if your GOPATH directory for the Kiali project is `/source/kiali/kiali` and you have git cloned the Kiali UI repository in `/source/kiali/kiali-ui` then you do not need to set CONSOLE_LOCAL_DIR. You can embed your locally built console into the core docker image via:

[source,shell]
----
CONSOLE_VERSION=local make docker-build
----

If you git cloned the Kiali UI repository in directory `/my/git/repo` and have built the UI there (such that the build files are located at `/my/git/repo/build`) then you can embed that locally built console into the core docker image via:

[source,shell]
----
CONSOLE_VERSION=local CONSOLE_LOCAL_DIR=/my/git/repo make docker-build
----

== Contributing

All contributions are welcome - Kiali uses the Apache 2 license and does not require any contributor agreement to submit patches. Please link:https://github.com/kiali/kiali/issues[open issues] for any bugs or problems you encounter or to suggest new features. Ask questions on the Kiali IRC channel (_#kiali_ on freenode) or the Google Groups: link:++https://groups.google.com/forum/#!forum/kiali-users++[kiali-users] or link:++https://groups.google.com/forum/#!forum/kiali-dev++[kiali-dev]. Get involved by submitting pull requests on GitHub.

To setup your environment, check instructions in the link:#building[Building] and link:#running[Running] sections.

=== Code Style Guide

See the link:./STYLE_GUIDE.adoc[Backend Style Guide] and the link:https://github.com/kiali/kiali-ui/blob/master/STYLE_GUIDE.adoc[Frontend Style Guide].

Documentation

Overview

Kiali

Kiali project, observability for the Istio service mesh

Schemes: http, https
BasePath: /api
Version: _

Consumes:
- application/json

Produces:
- application/json

swagger:meta