typesense eks

Evitos aidas

Um guia de solução completa para o banco de dados de busca elástico de manifestação auto-hospedagem no Amazon EKS (Elastic Kubernetes Service)

Instruções de configuração de cluster eks

Este ReadMe fornece instruções passo a passo para configurar um cluster Amazon EKS (Elastic Kubernetes Service) usando o script setup_eks_cluster.sh .

Pré -requisitos

• A AWS CLI instalou e configurada com credenciais apropriadas
• eksctl instalado
• kubectl instalado (verifique se ele suporta Kustomize)
• helm instalado

Passos

1. Defina variáveis ​​de ambiente

   • Abra setup_eks_cluster.sh e atualize as seguintes variáveis:

     • CLUSTER_NAME : defina o nome do cluster desejado (por exemplo, "amostra")
     • REGION : Defina a região da AWS desejada (por exemplo, "US-leste-1")
     • ACCOUNT_ID : Substitua pelo seu ID da conta AWS (por exemplo, "12345678")
     • VERSION : defina a versão Kubernetes (por exemplo, "1.31")

   • Configurações do grupo de nó:

     • WORKER_NODE_TYPE : tipo de instância para nós do trabalhador (por exemplo, "r6i.xlarge")
     • WORKER_NODES : número inicial de nós (por exemplo, 2)
     • WORKER_NODES_MIN : nós mínimos para autoscaling (por exemplo, 1)
     • WORKER_NODES_MAX : nós máximos para autoscaling (por exemplo, 5)
     • NODE_GROUP_NAME : Nome do Grupo de Nó (por exemplo, "Standard Workers")

2. Crie cluster EKS

   • A configuração do cluster inclui:
     • VPC com sub -redes públicas e privadas
     • Grupos de nós gerenciados
     • Addons de cluster (COREDNS, KUBE-PROXY, VPC-CNI)
     • Papéis e políticas do IAM
   • Revise o cluster.yaml gerado.yaml antes de prosseguir

3. Configure grupos de nó

   • A configuração do grupo de nó inclui:
     • Tipo de instância ( WORKER_NODE_TYPE )
     • Configurações de escala automática (min: WORKER_NODES_MIN , max: WORKER_NODES_MAX )
     • Etiquetas e contas de nós
     • Perfil da instância do IAM
   • O grupo de nós será criado como parte da implantação de cluster

4. Provedor associado do IAM OIDC

   • Esta etapa associa um provedor Iam OIDC ao seu cluster

5. Configure o driver EBS CSI

   • Cria uma conta de serviço IAM para o driver EBS CSI
   • Cria o addon do driver CSI

6. Configurar controlador de balanceador de carga da AWS

   • Cria uma política de iam para o alb
   • Cria uma conta de serviço IAM para o alb
   • Instala o controlador de balanceador de carga da AWS usando o comando

7. Verifique a instalação

   • O script procurará o gráfico de alm aula
   • Ele também verificará se o controlador de balanceador de carga da AWS está instalado corretamente

Uso

1. Faça o script executável:

    chmod +x setup_eks_cluster.sh
   

2. Execute o script:

    ./setup_eks_cluster.sh
   

3. Siga a saída para garantir que cada etapa seja concluída com êxito

Configuração do banco de dados

Siga estas etapas para implantar o TyeSense usando Kustomize:

1. Revise a configuração

   • Navegue até o diretório application
   • Verifique os seguintes arquivos:
     • kustomization.yaml : arquivo de configuração principal

2. Configurar configurações de digitação

   • modifique os valores em kustomization.yaml para corresponder à configuração desejada para cada ambiente

3. Configure segredos

   • Verifique os arquivos YAML atualizados executando kubectl kustomize environment/development/. ou kubectl kustomize environment/production/.
   • Verifique a configuração do YAML udpated conforme seus requisitos

4. Implante de times

 # 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. Acesso a entender

   • O serviço será exposto via balanceador de carga da AWS
   • Verifique o arquivo Ingress.yaml para obter o terminal

6. Monitoramento

   • Verifique a saúde do cluster:

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

   • Ver logs:

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

7. Configuração do pipeline CI/CD

   • O repositório inclui um fluxo de trabalho de ações do github em .github/workflows/aws.yml
   • O pipeline implanta automaticamente o Tysense quando as alterações são pressionadas:

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

   Segredos do Github exigidos:

   • AWS_ACCESS_KEY_ID : AWS IAM ACESSO DO ACESSO DA CHAVE
   • AWS_SECRET_ACCESS_KEY : AWS IAM User Secret Key
   • EKS_CLUSTER_NAME : Nome do cluster EKS
   • AWS_REGION : região da AWS

   Recursos de pipeline:

   • Implantação automática no Push to Main Branch
   • Implantação baseada no meio ambiente (desenvolvimento/produção)
   • Gerenciamento de credenciais da AWS
   • Atualizações de configuração do Kubernetes

   Para configurar o pipeline:

   1. Configure o usuário do AWS IAM com as permissões necessárias
   2. Adicionar credenciais da AWS aos segredos do repositório do GitHub
   3. Atualizar variáveis ​​de ambiente no arquivo de fluxo de trabalho
   4. Ativar ações do GitHub em seu repositório

Solução de problemas

• Se alguma etapa falhar, revise as mensagens de erro e verifique se todos os pré -requisitos forem atendidos
• Verifique se suas credenciais da AWS têm as permissões necessárias
• Verifique se todas as ferramentas necessárias (EKSCTL, KUBECTL, HELM) estão instaladas e atualizadas

Limpar

Para excluir o cluster EKS e os recursos associados quando não é mais necessário:

Contribuindo

Congratulamo-nos com contribuições para melhorar o projeto ET-EKS! Veja como você pode contribuir:

1. Fork o repositório

   • Crie seu próprio garfo do projeto
   • Clone -o para sua máquina local

2. Crie uma filial

   • Crie uma nova filial para seu recurso ou bugfix
   • Use um nome descritivo (por exemplo, feature/add-monitoring ou fix/nodegroup-scaling )

3. Faça suas alterações

   • Siga o estilo de código e convenções existentes
   • Adicione ou atualize a documentação conforme necessário
   • Teste suas mudanças completamente

4. Envie um pedido de tração

   • Empurre suas alterações no seu garfo
   • Crie uma solicitação de tração do seu ramo para o nosso ramo principal
   • Forneça uma descrição clara das mudanças
   • Referenciar quaisquer problemas relacionados

5. Revisão do código

   • Aguarde os mantenedores para revisar seu PR
   • Fazer qualquer alteração solicitada
   • Uma vez aprovado, seu PR será mesclado

Diretrizes de desenvolvimento

• Siga as práticas recomendadas da infraestrutura como código
• Documente quaisquer novas opções de configuração
• Atualize o ReadMe para mudanças significativas
• Alterações no teste em um cluster EKS separado antes de enviar

Relatando problemas

Se você encontrar um bug ou tiver uma solicitação de recurso:

1. Verifique os problemas existentes primeiro
2. Crie um novo problema com:
   • Descrição clara do problema
   • Etapas para reproduzir
   • Comportamento esperado vs real
   • Seus detalhes do seu ambiente

Para perguntas ou discussões, use a seção de discussões do repositório.

Escopo futuro

• Configure backup e restauração para o tempos
• Monitoramento e alerta de configuração para TypeShe
• Configure automaticamente o TyeShe