在 EKS 上部署 Milvus 集群

本主题介绍了如何在 Amazon EKS 上部署 Milvus 集群。

先决条件

您的本地 PC 或 Amazon EC2 上已安装 AWS CLI，该设备将用作执行本文档中涵盖操作的终端。对于 Amazon Linux 2 或 Amazon Linux 2023，AWS CLI 工具已经安装。要在本地 PC 上安装 AWS CLI，请参阅如何安装 AWS CLI。
在首选终端设备上已安装 Kubernetes 和 EKS 工具，包括：

已正确授予 AWS IAM 权限。您正在使用的 IAM 安全主体必须具有使用 Amazon EKS IAM 角色、与服务相关的角色、AWS CloudFormation、VPC 和其他相关资源的权限。您可以按照以下任一方式为您的主体授予适当的权限。

(不推荐) 简单地将您用于 AWS 托管策略 AdministratorAccess 的用户/角色的关联策略设置为。

(强烈推荐) 为了实施最小权限原则，请执行以下操作：

要为 eksctl 设置权限，请参阅为 eksctl 设置最低权限。

要设置创建/删除 AWS S3 存储桶的权限，请参考以下权限设置：

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "S3BucketManagement",
      "Effect": "Allow",
      "Action": [
        "s3:CreateBucket",
        "s3:PutBucketAcl",
        "s3:PutBucketOwnershipControls",
        "s3:DeleteBucket"
      ],
      "Resource": [
        "arn:aws:s3:::milvus-bucket-*"
      ]
    }
  ]
}

要设置创建/删除 IAM 策略的权限，请参考以下权限设置。请将 YOUR_ACCOUNT_ID 替换为您自己的账户 ID。

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "IAMPolicyManagement",
      "Effect": "Allow",
      "Action": [
        "iam:CreatePolicy",
        "iam:DeletePolicy"
      ],
      "Resource": "arn:aws:iam::YOUR_ACCOUNT_ID:policy/MilvusS3ReadWrite"
    }
  ]
}    

设置 AWS 资源

您可以使用AWS管理控制台、AWS CLI或IaC工具（如Terraform）设置所需的AWS资源，包括AWS S3存储桶和EKS集群。在本文档中，我们更倾向于使用AWS CLI来演示如何设置AWS资源。

### 创建Amazon S3存储桶

1. 创建一个AWS S3存储桶。

    阅读[Bucket Naming Rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html)并在为您的AWS S3存储桶命名时遵守命名规则。

    ```shell
    milvus_bucket_name="milvus-bucket-$(openssl rand -hex 12)"

    aws s3api create-bucket --bucket "$milvus_bucket_name" --region 'us-east-2' --acl private  --object-ownership ObjectWriter --create-bucket-configuration LocationConstraint='us-east-2'

    # 输出
    #
    # "Location": "http://milvus-bucket-039dd013c0712f085d60e21f.s3.amazonaws.com/"

为上述创建的存储桶创建一个用于读取和写入对象的IAM策略。请将存储桶名称替换为您自己的名称。

echo '{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "s3:GetObject",
        "s3:PutObject",
        "s3:ListBucket",
        "s3:DeleteObject"
      ],
      "Resource": [
        "arn:aws:s3:::your-milvus-bucket-name",
        "arn:aws:s3:::your-milvus-bucket-name/*"
      ]
    }
  ]
}' > milvus-s3-policy.json

aws iam create-policy --policy-name MilvusS3ReadWrite --policy-document file://milvus-s3-policy.json


# 从命令输出中获取ARN如下：
# {
#     "Policy": {
#         "PolicyName": "MilvusS3ReadWrite",
#         "PolicyId": "AN5QQVVPM1BVTFlBNkdZT",
#         "Arn": "arn:aws:iam::12345678901:policy/MilvusS3ReadWrite",
#         "Path": "/",
#         "DefaultVersionId": "v1",
#         "AttachmentCount": 0,
#         "PermissionsBoundaryUsageCount": 0,
#         "IsAttachable": true,
#         "CreateDate": "2023-11-16T06:00:01+00:00",
#        "UpdateDate": "2023-11-16T06:00:01+00:00"
#     }
# }    

（可选）如果您希望使用访问密钥而不是IAM AssumeRole，将策略附加到您的AWS用户/角色。

aws iam attach-user-policy --user-name <your-user-name> --policy-arn "arn:aws:iam::<your-iam-account-id>:policy/MilvusS3ReadWrite"

创建Amazon EKS集群

准备一个集群配置文件如下，并命名为eks_cluster.yaml。请将MilvusS3ReadWrite_Policy_ARN替换为上述命令输出中列出的ARN。

apiVersion: eksctl.io/v1alpha5
kind: ClusterConfig

metadata:
  name: 'milvus-eks-cluster'
  region: 'us-east-2'
  version: "1.27"

iam:
  withOIDC: true

  serviceAccounts:
  - metadata:
      name: aws-load-balancer-controller
      namespace: kube-system
    wellKnownPolicies:

awsLoadBalancerController: true
- metadata:
    name: milvus-s3-access-sa
    namespace: milvus
    labels: {aws-usage: "milvus"}
  attachPolicyARNs:
  - "MilvusS3ReadWrite_Policy_ARN"

managedNodeGroups:
  - name: milvus-node-group
    labels: { role: milvus }
    instanceType: m6i.4xlarge
    desiredCapacity: 3
    privateNetworking: true
    
addons:
- name: vpc-cni
  version: latest
  attachPolicyARNs:
    - arn:aws:iam::aws:policy/AmazonEKS_CNI_Policy
- name: coredns
  version: latest
- name: kube-proxy
  version: latest
- name: aws-ebs-csi-driver
  version: latest
  wellKnownPolicies:
    ebsCSIController: true

运行以下命令创建一个 EKS 集群。
```
eksctl create cluster -f eks_cluster.yaml
```

获取 kubeconfig 文件。

aws eks update-kubeconfig --region 'us-east-2' --name 'milvus-eks-cluster'

验证 EKS 集群。

kubectl cluster-info

kubectl get nodes -A -o wide

创建一个 StorageClass

Milvus 使用 etcd 作为元数据存储，并需要依赖 gp3 StorageClass 来创建和管理 PVC。

cat <<EOF | kubectl apply -f -
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
  name: ebs-gp3-sc
  annotations:
    storageclass.kubernetes.io/is-default-class: "true"
provisioner: ebs.csi.aws.com
volumeBindingMode: WaitForFirstConsumer
parameters:
  type: gp3
EOF

将原始的 gp2 StorageClass 设置为非默认。

kubectl patch storageclass gp2 -p '{"metadata": {"annotations":{"storageclass.kubernetes.io/is-default-class":"false"}}}'

安装 AWS LoadBalancer Controller

添加 Helm charts 仓库。

helm repo add eks https://aws.github.io/eks-charts
helm repo update

安装 AWS Load Balancer Controller。

helm install aws-load-balancer-controller eks/aws-load-balancer-controller \
  -n kube-system \
  --set clusterName='milvus-eks-cluster' \
  --set serviceAccount.create=false \
  --set serviceAccount.name=aws-load-balancer-controller 

验证安装

kubectl get deployment -n kube-system aws-load-balancer-controller

部署 Milvus

在本指南中，我们将使用 Milvus Helm Charts 部署一个 Milvus 集群。您可以在这里找到这些 charts。

添加 Milvus Helm Chart 仓库。

helm repo add milvus https://zilliztech.github.io/milvus-helm/
helm repo update

准备 Milvus 配置文件 milvus.yaml，并将 <bucket-name> 替换为上面创建的存储桶名称。

要为您的 Milvus 配置高可用性，请参考此计算器以获取更多信息。您可以直接从计算器下载相关配置，并且应删除与 MinIO 相关的配置。
要实现协调器的多副本部署，请将 xxCoordinator.activeStandby.enabled 设置为 true。
要从互联网访问您的 Milvus，请将 service.beta.kubernetes.io/aws-load-balancer-scheme 从 internal 更改为 internet-facing。

cluster:
  enabled: true

service:
  type: LoadBalancer
  port: 19530
  annotations: 
    service.beta.kubernetes.io/aws-load-balancer-type: external
    service.beta.kubernetes.io/aws-load-balancer-name: milvus-service
    service.beta.kubernetes.io/aws-load-balancer-scheme: internal
    service.beta.kubernetes.io/aws-load-balancer-nlb-target-type: ip

serviceAccount:
  create: false
  name: milvus-s3-access-sa

minio:
  enabled: false

# 使用 milvus-s3-access-sa 访问 milvus 存储桶，而不是使用 ak/sk。  
# 详情请参阅 https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html
externalS3:
  enabled: true
  host: "s3.us-east-2.amazonaws.com"
  port: "443"
  useSSL: true
  bucketName: "<bucket-name>"
  useIAM: true
  cloudProvider: "aws"
  iamEndpoint: ""

# 高可用性配置
rootCoordinator:
  replicas: 2
  activeStandby:
    enabled: true
  resources: 
    limits:
      cpu: 1
      memory: 2Gi

indexCoordinator:
  replicas: 2
  activeStandby:
    enabled: true
  resources: 
    limits:
      cpu: "0.5"
      memory: 0.5Gi

queryCoordinator:
  replicas: 2
  activeStandby:
    enabled: true
  resources: 
    limits:
      cpu: "0.5"
      memory: 0.5Gi

dataCoordinator:
  replicas: 2
  activeStandby:
    enabled: true
  resources: 
    limits:
      cpu: "0.5"
      memory: 0.5Gi

proxy:
  replicas: 2
  resources: 
    limits:
      cpu: 1
      memory: 2Gi  

3. 安装 Milvus。

    ```shell
    helm install milvus-demo milvus/milvus -n milvus -f milvus.yaml

等待所有 pod 运行。
```
kubectl get pods -n milvus
```
Helm 不支持调度服务创建的顺序。在早期阶段，业务 pod 在 etcd 和 pulsar 启动之前重启一两次是正常的。
获取 Milvus 服务地址。
```
kubectl get svc -n milvus
```

验证安装

您可以按照以下简单指南验证安装。有关更多详细信息，请参考此示例。

下载示例代码。

shell

wget https://raw.githubusercontent.com/milvus-io/pymilvus/master/examples/hello_milvus.py

将示例代码中的 host 参数更改为上述 Milvus 服务地址。

如果您在 milvus.yaml 中将 service.beta.kubernetes.io/aws-load-balancer-scheme 设置为 internal，则应在 EKS VPC 中运行示例代码。
```
...
connections.connect("default", host="milvus-service-06b515b1ce9ad10.elb.us-east-2.amazonaws.com", port="19530")
...
```

运行示例代码。

python3 hello_milvus.py

输出应类似于以下内容：

=== 开始连接到 Milvus     ===

Milvus 中是否存在集合 hello_milvus: False

=== 创建集合 `hello_milvus` ===


=== 开始插入实体       ===

Milvus 中的实体数量: 3000

=== 开始创建 IVF_FLAT 索引  ===


=== 开始加载                  ===


=== 开始基于向量相似度搜索 ===

命中: id: 2998, 距离: 0.0, 实体: {'random': 0.9728033590489911}, 随机字段: 0.9728033590489911
命中: id: 1262, 距离: 0.08883658051490784, 实体: {'random': 0.2978858685751561}, 随机字段: 0.2978858685751561
命中: id: 1265, 距离: 0.09590047597885132, 实体: {'random': 0.3042039939240304}, 随机字段: 0.3042039939240304
命中: id: 2999, 距离: 0.0, 实体: {'random': 0.02316334456872482}, 随机字段: 0.02316334456872482
命中: id: 1580, 距离: 0.05628091096878052, 实体: {'random': 0.3855988746044062}, 随机字段: 0.3855988746044062
命中: id: 2377, 距离: 0.08096685260534286, 实体: {'random': 0.8745922204004368}, 随机字段: 0.8745922204004368
搜索延迟 = 0.4693秒

=== 开始使用 `random > 0.5` 查询 ===

查询结果:
-{'embeddings': [0.20963514, 0.39746657, 0.12019053, 0.6947492, 0.9535575, 0.5454552, 0.82360446, 0.21096309], 'pk': '0', 'random': 0.6378742006852851}
查询延迟 = 0.9407秒
查询分页(限制=4):
        [{'random': 0.6378742006852851, 'pk': '0'}, {'random': 0.5763523024650556, 'pk': '100'}, {'random': 0.9425935891639464, 'pk': '1000'}, {'random': 0.7893211256191387, 'pk': '1001'}]
查询分页(偏移=1, 限制=3):
        [{'random': 0.5763523024650556, 'pk': '100'}, {'random': 0.9425935891639464, 'pk': '1000'}, {'random': 0.7893211256191387, 'pk': '1001'}]

=== 开始使用 `random > 0.5` 混合搜索 ===

命中: id: 2998, 距离: 0.0, 实体: {'random': 0.9728033590489911}, 随机字段: 0.9728033590489911
命中: id: 747, 距离: 0.14606499671936035, 实体: {'random': 0.5648774800635661}, 随机字段: 0.5648774800635661
命中: id: 2527, 距离: 0.1530652642250061, 实体: {'random': 0.8928974315571507}, 随机字段: 0.8928974315571507

    命中: id: 2377, 距离: 0.08096685260534286, 实体: {'随机': 0.8745922204004368}, 随机字段: 0.8745922204004368
    命中: id: 2034, 距离: 0.20354536175727844, 实体: {'随机': 0.5526117606328499}, 随机字段: 0.5526117606328499
    命中: id: 958, 距离: 0.21908017992973328, 实体: {'随机': 0.6647383716417955}, 随机字段: 0.6647383716417955
    搜索延迟 = 0.4652秒

    === 开始使用表达式 `pk in ["0" , "1"]` 删除 ===

    删除前按表达式 `pk in ["0" , "1"]` 查询 -> 结果:
    -{'随机': 0.6378742006852851, '嵌入': [0.20963514, 0.39746657, 0.12019053, 0.6947492, 0.9535575, 0.5454552, 0.82360446, 0.21096309], 'pk': '0'}
    -{'随机': 0.43925103574669633, '嵌入': [0.52323616, 0.8035404, 0.77824664, 0.80369574, 0.4914803, 0.8265614, 0.6145269, 0.80234545], 'pk': '1'}

    删除后按表达式 `pk in ["0" , "1"]` 查询 -> 结果: []


    === 删除集合 `hello_milvus` ===

清理工作

如果需要通过卸载 Milvus、销毁 EKS 集群以及删除 AWS S3 存储桶和相关 IAM 策略来恢复环境。

卸载 Milvus。
```
helm uninstall milvus-demo -n milvus
```

销毁 EKS 集群。

eksctl delete cluster --name milvus-eks-cluster

删除 AWS S3 存储桶和相关 IAM 策略。

请将存储桶名称和策略 ARN 替换为您自己的。

aws s3api delete-bucket --bucket milvus-bucket-039dd013c0712f085d60e21f --region us-east-2

aws iam delete-policy --policy-arn 'arn:aws:iam::12345678901:policy/MilvusS3ReadWrite'

接下来

如果您想了解如何在其他云平台部署 Milvus：

在 EKS 上部署 Milvus 集群

先决条件​

设置 AWS 资源​

创建Amazon EKS集群​

创建一个 StorageClass​

安装 AWS LoadBalancer Controller​

部署 Milvus​

验证安装​

清理工作​

接下来​

先决条件

设置 AWS 资源

创建Amazon EKS集群

创建一个 StorageClass

安装 AWS LoadBalancer Controller

部署 Milvus

验证安装

清理工作

接下来