Phoenix5k

Attempt at Grid5k's SID API, using Restfully Ruby library.

The idea here is to abstract the API to a more user-friendly GUI, initially to monitor jobs, but ultimately to be able to deploy, too.

Installation

Add this line to your application's Gemfile:

gem 'phoenix5k'

And then execute:

$ bundle

Or install it yourself as:

$ gem install phoenix5k

Usage

###Create a connection configuration

$ mkdir -p ~/.restfully && echo '
uri: https://api.grid5000.fr/sid/
username: LOGIN
password: PASSWORD
' > ~/.restfully/api.grid5000.fr.yml && chmod 600 ~/.restfully/api.grid5000.fr.yml

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.

Additional ressources

• SID API - Grid5k API v4.0 documentation
• Grid+Restfully - Grid's developer interface tutorial
• Restfully - Restfully git repo

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/lplit/phoenix5k. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.