Path: | README.md |
Last Update: | Fri Aug 24 21:28:19 +0000 2012 |
![fog]()
fog is the Ruby cloud computing library, top to bottom:
## Getting Started
sudo gem install fog
Now type `fog` to try stuff, confident that fog will let you know what to do. Here is an example of wading through server creation for Amazon Elastic Compute Cloud:
>> server = Compute[:aws].servers.create ArgumentError: image_id is required for this operation >> server = Compute[:aws].servers.create(:image_id => 'ami-5ee70037') <Fog::AWS::EC2::Server [...]> >> server.destroy # cleanup after yourself or regret it, trust me true
## Collections
A high level interface to each cloud is provided through collections, such as `images` and `servers`. You can see a list of available collections by calling `collections` on the connection object. You can try it out using the `fog` command:
>> Compute[:aws].collections [:addresses, :directories, ..., :volumes, :zones]
Some collections are available across multiple providers:
Collections share basic CRUD type operations, such as:
As an example, we‘ll try initializing and persisting a Rackspace Cloud server:
require 'fog' compute = Fog::Compute.new( :provider => 'Rackspace', :rackspace_api_key => key, :rackspace_username => username ) # boot a gentoo server (flavor 1 = 256, image 3 = gentoo 2008.0) server = compute.servers.create(:flavor_id => 1, :image_id => 3, :name => 'my_server') server.wait_for { ready? } # give server time to boot # DO STUFF server.destroy # cleanup after yourself or regret it, trust me
## Models
Many of the collection methods return individual objects, which also provide common methods:
## Mocks
As you might imagine, testing code using Fog can be slow and expensive, constantly turning on and and shutting down instances. Mocking allows skipping this overhead by providing an in memory representation resources as you make requests. Enabling mocking easy to use, before you run other commands, simply run:
Fog.mock!
Then proceed as usual, if you run into unimplemented mocks, fog will raise an error and as always contributions are welcome!
## Requests
Requests allow you to dive deeper when the models just can‘t cut it. You can see a list of available requests by calling `requests` on the connection object.
For instance, ec2 provides methods related to reserved instances that don‘t have any models (yet). Here is how you can lookup your reserved instances:
$ fog >> Compute[:aws].describe_reserved_instances #<Excon::Response [...]>
It will return an [excon](github.com/geemus/excon) response, which has `body`, `headers` and `status`. Both return nice hashes.
## Go forth and conquer
Play around and use the console to explore or check out [fog.io](fog.io) for more details and examples. Once you are ready to start scripting fog, here is a quick hint on how to make connections without the command line thing to help you.
# create a compute connection compute = Fog::Compute.new(:provider => 'AWS', :aws_access_key_id => ACCESS_KEY_ID, :aws_secret_access_key => SECRET_ACCESS_KEY) # compute operations go here # create a storage connection storage = Fog::Storage.new(:provider => 'AWS', :aws_access_key_id => ACCESS_KEY_ID, :aws_secret_access_key => SECRET_ACCESS_KEY) # storage operations go here
geemus says: "That should give you everything you need to get started, but let me know if there is anything I can do to help!"
## Contributing
## Additional Resources
[fog.io](fog.io)
## Sponsorship
![Engine Yard]()
All new work on fog is sponsored by [Engine Yard](engineyard.com)
## Copyright
(The MIT License)
Copyright (c) 2010 [geemus (Wesley Beary)](github.com/geemus)
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.