ghga/nos

Notification Orchestration Service

The Notification Orchestration Service controls the creation of notification events.

Description

The Notification Orchestration Service (NOS) uses data harvested from events published by various services to form Notification events, which are subsequently consumed by the Notification Service (NS) for dissemination.

Installation

We recommend using the provided Docker container.

A pre-built version is available on https://hub.docker.com/repository/docker/ghga/notification-orchestration-service:

bash
docker pull ghga/notification-orchestration-service:9.0.1

Or you can build the container yourself from the ./Dockerfile:

bash
# Execute in the repo's root dir:
docker build -t ghga/notification-orchestration-service:9.0.1 .

For production-ready deployment, we recommend using Kubernetes. However for simple use cases, you could execute the service using docker on a single server:

bash
# The entrypoint is pre-configured:
docker run -p 8080:8080 ghga/notification-orchestration-service:9.0.1 --help

If you prefer not to use containers, you may install the service from source:

bash
# Execute in the repo's root dir:
pip install .

# To run the service:
nos --help

Configuration

Parameters

The service requires the following configuration parameters:

• mongo_dsn (string, format: multi-host-uri, required): MongoDB connection string. Might include credentials. For more information see: [***] Length must be at least 1.

  Examples:

  json
  "mongodb://localhost:27017"
  

• db_name (string, required): Name of the database located on the MongoDB server.

  Examples:

  json
  "my-database"
  

• mongo_timeout: Timeout in seconds for API calls to MongoDB. The timeout applies to all steps needed to complete the operation, including server selection, connection checkout, serialization, and server-side execution. When the timeout expires, PyMongo raises a timeout exception. If set to None, the operation will not time out (default MongoDB behavior). Default: null.

  • Any of
    • integer: Exclusive minimum: 0.
    • null

  Examples:

  json
  300
  

  json
  600
  

  json
  null
  

• db_version_collection (string, required): The name of the collection containing DB version information for this service.

  Examples:

  json
  "ifrsDbVersions"
  

• migration_wait_sec (integer, required): The number of seconds to wait before checking the DB version again.

  Examples:

  json
  5
  

  json
  30
  

  json
  180
  

• migration_max_wait_sec: The maximum number of seconds to wait for migrations to complete before raising an error. Default: null.

  • Any of
    • integer
    • null

  Examples:

  json
  null
  

  json
  300
  

  json
  600
  

  json
  3600
  

• notification_topic (string, required): Name of the topic used for notification events.

  Examples:

  json
  "notifications"
  

• email_notification_type (string, required): The type used for email notification events.

  Examples:

  json
  "email_notification"
  

• sms_notification_type (string, required): The type used for SMS notification events.

  Examples:

  json
  "sms_notification"
  

• access_request_topic (string, required): Name of the event topic containing access request events.

  Examples:

  json
  "access-requests"
  

• user_topic (string): The name of the topic containing user events. Default: "users".

• auth_topic (string, required): The name of the topic containing auth-related events.

  Examples:

  json
  "auth-events"
  

• second_factor_recreated_type (string, required): The event type for recreation of the second factor for authentication.

  Examples:

  json
  "second_factor_recreated"
  

• iva_state_changed_topic (string, required): The name of the topic containing IVA events.

  Examples:

  json
  "ivas"
  

• iva_state_changed_type (string, required): The type to use for IVA state changed events.

  Examples:

  json
  "iva_state_changed"
  

• iva_send_code_type (string, required): The type to use for IVA send code events.

  Examples:

  json
  "iva_send_code"
  

• service_name (string): The Notification Orchestration Service controls the creation of notification events. Default: "nos".

• service_instance_id (string, required): A string that uniquely identifies this instance across all instances of this service. This is included in log messages.

  Examples:

  json
  "germany-bw-instance-001"
  

• kafka_servers (array, required): A list of connection strings to connect to Kafka bootstrap servers.

  • Items (string)

  Examples:

  json
  [
      "localhost:9092"
  ]
  

• kafka_security_protocol (string): Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL. Must be one of: "PLAINTEXT" or "SSL". Default: "PLAINTEXT".

• kafka_ssl_cafile (string): Certificate Authority file path containing certificates used to sign broker certificates. If a CA is not specified, the default system CA will be used if found by OpenSSL. Default: "".

• kafka_ssl_certfile (string): Optional filename of client certificate, as well as any CA certificates needed to establish the certificate's authenticity. Default: "".

• kafka_ssl_keyfile (string): Optional filename containing the client private key. Default: "".

• kafka_ssl_password (string, format: password, write-only): Optional password to be used for the client private key. Default: "".

• generate_correlation_id (boolean): A flag, which, if False, will result in an error when trying to publish an event without a valid correlation ID set for the context. If True, a new correlation ID will be generated and used in the event header. Default: true.

  Examples:

  json
  true
  

  json
  false
  

• kafka_max_message_size (integer): The largest message size that can be transmitted, in bytes, before compression. Only services that have a need to send/receive larger messages should set this. When used alongside compression, this value can be set to something greater than the broker's message.max.bytes field, which effectively concerns the compressed message size. Exclusive minimum: 0. Default: 1048576.

  Examples:

  json
  1048576
  

  json
  16777216
  

• kafka_compression_type: The compression type used for messages. Valid values are: None, gzip, snappy, lz4, and zstd. If None, no compression is applied. This setting is only relevant for the producer and has no effect on the consumer. If set to a value, the producer will compress messages before sending them to the Kafka broker. If unsure, zstd provides a good balance between speed and compression ratio. Default: null.

  • Any of
    • string: Must be one of: "gzip", "snappy", "lz4", or "zstd".
    • null

  Examples:

  json
  null
  

  json
  "gzip"
  

  json
  "snappy"
  

  json
  "lz4"
  

  json
  "zstd"
  

• kafka_max_retries (integer): The maximum number of times to immediately retry consuming an event upon failure. Works independently of the dead letter queue. Minimum: 0. Default: 0.

  Examples:

  json
  0
  

  json
  1
  

  json
  2
  

  json
  3
  

  json
  5
  

• kafka_enable_dlq (boolean): A flag to toggle the dead letter queue. If set to False, the service will crash upon exhausting retries instead of publishing events to the DLQ. If set to True, the service will publish events to the DLQ topic after exhausting all retries. Default: false.

  Examples:

  json
  true
  

  json
  false
  

• kafka_dlq_topic (string): The name of the topic used to resolve error-causing events. Default: "dlq".

  Examples:

  json
  "dlq"
  

• kafka_retry_backoff (integer): The number of seconds to wait before retrying a failed event. The backoff time is doubled for each retry attempt. Minimum: 0. Default: 0.

  Examples:

  json
  0
  

  json
  1
  

  json
  2
  

  json
  3
  

  json
  5
  

• log_level (string): The minimum log level to capture. Must be one of: "CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", or "TRACE". Default: "INFO".

• log_format: If set, will replace JSON formatting with the specified string format. If not set, has no effect. In addition to the standard attributes, the following can also be specified: timestamp, service, instance, level, correlation_id, and details. Default: null.

  • Any of
    • string
    • null

  Examples:

  json
  "%(timestamp)s - %(service)s - %(level)s - %(message)s"
  

  json
  "%(asctime)s - Severity: %(levelno)s - %(msg)s"
  

• log_traceback (boolean): Whether to include exception tracebacks in log messages. Default: true.

• central_data_stewardship_email (string, required): The email address of the central data steward.

• helpdesk_email (string, required): The email address of the GHGA Helpdesk.

• portal_url (string, format: uri): The URL of the GHGA data portal. Length must be between 1 and 2083 (inclusive). Default: "https://data.ghga.de/".

Usage:

A template YAML file for configuring the service can be found at ./example_config.yaml. Please adapt it, rename it to .nos.yaml, and place it in one of the following locations:

• in the current working directory where you execute the service (on Linux: ./.nos.yaml)
• in your home directory (on Linux: ~/.nos.yaml)

The config YAML file will be automatically parsed by the service.

Important: If you are using containers, the locations refer to paths within the container.

All parameters mentioned in the ./example_config.yaml can also be set using environment variables or file secrets.

For naming the environment variables, just prefix the parameter name with nos_, e.g. for the host set an environment variable named nos_host (you may use both upper or lower cases, however, it is standard to define all env variables in upper cases).

To use file secrets, please refer to the corresponding section of the pydantic documentation.

Architecture and Design:

This is a Python-based service following the Triple Hexagonal Architecture pattern. It uses protocol/provider pairs and dependency injection mechanisms provided by the https://github.com/ghga-de/hexkit library.

Development

For setting up the development environment, we rely on the https://code.visualstudio.com/docs/remote/containers of VS Code in combination with Docker Compose.

To use it, you have to have Docker Compose as well as VS Code with its "Remote - Containers" extension (ms-vscode-remote.remote-containers) installed. Then open this repository in VS Code and run the command Remote-Containers: Reopen in Container from the VS Code "Command Palette".

This will give you a full-fledged, pre-configured development environment including:

• infrastructural dependencies of the service (databases, etc.)
• all relevant VS Code extensions pre-installed
• pre-configured linting and auto-formatting
• a pre-configured debugger
• automatic license-header insertion

Inside the devcontainer, a command dev_install is available for convenience. It installs the service with all development dependencies, and it installs pre-commit.

The installation is performed automatically when you build the devcontainer. However, if you update dependencies in the ./pyproject.toml or the lock/requirements-dev.txt, run it again.

License

This repository is free to use and modify according to the Apache 2.0 License.

README Generation

This README file is auto-generated, please see .readme_generation/README.md for details.