typesense eks

Artensense-Eks

Eine vollständige Lösungshandbuch für Selbsthosting-Typsense-Suchdatenbank in Amazon EKS (Elastic Kubernetes Service)

EKS -Cluster -Setup -Anweisungen

Dieses Readme bietet Schritt-für-Schritt-Anweisungen zum Einrichten eines Amazon EKS-Cluster (Elastic Kubernetes-Dienst) mit dem Skript setup_eks_cluster.sh .

Voraussetzungen

• AWS CLI wurde mit geeigneten Anmeldeinformationen installiert und konfiguriert
• eksctl installiert
• kubectl installiert (Stellen Sie sicher, dass es Kustomize unterstützt)
• helm installiert

Schritte

1. Umgebungsvariablen festlegen

   • Öffnen Sie setup_eks_cluster.sh und aktualisieren Sie die folgenden Variablen:

     • CLUSTER_NAME : Setzen Sie Ihren gewünschten Clusternamen (z. B. "Beispiel")
     • REGION : Setzen Sie Ihre gewünschte AWS-Region (z. B. "US-East-1")
     • ACCOUNT_ID : Ersetzen Sie durch Ihre AWS -Konto -ID (z. B. "12345678").
     • VERSION : Kubernetes Version (z. B. "1.31") festlegen

   • Einstellungen für Knotengruppen:

     • WORKER_NODE_TYPE : Instanztyp für Arbeiterknoten (z. B. "r6i.xlarge")
     • WORKER_NODES : Anfangszahl der Knoten (z. B. 2)
     • WORKER_NODES_MIN : Mindestknoten für das Autoscaling (z. B. 1)
     • WORKER_NODES_MAX : Maximale Knoten für das Autoscaling (z. B. 5)
     • NODE_GROUP_NAME : Name der Knotengruppe (z. B. "Standard-Mitarbeiter")

2. Erstellen Sie EKS -Cluster

   • Die Clusterkonfiguration umfasst:
     • VPC mit öffentlichen und privaten Subnetzen
     • Verwaltete Knotengruppen
     • Cluster-Addons (Coredns, Kube-Proxy, VPC-CNI)
     • Ich bin Rollen und Richtlinien
   • Überprüfen Sie den generierten cluster.yaml vor dem fortfahren

3. Konfigurieren von Knotengruppen

   • Die Knotengruppenkonfiguration umfasst:
     • Instanztyp ( WORKER_NODE_TYPE )
     • Einstellungen zur automatischen Skalierung (min: WORKER_NODES_MIN , max: WORKER_NODES_MAX )
     • Knotenbezeichnungen und Mächte
     • IAM Instance -Profil
   • Die Knotengruppe wird als Teil der Cluster -Bereitstellung erstellt

4. Associate IAM OIDC -Anbieter

   • Dieser Schritt assoziiert einen IAM OIDC -Anbieter mit Ihrem Cluster

5. Richten Sie den EBS -CSI -Treiber ein

   • Erstellt ein IAM -Servicekonto für den EBS -CSI -Treiber
   • Erstellt das CSI -Treiber -Addon

6. Richten Sie den AWS -Last -Balancer -Controller ein

   • Schafft eine IAM -Politik für den ALB
   • Erstellt ein IAM -Servicekonto für den ALB
   • Installiert den AWS -Last -Balancer -Controller mit Helm

7. Überprüfen Sie die Installation

   • Das Skript sucht nach dem Alb -Helm -Diagramm
   • Es wird auch überprüfen

Verwendung

1. Machen Sie das Skript ausführbar:

    chmod +x setup_eks_cluster.sh
   

2. Führen Sie das Skript aus:

    ./setup_eks_cluster.sh
   

3. Befolgen Sie die Ausgabe, um sicherzustellen, dass jeder Schritt erfolgreich abgeschlossen ist

Datenbank -Setup

Befolgen Sie diese Schritte, um Artensex mit Kustomize bereitzustellen:

1. Überprüfung der Konfiguration

   • Navigieren Sie zum application
   • Überprüfen Sie die folgenden Dateien:
     • kustomization.yaml : Hauptkonfigurationsdatei

2. Konfigurieren Sie die Artensense -Einstellungen

   • Ändern Sie die Werte in der Kustomisierung.yaml so, dass sie Ihrer gewünschten Konfiguration für jede Umgebung entspricht

3. Geheimnisse einrichten

   • Überprüfen Sie die aktualisierten YAML -Dateien, indem Sie kubectl kustomize environment/development/. oder kubectl kustomize environment/production/.
   • Überprüfen Sie die uDPated YAML -Konfiguration gemäß Ihren Anforderungen

4. Artensexposition einsetzen

 # 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. Zugriffsarten

   • Der Service wird über AWS Last Balancer freigelegt
   • Überprüfen Sie die Datei "Ingress.yaml", um den Endpunkt zu erhalten

6. Überwachung

   • Überprüfen Sie die Clustergesundheit:

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

   • Protokolle anzeigen:

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

7. CI/CD -Pipeline -Setup

   • Das Repository enthält einen Workflow in .github/workflows/aws.yml
   • Die Pipeline setzt Artensense automatisch bereit, wenn Änderungen vorangetrieben werden:

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

   Erforderliche Github -Geheimnisse:

   • AWS_ACCESS_KEY_ID : AWS IAM -Benutzerzugriffstaste
   • AWS_SECRET_ACCESS_KEY : AWS IAM User Secret Key
   • EKS_CLUSTER_NAME : eks cluster name
   • AWS_REGION : AWS -Region

   Pipeline -Funktionen:

   • Automatische Bereitstellung beim Push to Main Branch
   • Umweltbasierte Bereitstellung (Entwicklung/Produktion)
   • AWS -Anmeldeinformationen Management
   • Kubernetes -Konfigurationsaktualisierungen

   Um die Pipeline einzurichten:

   1. Konfigurieren Sie AWS IAM -Benutzer mit den erforderlichen Berechtigungen
   2. Fügen Sie AWS -Anmeldeinformationen zu Github -Repository -Geheimnissen hinzu
   3. Aktualisieren Sie die Umgebungsvariablen in Workflow -Datei
   4. Aktivieren Sie GitHub -Aktionen in Ihrem Repository

Fehlerbehebung

• Wenn ein Schritt fehlschlägt, überprüfen Sie die Fehlermeldungen und stellen Sie sicher, dass alle Voraussetzungen erfüllt sind
• Überprüfen Sie, ob Ihre AWS -Anmeldeinformationen über die erforderlichen Berechtigungen verfügen
• Stellen Sie sicher, dass alle erforderlichen Tools (EKSCTL, Kubectl, Helm) installiert und aktuell sind

Aufräumen

So löschen Sie den EKS -Cluster und die zugehörigen Ressourcen, wenn Sie nicht mehr benötigt werden:

Beitragen

Wir begrüßen Beiträge zur Verbesserung des Artensense-Eks-Projekts! So können Sie dazu beitragen:

1. Geben Sie das Repository auf

   • Erstellen Sie Ihre eigene Gabel des Projekts
   • Klonen Sie es auf Ihre lokale Maschine

2. Erstellen Sie einen Zweig

   • Erstellen Sie eine neue Filiale für Ihre Funktion oder Ihr Bugfix
   • Verwenden Sie einen deskriptiven Namens (z. B. feature/add-monitoring oder fix/nodegroup-scaling ).

3. Nehmen Sie Ihre Änderungen vor

   • Befolgen Sie den vorhandenen Codestil und Konventionen
   • Dokumentation nach Bedarf hinzufügen oder aktualisieren
   • Testen Sie Ihre Änderungen gründlich

4. Senden Sie eine Pull -Anfrage

   • Drücken Sie Ihre Änderungen in Ihre Gabel
   • Erstellen Sie eine Pull -Anfrage von Ihrem Zweig zu unserer Hauptzweig
   • Geben Sie eine klare Beschreibung der Änderungen an
   • Verweisen Sie alle verwandten Probleme

5. Code Review

   • Warten Sie, bis die Betreuer Ihre PR überprüft
   • Fakten Sie angeforderte Änderungen vor
   • Nach der Genehmigung wird Ihre PR zusammengeführt

Entwicklungsrichtlinien

• Befolgen Sie die Best Practices der Infrastruktur-As-Code
• Dokumentieren Sie alle neuen Konfigurationsoptionen
• Aktualisieren Sie die Readme für signifikante Änderungen
• Testenänderungen in einem separaten EKS -Cluster vor dem Senden

Meldungsprobleme

Wenn Sie einen Fehler finden oder eine Funktionsanforderung haben:

1. Überprüfen Sie zuerst bestehende Probleme
2. Erstellen Sie ein neues Problem mit:
   • Klare Beschreibung des Problems
   • Schritte zum Fortpflanzung
   • Erwartet gegen tatsächliches Verhalten
   • Ihre Umgebungsdetails

Für Fragen oder Diskussionen verwenden Sie bitte den Abschnitt "Diskussionen des Repositorys".

Zukünftiger Umfang

• Backup einrichten und für ArtenSense wiederherstellen
• Einrichten der Überwachung und Alarmierung von ArtenSense
• Setup -Autoscaling für ArtenSense