fog--fog/README.rdoc

http://geemus.com/fog.png

fog helps you interact with cloud services.

The quick and dirty, top to bottom:
* Models provide a simplified interface, making clouds easier to work with and switch between.
* Requests allow power users to get the most out of the features of each individual cloud.
* Mocks make testing and integrating a breeze.

Put them together and you get a great cloud computing experience, but we are getting ahead of ourselves...

== Getting Started

  sudo gem install fog

Now just type 'fog' to trying stuff out, confident that fog should let you know what you need to do. Here is an example of wading through server creation for Amazon Elastic Compute Cloud:

  >> server = AWS.servers.create
  ArgumentError: image_id is required for this operation
  >> server = AWS.servers.create(:image_id => 'ami-5ee70037')
  <Fog::AWS::EC2::Server [...]>
  >> server.destroy # cleanup after yourself or regret it, trust me
  true

== Collections

Nouns like Images and Servers are collections, which form the interface to the cloud.
Some of these collections are shared across multiple providers.
The shared collections for compute resources are flavors, images and servers.
Shared collections for storage are directory and file.

Some common methods for all of these collections are:
* #all - fetch every object of that type from the provider.
* #create  initialize a new record locally and then persists it with the provider.
* #get - fetch a single object by its identity from the provider.
* #new - initialize a new record locally, but do not persist it to the provider.

As an example, we'll try initializing and persisting a Rackspace Cloud server:

  require 'fog'

  # initialize a connection to Rackspace Cloud Servers
  connection = Fog::Rackspace::Servers.new(
    :rackspace_api_key => key,
    :rackspace_username => username
  )

  # boot a gentoo server (flavor 1 = 256, image 3 = gentoo 2008.0)
  server = connection.servers.create(:flavor_id => 1, :image_id => 3, :name => 'my_server')

  # wait for it to be ready to do stuff
  server.wait_for { ready? }

  # DO STUFF

  # shutdown the server
  server.destroy

== Models

Many of the collection methods return individual objects, which provide destroy, save and wait_for methods.
* #destroy - will destroy the persisted object from the provider
* #save - persist the object to the provider
* #wait_for - takes a block and waits for either the block to return true for the object or for a timeout (defaults to 10 minutes)

== Mocks

Mocking provides an in memory representation of the state of cloud resources as you make requests.
Mocked calls to mimic the behavior of each provider while eliminating the cost and time needed to actually use cloud resources.
Enabling mocking easy to use, before you run any other commands run:

  Fog.mock!

Then you can run other commands just like you always would.
Some mocks are not implemented just yet, but fog will raise an error to let you know and contributions are always welcome!

== Requests

Requests allow you to dive deeper when the models just can't cut it.
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
  >> AWS[:ec2].describe_reserved_instances
  #<Excon::Response [...]>

It will return an {excon}[http://github.com/geemus/excon] response, which has #headers and #body. Both return nice hashes.

== Go forth and conquer

Play around and use the console to explore or check out the {getting started guide}[http://wiki.github.com/geemus/fog/getting-started-with-fog] for more details.

You should try out the (varying) support fog has for:
* {AWS}[http://aws.amazon.com] [{EC2}[http://aws.amazon.com/ec2], {ELB}[http://aws.amazon.com/elasticloadbalancing], {S3}[http://aws.amazon.com/s3], {SimpleDB}[http://aws.amazon.com/simpledb]]
* {Rackspace|http://www.rackspace.com} [{Files}[http://www.rackspacecloud.com/cloud_hosting_products/files], {Servers}[http://www.rackspacecloud.com/cloud_hosting_products/servers]]
* {Slicehost}[http://www.slicehost.com]
* {Terremark}[http://www.terremark.com] [{vCloud Express}[http://vcloudexpress.terremark.com]]
* {Blue Box Group}[http://www.blueboxgrp.com] [{Blocks}[http://www.blueboxgrp.com/blocks]]

Enjoy, and let me know what I can do to continue improving fog!

* Work for {twitter}[http://twitter.com]? I'd love to reclaim the unused {@fog}[http://twitter.com/fog] account!
* Follow {@geemus}[http://twitter.com/geemus] on Twitter.
* See upcoming work in the {tracker}[http://www.pivotaltracker.com/projects/54635].
* Report bugs in {issues}[http://github.com/geemus/fog/issues].
* Learn about {contributing}[http://wiki.github.com/geemus/fog/contributors-guide].

== Copyright

(The MIT License)

Copyright (c) 2010 {geemus (Wesley Beary)}[http://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.