Skip to content

Commit

Permalink
more details on options and helmez.yaml to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vyshakhp committed Jul 17, 2018
1 parent 7a55dc2 commit 0614f42
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,39 @@ appOne:
files:
properties.conf : |+
#contents of properties.conf in appOne folder will be added here, the path on which the extra files to be added can be configured using extra_files_root properties in the helmez.yaml
```


```
GLOBAL OPTIONS:
--base BASE, -b BASE Execute in base directory BASE (default: "./")
--dir DIR, -d DIR default folder name DIR, default `values` (default: "values")
--out values.yaml, -o values.yaml write the generate yaml to file values.yaml (default: "values.yaml")
--helmez HELMEZ default helmez config file HELMEZ (default: "helmez.yaml")
--help, -h show help
--version, -v print the version
```

helmez.yaml can be used in any sub directory to override the defaults of of each application should be configured
```
values_file_name: "values.yaml" # can use different name for values.yaml
ignore_dot_file: true # by default helmez wont include any file/dir starting with "."
extra_files_to_kv: true # toggle concidering extra files in the dir to the key value pair in the values file
extra_file_root: ["config", "files"] #if extra_files_to_kv is true, extra_file_root sets the root on which the files should be added as key value pair
ignored_files: [] # in case want to ignore few files from the directory to getting added to the generated files
//Config Object
type HelmezConfig struct {
ValuesFileName string `yaml:"values_file_name"`
IgnoreDotFile bool `yaml:"ignore_dot_file"`
ExtraFilesToKV bool `yaml:"extra_files_to_kv"`
ExtraFileRoot []string `yaml:"extra_files_root"`
IgnoredFiles []string `yaml:"ignored_files"`
}
```

0 comments on commit 0614f42

Please sign in to comment.