Configuration

Configuration areas

Nussknacker configuration is divided into several configuration areas, each area addressing a specific aspect of using Nussknacker:

• Designer configuration
• Scenario Types configuration, comprising of:
  • Deployment Manager configuration
  • Model configuration

Designer configuration contains all settings for Nussknacker Designer - e.g. web application ports, security, various UI settings.

One Nussknacker Designer deployment may be used to create various Scenario Types which:

• can be deployed with various Deployment Managers to e.g. different Flink clusters
• use different components and Model configurations

See development configuration (used to test various Nussknacker features) for an example of configuration with more than one Scenario Type.

Diagram below presents main relationships between configuration areas.

Let's see how those concepts look in fragment of main configuration file:

# Designer configuration 
environment: "local"
...

# Each scenario type is configured here 
scenarioTypes {
  "scenario-type-1": {
    # Configuration of DeploymentManager (Flink used as example here) 
    deploymentConfig: {
      type: "flinkStreaming"
      restUrl: "http://localhost:8081"
    }
    # Configuration of model
    modelConfig: {
      classPath: ["model/defaultModel.jar", "model/flinkExecutor.jar", "components/flink"]
      restartStrategy.default.strategy: disable
      components {
        ...
      }
    }
  }
}

This is how it looks in default configuration file in Nu distribution.

Environment variables

Environment variables are described in Installation guide, they are mostly helpful in the docker setup.

Conventions

• We use HoCon (see introduction or full specification for details) as our main configuration format. Lightbend config library is used for parsing configuration files - you can check documentation for details on conventions of file names and merging of configuration files.
• nussknacker.config.locations Java system property (CONFIG_FILE environment variable for Docker image) defines location of configuration files (separated by comma). The files are read in order, entries from later files can override the former (using HoCon fallback mechanism) - see docker demo for example:
  • setting multiple configuration files
  • file with configuration override
• defaultDesignerConfig.conf contains defaults for Nussknacker Designer
• If config.override_with_env_vars Java system property is set to true, it is possible to override settings with env variables. This property is set to true in the official Nussknacker docker image.

It’s important to remember that model configuration is prepared a bit differently. Please read model configuration for the details.