1
0
Fork 0
mirror of https://github.com/fog/fog.git synced 2022-11-09 13:51:43 -05:00
fog--fog/lib/fog/rackspace/examples/README.md

47 lines
1.5 KiB
Markdown
Raw Normal View History

2013-01-24 13:40:36 -05:00
# Getting Started Examples
## Download
2013-01-24 13:49:34 -05:00
Examples using the Rackspace Open Cloud and Fog can be found in the [fog repository](https://github.com/fog/fog) under the directory `fog/lib/fog/rackspace/examples`.
2013-01-24 13:40:36 -05:00
This repository can be downloaded via `git` by executing the following:
git clone git://github.com/fog/fog.git
2013-01-24 13:49:34 -05:00
Optionally you can download a zip by clicking on this [link](https://github.com/fog/fog/archive/master.zip).
2013-01-24 13:40:36 -05:00
## Requirements
2013-01-24 13:49:34 -05:00
Examples require the following:
2013-01-24 13:40:36 -05:00
2013-01-24 13:49:34 -05:00
* Rackspace Open Cloud account
2013-01-24 13:40:36 -05:00
* Ruby 1.8.x or 1.9.x
* `fog` gem
For more information please refer to the [Getting Started with Fog and the Rackspace Open Cloud](https://github.com/fog/fog/blob/master/lib/fog/rackspace/docs/getting_started.md) document.
## Credentials
2013-01-24 13:49:34 -05:00
Examples will prompt for Rackspace Open Cloud credentials. Prompts can be skipped by creating a `.fog` file in the user's home directory. This is an example of a `.fog` file for the Rackspace Open Cloud:
2013-01-24 13:40:36 -05:00
default:
rackspace_username: RACKSPACE_USERNAME
2013-01-24 13:49:34 -05:00
rackspace_api_key: RACKSPACE_API_KEY
2013-01-24 13:40:36 -05:00
2013-01-24 13:49:34 -05:00
***Note:* Replace capitalized values with the appropriate credential information.*
2013-01-24 13:40:36 -05:00
## Executing
2013-01-24 13:49:34 -05:00
To execute scripts using `bundler`:
2013-01-24 13:40:36 -05:00
bundle exec ruby <script>
2013-01-24 13:49:34 -05:00
To execute scripts without `bundler`:
2013-01-24 13:40:36 -05:00
ruby <script>
## Support and Feedback
2013-01-24 13:49:34 -05:00
2013-01-24 13:40:36 -05:00
Your feedback is appreciated! If you have specific issues with the **fog** SDK, developers should file an [issue via Github](https://github.com/fog/fog/issues).
For general feedback and support requests, send an email to: <sdk-support@rackspace.com>.