summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormjingle <mjingle@users.noreply.github.com>2019-04-18 10:30:36 -0400
committerMarc A. Paradise <marc.paradise@gmail.com>2019-04-24 13:29:00 -0400
commit8c73301fe37560faf5fb08d0c2a47909b6b68f20 (patch)
tree580c8ce564eaaa625ffc87fd51c2e1fa981d3ece
parenta036265fff3781c0945b3411c317eca1cafd64ca (diff)
downloadchef-8c73301fe37560faf5fb08d0c2a47909b6b68f20.tar.gz
Apply suggestions from code review
Co-Authored-By: marcparadise <marcparadise@users.noreply.github.com>
-rw-r--r--RELEASE_NOTES.md2
-rw-r--r--docs/dev/design_documents/bootstrap_with_train.md6
2 files changed, 4 insertions, 4 deletions
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
index 94caa8bab0..ef2e843bd5 100644
--- a/RELEASE_NOTES.md
+++ b/RELEASE_NOTES.md
@@ -47,7 +47,7 @@ The LC_ALL property in the locale resource has been deprecated as the usage of t
### Knife Bootstrap
Knife bootstrap has been updated, and Windows bootstrap has been merged into core Chef's `knife bootstrap`. This marks the deprecation of the `knife-windows` plugin's `bootstrap` behavior.
-This change also addresses [CVE-2015-8559](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2015-8559): The knife bootstrap command in chef leaks the validator.pem private RSA key to /var/log/messages.
+This change also addresses [CVE-2015-8559](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2015-8559): The `knife bootstrap` command in chef leaks the validator.pem private RSA key to /var/log/messages.
*Important*: `knife bootstrap` works with all supported versions of Chef client. Older versions may continue to work as far back as 12.20
diff --git a/docs/dev/design_documents/bootstrap_with_train.md b/docs/dev/design_documents/bootstrap_with_train.md
index b4c3dbcc89..be4fdeb3ec 100644
--- a/docs/dev/design_documents/bootstrap_with_train.md
+++ b/docs/dev/design_documents/bootstrap_with_train.md
@@ -64,7 +64,7 @@ passed through to no effect.
As part of this change, CLI options from `knife bootstrap windows winrm` and `knife bootstrap`
need to be merged. The majority will be untouched, but we'll also take this opportunity
to make flag names more accurately describe what they're doing, and updating several options that are
-protocol-specific to be prefixed with the protocol (e.g. --ssl-peer-fingerprint to --winrm-ssl-peer-fingerprint`)
+protocol-specific to be prefixed with the protocol (e.g. `--ssl-peer-fingerprint` to `--winrm-ssl-peer-fingerprint`)
When a direct mapping exists, the original names will continue to work with backward
compatibility and a deprecation warning if they have changed.
@@ -80,7 +80,7 @@ compatibility and a deprecation warning if they have changed.
| --connection-port | port to connect to, regardless of protocol |
`--connection-user`, `--connection-port`, and `--connection-password` replace their protocol-specific counterparts, since
-these are applicable to all supported transports. Their original knife config keys (`ssh\_user`, `ssh\_password`, etc) remain
+these are applicable to all supported transports. Their original knife config keys (`ssh\_user`, `ssh\_password`, etc.) remain
available for use.
Note that auth-related configuration may see further changes as work proceeds on credential set support for train.
@@ -111,7 +111,7 @@ Note that auth-related configuration may see further changes as work proceeds on
| Flag | Notes |
|-----:|:------|
|--kerberos-keytab-file| This option existed but was not implemented.|
-|--winrm-codepage| This was used under knife-windows because bootstrapping was performed over a `cmd` shell. It is now invoked from `powershell`, so this option is no longer required.|
+|--winrm-codepage| This was used under `knife-windows` because bootstrapping was performed over a `cmd` shell. It is now invoked from `powershell`, so this option is no longer required.|
|--winrm-shell| This option was ignored for bootstrap.|
|--prerelease|Prerelease Chef hasn't existed for some time.|
|--install-as-service|Installing Chef client as a service is not supported|