dock0 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2795fc2951f895f3487cafce831f0a72d54e36a
-  data.tar.gz: 0dcc00c9e4aed504ca89c2689c6176ef1d963e55
+  metadata.gz: 86db9bf623fa4fbb36f27052e0840772fa84a5dd
+  data.tar.gz: d018c8f6b981ac4f65951c7071ae4d041f6b309a
 SHA512:
-  metadata.gz: 90bc08e7cc9c77c75cbb7a6a79d5c0727634617e38bba3561712d9f84740bf985bfc5c68aab57e7ba2c991905a21f57f3fed12395896a0e23cbe6c859e3239ae
-  data.tar.gz: 1c525f556162698dfcf40648f515bc6bf56ffe9243062981a025e45caac478d06a63282838ae9cf009cf92d3a45c829232d1ee5e8cf7e859d26be05b9d7b064d
+  metadata.gz: e53cdc249cb4ad2d804ba87035f3099e3b99befaf5af20ccc7816171dfb2517dee844652e5f16d02d065eec3903ecd666dd9083950c7b814e3a198b50cb10b76
+  data.tar.gz: 8de5fd31242d696a9d577a20225c6e7f6cad1358632c47fa42518496020421cf65d9a8162622fded233c50e146b56fcc331b2c5b7ed7aafb4c9efe02838ae35d

data/README.md

@@ -4,14 +4,28 @@ dock0
 [![Gem Version](https://badge.fury.io/rb/dock0.png)](http://badge.fury.io/rb/dock0)
 [![Dependency Status](https://gemnasium.com/akerl/dock0.png)](https://gemnasium.com/akerl/dock0)
 [![Code Climate](https://codeclimate.com/github/akerl/dock0.png)](https://codeclimate.com/github/akerl/dock0)
-[![Coverage Status](https://coveralls.io/repos/akerl/dock0/badge.png?branch=master)](https://coveralls.io/r/akerl/dock0?branch=master)
-[![Build Status](https://travis-ci.org/akerl/dock0.png?branch=master)](https://travis-ci.org/akerl/dock0)
 
 Dynamic Arch image generator for building a read-only host system for [Docker](https://www.docker.io)
 
 ## Usage
 
-Informative words will be here one day.
+This is basically a meta-script that builds Arch images. Its primary use is to build read-only Docker hosts for me, but it could realistically be repurposed for other kinds of minimal deployments.
+
+An example configuration can be found in [this repo](https://www.github.com/akerl/my_dock0).
+
+The dock0 command accepts a list of configuration files as arguments. It changes to the directory of the first file given, so all other files and configuration options can use relative pathing based from that location:
+
+    dock0 /opt/my_dock0/config.yaml ./configs/foobar.yaml
+
+The module's Dock0::Image class exposes various methods, but the recommended option is to run .easy_mode(), which runs through them all in the preferred order. This is the sequence (@config represents the merged configs provided):
+
+1. `.prepare_device()` makes an ext2 filesystem at `@config['paths']['device']` and mounts it at `@config['paths']['mount']`
+2. `.prepare_root()` creates a filesystem at `@config['paths']['build_file']` and mounts it at `@config['paths']['build']`
+3. `.install_packages()` pacstraps the root filesystem with all the packages listed in `@config['paths']['package_list']`
+4. `.apply_overlay()` copies the contents of `@config['paths']['overlay']` into the root filesystem
+5. `.run_scripts()` runs all the ruby scripts in `@config['paths']['scripts']` in its own scope (the have access to `@config` and such)
+6. `.run_commands()` runs all commands in `@config['commands']['chroot']` using arch-chroot and all commands in `@config['commands']['host']` on the host system
+7. `.finalize()` unmounts the root FS, packs it in a squashfs, puts it on the target device, and unmounts that
 
 ## Installation
 

data/Rakefile

@@ -1,5 +1,4 @@
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
 desc 'Update bundle'
@@ -7,9 +6,6 @@ task :bundle do
   `bundle update`
 end
 
-desc 'Run tests'
-RSpec::Core::RakeTask.new(:spec)
-
 desc 'Run Rubocop on the gem'
 Rubocop::RakeTask.new(:rubocop) do |task|
   task.patterns = ['lib/**/*.rb', 'spec/*.rb', 'spec/helpers/*.rb', 'bin/*']
@@ -21,5 +17,5 @@ task :travislint do
   print 'There is an issue with your .travis.yml' unless system('travis-lint')
 end
 
-task default: [:spec, :travislint, :rubocop, :build]
+task default: [:travislint, :rubocop, :build]
 task release: [:bundle]

data/dock0.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'dock0'
-  s.version     = '0.0.3'
+  s.version     = '0.0.4'
   s.date        = Time.now.strftime("%Y-%m-%d")
 
   s.summary     = 'Builds a read-only Arch host for Docker'
@@ -17,7 +17,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'travis-lint'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'coveralls'
-  s.add_development_dependency 'rspec'
   s.add_development_dependency 'fuubar'
 end

data/lib/dock0.rb

@@ -88,6 +88,7 @@ module Dock0
     end
 
     def finalize
+      sleep 5
       puts 'Packing up root FS'
       run "umount #{@config['paths']['build']}"
       run "mksquashfs #{@config['paths']['build_file']} \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dock0
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -52,34 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  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'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -112,8 +84,6 @@ files:
 - bin/dock0
 - dock0.gemspec
 - lib/dock0.rb
-- spec/dock0_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/aker/dock0
 licenses:
 - MIT
@@ -138,6 +108,4 @@ rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Builds a read-only Arch host for Docker
-test_files:
-- spec/dock0_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/spec/dock0_spec.rb

@@ -1,7 +0,0 @@
-require 'spec_helper'
-
-describe Dock0 do
-  it "doesn't have tests yet" do
-    expect(1).to eql 1
-  end
-end

data/spec/spec_helper.rb

@@ -1,10 +0,0 @@
-require 'simplecov'
-require 'coveralls'
-
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
-SimpleCov.start do
-  add_filter '/spec/'
-end
-
-require 'rspec'
-require 'dock0'