typesense eks

Typeensense-Ks

Amazon EKS의 자체 호스팅 타입에 대한 완전한 솔루션 가이드 (Elastic Kubernetes Service)

EKS 클러스터 설정 지침

이 readme는 setup_eks_cluster.sh 스크립트를 사용하여 Amazon EK (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 : Set 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 )
     • 자동 스케일링 설정 (Min : WORKER_NODES_MIN , Max : 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를 사용하여 Typeense를 배포하십시오.

1. 구성을 검토하십시오

   • application 디렉토리로 이동하십시오
   • 다음 파일을 확인하십시오.
     • kustomization.yaml : 기본 구성 파일

2. Typeense 설정을 구성하십시오

   • 각 환경에 대한 원하는 구성에 맞게 kustomization.yaml의 값을 수정하십시오.

3. 비밀을 설정하십시오

   • 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. 액세스 유형

   • 이 서비스는 AWS로드 밸런서를 통해 노출됩니다
   • Endress.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 Actions Workflow가 포함되어 있습니다
   • 파이프 라인은 변경 사항을 푸시하면 타입을 자동으로 배포합니다.

      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. GitHub 리포지토리 비밀에 AWS 자격 증명을 추가하십시오
   3. 워크 플로 파일의 환경 변수를 업데이트합니다
   4. 저장소에서 GitHub 작업을 활성화하십시오

문제 해결

• 단계가 실패하면 오류 메시지를 검토하고 모든 전제 조건이 충족되도록하십시오.
• AWS 자격 증명에 필요한 권한이 있는지 확인하십시오
• 필요한 모든 도구 (EKSCTL, Kubectl, Helm)가 설치되어 최신 상태인지 확인하십시오.

정리

더 이상 필요하지 않은 경우 EKS 클러스터 및 관련 리소스를 삭제하려면 :

기여

Typesense-EKS 프로젝트를 개선하기위한 기여를 환영합니다! 기여하는 방법은 다음과 같습니다.

1. 저장소를 포크하십시오

   • 프로젝트 포크를 만듭니다
   • 로컬 기계에 복제하십시오

2. 지점을 만듭니다

   • 기능 또는 버그 문제에 대한 새 지점을 만듭니다
   • 설명 이름을 사용하십시오 (예 : feature/add-monitoring 또는 fix/nodegroup-scaling )

3. 변경하십시오

   • 기존 코드 스타일과 컨벤션을 따르십시오
   • 필요에 따라 문서를 추가하거나 업데이트하십시오
   • 변경 사항을 철저히 테스트하십시오

4. 풀 요청을 제출하십시오

   • 변경 사항을 포크로 밀어 넣으십시오
   • 지점에서 메인 브랜치로의 풀 요청 생성
   • 변경 사항에 대한 명확한 설명을 제공하십시오
   • 관련 문제를 참조하십시오

5. 코드 검토

   • 관리자가 PR을 검토 할 때까지 기다립니다
   • 요청 된 변경 사항을 작성하십시오
   • 승인되면 PR이 합병됩니다

개발 지침

• 코드로 인프라 모범 사례를 따르십시오
• 새로운 구성 옵션을 문서화하십시오
• 중대한 변경 사항을 위해 readme를 업데이트하십시오
• 제출하기 전에 별도의 EKS 클러스터의 변경 사항을 테스트합니다

보고 문제

버그를 찾거나 기능 요청이있는 경우 :

1. 기존 문제를 먼저 확인하십시오
2. 다음과 관련하여 새로운 문제를 만듭니다.
   • 문제에 대한 명확한 설명
   • 재현하기위한 단계
   • 예상 대 실제 행동
   • 환경 세부 사항

질문이나 토론은 저장소의 토론 섹션을 사용하십시오.

미래의 범위

• 유형을 위해 백업 및 복원
• 유형에 대한 모니터링 및 경고
• Typeense 용 자동 설정