elasticshelf 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17341df9c00b09d1a9627fedc1b198469cdd7873
-  data.tar.gz: 32c212f38fe54af22d16159dfadfe5948bafc226
+  metadata.gz: d7968094ac39d4574712c7eb852c759f1937a276
+  data.tar.gz: 3212b4fb19424ed90dcc19f4a4c07979629c8827
 SHA512:
-  metadata.gz: 309f27d6d4b3bdc13222b2ab84f9d578ab1f0882abb2a8e86d7a657854e8084e8921ad1d46c700e86a039c96b033b9541c67d99c4958e381a80b136b38a6fdd1
-  data.tar.gz: 646a30138b4cdea5c0d1f99dd9a2c8b2b255a0ae29d820eca3f6d632ccec048797664a9216f2f61756fe94386824281004951a32204fd45f737cddfb67939a2c
+  metadata.gz: bb262605adb4b05ddb5d2919d480f77b30c56a6d959f33fe0cc8e61e0866109ee3382c3826267df1b5df9d5881d5c555754e0ced1afdc4de0e025f65534ff928
+  data.tar.gz: 5cdae33b76fe925e5cdba056490c13741010f6b9c260e2c273a3264e814ed6f46d2f0d4e42e7397f4dbfc47656f7089b58ff03586d950a474ffc67a50a968553

data/README.md

@@ -1,14 +1,15 @@
 # Elasticshelf
 
-Ruby integrations for Elasticsearch indices management using close, delete, snapshot and restore.
+Manage Elasticsearch indices using wither, close, open, delete, snapshot, and restore.
 
-Inspired by Curator at https://github.com/elasticsearch/curator.git, but if
-you are an ophidiophobe, no worries, this is written in Ruby :-)
+Most of the index actions can be performed by setting an expiry via cutoff days.
 
-Honestly, there is nothing special here that can not already be done with the elasticsearch-ruby gem,
-but it's just packaged up as a convenience gem.
+The gem may be used within a Rails app or in a Ruby script for cron jobs.
 
-The goal is to perform the following on Elasticsearch indices:
+> Note: this is inspired by Curator at https://github.com/elasticsearch/curator.git,
+> but if you are an ophidiophobe, no worries, this is written in Ruby :-)
+
+The following actions may be performed on Elasticsearch indices:
   * **wither** (i.e. disable bloom filter)
   * **close**
   * **open**
@@ -152,7 +153,7 @@ es.snapshot_expired_indices
 es.indices = "index1" ... single
 es.indices = "index1,index2" ... multiples
 es.repo = 'name_of_the_snapshot_repository'
-es.snapshot = 'name_of_this_snapshot'
+es.snapshot = 'name_of_the_snapshot'
 es.snapshot_expired_indices
 ```
 
@@ -168,7 +169,7 @@ es.snapshot_get
 ### Snapshot delete
 
 ```
-es.snapshot = 'name_of_this_snapshot'
+es.snapshot = 'name_of_the_snapshot'
 es.snapshot_delete
 ```
 
@@ -176,8 +177,12 @@ es.snapshot_delete
 
 ```
 es.repo = 'name_of_the_snapshot_repository'
-es.snapshot = "name_of_this_snapshot"
-es.indices = "index1"
+es.snapshot = "name_of_the_snapshot"
+- do one of these:
+  1. es.indices = "" # restores all indices in the snapshot
+  2. es.indices = "index1,index2" # restore multiple indices
+  3. es.indices = "index1" # restore a single index
+  - note: es.snapshot_get can be used to list indices in a snapshot
 es.snapshot_restore
 puts "errors=#{es.errors.inspect}"
 puts "results=#{es.results.inspect}"
@@ -201,8 +206,37 @@ es.version ... of this gem
 * can not snapshot a closed index
 * can not restore an open index from a snapshot
 * deleting all (i.e. '*' or '_all') indices is not allowed
-* both es.errors and es.results should be checked after most usage
-* exceptions are not re-raised from the elasticsearch-ruby gem, but the class/message are echoed in es.errors
+* both es.errors and es.results should be checked after any action
+* exceptions are not re-raised from the elasticsearch-ruby gem, but the exception's class+message are copied into es.errors
+* the following defaults are set, but may be overridden:
+  * es.wait_for_completion = true
+  * es.ignore_unavailable = true
+  * es.include_global_state = false
+  * es.date_separator = '.'
+  * es.indices_prefix = 'logstash-'
+  * es.repo_type = 'fs'
+  * es.repo_compressed = true
+
+### Actions
+1. **get_settings_index** name
+1. **find_expired_indices**
+1. **open_index** name
+1. **index_closed?** name
+1. **close_index** name
+1. **close_expired_indices**
+1. **delete_index** name
+1. **delete_expired_indices**
+1. **wither_index** name
+1. **wither_expired_indices**
+1. **snapshot_create_repository**
+1. **snapshot_get_repository**
+1. **snapshot_delete_repository**
+1. **snapshot_expired_indices**
+1. **snapshot_create**
+1. **snapshot_get**
+1. **snapshot_delete**
+1. **snapshot_restore**
+
 
 ## Contributing
 

data/lib/elasticshelf.rb

@@ -9,30 +9,33 @@ module Elasticshelf
 
     attr_reader :get_info, :version
 
-    attr_reader :expired_indices, :indices_affected, :indices_rejected, :indices_closed, :indices_deleted, :indices_withered
+    attr_reader :indices_expired, :indices_affected, :indices_rejected, :indices_closed, :indices_deleted, :indices_withered
 
     attr_accessor :indices_prefix, :date_separator, :cutoff_days
 
-    attr_accessor :repo, :repo_type, :repo_location, :repo_compressed, :snapshot, :indices
+    attr_accessor :repo, :repo_type, :repo_location, :repo_compressed
+
+    attr_accessor :snapshot, :indices
 
     attr_accessor :wait_for_completion, :ignore_unavailable, :include_global_state
 
-    attr_accessor :snapshot_expired_indices_name
+    attr_accessor :snapshot_indices_expired_name
 
     def new(arguments={})
       @client = Elasticsearch::Transport::Client.new(arguments)
       @wait_for_completion = true
       @ignore_unavailable = true
       @include_global_state = false
-      @snapshot_expired_indices_name = nil
+      @snapshot_indices_expired_name = nil
       @date_separator = '.'
       @indices_prefix = 'logstash-'
       @cutoff_days = -1
       @repo_type = 'fs'
       @repo_compressed = true
+      @indices = []
       @indices_affected = {}
       @indices_rejected = {}
-      @expired_indices = {}
+      @indices_expired = {}
       @indices_closed = {}
       @indices_deleted = {}
       @indices_withered = {}
@@ -52,7 +55,7 @@ module Elasticshelf
         return {} if blank? @date_separator
         return {} if @cutoff_days.nil?
         return {} if @cutoff_days.to_i < 0
-        @expired_indices = {}
+        @indices_expired = {}
         # cutoff_date = cutoff_days_as_date
         # cutoff_date_beginning_of_day = set_time_to_beginning_of_day(cutoff_date.strftime("%Y.%m.%d"))
         cutoff_date_beginning_of_day = cutoff_days_as_date
@@ -68,7 +71,7 @@ module Elasticshelf
           index_time = set_time_to_beginning_of_day(unprefixed_index_name, separator=@date_separator)
           expiry = (cutoff_date_beginning_of_day - index_time).to_i
           if expiry > 0
-            @expired_indices[index_name] = expiry
+            @indices_expired[index_name] = expiry
           end
         end
       end
@@ -95,8 +98,8 @@ module Elasticshelf
     end
 
     def close_expired_indices
-      find_expired_indices if blank? @expired_indices
-      @expired_indices.each do |k,v|
+      find_expired_indices if blank? @indices_expired
+      @indices_expired.each do |k,v|
         close_index(k)
         puts "closed index '#{k}' expired #{v} days ago"
       end
@@ -114,8 +117,8 @@ module Elasticshelf
 
     def delete_expired_indices
       reset_errors_results
-      find_expired_indices if blank? @expired_indices
-      @expired_indices.each do |k,v|
+      find_expired_indices if blank? @indices_expired
+      @indices_expired.each do |k,v|
         delete_index(k)
         puts "deleted '#{k}' expired #{v} days ago"
       end
@@ -142,8 +145,8 @@ module Elasticshelf
 
     def wither_expired_indices
       reset_errors_results
-      find_expired_indices if blank? @expired_indices
-      @expired_indices.each do |k,v|
+      find_expired_indices if blank? @indices_expired
+      @indices_expired.each do |k,v|
         wither_index(k)
         puts "withered '#{k}' expired #{v} days ago"
       end
@@ -204,12 +207,12 @@ module Elasticshelf
     def snapshot_expired_indices
       @results = @errors = {}
       find_expired_indices
-      if blank? @expired_indices
+      if blank? @indices_expired
         @results = {"result" => "no expired indices found"}
         return
       end
       open_indices = []
-      @expired_indices.keys.each do |index_name|
+      @indices_expired.keys.each do |index_name|
         # only open indices can be used in a snapshot:
         if index_closed?(index_name)
           @indices_rejected[index_name] = "closed index can't snapshot"
@@ -224,28 +227,14 @@ module Elasticshelf
       end
       @indices = open_indices.join(',')
       # allow user to override this name:
-      if blank? @snapshot_expired_indices_name
+      if blank? @snapshot_indices_expired_name
         @snapshot = (Time.now.utc.to_s.gsub(' ', '_') +
                      "_#{@indices_prefix.chomp('*')}" +
                      "_cutoff_#{@cutoff_days}_days").downcase
       else
-        @snapshot = @snapshot_expired_indices_name
+        @snapshot = @snapshot_indices_expired_name
       end
       @results = snapshot_create
-      # {"snapshot"=>{
-      #   "snapshot"=>"2014-04-02_19:23:35_utc_logstash-_cutoff_22_days",
-      #   "indices"=>[],
-      #   "state"=>"SUCCESS",
-      #   "start_time"=>"2014-04-02T19:23:35.715Z",
-      #   "start_time_in_millis"=>1396466615715,
-      #   "end_time"=>"2014-04-02T19:23:35.721Z",
-      #   "end_time_in_millis"=>1396466615721,
-      #   "duration_in_millis"=>6,
-      #   "failures"=>[],
-      #   "shards"=>{"total"=>0, "failed"=>0, "successful"=>0}
-      # }}
-      # @results['snapshot']['state'].downcase == 'success'
-      # @results['snapshot']['failures']
     end
 
     def snapshot_create
@@ -295,30 +284,31 @@ module Elasticshelf
     end
 
     def snapshot_restore
-      if blank? @indices
-        @results = {"error" => "indices must be specified to restore from a snapshot"}
-        return
-      end
       try do
-        # @example Restore from the `snapshot-1` snapshot
-        #     client.snapshot.restore repository: 'my-backups', snapshot: 'snapshot-1'
-        # @example Restore a specific index under a different name
-        #     client.snapshot.restore repository: 'my-backups',
-        #                             snapshot: 'snapshot-5',
-        #                             body: {
-        #                               rename_pattern: "^(.*)$",
-        #                               rename_replacement: "restored_$1"
-        #                             }
-        @results = @client.snapshot.restore(
-          repository: @repo,
-          snapshot: @snapshot,
-          wait_for_completion: @wait_for_completion,
-          body: {
-            indices: @indices,
-            ignore_unavailable: true,
-            include_global_state: false
-          }
-        )
+        if blank? @indices
+          # the whole snapshot:
+          @results = @client.snapshot.restore(
+            repository: @repo,
+            snapshot: @snapshot,
+            wait_for_completion: @wait_for_completion,
+            body: {
+              ignore_unavailable: @ignore_unavailable,
+              include_global_state: @include_global_state
+            }
+          )
+        else
+          # note: @indices must be a string of comma separated index names
+          @results = @client.snapshot.restore(
+            repository: @repo,
+            snapshot: @snapshot,
+            wait_for_completion: @wait_for_completion,
+            body: {
+              indices: @indices,
+              ignore_unavailable: @ignore_unavailable,
+              include_global_state: @include_global_state
+            }
+          )
+        end
       end
     end
 

data/lib/elasticshelf/version.rb

@@ -1,4 +1,4 @@
 module Elasticshelf
   # Elasticshelf::VERSION
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticshelf
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - cLee Smith