From 83d0d56dafc5a13ed67f3c50bbddb09e67d33e86 Mon Sep 17 00:00:00 2001 From: WangDai Date: Fri, 14 Nov 2025 20:32:04 +0800 Subject: [PATCH] docs: add guidance docs for setting up the Kind + Istio environment --- .../service_discovery_guide/setup_env_en.md | 90 +++++++++++++ .../service_discovery_guide/setup_env_zh.md | 119 ++++++++++++++++++ 2 files changed, 209 insertions(+) create mode 100644 docs/en/service_discovery_guide/setup_env_en.md create mode 100644 docs/zh/service_discovery_guide/setup_env_zh.md diff --git a/docs/en/service_discovery_guide/setup_env_en.md b/docs/en/service_discovery_guide/setup_env_en.md new file mode 100644 index 0000000..e6866e2 --- /dev/null +++ b/docs/en/service_discovery_guide/setup_env_en.md @@ -0,0 +1,90 @@ +# Install Kind & Istio, create a Kubernetes cluster + +This guide introduces how to install Kind (Kubernetes in Docker) and Istio on a physical Linux machine, create a Kubernetes cluster using Kind, and finally launch Istio services. It is applicable to both ARM and x86_64 architectures. Developers can experience the k8s service discovery capability of AIGW based on the Kind deployment environment. + +## Environmental requirements + +- Linux system +- Install `curl`, `git`, and `bash` +- Pre-install Docker (Kind uses Docker to create a K8s cluster) + +## Step 1: Install Kind + +### 1.1 Download Kind + +Download the appropriate Kind binary file according to the architecture. + +- **x86_64 architecture**: + + ```bash + curl -Lo kind https://kind.sigs.k8s.io/dl/v0.23.0/kind-linux-amd64 + ``` + +- **ARM architecture**: + + ```bash + curl -Lo kind https://kind.sigs.k8s.io/dl/v0.23.0/kind-linux-arm64 + ``` + +### 1.2 Install Kind + +After the download is complete, grant execute permission and move it to `/usr/local/bin`: + +```bash +chmod +x kind +sudo mv kind /usr/local/bin/ +``` + +## 2 Create a Kubernetes cluster + +Create a local Kubernetes cluster using Kind. +```bash +kind create cluster --name istio-cluster +``` + +After the cluster creation is complete, you can verify the cluster status using the following command: +```bash +kubectl cluster-info --context kind-istio-cluster +``` + +## 3 Installing Istio +### 3.1 Downloading Istio + +Download the Istio installation package according to the architecture. +- **x86_64 architecture**: +```bash +curl -Lo istio.tar.gz https://github.com/istio/istio/releases/download/1.27.3/istio-1.27.3-linux-amd64.tar.gz +``` + +- **ARM architecture**: +```bash +curl -Lo istio.tar.gz https://github.com/istio/istio/releases/download/1.27.3/istio-1.27.3-linux-arm64.tar.gz +``` + +### 3.2 Unzip and install Istio +```bash +tar -zxvf istio.tar.gz +cd istio-1.27.3 +sudo mv bin/istioctl /usr/local/bin/ +``` + +Verify whether istioctl is successfully installed: +```bash +istioctl version +``` + +### 3.3 Starting Istio +Install the Istio control plane using the default configuration of Istio: +```bash +istioctl install --set profile=demo -y +``` + +Verify Istio installation: +```bash +kubectl get pods -n istio-system +``` + +Obtain the external IP of the Istio gateway: +```bash +kubectl get svc istio-ingressgateway -n istio-system +``` \ No newline at end of file diff --git a/docs/zh/service_discovery_guide/setup_env_zh.md b/docs/zh/service_discovery_guide/setup_env_zh.md new file mode 100644 index 0000000..a653260 --- /dev/null +++ b/docs/zh/service_discovery_guide/setup_env_zh.md @@ -0,0 +1,119 @@ +# 在k8s集群内使用AIGW + +本指南介绍如何在 k8s 集群环境下使用 AIGW。首先介绍如何在 Linux 物理机上安装 Kind(Kubernetes in Docker)、Istio，并使用 Kind 创建 Kubernetes 集群并启动 Istio 服务。本文档适用于 ARM 和 x86_64 架构。开发者可以基于 Kind 部署环境，体验 AIGW 的 k8s 服务发现能力。 + +## 环境要求 + +- Linux 系统 +- 安装 `curl`、`git` 和 `bash` +- 预先安装 Docker（Kind 使用 Docker 创建 K8s 集群） + +## 1. 安装 Kind + +### 1.1 下载 Kind + +根据架构下载适合的 Kind 二进制文件。 + +- **x86_64 架构**: + + ```bash + curl -Lo kind https://kind.sigs.k8s.io/dl/v0.23.0/kind-linux-amd64 + ``` + +- **ARM 架构**: + + ```bash + curl -Lo kind https://kind.sigs.k8s.io/dl/v0.23.0/kind-linux-arm64 + ``` + +### 1.2 安装 Kind + +下载完成后，赋予执行权限并移动到 `/usr/local/bin` 中： + +```bash +chmod +x kind +sudo mv kind /usr/local/bin/ +``` + +## 2. 创建 Kubernetes 集群 + +使用 Kind 创建一个本地的 Kubernetes 集群。 +```bash +kind create cluster --name istio-cluster +``` + +等待集群创建完成，可以通过以下命令验证集群状态： +```bash +kubectl cluster-info --context kind-istio-cluster +``` + +## 3. 安装 Istio +### 3.1 下载 Istio + +根据架构下载 Istio 安装包。 +- **x86_64 架构**: +```bash +curl -Lo istio.tar.gz https://github.com/istio/istio/releases/download/1.27.3/istio-1.27.3-linux-amd64.tar.gz +``` + +- **ARM 架构**: +```bash +curl -Lo istio.tar.gz https://github.com/istio/istio/releases/download/1.27.3/istio-1.27.3-linux-arm64.tar.gz +``` + +### 3.2 解压并安装 Istio +```bash +tar -zxvf istio.tar.gz +cd istio-1.27.3 +sudo mv bin/istioctl /usr/local/bin/ +``` + +验证 istioctl 是否安装成功： +```bash +istioctl version +``` + +## 4. 运行 +### 4.1 启动 Mock Service +启动Mock Service，作为upstream服务组件被AIGW发现： +```bash +make start-mock-service +``` + +### 4.2 Docker 模式运行 +#### 启动 Istio & 订阅 k8s Service API +导出Kind集群配置到./etc目录，供Istio订阅： +```bash +kind get kubeconfig --name istio-test > ./etc/kind-kubeconfig.yaml +``` + +启动Istio： +```bash +make WITH_KIND=ON start-istio +``` + +#### 启动AIGW +启动AIGW，拉起自定义xDS服务器，从Istio Pilot订阅 CDS/EDS 信息，并启动gRPC Server供Envoy拉取。 +服务信息传递流程：Istio Pilot => AIGW 自定义xDS服务器 => Envoy。 +```bash +make WITH_KIND=ON start-aigw-xds +``` + +### 4.3 k8s pod 模式运行 +#### 启动 Istio 加入 k8s 集群 +使用默认配置安装 Istio 控制平面： +```bash +istioctl install --set profile=demo -y +``` + +验证 Istio 安装： +```bash +kubectl get pods -n istio-system +``` + +获取 Istio 网关的外部 IP： +```bash +kubectl get svc istio-ingressgateway -n istio-system +``` + +#### AIGW 加入 k8s 集群