File Layout

File Layout #

By default, the configuration files are stored in the config directory.

config\
    nodes\
        ServerA.hcl
        ServerA__instance1.hcl
        serverB.hcl
        ServerB\
            defaults.hcl
            Instance1.hcl
            Instance2.hcl
    defaults.hcl
    targets.hcl
  • targets.hcl lists the targets that will be configured
  • The configurations in defaults.hcl will be applied to all targets.
  • The configurations stored in nodes\ServerA.hcl will override the defaults for all instances on ServerA. AND they will be applied to the default instance on ServerA.

Configuring Named Instances #

Prior to 1.43.20, there was only one way to configure named instances:

config\
    nodes\
        ServerA.hcl
        ServerA__instance1.hcl
    defaults.hcl

The file list is defaults.hcl, ServerA.hcl, ServerA__Instance1.hcl. Later files will override earlier files. And note the double-underscores before the instance name.

Starting with 1.43.20, this layout also works:

config\
    nodes\
        ServerB.hcl
        ServerB\
            defaults.hcl
            Instance1.hcl
            Instance2.hcl
    defaults.hcl
  • ServerB.hcl applies to all instances on ServerB
  • ServerB/defaults.hcl files applies to all instances on ServerB.
  • ServerB/Instance1.hcl applies to ServerB\Instance1