stork 0.1.0.pre → 0.2.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1581ba2bfdc4b0cf01bccf46a1c47e6e13e17189
-  data.tar.gz: a787111c144416b14481e5a37d563cf15b54aa5e
+  metadata.gz: c25720b623362f9066503a5134f8e43bd657d55e
+  data.tar.gz: 6ef866902b3736eec018d0fef07ee4fe221a3d36
 SHA512:
-  metadata.gz: 7cc04766af4a80d5e9f63d0c31856ba10bbdd4f179eb9325755dc1390f1dac2c7f8691258147081e4df8520bf234aa450e9bca5e09a3ca1936464d21dd4f5c40
-  data.tar.gz: 5f11301ad092f211d2fed355201f30416460f3236168bab0ad693c1bb30f5ee774b653d9fbfc3d34d94fa2d4cd618da439a417b4f11abbb59ea6cf9839e53ee5
+  metadata.gz: 728bc4a4d5b8f6f3c7bf139d4fd7ca7678f98aa73b15388d55b851f8e0e9bcb5bb32f8a75626b20ab1a2b2a5c5b074537cbd024b1a20da8008b4a9d011bf0ebb
+  data.tar.gz: 78f163a2fa584dac08c8581ebfa8ad0464a92332618392704e1ae91b1ef3742b5fb5319721b83907b5c70e38eeade5545251e710cb8e86f1876172915bc069f9

data/.gitignore

@@ -3,10 +3,12 @@
 .bundle
 .config
 .yardoc
+.vagrant
 Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
+documentation
 doc/
 log/
 lib/bundler/man
@@ -18,4 +20,5 @@ specs/version_tmp
 specs/ksvalidator
 tmp
 test*
+box/stork_pxe*
 .DS_Store

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p247
+2.0.0

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    stork (0.1.0.pre)
+    stork (0.2.0.pre)
       highline
+      mixlib-config
       rest-client
       sinatra
       sqlite3
-      thin
+      webrick
 
 GEM
   remote: https://rubygems.org/
@@ -17,9 +18,7 @@ GEM
       simplecov (>= 0.7)
       term-ansicolor
       thor
-    daemons (1.1.9)
     docile (1.1.3)
-    eventmachine (1.0.3)
     given_core (3.5.4)
       sorcerer (>= 0.3.7)
     highline (1.6.21)
@@ -30,6 +29,7 @@ GEM
     minitest-given (3.5.4)
       given_core (= 3.5.4)
       minitest (> 4.3)
+    mixlib-config (2.1.0)
     multi_json (1.9.2)
     rack (1.5.2)
     rack-protection (1.5.3)
@@ -52,13 +52,11 @@ GEM
     sqlite3 (1.3.9)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
-    thin (1.6.2)
-      daemons (>= 1.0.9)
-      eventmachine (>= 1.0.0)
-      rack (>= 1.0.0)
     thor (0.19.1)
     tilt (1.4.1)
     tins (1.1.0)
+    webrick (1.3.1)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
@@ -73,3 +71,4 @@ DEPENDENCIES
   rake
   simplecov
   stork!
+  yard

data/README.md

@@ -5,27 +5,544 @@
 
 Stork is a autoinstall utility, kickstart generation tool and server for CentOS and Redhat systems.  It aims to fill the gap in the bare metal systems deployment that many of the other tools for cloud and virtual systems excel at.
 
+##### ***Stork is currently under heavy development, but I hope to release the first stable version soon.  Please be aware that the DSL and/or API may change significantly during this time.***
+
 ## Installation
 
 Installation using rubygems:
 
-    $ gem install stork
+    $ gem install stork --pre
 
 Install the latest version from the github:
 
     $ git clone https://github.com/rlyon/stork.git
 
+If you are installing the latest version from github, you have two choices to run stork.  First, you can run ```rake install``` and build/install the gem, or you can run the executables direcly from the **bin** directory.
+
 ## Usage
 
 ### Control the server
     storkctl start restart stop [options]
 
-### Query
+### Commands
+    stork host install [name]
     stork host list
     stork host localboot [name]
-    stork host install [name]
+    stork host reload
     stork host show [name]
 
+## Defining a host
+
+### ```host```
+
+#### Syntax:
+
+The syntax for **host** is as follows:
+
+```ruby 
+host "fqdn" do
+  attribute "value"
+end
+```
+
+where
+
+* ```fqdn``` is the fully qualified domain name of the host.
+* ```attribute``` is the attributes available for this resource.
+
+#### Attributes:
+
+* ```layout``` - Disk layout containing partition and volume group information.  You can supply a string or a block value.  If a string is supplied stork will attempt to find the id matching a previously defined layout.
+* ```template``` - The kickstart template to use when generating the autoinstallation instructions
+* ```chef``` - Chef server information.  You can supply a string or a block value.  If a string is supplied stork will attempt to find the id matching a previously defined chef server.
+* ```pxemac``` - The mac address of the PXE enabled interface.  Used to create the boot configuration files.
+* ```pre_snippet``` - Scripts that will be run in the **pre** section before the install begins.  Snippets are accessed by the basename of the file they are stored in.
+* ```post_snippet``` - Scripts that will be run in the **post** section afer the install has successfully completed.  Snippets are accessed by the basename of the file they are stored in.
+* ```interface``` - Network interface information. Takes only a block value.
+* ```distro``` - Install distribution information.  You can supply a string or a block value.  If a string is supplied stork will attempt to find the id matching a previously defined distribution.
+* ```timezone``` - The IANA zone name (e.g. 'America/Chicago').
+* ```firewall``` - Initial firewall settings.  Block only.
+* ```selinux``` - String or symbol value representing the three selinux states. The only valid values are:  enforcing, permissive, or disabled.  Default is enforcing.
+* ```package``` - Adds a package to the install.  Generally not needed as the minimal set of packages that are installed by default will be enough to install the configuration management software.
+* ```run_list``` - Chef runlist items that will populate the first-boot.json file.  Can be an array or string value.
+* ```chef_environment``` - A string value representing the chef environment the system is part of.  Defaults to the '_default' environment.
+* ```repos``` - Add a new repo to the host.
+* ```stork``` - Url.  Override the stork server location.
+
+#### Examples:
+
+Typical hosts will look like:
+
+```ruby
+host "server.example.org" do
+  template    "default"
+  chef        "default"
+  pxemac      "00:11:22:33:44:55"
+  layout      "home"
+  distro      "centos"
+  repo        "whamcloud-client", baseurl: "http://yum.example.com/eln/x86_64"
+  package     "foo"
+
+
+  interface "eth0" do
+    bootproto :static
+    ip        "99.99.1.8"
+    network   "org"
+  end
+
+  interface "eth1" do
+    bootproto :static
+    ip        "192.168.1.10"
+    netmask   "255.255.255.0"
+    gateway   "192.168.1.1"
+    nameserver "192.168.1.253"
+    nameserver "192.168.1.252"
+  end
+
+  pre_snippet    "setup"
+  post_snippet   "ntp"
+  post_snippet   "resolv-conf"
+  post_snippet   "chef-bootstrap"
+  post_snippet   "chef-reconfigure"
+  post_snippet   "notify"
+
+  run_list %w{ role[base] recipe[apache] }
+end
+```
+
+Or you define hosts programatically with common ruby techniques:
+
+```ruby
+hosts=[
+  [10, "00:11:22:33:44:01"],
+  [11, "00:11:22:33:44:02"],
+  [12, "00:11:22:33:44:03"],
+  [13, "00:11:22:33:44:04"],
+  [14, "00:11:22:33:44:05"],
+  [15, "00:11:22:33:44:06"],
+  [16, "00:11:22:33:44:07"],
+  [17, "00:11:22:33:44:08"],
+  [18, "00:11:22:33:44:09"],
+  [19, "00:11:22:33:44:10"]
+]
+
+hosts.each do |octet, mac|
+  host "c0#{octet}.example.org" do
+    template    "default"
+    chef        "default"
+    distro      "centos"
+    pxemac      mac
+    layout      "home"
+
+
+    interface "eth0" do
+      bootproto :static
+      ip        "192.168.10.#{octet}"
+      network   "org"
+    end
+    run_list %w{ role[node] }
+  end
+end
+```
+## Defining the disk layout
+
+### ```layout```
+
+#### Syntax:
+
+The syntax for **layout** is as follows:
+
+```ruby
+layout "name", part: "physical_volume" do
+  attribute "value"
+end
+```
+
+where
+
+* ```name``` is a unique name that can be used to define global resources that can be referenced from other resources by the defined name.
+* ```part``` is the physical_volume that the volume group will be placed on.
+* ```attribute``` is the attributes available for this resource.
+
+#### Attributes:
+
+* ```zerombr``` - Initialize invalid partition tables.
+* ```clearpart``` - Remove partitions prior to the creation of new partitions.
+* ```partition``` or ```part``` - Partition information (see Partition Resource).
+* ```volume_group``` or ```vg``` - Volume group information (see Volume Group Resource).
+
+### ```partition``` or ```part```
+
+#### Syntax:
+
+The syntax for **partition** is as follows:
+
+```ruby
+partition "mountpoint" do
+  attribute "value"
+end
+```
+
+where
+
+* ```mountpoint``` is the filesystem path where the partition will be mounted. When a volume group will be associated with the partition, use the *pv.n* naming scheme to specify that the partition is a physical volume.
+* ```attribute``` is the attributes available for this resource
+
+#### Attributes:
+
+* ```size``` - Size of the partition in MB.
+* ```type``` - Set the file system type.
+* ```primary``` - Force allocation of the partition as a primary partition.
+* ```grow``` - Grow the partition to the maximum amount.
+* ```recommended``` - Let the installer determine the recommended size.
+
+See ```layout``` for an example of how partition can be used to define disk partitions. 
+
+### ```volume_group``` or ```volgroup```
+
+#### Syntax:
+
+The syntax for **volume_group** is as follows:
+
+```ruby
+volume_group "name" do
+  block_attribute "value" do
+    attribute "value"
+  end
+end
+```
+
+where
+
+* ```name``` is the name of the volume group.
+* ```attribute``` is the attributes available for this resource
+
+#### Attributes:
+
+* ```logical_volume``` - Add a logical volume to the volume group.
+
+### ```logical_volume``` or ```logvol``` 
+
+#### Syntax:
+
+The syntax for **logical_volume** is as follows:
+
+```ruby 
+logical_volume "name" do
+  attribute "value"
+end
+```
+
+where
+
+* ```name``` is the name of the logical volume.
+* ```attribute``` is the attributes available for this resource
+
+#### Attributes:
+
+* ```path``` - Mount point.
+* ```size``` - Size of the logical volume in MB.
+* ```type``` - Set the file system type.
+* ```grow``` - Grow the logical volume to the maximum amount.
+* ```recommended``` - Let the installer determine the recommended size.
+
+#### Examples:
+Layouts can be defined seperately from hosts and referenced in hosts by name.  A typical layout will look like this:
+
+```ruby
+layout "root_and_home" do
+  clearpart
+  zerombr
+  part "/boot" do
+    size 100
+    type "ext4"
+    primary
+  end
+
+  part "swap" do
+    recommended
+    type "swap"
+    primary
+  end
+
+  part "pv.01" do
+    grow
+    primary
+  end
+
+  volume_group "vg", part: "pv.01" do
+    logical_volume "lv_root" do
+      path "/"
+      type "ext4"
+      size 4096
+    end
+
+    logical_volume "lv_home" do
+      path "/home"
+      type "ext4"
+      grow
+    end
+  end
+end
+``` 
+
+## Defining the install distribution
+
+### ```distro```
+
+#### Syntax:
+
+The syntax for **distro** is as follows:
+
+```ruby
+distro "name" do
+  attribute "value"
+end
+```
+
+where
+
+* ```name``` is a unique name that can be used to define global resources that can be referenced from other resources by the defined name.
+* ```attribute``` is the attributes available for this resource
+
+#### Attributes:
+
+* ```kernel``` - Name of the kernel.  This is the kernel that will be transfered via tftp to the host at install time.
+* ```image``` - Name of the RAM disk image of the installer.
+* ```url``` - Install url for network install (only supports http - at least thats the only one I'm testing with)
+
+#### Examples:
+```ruby
+distro "centos" do
+  kernel "vmlinuz"
+  image "initrd.img"
+  url "http://mirror.example.com/centos"
+end
+```
+
+## Adding network interfaces
+
+### ```network```
+
+#### Syntax:
+
+The syntax for **network** is as follows:
+
+```ruby
+network "name" do
+  attribute "value"
+end
+```
+
+where
+
+* ```name``` is a unique name that can be used to define global resources that can be referenced from other resources by the defined name.
+* ```attribute``` is one or more of the attributes available for this resource.
+
+#### Attributes:
+
+* ```netmask``` - the netmask of the network.
+* ```gateway``` - the ip address of the network's gateway.
+* ```nameserver``` - add a nameserver to the network.
+* ```search_path``` - add a search_path to the network.
+
+#### Examples:
+
+```ruby
+network "org" do
+  netmask "255.255.255.0"
+  gateway "99.99.1.1"
+  nameserver "99.99.1.253"
+  nameserver "99.99.1.252"
+  search_path "example.org"
+end
+
+```
+
+### ```interface```
+
+#### Syntax:
+
+The syntax for **interface** is as follows:
+
+```ruby
+interface "device" do
+  attribute "value"
+end
+```
+
+where
+
+* ```device``` is the device that is being configured
+* ```attribute``` is one or more of the attributes available for this resource.
+
+#### Attributes:
+
+* ```onboot``` - enables the interface on boot.
+* ```ipv4``` or ```noipv4``` - enable or disable ipv4 support.
+* ```ipv6``` or ```noipv6``` - enable or disable ipv6 support.
+* ```defroute``` or ```nodefroute``` - use or don't use the interface for the default route.
+* ```ethtool``` - a string value representing the ethtool options for the interface.
+* ```bootproto``` - a string or symbol representing the boot protocol.  Allowed values include :static and :dhcp.
+
+For statically configured interfaces: ```bootproto :static```
+
+* ```ip``` - the ip address of the interface.
+* ```netmask``` - the netmask of the network.
+* ```gateway``` - the ip address of the network's gateway.
+* ```nameserver``` - add a nameserver to the network.
+* ```search_path``` - add a search_path to the network.
+* ```network``` - set the netmask, gateway, nameservers, and search paths with the values found in the specified network resource. 
+
+For dynamically configured interfaces: ```bootproto :dhcp```
+
+* ```dns``` or ```nodns``` - allow or disallow dhcpd to update resolv.conf.
+
+#### Examples:
+
+```ruby
+interface "eth0" do
+  onboot
+  bootproto :dhcp
+end
+
+interface "eth1" do
+  bootproto :static
+  ip        "99.99.1.8"
+  network   "org"
+end
+
+interface "eth2" do
+  bootproto :static
+  ip        "192.168.1.10"
+  netmask   "255.255.255.0"
+  gateway   "192.168.1.1"
+  nameserver "192.168.1.253"
+  nameserver "192.168.1.252"
+end
+```
+
+## Setting the host firewall
+
+### ```firewall```
+
+#### Syntax:
+
+The syntax for **firewall** is as follows:
+
+```ruby
+firewall do
+  attribute "value"
+end
+```
+
+where
+
+* ```attribute``` is one or more of the attributes available for this resource.
+
+#### Attributes:
+
+* ```enabled``` - enable the firewall.
+* ```disable``` - disable the firewall.
+* ```ssh``` - allow the ssh protocol through the firewall.
+* ```telnet``` - allow the telnet protocol through the firewall.
+* ```smtp``` - allow the smtp protocol through the firewall.
+* ```http``` - allow the http protocol through the firewall.
+* ```ftp``` - allow the ftp protocol through the firewall.
+* ```trust``` - add a device (e.g. eth1, eth2, p1p2, etc) as a trusted device.
+* ```allow``` - allow a port and using the **port:protocol** format
+
+#### Examples:
+
+```ruby
+firewall do
+  enabled
+  ssh
+  allow "8080:tcp"
+  trust "eth1"
+end
+```
+
+## Defining the chef resources
+
+### ```chef```
+
+#### Syntax:
+
+The syntax for the **chef** resource is as follows:
+
+```ruby
+chef "name" do
+  attribute "value"
+end
+```
+
+where
+
+* ```name``` is a unique name that can be used to define global resources that can be referenced from other resources by the defined name.
+* ```attribute``` is the attributes available for this resource
+
+#### Attributes:
+
+* ```version``` - The version of chef to use.
+* ```client_name``` - The admin client name.
+* ```client_key``` - The admin client key file.
+* ```validator_name``` - The validation client name.
+* ```validation_key``` - The validation key file.
+* ```encrypted_data_bag_secret``` - A string value of the data bag encryption key.
+
+#### Examples:
+
+```ruby
+chef "default" do
+  url "https://chef.example.org"
+  version "11.6.0"
+  client_name "root"
+  client_key "./specs/keys/snakeoil-root.pem"
+  validator_name "chef-validator"
+  validation_key "./specs/keys/snakeoil-validation.pem"
+  encrypted_data_bag_secret "9EE8rGyPB8mXARNrzSDal9TOAQ...e7/x2uPkqMS/tOU="
+end
+```
+
+## Templates and Snippet Scripts
+
+Templates and snippets use the ERB templating system.  When the ERB files are rendered, binding are created to expose ruby the underlying ruby objects.  
+
+In kickstart templates, the generated kickstart commands can be accessed:
+
+* ```url``` - Outputs the kickstart command assigning the URL for network installs.
+* ```network``` - Outputs each interface kickstart command for all defined interfaces.
+* ```password``` - Outputs the 'rootpw' command with a randomized password.
+* ```firewall``` - Outputs the firewall command.
+* ```timezone``` - Outputs the timezone command for the installer.
+* ```selinux``` - Outputs the selinux command.
+* ```layout``` - Outputs all of the partition, volume groups and logical volume commands.
+* ```bootloader``` - Outputs the bootloader config information.
+* ```zerombr``` - Outputs the zerombr command.
+* ```clearpart``` - Outputs the clearpart command.
+* ```repos``` - Outputs all additional repo commands.
+* ```packages``` - Outputs the packages section.
+* ```pre_snippets``` - Renders and outputs all pre snippets in the %pre section.
+* ```post_snippets``` - Renders and outputs all post snippets in the %post section.
+
+In addition to the kickstart command generators, the following objects are exposed and can be used:
+
+* ```host``` - The complete host object for the current host.
+
+Snippets expose the following objects to the template:
+
+* ```host``` - The current host.
+* ```chef``` - The chef object.
+* ```authorized_keys``` - A string containing all the public keys.
+* ```first_boot_content``` - A string representation of the json content that will make up the first_boot file.
+* ```nameservers``` - An array of all unique nameservers.
+* ```search_paths``` - An array of all unique search_paths.
+* ```stork_server``` - The IP address or hostname of the stork server.
+* ```stork_port``` - The port that the stork server is running on.
+* ```stork_bind``` - The bind IP address of the stork server.
+
+
 ## Contributing
 
 ### Grab the source and make a branch
@@ -36,7 +553,7 @@ Install the latest version from the github:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-### Seting up for the kickstart validation tests
+### Setting up for the kickstart validation tests
 
 To run the kickstart validation tests on your local system, you
 will need to install python and the python virtualenv module.  

data/bin/stork

@@ -18,13 +18,20 @@ require 'ostruct'
 class StorkApp
   def initialize
     @options = OpenStruct.new
-    @options.config = "/etc/stork/config.rb"
+    @options.config = ENV['STORK_CONFIG'] || "#{ENV['HOME']}/.stork/client.rb"
+    @options.debug = false
 
     @opts = OptionParser.new do |o|
       o.banner = "Usage: stork sub-command action [options]"
       o.on("-c", "--config FILE", "Read configuration from the specified file") do |config|
         @options.config = config
       end
+      o.on("-D", "--debug", "Turn on debug output") do
+        @options.debug = true
+      end
+      o.on("-h", "--help", "Print this help message") do
+        help
+      end
     end
   end
 
@@ -42,6 +49,7 @@ class StorkApp
 
   # Probably not the best way to keep track
   def plugins
+    puts Module.constants if @options.debug
     Module.constants.select{|m| m =~ /Plugin/}
   end
 
@@ -57,16 +65,15 @@ class StorkApp
     action_name = action.to_s.capitalize
 
     opt_parse
-
+    load_or_create_config
+    
     plugin_name = "#{sub_command_name}#{action_name}"
     module_name = "#{plugin_name}Plugin"
     constant_name = "#{module_name}::#{plugin_name}"
     
     begin
       klass = Stork.const_get(constant_name)
-      # pass the options and the remaning args
-      configuration = Stork::Configuration.from_file(@options.config)
-      @plugin = klass.new(configuration, @options, ARGV)
+      @plugin = klass.new(@options, ARGV)
     rescue NameError => err
       help "Unknown sub-command"
     rescue Errno::ENOENT => err
@@ -79,6 +86,13 @@ class StorkApp
     @opts.parse!
   end
 
+  def load_or_create_config
+    unless File.exist?(@options.config)
+      help "Your configuration file was not found at: #{@options.config}"
+    end
+    Stork::Configuration.from_file(@options.config)
+  end
+
   def run
     begin
       @plugin.run