From 3d205ce25a570a7988a1f0461cde3b782c7940b9 Mon Sep 17 00:00:00 2001 From: Jose Asuncion Date: Tue, 16 Oct 2018 08:34:29 -0700 Subject: [PATCH] add documentation for sparse mode Signed-off-by: Jose Asuncion --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 2ad1a44..89204bb 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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