Configuration overview

The Enterprise Deephaven system is complex and highly configurable, featuring various types of configuration data stored in multiple locations.

Configuration data is stored in multiple places. Some configuration items are created and managed by the installer, while others must be updated manually after installation. Additionally, extension points are available for modifying the system's configuration.

Most Deephaven configuration is managed by the Configuration Server, which centralizes access to configuration data stored in etcd. Other configuration data is stored in files.

Use the dhconfig tool to manage the configuration data handled by the Configuration Server.

Dynamic vs static configuration types

Most configuration is static; a process reads configuration data when it starts and never checks it again.

The Persistent Query Controller and Authentication Server support reloading some configuration without restarting via the dhconfig pq reload and sudo -u irisadmin /usr/illumon/latest/bin/iris auth_server_reload_tool commands.

Many processes watch for changes to data routing and schema configuration. They will respond dynamically to any updates.

Types of configuration

There are various types of configuration files:

  • Deephaven properties files

  • XML files:

    • Schemas are stored as XML data.
    • The Tailer configuration is an XML file.
    • PQ configurations are represented as XML data.

  • YAML files:

    • Data routing configuration is stored in YAML format.

    • The optional Envoy proxy is configured with a YAML file.

    • Kubernetes configurations are YAML files.

    • etcd server configuration is a YAML file.

    Note

    A YAML filename may end in either .yml or .yaml.

  • Security and Authentication files:

    • Includes X509 certificates, keys, truststores, keystores, and password files.

There are additional text-based files with formats specified by the applications that use them.

Locations of configuration data

Much of a Deephaven system's configuration is stored in etcd and accessed via the Configuration Server:

The rest of the configuration is stored as text files in several well-known locations. Not all files are available on every type of Deephaven node. File system permissions are carefully managed so that access to sensitive files is restricted to the correct users and groups.

Managing configuration

To change configuration files stored on disk, edit the files directly. After making the changes, restart the relevant processes. Most files are not shared between machines in a deployment, so you must edit the files and restart the processes on all relevant nodes.

  • Use the dhconfig tool to make changes to configuration managed by the Configuration Server.
  • Use the Property Inspector to investigate properties files.
  • Use the Query Monitor to edit Persistent Queries.
  • Use the ACL editor UI or the dhconfig acl command to manage users and ACLS.