Repository files navigation

fog is the Ruby cloud services library, top to bottom:

• Collections 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.

Currently all fog providers are getting separated into metagems to lower theload time and dependency count.

If there's a metagem available for your cloud provider, e.g.fog-aws,you should be using it instead of requiring the full fog collection to avoidunnecessary dependencies.

'fog' should be required explicitly only if the provider you use doesn't yethave a metagem available.

The easiest way to learn fog is to install the gem and use the interactive console.Here is an example of wading through server creation for Amazon Elastic Compute Cloud:

$ sudo gem install fog[...]$ fog  Welcome to fog interactive!  :default provides [...]>> server = Compute[:aws].servers.createArgumentError: 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 metrue

Fog requires Ruby2.0.0 or later.

Ruby1.8 and1.9 support was dropped infog-v2.0.0 as a backwards incompatiblechange. Please use the later fog1.x versions if you require1.8.7 or1.9.x support.

A high level interface to each cloud is provided through collections, such asimages andservers.You can see a list of available collections by callingcollections on the connection object.You can try it out using thefog command:

>> Compute[:aws].collections[:addresses, :directories, ..., :volumes, :zones]

Some collections are available across multiple providers:

• compute providers haveflavors,images andservers
• dns providers havezones andrecords
• storage providers havedirectories andfiles

Collections share basic CRUD type operations, such as:

• all - fetch every object of that type from the provider.
• create - initialize a new record locally and a remote resource with the provider.
• get - fetch a single object by its identity from the provider.
• new - initialize a new record locally, but do not create a remote resource with the provider.

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 STUFFserver.destroy# cleanup after yourself or regret it, trust me

Many of the collection methods return individual objects, which also provide common 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)

As you might imagine, testing code using Fog can be slow and expensive, constantly turning on and shutting down instances.Mocking allows skipping this overhead by providing an in memory representation of resources as you make requests.Enabling mocking is 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 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 anexcon response, which hasbody,headers andstatus. Both return nice hashes.

Play around and use the console to explore or check outfog.github.io and theprovider documentationfor 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 connectioncompute=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 connectionstorage=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!"

Fog library aims to adhere toSemantic Versioning 2.0.0, although it does notaddress challenges of multi-provider libraries. Semantic versioning is only guaranteed forthe common API, not any provider-specific extensions. You may also need to update yourconfiguration from time to time (even between Fog releases) as providers update or deprecateservices.

However, we still aim for forwards compatibility within Fog major versions. As a result of this policy, you can (andshould) specify a dependency on this gem using thePessimistic VersionConstraint with two digits of precision. For example:

spec.add_dependency'fog','~> 1.0'

This means your project is compatible with Fog 1.0 up until 2.0. You can also set a higher minimum version:

spec.add_dependency'fog','~> 1.16'

• General Documentation.
• Provider Specific Documentation.
• Ask specific questions onStack Overflow
• Report bugs and discuss potential features inGithub issues.

Please refer toCONTRIBUTING.md.

Please refer toLICENSE.md.