typesense eks

EKSSENSES

คู่มือโซลูชันที่สมบูรณ์สำหรับฐานข้อมูลการค้นหาแบบยืดหยุ่นแบบโฮสต์ตัวเองบน Amazon EKS (บริการ Elastic Kubernetes)

คำแนะนำการตั้งค่าคลัสเตอร์ EKS

readme นี้ให้คำแนะนำทีละขั้นตอนสำหรับการตั้งค่าคลัสเตอร์ Amazon EKS (Elastic Kubernetes) โดยใช้สคริปต์ setup_eks_cluster.sh

ข้อกำหนดเบื้องต้น

• AWS CLI ติดตั้งและกำหนดค่าด้วยข้อมูลรับรองที่เหมาะสม
• ติดตั้ง eksctl
• ติดตั้ง kubectl (ตรวจสอบให้แน่ใจว่ารองรับ kustomize)
• ติดตั้ง helm

ขั้นตอน

1. ตั้งค่าตัวแปรสภาพแวดล้อม

   • เปิด setup_eks_cluster.sh และอัปเดตตัวแปรต่อไปนี้:

     • CLUSTER_NAME : ตั้งชื่อคลัสเตอร์ที่คุณต้องการ (เช่น "ตัวอย่าง")
     • REGION : ตั้งค่าภูมิภาค AWS ที่คุณต้องการ (เช่น "US-East-1"))
     • ACCOUNT_ID : แทนที่ด้วยรหัสบัญชี AWS ของคุณ (เช่น "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 , Max: WORKER_NODES_MAX )
     • ฉลากโหนดและ taints
     • โปรไฟล์ IAM อินสแตนซ์
   • กลุ่มโหนดจะถูกสร้างขึ้นเป็นส่วนหนึ่งของการปรับใช้คลัสเตอร์

4. รองผู้ให้บริการ IAM OIDC

   • ขั้นตอนนี้เชื่อมโยงผู้ให้บริการ IAM OIDC กับคลัสเตอร์ของคุณ

5. ตั้งค่าไดรเวอร์ EBS CSI

   • สร้างบัญชีบริการ IAM สำหรับไดรเวอร์ EBS CSI
   • สร้างส่วนเสริมไดรเวอร์ CSI

6. ตั้งค่าคอนโทรลเลอร์ Load Balancer AWS

   • สร้างนโยบาย IAM สำหรับ ALB
   • สร้างบัญชีบริการ IAM สำหรับ ALB
   • ติดตั้งคอนโทรลเลอร์ AWS Load Balancer โดยใช้ Helm

7. ตรวจสอบการติดตั้ง

   • สคริปต์จะค้นหาแผนภูมิ ALB Helm
   • นอกจากนี้ยังจะตรวจสอบว่าตัวควบคุม Load Balancer AWS ได้รับการติดตั้งอย่างถูกต้อง

การใช้งาน

1. ทำให้สคริปต์ดำเนินการได้:

    chmod +x setup_eks_cluster.sh
   

2. เรียกใช้สคริปต์:

    ./setup_eks_cluster.sh
   

3. ทำตามผลลัพธ์เพื่อให้แน่ใจว่าแต่ละขั้นตอนจะเสร็จสมบูรณ์

การตั้งค่าฐานข้อมูล

ทำตามขั้นตอนเหล่านี้เพื่อปรับใช้ typesense โดยใช้ kustomize:

1. ตรวจสอบการกำหนดค่า

   • นำทางไปยังไดเรกทอรี application
   • ตรวจสอบไฟล์ต่อไปนี้:
     • kustomization.yaml : ไฟล์การกำหนดค่าหลัก

2. กำหนดค่าการตั้งค่า typesense

   • ปรับเปลี่ยนค่าใน kustomization.yaml เพื่อให้ตรงกับการกำหนดค่าที่คุณต้องการสำหรับแต่ละสภาพแวดล้อม

3. ตั้งค่าความลับ

   • ตรวจสอบไฟล์ YAML ที่อัปเดตโดยเรียกใช้ kubectl kustomize environment/development/. หรือ kubectl kustomize environment/production/.
   • ตรวจสอบการกำหนดค่า udpated yaml ตามความต้องการของคุณ

4. ปรับใช้ typesense

 # 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. Typesense Access

   • บริการจะถูกเปิดเผยผ่าน AWS Load Balancer
   • ตรวจสอบไฟล์ 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 Workflow ใน .github/workflows/aws.yml
   • ไปป์ไลน์จะปรับใช้ typesense โดยอัตโนมัติเมื่อมีการเปลี่ยนแปลงการเปลี่ยนแปลง:

      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 ACCESS ACCESS
   • AWS_SECRET_ACCESS_KEY : AWS IAM SECRETIN SECRETION
   • 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. สร้างสาขา

   • สร้างสาขาใหม่สำหรับคุณสมบัติหรือ Fix ของคุณ
   • ใช้ชื่อเชิงพรรณนา (เช่น feature/add-monitoring หรือ fix/nodegroup-scaling )

3. ทำการเปลี่ยนแปลงของคุณ

   • ทำตามรูปแบบรหัสและการประชุมที่มีอยู่
   • เพิ่มหรืออัปเดตเอกสารตามต้องการ
   • ทดสอบการเปลี่ยนแปลงของคุณอย่างละเอียด

4. ส่งคำขอดึง

   • ผลักดันการเปลี่ยนแปลงของคุณไปยังส้อมของคุณ
   • สร้างคำขอดึงจากสาขาของคุณไปยังสาขาหลักของเรา
   • ให้คำอธิบายที่ชัดเจนของการเปลี่ยนแปลง
   • อ้างอิงปัญหาที่เกี่ยวข้องใด ๆ

5. รีวิวรหัส

   • รอให้ผู้ดูแลตรวจสอบการประชาสัมพันธ์ของคุณ
   • ทำการเปลี่ยนแปลงใด ๆ ที่ร้องขอ
   • เมื่อได้รับอนุมัติแล้ว PR ของคุณจะถูกรวมเข้าด้วยกัน

แนวทางการพัฒนา

• ปฏิบัติตามแนวทางปฏิบัติที่ดีที่สุด
• จัดทำเอกสารตัวเลือกการกำหนดค่าใหม่
• อัปเดต readMe สำหรับการเปลี่ยนแปลงที่สำคัญ
• ทดสอบการเปลี่ยนแปลงในคลัสเตอร์ EKS แยกต่างหากก่อนส่ง

ปัญหาการรายงาน

หากคุณพบข้อผิดพลาดหรือมีคำขอคุณสมบัติ:

1. ตรวจสอบปัญหาที่มีอยู่ก่อน
2. สร้างปัญหาใหม่ด้วย:
   • คำอธิบายที่ชัดเจนของปัญหา
   • ขั้นตอนในการทำซ้ำ
   • พฤติกรรมที่คาดหวังเทียบกับพฤติกรรมจริง
   • รายละเอียดสภาพแวดล้อมของคุณ

สำหรับคำถามหรือการอภิปรายโปรดใช้ส่วนการอภิปรายของที่เก็บ

ขอบเขตในอนาคต

• ตั้งค่าการสำรองและกู้คืนสำหรับ typeSense
• การตรวจสอบการตั้งค่าและการแจ้งเตือนสำหรับ typesense
• การตั้งค่าการปรับสภาพอัตโนมัติสำหรับ typeSense