Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add documentation for sparse mode #325

Merged
merged 1 commit into from
Nov 28, 2018
Merged

add documentation for sparse mode #325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ Short | Long | Description | Default | Valid Values | Sub-Commands
-F FORMAT | --format FORMAT | Format for decrypted output | summary | summary, json, yaml, pp | show
| --clean-unknown-clients | Remove unknown clients during key rotation | | | refresh, remove, rotate
| --clean | Clean clients list before performing search | | | refresh, update
| --keys-mode | | method to use to manage keys | default | default, sparse | create

## USAGE IN RECIPES

Expand Down Expand Up @@ -248,6 +249,11 @@ Use `chef-vault --help` to see all all available options

chef-vault -v passwords -i root -a password -k /etc/chef/knife.rb

## SCALING
As more nodes use a shared key, some operations like refresh or update can execute more efficiently using sparse mode (see [issue #237](https://github.com/chef/chef-vault/issues/237)).

To create a vault item using sparse mode, pass the value `sparse` to the `--keys-mode` option to `knife vault create`.

## TESTING

To use Chef Vault in Test Kitchen, ensure that the `chef-vault` recipe
Expand Down