palletjack 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e67d0b124d14adf092a78bf3c3c9e0c2b653698
+  data.tar.gz: f4e2e35cb63690e534c6f00865cfbea1a36a3621
+SHA512:
+  metadata.gz: e70c5757bdb8bb3836582cdaf3c8a9f457c7831e9d9753065be15de846039848a5d61b7f19746eb760714611e407ecc70c72975d934475355ddb1fee597d0758
+  data.tar.gz: 5d4aee420d2ec7acebd6c5b8fa500a518e1f265eb5403dfa5521adbba4e209a9a4c67460e7b5a4cf544817a3dfc15a795152b92a042f6112408a973723abb097

data.tar.gz.sig

@@ -0,0 +1,2 @@
+1Y�	)%��c@��(A�6�Q��;5¼�x�Rp����g/� 7Jeʽ�D�O(��|eh��F�T�ܼk4#��$5��p����] ���rZ=��F�����i���r�:�j���H���m�#�©ʁ�j�&j��ʮ���1+��m;���0���
+�Ϗ�	�3<Ж�9�7"��Hf������0�����RA�A8��v��P[FGјy M�%�q��S�91�ox-���j����]7����K

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+*~
+# Ignore personal preferences for rspec output
+.rspec

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 saab-simc-admin
+
+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,243 @@
+# Pallet Jack
+Pallet Jack is a lightweight configuration management database, utilizing
+the power of a Posix file system to store yaml serialized key-value trees.
+
+A database is created from a warehouse (directory) of different kinds
+(directory) of pallets (directory), each containing boxes (yaml files)
+with keys. Pallets can also contain references to other pallets (symlinks)
+to build a Directed Acyclic Graph of key-value search nodes.
+
+The entire structure is indended to live beside configuration management
+code and data in a version control system repository, to enable tagged
+releases of both code, data and metadata.
+
+The toplevel `transforms.yaml` file defines key-value transforms to perform
+when loading the database, e.g. synthesize key-values from pallet metadata.
+
+```
+warehouse
+├── building
+│   └── 1
+│       └── location.yaml
+├── chassis
+│   └── Example:FastServer-128:1234ABCD
+│       ├── identity.yaml
+│       ├── location.yaml
+│       └── rack -> ../../rack/1-A-2/
+├── domain
+│   └── example.com
+│       ├── dns.yaml
+│       ├── ipv4_network -> ../../ipv4_network/192.168.0.0_24/
+│       └── services.yaml
+├── ipv4_interface
+│   ├── 192.168.0.1
+│   │   ├── dns.yaml
+│   │   ├── domain -> ../../domain/example.com/
+│   │   ├── ipv4_network -> ../../ipv4_network/192.168.0.0_24/
+│   │   ├── phy_nic -> ../../phy_nic/14:18:77:ab:cd:ef/
+│   │   └── system -> ../../system/vmhost1/
+│   └── 192.168.0.2
+│       ├── domain -> ../../domain/example.com/
+│       ├── ipv4_network -> ../../ipv4_network/192.168.0.0_24/
+│       ├── phy_nic -> ../../phy_nic/52:54:00:12:34:56/
+│       └── system -> ../../system/testvm/
+├── ipv4_network
+│   └── 192.168.0.0_24
+│       ├── dhcp.yaml
+│       └── identity.yaml
+├── machine
+│   ├── testvm
+│   │   ├── host -> ../../system/vmhost1/
+│   │   └── type.yaml
+│   └── vmhost1
+│       ├── chassis -> ../../chassis/Example:FastServer-128:1234ABCD/
+│       └── type.yaml
+├── netinstall
+│   ├── CentOS-7.2.1511-x86_64-Kickstart_sda
+│   │   ├── kickstart.yaml
+│   │   └── os -> ../../os/CentOS-7.2.1511-x86_64
+│   ├── CentOS-7.2.1511-x86_64-Kickstart_vda
+│   │   ├── kickstart.yaml
+│   │   └── os -> ../../os/CentOS-7.2.1511-x86_64
+│   └── CentOS-7.2.1511-x86_64-Manual
+│       ├── kickstart.yaml
+│       └── os -> ../../os/CentOS-7.2.1511-x86_64
+├── os
+│   └── CentOS-7.2.1511-x86_64
+│       └── kickstart.yaml
+├── phy_nic
+│   ├── 14:18:77:ab:cd:ef
+│   │   ├── chassis -> ../../chassis/Example:FastServer-128:1234ABCD/
+│   │   └── location.yaml
+│   └── 52:54:00:12:34:56
+│       ├── identity.yaml
+│       └── phy_nic -> ../../phy_nic/14:18:77:ab:cd:ef/
+├── rack
+│   └── 1-A-2
+│       ├── location.yaml
+│       └── room -> ../../room/server-room-1/
+├── room
+│   └── server-room-1
+│       ├── building -> ../../building/1
+│       ├── identity.yaml
+│       └── location.yaml
+├── service
+│   ├── dhcp-server-example-net
+│   │   └── kea.yaml
+│   └── dns-resolver-example-com
+│       └── unbound.yaml
+├── system
+│   ├── testvm
+│   │   ├── architecture.yaml
+│   │   ├── domain -> ../../domain/example.com/
+│   │   ├── machine -> ../../machine/testvm/
+│   │   ├── netinstall -> ../../netinstall/CentOS-7.2.1511-x86_64-Kickstart_vda/
+│   │   └── role.yaml
+│   └── vmhost1
+│       ├── architecture.yaml
+│       ├── domain -> ../../domain/example.com/
+│       ├── machine -> ../../machine/vmhost1/
+│       ├── netinstall -> ../../netinstall/CentOS-7.2.1511-x86_64-Kickstart_sda/
+│       └── role.yaml
+└── transforms.yaml
+```
+
+```bash
+% irb -r palletjack
+2.3.1 :001 > jack = PalletJack.new('warehouse')
+2.3.1 :002 > testvm = jack.fetch('system', name:'testvm')
+ => #<PalletJack::Pallet:148ac64>
+2.3.1 :003 > testvm['host.type']
+ => "virtual"
+2.3.1 :004 > jack['system'].each {|pallet| puts "#{pallet['net.dns.name']}: #{pallet['chassis.serial']}" }
+vmhost1: 1234ABCD
+testvm: 1234ABCD
+ => #<Set: {#<PalletJack::Pallet:16abed0>, #<PalletJack::Pallet:148ac64>}>
+2.3.1 :005 > jack['system', with_all:{'host.type' => 'virtual'}].each {|system| puts system['net.dns.name'] }
+testvm
+ => #<Set: {#<PalletJack::Pallet:148ac64>}>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'palletjack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install palletjack
+
+## Creating warehouse objects
+
+Warehouse objects are simple directories, so you can create them using
+`mkdir`. To simplify the process, there are some tools that create
+objects with standard links and YAML structures for you. Example:
+
+```bash
+$ create_domain --warehouse /tmp/warehouse --domain example.com --network 192.168.42.0/24
+$ create_system --warehouse /tmp/warehouse --system vmhost --domain example.com --os CentOS-7.2.1511-x86_64
+$ create_ipv4_interface --warehouse /tmp/warehouse --system vmhost --domain example.com --mac 52:54:00:8d:be:fe --ipv4 192.168.42.1 --network 192.168.42.0/24
+$ dump_pallet --warehouse /tmp/warehouse --type ipv4_interface 192.168.42.1
+```
+
+```yaml
+---
+pallet:
+  ipv4_network: 192.168.42.0_24
+  boxes: []
+  references:
+    ipv4_network: 192.168.42.0_24
+    domain: example.com
+    phy_nic: 52:54:00:8d:be:fe
+    os: CentOS-7.2.1511-x86_64
+    system: vmhost
+  domain: example.com
+  phy_nic: 52:54:00:8d:be:fe
+  os: CentOS-7.2.1511-x86_64
+  system: vmhost
+  ipv4_interface: 192.168.42.1
+net:
+  dhcp:
+    tftp-server: ''
+    boot-file: ''
+  ipv4:
+    gateway: ''
+    prefixlen: '24'
+    cidr: 192.168.42.0/24
+    address: 192.168.42.1
+  dns:
+    resolver:
+    - ''
+    ns:
+    - ''
+    soa-ns: ''
+    soa-contact: ''
+    domain: example.com
+    name: vmhost
+    fqdn: vmhost.example.com
+  service:
+    syslog:
+    - address: syslog-archive.example.com
+      port: 514
+      protocol: udp
+    - address: logstash.example.com
+      port: 5514
+      protocol: tcp
+  layer2:
+    name: ''
+    address: 52:54:00:8d:be:fe
+host:
+  kickstart:
+    baseurl: http://mirror.centos.org/centos/7.2.1511/os/x86_64/
+  pxelinux:
+    kernel: "/boot/CentOS-7.2.1511-x86_64/vmlinuz"
+    config: CentOS-7.2.1511-x86_64
+system:
+  os: CentOS-7.2.1511-x86_64
+  role:
+  - ''
+  name: vmhost
+```
+
+## 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`.
+
+## Contributing
+
+We are happy to accept contributions in the form of issues and pull requests on [GitHub](https://github.com/saab-simc-admin/palletjack). Please follow these guidelines to make the experience as smooth as possible:
+
+- All development takes place in feature branches, with master only accepting non-fast-forward merges.
+
+- Others shall be able to use the Pallet Jack library to build their own tools. To facilitate this, the library and the included tools are packaged as two different Ruby gems, and are intended to be loosely coupled. If you introduce API changes, please increment version numbers according to [semantic versioning](http://semver.org/).
+
+- All code will be reviewed before it is merged. To help the reviewer, send your work as a series of logically separate changes, not as one gigantic squash commit. Make sure bisection will work by ensuring the code actually works after each change.
+
+- GnuPG sign all your commits and tags, with a key that is [validated by GitHub](https://help.github.com/articles/about-gpg-commit-and-tag-signatures/).
+
+  - GitHub's web UI cannot generate signed merges when accepting pull requests. Instead, we use [a custom tool](https://github.com/saab-simc-admin/workflow-tools/tree/master/git-ghpr) to accept them. You can still send them through the web as usual.
+
+  - Your code shall be signed by you. Therefore, the maintainer cannot fix any merge conflicts arising from your pull request. If there are any conflicts, please rebase onto current master before sending your pull request.
+
+- Document your work.
+
+  - At an absolute minimum, Ruby code shall have [RDoc](https://rdoc.github.io/rdoc/) blocks documenting each function, with analogues for other languages (e.g. Python [docstrings](https://www.python.org/dev/peps/pep-0257/)).
+
+  - User-visible features shall have examples in the [`examples/` directory](https://github.com/saab-simc-admin/palletjack/tree/master/examples). In particular, [the example warehouse](https://github.com/saab-simc-admin/palletjack/tree/master/examples/warehouse) shall include demonstrations of all keys used by any included tool.
+
+    - If your code needs larger chunks of static data to work, please provide it in a separate directory under `examples/`. See e.g. [the `examples/pxelinux/` tree](https://github.com/saab-simc-admin/palletjack/tree/master/examples/pxelinux), which contains files required to make sense of the output from `palletjack2pxelinux`.
+
+  - Write your commit messages in the usual Git style: a short summary in the first line, then paragraphs of explanatory text, line wrapped.

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 "palletjack"
+
+# 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/lib/palletjack.rb

@@ -0,0 +1,71 @@
+require 'active_support'
+require 'yaml'
+require 'kvdag'
+require 'palletjack/version'
+require 'palletjack/keytransformer'
+require 'palletjack/pallet'
+
+class PalletJack < KVDAG
+  attr_reader :pallets
+  attr_reader :keytrans_reader
+  attr_reader :keytrans_writer
+
+  def self.load(warehouse)
+    new.load(warehouse)
+  end
+
+  def initialize
+    super
+    @pallets = Hash.new
+  end
+
+  def load(warehouse)
+    @warehouse = File.expand_path(warehouse)
+    key_transforms = YAML::load_file(File.join(@warehouse, "transforms.yaml"))
+    @keytrans_reader = KeyTransformer::Reader.new(key_transforms)
+    @keytrans_writer = KeyTransformer::Writer.new(key_transforms)
+
+    Dir.foreach(@warehouse) do |kind|
+      kindpath = File.join(@warehouse, kind)
+      next unless File.directory?(kindpath) and kind !~ /^\.{1,2}$/
+
+      Dir.foreach(kindpath) do |pallet|
+        palletpath = File.join(kindpath, pallet)
+        next unless File.directory?(palletpath) and pallet !~ /^\.{1,2}$/
+        Pallet.new(self, palletpath)
+      end
+    end
+    self
+  end
+
+  # Search for pallets in a PalletJack warehouse
+  #
+  # The search is filtered by KVDAG::Vertex#match? expressions.
+  #
+  # Useful Pallet methods to match for include:
+  #
+  # kind:: the kind of pallet
+  # name:: the filesystem +basename+ of the pallet
+
+  def [](filter = {})
+    vertices(filter)
+  end
+
+  # Fetch a single pallet from a PalletJack warehouse
+  #
+  # The search is filtered by KVDAG::Vertex#match? expressions.
+  #
+  # Useful Pallet methods to match for include:
+  #
+  # kind:: the kind of pallet
+  # name:: the filesystem +basename+ of the pallet
+
+  def fetch(filter = {})
+    result = self[filter]
+
+    if result.length != 1
+      raise KeyError.new("#{options} matched #{result.length} pallets")
+    end
+    result.first
+  end
+end