chef_sous_vide 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dbf479c7c26026bf1c478fed4b9268743c018cc
+  data.tar.gz: f903092d21a62916b09d1b03c5b0a6e2e00be2c5
+SHA512:
+  metadata.gz: 6cf82abbceeb1d85371f5cda965cf3c27dbbd61bdc220253c9e5ded22149ce6ab6f658f2473cd2a15a050c127d9c525536ee13d5ba62cd7e496e488211a8b1ab
+  data.tar.gz: c80e255d8f134869e2e72448c2b30ebdec32044568271175138933129dd5ab643eaa370b5a5af5729f06b33019b208c9afc652bf16622eb1446408af5fb16960

data/.gitignore

@@ -0,0 +1,14 @@
+.bundle/
+.yardoc
+_yardoc/
+coverage/
+doc/
+pkg/
+spec/reports/
+tmp/
+vendor
+
+# rspec failure tracking
+.rspec_status
+.kitchen/
+.kitchen.local.yml

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.17.1

data/Berksfile

@@ -0,0 +1,11 @@
+source "https://supermarket.chef.io"
+
+Dir.glob("cookbooks/*").map do |dir|
+  cookbook File.basename(dir), path: dir
+end
+
+cookbook "java"
+cookbook "elasticsearch"
+cookbook "seven_zip", "< 3.1"
+cookbook "tomcat"
+cookbook "nginx"

data/Berksfile.lock

@@ -0,0 +1,45 @@
+DEPENDENCIES
+  elasticsearch
+  java
+  nginx
+  seven_zip (< 3.1.0)
+  sous_vide
+    path: cookbooks/sous_vide
+  tomcat
+
+GRAPH
+  apt (7.1.1)
+  ark (4.0.0)
+    build-essential (>= 0.0.0)
+    seven_zip (>= 0.0.0)
+  build-essential (8.2.1)
+    mingw (>= 1.1)
+    seven_zip (>= 0.0.0)
+  chef-sugar (5.0.1)
+  elasticsearch (4.0.5)
+    apt (>= 0.0.0)
+    ark (>= 0.0.0)
+    chef-sugar (>= 0.0.0)
+    yum (>= 0.0.0)
+  homebrew (5.0.8)
+  java (3.2.1)
+    homebrew (>= 0.0.0)
+    windows (>= 0.0.0)
+  mingw (2.1.0)
+    seven_zip (>= 0.0.0)
+  nginx (9.0.0)
+    build-essential (>= 5.0)
+    ohai (>= 4.1.0)
+    yum-epel (>= 0.0.0)
+  ohai (5.2.5)
+  seven_zip (3.0.0)
+    windows (>= 0.0.0)
+  sous_vide (0.0.1)
+    elasticsearch (>= 0.0.0)
+    java (>= 0.0.0)
+    nginx (>= 0.0.0)
+    tomcat (>= 0.0.0)
+  tomcat (3.2.0)
+  windows (5.3.0)
+  yum (5.1.0)
+  yum-epel (3.3.0)

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,297 @@
+PATH
+  remote: .
+  specs:
+    sous_vide (0.1.0)
+      chef (~> 12.17.44)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    backports (3.12.0)
+    berkshelf (6.3.4)
+      buff-config (~> 2.0)
+      buff-extensions (~> 2.0)
+      chef (>= 12.7.2, < 14.0)
+      cleanroom (~> 1.0)
+      concurrent-ruby (~> 1.0)
+      faraday (~> 0.9)
+      httpclient (~> 2.7)
+      minitar (~> 0.5, >= 0.5.4)
+      mixlib-archive (~> 0.4)
+      mixlib-shellout (~> 2.0)
+      octokit (~> 4.0)
+      retryable (~> 2.0)
+      ridley (~> 5.0)
+      solve (~> 4.0)
+      thor (~> 0.19, < 0.19.2)
+    buff-config (2.0.0)
+      buff-extensions (~> 2.0)
+      varia_model (~> 0.6)
+    buff-extensions (2.0.0)
+    buff-ignore (1.2.0)
+    buff-ruby_engine (1.0.0)
+    buff-shell_out (1.1.0)
+      buff-ruby_engine (~> 1.0)
+    builder (3.2.3)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    celluloid-io (0.16.2)
+      celluloid (>= 0.16.0)
+      nio4r (>= 1.1.0)
+    chef (12.17.44)
+      addressable
+      bundler (>= 1.10)
+      chef-config (= 12.17.44)
+      chef-zero (>= 4.8)
+      diff-lcs (~> 1.2, >= 1.2.4)
+      erubis (~> 2.7)
+      ffi-yajl (~> 2.2)
+      highline (~> 1.6, >= 1.6.9)
+      iniparse (~> 1.4)
+      mixlib-archive (>= 0.2.0)
+      mixlib-authentication (~> 1.4)
+      mixlib-cli (~> 1.7)
+      mixlib-log (~> 1.3)
+      mixlib-shellout (~> 2.0)
+      net-sftp (~> 2.1, >= 2.1.2)
+      net-ssh (>= 2.9, < 4.0)
+      net-ssh-multi (~> 1.1)
+      ohai (>= 8.6.0.alpha.1, < 9)
+      plist (~> 3.2)
+      proxifier (~> 1.0)
+      rspec-core (~> 3.5)
+      rspec-expectations (~> 3.5)
+      rspec-mocks (~> 3.5)
+      rspec_junit_formatter (~> 0.2.0)
+      serverspec (~> 2.7)
+      specinfra (~> 2.10)
+      syslog-logger (~> 1.6)
+      uuidtools (~> 2.1.5)
+    chef-config (12.17.44)
+      addressable
+      fuzzyurl
+      mixlib-config (~> 2.0)
+      mixlib-shellout (~> 2.0)
+    chef-zero (13.1.0)
+      ffi-yajl (~> 2.2)
+      hashie (>= 2.0, < 4.0)
+      mixlib-log (~> 1.3)
+      rack (~> 2.0)
+      uuidtools (~> 2.1)
+    cleanroom (1.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    cucumber (3.1.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 3.2.0)
+      cucumber-expressions (~> 6.0.1)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (~> 1.3)
+      gherkin (~> 5.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (3.2.1)
+      backports (>= 3.8.0)
+      cucumber-tag_expressions (~> 1.1.0)
+      gherkin (~> 5.0)
+    cucumber-expressions (6.0.1)
+    cucumber-tag_expressions (1.1.1)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.10.0)
+    ffi-yajl (2.3.1)
+      libyajl2 (~> 1.2)
+    fuzzyurl (0.9.0)
+    gherkin (5.1.0)
+    gssapi (1.2.0)
+      ffi (>= 1.0.1)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    hashie (3.6.0)
+    highline (1.7.10)
+    hitimes (1.3.1)
+    httpclient (2.8.3)
+    iniparse (1.4.4)
+    ipaddress (0.8.3)
+    json (2.2.0)
+    kitchen-docker (2.9.0)
+      test-kitchen (>= 1.0.0)
+    kitchen-transport-rsync (0.1.2)
+      test-kitchen (~> 1.4)
+    libyajl2 (1.2.0)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    method_source (0.9.2)
+    minitar (0.8)
+    mixlib-archive (0.4.20)
+      mixlib-log
+    mixlib-authentication (1.4.2)
+    mixlib-cli (1.7.0)
+    mixlib-config (2.2.18)
+      tomlrb
+    mixlib-install (3.11.11)
+      mixlib-shellout
+      mixlib-versioning
+      thor
+    mixlib-log (1.7.1)
+    mixlib-shellout (2.4.4)
+    mixlib-versioning (1.2.7)
+    molinillo (0.6.6)
+    multi_json (1.13.1)
+    multi_test (0.1.2)
+    multipart-post (2.0.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-sftp (2.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (3.2.0)
+    net-ssh-gateway (1.3.0)
+      net-ssh (>= 2.6.5)
+    net-ssh-multi (1.2.1)
+      net-ssh (>= 2.6.5)
+      net-ssh-gateway (>= 1.2.0)
+    net-telnet (0.1.1)
+    nio4r (2.3.1)
+    nori (2.6.0)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    ohai (8.26.1)
+      chef-config (>= 12.5.0.alpha.1, < 14)
+      ffi (~> 1.9)
+      ffi-yajl (~> 2.2)
+      ipaddress
+      mixlib-cli
+      mixlib-config (~> 2.0)
+      mixlib-log (>= 1.7.1, < 2.0)
+      mixlib-shellout (~> 2.0)
+      plist (~> 3.1)
+      systemu (~> 2.6.4)
+      wmi-lite (~> 1.0)
+    plist (3.5.0)
+    proxifier (1.0.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rack (2.0.6)
+    rake (10.5.0)
+    retryable (2.0.4)
+    ridley (5.1.1)
+      addressable
+      buff-config (~> 2.0)
+      buff-extensions (~> 2.0)
+      buff-ignore (~> 1.2)
+      buff-shell_out (~> 1.0)
+      celluloid (~> 0.16.0)
+      celluloid-io (~> 0.16.1)
+      chef-config (>= 12.5.0)
+      erubis
+      faraday (~> 0.9)
+      hashie (>= 2.0.2, < 4.0.0)
+      httpclient (~> 2.7)
+      json (>= 1.7.7)
+      mixlib-authentication (>= 1.3.0)
+      retryable (~> 2.0)
+      semverse (~> 2.0)
+      varia_model (~> 0.6)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rspec_junit_formatter (0.2.3)
+      builder (< 4)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubyntlm (0.6.2)
+    rubyzip (1.2.2)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    semverse (2.0.0)
+    serverspec (2.41.3)
+      multi_json
+      rspec (~> 3.0)
+      rspec-its
+      specinfra (~> 2.72)
+    sfl (2.3)
+    solve (4.0.2)
+      molinillo (~> 0.6)
+      semverse (>= 1.1, < 4.0)
+    specinfra (2.77.0)
+      net-scp
+      net-ssh (>= 2.7)
+      net-telnet (= 0.1.1)
+      sfl
+    syslog-logger (1.6.8)
+    systemu (2.6.5)
+    test-kitchen (1.24.0)
+      mixlib-install (~> 3.6)
+      mixlib-shellout (>= 1.2, < 3.0)
+      net-scp (~> 1.1)
+      net-ssh (>= 2.9, < 5.0)
+      net-ssh-gateway (~> 1.2)
+      thor (~> 0.19)
+      winrm (~> 2.0)
+      winrm-elevated (~> 1.0)
+      winrm-fs (~> 1.1)
+    thor (0.19.1)
+    timers (4.0.4)
+      hitimes
+    tomlrb (1.2.8)
+    uuidtools (2.1.5)
+    varia_model (0.6.0)
+      buff-extensions (~> 2.0)
+      hashie (>= 2.0.2, < 4.0.0)
+    winrm (2.3.1)
+      builder (>= 2.1.2)
+      erubis (~> 2.7)
+      gssapi (~> 1.2)
+      gyoku (~> 1.0)
+      httpclient (~> 2.2, >= 2.2.0.2)
+      logging (>= 1.6.1, < 3.0)
+      nori (~> 2.0)
+      rubyntlm (~> 0.6.0, >= 0.6.1)
+    winrm-elevated (1.1.1)
+      winrm (~> 2.0)
+      winrm-fs (~> 1.0)
+    winrm-fs (1.3.2)
+      erubis (~> 2.7)
+      logging (>= 1.6.1, < 3.0)
+      rubyzip (~> 1.1)
+      winrm (~> 2.0)
+    wmi-lite (1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  berkshelf
+  bundler (~> 1.17)
+  cucumber (~> 3.1.2)
+  kitchen-docker
+  kitchen-transport-rsync
+  pry
+  rake (~> 10.0)
+  sous_vide!
+  test-kitchen
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 robuye
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,127 @@
+# SousVide for Chef
+
+**=======> SousVide is not ready to use. <=======**
+
+SousVide is a Chef Handler you can use to collect & visualize `chef-client` converge process. It receives event data from `chef-client` and keeps track of the converge process. It's essentially a stream parser hooked into `Chef::EventDispatch`.
+
+At the end you will have an extensive report about events occured during the run.
+
+Here's what SousVide will tell you:
+
+* time spent on a resource in ms
+* source location of a tracked resource (`cookbook::recipe`)
+* real execution order
+  - takes into account notifications and multiple executions
+* better execution status
+  - detects why-run used with :before notifications
+  - is aware of 'unprocessed' resources
+* better execution phase
+  - adds 'delayed' and 'post-converge' custom phases
+* better errors for retriable and ignorable resources
+  - last error is always captured, even if the resource succeed on retry
+* guards details (only_if & not_if) when a resource was skipped
+* more data about notifications
+  - simple counters for each type
+  - notification type & notifying resource when available
+
+All this and more will be available in a simple JSON friendly data structure ready to serve anywhere you like.
+
+Feed it to Kibana, save to file or print at the end of chef-client run. `SousVide` comes with common outputs (see `SousVide::Outputs`) but you can write your own or even pass it a Proc.
+
+## Installation & Usage
+
+Add to your recipe:
+
+```ruby
+chef_gem "sous_vide" do
+  action :install
+end
+
+require "sous_vide"
+SousVide::Handler.register(node.run_context)
+```
+
+You should add these lines as early as possible. SousVide will not detect compile-time executions before it's registration, but otherwise it will work just fine (or just as one would expect).
+
+In default configuration the report will be sent to `Chef::Log` at `INFO` level. `chef-client` will not print it to stdout if executed from a terminal (`log_level :auto`), it will be printed to the log file only.
+
+## Outputs & Configuration
+
+Once SousVide is registered, it's for the most part up to you to consume the output. `JsonHTTP` will probably be the most useful, the structure looks like this:
+
+```json
+[
+  {
+    "chef_resource": "execute[wait-for-logstash]#run",
+    "chef_resource_name": "wait-for-logstash",
+    "chef_resource_type": "execute",
+    "chef_resource_cookbook": "sous_vide",
+    "chef_resource_recipe": "default",
+    "chef_resource_action": "run",
+    "chef_resource_guard": null,
+    "chef_resource_duration_ms": 17,
+    "chef_resource_error_output": null,
+    "chef_resource_error_source": null,
+    "chef_resource_retries": 0,
+    "chef_resource_notified_by": null,
+    "chef_resource_notified_via": null,
+    "chef_resource_before_notifications": 0,
+    "chef_resource_immediate_notifications": 0,
+    "chef_resource_delayed_notifications": 0,
+    "chef_resource_order": 47,
+    "chef_resource_execution_phase": "converge",
+    "chef_resource_started_at": "2019-04-01 11:46:24",
+    "chef_resource_completed_at": "2019-04-01 11:46:24",
+    "chef_resource_status": "updated",
+    "chef_node_ipv4": "172.17.0.2",
+    "chef_node_instance_id": "default-ubuntu-1604",
+    "chef_node_role": "elasticsearch",
+    "chef_run_id": "133e4189",
+    "chef_run_name": "2019-04-01 11:46:18 elasticsearch 172.17.0.2 133e4189",
+    "chef_run_started_at": "2019-04-01 11:46:18",
+    "chef_run_completed_at": "2019-04-01 11:46:24",
+    "chef_run_success": true
+  },
+
+  #...
+]
+```
+
+You can configure SousVide in the recipe:
+
+```ruby
+require "sous_vide"
+json_http = SousVide::Outputs::JsonHTTP.new(url: "http://elasticsearch:3000")
+SousVide::Handler.instance.sous_output = json_http
+SousVide::Handler.register(node.run_context)
+```
+
+Open `cookbooks/sous_vide/recipes/install.rb` to see how to configure other outputs or use more than one.
+
+SousVide output can be any object that responds to `call` method (a simple proc is valid too) with the following parameters:
+
+```ruby
+def call(run_data:, node_data:, resources_data:)
+  # ... something interesting
+end
+```
+
+## Demo
+
+This repository comes with `kitchen` setup you can use out of the box to see SousVide in action.
+
+Run `bundle exec kitchen converge default` to provision a docker container with ELK stack using `chef-client` & SousVide.
+
+Once `chef-client` finishes converging you can access a Kibana dashboard and see all the information SousVide collected during the run at `http://localhost:5601/app/kibana#/dashboard/cba01d00-5383-11e9-90a1-a5ec6cbc0c49`.
+
+There are more example kitchen configurations you can converge and see the runs in Kibana. You can change the default recipe, converge again and see it in Kibana.
+
+## Contributing
+
+Bug reports, suggestions and pull requests are welcome on GitHub.
+
+More and better kitchen (longer, more real-world) suites or dashboard improvements will be greatly appreciated.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).