Skip to main content

Director TOML File

The primary source of configuration for RioRey Director is the TOML file located on the system at /etc/riorey/director-core/main.toml. When logged on as the 'admin' user, you will need to edit this file using sudo and the editor of your choice (such as nano, vim or emacs, all of which are avilable when logged into Director).

Once you have finished making changes and saved your configuration, you can reload your configuration from the command line by entering director reload config, or first entering the Director CLI by entering director and then issuing the reload config command.

You can also check the configuration is correct by running the director_validate command against the main config file: director_validate /etc/riorey/director-core/main.toml. Unlike director reload config, this simply verifies that the syntax in the provided file is correct. You can thus draft a configuration in a different file, check that the draft configuration is correct without affecting your current running configuration, and then copy it over to the main TOML and issue a reload when you want the new configuration in place. The broad sections of a configuration are as follows:

  • Actions: The specific action you want to initiate in response to a workflow triggering.
  • BGP: Configuration of the Director BGP instance and any remote neighbors.
  • Flow Sampling Configuration: Configuration of how Director receives and processes network flow samples.
  • Mapping: The assocation of Groups and Zones to specific workflows.
  • Special Data Types: The non-standard TOML types that are used in various configuration items.
  • Workflows: The association of a set of network based triggers with the set of actions that should be invoked.
  • rWeb: Configuration for the rWeb instance that Director should use for Group and Zone information.