• Stars
    star
    4,318
  • Rank 9,974 (Top 0.2 %)
  • Language
    Ruby
  • License
    MIT License
  • Created over 15 years ago
  • Updated 6 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

The Ruby cloud services library.

fog

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.

Build Status Code Climate Gem Version SemVer

Dependency Notice

Currently all fog providers are getting separated into metagems to lower the load 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 avoid unnecessary dependencies.

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

Getting Started

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

Ruby version

Fog requires Ruby 2.0.0 or later.

Ruby 1.8 and 1.9 support was dropped in fog-v2.0.0 as a backwards incompatible change. Please use the later fog 1.x versions if you require 1.8.7 or 1.9.x support.

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:

  • compute providers have flavors, images and servers
  • dns providers have zones and records
  • storage providers have directories and files

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 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:

  • 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

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

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 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 and the provider documentation 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!"

Versioning

Fog library aims to adhere to Semantic Versioning 2.0.0, although it does not address challenges of multi-provider libraries. Semantic versioning is only guaranteed for the common API, not any provider-specific extensions. You may also need to update your configuration from time to time (even between Fog releases) as providers update or deprecate services.

However, we still aim for forwards compatibility within Fog major versions. As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint 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'

Getting Help

Contributing

Please refer to CONTRIBUTING.md.

License

Please refer to LICENSE.md.

More Repositories

1

fog-aws

Module for the 'fog' gem to support Amazon Web Services http://aws.amazon.com/
Ruby
300
star
2

fog-google

Fog for Google Cloud Platform
Ruby
98
star
3

fog-openstack

Fog for OpenStack Platform
Ruby
68
star
4

fog-core

fog's core, shared behaviors without API and provider specifics
Ruby
45
star
5

fog-aliyun

Fog provider for aliyun
Ruby
37
star
6

fog-vsphere

Fog for vSphere
Ruby
36
star
7

fog-azure-rm

Fog for Azure Resource Manager
Ruby
35
star
8

fog-proxmox

Fog module for Proxmox VE Platform
Ruby
31
star
9

fog-backblaze

Integration library for gem fog and Backblaze B2 Cloud Storage
Ruby
19
star
10

fog-azure

Ruby
19
star
11

fog-digitalocean

Fog for DigitalOcean Platform — Edit
Ruby
17
star
12

fog-local

Module for the 'fog' gem to support local filesystem storage
Ruby
17
star
13

fog-libvirt

libvirt provider for fog
Ruby
16
star
14

fog-xenserver

Module for the 'fog' gem to support XENSERVER
Ruby
16
star
15

fog-sakuracloud

Module for the 'fog' gem to support Sakura no Cloud
Ruby
13
star
16

fog-dropbox

Module for the 'fog' gem to support Dropbox http://dropbox.com
Ruby
12
star
17

fog-ovirt

Ruby
11
star
18

fog-rackspace

Rackspace provider gem for Fog ecosystem
Ruby
8
star
19

fog.github.com

fog.io documentation website
JavaScript
8
star
20

fog-dnsimple

Module for the 'fog' gem to support DNSimple.
Ruby
7
star
21

fog-openstack-core

fog's core openstack behaviors without API and cloud provider specifics
Ruby
6
star
22

fog-brightbox

Brightbox Cloud support for the fog gem. Officially supported.
Ruby
5
star
23

fog-radosgw

Ruby
5
star
24

fog-oraclecloud

Fog library for the Oracle Cloud
Ruby
5
star
25

fog-kubevirt

Module for the 'fog' gem to support Kubevirt.
Ruby
5
star
26

fog-powerdns

Module for the 'fog' gem to support PowerDNS
Ruby
4
star
27

fog-internet-archive

Internet Archive Storage support for Fog
Ruby
4
star
28

fog-akamai

Module for the 'fog' gem to support Akamai http://www.akamai.com/
Ruby
3
star
29

fog-profitbricks

Module for the 'fog' gem to support ProfitBricks
Ruby
3
star
30

fog-dynect

Module for the 'fog' gem to support Dyn Managed DNS http://dyn.com/
Ruby
3
star
31

fog-xml

Shared XML related functionality for fog
Ruby
2
star
32

fog-hadoop

Fog connector for Hadoop
Ruby
2
star
33

fog-cloudatcost

Module for the 'fog' gem to support CloudAtCost Services http://panel.cloudatcost.com/
Ruby
2
star
34

fog-linode

Fog provider for Linode
Ruby
2
star
35

fog-riakcs

Module for the 'fog' gem to support RiakCS
Ruby
2
star
36

fog-json

Shared JSON related functionality for fog
Ruby
2
star
37

fog-packet

Fog for Packet
Ruby
2
star
38

fog-cloudstack

Ruby
1
star
39

fog-joyent

Module for the 'fog' gem to support Joyent
Ruby
1
star
40

fog-softlayer

Ruby
1
star
41

fog-ecloud

Module for the 'fog' gem to support Terremark Enterprise Cloud
Ruby
1
star
42

fog-vmfusion

Module for the 'fog' gem to support VMWARE Fusion
Ruby
1
star
43

fog-dnsmadeeasy

Fog DNS Made Easy Module
Ruby
1
star