= Kiali image:https://img.shields.io/twitter/url/http/shields.io.svg?style=social["Tweet about Kiali", link="https://twitter.com/intent/tweet?text=Learn%20what%20your%20Istio-Mesh%20is%20doing.%20Visit%20https://www.kiali.io/%20and%20@kialiProject"] :toc: macro :toc-title:

image:https://img.shields.io/badge/license-Apache2-blue.svg["Apache 2.0 license", link="LICENSE"]

== Introduction

link:https://kiali.io/[kiali] is a management console for Istio service mesh. Kiali can be quickly installed as an Istio add-on or integrated as a trusted component within a production environment.

=== Table of contents

toc::[]

=== Contributing

First, check the link:https://kiali.io/community/[Community section on kiali.io], which provides a brief introduction on contributing, how to report issues and request features, and how to reach us.

For those interested in making code contributions, please also check the link:./CONTRIBUTING.md[Contribution Guide].

=== Getting Started

The target audience of this README are developers. For those who are not developers but wish to learn more about Kiali, the link:https://kiali.io/docs[Kiali documentation] should be more helpful. For instructions on installing Kiali, please read the link:https://kiali.io/docs/installation/[Installation] page.

=== AI Documentation (Dev Preview)

Kiali includes a Chat AI integration in developer preview. The APIs and configuration are still evolving and may change without notice. See link:./ai/README.md[AI README] for details.

=== How and where Kiali is released?

Read the link:./RELEASING.adoc[RELEASING.adoc] file.

== Developer setup

Ensure the following tools are available:

• The link:http://golang.org/doc/install[Go Programming Language] ** Kiali releases are built with a specified minimum version of Go, as indicated in the link:https://github.com/kiali/kiali/blob/master/Makefile#L31[Makefile]. While Kiali may compile with other versions, using the version specified in the Makefile is recommended for consistent builds.
• link:http://git-scm.com/book/en/v2/Getting-Started-Installing-Git[git]
• gcc
• link:https://docs.docker.com/installation/[Docker] or link:https://podman.io[Podman] ** If using podman, set the environment variable DORP=podman.
• link:https://nodejs.org[NodeJS] (Node.js >= 20 with the NPM command) ** link:https://nodejs.org/api/corepack.html[Corepack] is used to manage the Yarn version. Enable it with corepack enable. The exact Yarn version is pinned in frontend/package.json via the packageManager field.
• The GNU make (or a compatible alternative)

Once the required developer tools are available, the code can be obtained and built using the following script:

[source,shell]

Checkout the source code

mkdir kiali_sources cd kiali_sources export KIALI_SOURCES=$(pwd)

git clone https://github.com/kiali/kiali.git git clone https://github.com/kiali/kiali-operator.git git clone https://github.com/kiali/helm-charts.git

ln -s $KIALI_SOURCES/kiali-operator kiali/operator

Build the front-end

make build-ui

Build the back-end

cd $KIALI_SOURCES/kiali make build

Go test flags can be passed via the GO_TEST_FLAGS environment variable.

make -e GO_TEST_FLAGS="-race -v -run="TestCanConnectToIstiodReachable"" test

---

[NOTE] The rest of this README assumes the directory tree created by the previous commands:

-- kiali_sources |- kiali |- kiali-operator - helm-charts

=== Create a Kubernetes cluster and install a Service Mesh

To use Kiali, a management console for Istio-based service meshes, an Istio-compatible service mesh is required. Istio meshes are installed on Kubernetes clusters.

We provide a few unsupported scripts that can help to get started. The scripts below are already in the Kiali Repository. Ensure that the correct path is being used to run the scripts without issues.

• One way to setup your development environment locally is to run the link:hack/run-integration-tests.sh[run-integration-tests.sh] script. This will start a local cluster, install Istio and Bookinfo, and then start Kiali. It supports every deployment scenario including multi-cluster, external Kiali, etc. It is also run as part of the CI pipeline so there's a high chance it will work for you. The multi-cluster suites currently do not work with podman and you must have docker engine installed on your system.
• The link:hack/crc-openshift.sh[crc-openshift.sh] script allows creation of an OpenShift cluster on a local machine.
• For those familiar with minikube, the link:hack/k8s-minikube.sh[k8s-minikube.sh] script can be used. This script includes an option to install Dex, which is helpful for testing with OpenID.
• Alternatively, the link:hack/start-kind.sh[start-kind.sh] script can be used to create a single-node KinD cluster with MetalLB enabled, allowing Kiali to be tested in a real environment.
• Finally, the link:hack/istio/install-istio-via-istioctl.sh[install-istio-via-istioctl.sh] and the link:hack/istio/install-bookinfo-demo.sh[install-bookinfo-demo.sh] scripts can assist in installing Istio and the Bookinfo sample application in the cluster, respectively. Trying to run these scripts without any arguments is also an option.

These scripts are written to rely on the minimum dependencies as possible and will try to download any required tools.

Based on the type of cluster in use, define the CLUSTER_TYPE environment variable in the shell. Set it to openshift (default if not specified), minikube or kind so the Makefiles can assist with additional operations. For other cluster types, set CLUSTER_TYPE=local.

[NOTE] For minikube it is recommended to enable the registry and ingress add-ons, which can be configured by the k8s-minikube.sh script.

[NOTE] When using docker with Minikube's registry add-on or any custom non-secure registry, ensure the link:https://docs.docker.com/registry/insecure/[Docker daemon is properly configured to use your registry].

=== Running Kiali from your local kubeconfig (with hot-reload)

以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗