Importer-Konfiguration
Im folgenden werden alle vorhandenen Konfigurationswerte beschrieben.
Verwendung
Der Importer kann direkt beim Installieren mit valuesYamlOverwrite (siehe) konfiguriert werden.
Verfügbare Konfigurationswerte
| Konfigurationsschlüssel | Beschreibung | Standardwert |
|---|---|---|
/config/logging/level |
Level definiert das verwendete Log-Level. Mögliche Werte sind: DEBUG, INFO, WARN, ERROR | INFO |
/config/api/host |
Host konfiguriert den FQDN, unter dem der Exporter für den CES-Datenexport verfügbar ist. Der Importer kontaktiert die Exporter-API, die alle erforderlichen Daten wie Datenpfade usw. zurückgibt. Der API-Endpunkt des Exporters ist festgelegt und wird auf der Quellseite weitergeleitet. | |
/config/api/secretName |
SecretName ist der Name des Secrets welches den API-Key des Exporters enthält. | ces-importer-secret |
/config/api/secretDataKey |
SecretDataKey enthält den Namen des Schlüssels innerhalb des Secrets, der den tatsächlichen API-Key des Exporters enthält. | apiKey |
/config/api/skipTLSVerify |
SkipTLSVerify steuert, ob ein Client die Zertifikatskette und den Hostnamen des Servers verifiziert. Wenn skipTLSVerify "true" ist, akzeptiert der Client jedes vom Server vorgelegte Zertifikat und jeden Hostnamen in diesem Zertifikat. | false |
/config/api/tlsConfigmapName |
TlsConfigmapName gibt den Namen der ConfigMap an in der das CA-Zertifikat der Exporter-Instanz enthalten ist. | ces-importer-exporter-ca |
/config/api/tlsConfigmapKey |
TlsConfigmapKey gibt den Namen des Keys der ConfigMap an in der das CA-Zertifikat der Exporter-Instanz enthalten ist. | exporter.crt |
/config/ssh/secretName |
SecretName ist der Name des Secrets welches den privaten SSH-Schlüssel enthält, den der Importer verwendet, um Zugriff auf das Quellsystem zu bekommen. | ces-importer-secret |
/config/ssh/secretDataKey |
SecretDataKey enthält den Namen des Schlüssels innerhalb des Secrets, der den tatsächlichen SSH-Schlüssel enthält. | privateKey |
/config/migration/regularSchedule |
RegularSchedule konfiguriert den Rhythmus der Ausführung der Migrationen. Der Rhythmus wird in CRON-Notation festgelegt, zum Beispiel 0 2 * * * |
|
/config/migration/finalSchedule |
FinalSchedule startet den finalen Migrationsjob zum angegebenen Zeitpunkt. Das Quellsystem sollte zu diesem Zeitpunkt keine aktiven Benutzer haben. Benutzt die RFC-3339-Notation: 2025-04-03T12:34:56Z (Serverzeit) |
|
/config/migration/changeFQDN |
ChangeFQDN konfiguriert den Import der FQDN und der Zertifikate. Wenn aktiviert, ist die Zielinstanz nach der finalen Migration unter der FQDN der Quellinstanz erreichbar. Dieser Wert wird nur bei der finalen Migration beachtet (siehe finalSchedule) | false |
/config/migration/maintenanceModeMessage/title |
MaintenanceModeMessage/title konfiguriert den Title, die Benutzer der Quellinstanz zu sehen bekommen, wenn die Instanz final migriert wird. Der Titel kann frei gewählt werden. | Migration in progess. |
/config/migration/maintenanceModeMessage/text |
MaintenanceModeMessage/text konfiguriert die Nachricht, die Benutzer der Quellinstanz zu sehen bekommen, wenn die Instanz final migriert wird. Der Text kann frei gewählt werden. | The migration of your instance is in progress. |
/config/migration/executePreflightCheck |
executePreflightCheck kontrolliert, ob der Preflight-Check beim Start des Importers ausgeführt wird. Der Preflight-Check kontrolliert wichtige Konfigurationen auf ihre Richtigkeit. | true |
/config/job/excludedDogus |
ExcludedDogus enthält eine Liste von Dogunamen, die nicht migriert werden sollen. Der Namespace muss dabei nicht angegeben werden, es reicht der Doguname, zum Beispiel redmine |
|
/config/job/excludedGlobalConfigurationKeys |
ExcludedGlobalConfigurationKeys enthält eine Liste von Namen von Konfigurationswerten, die nicht migriert werden sollen. | |
/config/job/excludedDoguConfigurationKeys |
ExcludedDoguConfigurationKeys enthält eine Liste von Namen von dogu-spezifischen Konfigurationswerten, die nicht migriert werden sollen, gruppiert nach Doguname. | |
/config/job/exclude |
Exclude enthält pro angegebenem Dogu Dateimuster, die bei der Migration ignoriert werden. Ein Beispiel findet sich in der unten gezeigten values.yaml. | |
/config/job/verbose |
Verbose aktiviert erweitertes Logging beim Datenmigrator. Unter anderem werden hiermit alle migrierten Ordner geloggt. | true |
/config/smtp/enabled |
Enabled aktiviert den Versand von Emails nach der Migration | false |
/config/smtp/server |
Der Hostname oder die IP-Adresse des SMTP-Servers (z.B., mailhog, smtp.gmail.com) | smtp.example.com |
/config/smtp/port |
Der Port auf den der SMTP-Mailserver hört (25, 587 for TLS, 1025 for MailHog/dev) | 25 |
/config/smtp/username |
Optional: Der Benutzername für den SMTP-Mailserver | |
/config/smtp/secretName |
secretName ist der Name des Secrets welches das Password des SMTP-Mailservers enthält | ces-importer-secret |
/config/smtp/secretDataKey |
secretDataKey enthält den Namen des Schlüssels innerhalb des Secrets der das tatsächliche Password des Mailservers enthält. | mailPassword |
/config/smtp/from |
Emailadresse die im "Von"-Feld der Email erscheint | importer@cloudogu.com |
/config/smtp/to |
Liste aller Email-Adressen, die das Ergebnis der Migration gesendet bekommen | |
/config/smtp/useTLS |
Gibt an ob der Mail-Server TLS verwendet | false |
/config/smtp/skipTLSVerify |
Steuert, ob die Zertifikatskette des Mail-Servers verifiziert wird. Wenn skipTLSVerify "true" ist, akzeptiert der Client jedes vom Mail-Server vorgelegte Zertifikat und jeden Hostnamen in diesem Zertifikat. | false |
/config/smtp/tlsConfigmapName |
TlsConfigmapName gibt den Namen der ConfigMap an, in der das CA-Zertifikat des Mail-Servers enthalten ist. | ces-importer-mail-ca |
/config/smtp/tlsConfigmapKey |
TlsConfigmapKey gibt den Namen des Keys der ConfigMap an, in der das CA-Zertifikat des Mail-Servers enthalten ist. | mail.crt |
Referenz values.yaml
config:
logging:
# level definiert das verwendete Log-Level. Mögliche Werte sind: DEBUG, INFO, WARN, ERROR
level: INFO
api:
# host konfiguriert den FQDN, unter dem der Exporter für den CES-Datenexport verfügbar ist. Der Importer kontaktiert
# die Exporter-API, die alle erforderlichen Daten wie Datenpfade usw. zurückgibt. Der API-Endpunkt des Exporters
# ist festgelegt und wird auf der Quellseite weitergeleitet.
host: ""
# secretName ist der Name des Secrets welches den API-Key des Exporters enthält.
secretName: "ces-importer-secret"
# secretDataKey enthält den Namen des Schlüssels innerhalb des Secrets, der den tatsächlichen API-Key des Exporters enthält.
secretDataKey: "apiKey"
# skipTLSVerify steuert, ob ein Client die Zertifikatskette und den Hostnamen des Servers verifiziert.
# Wenn skipTLSVerify "true" ist, akzeptiert der Client jedes vom Server vorgelegte Zertifikat und jeden Hostnamen in diesem Zertifikat.
skipTLSVerify: false
# Name der ConfigMap die das CA-Zertifikat des Exporters enthält
tlsConfigmapName: "ces-importer-exporter-ca"
# Name des Keys in der ConfigMap die das CA-Zertifikat des Exporters enthält
tlsConfigmapKey: "exporter.crt"
ssh:
# secretName ist der Name des Secrets welches den privaten SSH-Schlüssel enthält, den der Importer verwendet,
# um Zugriff auf das Quellsystem zu bekommen.
secretName: "ces-importer-secret"
# secretDataKey enthält den Namen des Schlüssels innerhalb des Secrets, der den tatsächlichen SSH-Schlüssel enthält.
secretDataKey: "privateKey"
migration:
# regularSchedule konfiguriert den Rhythmus der Ausführung der Migrationen.
# Der Rhythmus wird in CRON-Notation festgelegt, zum Beispiel "0 2 * * *" in Serverzeit.
regularSchedule: ""
# finalSchedule startet den finalen Migrationsjob zum angegebenen Zeitpunkt. Das Quellsystem sollte zu diesem
# Zeitpunkt keine aktiven Benutzer haben.
# Benutzt die RFC-3339-Notation: "2025-04-03T12:34:56Z"
finalSchedule: ""
# changeFQDN konfiguriert den Import der FQDN und der Zertifikate. Wenn aktiviert, ist die Zielinstanz nach der
# finalen Migration unter der FQDN der Quellinstanz erreichbar.
# Dieser Wert wird nur bei der finalen Migration beachtet (siehe finalSchedule)
changeFQDN: false
# maintenanceModeMessage konfiguriert die Nachricht, die Benutzer der Quellinstanz zu sehen bekommen, wenn die Instanz
# final migriert wird.
maintenanceModeMessage:
# Titel der Nachricht
title: "Migration in progess."
# Text der Nachricht
text: "The migration of your instance is in progress."
job:
# excludedDogus ist eine Liste von Dogunamen, die bei der Migration ignoriert werden sollen. Diese werden zusätzlich
# zu den Dogus,die auf Multinode-Clustern nicht existieren, vom Import ausgenommen. Dogus, die standardmäßig nicht
# importiert werden, sind: monitoring, backup, registrator
# Beispiel:
# excludedDogus:
# - jenkins
# - cockpit
excludedDogus: [ ]
# excludedGlobalConfigurationKeys enthält die Namen globaler (nicht dogu-spezifischer) Konfigurationswerte,
# die vom Import ausgeschlossen werden sollen. Für diese Konfigurationen behält das Zielsystem seinen aktuellen Wert.
# Die hier aufgeführten Schlüssel sind zusätzlich zu den Schlüsseln, die immer vom Import ausgeschlossen sind.
# Immer vom Import ausgeschlossene Schlüssel sind: fqdn, alternativeFQDNs, maintenance sowie alle Schlüssel, die mit
# proxy/, k8s/ oder certificate/ beginnen.
# Beispiel:
# excludedGlobalConfigurationKeys:
# - default_dogu
# - otherKey
excludedGlobalConfigurationKeys: []
# excludedDoguConfigurations enthält die Namen dogu-spezifischer Konfigurationswerte, die vom Import
# ausgeschlossen werden sollen gruppiert nach Dogu-Name.
# Beispiel:
# excludedDoguConfigurations:
# - dogu: "ldap"
# keys:
# - admin_mail
# - admin_username
excludedDoguConfigurationKeys: []
# exclude enthält pro angegebenem Dogu Dateimuster, die bei der Migration ignoriert werden.
# Beispiel:
# exclude:
# - dogu: "official/jenkins"
# pattern:
# - "/path/unused_config.txt"
# - "/data/deleted/"
exclude: [ ]
# verbose aktiviert erweitertes Logging beim Datenmigrator.
# Unter anderem werden hiermit alle migrierten Ordner geloggt.
verbose: true
smtp:
# enabled aktiviert den Versand von Emails nach der Migration.
# Default: false
enabled: false
# Der Hostname oder die IP-Adresse des SMTP-Servers (z.B., mailhog, smtp.gmail.com)
server: smtp.example.com
# Der Port auf den der SMTP-Mailserver hört (25, 587 for TLS, 1025 for MailHog/dev)
port: 25
# Optional: Der Benutzername für den SMTP-Mailserver
username:
# secretName ist der Name des Secrets welches das Password des SMTP-Mailservers enthält
secretName: "ces-importer-secret"
# secretDataKey enthält den Namen des Schlüssels innerhalb des Secrets der das tatsächliche Password
# des Mailservers enthält.
secretDataKey: "mailPassword"
# Emailadresse die im "Von"-Feld der Email erscheint
from: importer@cloudogu.com
# Liste aller Email-Adressen, die das Ergebnis der Migration gesendet bekommen
to: [ ]
# useTLS konfiguriert den Mailserver für die Verwendung von TLS
# Deaktivieren Sie diese Option, wenn der Mailserver TLS nicht unterstützt, da dies sonst zu Fehlern führt.
useTLS: false
# skipTLSVerify konfiguriert den Mail-Dienst so, dass die TLS-Überprüfung bei Verwendung von TLS übersprungen wird.
skipTLSVerify: false
# Name der ConfigMap die das CA-Zertifikat des Mail-Servers enthält
tlsConfigmapName: "ces-importer-mail-ca"
# Name des Keys in der ConfigMap die das CA-Zertifikat des Mail-Servers enthält
tlsConfigmapKey: "mail.crt"