hyperkit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c987dcdd24e8fd164c8c1aa0ba7d6424413afbf
+  data.tar.gz: f1cb3dccfbe526352a95b237e3f02e09371df577
+SHA512:
+  metadata.gz: 21984f55160a78b75d64971d67ea3ff45d8d5017ff3f34c7b985a265c34961844f0717680fa0c7e3061a67328cbb3c68bc65219c15e2f73687b0328c0e38acd0
+  data.tar.gz: 37e780a30ca13a612637de881d91d8ea86ca83c8fb9e1f89faff770313458bbfee028c9c382dd6036241e7ea524ebec8641baa565f5380a347ed1b4bc1e59f70

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-gemset
+/.ruby-version
+/.vagrant
+.*.swp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.11.2

data/.yardopts

@@ -0,0 +1 @@
+--type-tag async:"Asynchronous"

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,23 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'awesome_print', :require => 'ap'
+  gem 'guard-rspec', '~> 4.6'
+  gem 'hirb-unicode'
+  gem 'pry'
+  gem 'yard'
+  gem 'rake'
+end
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'multi_json', '~> 1.11.0'
+  gem 'rb-fsevent', '~> 0.9'
+  gem 'rspec', '~> 3.0.0'
+  gem 'simplecov', :require => false
+  gem 'vcr', '~> 3.0'
+  gem 'webmock', '~> 1.24.2'
+end
+
+# Specify your gem's dependencies in hyperkit.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,43 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+end

data/LICENSE.txt

@@ -0,0 +1,47 @@
+================================================================================
+The MIT License (MIT)
+
+Copyright (c) 2016, Western University
+
+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.
+
+--------------------------------------------------------------------------
+Portions of this software adapted or taken from Octokit.
+The original license text is below:
+--------------------------------------------------------------------------
+
+Copyright (c) 2009-2016 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober
+
+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,341 @@
+# Hyperkit
+
+Hyperkit is a flat API wrapper for LXD, the next-generation hypervisor.  It is
+shamelessly based on the design of Octokit, the popular wrapper for the GitHub
+API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hyperkit'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install hyperkit
+```
+
+## Usage examples
+
+```ruby
+require 'hyperkit'
+
+lxd = Hyperkit::Client.new(api_endpoint: "https://lxd.example.com", verify_ssl: false)
+
+# Create a new container and start it
+lxd.create_container("test-container", alias: "ubuntu/trusty/amd64")
+lxd.start_container("test-container")
+
+# Execute a command in a container
+lxd.execute_command("test-container", "bash -c 'echo hello > /tmp/test.txt'")
+
+# Create an image from a container and assign an alias to it
+response = lxd.create_image_from_container("test-container")
+lxd.create_image_alias(response.metadata.fingerprint, "ubuntu/custom")
+
+# Take a snapshot of a container (note that CRIU must be installed to snapshot
+# a running container)
+lxd.create_snapshot("test-container", "test-snapshot")
+
+# Migrate a container (or a snapshot) from one server to another
+# Note that CRIU must be installed on both LXD servers to migrate a running
+# container.
+lxd2 = Hyperkit::Client.new(api_endpoint: "https://lxd2.example.com")
+source = lxd2.init_migration("remote-container")
+lxd.migrate_container(source, "migrated-container")
+```
+
+Each method in the API documentation has at least one example of its usage.   Please see the documentation for the following modules:
+
+* [Certificates]()
+* [Containers]()
+* [Images]()
+* [Networks]()
+* [Operations]()
+* [Profiles]()
+
+## Requirements
+
+Hyperkit supports **LXD 2.0.0 and above**, and **Ruby 2.0 and above**.
+
+To get started, you'll need to first enable the HTTPS API on your LXD server:
+
+```
+$ lxc config set core.https_address 127.0.0.1
+```
+
+To listen on all interfaces, replace `127.0.0.1` with `0.0.0.0`.
+
+### Making requests
+
+Being based on Octokit, [API methods][] are available as module methods
+(consuming module-level configuration) or as client instance methods.
+
+```ruby
+Hyperkit.configure do |c|
+  c.api_endpoint = 'https://lxd.example.com:8443'
+  c.verify_ssl = false
+end
+
+# Create an Ubuntu 14.04 container
+Hyperkit.create_container("test-container", alias: "ubuntu/trusty/amd64")
+```
+or
+
+```ruby
+client = Octokit::Client.new(api_endpoint: 'https://lxd.example.com:8443', verify_ssl: false)
+
+# Create an Ubuntu 14.04 container
+client.create_container("test-container", alias: "ubuntu/trusty/amd64")
+```
+
+[API methods]: http://TODO
+
+## Authentication
+
+The LXD API uses client-side certificates to authenticate clients.  By
+default, Hyperkit uses the following files:
+
+* Certificate: `ENV['HOME']/.config/lxc/client.crt`
+* Private key: `ENV['HOME']/.config/lxc/client.key`
+
+To specify alternate files:
+
+```
+client = Hyperkit::Client.new(client_cert: '/path/to/crt/file', client_key: '/path/to/key/file')
+```
+
+or, to configure all new instances of Hyperkit:
+
+```
+Hyperkit.configure do |c|
+  c.client_cert = '/path/to/crt/file'
+  c.client_key = '/path/to/key/file'
+end
+```
+
+If you're running Hyperkit on your LXD host, the `lxc` tool should have
+already generated your certificate and private key for you, and placed them in
+`~/.config/lxc`.
+
+If you are running Hyperkit on a different host, you'll need to generate a
+certificate and private key.  To do this, install OpenSSL and issue the
+following commands:
+
+```
+mkdir -p ~/.config/lxc
+openssl req -x509 -newkey rsa:2048 -keyout ~/.config/lxc/client.key.secure -out ~/.config/lxc/client.crt -days 3650
+openssl rsa -in ~/.config/lxc/client.key.secure -out ~/.config/lxc/client.key
+```
+
+You will then need to tell LXD to trust your certificate.  You can do this in
+two ways:
+
+### Option 1: Trusting your certificate using a trust password
+
+If you have configured your LXD server with a trust password, you can use
+Hyperkit to get your certificate trusted:
+
+```ruby
+require 'hyperkit'
+
+Hyperkit.api_endpoint = 'https://lxd.example.com:8443'
+Hyperkit.verify_ssl = false   # Needed if you're using a self-signed certificate on the server
+
+Hyperkit.create_certificate(File.read("/path/to/your/client.crt"), password: "server-trust-password")
+```
+
+### Option 2: Trusting your certificate using the `lxc` tool
+
+Alternatively, you can simply copy your certificate file to the LXD server and
+use the `lxc` tool to trust it:
+
+```
+lxd-server$ lxc config trust add my-new-cert.crt
+```
+
+## API coverage
+
+Hyperkit supports the entirety of [version 1.0 of the LXD
+API](https://github.com/lxc/lxd/blob/master/specs/rest-api.md), but does not
+support any of the Websocket API calls (e.g. `/1.0/events`).
+
+## Asynchronous Operations
+
+A good deal of the LXD API calls are asynchronous: you issue the call, and you
+receive an operation ID.  You must then wait on the operation to complete.
+Each asynchronous method is marked as such in the Hyperkit documentation.
+
+**By default, Hyperkit provides auto-synchronization**.  When you initiate an
+asynchronous operation, Hyperkit will automatically wait for the operation to
+complete before returning.
+
+For example,
+
+```ruby
+# By default, this will block until the container is created
+Hyperkit.create_container("test-container", alias: "ubuntu/trusty/amd64")
+```
+
+If you wish to override this functionality, there are two ways to do this.
+First, you can pass `sync: false` to any of the asynchronous methods:
+
+```ruby
+# Initiates the operation and immediately returns an operation ID
+op = Hyperkit.create_container("test-container", alias: "ubuntu/trusty/amd64", sync: false)
+
+# Blocks until the operation is complete
+Hyperkit.wait_for_operation(op.id)
+```
+
+Alternatively, you can disable auto-synchronization at the module or class
+level:
+
+```ruby
+Hyperkit.auto_sync = false
+
+# or
+
+client = Hyperkit::Client.new(auto_sync: false)
+```
+
+Any asynchronous calls you issue after setting `auto_sync` to `false` will
+immediately return an operation ID instead of blocking.  To ensure that an
+operation is complete, you will need to call `wait_for_operation`:
+
+```ruby
+Hyperkit.auto_sync = false
+
+op = Hyperkit.create_container("test-container", alias: "ubuntu/trusty/amd64")
+Hyperkit.wait_for_operation(op.id)
+```
+
+Note that, after an operation completes, LXD keeps it around for only 5
+seconds, so if you wait too long to call `wait_for_operation`, you'll get an
+exception when you eventually do call it.
+
+Most users will likely want to keep `auto_sync` enabled for convenience.
+
+
+## Configuration and defaults
+
+Hyperkit allows you to configure a new `Hyperkit::Client` instance by passing
+options to its constructor.
+
+As in Octokit, you also have the option of setting configuration at the module
+level.  If you need to create a number of client instances which will share
+certain options, this ability will be useful.
+
+When you change options at the module level, only new `Hyperkit::Client`
+instances will be affected -- any existing instances that you have created
+will retain their existing configuration.
+
+### Configuring module defaults
+
+Every writable attribute in {Hyperkit::Configurable} can be set one at a time:
+
+```ruby
+Hyperkit.api_endpoint = 'https://lxd.example.com:8443'
+Hyperkit.verify_ssl   = false
+Hyperkit.client_cert  = '/home/user/client.crt'
+Hyperkit.client_key   = '/home/user/client.key'
+```
+
+or in batch:
+
+```ruby
+Hyperkit.configure do |c|
+  c.api_endpoint = 'https://lxd.example.com:8443'
+  c.verify_ssl   = false
+  c.client_cert  = '/home/user/client.crt'
+  c.client_key   = '/home/user/client.key'
+end
+```
+
+### Using ENV variables
+
+Default configuration values are specified in {Hyperkit::Default}. Many
+attributes will look for a default value from the `ENV` before returning
+Hyperkit's default.
+
+```ruby
+# Given $HYPERKIT_API_ENDPOINT is "https://lxd.example.com:8443"
+Hyperkit.api_endpoint
+
+# => "https://lxd.example.com:8443"
+```
+
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against][travis] the following
+Ruby implementations:
+
+* Ruby 2.0
+* Ruby 2.1
+* Ruby 2.2
+
+If something doesn't work on one of these interpreters, it's a bug.  This
+library may inadvertently work (or seem to work) on other Ruby
+implementations, however support will only be provided for the versions listed
+above.
+
+If you would like this library to support another Ruby version, you may
+volunteer to be a maintainer. Being a maintainer entails making sure all tests
+run and pass on that implementation. When something breaks on your
+implementation, you will be responsible for providing patches in a timely
+fashion. If critical issues for a particular implementation exist at the time
+of a major release, support for that Ruby version may be dropped.
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint][pvc] with two digits of precision. For example:
+
+```ruby
+spec.add_dependency 'hyperkit', '~> 1.0'
+```
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+
+## 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/jeffshantz/hyperkit. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).  Its design is based on Octokit,
+also licensed under the MIT license.  See the file `LICENSE.txt` for more
+information.
+