mirror of
https://github.com/fog/fog.git
synced 2022-11-09 13:51:43 -05:00
tweaking examples document
This commit is contained in:
parent
c1d894ec4a
commit
9543504ba7
1 changed files with 47 additions and 0 deletions
47
lib/fog/rackspace/examples/cloud_servers/README.md
Normal file
47
lib/fog/rackspace/examples/cloud_servers/README.md
Normal file
|
@ -0,0 +1,47 @@
|
|||
# Getting Started Examples
|
||||
|
||||
## Download
|
||||
|
||||
Examples using the Rackspace Open Cloud and Fog can be found in the [fog repository](https://github.com/fog/fog) under the `fog/lib/fog/rackspace/examples` directory.
|
||||
|
||||
This repository can be downloaded via `git` by executing the following:
|
||||
|
||||
git clone git://github.com/fog/fog.git
|
||||
|
||||
Optionally you can download a zip by clicking on this [link](https://github.com/fog/fog/archive/master.zip).
|
||||
|
||||
## Requirements
|
||||
|
||||
Examples require the following:
|
||||
|
||||
* Rackspace Open Cloud account
|
||||
* 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
|
||||
|
||||
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:
|
||||
|
||||
default:
|
||||
rackspace_username: RACKSPACE_USERNAME
|
||||
rackspace_api_key: RACKSPACE_API_KEY
|
||||
|
||||
***Note:* Replace capitalized values with the appropriate credential information.*
|
||||
|
||||
## Executing
|
||||
|
||||
To execute scripts using `bundler`:
|
||||
|
||||
bundle exec ruby <script>
|
||||
|
||||
To execute scripts without `bundler`:
|
||||
|
||||
ruby <script>
|
||||
|
||||
## Support and Feedback
|
||||
|
||||
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>.
|
Loading…
Add table
Reference in a new issue