typesense eks

eks de tipos

Una guía de solución completa para la base de datos de búsqueda elástica de los tipos de autohospense en Amazon EKS (servicio elástico de Kubernetes)

Instrucciones de configuración del clúster EKS

Este ReadMe proporciona instrucciones paso a paso para configurar un clúster de Amazon EKS (elastic Kubernetes) utilizando el script setup_eks_cluster.sh .

Requisitos previos

• AWS CLI instalada y configurada con credenciales apropiadas
• eksctl instalado
• kubectl instalado (asegúrese de que admite kustomize)
• helm instalado

Pasos

1. Establecer variables de entorno

   • Abra setup_eks_cluster.sh y actualice las siguientes variables:

     • CLUSTER_NAME : establezca el nombre de su clúster deseado (por ejemplo, "muestra")
     • REGION : Establezca la región de AWS deseada (por ejemplo, "US-East-1")
     • ACCOUNT_ID : reemplace con su ID de cuenta de AWS (por ejemplo, "12345678")
     • VERSION : Establezca la versión de Kubernetes (por ejemplo, "1.31")

   • Configuración del grupo de nodo:

     • WORKER_NODE_TYPE : tipo de instancia para nodos de trabajadores (por ejemplo, "R6i.xlarge")
     • WORKER_NODES : número inicial de nodos (por ejemplo, 2)
     • WORKER_NODES_MIN : nodos mínimos para autoscalización (por ejemplo, 1)
     • WORKER_NODES_MAX : nodos máximos para autoscalización (por ejemplo, 5)
     • NODE_GROUP_NAME : nombre del grupo de nodo (por ejemplo, "trabajadores estándar")

2. Crear clúster EKS

   • La configuración del clúster incluye:
     • VPC con subredes públicas y privadas
     • Grupos de nodos administrados
     • Complementos de clúster (Coredns, Kube-Proxy, VPC-CNI)
     • Roles y políticas de IAM
   • Revise el cluster.yaml generado.yaml antes de continuar

3. Configurar grupos de nodos

   • La configuración del grupo de nodos incluye:
     • Tipo de instancia ( WORKER_NODE_TYPE )
     • Configuración de escala automática (min: WORKER_NODES_MIN , max: WORKER_NODES_MAX )
     • Etiquetas y manchas de nodos
     • Perfil de instancia de IAM
   • El grupo de nodo se creará como parte de la implementación del clúster

4. Proveedor asociado de IAM OIDC

   • Este paso asocia a un proveedor de IAM OIDC con su clúster

5. Configurar controlador EBS CSI

   • Crea una cuenta de servicio IAM para el controlador EBS CSI
   • Crea el complemento del controlador CSI

6. Configurar el controlador de equilibrio de carga de AWS

   • Crea una política de IAM para el ALB
   • Crea una cuenta de servicio IAM para el ALB
   • Instala el controlador de equilibrio de carga de AWS con timón

7. Verificar la instalación

   • El script buscará la tabla de timón de Alb
   • También verificará que el controlador de equilibrio de carga de AWS esté instalado correctamente

Uso

1. Hacer que el script sea ejecutable:

    chmod +x setup_eks_cluster.sh
   

2. Ejecute el guión:

    ./setup_eks_cluster.sh
   

3. Siga la salida para garantizar que cada paso se complete con éxito

Configuración de la base de datos

Siga estos pasos para implementar Typesense usando Kustomize:

1. Revisar la configuración

   • Navegue al directorio application
   • Verifique los siguientes archivos:
     • kustomization.yaml : archivo de configuración principal

2. Configurar configuraciones de tipos de tipos

   • Modifique los valores en kustomization.yaml para que coincida con la configuración deseada para cada entorno

3. Configurar secretos

   • Verifique los archivos YAML actualizados ejecutando kubectl kustomize environment/development/. o kubectl kustomize environment/production/.
   • Verifique la configuración de YAML UDPATIONS según sus requisitos

4. Implementar 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. Acceso a los tipos

   • El servicio se expondrá a través de AWS Load Balancer
   • Verifique el archivo Ingress.yaml para obtener el punto final

6. Escucha

   • Verifique la salud del clúster:

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

   • Ver registros:

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

7. Configuración de tuberías de CI/CD

   • El repositorio incluye un flujo de trabajo de GitHub Actions en .github/workflows/aws.yml
   • La tubería implementa automáticamente TypeSense cuando se presionan los cambios:

      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' }}/.

   Secretos de GitHub requeridos:

   • AWS_ACCESS_KEY_ID : clave de acceso de usuario de AWS IAM
   • AWS_SECRET_ACCESS_KEY : clave de secreto del usuario de AWS IAM
   • EKS_CLUSTER_NAME : nombre de clúster eks
   • AWS_REGION : región de AWS

   Características de la tubería:

   • Implementación automática en empuje a la rama principal
   • Implementación basada en el medio ambiente (desarrollo/producción)
   • Gestión de credenciales de AWS
   • Actualizaciones de configuración de Kubernetes

   Para configurar la tubería:

   1. Configurar el usuario de AWS IAM con permisos requeridos
   2. Agregar credenciales de AWS a los secretos del repositorio de GitHub
   3. Actualizar variables de entorno en el archivo de flujo de trabajo
   4. Habilite las acciones de GitHub en su repositorio

Solución de problemas

• Si falla algún paso, revise los mensajes de error y asegúrese de que se cumplan todos los requisitos previos
• Verifique que sus credenciales de AWS tengan los permisos necesarios
• Verifique que todas las herramientas requeridas (EKSCTL, Kubectl, Helm) estén instaladas y actualizadas

Limpiar

Para eliminar el clúster EKS y los recursos asociados cuando ya no se necesita:

Que contribuye

¡Agradecemos contribuciones para mejorar el proyecto Typesense-Eks! Así es como puedes contribuir:

1. Bifurca el repositorio

   • Crea tu propio bifurcado del proyecto
   • Clonarlo a su máquina local

2. Crear una rama

   • Cree una nueva rama para su característica o interrupción de errores
   • Use un nombre descriptivo (por ejemplo, feature/add-monitoring o fix/nodegroup-scaling )

3. Haz tus cambios

   • Siga el estilo de código y las convenciones existentes
   • Agregar o actualizar la documentación según sea necesario
   • Pon a prueba tus cambios a fondo

4. Envíe una solicitud de extracción

   • Empuja tus cambios a tu bifurcación
   • Cree una solicitud de extracción de su rama a nuestra rama principal
   • Proporcionar una descripción clara de los cambios
   • Referencia a cualquier problema relacionado

5. Revisión del código

   • Espere a que los mantenedores revisen sus relaciones públicas
   • Hacer cualquier cambio solicitado
   • Una vez aprobado, su PR se fusionará

Pautas de desarrollo

• Siga las mejores prácticas de infraestructura como código
• Documente cualquier opción de configuración nueva
• Actualizar el ReadMe para cambios significativos
• Prueba los cambios en un clúster EKS separado antes de enviar

Problemas de informes

Si encuentra un error o tiene una solicitud de función:

1. Verifique los problemas existentes primero
2. Crea un nuevo problema con:
   • Descripción clara del problema
   • Pasos para reproducir
   • Comportamiento real esperado frente a
   • Sus detalles del entorno

Para preguntas o discusiones, utilice la sección de discusiones del repositorio.

Alcance futuro

• Configuración de copia de seguridad y restauración para TypeenSen
• Configuración de monitoreo y alerta para TypesenSen
• Configuración de autoscalado para typesense