ceph-ruby-livelink 1.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 156dbabee9228fe85292b28c7ab54b152d69d14d
+  data.tar.gz: 4f5e24209a2641ae76764375d34914cd32a21e9a
+SHA512:
+  metadata.gz: 919c6f08edeb98c704e37f3bc5a2c5fdac24e0ab489f1bf1e44a06c46111bacf9c2ee57b6cb57656e9e6d5fd4a45ccf55f2b462100b80a4b3e5e71043037a51b
+  data.tar.gz: e1c66b0327860078379b2971e4658bfa465cd24a3b3b542363ce6cfa3095fbdac0781bbd3dd3925e4b603b28d6029f6434c519ba7a1fdf6388cbc4fee8cf4bab

data/.cluster.example.yml

@@ -0,0 +1,19 @@
+---
+:cluster: ceph
+:config_dir: "/etc/ceph"
+:user: client.admin
+:flags: 0
+:readable: true # User has +r mon cap
+:writable: true # User has +w mon cap
+:pool:
+   :name: rspec_test
+   :create_delete: true # Means you can run create and delete on this pool {beware of dragons!}
+                        # If you accidentally set this and you have a pool with the same name it will 
+                        # delete it at the end of the rspec test!
+                        # This only works if the user has +w mon cap
+   :rule_id: 0  # Crush Ruleset id to determine where to place pools
+   :writable: true # Means this pool has read/write permissions {beware of dragons!}
+                   # If you accidentally set this to true and you have objects in your pool
+                   # that you want to keep with name = object_name, it will overwrite and then delete them!
+                   # this only works if the user has +w osd cap at least on pool[:name]
+   :object_name: rspec_test_object

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+.cluster.yml
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/FileName:
+  Enabled: false

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,20 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard 'rake', task: 'dev_test' do
+  watch(%r{^(spec|lib/.*)/.*.rb})
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 - 2013 Netskin GmbH
+
+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 @@
+Ceph-ruby are the official ruby bindings now and so were moved to the ceph organisation: https://github.com/ceph/ceph-ruby

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+task test: [:rubocop_test, :spec]
+
+task dev_test: [:rubocop_dev, :spec]

data/ceph-ruby.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ceph-ruby/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'ceph-ruby-livelink'
+  gem.version       = CephRuby::VERSION
+  gem.authors       = ['Netskin GmbH', 'Corin Langosch', 'LivelinkTechnology LTD', 'Stuart Harland']
+  gem.email         = ['info@netskin.com', 'info@corinlangosch.com', 'infraops@livelinktechnology.net', 's.harland@livelinktechnology.net']
+  gem.description   = 'Easy management of Ceph'
+  gem.summary       = 'Easy management of Ceph Distributed Storage System'
+  gem.homepage      = 'http://github.com/livelink/ceph-ruby'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($RS)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'ffi', '~> 1.9'
+  gem.add_dependency 'activesupport', '~> 3.0'
+  gem.add_development_dependency 'guard', '~> 2.13'
+  gem.add_development_dependency 'guard-rake', '~> 1.0'
+  gem.add_development_dependency 'guard-rspec', '~> 4.6'
+  gem.add_development_dependency 'guard-bundler', '~> 2.1'
+  gem.add_development_dependency 'rubocop', '~> 0.39'
+  gem.add_development_dependency 'rspec', '~> 3.4'
+  gem.add_development_dependency 'rake', '~> 11.1'
+  gem.add_development_dependency 'bundler', '~> 1.3'
+end

data/lib/ceph-ruby.rb

@@ -0,0 +1,32 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/attribute_accessors'
+
+require 'ffi'
+
+require 'ceph-ruby/lib/rados'
+require 'ceph-ruby/lib/rbd'
+
+require 'ceph-ruby/version'
+require 'ceph-ruby/cluster_helper'
+require 'ceph-ruby/pool_enumerator'
+require 'ceph-ruby/cluster'
+require 'ceph-ruby/rados_object_enumerator'
+require 'ceph-ruby/pool_helper'
+require 'ceph-ruby/pool'
+require 'ceph-ruby/rados_block_device_helper'
+require 'ceph-ruby/rados_block_device'
+require 'ceph-ruby/rados_object'
+require 'ceph-ruby/xattr'
+require 'ceph-ruby/xattr_enumerator'
+# Ceph::Ruby
+#
+# Easy management of Ceph Distributed Storage System
+# (rbd, images, rados objects) using ruby.
+module CephRuby
+  mattr_accessor :logger
+
+  def self.log(message)
+    return unless logger
+    logger.info("CephRuby: #{message}")
+  end
+end

data/lib/ceph-ruby/cluster.rb

@@ -0,0 +1,129 @@
+module CephRuby
+  # = Cluster
+  #
+  # == Synopsis
+  # A cluster object will connect to a Ceph monitor to
+  # carry out tasks or access objects from ceph
+  #
+  # == How to connect
+  # clusterA = ::CephRuby::Cluster.new
+  # clusterB = ::CephRuby::Cluster.new('/path/to/config/dir')
+  # clusterC = ::CephRuby::Cluster.new('/path/to/config/dir', options)
+  # clusterD = ::CephRuby::Cluster.new(options)
+  # === Options (with defaults)
+  #    {
+  #       config_dir: '/etc/ceph'
+  #       cluster: 'ceph',
+  #       user: 'client.admin',
+  #       flags: 0
+  #    }
+  class Cluster
+    extend CephRuby::ClusterHelper
+    include CephRuby::ClusterHelper
+    include ::Comparable
+    attr_reader :options
+    attr_accessor :handle
+
+    def initialize(config = {}, opts = {})
+      setup(config, opts)
+
+      connect
+
+      if block_given?
+        begin
+          yield(self)
+        ensure
+          shutdown
+        end
+      end
+    end
+
+    def shutdown
+      return unless handle
+      log('shutdown')
+      Lib::Rados.rados_shutdown(handle)
+      self.handle = nil
+    end
+
+    def pool(name, &block)
+      Pool.new(self, name, &block)
+    end
+
+    def pools
+      PoolEnumerator.new(self)
+    end
+
+    def pool_name_by_id(id, size = 512)
+      data_p = FFI::MemoryPointer.new(:char, size)
+      ret = Lib::Rados.rados_pool_reverse_lookup(handle,
+                                                 id,
+                                                 name,
+                                                 size)
+      raise Errno::ERANGE,
+            'buffer size too small' if ret == -Errno::ERANGE::Errno
+      raise SystemCallError.new('read of pool name failed', -ret) if ret < 0
+      data_p.get_bytes(0, ret)
+    end
+
+    def pool_id_by_name(name)
+      ret = Lib::Rados.rados_pool_lookup(handle, name)
+      raise Errno::ENOENT if ret == -Errno::ERANGE::Errno
+      raise SystemCallError.new('read of pool id failed', -ret) if ret < 0
+      ret
+    end
+
+    def connect
+      log('connect')
+      ret = Lib::Rados.rados_connect(handle)
+      raise SystemCallError.new('connect to cluster failed', -ret) if ret < 0
+    end
+
+    def setup_using_file
+      log("setup_using_file #{options[:path]}")
+      ret = Lib::Rados.rados_conf_read_file(handle, options[:path])
+      raise SystemCallError.new('setup of cluster from config file'\
+                                " '#{options[:path]}' failed", -ret) if ret < 0
+    end
+
+    def status
+      log('stat')
+      stat_s = Lib::Rados::MonitorStatStruct.new
+      ret = Lib::Rados.rados_cluster_stat(handle, stat_s)
+      raise SystemCallError.new('retrieve cluster status failed',
+                                -ret) if ret < 0
+      stat_s.to_hash
+    end
+
+    def fsid
+      log('fsid')
+      data_p = FFI::MemoryPointer.new(:char, 37)
+      ret = Lib::Rados.rados_cluster_fsid(handle, data_p, 37)
+      raise SystemCallError.new('cluster fsid failed',
+                                -ret) if ret < 0
+      data_p.get_bytes(0, ret)
+    end
+
+    private
+
+    def setup(config, opts)
+      log("init lib rados #{Lib::Rados.version_string},"\
+          " lib rbd #{Lib::Rbd.version_string}")
+      setup_options(config, opts)
+      self.handle = Cluster.setup_handle(options)
+      setup_using_file
+    end
+
+    def setup_options(config, opts)
+      @options = Cluster.default_options
+      if config.is_a?(::Hash)
+        @options.merge! config
+      else
+        @options.merge! opts
+        @options[:config_path] = config
+      end
+
+      @options[:flags] = 0 unless Cluster.uint?(@options[:flags])
+      @options.freeze
+    end
+  end
+end

data/lib/ceph-ruby/cluster_helper.rb

@@ -0,0 +1,39 @@
+module CephRuby
+  # Helper Methods for CephRuby::Cluster
+  module ClusterHelper
+    def setup_handle(options)
+      handle_p = FFI::MemoryPointer.new(:pointer)
+      ret = Lib::Rados.rados_create2(handle_p,
+                                     options[:cluster],
+                                     options[:user],
+                                     options[:flags])
+      raise SystemCallError.new('open of cluster failed', -ret) if ret < 0
+      handle_p.get_pointer(0)
+    end
+
+    def default_options
+      {
+        config_path: '/etc/ceph',
+        user: 'client.admin',
+        cluster: 'ceph'
+      }
+    end
+
+    def uint?(value)
+      value.is_a?(Integer) && value >= 0
+    end
+
+    def log(message)
+      CephRuby.log("cluster #{message}")
+    end
+
+    def <=>(other)
+      other.options <=> options
+    end
+
+    def eql?(other)
+      return false if other.class != self.class
+      self == other
+    end
+  end
+end

data/lib/ceph-ruby/lib/rados.rb

@@ -0,0 +1,158 @@
+require 'ffi'
+
+# see https://github.com/ceph/ceph/blob/v0.48.2argonaut/src/pybind/rados.py
+
+module CephRuby
+  module Lib
+    # Ruby bindings for librados
+    module Rados
+      extend FFI::Library
+
+      ffi_lib ['rados', 'librados.so.2']
+
+      attach_function 'rados_version', [:pointer, :pointer, :pointer], :void
+
+      attach_function 'rados_create', [:pointer, :string], :int
+
+      attach_function 'rados_create2', [:pointer, :string, :string,
+                                        :uint64], :int
+
+      attach_function 'rados_connect', [:pointer], :int
+
+      attach_function 'rados_conf_read_file', [:pointer, :string], :int
+
+      attach_function 'rados_shutdown', [:pointer], :void
+
+      attach_function 'rados_cluster_stat', [:pointer, :pointer], :int
+
+      attach_function 'rados_cluster_fsid', [:pointer, :buffer_out,
+                                             :size_t], :int
+
+      attach_function 'rados_pool_list', [:pointer, :buffer_out, :size_t], :int
+
+      attach_function 'rados_pool_lookup', [:pointer, :string], :int
+
+      attach_function 'rados_pool_reverse_lookup', [:pointer, :int,
+                                                    :buffer_out, :size_t], :int
+
+      attach_function 'rados_pool_create', [:pointer, :string], :int
+
+      attach_function 'rados_pool_create_with_auid', [:pointer, :string,
+                                                      :uint64], :int
+
+      attach_function 'rados_pool_create_with_crush_rule', [:pointer, :string,
+                                                            :uint8], :int
+
+      attach_function 'rados_pool_create_with_all', [:pointer, :string,
+                                                     :uint64, :uint8], :int
+
+      attach_function 'rados_pool_delete', [:pointer, :string], :int
+
+      attach_function 'rados_ioctx_pool_set_auid', [:pointer, :uint64], :int
+
+      attach_function 'rados_ioctx_pool_get_auid', [:pointer, :pointer], :int
+
+      attach_function 'rados_ioctx_pool_stat', [:pointer, :pointer], :int
+
+      attach_function 'rados_ioctx_get_id', [:pointer], :int
+
+      attach_function 'rados_ioctx_get_pool_name', [:pointer, :buffer_out,
+                                                    :size_t], :int
+
+      attach_function 'rados_ioctx_set_namespace', [:pointer, :string], :void
+
+      attach_function 'rados_ioctx_create', [:pointer, :string, :pointer], :int
+
+      attach_function 'rados_ioctx_destroy', [:pointer], :void
+
+      attach_function 'rados_write', [:pointer, :string, :buffer_in,
+                                      :size_t, :off_t], :int
+
+      attach_function 'rados_write_full', [:pointer, :string, :buffer_in,
+                                           :size_t], :int
+
+      attach_function 'rados_read', [:pointer, :string, :buffer_out,
+                                     :size_t, :off_t], :int
+      attach_function 'rados_append', [:pointer, :string, :buffer_out,
+                                       :size_t], :int
+      attach_function 'rados_remove', [:pointer, :string], :int
+
+      attach_function 'rados_trunc', [:pointer, :string, :size_t], :int
+
+      attach_function 'rados_stat', [:pointer, :string, :pointer,
+                                     :pointer], :int
+
+      attach_function 'rados_getxattr', [:pointer, :string, :string,
+                                         :buffer_out, :size_t], :int
+      attach_function 'rados_setxattr', [:pointer, :string, :string,
+                                         :buffer_in, :size_t], :int
+      attach_function 'rados_rmxattr', [:pointer, :string, :string], :int
+
+      attach_function 'rados_getxattrs', [:pointer, :string, :pointer], :int
+
+      attach_function 'rados_getxattrs_next', [:pointer, :pointer, :pointer,
+                                               :pointer], :int
+      attach_function 'rados_getxattrs_end', [:pointer], :void
+
+      attach_function 'rados_nobjects_list_open', [:pointer, :pointer], :int
+
+      attach_function 'rados_nobjects_list_seek', [:pointer, :uint32], :uint32
+
+      attach_function 'rados_nobjects_list_next', [:pointer, :pointer,
+                                                   :pointer,
+                                                   :pointer], :int
+
+      attach_function 'rados_nobjects_list_close', [:pointer], :void
+
+      attach_function 'rados_nobjects_list_get_pg_hash_position',
+                      [:pointer], :uint32
+
+      class MonitorStatStruct < FFI::Struct #:nodoc:
+        layout :kb, :uint64,
+               :kb_used, :uint64,
+               :kb_avail, :uint64,
+               :num_objects, :uint64
+        def to_hash
+          return {} if members.empty?
+          Hash[* members.collect { |m| [m, self[m]] }.flatten!]
+        end
+      end
+
+      class PoolStatStruct < FFI::Struct #:nodoc:
+        layout :num_bytes, :uint64,
+               :num_kb, :uint64,
+               :num_objects, :uint64,
+               :num_object_clones, :uint64,
+               :num_object_copies, :uint64,
+               :num_objects_missing_on_primary, :uint64,
+               :num_objects_unfound, :uint64,
+               :num_objects_degraded, :uint64,
+               :num_rd, :uint64,
+               :num_rd_kb, :uint64,
+               :num_wr, :uint64,
+               :num_wr_kb, :uint64
+
+        def to_hash
+          return {} if members.empty?
+          Hash[* members.collect { |m| [m, self[m]] }.flatten!]
+        end
+      end
+
+      def self.version
+        major = FFI::MemoryPointer.new(:int)
+        minor = FFI::MemoryPointer.new(:int)
+        extra = FFI::MemoryPointer.new(:int)
+        rados_version(major, minor, extra)
+        {
+          major: major.get_int(0),
+          minor: minor.get_int(0),
+          extra: extra.get_int(0)
+        }
+      end
+
+      def self.version_string
+        "#{version[:major]}.#{version[:minor]}.#{version[:extra]}"
+      end
+    end
+  end
+end