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的設置自動化