values.yaml-Dateien gespeichert. Zwei Provider werden unterstützt; pro Installation ist genau einer über vantage.secrets konfiguriert.
Unterstützte Provider
Die beiden Provider verwenden dieselbe Secret-Alias-Konvention. Vantage-Workloads suchen Secrets anhand von Aliasen, unabhängig davon, woher die Werte stammen. Verwenden Sie das Alias-Inventar unten, um die Bereitstellung zu planen.
Azure Key Vault-Provider
Identitätsmodi
Funktionsweise
Vantage verwendet den Secrets Store CSI-Treiber mit dem Azure Key Vault-Anbieter. DieSecretProviderClass jedes workloads wird im nutzenden pod als CSI-Volume eingebunden. Dieser Mount veranlasst den Treiber, die Werte in ein workload-spezifisches Kubernetes-Secret zu synchronisieren (die secretObjects-Funktion der SPC), das der pod wiederum über envFrom und Volume-Mounts nutzt. Die Kette sieht wie folgt aus:
- Der Bediener generiert für jeden Workload (Deployment, StatefulSet oder Migrator) jedes installierten Charts eine
SecretProviderClass(SPC). Diese legt fest, welche Key Vault-Aliasse der Workload benötigt und welchem Schlüssel im Kubernetes-Secretdes Workloads jeder Alias zugeordnet wird. - Wenn ein Pod das Volume der SPC einbindet, authentifiziert sich der Secrets Store CSI-Treiber mit der Identität des Workloads (siehe Identitätsmodi), ruft die benannten Objekte aus Key Vault ab und synchronisiert sie über die Funktion
secretObjectsder SPC in das Kubernetes-Secretdes Workloads. - Der Pod des Workloads nutzt dieses
Secret:- Die meisten Secrets werden über
envFromals Umgebungsvariablen geladen. - Zertifikate (
authSigningTlsCrtusw.) werden zusätzlich übervolumeMountsals Dateien eingebunden (in der Regel unter/var/run/certs/).
- Die meisten Secrets werden über
Secret des jeweiligen Workloads und zur Laufzeit in der Umgebung des Pods vorhanden – für kubectl get secret sind sie also nicht unsichtbar. In values.yaml, ArgoCD-Diffs oder Git tauchen sie jedoch nie auf, da der CSI-Treiber sie erst beim Start des Pods befüllt.
Der Secrets Store CSI-Treiber und das Azure Key Vault-Anbieter-Plugin müssen vor Vantage im Cluster installiert sein. Siehe Voraussetzungen.
Ressourcen pro workload
Jeder workload eines Vantage-charts, der secrets verwendet, erhält eigene Ressourcen:
Der Bediener erstellt diese Ressourcen nur für installierte charts und entfernt sie wieder, sobald ein chart nicht mehr installiert ist.
Die SPC eines workloads verweist nur auf die Aliase, die dieser workload tatsächlich benötigt. Wie Sie zusätzlich einschränken, welche Key Vault-Objekte die Identität des jeweiligen workloads lesen darf, erfahren Sie unter Zugriff nach dem Prinzip der geringsten Rechte.
Kubernetes-Secrets-Provider
Secret-Ressourcen im Installations-Namespace, bevor Sie das Chart ausführen. Standardmäßig wird jeder Alias in ein einziges Secret mit dem Namen vantage-secrets aufgelöst. Fügen Sie eine objects-Zuordnung (secretName pro Alias) hinzu, um einen Alias auf ein anderes Secret verweisen zu lassen.
Die Datenschlüssel in jedem Secret sind die Namen der Umgebungsvariablen, die die Workloads lesen, nicht die Alias-Namen. Beispielsweise wird der Alias mailDatabaseConnectionString aus dem Schlüssel MailDatabase__ConnectionString gelesen. Siehe die Spalte Kubernetes key unter Secret-Aliase. Wenn Workloads einen Alias unter mehreren Variablennamen lesen, muss sein Secret jeden dieser Schlüssel mit demselben Wert enthalten.
Jedes Secret wird vollständig (envFrom) in jeden Workload eingebunden, der einen ihm zugeordneten Alias liest. Mit dem einzelnen Standard-Secret vantage-secrets erhält jeder dieser Workloads sämtliche Verbindungszeichenfolgen. Um einzuschränken, was ein Workload erhält, ordnen Sie seine Aliase separaten Secrets zu.
Das ServiceAccount eines Workloads schränkt nicht ein, welche Secrets dieser lesen kann: Kubernetes legt nicht fest, welche Secrets aus seinem Namespace ein Pod einbinden darf. Die Isolation wird stattdessen erreicht, indem Sie:
- der Verbindungszeichenfolge jedes Workloads ein eigenes Secret zuweisen
- die Identität, die ein Secret aus Ihrem externen Speicher synchronisiert (sofern Sie einen verwenden), auf die externen Secrets beschränken, aus denen dieses Secret erstellt wird
- einschränken, wer Pods im Vantage-Namespace erstellen darf
Secret-Objekten im Cluster gelesen.
Während der Vorabprüfung prüft der Operator, ob jedes referenzierte Secret existiert und alle Schlüssel enthält, die die installierten Charts benötigen. Andernfalls bricht er mit einer Fehlermeldung ab, die das fehlende Secret bzw. den fehlenden Schlüssel nennt. Die zugehörigen Operator- und Vantage-Charts installieren eine Secret-Reader-ClusterRole und binden sie ausschließlich im Vantage-Release-Namespace an das ServiceAccount des Operators. Wenn Sie den Zugriff auf Secrets über resourceNames einschränken, schließen Sie jeden Standardnamen und jeden überschriebenen Secret-Namen ein.
Ein externes Secret-Management-System kann weiterhin Ihre maßgebliche Quelle bleiben. So kann External Secrets Operator beispielsweise Kubernetes-Secrets aus HashiCorp Vault materialisieren. Vantage verwendet nur die daraus entstehenden Kubernetes-Secrets und stellt keine direkte Verbindung zu External Secrets oder Vault her. Ein SecretStore, der sich mit der eigenen Identität des External-Secrets-Operator-Controllers authentifiziert, teilt diese Identität mit allen anderen SecretStores, die sich ebenso authentifizieren. Damit jeder SecretStore einen eigenen, abgegrenzten Zugriff auf Ihren externen Speicher erhält, lassen Sie ihn sich mit einem eigenen ServiceAccount authentifizieren.
Dienstspezifische Datenbank-Secrets
Jeder Service muss eine Verbindungszeichenfolge erhalten, die eine eigene logische Datenbank auf SQL Server oder PostgreSQL angibt; bei gemeinsamer Nutzung derselben Datenbank kommt es zu Konflikten beim Migrationsstatus der Services. Beim Kubernetes-Provider werden 15 Datenbank-Aliasse aus demselben SchlüsselDatabase__ConnectionString gelesen (siehe die Spalte Kubernetes key unter Datenbanken). Ohne eine objects-Zuordnung werden sie alle zu diesem Schlüssel im Standard-Secret vantage-secrets aufgelöst und erhalten dieselbe Verbindungszeichenfolge. Erstellen Sie für jeden dieser Aliasse ein separates Secret und ordnen Sie es über vantage.secrets.kubernetes.objects zu. Aliasse mit eindeutig benannten Schlüsseln, wie z. B. MailDatabase__ConnectionString, können sich ein Secret teilen.
Setzen Sie vantage.databaseProvider: PostgreSQL, um PostgreSQL zu verwenden. Das folgende Beispiel ordnet zwei dieser Aliasse zu:
reportingEnabled: false, wenn Sie PostgreSQL verwenden.
Secret-Aliasse
Die folgenden Aliasse bilden die verbindliche Schnittstelle zwischen Vantage-Workloads und Ihrem Secrets-Provider. Mit dem Azure-Provider ist es am einfachsten, Ihre Key Vault-Secrets so zu benennen, dass sie dem Alias entsprechen. Bei beiden Providern können Sie Namen jedoch über einobjects-Mapping in Ihrer Secrets-Konfiguration neu zuordnen. Die Spalte Kubernetes key enthält die Datenschlüssel, die jeder Alias in seinem Secret benötigt, wenn Sie den Kubernetes-Provider verwenden.
Plattform
Speicher
Nur erforderlich, wenn das standardmäßige Azure-Blob-Speicher-Backend verwendet wird. Wennspec.storage.custom für ein Backend auf Basis einer Kubernetes-StorageClass (zum Beispiel NFS) konfiguriert ist, werden diese Aliase nicht verwendet.
Jeder Alias enthält entweder eine Verbindungszeichenfolge für ein Speicherkonto (Authentifizierung per Kontoschlüssel) oder den Namen eines Speicherkontos (Authentifizierung über Microsoft Entra ID, nur öffentliche Azure-Cloud, erreichbar unter https://<name>.blob.core.windows.net). Alle fünf Aliase können auf dasselbe Konto oder auf verschiedene Konten verweisen.
Der Speicher-Service gibt den Wert seiner Speicher-secrets an jeden Workload weiter, für den er Speicher-token ausstellt. Bei Verwendung von Verbindungszeichenfolgen verfügt daher jeder Workload, der Speicher nutzt, über den Schlüssel des Speicherkontos – unabhängig davon, welche secrets ihm zugewiesen sind.
Statt Verbindungszeichenfolgen mit Kontoschlüssel empfehlen wir die Authentifizierung über Microsoft Entra ID mit Speicherkontonamen, da jeder Workload dann auf seine eigene Identität beschränkt ist und Zugriffsrechte pro Workload erteilt und entzogen werden können. Um Entra ID zu verwenden, setzen Sie die fünf Aliase auf den Kontonamen, weisen Sie jedem Workload, der auf Blob-Speicher zugreift, eine Identität mit der Rolle Storage Blob Data Contributor für jedes in den Aliasen angegebene Konto zu, fügen Sie den pods dieser Workloads über vantage.workloads.pods das Pod-Label azure.workload.identity/use: "true" hinzu und setzen Sie allowSharedKeyAccess: false für jedes Konto, sodass kein Schlüssel existiert, der offengelegt werden könnte. Mehrere Workloads können dieselbe Identität verwenden. Welche Workloads auf Blob-Speicher zugreifen, ist aus den secrets-Zuordnungen nicht ersichtlich; die Liste für Ihre Vantage-Version erhalten Sie von Ihrem ABBYY-Kundenbetreuungsteam.
Für jedes Speicherkonto gilt:
- Verwenden Sie es ausschließlich für Vantage.
- Beschränken Sie den Netzwerkzugriff, zum Beispiel mit einem privaten Endpunkt oder mit Firewallregeln, die nur das Netzwerk des Clusters zulassen. Auch bei einem privaten Endpunkt wird das Konto weiterhin über
<name>.blob.core.windows.neterreicht. - Erzwingen Sie TLS 1.2 oder höher und unterbinden Sie anonymen (öffentlichen) Blob-Zugriff.
- Aktivieren Sie vorläufiges Löschen (Soft Delete) und optional die Versionsverwaltung für Blobs und Container, damit sich Daten nach versehentlichem oder böswilligem Löschen wiederherstellen lassen.
Datenbanken
Verbindungszeichenfolgen, eine pro Datenbank. Die Datenbanknamen dienen nur als Beispiel; Sie können jeden Namen verwenden, den Ihr Bereitstellungsprozess erzeugt, solange die Verbindungszeichenfolge auf die richtige Datenbank verweist.
†
sendgridApiKey ist nur erforderlich, wenn kein SMTP verwendet wird. Siehe Bekannte Einschränkungen.
Zertifikataliasse
Vier PEM-kodierte TLS-Artefakte sind erforderlich, die als zwei Paare von Secret-Aliasen bereitgestellt werden (Zertifikat + privater Schlüssel). Beim Azure-Provider speichern Sie sie als Key Vault-Secrets, nicht als Key Vault-Zertifikatobjekte:
Beim Azure-Provider ist es am einfachsten, zwei selbstsignierte Zertifikate in Key Vault mit den Namen
auth-signing und auth-deactivated zu erstellen (Common Name = Ihr Vantage-dnsRecord-Wert) und anschließend vier Key Vault-Secrets anzulegen, deren Namen den obigen Aliasen entsprechen. Beim Kubernetes-Provider erstellen Sie die Secret-Ressourcen mit dem PEM-Material vorab. Die Standard-Datenschlüssel sind auth-signing-tls-crt, auth-signing-tls-key, auth-deactivated-tls-crt und auth-deactivated-tls-key. Verwenden Sie ein objects-Mapping, um Secret-Namen neu zuzuordnen.
Benennung und Zuordnung
Beim Azure-Provider verwenden Aliase, die nicht in derobjects-Zuordnung aufgeführt sind, den Alias selbst als Namen des Key Vault-Objekts (abgerufen als Typ secret). Wenn Ihre Key Vault-Objekte bereits so benannt sind, dass sie den Aliasen entsprechen, ist keine objects-Zuordnung erforderlich. Beim Kubernetes-Provider werden die Standardnamen der Secrets verwendet, wenn objects nicht definiert ist.
Wenn Ihr Bereitstellungsprozess andere Namen verwendet, geben Sie in Ihrer Secrets-Konfiguration eine objects-Zuordnung an:
Erforderliche Berechtigungen
Beim Azure Key Vault-Anbieter benötigt die Identität, mit der sich der Secrets Store CSI-Treiber authentifiziert, Lesezugriff auf die Key Vault-Objekte in derSecretProviderClass jedes Workloads, der diesen Anbieter verwendet. Nutzen alle Workloads eine gemeinsame Identität, benötigt diese Lesezugriff auf sämtliche oben aufgeführten geheimen Werte und Zertifikate. Welche Identität verwendet wird, hängt vom Modus ab:
workloadIdentity(Standard): die verwaltete Identität aus der Annotationazure.workload.identity/client-idim ServiceAccount des jeweiligen Workloads bzw.vantage.secrets.azure.clientId, wenn der ServiceAccount keine solche Annotation hat. Wie Sie jede Identität auf die Objekte ihres eigenen Workloads beschränken, erfahren Sie unter Zugriff mit minimalen Berechtigungen.vmManagedIdentity: die Identität, deren Client-ID invantage.secrets.azure.userAssignedIdentityIDangegeben ist.podIdentity: kein getestetes Szenario; wenden Sie sich an Ihr ABBYY-Kundenbetreuungsteam, bevor Sie diesen Modus einsetzen.
Secret-Ressourcen vorab im Install-Namespace; Vantage nutzt sie direkt. Für Storage-Aliase, die auf Kontonamen gesetzt sind, sind weiterhin die unter Speicher beschriebenen Identitätsberechtigungen erforderlich.
Vantage-Workloads, die sich über Microsoft Entra ID-Authentifizierung mit Azure SQL oder Blob Storage verbinden, authentifizieren sich mit der Identität aus der Annotation
azure.workload.identity/client-id ihres ServiceAccounts und benötigen das Pod-Label azure.workload.identity/use: "true"; siehe Datenbank-Anmeldedaten und Speicher. Andere Workloads in Ihrem Cluster, die Workload-Identität verwenden (beispielsweise ein In-mesh Prometheus, den Sie zur Überwachung bereitstellen – das Vantage-Installationsprogramm stellt Prometheus nicht bereit), können dieselbe oder eine andere UAMI verwenden.Zugriff nach dem Prinzip der minimalen Rechte
Vantage führt viele Workloads aus, und jeder davon benötigt Zugriff auf null oder mehr Komponenten außerhalb seines Pods. Um die Auswirkungen eines kompromittierten Pods zu begrenzen, gewähren Sie jedem Workload nur den Zugriff, den er tatsächlich benötigt. Gehen Sie für jeden Workload wie folgt vor:- Ermitteln Sie, worauf der Workload Zugriff benötigt.
- Konfigurieren Sie, wie der Kubernetes-ServiceAccount des Workloads diesen Zugriff erhält.
Wenn Sie Cloud-IAM wie Azure Workload Identity verwenden, legen Sie die Identitäten und ihre Rollenzuweisungen außerhalb von Kubernetes bei Ihrem Cloud-Provider fest. Die Konfiguration erfolgt dann in zwei Schritten: Erstellen Sie die Identität und erteilen Sie ihr die benötigten Berechtigungen. Verknüpfen Sie sie anschließend mit dem Kubernetes-ServiceAccount des Workloads.
Dienstkonten und Identitätsbereich
Der Bediener erstellt oder annotiert keineServiceAccount-Ressourcen; das Chart vantage-selfhosted hingegen schon.
- Standardmäßig wird jeder Workload unter
vantage.serviceAccountName(Standard:default) ausgeführt. MitserviceAccounts.vantage.create: trueerstellt das Chart dieses gemeinsame ServiceAccount, das standardmäßig nach dem Release benannt wird. - Ein Eintrag
serviceAccounts.workloads.<chart>.<kind>(migrator,deploymentoderstatefulSet) weist einem Workload ein eigenes ServiceAccount zu und legtvantage.workloads.serviceAccountsfest. Standardmäßig erstellt der Eintrag das ServiceAccount mit dem Namen<chart name without -helm>-<kind>(zum Beispielmail-migrator). Um ein vorhandenes ServiceAccount zu verwenden, legen Siecreate: falseund einennamefest. Der Eintrag akzeptiertannotationswieazure.workload.identity/client-id. - Das Chart bindet jedes Workload-ServiceAccount an die Rollen, die der jeweilige Workload im Cluster benötigt. Workloads können ein ServiceAccount gemeinsam nutzen, indem sie denselben Namen verwenden.
- Jedes benannte ServiceAccount außer
defaultmuss vor der Installation im Vantage-Namensraum vorhanden sein; andernfalls schlägt die VorabprüfungServiceAccountsReadyfehl.
workloadIdentity authentifiziert sich die SecretProviderClass jedes Workloads mit der Identität aus der Annotation azure.workload.identity/client-id seines ServiceAccounts; fehlt diese, wird auf vantage.secrets.azure.clientId zurückgegriffen. clientId ist optional, wenn alle ServiceAccounts, die Secrets mounten, annotiert sind. Die Fallback-Identität benötigt für jedes ServiceAccount, das sie verwendet, Zugangsdaten für eine föderierte Identität; andernfalls schlägt der Mount mit AADSTS700213: No matching federated identity record found fehl. Ein Workload mit eigenem ServiceAccount benötigt daher in der Regel auch eine eigene Annotation. Die Vorabprüfung SecretsConfigurationReady schlägt fehl, wenn für einen Workload keine Client-ID ermittelt werden kann.
Um den Key Vault-Zugriff nach dem Prinzip der geringsten Rechte zu gestalten, weisen Sie jedem Workload ein eigenes ServiceAccount und eine eigene verwaltete Identität zu, die ausschließlich Lesezugriff auf die Objekte in der SecretProviderClass dieses Workloads hat. Bei einem Key Vault, der Azure RBAC verwendet, beschränken Sie die Rolle Key Vault Secrets User auf einzelne Secrets.
Key Vault-Zugriff und Image-Pull-Zugriff sind voneinander unabhängig, können aber dieselben ServiceAccounts betreffen. Die UAMI-Föderation (diese Seite) gewährt Lesezugriff auf Secrets, authentifiziert jedoch keine Image-Pulls. Für Pulls fügen Sie ein Registry-Pull-Secret zu den
imagePullSecrets des in vantage.serviceAccountName angegebenen ServiceAccounts sowie aller in vantage.workloads.serviceAccounts angegebenen ServiceAccounts hinzu (oder legen Sie serviceAccounts.imagePullSecrets fest, wenn das Chart sie erstellt). Alternativ können Sie der AKS-Kubelet-Identität die Rolle AcrPull zuweisen. Siehe Image-Pull-Zugriff.Beispiel: Identität mit minimalen Berechtigungen für einen Workload
Der Zugriff mit minimalen Berechtigungen für einen Workload umfasst zwei Ebenen: Der Workload kann nur die secrets lesen, die er benötigt, und die Anmeldedaten in diesen secrets gewähren nur Zugriff auf die Ressourcen, die er benötigt. Dieses Beispiel behandelt die erste Ebene für den Migrator vonmail-helm, der genau ein secret liest: mailDatabaseConnectionString. Informationen zur zweiten Ebene finden Sie unter Datenbank-Anmeldedaten. Wie Sie die Aliase ermitteln, die andere Workloads lesen, zeigt die Tabelle oben.
Erstellen Sie eine verwaltete Identität, lassen Sie ausschließlich Tokens des ServiceAccounts des Migrators als vertrauenswürdig zu, und gewähren Sie der Identität Lesezugriff auf genau dieses eine Key Vault-secret. mail-migrator ist der Name, den der chart dem ServiceAccount des Migrators standardmäßig zuweist. Rollenzuweisungen auf Ebene einzelner secrets setzen einen Key Vault voraus, der Azure RBAC verwendet.
$resource_group ist die Ressourcengruppe für die Identität, $identity_name ist ein frei wählbarer Name, und $aks_oidc_issuer_url ist die OIDC-Aussteller-URL Ihres AKS-Clusters. $install_namespace und $key_vault_name sind die gleichnamigen Installationsvariablen.
Wenn vantage.secrets.azure.objects den Alias einem anderen Key-Vault-Objekt zuordnet, beschränken Sie den Scope der Rollenzuweisung stattdessen auf dieses Objekt. Es kann einige Minuten dauern, bis Rollenzuweisungen wirksam werden; bis dahin schlägt der SecretProviderClass-Mount mit Forbidden fehl.
Erstellen Sie den ServiceAccount des Migrators und annotieren Sie ihn mit der Client-ID der Identität:
mail-helm-Bereitstellung mit einer eigenen Identität und einem eigenen ServiceAccount, beschränkt auf die Aliase, die sie ausliest: mailDatabaseConnectionString, redisConnectionString und bei Verwendung von SendGrid zusätzlich sendgridApiKey.
Datenbank-Anmeldedaten
Verwenden Sie für jede Datenbank einen eigenen Login, der ausschließlich auf diese Datenbank Zugriff hat. Migratoren verwalten das Schema und benötigen DDL-Rechte: unter SQL Serverdb_ddladmin, db_datareader, db_datawriter und EXECUTE. Eine Bereitstellung, die eine kennwortbasierte Verbindungszeichenfolge mit ihrem Migrator gemeinsam nutzt, verwendet auch dessen Login und Berechtigungen. Damit die Bereitstellung weniger Berechtigungen erhält, muss sich jeder Workload mit seiner eigenen Identität authentifizieren (siehe Azure SQL mit Microsoft Entra ID). Die Bereitstellungen catalogstorage-helm und reporting-helm verwalten ebenfalls ein Schema und behalten ihre DDL-Rechte in jedem Fall.
SQL Server
Verwenden Sie eigenständige Datenbankbenutzer (Contained Database Users). Azure SQL Database unterstützt diese standardmäßig; unter SQL Server müssen Sie die Authentifizierung für eigenständige Datenbanken aktivieren und die Eigenständigkeit der Datenbank aufPARTIAL setzen. Zum Beispiel:
PostgreSQL
Standardmäßig kann sich jede Rolle mit jeder Datenbank verbinden. Entziehen SiePUBLIC dieses Recht für jede Vantage-Datenbank, und erteilen Sie es anschließend nur der Rolle des Service:
public zu verwenden, benötigt die Rolle zusätzlich das Recht CREATE für die Datenbank (oder muss deren Eigentümer sein).
Azure SQL mit Microsoft Entra ID
Empfohlen für Azure SQL. Der Workload authentifiziert sich bei seiner Datenbank nicht mit einem Kennwort, sondern über seine verwaltete Identität. Dadurch können ein Migrator und seine Bereitstellung dieselbe Verbindungszeichenfolge nutzen und trotzdem über unterschiedliche Berechtigungen verfügen. Stellen Sie als Microsoft Entra-Administrator des Servers eine Verbindung mit der Datenbank des Service her, erstellen Sie einen Benutzer für die verwaltete Identität und weisen Sie ihm die oben genannten Rollen zu. Lassen Siedb_ddladmin bei Bereitstellungen weg – mit Ausnahme von catalogstorage-helm und reporting-helm:
Server=tcp:<server>.database.windows.net,1433;Database=mail;Authentication=Active Directory Default. Weisen Sie dem Workload einen eigenen ServiceAccount zu, der mit der Client-ID der Identität annotiert ist, wie im obigen Beispiel.
Versehen Sie die Pods des Workloads mit dem Label, damit der Azure Workload Identity-Webhook ein Token einfügt. Der SecretProviderClass-Mount benötigt das Label nicht, die eigene Datenbankverbindung des Workloads hingegen schon:
Nächste Schritte
Voraussetzungen
Anforderungen auf Cluster-Ebene und an externe Services für jede Installation.
Installation auf Azure
Azure Key Vault-Übersicht und die Schritt-für-Schritt-Installation.
Selbstverwaltetes Kubernetes
Native Kubernetes-Secrets und PostgreSQL-Konfiguration.
