summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNoah Kantrowitz <noah@coderanger.net>2018-07-11 13:09:15 -0700
committerNoah Kantrowitz <noah@coderanger.net>2018-07-11 13:09:15 -0700
commit3571f2adc5c0491b1aa38d3813d0a0cf5da9669a (patch)
tree38b8cb0d2f862e60b720b80d4678852e6955481d
parentd1783558c0b10b36b1fdc48724ca5c95e3833f56 (diff)
downloadchef-3571f2adc5c0491b1aa38d3813d0a0cf5da9669a.tar.gz
Update release notes to include list-profiles and more details.
Signed-off-by: Noah Kantrowitz <noah@coderanger.net>
-rw-r--r--RELEASE_NOTES.md30
1 files changed, 24 insertions, 6 deletions
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
index d105fa687c..11f71b466e 100644
--- a/RELEASE_NOTES.md
+++ b/RELEASE_NOTES.md
@@ -1,12 +1,30 @@
This file holds "in progress" release notes for the current release under development and is intended for consumption by the Chef Documentation team. Please see <https://docs.chef.io/release_notes.html> for the official Chef release notes.
-## New `knife config get-profile` and `knife config use-profile` commands
+## Knife configuration profile management commands
-Two new commands under `knife config` have been added, in addition to the previous
-`knife config get`. `get-profile` will display the active credentials profile
-name. `use-profile` will, conversely, set the default profile name. The default
-profile set via `use-profile` can still be overridden by the `--profile` command
-line option or the `$CHEF_PROFILE` environment variable.
+Several new commands have been added under `knife config` to help manage multiple
+profiles in your `credentials` file.
+
+`knife config get-profile` will display the active profile.
+
+`knife config use-profile PROFILE` will set the workstation-level default
+profile. That default can still be overridden by the `--profile` command line
+option or the `$CHEF_PROFILE` environment variable.
+
+`knife config list-profiles` will display all your available profiles along with
+summary information on each.
+
+```bash
+$ knife config get-profile
+staging
+$ knife config use-profile prod
+Set default profile to prod
+$ knife config list-profiles
+ Profile Client Key Server
+-----------------------------------------------------------------------------
+ staging myuser ~/.chef/user.pem https://example.com/organizations/staging
+*prod myuser ~/.chef/user.pem https://example.com/organizations/prod
+```
# Chef Client Release Notes 14.3: