Install

Instructions for installing Aeraki.

Requirements

MetaProtocol and Istio compatiblity

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

AerakiMetaProtocol ProxyIstio
1.0.x1.0.x1.10.x
1.1.x1.1.x1.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
  1. kubectl edit cm istio -n istio-system
  1. apiVersion: v1
  2. data:
  3. mesh: |-
  4. defaultConfig:
  5. proxyMetadata:
  6. ISTIO_META_DNS_CAPTURE: "true"
  7. proxyStatsMatcher:
  8. inclusionPrefixes:
  9. - thrift
  10. - dubbo
  11. - kafka
  12. - meta_protocol
  13. inclusionRegexps:
  14. - .*dubbo.*
  15. - .*thrift.*
  16. - .*kafka.*
  17. - .*zookeeper.*
  18. - .*meta_protocol.*

Install Aeraki

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

Install AerakiCtl(Optional)

You can choose to install aerakictl tool for debug purpose.

  1. 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)