README.md in knife-spork-1.4.2 vs README.md in knife-spork-1.5.0

- old
+ new

@@ -48,14 +48,16 @@ - user_testing - acceptance_testing version_change_threshold: 2 preserve_constraint_operators: true environment_path: "/home/me/environments" +save_environment_locally_on_create: false role_path: "/home/me/roles" custom_plugin_path: "/home/me/spork-plugins" always_promote_remote: true skip_berkshelf: false +role_match_file_name: true json_options: indent: " " plugins: campfire: account: myaccount @@ -88,10 +90,17 @@ gist: "/usr/bin/gist" channel: ["chef-annoucements"] graphite: server: graphite.mydomain.com port: 2003 + influxdb: + database: deployments + username: deploy + password: deploy + series: deployments + host: influx.example.com + port: 8086 eventinator: url: http://eventinator.mydomain.com/events/oneshot slack: api_token: abc123 channel: "#sysops" @@ -127,13 +136,20 @@ #### JSON Options The `json_options` directive allows you to tell spork to pass options to [pretty_generate](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/json/rdoc/JSON.html#method-i-pretty_generate) to control the format of the resulting json #### Environment Path -The `environment_path` allows you to specify the path to where you store your chef environment json files. If this parameter is not specified, spork will default to using the first element of your cookbook_path, replacing the word "cookbooks" with "environments" +The `environment_path` directive allows you to specify the path to where you store your chef environment json files. If this parameter is not specified, spork will default to using the first element of your cookbook_path, replacing the word "cookbooks" with "environments" +#### Save Environment on Create +The `save_environment_on_create` directive allows you to have the ```knife spork environment create``` command save a copy of the new environment to your Chef repository. This will default to saving environment files in the location specified by the ```environment_path``` directive. If this parameter is not specified, spork will default to using the first element of your cookbook_path, replacing the word "cookbooks" with "environments" + + #### Role Path The `role_path` allows you to specify the path to where you store your chef role json files. If this parameter is not specified, spork will default to using the first element of your cookbook_path, replacing the word "cookbooks" with "roles" + +#### Role Match File Name +The `role_match_file_name` flag allows you to check whether the file name that is used to upload a role matches the role name as well. If the parameter is specified, or flag `--match-filename` is set, spork will not let you upload a role from a file unless the name matches the rolename. #### Custom Plugin Path The `custom_plugin_path` allows you to specify an additional directory from which to load knife-spork plugins. If this parameter is not specified or the path set does not exist, only the default plugins shipped with knife-spork will be loaded (if enabled in config)