dhconfig routing

The routing (or datarouting) configuration data type of the dhconfig tool is used to work with the data routing configuration.

dhconfig routing [import|export|validate|help] [arguments]

Note

Many Deephaven processes respond dynamically to data routing configuration changes.

As with other dhconfig configuration data types, the --help argument provides detailed information on the available actions and arguments, as well as usage examples. Use --help whenever you need more information about the available actions. For example, if you want information about the import action, you can run:

dhconfig routing import --help

Which prints the following:

usage: dhconfig routing import [--configfile <arg>] [--diskprops] [--etcd] [-f <arg>] [-h] [-k <arg> | -user <arg>] [-pf
       <arg>]  [-v]
Import data routing configuration from a file.

...followed by a description of all of the subcommand's arguments and some usage examples.

Due to the number of available actions and combinations, an exhaustive list of all possible commands is not provided here. Instead, we will give some usage examples and recommend that you use the --help argument as needed for more information.

Examples

export

Print the data routing configuration:

/usr/illumon/latest/bin/dhconfig routing export

Export data routing configuration to /tmp/routing.yml:

/usr/illumon/latest/bin/dhconfig routing export --file /tmp/routing.yml

/usr/illumon/latest/bin/dhconfig routing export /tmp/routing.yml

import

Note

Import actions require authentication, with sudo, --key, or --user.

Unless the --etcd option is used, the authenticated user must be in the superusers group (iris-superusers by default) or in a group authorized for data routing service changes via by the DataRoutingService.writers property, which must be visible to the configuration server:

DataRoutingService.writers=group1,group2

Import data routing configuration from /tmp/routing.yml:

sudo -u irisadmin /usr/illumon/latest/bin/dhconfig routing import --file /tmp/routing.yml

Import data routing configuration from /tmp/routing.yml, bypassing configuration server (requires sudo):

sudo -u irisadmin /usr/illumon/latest/bin/dhconfig routing import --file /tmp/routing.yml --etcd

Note

You cannot use dhconfig routing to validate or import both the main routing configuration file and additional, separately managed DIS files in a single command. If you need to work with both at once, use dhconfig dis with the --routing-file option.

For example:

dhconfig dis import --routing-file /tmp/routing.yml --file /tmp/dis1.yml --file /tmp/dis2.yml

validate

Check /tmp/routing.yml for errors:

/usr/illumon/latest/bin/dhconfig routing validate --file /tmp/routing.yml
/usr/illumon/latest/bin/dhconfig routing validate --file /tmp/routing.yml --verbose