varnish_rest_api 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51ea11f88e1b5c03c9bf2ff42432c4eb14f6c10b
+  data.tar.gz: cf4faad7e206ec9cdf52ee40379593f7070689bd
+SHA512:
+  metadata.gz: 9e3e2e865b03b00495ad4e4e12db73943a2967776d76881f866308ca79ed3ac5794f74350b5e61e5d77d90dbae9e7fbe58209ed78f88f7073af69e9a5843bc7d
+  data.tar.gz: 782a08d98d20563567b1ab9b26b35f07307e882332c087f7d984e71c12be5cf6f099614c6485698f10e8e76f08c479a468f1f1bd5a8b2ddca85fb6f445fa9fcb

data/.buildpath

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<buildpath>
+	<buildpathentry kind="src" path=""/>
+	<buildpathentry kind="con" path="org.eclipse.dltk.launching.INTERPRETER_CONTAINER"/>
+</buildpath>

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.project

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in varnish_rest_api.gemspec
+gemspec

data/Gemfile.orig

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+gem 'json'
+gem 'rest-client'
+gem 'sinatra'
+gem 'zk'
+
+group :development do
+    gem 'rerun'
+    gem 'thin'
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jonathan Colby
+
+MIT License
+
+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,208 @@
+# varnish-rest-api
+
+## Overview
+
+A small RESTful HTTP API for [Varnish](<https://www.varnish-cache.org>) written with [Sinatra](<http://www.sinatrarb.com/intro.html>).  It is designed to be run on the varnish node(s) since it executes varnishadm on the varnish node itself.  It can be started as a stand-alone server using Thin, or as a rack-aware application.  
+
+#### Features
+
+* REST calls output JSON 
+* (optional) use zookeeper to register varnish nodes
+* configurable with a yaml configuration file and sane defaults
+
+
+## Getting Started
+
+### Installing
+
+*NOTE: It is recommended to use a ruby version manager such as [rvm](<https://rvm.io/>) instead of installing with the system ruby. With a ruby version manager, you can prevent "contaminating" your system-level ruby installation by creating an isolated ruby environment independent of system-installed ruby libraries. Plus, on some systems, installing gems at the system level may require root privileges.*
+
+```
+gem install varnish_rest_api
+```
+
+### Configuration
+
+Configuration settings are stored in a file called **varnish_rest_api.yaml**. The default, example configuration can be found in the [github](<https://github.com/joncolby/varnish_rest_api/tree/master/lib>) repo or on your local system in the installed gem location.
+
+This file is search for in the following paths in this order.  The first file found is used:
+
+* **/etc/varnish_rest_api.yaml**
+* **HOME-DIR-OF-PROCESS-USER/varnish_rest_api.yaml**
+* **GEMFILE-PATH/lib/varnish_rest_api.yaml**
+
+To locate and copy the default yaml configuration:
+
+```
+$gem contents varnish_rest_api |grep yaml$
+..
+/usr/lib/ruby/gems/1.8/gems/varnish_rest_api-0.0.2/lib/varnish_rest_api.yaml
+..
+
+$cp /usr/lib/ruby/gems/1.8/gems/varnish_rest_api-0.0.2/lib/varnish_rest_api.yaml ~/
+
+```
+
+copy the secret file:
+
+```
+sudo cp /etc/varnish/secret ~
+sudo chown <username> ~/secret
+sudo chmod 0600 ~/secret
+```
+
+*(defaults configured in the application)*
+```
+---
+port: 10001  <-- port server will run on  (standalone mode)
+bind_ip: '0.0.0.0'   <-- this will bind the server to all interfaces (standalone mode)
+secret: /etc/varnish/secret  <-- IMPORTANT. This must be a valid,readable path to the varnish "secret" file
+mgmt_port: 6082  <-- varnish management port
+mgmt_host: localhost <-- varnish management ip
+varnishadm_path: /usr/bin/varnishadm  <-- path to varnishadm binary
+instance: default  <-- if more than one instance configured, specify instance name
+use_zookeeper: false  <-- zookeeper can be used to report available vanrish nodes
+zookeeper_host: zookeeper_host:2181
+zookeeper_basenode: /varnish
+```
+
+
+### Running
+
+
+#### Standalone executable
+
+An executable script is included in the gem and will be added to your $PATH after installation. The standalone executable uses Thin/WEBrick.
+
+```
+$ varnishrestapi.rb
+
+using configuration file: /home/vagrant/.rvm/gems/ruby-2.2.1@gemtest/gems/varnish_rest_api-0.0.2/lib/varnish_rest_api.yaml
+varnishadm command line: /usr/bin/varnishadm -T localhost:6082 -S /home/vagrant/secret
+[2015-03-27 14:17:58] INFO  WEBrick 1.3.1
+[2015-03-27 14:17:58] INFO  ruby 2.2.1 (2015-02-26) [x86_64-linux]
+== Sinatra (v1.4.6) has taken the stage on 10001 for development with backup from WEBrick
+[2015-03-27 14:17:58] INFO  WEBrick::HTTPServer#start: pid=14591 port=10001
+```
+
+#### Rackup
+
+create a config.ru file with the following contents:
+
+```
+require 'rubygems'
+require 'sinatra'
+set :environment, ENV['RACK_ENV'].to_sym
+disable :run, :reload
+require 'varnish_rest_api'
+run VarnishRestApi
+```
+
+Start server with the rackup command:
+
+```
+$ rackup -p10001 --host 0.0.0.0 config.ru
+using configuration file: /etc/varnish_rest_api.yaml
+varnishadm command line: /usr/bin/varnishadm -T localhost:6082 -S /home/vagrant/secret
+Thin web server (v1.6.3 codename Protein Powder)
+Maximum connections set to 1024
+Listening on 0.0.0.0:10001, CTRL+C to stop
+192.168.33.1 - - [28/Mar/2015:14:36:18 +0000] "GET / HTTP/1.1" 200 1905 0.0199
+```
+#### Example using Nginx/Passenger
+
+Install nginx with passenger support.  Excellent documentation available here: [Passenger documentation](<https://www.phusionpassenger.com/documentation/Users%20guide%20Nginx.html#bundler_support>) and [nginx centos how-to](<https://www.digitalocean.com/community/tutorials/how-to-compile-nginx-from-source-on-a-centos-6-4-x64-vps>)
+
+##### Concise How-to (nginx yum installation method)
+
+Install passenger gem:
+
+```
+$gem install passenger
+```
+
+configure passenger support for nginx with provided script:
+
+```
+$passenger-install-nginx-module
+```
+
+create the following directory structure for the application:
+
+```
+/var/www/varnishapi
+  |
+  +-- config.ru <-- see rackup example above for contents
+  |
+  +-- public/
+  |
+  +-- tmp/
+```
+
+make sure these lines are in your nginx.conf:
+
+```
+...
+http {
+
+    types_hash_bucket_size 64;
+    server_names_hash_bucket_size 128;
+
+    passenger_root /home/vagrant/.rvm/gems/<your-active-rvm-ruby>/gems/passenger-5.0.5;
+    passenger_ruby /home/vagrant/.rvm/gems/<your-active-rvm-ruby>/wrappers/ruby
+...
+
+...
+server {
+        listen       80;
+        server_name  localhost;
+
+        root /var/www/varnishapi/public;
+        passenger_enabled on;        
+...        
+```
+
+start nginx and verify running processes:
+
+```
+$ passenger-memory-stats
+...
+----- Passenger processes -----
+PID    VMSize    Private  Name
+-------------------------------
+14717  351.3 MB  0.9 MB   PassengerAgent watchdog
+14720  628.9 MB  1.4 MB   PassengerAgent server
+14725  222.9 MB  0.8 MB   PassengerAgent logger
+14741  285.7 MB  2.2 MB   Passenger AppPreloader: /var/www/varnishapi
+14761  354.4 MB  12.2 MB  Passenger RubyApp: /var/www/varnishapi/public
+14768  354.5 MB  9.8 MB   Passenger RubyApp: /var/www/varnishapi/public
+14775  352.6 MB  2.3 MB   Passenger RubyApp: /var/www/varnishapi/public
+...
+```
+
+### Usage Documentation
+The usage documentation is available at the root context:
+
+```
+http://your-ip-address:10001/
+```
+
+### WORD OF WARNING!
+
+This small web application is meant to run in an controlled environment and offers no encryption or authentication.  Anyone who can access the Rest API can potentially remove all of your varnish backends or overload your vanish process with calls to the "varnishadm" command. Use at your own risk!
+
+
+
+### RESTful API Actions
+ 
+
+
+| Method  | Url | Description | Remarks | 
+|------|------|------|------|
+| GET | /list   | list all backends | read-only |
+| GET | /ping | ping varnish process  | read-only | 
+| GET | /banner | display varnish banner with version information | read-only |
+| GET | /status | display status of varnish process | read-only | 
+| GET | /ban | ban all objects immediately | effectively purges objects. See varnish [documentation](<https://www.varnish-cache.org/docs/3.0/tutorial/purging.html>) | 
+| GET | /*backend*/in | sets backend health to "auto", allowing probe to decide if backend is healthy | use partial or complete backend name as it appears in VCL. The Rest API will not process request if more than one backend is found matching for the pattern |  
+| GET | /*backend*/out | sets backend health to "sick" | use partial or complete backend name as it appears in VCL. The Rest API will not process request if more than one backend is found matching for the pattern|  

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/varnishrestapi.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'varnish_rest_api'
+
+VarnishRestApi.run!

data/examples/config.ru

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'sinatra'
+
+set :environment, ENV['RACK_ENV'].to_sym
+disable :run, :reload
+
+require 'varnish_rest_api'
+
+run VarnishRestApi

data/lib/varnish_rest_api/varnish_base.rb

@@ -0,0 +1,199 @@
+
+require 'open3'
+require 'json'
+require 'ostruct'
+require 'zk'
+require 'socket'
+
+
+class VarnishBase
+
+  def initialize(params = {})
+    @mgmt_port = params.fetch(:mgmt_port, 6082)
+    @mgmt_host = params.fetch(:mgmt_host, 'localhost')
+    @instance = params.fetch(:instance, 'default')
+    @use_zookeeper = params.fetch(:use_zookeeper, false)
+    @zookeeper_host = params.fetch(:zookeeper_host, nil)
+    @zookeeper_basenode = params.fetch(:zookeeper_basenode, '/varnish')
+    @secret = params.fetch(:secret, '/etc/varnish/secret')
+    @varnishadm_path = params.fetch(:varnishadm_path, '/usr/bin/varnishadm')
+    @varnishadm = "#{@varnishadm_path.to_s} -T #{@mgmt_host.to_s}:#{@mgmt_port.to_s} -S #{@secret.to_s}"
+    @hostname = Socket.gethostname
+
+    puts "varnishadm command line: " + @varnishadm.to_s
+
+    if @use_zookeeper && !@zookeeper_host.empty?
+      puts "configured to use use zookeeper"
+      begin
+        @zk = ZK.new(@zookeeper_host)
+      rescue RuntimeError => e
+          abort "problem connecting to zookeeper host: #{@zookeeper_host}"
+      end
+        
+      begin         
+        @zk.create(@zookeeper_basenode + '/' + @hostname, @hostname, :mode => :ephemeral_sequential)
+      rescue ZK::Exceptions::NoNode => zke
+        @zk.create(@zookeeper_basenode,'', :mode => :persistent)
+      end
+    end
+    
+  end
+  
+  def output(result)
+    result[:error].empty? ? result[:output] : result[:error]
+  end
+  
+  def varnish_major_version
+    varnishadm("banner")[:output].each do |d|
+      m = /^varnish-([0-9]+).*/.match(d)
+      unless m.nil? 
+        return m[1].to_i
+      end
+    end
+    return 0 
+  end
+
+  # banning has the effect of purging content
+  # https://www.varnish-software.com/static/book/Cache_invalidation.html#banning
+  def ban_all 
+    command = varnish_major_version >= 4 ?  '\'ban req.url ~ .\'' :  '\'ban.url .\'' 
+    result = output(varnishadm(command))
+    JSON.pretty_generate({ command => result.empty? ? "command successful" : result })
+  end
+  
+  # ping
+  def ping
+    JSON.pretty_generate({ 'ping' => output(varnishadm("ping")) })
+  end
+  
+  # backend enable/disable
+   def set_health(backend,health,options={})
+    default_options = {
+     :safe => true,
+     :json => false
+     }    
+    options = default_options.merge!(options)
+
+    unless ["sick","auto"].include?(health)
+      error = { 'error' => "invalid health '#{health}'. health must be 'sick' or 'auto'"}
+      return options[:json] ? JSON.pretty_generate(error) : error 
+    end
+    
+    backends_found = list_backends(:expression => backend)
+
+    if options[:safe] && backends_found.size > 1
+      error = { 'error' => "multiple backends found for pattern '#{backend}': " +  backends_found.collect { |b| b.backend_name }.join(',')}
+      return  options[:json] ? JSON.pretty_generate(error) : error
+    end
+    
+    varnishadm("backend.set_health #{backend} #{health}")    
+    list_backends(:expression => backend, :json => options[:json])
+  end
+   
+  # list backends   
+  def list_backends(options={})
+   default_options = {
+    :expression => nil,
+    :json => false
+    }
+    options = default_options.merge!(options)
+    backends = Array.new
+    command = "backend.list"
+    
+    unless options[:expression].nil? || options[:expression].empty?
+      command += " #{options[:expression]}"
+    end
+    
+    varnishadm_result = varnishadm(command)
+    #puts "command => " + command
+    
+    unless varnishadm_result[:error].empty?
+      return options[:json] ? JSON.pretty_generate(varnishadm_result[:error]) : varnishadm_result[:error]
+    end
+    
+    varnishadm_result[:output].to_a.each_with_index do |line,i|
+    #varnishadm(command)[:output].to_a.each_with_index do |line,i| 
+      next if i < 1
+      backend = OpenStruct.new
+      #server1(127.0.0.1,80) 1 probe Sick 0/5 
+      #line = "server1(127.0.0.1,80) 1 probe Sick 0/5"
+      components = line.squeeze.split
+      host_re = /(.*?)\((.*?)\)\s+(\d+)\s+(.*?)\s+(.*)/
+      match = host_re.match(line)
+      backend.backend_name = match[1].to_s
+      backend.host = match[2].to_s
+      backend.refs = match[3].to_s
+      backend.admin = match[4].to_s
+      backend.health = match[5].to_s
+      backends << backend
+    end
+    options[:json] ? JSON.pretty_generate(backends.map { |o| Hash[o.each_pair.to_a] }) : backends
+  end
+  
+  # Display the varnish banner
+  def banner
+    JSON.pretty_generate({ 'banner' => output(varnishadm("banner"))})
+  end
+  
+  # Display the current status of the varnish process
+  def status
+    JSON.pretty_generate({ 'status' => output(varnishadm("status"))}) 
+  end
+  
+  # Run the varnishadm command and capture and return stdout,stderr
+  def varnishadm(cmd)  
+    output = Array.new 
+    error = Array.new  
+    begin
+      Open3.popen3(@varnishadm + ' ' + cmd) do |stdin, stdout, stderr, wait_thr|        
+
+        exit_status = wait_thr.value
+        
+        unless exit_status.success?
+          #raise
+          $stderr.puts "varnishadm exited with code #{exit_status.exitstatus}"
+          while line = stderr.gets
+            $stderr.puts line
+            if line.strip.length > 0
+              error << line.strip
+            end
+          end
+        end
+        
+        while line = stdout.gets
+          if line.strip.length > 0          
+            output << line.strip
+          end
+        end        
+      end
+      
+    rescue Errno::ENOENT => e
+      $stderr.puts "error running varnishadm: #{e.message}"
+      error << "error running varnishadm: #{e.message}"
+      output << "error running varnishadm: #{e.message}"
+    end
+    
+    return { :output => output, :error => error}      
+  end
+
+  def to_s
+    "instance #{@instance}"
+  end
+  
+  private :varnishadm, :varnish_major_version, :output
+  
+end
+
+
+=begin
+v = Varnish.new
+puts v.status
+puts "="
+puts v.banner
+puts "="
+puts v.list_backends(:expression => "server3", :json=>true)
+puts "="
+puts v.list_backends
+=end
+
+

data/lib/varnish_rest_api/version.rb

@@ -0,0 +1,3 @@
+module VarnishRestApi
+  VERSION = "0.0.4"
+end

data/lib/varnish_rest_api.rb

@@ -0,0 +1,152 @@
+require 'sinatra/base'
+require 'varnish_rest_api/varnish_base'
+require 'yaml'
+
+class VarnishRestApi < Sinatra::Application
+  
+CONFIG_FILE = "varnish_rest_api.yaml"
+CONFIG_PATHS = [ '/etc/' + CONFIG_FILE, ENV['HOME'] + '/' + CONFIG_FILE , File.dirname(__FILE__) + '/' + CONFIG_FILE ]
+CONFIG = CONFIG_PATHS.detect {|config| File.file?(config) }
+  
+if !CONFIG
+  $stderr.puts "no configuration file found in paths: " + CONFIG_PATHS.join(',')
+  exit!
+else
+  puts "using configuration file: " + CONFIG
+end
+
+config_parsed = begin
+  YAML.load(File.open(CONFIG))
+rescue ArgumentError, Errno::ENOENT => e
+  $stderr.puts "Exception while opening yaml config file: #{e}"
+  exit!
+end
+
+config_file = Hash.new
+begin
+  config_file = config_parsed.inject({}){|h,(k,v)| h[k.to_sym] = v; h}
+rescue NoMethodError => e
+  $stderr.puts "error parsing configuration yaml"
+end
+
+# default configuration
+config_default = {
+  :bind_ip => '0.0.0.0',
+  :port => 4567,
+  :mgmt_port => 6082,
+  :mgmt_host => 'localhost',
+  :secret => '/etc/varnish/secret',
+  :varnishadm_path => '/usr/bin/varnishadm',
+  :instance => "default",
+  :use_zookeeper => false,
+  :zookeeper_host => nil,
+  :zookeeper_basenode => '/varnish'  
+}
+
+config = config_default.merge!(config_file)
+
+varnish = VarnishBase.new(:instance => config[:instance], \
+  :zookeeper_host => config[:zookeeper_host], \
+  :use_zookeeper => config[:use_zookeeper], \
+  :zookeeper_basenode => config[:zookeeper_basenode], \
+  :secret => config[:secret], \
+  :mgmt_port => config[:mgmt_port], \
+  :mgmt_host => config[:mgmt_host], \
+  :varnishadm_path => config[:varnishadm_path])
+
+# sinatra configuration
+configure do
+  set :root, File.dirname(__FILE__)
+  set :bind, config[:bind_ip]
+  set :port, config[:port]
+  set :server, %w[thin mongrel webrick]
+  set :show_exceptions, true
+end
+  
+before do
+  content_type :json
+end
+
+not_found do
+  content_type :html
+  @status = status.to_i
+  erb :help
+end
+
+helpers do
+end
+
+error do
+  'Sorry there was a nasty error - ' + env['sinatra.error'].name
+end
+
+['/', '/help', '/usage'].each do |route|
+get route do
+  content_type :html
+  erb :help
+end
+end
+
+# display the varnish banner containing varnish version information
+get '/banner' do
+  varnish.banner
+end
+
+# run varnishadm ping call to varnish
+get '/ping' do
+  varnish.ping
+end
+
+# report the status of the varnish process
+get '/status' do
+  varnish.status
+end
+
+# display all backends and state
+get '/list' do
+  varnish.list_backends(:json => true)
+end
+
+# purge cache objects using the ban feature
+get '/ban' do
+  varnish.ban_all
+end
+
+# set the health of a backend.  Acceptable actions are "sick" and "auto". Auto indicates the varnish probe should decide whether to send traffic to this backend based on probe health
+# only one backend at a time can be changed. This is a safety feature due to varnish-cli greedy and unpredictable expression pattern matching.
+get %r{^/(.*?)/(in|out)$} do  
+  backend = params[:captures].first
+  action = params[:captures].last
+  health = action == 'out' ? 'sick' : 'auto'
+  backends = varnish.set_health(backend,health)
+
+    if backends.empty?
+      content_type :html
+      halt 400, erb(:error, :locals => { :message => "No backend found for pattern #{backend}"}) 
+    elsif backends.class == Hash && backends.has_key?("error")
+      content_type :html
+      error = backends['error']
+      halt 400, erb(:error, :locals => { :message => error}) 
+    end
+  redirect to('/list') 
+end
+
+=begin
+v = Varnish.new
+puts v.status
+puts "="
+puts v.banner
+puts "="
+puts v.list_backends(:expression => "server3", :json=>true)
+puts "="
+puts v.list_backends(:expression => "server2",:json=>true) 
+puts v.set_health("server11","sick")
+puts v.set_health("server3","auto")
+puts v.set_health("server","auto",false)
+puts "="
+puts v.ping
+puts "="
+puts v.ban_all
+=end
+run! if app_file == $0
+end

data/lib/varnish_rest_api.yaml

@@ -0,0 +1,11 @@
+---
+port: 10001
+bind_ip: '0.0.0.0'
+secret: /home/vagrant/secret
+mgmt_port: 6082
+mgmt_host: localhost
+varnishadm_path: /usr/bin/varnishadm
+instance: default
+use_zookeeper: false
+zookeeper_host: autodeploy38-2:2181
+zookeeper_basenode: /varnish

data/lib/views/error.erb

@@ -0,0 +1,9 @@
+<html>
+<style>
+h2 {
+    text-align: center;
+    color: red;
+}
+</style>
+<h2><%= message %></h2>
+</html>

data/lib/views/help.erb

@@ -0,0 +1,91 @@
+<html>
+<style>
+h2 {
+    text-align: center;
+    color: red;
+}
+h1 {
+    text-align: left;
+}
+table {
+    border-spacing: 5px;
+}
+tr:nth-child(even) {
+    background-color: #eee;
+}
+tr:nth-child(odd) {
+    background-color: #fff;
+}
+th {
+    text-align: left;
+    color: white;
+    background-color: black;
+} 
+</style>
+<% if status == 404 %>
+<h2>Error: <%= request.path_info %> is not a valid url</h2>
+<% end %>
+
+
+
+<table>
+<caption><h3>Varnish REST API help</h3></caption>
+  <tr>
+    <th>Method</th>
+    <th>URL</th>
+    <th>Description</th>
+    <th>Remarks</th>
+  </tr>
+  
+    <tr>
+    <td>GET</td>
+    <td>/list</td>
+    <td>list all backends</td>
+    <td>read-only</td>
+  </tr>
+  
+     <tr>
+    <td>GET</td>
+    <td>/ping</td>
+    <td>ping varnish process</td>
+    <td>read-only</td>
+  </tr>
+  <tr>
+    <td>GET</td>
+    <td>/banner</td>
+    <td>display varnish banner with version information</td>
+    <td>read-only</td>
+  </tr>
+  
+    <tr>
+    <td>GET</td>
+    <td>/status</td>
+    <td>display status of varnish process</td>
+    <td>read-only</td>
+  </tr>
+  
+      <tr>
+    <td>GET</td>
+    <td>/ban</td>
+    <td>ban all objects immediately</td>
+    <td>effectively purges objects. See <a href="https://www.varnish-cache.org/docs/3.0/tutorial/purging.html">here</a> and <a href="https://www.varnish-software.com/static/book/Cache_invalidation.html">here</a></td>
+  </tr>
+  
+   <tr>
+    <td>GET</td>
+    <td>/{backend}/in</td>
+    <td>sets backend health to "auto", allowing probe to decide if backend is healthy</td>
+    <td>use partial or complete backend name as it appears in VCL. The Rest API will not process request if more than one backend is found matching for the pattern</td>
+  </tr>
+   <tr>
+    <td>GET</td>
+    <td>/{backend}/out</td>
+    <td>sets backend health to "sick"</td>
+    <td>use partial or complete backend name as it appears in VCL. The Rest API will not process request if more than one backend is found matching for the pattern</td>    
+  </tr>
+<tr>
+</tr>
+</table>
+
+
+</html>

data/varnish_rest_api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'varnish_rest_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "varnish_rest_api"
+  spec.version       = VarnishRestApi::VERSION
+  spec.authors       = ["Jonathan Colby"]
+  spec.email         = ["jcolby@team.mobile.de"]
+  spec.summary       = %q{A sinatra rest api for varnish.}
+  spec.description   = %q{A restful http api for setting backend health, banning cache objects and getting status information. Executes varnishadm via http rest calls.}
+  spec.homepage      = "http://rubygems.org/gems/varnish_rest_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         << ["bin/varnishrestapi.rb"]
+  spec.files         << ["examples/config.ru"]
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "sinatra"
+  spec.add_dependency "zk"
+  spec.add_dependency "zookeeper"
+  spec.add_dependency "json"
+  
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: varnish_rest_api
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Jonathan Colby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zookeeper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A restful http api for setting backend health, banning cache objects
+  and getting status information. Executes varnishadm via http rest calls.
+email:
+- jcolby@team.mobile.de
+executables:
+- varnishrestapi.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".buildpath"
+- ".gitignore"
+- Gemfile
+- Gemfile.orig
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/varnishrestapi.rb
+- examples/config.ru
+- lib/varnish_rest_api.rb
+- lib/varnish_rest_api.yaml
+- lib/varnish_rest_api/varnish_base.rb
+- lib/varnish_rest_api/version.rb
+- lib/views/error.erb
+- lib/views/help.erb
+- varnish_rest_api.gemspec
+homepage: http://rubygems.org/gems/varnish_rest_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A sinatra rest api for varnish.
+test_files: []
+has_rdoc: