Skip to content

Commit

Permalink
Merge pull request #325 from jeunito/doc/sparse-mode
Browse files Browse the repository at this point in the history
add documentation for sparse mode
  • Loading branch information
tas50 authored Nov 28, 2018
2 parents ddf8cd4 + 3d205ce commit fdea4f9
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
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

0 comments on commit fdea4f9

Please sign in to comment.