summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThom May <thom@may.lt>2016-05-31 18:17:40 +0100
committerThom May <thom@may.lt>2016-05-31 18:17:40 +0100
commit8a7158de00b0e8ef7813c68400a46791c681176e (patch)
treeb3c709814a3e3ffaf1ca602743d8a25da6024d75
parent7bfe32232ae0a0250f9e168b0a1a6390758b41a7 (diff)
parentfe3c8e03e1066fcb7c0bf7378d7b50453e0488a7 (diff)
downloadchef-8a7158de00b0e8ef7813c68400a46791c681176e.tar.gz
Merge pull request #4971 from chef/smurawski/rfc062-exit-status-chef-client
DOC_CHANGES for RFC 062 Exit Status behavior
-rw-r--r--DOC_CHANGES.md20
1 files changed, 9 insertions, 11 deletions
diff --git a/DOC_CHANGES.md b/DOC_CHANGES.md
index 90b57c7e34..069cdc62b4 100644
--- a/DOC_CHANGES.md
+++ b/DOC_CHANGES.md
@@ -6,17 +6,15 @@ Example Doc Change:
Description of the required change.
-->
-## Doc changes for Chef 12.9
+## Doc changes for Chef 12.11
-### New timeout option added to `knife ssh`
+### RFC 062 Exit Status Support
-When doing a `knife ssh` call, if a connection to a host is not able
-to succeed due to host unreachable or down, the entire call can hang. In
-order to prevent this from happening, a new timeout option has been added
-to allow a connection timeout to be passed to the underlying SSH call
-(see ConnectTimeout setting in http://linux.die.net/man/5/ssh_config)
+Starting with Chef Client 12.11, there is support for the consistent, standard exit codes as defined in [Chef RFC 062](https://github.com/chef/chef-rfc/blob/master/rfc062-exit-status.md).
+
+With no additional configuration when Chef Client exits with a non-standard exit code a deprecation warning will be issued advising users of the upcoming change in behavior.
+
+To enable the standardized exit code behavior, there is a new setting in client.rb. The `exit_status` setting, when set to `:enabled` will enforce standarized exit codes. In a future release, this will become the default behavior.
+
+If you need to maintain the previous exit code behavior to support your current workflow, you can disable this (and the deprecation warnings) by setting `exit_status` to `:disabled`.
-The timeout setting can be passed in via a command line parameter
-(`-t` or `--ssh-timeout`) or via a knife config
-(`Chef::Config[:knife][:ssh_timeout]`). The value of the timeout is set
-in seconds.