Skip to content

Latest commit

 

History

History
93 lines (55 loc) · 4.54 KB

README.md

File metadata and controls

93 lines (55 loc) · 4.54 KB
Raw

Fog::Google

Gem Version Build Status Dependency Status Coverage Status Code Climate Stories in Ready

The main maintainers for the Google sections are @icco, @Temikus and @plribeiro3000. Please send pull requests to them.

As of v0.1.1, Google no longer supports Ruby versions less than 2.0.0.

Storage

There are two ways to access Google Cloud Storage. The old S3 API and the new JSON API. Fog::Storage::Google will automatically direct you to the appropriate API based on the credentials you provide it.

Compute

Google Compute Engine is a Virtual Machine hosting service. Currently it is built on version v1 of the GCE API.

As of 2015-12-07, we believe Fog for Google Compute engine (Fog::Compute::Google) is feature complete.

If you are using Fog to interact with GCE, please keep Fog up to date and file issues for any anomalies you see or features you would like.

SQL

Fog implements v1beta3 of the Google Cloud SQL Admin API. This is a currently deprecated API. Pull Requests for updates would be greatly appreciated.

DNS

Fog implements v1 of the Google Cloud DNS API. We are always looking for people to improve our code and test coverage, so please file issues for any anomalies you see or features you would like.

Monitoring

Fog implements v2beta2 of the Google Cloud Monitoring API. As of 2016-03-15, we believe Fog for Google Cloud Monitoring is feature complete. We are always looking for people to improve our code and test coverage, so please file issues for any anomalies you see or features you would like.

Pubsub

Note: You must have a version of google-api-client > 0.8.5 to use the Pub/Sub API; previous versions will not work.

Fog mostly implements v1 of the Google Cloud Pub/Sub API; however some less common API methods are missing. Pull requests for additions would be greatly appreciated.

Installation

Add the following two lines to your application's Gemfile:

gem 'fog-google'
gem 'google-api-client', '~> 0.8.6'

And then execute:

$ bundle

Or install it yourself as:

$ gem install fog-google

Setup

Credentials

Follow the instructions to generate a private key. You can then create a fog credentials file at ~/.fog, which will look something like this:

my_credential:
    google_project: my-project
    google_client_email: xxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx@developer.gserviceaccount.com
    google_json_key_location: /path/to/my-project-xxxxxxxxxxxx.json

You can also provide service account credentials with google_json_key_string or with google_key_location and google_key_string for P12 private keys.

HMAC credentials follow a similar format:

my_credentials:
	google_storage_access_key_id: GOOGXXXXXXXXXXXXXXXX
	google_storage_secret_access_key: XXXX+XXX/XXXXXXXX+XXXXXXXXXXXXXXXXXXXXX

SSH-ing into instances

If you want to be able to bootstrap SSH-able instances, (using servers.bootstrap,) be sure you have a key in ~/.ssh/id_rsa and ~/.ssh/id_rsa.pub.

Contributing

See CONTRIBUTING.md in this repository.