HDXCTL Advanced Configuration

HDXCTL provides some features and functionality that allow for advanced configuration of your Hydrolix deployment.

Configuring you Deployment with a config file.

HDXCTL scale has the option to either edit --edit or load using --from-file a file that contains all the parameters for a deployment.

  • --edit will open a VIM that you can edit via your editor. On closing any changes you have made will be saved to the deployment you specified in the HDXCTL scale command
  • --from-file will load a config from a file and path you specify. On execution it will update the deployment with the items within the file.

HDXCTL uses a TOML (https://en.wikipedia.org/wiki/TOML) file format for specifying various components and configuration options for a deployment.

[service.head.instance]
family = "c5n"
size = "xlarge"
count = 1
disk = 30

[service.stream-head.instance]
family = "m5"
size = "large"
count = 1
disk = 30
......

Services and Pools

The Hydrolix TOML uses a classification for components to specify their type within a deployment. A service is a a deployment can have one or more pools

Configuration name Component Default Setting
service.head.instance
service.stream-head.instance
service.rds.instance
service.ui.instance
service.config.instance
Configuration name Component
default-query-peer.instance
pool.default-stream-peer.instance
default-batch-peer

A Simple example

[service.head.instance]
family = "c5n"
size = "xlarge"
count = 1
disk = 30

[service.stream-head.instance]
family = "m5"
size = "large"
count = 1
disk = 30

[service.rds.instance]
family = "db.t2"
size = "small"
disk = 30

[service.default.instance]
family = "t2"
size = "micro
count = 1
disk = 30

[service.ui.instance]
count = 1

[service.config.instance]
count = 1

[pool.default-query-peer.instance]
service = "peer"
family = "c5n"
size = "2xlarge"
count = 1
disk = 100

[pool.default-stream-peer.instance]
service = "stream-peer"
family = "m5"
size = "large"
count = 1

[pool.default-batch-peer.instance]
service = "batch-peer"
family = "r5"
size = "xlarge"
count = 1