summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortyler-ball <tball@chef.io>2019-04-18 12:38:49 -0600
committerMark Anderson <mark@chef.io>2019-05-03 21:28:03 -0700
commitf02fe6b3ad2711f7e84f310bf19128b74fc3cd0e (patch)
treee191984df8eb8bdc8d464dc2e7c58d9960efbd42
parenta2fc3baaaa3503507c726ba1eca2af1c0711fc76 (diff)
downloadchef-f02fe6b3ad2711f7e84f310bf19128b74fc3cd0e.tar.gz
Adding developer docs to explain license flow
Signed-off-by: tyler-ball <tball@chef.io>
-rw-r--r--docs/dev/license_acceptance.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/dev/license_acceptance.md b/docs/dev/license_acceptance.md
new file mode 100644
index 0000000000..bb6e8a4e07
--- /dev/null
+++ b/docs/dev/license_acceptance.md
@@ -0,0 +1,13 @@
+# License Acceptance
+
+Starting with Chef Client 15 users are required to accept the [Chef
+EULA](https://www.chef.io/end-user-license-agreement/) to use the Chef Software distribution. This document aims to
+explain how the `license-acceptance` gem and the `chef` gem interact.
+
+The overall goal is that the license acceptance flow is invoked as early as possible in the binary (EG, `chef-client`)
+execution. Failure to accept the license causes the binary to immediately exit with code `172`.
+
+For an explanation of how this is achieved please see the [Ruby
+README](https://github.com/chef/license-acceptance/tree/master/components/ruby) in the license-acceptance repo. For an
+overall view of how the license-acceptance gem works, its specification, how marker files are stored, etc. please see
+the [repo README](https://github.com/chef/license-acceptance).