Datenprodukt-Portal-Integrationen 2: Helm

Wenn Sie es verpasst haben, sollten Sie unseren ersten Blogbeitrag über Wie man sich mit OIDC integriert überprüfen.

In diesem Beitrag konzentrieren wir uns auf die Installation des Portals in Produktionsumgebungen. Zwar ist es möglich, eine produktionsbereite Bereitstellung mit unseren Docker-Images zu erstellen, aber der einfachste Weg ist die Verwendung von Helm auf einem bestehenden Kubernetes-Cluster. Mit unserem Helm-Chart können Sie innerhalb kürzester Zeit einsatzbereit sein.

In diesem Blogbeitrag gehen wir die spezifischen Konfigurationswerte in unserem Helm-Chart durch, was sie sind und wie sie verwendet werden sollten.

Was ist Helm?

Helm hilft Ihnen bei der Verwaltung von Kubernetes-Anwendungen – Helm-Charts helfen Ihnen, selbst die komplexesten Kubernetes-Anwendungen zu definieren, zu installieren und zu aktualisieren.

Wir bieten ein Helm-Chart, das alle notwendigen Komponenten in Ihrem Kubernetes-Cluster einrichtet, um nahtlos mit allem zu interagieren, was bereits vorhanden ist.

Die Werte-Datei

Helm-Konfigurationen können durch Konfigurationswerte an Ihre individuellen Bedürfnisse angepasst werden. Sie können diese Werte direkt an Ihre helm install-Befehle übergeben, aber bewährte Praktiken empfehlen, sie stattdessen in einer values.yaml-Datei zu speichern. Diese Datei finden Sie in unserem Code-Repository hier.

Die values.yaml-Datei des Portals hat zwei große Abschnitte.

• Konfigurationswerte, die Sie unbedingt ändern müssen.

• Optional konfigurierbare Werte.

Pflichtkonfigurationswerte

Diese Werte müssen aktualisiert werden, um Ihrer spezifischen Umgebung zu entsprechen. Wenn Sie ein helm install ausführen, ohne diese Werte anzupassen, riskieren Sie die Bereitstellung einer unsicheren Version des Portals mit Standarddatenbankpasswörtern und schlecht konfigurierten CNAMEs.

OIDC

Diese Konfiguration richtet die OIDC-Integration ein. Für detailliertere Informationen zur Einrichtung davon, verweisen Sie auf unseren früheren Blogbeitrag.

oidc:  disabled: false  client_id: id  client_secret: secret  authority: authority  redirect_uri: host

PostgreSQL

Das Helm-Chart unterstützt standardmäßig dieses PostgreSQL-Abhängigkeits-Chart. Wenn postgres_enabled: true, wird die Helm-Installation auch eine PostgreSQL-Datenbank in Ihrem Kubernetes-Cluster einrichten. Die Werte unter global sind die Konfigurationswerte für diese Datenbank.

Bitte beachten Sie, dass wir port als expliziten String übergeben, um zu verhindern, dass das Helm-Chart falsches Casting durchführt.
Wenn postgres_enabled: false, werden alle anderen Werte ignoriert.

postgres_enabled: falseglobal:  postgresql:    auth:      password: pw      database: data-product-portal      port: "!!string 5432"      server: data-product-portal-postgresql      username: postgres

Datenbank

Diese Konfiguration gibt an, wie das Portal mit der Datenbank verbunden wird. Wenn postgres_enabled: true, verwenden Sie die gleichen Werte wie oben. Wenn postgres_enabled: false, können dies beliebige Werte sein, die erforderlich sind, um eine Verbindung zu Ihrer Datenbank herzustellen (z.B. RDS-Endpunkte).

database:  password: pw  dbname: data-product-portal  port: "!!string 5432"  server: data-product-portal-postgresql  username: postgres

API-Schlüssel

Wenn enabled: true, können Sie den Wert von key als API-Schlüssel im x-key-Headerfeld verwenden, um Ihre API-Anfragen zu authentifizieren.

api_key:  enabled: false  key: "example"

Conveyor

Wenn Sie eine Conveyor-Installation verfügbar haben und diese mit dem Portal verknüpfen möchten, geben Sie hier den korrekten API-Schlüssel und das Geheimnis an. Wenn es nicht korrekt konfiguriert ist, wird es ignoriert.

conveyor:  api_key: conveyor_key  secret: conveyor_secret

Host

Dieser Wert sollte der CNAME Ihrer Portal-Anwendung ohne abschließendem Schrägstrich sein. Zum Beispiel https://www.portal.com.

host: pleaseupdateme

Cloudwatch

Portal kann automatisch in AWS Cloudwatch Logs protokollieren, wenn Ihre Pods die richtigen Zugriffsrechte auf Ihrem verbundenen AWS-Konto haben.

cloudwatch_enabled: true

Optionale Konfigurationswerte

Diese Werte können angepasst werden, wenn Sie eine ausgereifte Kubernetes-Cluster-Einrichtung haben und bestimmte Volumes wiederverwenden, Bereitstellungsdetails ändern oder Ihren Cluster mit bestimmten Cloud-Anbieter-Funktionen über Anmerkungen verknüpfen möchten. Für die Erstinstallation müssen diese nicht angepasst werden. Wir könnten in einem kommenden Blogbeitrag tiefer in diese Konfigurationswerte eintauchen und lernen, wie man Anmerkungen zu Ihrer Service-Rolle für die automatische AWS IAM-Rollenübernahme hinzufügt, Anmerkungen zu Ihrem Ingress-Controller für die automatische AWS ELB-Erstellung usw.

Fazit

Der grundlegende Satz von Konfigurationswerten, die Sie ändern sollten, ist recht klein und einfach zu verstehen. Dies ermöglicht es Ihnen, Ihre Produktionsdienste schnell in einer nahtlosen Integration zu verknüpfen. Wie immer hoffe ich, dass alles klar ist. Zögern Sie nicht, uns über unsere Slack-Community zu kontaktieren, wenn Sie Fragen haben. Bleiben Sie dran für den nächsten Blogbeitrag, in dem wir möglicherweise tiefer in diese optionalen Konfigurationswerte eintauchen.

Wir sehen uns im nächsten Blogbeitrag!