ceph-crush-location 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ce20f8f342c0b2a09c41c7ab5a2915ed5f47310
+  data.tar.gz: df72c8eda7b4803e273f8787c8aa891e20b30309
+SHA512:
+  metadata.gz: 004ae1ccbfd2844e14cb8292aff17da7e3d1aea69a495b9157d497d495e177ec88715a4cad69c19d58e667fdfe5b9d4456678c3d6258e1c2ffa2b53b7d77c140
+  data.tar.gz: bbead56a581722574c8d5318355828422493e397b091cd1f96184deb36f32e0dd5a38bb4b786548628c589fd2f9b9ce6daf44403028f611d841475af0e9be786

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change.
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
+   do not have permission to do that, you may request the second reviewer to merge it for you.

data/Gemfile

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

data/README.md

@@ -0,0 +1,67 @@
+# Ceph::Crush::Location
+
+This module is designed as an assistent to the [Ceph OSD](https://ceph.com) daemon.
+On starting a Ceph OSD, the daemon will invoke an executable as detailed in the config.
+
+```ini
+[osd]
+osd_crush_location_hook = /path/to/crush/location/bin
+```
+
+Ceph invokes this executable with the following options:
+    --cluster CLUSTER
+    --id ID
+    --type DAEMON_TYPE
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install ceph-crush-location
+
+## Usage
+
+This file takes information about the node from a file called `/etc/nodeinfo/info.json`. This can contain information about what datacenter, row, rack and chassis a host is in.
+This is useful for maintaining redundancy of data.
+
+the json file can take the following format
+```json
+{
+  "datacenter": "dc",
+  "row": "1",
+  "rack": "rackname",
+  "chassis": "chassis-name"
+}
+```
+
+Should this file not be available from this location, you can specify the location using `ENV['NODE_INFO']`
+
+Beyond that there are three lower types provided which are derived as follows:
+    root # Crush root, either default, or read from /path/to/osd/crush_root
+    disk_chassis # JBOD level of redundancy read from /path/to/osd/disk_chassis
+    enclosure # Enclosure/backplane read from /path/to/osd/enclosure
+
+If any of the crush bucket information items are not retrievable (or not provided), they will be ommitted.
+
+Each bucket is maintained as unique by concatenating all higher level bucket names to the lower one, thus if you ignore a bucket layer in the middle, the disk will fall potentially into a different bucket from what you are expecting.
+
+Your crush ruleset will require the following types to use this gem:
+    type 0 osd
+    type 1 enclosure
+    type 2 disk_chassis
+    type 3 host
+    type 4 chassis
+    type 5 rack
+    type 6 row
+    type 7 datacenter
+    type 8 root
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/essjayhch/ceph-crush-location.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ceph/crush/location'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ceph-crush-location.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ceph/crush/location/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ceph-crush-location'
+  spec.version       = Ceph::Crush::Location::VERSION
+  spec.authors       = ['Stuart Harland']
+  spec.email         = ['s.harland@livelinktechnology.net']
+
+  spec.summary       = 'Manage where OSDs are found in crush map'
+  spec.homepage      = 'https://github.com/essjayhch/ceph-crush-location'
+  spec.licenses      = ['MIT']
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'json'
+  spec.add_runtime_dependency 'logger'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/exe/crush-location.rb

@@ -0,0 +1,3 @@
+#!/bin/env ruby
+require 'ceph/crush/location'
+puts Ceph::Crush::Location::Bucket.new

data/lib/ceph/crush/location.rb

@@ -0,0 +1,20 @@
+# Ruby module for code to do with Ceph
+module Ceph
+  # Ruby Module to do with Crush Maps
+  module Crush
+    # Code to handle where to inject OSDs into the Crush Map
+    module Location
+      require 'rubygems'
+      require 'active_support'
+      mattr_accessor :nodeinfo, :logger, :options
+      require 'ceph/crush/location/version'
+      require 'ceph/crush/location/logger'
+      Ceph::Crush::Location::Logger.send('Load')
+      require 'ceph/crush/location/options/parser'
+      require 'ceph/crush/location/node_info/parser'
+      require 'ceph/crush/location/osd'
+      require 'ceph/crush/location/bucket'
+      Ceph::Crush::Location::Logger.send('Loaded')
+    end
+  end
+end

data/lib/ceph/crush/location/bucket.rb

@@ -0,0 +1,97 @@
+module Ceph
+  module Crush
+    module Location
+      # Derives a Bucket line for Crush
+      class Bucket
+        def initialize
+          Ceph::Crush::Location::Logger.send('Bucket.initialize')
+          @osd = OSD.new
+        end
+
+        def to_s
+          Ceph::Crush::Location::Logger.send('Bucket.to_s')
+          [root_bucket, datacenter_bucket,
+           row_bucket, rack_bucket, chassis_bucket,
+           host_bucket, disk_chassis_bucket, enclosure_bucket].join('')
+        end
+
+        private
+
+        def root_bucket
+          Ceph::Crush::Location::Logger.send('Bucket.root_bucket')
+          "root=#{@osd.root}"
+        end
+
+        def datacenter_bucket
+          Ceph::Crush::Location::Logger.send('Bucket.datacenter_bucket')
+          " datacenter=#{datacenter}" if @osd.knows_datacenter?
+        end
+
+        def datacenter
+          Ceph::Crush::Location::Logger.send('Bucket.datacenter')
+          @osd.root_artifact(@osd.datacenter)
+        end
+
+        def row_bucket
+          Ceph::Crush::Location::Logger.send('Bucket.row_bucket')
+          " row=#{row}" if @osd.knows_row?
+        end
+
+        def row
+          Ceph::Crush::Location::Logger.send('Bucket.row')
+          @osd.datacenter_artifact(@osd.row)
+        end
+
+        def rack_bucket
+          Ceph::Crush::Location::Logger.send('Bucket.rack_bucket')
+          " rack=#{rack}" if @osd.knows_rack?
+        end
+
+        def rack
+          Ceph::Crush::Location::Logger.send('Bucket.rack')
+          @osd.row_artifact(@osd.rack)
+        end
+
+        def chassis_bucket
+          Ceph::Crush::Location::Logger.send('Bucket.chassis_bucket')
+          " chassis=#{chassis}" if @osd.knows_chassis?
+        end
+
+        def chassis
+          Ceph::Crush::Location::Logger.send('Bucket.chassis')
+          @osd.rack_artifact(@osd.chassis)
+        end
+
+        def host_bucket
+          Ceph::Crush::Location::Logger.send('Bucket.host_bucket')
+          " host=#{host}"
+        end
+
+        def host
+          Ceph::Crush::Location::Logger.send('Bucket.host')
+          @osd.chassis_artifact(@osd.hostname)
+        end
+
+        def disk_chassis_bucket
+          Ceph::Crush::Location::Logger.send('Bucket.disk_chassis_bucket')
+          " disk_chassis=#{disk_chassis}" if @osd.knows_disk_chassis?
+        end
+
+        def disk_chassis
+          Ceph::Crush::Location::Logger.send('Bucket.disk_chassis')
+          @osd.host_artifact(@osd.disk_chassis)
+        end
+
+        def enclosure_bucket
+          Ceph::Crush::Location::Logger.send('Bucket.enclosure_bucket')
+          " enclosure=#{enclosure}" if @osd.knows_enclosure?
+        end
+
+        def enclosure
+          Ceph::Crush::Location::Logger.send('Bucket.enclosure')
+          @osd.disk_chassis_artifact(@osd.enclosure)
+        end
+      end
+    end
+  end
+end

data/lib/ceph/crush/location/logger.rb

@@ -0,0 +1,28 @@
+module Ceph
+  module Crush
+    module Location
+      # Logs things
+      module Logger
+        mattr_accessor :loggers
+
+        def self.add_logger_instance(logger)
+          loggers << logger
+        end
+
+        def self.send(message, level = ::Logger::INFO)
+          return unless loggers
+          loggers.each do |l|
+            send_log_message(message, l, level)
+          end
+        end
+
+        def self.send_log_message(message, logger, level = ::Logger::INFO)
+          return logger.info(message) if level == ::Logger::INFO
+          return logger.error(message) if level == ::Logger::ERR
+          return logger.warn(message) if level == ::Logger::WARN
+          logger.debug(message)
+        end
+      end
+    end
+  end
+end

data/lib/ceph/crush/location/node_info/parser.rb

@@ -0,0 +1,17 @@
+module Ceph
+  module Crush
+    module Location
+      # This Module loads information about this node from a json file
+      module NodeInfo
+        def self.load
+          Ceph::Crush::Location::Logger.send('loading node info')
+          require 'json'
+          Ceph::Crush::Location.nodeinfo = JSON.parse(
+            ::File.read(Ceph::Crush::Location.options[:nodeinfo])
+          )
+        end
+      end
+    end
+  end
+end
+Ceph::Crush::Location::NodeInfo.load

data/lib/ceph/crush/location/options/parser.rb

@@ -0,0 +1,109 @@
+require 'optparse'
+module Ceph
+  module Crush
+    module Location
+      # Holds options
+      module Options
+        def self.parse!
+          Parser.parse!
+        end
+
+        # Parses it
+        class Parser
+          class << self
+            def parse!
+              ::Ceph::Crush::Location::Logger.send('parsing attributes')
+              ::Ceph::Crush::Location.options = {}
+              grab!
+              validate!
+              default_env
+              env!
+              ::Ceph::Crush::Location.options.freeze
+            rescue OptionParser::MissingArgument => e
+              report e
+            end
+
+            def default_env
+              Ceph::Crush::Location::Logger.send('Options::Parser.default_env')
+              ::Ceph::Crush::Location.options[:nodeinfo] =
+                '/etc/nodeinfo/info.json'
+            end
+
+            def env!
+              Ceph::Crush::Location::Logger.send('Options::Parser.env!')
+              return unless ENV['NODE_INFO']
+              ::Ceph::Crush::Location.options[:nodeinfo] = ENV['NODE_INFO']
+            end
+
+            def report(e)
+              ::Ceph::Crush::Location.log(e, Logger::ERROR)
+              STDERR.puts "#{$PROGRAM_NAME}: #{e}"
+              exit(-1)
+            end
+
+            def usage(opts)
+              Ceph::Crush::Location::Logger.send('Options::Parser.usage')
+              opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+              opts.separator ''
+              opts.separator 'Specific options:'
+            end
+
+            def options(opts)
+              Ceph::Crush::Location::Logger.send('Options::Parser.options')
+              opts.on('-c', '--cluster CLUSTER', 'Specify Cluster Name') do |c|
+                ::Ceph::Crush::Location.options[:cluster] = c
+              end
+
+              opts.on('-t', '--type TYPE', 'Specify Daemon Type') do |t|
+                ::Ceph::Crush::Location.options[:type] = t
+              end
+
+              opts.on('-i', '--id ID', 'Specify Daemon ID') do |i|
+                ::Ceph::Crush::Location.options[:id] = i
+              end
+            end
+
+            def tail
+              Ceph::Crush::Location::Logger.send('Options::Parser.tail')
+              opts.on_tail('-h', '--help', 'Show this message') do
+                puts opts
+                exit
+              end
+
+              opts.on_tail('--version', 'Show version') do
+                puts Ceph::Crush::Location::VERSION
+                exit
+              end
+            end
+
+            def grab!
+              Ceph::Crush::Location::Logger.send('Options::Parser.grab!')
+              OptionParser.new do |opts|
+                usage(opts)
+
+                options(opts)
+
+                opts.separator ''
+                opts.separator 'Common options:'
+              end.parse!(ARGV)
+            end
+
+            def validate!
+              Ceph::Crush::Location::Logger.send('Options::Parser.validate!')
+              ::Ceph::Crush::Location.options.fetch(:cluster) do
+                raise OptionParser::MissingArgument, 'no \'cluster\' provided'
+              end
+              ::Ceph::Crush::Location.options.fetch(:id) do
+                raise OptionParser::MissingArgument, 'no \'id\' provided'
+              end
+              ::Ceph::Crush::Location.options.fetch(:type) do
+                raise OptionParser::MissingArgument, 'no \'type\' provided'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+Ceph::Crush::Location::Options.parse!

data/lib/ceph/crush/location/osd.rb

@@ -0,0 +1,137 @@
+require 'socket'
+module Ceph
+  module Crush
+    module Location
+      # This class stores metadata about this OSD
+      class OSD
+        attr_accessor :id, :cluster
+        CEPH_OSD_ROOT_PATH = '/var/lib/ceph/osd'.freeze
+        def initialize
+          Ceph::Crush::Location::Logger.send('OSD.initialize')
+          self.id = Ceph::Crush::Location.options[:id]
+          self.cluster = Ceph::Crush::Location.options[:cluster]
+        end
+
+        def osd_directory
+          Ceph::Crush::Location::Logger.send('OSD.osd_directory')
+          ::File.join CEPH_OSD_ROOT_PATH, "#{cluster}-#{id}"
+        end
+
+        def default_root?
+          !::File.exist? root_path
+        end
+
+        def root_path
+          @root_path ||= ::File.join(osd_directory, 'crush_root')
+        end
+
+        def root
+          return 'default' if default_root?
+          ::File.read root_path
+        end
+
+        def disk_chassis_path
+          Ceph::Crush::Location::Logger.send('OSD.disk_chassis_path')
+          @disk_chassis_path ||= ::File.join(osd_directory, 'disk_chassis')
+        end
+
+        def knows_disk_chassis?
+          ::File.exist? disk_chassis_path
+        end
+
+        def disk_chassis
+          ::File.read disk_chassis_path if knows_disk_chassis?
+        end
+
+        def enclosure_path
+          Ceph::Crush::Location::Logger.send('OSD.enclosure_path')
+          @enclosure_path ||= ::File.join(osd_directory, 'enclosure')
+        end
+
+        def knows_enclosure?
+          ::File.exist? enclosure_path
+        end
+
+        def enclosure
+          ::File.read enclosure_path if knows_enclosure?
+        end
+
+        def knows_chassis?
+          !chassis.nil?
+        end
+
+        def chassis
+          Ceph::Crush::Location::Logger.send('OSD.chassis')
+          @chassis ||= Ceph::Crush::Location.nodeinfo['chassis']
+        end
+
+        def knows_rack?
+          !rack.nil?
+        end
+
+        def rack
+          @rack ||= Ceph::Crush::Location.nodeinfo['rack']
+        end
+
+        def knows_row?
+          !row.nil?
+        end
+
+        def row
+          @row ||= Ceph::Crush::Location.nodeinfo['row']
+        end
+
+        def knows_datacenter?
+          !datacenter.nil?
+        end
+
+        def datacenter
+          Ceph::Crush::Location::Logger.send('OSD.datacenter')
+          @datacenter ||= Ceph::Crush::Location.nodeinfo['datacenter']
+        end
+
+        def hostname
+          Socket.gethostname.strip.split('.').first
+        end
+
+        def root_artifact(append = '')
+          "#{root}_#{append}"
+        end
+
+        def datacenter_artifact(append = '')
+          return root_artifact("#{datacenter}_#{append}") if knows_datacenter?
+          root_artifact(append)
+        end
+
+        def row_artifact(append = '')
+          return datacenter_artifact("#{row}_#{append}") if knows_row?
+          datacenter_artifact(append)
+        end
+
+        def rack_artifact(append = '')
+          return row_artifact("#{rack}_#{append}") if knows_rack?
+          row_artifact(append)
+        end
+
+        def chassis_artifact(append = '')
+          return rack_artifact("#{chassis}_#{append}") if knows_chassis?
+          rack_artifact(append)
+        end
+
+        def host_artifact(append = '')
+          chassis_artifact("#{hostname}_#{append}")
+        end
+
+        def disk_chassis_artifact(append = '')
+          return host_artifact(append) unless knows_disk_chassis?
+          host_artifact("#{disk_chassis}_#{append}")
+        end
+
+        def enclosure_artifact(append = '')
+          return disk_chassis_artifact(append) unless knows_enclosure?
+          disk_chassis_artifact("#{enclosure}_#{append}")
+        end
+      end
+    end
+  end
+end

data/lib/ceph/crush/location/version.rb

@@ -0,0 +1,7 @@
+module Ceph
+  module Crush
+    module Location
+      VERSION = '0.1.1'.freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: ceph-crush-location
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Stuart Harland
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: logger
+  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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- s.harland@livelinktechnology.net
+executables:
+- crush-location.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ceph-crush-location.gemspec
+- exe/crush-location.rb
+- lib/ceph/crush/location.rb
+- lib/ceph/crush/location/bucket.rb
+- lib/ceph/crush/location/logger.rb
+- lib/ceph/crush/location/node_info/parser.rb
+- lib/ceph/crush/location/options/parser.rb
+- lib/ceph/crush/location/osd.rb
+- lib/ceph/crush/location/version.rb
+homepage: https://github.com/essjayhch/ceph-crush-location
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Manage where OSDs are found in crush map
+test_files: []