restored attributes in README.md and renamed all cookbook refs to `su…

…mologic-collector`

.kitchen.yml

@@ -15,5 +15,5 @@ platforms:
 suites:
 - name: default
   run_list:
-    - recipe[sumo-collector]
+    - recipe[sumologic-collector]
     - recipe[minitest-handler]

README.md

@@ -1,4 +1,4 @@
-sumo-collector Cookbook
+sumologic-collector Cookbook
 ============================
 This cookbook installs the Sumo Logic collector on Linux using the shell script
 installer. Here are the steps it follows:
@@ -20,25 +20,76 @@ Installation
 
 ```knife cookbook github install SumoLogic/sumo-collector-chef-cookbook```
 
-3. Create a data bag with your access credentials:
-
-```knife data bag create sumo-config access-creds```
-
-```json
-{
-  "id": "access-creds",
-  "accessID": "<access_id>",
-  "accessKey": "<access_key>"
-}
-```
+3. Specify data bag and item with your access credentials.  The data item should
+contain attributes `accessID` and `accessKey`.
 
 4. Upload the cookbook to your Chef Server:
 
-```knife cookbook upload sumo-collector```
+```knife cookbook upload sumologic-collector```
 
-5. Add the `sumo-collector` receipe to your node run lists.  This step depends
+5. Add the `sumologic-collector` receipe to your node run lists.  This step depends
 on your node configuration, so specifics will not be described in this README.md.
 
+Attributes
+----------
+
+<table>
+  <tr>
+    <td>['sumologic']['ephemeral']</td>
+    <td>Boolean</td>
+    <td>Sumo Logic Ephemeral Setting</td>
+    <td>Required</td>
+  </tr>
+  <tr>
+    <td>['sumologic']['sources']['default_timezone']</td>
+    <td>String</td>
+    <td>Timezone for source setup (defaults to UTC)</td>
+    <td>Required</td>
+  </tr>
+  <tr>
+    <td>['sumologic']['installDir'] </td>
+    <td>String</td>
+    <td>Sumo Logic Install Directory</td>
+    <td>Required</td>
+  </tr>
+  <tr>
+    <td>['sumologic']['ephemeral']</td>
+    <td>Boolean</td>
+    <td>Sumo Logic Ephemeral Setting</td>
+    <td>Required</td>
+  </tr>
+  <tr>
+    <td>['sumologic']['sources']['default_timezone']</td>
+    <td>String</td>
+    <td>Timezone for source setup (defaults to UTC)</td>
+    <td>Required</td>
+  </tr>
+  <tr>
+    <td>['sumologic']['installDir'] </td>
+    <td>String</td>
+    <td>Sumo Logic Install Directory</td>
+    <td>Required</td>
+  </tr>
+  <tr>
+    <td>['sumologic']['credentials']['bag_name']</td>
+    <td>String</td>
+    <td>Name of the data bag.</td>
+    <td>Required</td>
+  </tr>
+  <tr>
+    <td>['sumologic']['credentials']['item_name']</td>
+    <td>String</td>
+    <td>Name of the item within the data bag. </td>
+    <td>Required</td>
+  </tr>
+  <tr>
+    <td>['sumologic']['credentials']['secret_file']</td>
+    <td>String</td>
+    <td>Path to the local file containing the encryption secret key.</td>
+    <td>Optional</td>
+  </tr>
+</table>
+
 Contributing
 ------------
 This cookbook is meant to help customers use Chef to install Sumo Logic

attributes/default.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Ben Newton (<[email protected]>)
-# Cookbook Name:: sumo-collector
+# Cookbook Name:: sumologic-collector
 # Recipe:: Default Recipe Attributes
 #
 # Copyright 2013, Sumo Logic
@@ -32,12 +32,12 @@
 # Default json.conf configuration templates cookbook
 # Replace this with a custom cookbook name if you want to create
 # your own custom sumo.json or template.
-default['sumologic']['json_config_cookbook'] = 'sumo-collector'
+default['sumologic']['json_config_cookbook'] = 'sumologic-collector'
 
 # Default sumo.conf configuration templates cookbook
 # Replace this with a custom cookbook name if you want to create
 # your own custom sumo.conf template.
-default['sumologic']['conf_config_cookbook'] = 'sumo-collector'
+default['sumologic']['conf_config_cookbook'] = 'sumologic-collector'
 
 # Default sumo.json template is set to nil so that it's determined in the
 # template based on platform_family.  Override this if you want to use a

metadata.rb

@@ -1,3 +1,4 @@
+name             'sumologic-collector'
 maintainer       'Ben Newton'
 maintainer_email '[email protected]'
 license          'Apache v2.0'

recipes/cleanup.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Ben Newton (<[email protected]>)
-# Cookbook Name:: sumo-collector
+# Cookbook Name:: sumologic-collector
 # Recipe:: Delete sumo.conf and json file
 #
 # Copyright 2013, Sumo Logic

recipes/default.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Ben Newton (<[email protected]>)
-# Cookbook Name:: sumo-collector
+# Cookbook Name:: sumologic-collector
 # Recipe:: Install, Register, and Configure Collector
 #
 # Copyright 2013, Sumo Logic
@@ -31,8 +31,8 @@
     # TODO recipe update
 else
     Chef::Log.info "Installing Sumo Logic Collector..."
-    include_recipe 'sumo-collector::sumoconf'
-    include_recipe 'sumo-collector::sumojson'
-    include_recipe 'sumo-collector::install'
-    include_recipe 'sumo-collector::cleanup'
+    include_recipe 'sumologic-collector::sumoconf'
+    include_recipe 'sumologic-collector::sumojson'
+    include_recipe 'sumologic-collector::install'
+    include_recipe 'sumologic-collector::cleanup'
 end

recipes/install.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Ben Newton (<[email protected]>)
-# Cookbook Name:: sumo-collector
+# Cookbook Name:: sumologic-collector
 # Recipe:: Install Sumo Logic Collector
 #
 #

recipes/sumoconf.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Ben Newton (<[email protected]>)
-# Cookbook Name:: sumo-collector
+# Cookbook Name:: sumologic-collector
 # Recipe:: Configure sumo.conf for unattended installs and activation
 #
 # Copyright 2013, Sumo Logic

recipes/sumojson.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Ben Newton (<[email protected]>)
-# Cookbook Name:: sumo-collector
+# Cookbook Name:: sumologic-collector
 # Recipe:: Configure json for configuring sources
 #
 #