cloudstack_helper 0.2 → 0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. data/README.md +23 -4
  2. data/cloudstack_helper.gemspec +1 -1
  3. metadata +3 -3
data/README.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # cloudstack_helper
2
- cloudstack_helper is a simple ruby library that helps making request to CloudStack API easier. With cloudstack_helper, you only have to specify the command the parameters for the request and it will handle everything for you.
2
+ cloudstack_helper is a simple ruby library that helps making request to CloudStack API easier. With cloudstack_helper, you only have to specify the command and the parameters for the request, and it will handle everything for you.
3
3
 
4
4
  ## Library Usage
5
5
 
@@ -18,8 +18,27 @@ cloudstack_helper is a simple ruby library that helps making request to CloudSta
18
18
  puts cs_helper.get(params).body
19
19
  ```
20
20
 
21
- ## Executable Script Usage
21
+ ## Script Usage
22
22
  ```
23
- cloudstack_rb -x listUsers domainid=1
24
- cloudstack_rb -x deployVirtualMachine serviceofferingid=12 templateid=4 zoneid=1 displayname=ohyea
23
+ Usage: cloudstack_rb -c conf -x command param1=value1 param2=value2
24
+ -x, --execute COMMAND command to execute. See CloudStack API for list of commands.
25
+ -c, --conf FILE YAML config file that stores api and secret key
26
+ -h, --help Show this message.
27
+
28
+ ```
29
+
30
+ ####Examples
31
+ ```
32
+ cloudstack_rb -x listUsers domainid=1
33
+ cloudstack_rb -x listUsers domainid=1 response=json
34
+ cloudstack_rb -x deployVirtualMachine serviceofferingid=12 templateid=4 zoneid=1 displayname=ohyea
35
+ ```
36
+
37
+ ####Configuration
38
+ By default, if you don't specify a config file, cloudstack_rb assumes there is a config file in the current working directory under the name 'cloudstack.yaml'
39
+ The config file should look like this
25
40
  ```
41
+ api_url: "http://mycloudstack:8080/client/api"
42
+ api_key: "WiUVlx74PpVE8w7z7J7gtojiOQasdaFL3A054D_IPeSxxcm1PadgasdgujGSJBGiS2uBcG0GoLwLisosDCA"
43
+ secret_key: "uqzgrfMXnYSVvUiasdgj0DgvtXBemILs_npqi90Ki0xigOKjagvQTtYg093EUrHSLZJEnI3lV1z9PrQmv2SxQ"
44
+ ````
@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path("../lib", __FILE__)
4
4
 
5
5
  Gem::Specification.new do |s|
6
6
  s.name = "cloudstack_helper"
7
- s.version = "0.2"
7
+ s.version = "0.3"
8
8
  s.platform = Gem::Platform::RUBY
9
9
  s.authors = ["Darren Dao"]
10
10
  s.email = ["darrendao@gmail.com"]
metadata CHANGED
@@ -1,12 +1,12 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cloudstack_helper
3
3
  version: !ruby/object:Gem::Version
4
- hash: 15
4
+ hash: 13
5
5
  prerelease:
6
6
  segments:
7
7
  - 0
8
- - 2
9
- version: "0.2"
8
+ - 3
9
+ version: "0.3"
10
10
  platform: ruby
11
11
  authors:
12
12
  - Darren Dao