hetzner-bootstrap-coreos 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d07dc6e9373f36a16bc6da8782dee0d1c9b958d2
+  data.tar.gz: 0fc042ce7cfc437391037d4c6bc3e1b66ffb587e
+SHA512:
+  metadata.gz: e4a4e45ee787118c7094771f40c7a9bc4b5897d7e621161b6891a022f817be95b9ac99e20a34c659a66ce9e4426f08c4cac55fb90d8a1804c60448f28a5f843a
+  data.tar.gz: 812962458371ed6c2d600120e8e38303a3b7379de10a5d6244773fd5c03cf9b1db9b6ae36af5524a79fb722180f8c8b41bd02812d22c21bd401a4036e8c5dca5

data/.gitignore

@@ -0,0 +1,7 @@
+.idea/*
+bin/*
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rbenv-vars

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Moriz GmbH, Roland Moriz, http://moriz.de/
+
+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,93 @@
+# hetzner-bootstrap-coreos
+
+This gem allows you to bootstrap CoreOS on a Hetzner root server.
+
+[![Gem Version](https://badge.fury.io/rb/hetzner-bootstrap-coreos.png)](http://badge.fury.io/rb/hetzner-bootstrap-coreos)
+
+## What it does:
+/3.
+In our case we are running a large [CoreOS](https://coreos.com) cluster and which uses bare metal servers hosted at Hetzner. This Ruby gem helps to fully automate the provisioning of CoreOS on a Hetzner root server.
+
+Warning: All existing data on the system will be lost!
+
+## Requirements:
+
+First of all retrieve your API login credentials from the Hetzner admin interface at [https://robot.your-server.de](https://robot.your-server.de). Additionally you need the IP address of the shipped system.
+
+## Implemented steps:
+
+1. Enable Rescue Mode (using Hetzner's webservice)
+2. Resetting the System to boot into rescue mode (using Hetzner's webservice)
+3. Log into the rescue system, write your cloud config file and launch the installation
+4. Reboot
+5. Verify installation (very basic check but can be overwritten)
+6. Copy your local ssh public-key into root's .authorized_keys
+7. Adds the generated server key into your .know_hosts file
+8. Execute post_install hooks (optional)
+
+## Example:
+
+**see example.rb file for usage!**
+
+Warning: All existing data on the system will be lost!
+
+```ruby
+
+#!/usr/bin/env ruby
+require "rubygems"
+require "hetzner-bootstrap-coreos"
+
+# Retrieve your API login credentials from the Hetzner admin interface
+# at https://robot.your-server.de and assign the appropriate environment
+# variables ENV['ROBOT_USER'] and ENV['ROBOT_PASSWORD']
+
+bs = Hetzner::Bootstrap::CoreOS.new(
+  :api => Hetzner::API.new(ENV['ROBOT_USER'], ENV['ROBOT_PASSWORD'])
+)
+
+# Main configuration (cloud-config) 
+cloud_config = <<EOT
+hostname: <%= hostname %>
+ssh_authorized_keys:
+  - <%= public_keys %>
+EOT
+
+# The post_install hook is the right place to launch further tasks (e.g.
+# software installation, system provisioning etc.)
+post_install = <<EOT
+  # TODO
+EOT
+
+bs << { :ip => "1.2.3.4",
+  :cloud_config => cloud_config,
+  :hostname => 'artemis.massive-insights.com',
+    :public_keys => "~/.ssh/id_dsa.pub",
+    :post_install => post_install
+}
+
+bs.bootstrap!
+
+```
+
+Installation:
+-------------
+
+**gem install hetzner-bootstrap-coreos**
+
+Warnings:
+---------
+
+* All existing data on the system will be wiped on bootstrap!
+* This is not an official Hetzner AG project.
+* The gem and the author are not related to Hetzner AG!
+
+**Use at your very own risk. Satisfaction is NOT guaranteed.**
+
+## Thank you greeting
+
+This Ruby gem is inspired by the [hetzner-bootstrap](https://github.com/rmoriz/hetzner-bootstrap) gem and requires the underlying wrapper for the Hetzner server management API [hetzner-api](https://github.com/rmoriz/hetzner-api). Thus I want to thank [Roland Moriz](https://roland.io/developer) a lot for his great work! 
+
+Copyright
+---------
+
+Copyright © 2014 Christoph Pilka ([Asconix Systems AS](https://www.asconix.com)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/example.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "hetzner-bootstrap-coreos"
+
+# Retrieve your API login credentials from the Hetzner admin interface
+# at https://robot.your-server.de and assign the appropriate environment
+# variables ENV['ROBOT_USER'] and ENV['ROBOT_PASSWORD']
+
+bs = Hetzner::Bootstrap::CoreOS.new(
+	:api => Hetzner::API.new(ENV['ROBOT_USER'], ENV['ROBOT_PASSWORD'])
+)
+
+# Main configuration (cloud-config) 
+cloud_config = <<EOT
+hostname: <%= hostname %>
+ssh_authorized_keys:
+  - <%= public_keys %>
+EOT
+
+# The post_install hook is the right place to launch further tasks (e.g.
+# software installation, system provisioning etc.)
+post_install = <<EOT
+  # TODO
+EOT
+
+bs << { :ip => "1.2.3.4",
+	:cloud_config => cloud_config,
+	:hostname => 'artemis.massive-insights.com',
+    :public_keys => "~/.ssh/id_dsa.pub",
+    :post_install => post_install
+}
+
+bs.bootstrap!

data/hetzner-bootstrap-coreos.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hetzner/bootstrap/coreos/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hetzner-bootstrap-coreos"
+  s.version     = Hetzner::Bootstrap::CoreOS::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Christoph Pilka"]
+  s.email       = ["c.pilka@asconix.com"]
+  s.homepage    = "http://www.asconix.com"
+  s.summary     = %q{Bootstrapping of the root servers at Hetzner with CoreOS}
+  s.description = %q{Bootstrapping of the root servers at Hetzner with CoreOS}
+
+  s.add_dependency 'hetzner-api', '>= 1.1.0'
+  s.add_dependency 'net-ssh',     '>= 2.6.0'
+  s.add_dependency 'erubis',      '>= 2.7.0'
+
+  s.add_development_dependency "rspec",   ">= 2.13.0"
+  s.add_development_dependency "rake"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/hetzner/bootstrap/coreos/cloud_config.rb

@@ -0,0 +1,21 @@
+module Hetzner
+  class Bootstrap
+    class CoreOS
+      class CloudConfig
+        attr_accessor :raw_cloud_config
+
+        def initialize(param)
+          if param.is_a? Hetzner::Bootstrap::CoreOS::CloudConfig
+            return param
+          elsif param.is_a? String
+            @raw_cloud_config = param
+          end
+        end
+
+        def to_s
+          @raw_clooud_config
+        end
+      end
+    end
+  end
+end

data/lib/hetzner/bootstrap/coreos/target.rb

@@ -0,0 +1,241 @@
+require 'erubis'
+require 'net/ssh'
+require 'socket'
+require 'timeout'
+
+module Hetzner
+  class Bootstrap
+    class CoreOS
+      class Target
+        attr_accessor :ip
+        attr_accessor :login
+        attr_accessor :password
+        attr_accessor :cloud_config
+        attr_accessor :rescue_os
+        attr_accessor :rescue_os_bit
+        attr_accessor :actions
+        attr_accessor :hostname
+        attr_accessor :post_install
+        attr_accessor :post_install_remote
+        attr_accessor :public_keys
+        attr_accessor :bootstrap_cmd
+        attr_accessor :logger
+
+        def initialize(options = {})
+          @rescue_os     = 'linux'
+          @rescue_os_bit = '64'
+          @retries       = 0
+          @bootstrap_cmd = 'export TERM=xterm; /tmp/coreos-install -d /dev/sda -C stable -c /tmp/cloud-config.yaml'
+          @login         = 'root'
+
+          if cc = options.delete(:cloud_config)
+            @cloud_config = CloudConfig.new cc
+          else
+            raise NoCloudConfigProvidedError.new 'No cloud config file provided.'
+          end
+
+          options.each_pair do |k,v|
+            self.send("#{k}=", v)
+          end
+        end
+
+        def enable_rescue_mode(options = {})
+          result = @api.enable_rescue! @ip, @rescue_os, @rescue_os_bit
+
+          if result.success? && result['rescue']
+            @password = result['rescue']['password']
+            reset_retries
+            logger.info "IP: #{ip} => password: #{@password}"
+          elsif @retries > 3
+            logger.error "Rescue system could not be activated"
+            raise CantActivateRescueSystemError, result
+          else
+            @retries += 1
+
+            logger.warn "Problem while trying to activate rescue system (retries: #{@retries})"
+            @api.disable_rescue! @ip
+
+            rolling_sleep
+            enable_rescue_mode options
+          end
+        end
+
+        def reset(options = {})
+          result = @api.reset! @ip, :hw
+
+          if result.success?
+            reset_retries
+          elsif @retries > 3
+            logger.error "Resetting through web service failed."
+            raise CantResetSystemError, result
+          else
+            @retries += 1
+            logger.warn "Problem while trying to reset/reboot system (retries: #{@retries})"
+            rolling_sleep
+            reset options
+          end
+        end
+
+        def port_open? ip, port
+          ssh_port_probe = TCPSocket.new ip, port
+          IO.select([ssh_port_probe], nil, nil, 2)
+          ssh_port_probe.close
+          true
+        end
+
+        def wait_for_ssh_down(options = {})
+          loop do
+            sleep 2
+            Timeout::timeout(4) do
+              if port_open? @ip, 22
+                logger.debug "SSH UP"
+              else
+                raise Errno::ECONNREFUSED
+              end
+            end
+          end
+        rescue Timeout::Error, Errno::ECONNREFUSED
+          logger.debug "SSH down"
+        end
+
+        def wait_for_ssh_up(options = {})
+          loop do
+            Timeout::timeout(4) do
+              if port_open? @ip, 22
+                logger.debug "SSH up"
+                return true
+              else
+                raise Errno::ECONNREFUSED
+              end
+            end
+          end
+        rescue Errno::ECONNREFUSED, Timeout::Error
+          logger.debug "SSH down"
+          sleep 2
+          retry
+        end
+
+        def installimage(options = {})
+          cloud_config = render_cloud_config
+
+          remote do |ssh|
+            ssh.exec! "echo \"#{cloud_config}\" > /tmp/cloud-config.yaml"
+            logger.info "Remote executing: #{@bootstrap_cmd}"
+            output = ssh.exec!(@bootstrap_cmd)
+            logger.info output
+          end
+        end
+
+        def reboot(options = {})
+          remote do |ssh|
+            ssh.exec!("reboot")
+          end
+        end
+
+        def verify_installation(options = {})
+          remote do |ssh|
+            working_hostname = ssh.exec!("cat /etc/hostname")
+            unless @hostname == working_hostname.chomp
+              raise InstallationError, "Hostnames do not match: assumed #{@hostname} but received #{working_hostname}"
+            end
+          end
+        end
+
+        def update_local_known_hosts(options = {})
+          remote(:paranoid => true) do |ssh|
+            # dummy
+          end
+        rescue Net::SSH::HostKeyMismatch => e
+          e.remember_host!
+          logger.info "Remote host key added to local ~/.ssh/known_hosts file."
+        end
+
+        def post_install(options = {})
+          return unless @post_install
+
+          post_install = render_post_install
+          logger.info "Executing post_install:\n #{post_install}"
+
+          output = local do
+            `#{post_install}`
+          end
+
+          logger.info output
+        end
+
+        def post_install_remote(options = {})
+          remote do |ssh|
+            @post_install_remote.split("\n").each do |cmd|
+              cmd.chomp!
+              logger.info "executing #{cmd}"
+              ssh.exec!(cmd)
+            end
+          end
+        end
+
+        def render_cloud_config
+          eruby = Erubis::Eruby.new @cloud_config.to_s
+
+          params = {}
+          params[:hostname] = @hostname
+          params[:ip]       = @ip
+
+          return eruby.result(params)
+        end
+
+        def render_post_install
+          eruby = Erubis::Eruby.new @post_install.to_s
+
+          params = {}
+          params[:hostname] = @hostname
+          params[:ip]       = @ip
+          params[:login]    = @login
+          params[:password] = @password
+
+          return eruby.result(params)
+        end
+
+        def use_api(api_obj)
+          @api = api_obj
+        end
+
+        def use_logger(logger_obj)
+          @logger = logger_obj
+          @logger.formatter = default_log_formatter
+        end
+
+        def remote(options = {}, &block)
+          default = { :paranoid => false, :password => @password }
+          default.merge! options
+          Net::SSH.start(@ip, @login, default) do |ssh|
+            block.call ssh
+          end
+        end
+
+        def local(&block)
+          block.call
+        end
+
+        def reset_retries
+          @retries = 0
+        end
+
+        def rolling_sleep
+          sleep @retries * @retries * 3 + 1 # => 1, 4, 13, 28, 49, 76, 109, 148, 193, 244, 301, 364 ... seconds
+        end
+
+        def default_log_formatter
+           proc do |severity, datetime, progname, msg|
+             caller[4]=~/`(.*?)'/
+             "[#{datetime.strftime "%H:%M:%S"}][#{sprintf "%-15s", ip}][#{$1}] #{msg}\n"
+           end
+        end
+
+        class NoCloudConfigProvidedError < ArgumentError; end
+        class CantActivateRescueSystemError < StandardError; end
+        class CantResetSystemError < StandardError; end
+        class InstallationError < StandardError; end
+      end
+    end
+  end
+end

data/lib/hetzner/bootstrap/coreos/version.rb

@@ -0,0 +1,7 @@
+module Hetzner
+  class Bootstrap
+    class CoreOS
+      VERSION = '0.0.1'
+    end
+  end
+end

data/lib/hetzner-bootstrap-coreos.rb

@@ -0,0 +1,71 @@
+require 'benchmark'
+require 'logger'
+
+require 'hetzner-api'
+require 'hetzner/bootstrap/coreos/version'
+require 'hetzner/bootstrap/coreos/target'
+require 'hetzner/bootstrap/coreos/cloud_config'
+
+module Hetzner
+  class Bootstrap
+    class CoreOS
+      attr_accessor :targets
+      attr_accessor :api
+      attr_accessor :actions
+      attr_accessor :logger
+
+      def initialize(options = {})
+        @targets     = []
+        @actions     = %w(enable_rescue_mode
+                          reset
+                          wait_for_ssh_down
+                          wait_for_ssh_up
+                          installimage
+                          reboot
+                          wait_for_ssh_down
+                          wait_for_ssh_up
+                          verify_installation
+                          update_local_known_hosts
+                          post_install
+                          post_install_remote)
+        @api         = options[:api]
+        @logger      = options[:logger] || Logger.new(STDOUT)
+      end
+
+      def add_target(param)
+        if param.is_a? Hetzner::Bootstrap::CoreOS::Target
+          @targets << param
+        else
+          @targets << (Hetzner::Bootstrap::CoreOS::Target.new param)
+        end
+      end
+
+      def <<(param)
+        add_target param
+      end
+
+      def bootstrap!(options = {})
+        @targets.each do |target|
+          target.use_api @api
+          target.use_logger @logger
+          bootstrap_one_target! target
+        end
+      end
+
+      def bootstrap_one_target!(target)
+        actions = (target.actions || @actions)
+        actions.each_with_index do |action, index|
+          loghack = "\b" * 24 # remove: "[bootstrap_one_target!] ".length
+          target.logger.info "#{loghack}[#{action}] #{sprintf "%-20s", "START"}"
+          d = Benchmark.realtime do
+            target.send action
+          end
+          target.logger.info "#{loghack}[#{action}] FINISHED in #{sprintf "%.5f",d} seconds"
+        end
+      rescue => e
+        puts "Something bad happened unexpectedly: #{e.class} => #{e.message}"
+      end
+    end
+  end
+end
+

data/spec/hetzner_bootstrap_coreos_spec.rb

@@ -0,0 +1,49 @@
+require 'hetzner-api'
+require 'spec_helper'
+
+describe "Bootstrap" do
+  before(:all) do
+    @api = Hetzner::API.new API_USERNAME, API_PASSWORD
+    @bootstrap = Hetzner::Bootstrap::CoreOS.new :api => @api
+  end
+
+  context "add target" do
+    
+    it "should be able to add a server to operate on" do
+      @bootstrap.add_target proper_target
+      @bootstrap.targets.should have(1).target
+      @bootstrap.targets.first.should be_instance_of Hetzner::Bootstrap::CoreOS::Target
+    end
+
+    it "should have the default cloud config file if none is specified" do
+      @bootstrap.add_target proper_target
+      @bootstrap.targets.first.cloud_config.should be_instance_of Hetzner::Bootstrap::CoreOS::CloudConfig
+    end
+
+    it "should raise an NoCloudConfigProvidedError when no cloud config option provided" do
+      lambda {
+      @bootstrap.add_target improper_target_without_cloud_condfig
+      }.should raise_error(Hetzner::Bootstrap::CoreOS::Target::NoCloudConfigProvidedError)
+    end
+  
+  end
+
+  def proper_target
+    return {
+      :ip            => "1.2.3.4",
+      :login         => "root",
+      :password      => "verysecret",
+      :rescue_os     => "linux",
+      :rescue_os_bit => "64",
+      :cloud_config  => default_cloud_config
+    }
+  end
+
+  def improper_target_without_cloud_config
+    proper_target.select { |k,v| k != :cloud_config }
+  end
+
+  def default_cloud_config
+    "foobar"
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: hetzner-bootstrap-coreos
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christoph Pilka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hetzner-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bootstrapping of the root servers at Hetzner with CoreOS
+email:
+- c.pilka@asconix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example.rb
+- hetzner-bootstrap-coreos.gemspec
+- lib/hetzner-bootstrap-coreos.rb
+- lib/hetzner/bootstrap/coreos/cloud_config.rb
+- lib/hetzner/bootstrap/coreos/target.rb
+- lib/hetzner/bootstrap/coreos/version.rb
+- spec/hetzner_bootstrap_coreos_spec.rb
+homepage: http://www.asconix.com
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Bootstrapping of the root servers at Hetzner with CoreOS
+test_files:
+- spec/hetzner_bootstrap_coreos_spec.rb