dir2consul

dir2consul

Summary

dir2consul mirrors a filesystem directory to a Consul Key-Value (KV) Store

A files path and name, with the file extension removed, becomes the Consul Key while the contents of the file are the Value. Note that mirroring is exact which includes deleting any Consul Keys that are not present in the source files. Hidden files and directories, those beginning with ".", are always skipped.

It should be noted that this is extended when the file type is known: the value of a key = value inside a file will be mirrored as path/to/file/key = value.

Likewise, the specific properties will be augmented with the contents of files named default.type in the hierarchy. When loading a file at some/path/foo.properties, for example, the system will also load files at default.properties, some/default.properties, some/path/default.properties, and then some/path/foo.properties. Keys with values which are loaded from a default file will be overridden by files lower in the directory tree -- so if default.properties has key1=value1, while some/path/default.properties has key1=value2, key1=value2 would show up in the final properties. If key1 also has a value in foo.properties, then foo.properties would take precedence. If no lower file overrides a value, then that value will appear in the final properties loaded for foo.properties.

Configuration

dir2consul uses environment variables to override default configuration values. The variables are:

• D2C_CONSUL_KEY_PREFIX is the path to prepend to all Consul keys. Default: "dir2consul"
• DC2_DEFAULT_CONFIG_TYPE is a type to apply to files with no extension. Default: "" (ie, no value)
• D2C_DIRECTORY is the directory dir2consul will walk. Default: "local/repo"
• D2C_DRYRUN is a flag that prevents all Consul data modification. Set it to any truthy value to enable. Default: "false"
• D2C_IGNORE_DIR_REGEX is a PCRE regular expression that matches directories we ignore when walking the file system. The default value is impossible to match. Default: "a^"
• D2C_IGNORE_FILE_REGEX is a PCRE regular expression that matches files we ignore when walking the file system. Default: "README.md"
• D2C_VERBOSE is a flag that increases log output. Set it to any truthy value to enable. Default: "false"

Consul specific configuration variables are documented here and may be used to customize dir2consul connectivity to a Consul server.

Read more about regular expression syntax to get the desired behavior with the D2C_IGNORE_DIR_REGEX and D2C_IGNORE_FILE_REGEX configuration options.

Installation

dir2consul requires no installation. It ships as a Docker container.

Usage

Running with Docker

The following command does a dry run of mirroring the present working directory (PWD) to the Consul server KV store under the path "some/specific/kv/path".

docker run -v $(PWD):/local \
  --env CONSUL_HTTP_ADDR=consul.example.com:8500 \
  --env D2C_CONSUL_KEY_PREFIX=some/specific/kv/path \
  --env D2C_DRYRUN=true \
  code42software/dir2consul:v1.5.0

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Author

Jim Razmus II

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.