Link Search Menu Expand Document


With Kattlo you are able to use human readable notation to declare resources migrations and rules.

Table of contents

  1. Initialization
  2. Available Notations for Human Readable
  3. --config-file
  4. --kafka-config-file


To initialize new Kattlo project you just run the following command:

kattlo init --directory='/path/to/initialize'

Use the --bootstrap-servers to generate the Kattlo config with right Kafka addresses:

kattlo --bootstrap-servers='my-kafka-b1:9092,my-kafka-b2:9092' \
  init --directory='/path/to/initialize'

If you suppress the --directory option, the current folder will be initialized.

Available Notations for Human Readable

  • name regex pattern
  • time: transformed to millis
    • seconds or second
    • minutes or minute
    • hours or hour
    • days or day
  • size: transformed to bytes
    • KiB
    • MiB
    • GiB
  • math: transformed to floating point number between 0 and 1
    • %

For bytes Kattlo uses the quibibyte notation


  • 1day will be transformed in 86400000 milliseconds
  • 2seconds in 2000 milliseconds
  • 1hour in 3600000 milliseconds
  • 1KiB in 1024 bytes
  • 50% in 0.5


Relative or absolute path to Kattlo’s configuration file.

In the .kattlo.yaml configuration file you may define the following properties or use the init command to generate it.

Example of .kattlo.yaml

    namePattern: 'your pattern'
    # more rules constraints...


Relative or absolute path to Apache Kafka® configuration file used by Kattlo to perform Admin, Producer and Consumer operations.

Created by init command too

You may put the properties described at official documentation.

Example of