typesense eks

typeSense-eks

一个完整的解决方案指南，用于Amazon EKS上的自托型弹性搜索数据库（弹性Kubernetes服务）

EKS群集设置指令

此REDME提供了使用setup_eks_cluster.sh脚本设置Amazon EKS（Elastic Kubernetes Service）群集的分步说明。

先决条件

• AWS CLI安装和配置了适当的凭据
• 安装了eksctl
• 安装了kubectl （确保它支持Kustomize）
• 安装了helm

步骤

1. 设置环境变量

   • 打开setup_eks_cluster.sh并更新以下变量：

     • CLUSTER_NAME ：设置所需的群集名称（例如，“示例”）
     • REGION ：设置所需的AWS区域（例如，“ US-EAST-1”）
     • ACCOUNT_ID ：用您的AWS帐户ID替换（例如，“ 12345678”）
     • VERSION ：设置Kubernetes版本（例如，“ 1.31”）

   • 节点组设置：

     • WORKER_NODE_TYPE ：工人节点的实例类型（例如，“ r6i.xlarge”）
     • WORKER_NODES ：初始节点数（例如，2）
     • WORKER_NODES_MIN ：自动化的最小节点（例如，1）
     • WORKER_NODES_MAX ：自动化的最大节点（例如，5）
     • NODE_GROUP_NAME ：节点组的名称（例如，“标准工人”）

2. 创建EKS群集

   • 集群配置包括：
     • 公共和私人子网的VPC
     • 托管节点组
     • 集群插件（Coredns，Kube-Proxy，VPC-CNI）
     • IAM角色和政策
   • 在继续之前，请检查生成的cluster.yaml

3. 配置节点组

   • 节点组配置包括：
     • 实例类型（ WORKER_NODE_TYPE ）
     • 自动尺度设置（最小： WORKER_NODES_MIN ，最大： WORKER_NODES_MAX ）
     • 节点标签和污点
     • IAM实例配置文件
   • 节点组将作为集群部署的一部分创建

4. 助理IAM OIDC提供商

   • 此步骤将IAM OIDC提供商与您的集群相关联

5. 设置EBS CSI驱动程序

   • 为EBS CSI驱动程序创建一个IAM服务帐户
   • 创建CSI驱动程序插件

6. 设置AWS负载平衡器控制器

   • 为ALB创建IAM政策
   • 为Alb创建一个IAM服务帐户
   • 使用Helm安装AWS负载平衡器控制器

7. 验证安装

   • 脚本将搜索Alb Helm图表
   • 它还将验证AWS负载平衡器控制器是否正确安装

用法

1. 使脚本可执行：

    chmod +x setup_eks_cluster.sh
   

2. 运行脚本：

    ./setup_eks_cluster.sh
   

3. 关注输出以确保每个步骤成功完成

数据库设置

请按照以下步骤使用Kustomize部署类型：

1. 查看配置

   • 导航到application程序目录
   • 检查以下文件：
     • kustomization.yaml ：主配置文件

2. 配置typeensens设置

   • 修改kustomization.yaml中的值以匹配每个环境的所需配置

3. 设置秘密

   • 通过运行kubectl kustomize environment/development/.或kubectl kustomize environment/production/.
   • 根据您的要求验证紫外线配置

4. 部署typessense

 # Deploy to development environment
 kubectl apply -k environment/development/.
 
 # Deploy to production environment
 kubectl apply -k environment/production/.
 
 # Verify the deployment
 kubectl get pods -n your-namespace       # Check pod status
 kubectl get pvc -n your-namespace        # Verify storage provisioning
 kubectl get svc -n your-namespace        # Check service creation
 kubectl get ingress -n your-namespace    # Verify ingress configuration

5. 访问类型

   • 该服务将通过AWS负载平衡器暴露
   • 检查Ingress.yaml文件以获取端点

6. 监视

   • 检查群集健康：

     kubectl exec -it typesense-0 -n your-namespace -- curl http://localhost:8108/health

   • 查看日志：

     kubectl logs -f typesense-0 -n your-namespace

7. CI/CD管道设置

   • 存储库包括.github/workflows/aws.yml中的github操作工作流程
   • 当推动更改时，管道会自动部署Typesensens：

      name : Deploy to EKS
     
     on :
      push :
         branches : [ development, main  ]
     
     jobs :
     
       build :
     
         name : Deployment
         runs-on : ubuntu-latest
         environment : ${{ github.ref == 'refs/heads/main' && 'production' || 'development' }}
         
         steps :
     
         - name : Set short git commit SHA
            id : commit
            uses : prompt/actions-commit-hash@v2
     
         - name : Check out code
            uses : actions/checkout@v2
         
         - name : Configure AWS credentials
            uses : aws-actions/configure-aws-credentials@v1
            with :
            aws-access-key-id : ${{ secrets.AWS_ACCESS_KEY_ID }}
            aws-secret-access-key : ${{ secrets.AWS_SECRET_ACCESS_KEY }}
            aws-region : ${{ secrets.AWS_REGION }}
     
         - name : Login to Amazon ECR
            id : login-ecr
            uses : aws-actions/amazon-ecr-login@v1
     
         - name : Update kube config
            env :
            EKS_CLUSTER_NAME : ${{ secrets.EKS_CLUSTER_NAME }}
            AWS_REGION : ${{ secrets.AWS_REGION }}
            
            run : aws eks update-kubeconfig --name $EKS_CLUSTER_NAME --region $AWS_REGION
     
         - name : Deploy to EKS
            run : |
            kubectl apply -k  environments/${{ github.ref == 'refs/heads/main' && 'production' || 'development' }}/.

   必需的github秘密：

   • AWS_ACCESS_KEY_ID ：AWS IAM用户访问密钥
   • AWS_SECRET_ACCESS_KEY ：AWS IAM用户秘密密钥
   • EKS_CLUSTER_NAME ：EKS群集名称
   • AWS_REGION ：AWS地区

   管道特征：

   • 自动部署到主分支
   • 基于环境的部署（开发/生产）
   • AWS凭证管理
   • Kubernetes配置更新

   设置管道：

   1. 配置AWS IAM用户具有所需的权限
   2. 将AWS凭据添加到GitHub存储库秘密
   3. 更新工作流文件中的环境变量
   4. 在存储库中启用github操作

故障排除

• 如果任何步骤失败，请查看错误消息并确保满足所有先决条件
• 检查您的AWS凭据是否具有必要的权限
• 验证是否安装了所有必需的工具（EKSCTL，Kubectl，Helm）并最新

清理

在不再需要时删除EKS群集和相关资源：

贡献

我们欢迎捐款以改善TypeSense-eks项目！您可以做出贡献：

1. 分叉存储库

   • 创建自己的项目叉
   • 克隆到您当地的机器

2. 创建一个分支

   • 为您的功能或BugFix创建一个新分支
   • 使用描述性名称（例如， feature/add-monitoring或fix/nodegroup-scaling ）

3. 进行更改

   • 遵循现有的代码样式和约定
   • 根据需要添加或更新文档
   • 彻底测试您的更改

4. 提交拉请请求

   • 将您的更改推向叉子
   • 从您的分支到我们的主要分支机构创建拉动请求
   • 清楚地描述了变化
   • 参考任何相关问题

5. 代码审查

   • 等待维护者查看您的公关
   • 进行任何要求的更改
   • 一旦获得批准，您的公关将合并

发展指南

• 遵循基础架构 - 代码最佳实践
• 记录任何新配置选项
• 更新读书文件以进行重大更改
• 在提交之前，在单独的EKS群集中测试更改

报告问题

如果您找到错误或有功能请求：

1. 首先检查现有问题
2. 创建一个新问题：
   • 问题的清晰描述
   • 繁殖的步骤
   • 预期与实际行为
   • 您的环境详细信息

有关问题或讨论，请使用存储库的讨论部分。

未来范围

• 设置备份并为typesense还原
• 设置监视和警报类型
• typesense的设置自动化