Install

Instructions for installing Aeraki.

Requirements

MetaProtocol and Istio compatiblity

Before installing Aeraki, please check the supported Istio versions and the corresponding Proxy version:

Aeraki MetaProtocol Proxy Istio
1.0.x 1.0.x 1.10.x
1.1.x 1.1.x 1.12.x

Modify Istio configuration

Please modify the istio ConfigMap to add the following content.

  • Enable Istio DNS catpure
  • Turn on metrics for Aeraki managed protocols
kubectl edit cm istio -n istio-system
apiVersion: v1
data:
  mesh: |-
    defaultConfig:
      proxyMetadata:
        ISTIO_META_DNS_CAPTURE: "true"
      proxyStatsMatcher:
        inclusionPrefixes:
        - thrift
        - dubbo
        - kafka
        - meta_protocol
        inclusionRegexps:
        - .*dubbo.*
        - .*thrift.*
        - .*kafka.*
        - .*zookeeper.*
        - .*meta_protocol.*    

Install Aeraki

git clone https://github.com/aeraki-mesh/aeraki.git
cd aeraki
export AERAKI_VERSION=1.0.0
make install

Install AerakiCtl(Optional)

You can choose to install aerakictl tool for debug purpose.

git clone https://github.com/aeraki-mesh/aerakictl.git ~/aerakictl;source ~/aerakictl/aerakictl.sh

Use Aeraki in TCM(Tencent Cloud Mesh)

If you want to use Aeraki with Tencent Cloud Mesh TCM, please contact TCM’s sales team or business advisors.


Last modified May 23, 2022: 增加 v1.1 文档目录 (431bf1a)