knife-solo_data_bag 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf49bac07e42c95338783f5538307c3041fb42c3
-  data.tar.gz: 93ad9e80f4d7b1f42a59a7f130a04beb022cc8dd
+  metadata.gz: 3870c3b498f4efbc193907f8c1a42bfa223bea9c
+  data.tar.gz: 39daf037a5840c12ac93c2858ef374cc6e2f1fc2
 SHA512:
-  metadata.gz: 58029e99bc35b17c56d4b9d5e323f4a33108aaff0d39b085e9b6cc024402950bb8e27cfeccd476ebd6c2af9fa8278327999646d987a368604a4aba59aa40a997
-  data.tar.gz: 2c1f8b1273fb493d825b986ac5e658f2b18fc7eebe3310ce8f5070099aa7fab71b9e1174e66b0bfdf4e0dd44b85ea0c98a0548168f52ee45b372706c873f86d8
+  metadata.gz: 7b4dfd5afb7692e1378aa18b3657aed91405d6085ea5b8e43cde826fe7bacd247eb6eb42810b851bc25be2cee9f6d262fe23318aca18fc8684e564679ed0160e
+  data.tar.gz: 1826ad39e5277833fa90006db7ab8f119540b7241b1b6cd5939cfe4facfbd3ee7386e83c1eb84017e8286232f98527132d7181f5282fbe26052b33a870534f56

data/README.md

@@ -1,9 +1,25 @@
 # Knife Solo Data Bag
+
 A knife plugin to make working with data bags easier in a chef solo environment.
 
 If you are looking for a full featured chef solo management solution, you may
 want to check out [knife solo](https://github.com/matschaffer/knife-solo).
 
+## Alternatives
+
+### `knife data bag`
+
+The standard `chef` gem includes the knife command and
+[commands to manipulate data bags][knife-data-bag-docs].
+
+`knife-solo_data_bag` has the following advantages over the `knife data bag`
+command:
+
+* allows recovery from errors when creating/editing JSON files,
+* allows import and export of the the contents in JSON format.
+
+[knife-data-bag-docs]: https://docs.chef.io/knife_data_bag.html "Knife data bag docs"
+
 ## Deprecation Notices
 
 * Versions >= 2 only support Ruby versions 2.2 and above.
@@ -12,15 +28,31 @@ want to check out [knife solo](https://github.com/matschaffer/knife-solo).
   If you need support for an earlier version of chef, use a knife solo data bag version < 1.0.0.
 
 ## Build Status
+
 ![Build Status](https://secure.travis-ci.org/thbishop/knife-solo_data_bag.png)
 
 ## Installation
+```sh
+gem install knife-solo_data_bag
 
-    gem install knife-solo_data_bag
-
+# or if using ChefDK
+chef gem install knife-solo_data_bag
+```
 ## Usage
 
+### Setup
+
+With Chef >= 12.x, you need to indicate that you're running in local mode,
+otherwise Chef will try to connect to a server.
+
+In `.chef/knife.rb`, add:
+
+```ruby
+local_mode       true
+```
+
 ### Create
+
 Create a plain text data bag
 
     $ knife solo data bag create apps app_1
@@ -42,6 +74,7 @@ Create a data bag item from a json file
     $ knife solo data bag create apps app_1 --json-file foo.json
 
 ### Edit
+
 Edit a plain text data bag
 
     $ knife solo data bag edit apps app_1
@@ -55,11 +88,13 @@ Edit an encrypted data bag with the provided file content as the secret
     $ knife solo data bag edit apps app_1 --secret-file 'SECRET_FILE'
 
 ### List
-List all of the data bag
+
+List data bags
 
     $ knife solo data bag list
 
 ### Show
+
 Show the plain text content of a data bag (if this is an encrypted data bag, it will return the encrypted data)
 
     $ knife solo data bag show apps app_1
@@ -76,19 +111,31 @@ You can also display any of the above variations in JSON format with `-F json`
 
     $ knife solo data bag show apps app_1 -s secret_key -F json
 
+### Using Data Bags in Recipes
+
+You can load your data bags inside you recipes as follows:
+
+```ruby
+app_1 = Chef::EncryptedDataBagItem.load("apps", "app_1").to_hash
+```
+
 ## Notes
+
 ### Data Bag Path
+
 By default, this plugin will use the configured data_bag_path. This is
 defaulted to `/var/chef/data_bags` by Chef. It is possible to override this
 path in your Chef client config if desired. When using this plugin, it is also
 possible to override the path using the `--data-bag-path` argument.
 
 ### Encrypted Data Bag Secret
+
 This plugin respects the "encrypted_data_bag_secret" configuration option in
 knife.rb. Command line secret arguments (-s or --secret-file) will override the
 setting in knife.rb.
 
 ## Version Support
+
 This plugin has been tested on the following:
 
 Chef:
@@ -104,11 +151,23 @@ OS:
 * OSX
 * Linux
 
+# Development
+
+Running tests requires an indication of the Gemfile to use:
+
+```shell
+export BUNDLE_GEMFILE=$PWD/gemfiles/Gemfile.chef.11.18.12
+bundle
+bundle exec rspec
+```
+
 ## Contribute
+
 * Fork the project
 * Make your feature addition or bug fix (with tests and docs) in a topic branch
 * Bonus points for not mucking with the gemspec or version
 * Send a pull request
 
 ## License
+
 See LICENSE for details

data/lib/chef/knife/solo_data_bag_edit.rb

@@ -29,6 +29,7 @@ class Chef
 
       def run
         Chef::Config[:solo]   = true
+        Chef::Config[:solo_legacy_mode] = true if Gem.loaded_specs['chef'].version > Gem::Version.new('12.11.0')
         @bag_name, @item_name = @name_args
         ensure_valid_arguments
         edit_content

data/lib/chef/knife/solo_data_bag_show.rb

@@ -28,6 +28,7 @@ class Chef
 
       def run
         Chef::Config[:solo]   = true
+        Chef::Config[:solo_legacy_mode] = true if Gem.loaded_specs['chef'].version > Gem::Version.new('12.11.0')
         @bag_name, @item_name = @name_args
         ensure_valid_arguments
         display_content

data/lib/knife-solo_data_bag/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module SoloDataBag
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-solo_data_bag
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Tommy Bishop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-10 00:00:00.000000000 Z
+date: 2017-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A knife plugin for working with data bags and chef solo