Importer configuration
The following is a list of all available config keys for the importer.
Usage
Configure the importer when installing with valuesYamlOverwrite (see here).
Available config values
| Konfigurationsschlüssel | Beschreibung | Standardwert |
|---|---|---|
/config/logging/level |
Level defines the log level to be used. Valid values are: DEBUG, INFO, WARN, ERROR | INFO |
/config/api/host |
host configures the FQDN under which the exporter will be available for CES data export. The importer will contact the exporter API, which returns all required data like data paths etc. The exporter API endpoint is fixed and will be routed on the source side. | |
/config/api/secretName |
secretName is the name of the secret that contains the exporter API key. | ces-importer-secret |
/config/api/secretDataKey |
secretDataKey contains the key name within the secret that accommodates the actual exporter API key as value. | apiKey |
/config/api/skipTLSVerify |
skipTLSVerify controls whether a client verifies the server's certificate chain and host name. If skipTLSVerify is true, the client accepts any certificate presented by the server and any host name in that certificate. |
false |
/config/api/tlsConfigmapName |
TlsConfigmapName specifies the name of the ConfigMap containing the CA certificate of the Exporter instance. | ces-importer-exporter-ca |
/config/api/tlsConfigmapKey |
TlsConfigmapKey specifies the name of the key in the ConfigMap that contains the CA certificate of the Exporter instance. | exporter.crt |
/config/ssh/secretName |
secretName contains the name of the secret that contains the SSH private key which the importer will use to access the source system. | ces-importer-secret |
/config/ssh/secretDataKey |
secretDataKey contains the key name within the secret that accommodates the actual exporter SSH private key as value. | privateKey |
/config/migration/regularSchedule |
regularSchedule triggers recurring migration jobs while the whole source system is running. Uses CRON notation like 0 2 * * * |
|
/config/migration/finalSchedule |
finalSchedule triggers the finishing migration job while the source system is supposed to be void of active users. Uses RFC 3339 notation like: 2025-04-03T12:34:56Z (server time) |
|
/config/migration/changeFQDN |
changeFQDN triggers the fqdn and certificate import. This is only taken into account if it is a final migration. | false |
/config/migration/maintenanceModeMessage/title |
maintenanceModeMessage/title is the title to been shown, when the maintenance mode gets activated at the source system. | Migration in progess. |
/config/migration/maintenanceModeMessage/text |
maintenanceModeMessage/text is the message to been shown, when the maintenance mode gets activated at the source system. | The migration of your instance is in progress. |
/config/migration/executePreflightCheck |
executePreflightCheck checks whether the preflight check is executed when the importer is started. The preflight check checks important configurations for correctness. | true |
/config/job/excludedDogus |
excludedDogus contains a list of dogu names that will not be migrated. This name does not have to include the dogu namespace (e.g. official/), the dogu name is sufficient, for example redmine |
|
/config/job/excludedGlobalConfigurationKeys |
excludedGlobalConfigurationKeys contains a list of configuration keys that will not be imported | |
/config/job/excludedDoguConfigurationKeys |
excludedDoguConfigurationKeys contains dogu-specific configuration keys that will not be imported, grouped by dogu name | |
/config/job/exclude |
exclude contains dogus with a pattern to exclude specific files during the import. See the values.yaml for an example. | |
/config/job/verbose |
verbose sets the data migrator to verbose logging. This logs all migrated directories. | true |
/config/smtp/enabled |
enabled determined whether an email should be sent after migration | false |
/config/smtp/server |
The SMTP server hostname or IP address (e.g., mailhog, smtp.gmail.com) | smtp.example.com |
/config/smtp/port |
The port the SMTP server listens on (25, 587 for TLS, 1025 for MailHog/dev) | 25 |
/config/smtp/username |
Optional: username for SMTP authentication (leave empty if not required) | |
/config/smtp/secretName |
secretName contains the name of the secret that contains the smtp mail password which the importer will to send emails. | ces-importer-secret |
/config/smtp/secretDataKey |
secretDataKey contains the key name that accommodates the actual exporter smtp mail password as value. | mailPassword |
/config/smtp/from |
Email address that appears in the "From" field of the email | importer@cloudogu.com |
/config/smtp/to |
List of recipient email addresses getting the migration result | |
/config/smtp/useTLS |
Specifies whether the mail server uses TLS. | false |
/config/smtp/skipTLSVerify |
Controls whether the mail server's certificate chain is verified. If skipTLSVerify is “true” the client accepts any certificate presented by the mail server and any host name in that certificate. | false |
/config/smtp/tlsConfigmapName |
TlsConfigmapName specifies the name of the ConfigMap containing the mail server's CA certificate. | ces-importer-mail-ca |
/config/smtp/tlsConfigmapKey |
TlsConfigmapKey specifies the name of the key in the ConfigMap that contains the mail server's CA certificate. | mail.crt |
Reference values.yaml
config:
logging:
# level defines the log level to be used. Valid values are: DEBUG, INFO, WARN, ERROR
level: INFO
api:
# host configures the FQDN under which the exporter will be available for CES data export. The importer will
# contact the exporter API, which returns all required data like data paths etc.
# The exporter API endpoint is fixed and will be routed on the source side.
host: ""
# secretName is the name of the secret that contains the exporter API key.
secretName: "ces-importer-secret"
# secretDataKey contains the key name within the secret that accommodates the actual exporter API key as value.
secretDataKey: "apiKey"
# skipTLSVerify controls whether a client verifies the server's certificate chain and host name.
# If skipTLSVerify is true, the client accepts any certificate presented by the server and any host name in that certificate.
skipTLSVerify: false
# Name of the ConfigMap containing the exporter's CA certificate
tlsConfigmapName: "ces-importer-exporter-ca"
# Name of the key in the ConfigMap that contains the exporter's CA certificate
tlsConfigmapKey: "exporter.crt"
ssh:
# secretName contains the name of the secret that contains the SSH private key which the importer will use to access the source system.
secretName: "ces-importer-secret"
# secretDataKey contains the key name within the secret that accommodates the actual exporter SSH private key as value.
secretDataKey: "privateKey"
migration:
# regularSchedule triggers recurring migration jobs while the whole source system is running.
# Uses CRON notation like "0 2 * * *" in server time.
regularSchedule: ""
# finalSchedule triggers the finishing migration job while the source system is supposed to be void of active users.
# Uses RFC 3339 notation like 2025-04-03T12:34:56Z
finalSchedule: ""
# changeFQDN triggers the fqdn and certificate import.
# This is only taken into account if it is a final migration.
# Default: false
changeFQDN: false
# maintenanceModeMessage is the message to been shown, when the maintenance mode gets activated at the source system.
maintenanceModeMessage:
# title to be shown in the maintenance mode message.
title: "Migration in progess."
# text to be shown in the maintenance mode message.
text: "The migration of your instance is in progress."
job:
# excludedDogus contains the names of dogus to exclude from the import. This is in addition to the dogus that are
# excluded because they do not exist as dogus on multinode clusters: monitoring, backup, and registrator
# example:
# excludedDogus:
# - jenkins
# - cockpit
excludedDogus: [ ]
# excludedGlobalConfigurationKeys contains the names of configuration keys that are not dogu-specific to exclude from the
# import. For these configuration keys, the importing system will keep the current value. The keys in this list are
# added to the keys that are always excluded from the import, those will not be overwritten by this configuration.
# Always excluded keys are: fqdn, alternativeFQDNs, maintenance, and those starting with proxy/, k8s/ or
# certificate/
# example:
# excludedGlobalConfigurationKeys:
# - default_dogu
# - otherKey
excludedGlobalConfigurationKeys: []
# excludedDoguConfigurations contains the names of configuration keys that are dogu-specific to exclude from the
# import, grouped by dogu name
# example:
# excludedDoguConfigurations:
# - dogu: "ldap"
# keys:
# - admin_mail
# - admin_username
excludedDoguConfigurationKeys: []
# exclude contains dogus with a pattern to exclude specific files during the import
# example:
# exclude:
# - dogu: "official/jenkins"
# pattern:
# - "EXCLUDE_PATTERN_1"
# - "EXCLUDE_PATTERN_2"
exclude: [ ]
# verbose sets the data migrator to verbose logging
# This logs all migrated directories
verbose: true
smtp:
# enabled controls whether email notifications are sent.
# Default: false
enabled: false
# The SMTP server hostname or IP address (e.g., mailhog, smtp.gmail.com)
server: smtp.example.com
# The port the SMTP server listens on (25, 587 for TLS, 1025 for MailHog/dev)
port: 25
# Optional: username for SMTP authentication (leave empty if not required)
username:
# secretName contains the name of the secret that contains the smtp mail password which the importer will to send emails.
secretName: "ces-importer-secret"
# secretDataKey contains the key name that accommodates the actual exporter smtp mail password as value.
secretDataKey: "mailPassword"
# sender mail address
# Email address that appears in the "From" field of the email
from: importer@cloudogu.com
# List of recipient email addresses
to: [ ]
# useTLS configures the mail server to use TLS
# Disable, if the mail server does not support TLS, otherwise this will lead to errors
useTLS: false
# skipTLSVerify configures the mail service to skip TLS verification when using TLS
skipTLSVerify: false
# Name of the config map containing the tls CA
tlsConfigmapName: "ces-importer-mail-ca"
# Key in the configmap containing the actual tls CA value
tlsConfigmapKey: "mail.crt"