diff --git a/README.md b/README.md index 8f492eeb4..991f132c7 100644 --- a/README.md +++ b/README.md @@ -89,6 +89,78 @@ For example, the configuration file in [conf/dynomite.yml](conf/dynomite.yml) Finally, to make writing syntactically correct configuration files easier, dynomite provides a command-line argument -t or --test-conf that can be used to test the YAML configuration file for any syntax error. +### Configuration YAML Generator + +The utility [generate_yams.py](https://github.com/Netflix/dynomite/blob/dev/scripts/dynomite/generate_yamls.py) automates +.yaml configuration files creation, needed for every node. + +The following usage examples show how to create different cluster configuration +with the command line. + +**Usage example 1**: +- 2 Datacenters (usa / europe) +- Each having 1 Rack (usa_rack1 / europe_rack1) + - One node per Rack, external ip's should be used (1.1.1.2 / 1.1.1.3) + + +``` +python generate_yamls.py 1.1.1.2:europe_rack1:europe 1.1.1.3:usa_rack1:usa -o mycluster +``` + +Will generate two yml files outputing the files to 'mycluster' folder + +More commands: +``` +python generate_yamls.py --help + +usage: + Dynomite Configuration YAML Generator + + Script for generating Dynomite yaml configuration files for distribution with every node. + generated yaml files will be outputted for each node, named as {ipaddress}.yml + so cluster wide can be easily configured + + + [-h] [-cp CLIENT_PORT] [-o OUTPUT_DIR] [-sp SERVER_PORT] + [-pp PEER_PORT] [-rc {DC_QUORUM,DC_ONE,DC_SAFE_QUORUM}] + [-sso {datacenter,none,rack}] [--redis] [--mem] + nodes [nodes ...] + +positional arguments: + nodes Usage: