ropenstack 1.2.1 → 2.0.0

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 (113) hide show
  1. data/.gitignore +1 -0
  2. data/README.md +2 -1
  3. data/doc/Ropenstack.html +151 -0
  4. data/doc/Ropenstack/Cinder.html +197 -0
  5. data/doc/Ropenstack/Glance.html +292 -0
  6. data/doc/Ropenstack/Keystone.html +737 -0
  7. data/doc/Ropenstack/MalformedRequestError.html +142 -0
  8. data/doc/Ropenstack/NotFoundError.html +142 -0
  9. data/doc/Ropenstack/Nova.html +562 -0
  10. data/doc/Ropenstack/OpenstackService.html +199 -0
  11. data/doc/Ropenstack/Quantum.html +830 -0
  12. data/doc/Ropenstack/Rest.html +483 -0
  13. data/doc/Ropenstack/RopenstackError.html +143 -0
  14. data/doc/Ropenstack/TimeoutError.html +142 -0
  15. data/doc/Ropenstack/UnauthorisedError.html +142 -0
  16. data/doc/created.rid +10 -0
  17. data/doc/images/add.png +0 -0
  18. data/doc/images/brick.png +0 -0
  19. data/doc/images/brick_link.png +0 -0
  20. data/doc/images/bug.png +0 -0
  21. data/doc/images/bullet_black.png +0 -0
  22. data/doc/images/bullet_toggle_minus.png +0 -0
  23. data/doc/images/bullet_toggle_plus.png +0 -0
  24. data/doc/images/date.png +0 -0
  25. data/doc/images/delete.png +0 -0
  26. data/doc/images/find.png +0 -0
  27. data/doc/images/loadingAnimation.gif +0 -0
  28. data/doc/images/macFFBgHack.png +0 -0
  29. data/doc/images/package.png +0 -0
  30. data/doc/images/page_green.png +0 -0
  31. data/doc/images/page_white_text.png +0 -0
  32. data/doc/images/page_white_width.png +0 -0
  33. data/doc/images/plugin.png +0 -0
  34. data/doc/images/ruby.png +0 -0
  35. data/doc/images/tag_blue.png +0 -0
  36. data/doc/images/tag_green.png +0 -0
  37. data/doc/images/transparent.png +0 -0
  38. data/doc/images/wrench.png +0 -0
  39. data/doc/images/wrench_orange.png +0 -0
  40. data/doc/images/zoom.png +0 -0
  41. data/doc/index.html +93 -0
  42. data/doc/js/darkfish.js +153 -0
  43. data/doc/js/jquery.js +18 -0
  44. data/doc/js/navigation.js +142 -0
  45. data/doc/js/search.js +94 -0
  46. data/doc/js/search_index.js +1 -0
  47. data/doc/js/searcher.js +228 -0
  48. data/doc/rdoc.css +543 -0
  49. data/doc/table_of_contents.html +200 -0
  50. data/lib/ropenstack.rb +18 -0
  51. data/lib/ropenstack/blockStorage.rb +25 -0
  52. data/lib/ropenstack/blockStorage/v1.rb +67 -0
  53. data/lib/ropenstack/blockStorage/v2.rb +11 -0
  54. data/lib/ropenstack/common/error.rb +12 -0
  55. data/lib/ropenstack/common/openstackservice.rb +28 -0
  56. data/lib/ropenstack/common/rest.rb +138 -0
  57. data/lib/ropenstack/compute.rb +164 -0
  58. data/lib/ropenstack/compute/v2.rb +11 -0
  59. data/lib/ropenstack/compute/v2/extensions.rb +14 -0
  60. data/lib/ropenstack/compute/v2/extensions/admin.rb +0 -0
  61. data/lib/ropenstack/compute/v2/extensions/agents.rb +0 -0
  62. data/lib/ropenstack/compute/v2/extensions/aggregates.rb +0 -0
  63. data/lib/ropenstack/compute/v2/extensions/certificates.rb +0 -0
  64. data/lib/ropenstack/compute/v2/extensions/cloudpipe.rb +0 -0
  65. data/lib/ropenstack/compute/v2/extensions/console.rb +0 -0
  66. data/lib/ropenstack/compute/v2/extensions/coverage.rb +0 -0
  67. data/lib/ropenstack/compute/v2/extensions/defaultsecuritygroup.rb +0 -0
  68. data/lib/ropenstack/compute/v2/extensions/diagnostics.rb +0 -0
  69. data/lib/ropenstack/compute/v2/extensions/extraspecs.rb +0 -0
  70. data/lib/ropenstack/compute/v2/extensions/fixedips.rb +0 -0
  71. data/lib/ropenstack/compute/v2/extensions/flavors.rb +0 -0
  72. data/lib/ropenstack/compute/v2/extensions/hosts.rb +0 -0
  73. data/lib/ropenstack/compute/v2/extensions/hypervisors.rb +0 -0
  74. data/lib/ropenstack/compute/v2/extensions/images.rb +0 -0
  75. data/lib/ropenstack/compute/v2/extensions/instanceactions.rb +0 -0
  76. data/lib/ropenstack/compute/v2/extensions/interfaces.rb +0 -0
  77. data/lib/ropenstack/compute/v2/extensions/keypairs.rb +20 -0
  78. data/lib/ropenstack/compute/v2/extensions/limits.rb +0 -0
  79. data/lib/ropenstack/compute/v2/extensions/migrations.rb +0 -0
  80. data/lib/ropenstack/compute/v2/extensions/networks.rb +0 -0
  81. data/lib/ropenstack/compute/v2/extensions/quotasets.rb +0 -0
  82. data/lib/ropenstack/compute/v2/extensions/securitygroups.rb +40 -0
  83. data/lib/ropenstack/compute/v2/extensions/servergroups.rb +0 -0
  84. data/lib/ropenstack/compute/v2/extensions/serverpassword.rb +0 -0
  85. data/lib/ropenstack/compute/v2/extensions/services.rb +0 -0
  86. data/lib/ropenstack/compute/v2/extensions/shelvedservers.rb +0 -0
  87. data/lib/ropenstack/compute/v2/extensions/usage.rb +0 -0
  88. data/lib/ropenstack/compute/v2/extensions/virtualinterfaces.rb +0 -0
  89. data/lib/ropenstack/compute/v2/extensions/volumes.rb +20 -0
  90. data/lib/ropenstack/compute/v3.rb +5 -0
  91. data/lib/ropenstack/database.rb +24 -0
  92. data/lib/ropenstack/database/v1.rb +113 -0
  93. data/lib/ropenstack/identity.rb +28 -0
  94. data/lib/ropenstack/identity/v2.rb +178 -0
  95. data/lib/ropenstack/identity/v3.rb +13 -0
  96. data/lib/ropenstack/image.rb +25 -0
  97. data/lib/ropenstack/image/v1.rb +107 -0
  98. data/lib/ropenstack/image/v2.rb +134 -0
  99. data/lib/ropenstack/networking.rb +160 -0
  100. data/lib/ropenstack/networking/v2.rb +5 -0
  101. data/lib/ropenstack/networking/v2/extensions.rb +9 -0
  102. data/lib/ropenstack/networking/v2/extensions/l3.rb +111 -0
  103. data/lib/ropenstack/networking/v2/extensions/lbaas.rb +5 -0
  104. data/lib/ropenstack/networking/v2/extensions/metering.rb +5 -0
  105. data/lib/ropenstack/networking/v2/extensions/quotas.rb +5 -0
  106. data/lib/ropenstack/networking/v2/extensions/securitygroups.rb +5 -0
  107. data/lib/ropenstack/objectStorage.rb +60 -0
  108. data/lib/ropenstack/orchestration.rb +23 -0
  109. data/lib/ropenstack/orchestration/v1.rb +162 -0
  110. data/lib/ropenstack/telemetry.rb +23 -0
  111. data/lib/ropenstack/telemetry/v2.rb +68 -0
  112. data/ropenstack.gemspec +13 -0
  113. metadata +112 -1
@@ -0,0 +1,142 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class Ropenstack::MalformedRequestError - RDoc Documentation</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>lib/ropenstack/error.rb
51
+ </ul>
52
+ </nav>
53
+
54
+
55
+ </div>
56
+
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link"><a href="RopenstackError.html">Ropenstack::RopenstackError</a>
63
+
64
+ </nav>
65
+
66
+
67
+
68
+ </div>
69
+
70
+ <div id="project-metadata">
71
+
72
+ <nav id="classindex-section" class="section project-section">
73
+ <h3 class="section-header">Class and Module Index</h3>
74
+
75
+ <ul class="link-list">
76
+
77
+ <li><a href="../Ropenstack.html">Ropenstack</a>
78
+
79
+ <li><a href="../Ropenstack/Cinder.html">Ropenstack::Cinder</a>
80
+
81
+ <li><a href="../Ropenstack/Glance.html">Ropenstack::Glance</a>
82
+
83
+ <li><a href="../Ropenstack/Keystone.html">Ropenstack::Keystone</a>
84
+
85
+ <li><a href="../Ropenstack/MalformedRequestError.html">Ropenstack::MalformedRequestError</a>
86
+
87
+ <li><a href="../Ropenstack/NotFoundError.html">Ropenstack::NotFoundError</a>
88
+
89
+ <li><a href="../Ropenstack/Nova.html">Ropenstack::Nova</a>
90
+
91
+ <li><a href="../Ropenstack/OpenstackService.html">Ropenstack::OpenstackService</a>
92
+
93
+ <li><a href="../Ropenstack/Quantum.html">Ropenstack::Quantum</a>
94
+
95
+ <li><a href="../Ropenstack/Rest.html">Ropenstack::Rest</a>
96
+
97
+ <li><a href="../Ropenstack/RopenstackError.html">Ropenstack::RopenstackError</a>
98
+
99
+ <li><a href="../Ropenstack/TimeoutError.html">Ropenstack::TimeoutError</a>
100
+
101
+ <li><a href="../Ropenstack/UnauthorisedError.html">Ropenstack::UnauthorisedError</a>
102
+
103
+ </ul>
104
+ </nav>
105
+
106
+ </div>
107
+ </nav>
108
+
109
+ <div id="documentation">
110
+ <h1 class="class">class Ropenstack::MalformedRequestError</h1>
111
+
112
+ <div id="description" class="description">
113
+
114
+ <p>Error fired if openstack returns a Bad Request error</p>
115
+
116
+ </div><!-- description -->
117
+
118
+
119
+
120
+
121
+ <section id="5Buntitled-5D" class="documentation-section">
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+ <!-- Methods -->
131
+
132
+ </section><!-- 5Buntitled-5D -->
133
+
134
+ </div><!-- documentation -->
135
+
136
+
137
+ <footer id="validator-badges">
138
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
139
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
140
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
141
+ </footer>
142
+
@@ -0,0 +1,142 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class Ropenstack::NotFoundError - RDoc Documentation</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>lib/ropenstack/error.rb
51
+ </ul>
52
+ </nav>
53
+
54
+
55
+ </div>
56
+
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link"><a href="RopenstackError.html">Ropenstack::RopenstackError</a>
63
+
64
+ </nav>
65
+
66
+
67
+
68
+ </div>
69
+
70
+ <div id="project-metadata">
71
+
72
+ <nav id="classindex-section" class="section project-section">
73
+ <h3 class="section-header">Class and Module Index</h3>
74
+
75
+ <ul class="link-list">
76
+
77
+ <li><a href="../Ropenstack.html">Ropenstack</a>
78
+
79
+ <li><a href="../Ropenstack/Cinder.html">Ropenstack::Cinder</a>
80
+
81
+ <li><a href="../Ropenstack/Glance.html">Ropenstack::Glance</a>
82
+
83
+ <li><a href="../Ropenstack/Keystone.html">Ropenstack::Keystone</a>
84
+
85
+ <li><a href="../Ropenstack/MalformedRequestError.html">Ropenstack::MalformedRequestError</a>
86
+
87
+ <li><a href="../Ropenstack/NotFoundError.html">Ropenstack::NotFoundError</a>
88
+
89
+ <li><a href="../Ropenstack/Nova.html">Ropenstack::Nova</a>
90
+
91
+ <li><a href="../Ropenstack/OpenstackService.html">Ropenstack::OpenstackService</a>
92
+
93
+ <li><a href="../Ropenstack/Quantum.html">Ropenstack::Quantum</a>
94
+
95
+ <li><a href="../Ropenstack/Rest.html">Ropenstack::Rest</a>
96
+
97
+ <li><a href="../Ropenstack/RopenstackError.html">Ropenstack::RopenstackError</a>
98
+
99
+ <li><a href="../Ropenstack/TimeoutError.html">Ropenstack::TimeoutError</a>
100
+
101
+ <li><a href="../Ropenstack/UnauthorisedError.html">Ropenstack::UnauthorisedError</a>
102
+
103
+ </ul>
104
+ </nav>
105
+
106
+ </div>
107
+ </nav>
108
+
109
+ <div id="documentation">
110
+ <h1 class="class">class Ropenstack::NotFoundError</h1>
111
+
112
+ <div id="description" class="description">
113
+
114
+ <p>Error fired if a 404 error comes back from openstack</p>
115
+
116
+ </div><!-- description -->
117
+
118
+
119
+
120
+
121
+ <section id="5Buntitled-5D" class="documentation-section">
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+ <!-- Methods -->
131
+
132
+ </section><!-- 5Buntitled-5D -->
133
+
134
+ </div><!-- documentation -->
135
+
136
+
137
+ <footer id="validator-badges">
138
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
139
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
140
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
141
+ </footer>
142
+
@@ -0,0 +1,562 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class Ropenstack::Nova - RDoc Documentation</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>lib/ropenstack/nova.rb
51
+ </ul>
52
+ </nav>
53
+
54
+
55
+ </div>
56
+
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link">OpenstackService
63
+
64
+ </nav>
65
+
66
+
67
+ <!-- Method Quickref -->
68
+ <nav id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+
71
+ <ul class="link-list">
72
+
73
+ <li><a href="#method-i-action">#action</a>
74
+
75
+ <li><a href="#method-i-attach_volume">#attach_volume</a>
76
+
77
+ <li><a href="#method-i-create_server">#create_server</a>
78
+
79
+ <li><a href="#method-i-delete_image">#delete_image</a>
80
+
81
+ <li><a href="#method-i-delete_server">#delete_server</a>
82
+
83
+ <li><a href="#method-i-detach_volume">#detach_volume</a>
84
+
85
+ <li><a href="#method-i-flavors">#flavors</a>
86
+
87
+ <li><a href="#method-i-images">#images</a>
88
+
89
+ <li><a href="#method-i-quotas">#quotas</a>
90
+
91
+ <li><a href="#method-i-servers">#servers</a>
92
+
93
+ <li><a href="#method-i-servers_detailed">#servers_detailed</a>
94
+
95
+ </ul>
96
+ </nav>
97
+
98
+ </div>
99
+
100
+ <div id="project-metadata">
101
+
102
+ <nav id="classindex-section" class="section project-section">
103
+ <h3 class="section-header">Class and Module Index</h3>
104
+
105
+ <ul class="link-list">
106
+
107
+ <li><a href="../Ropenstack.html">Ropenstack</a>
108
+
109
+ <li><a href="../Ropenstack/Cinder.html">Ropenstack::Cinder</a>
110
+
111
+ <li><a href="../Ropenstack/Glance.html">Ropenstack::Glance</a>
112
+
113
+ <li><a href="../Ropenstack/Keystone.html">Ropenstack::Keystone</a>
114
+
115
+ <li><a href="../Ropenstack/MalformedRequestError.html">Ropenstack::MalformedRequestError</a>
116
+
117
+ <li><a href="../Ropenstack/NotFoundError.html">Ropenstack::NotFoundError</a>
118
+
119
+ <li><a href="../Ropenstack/Nova.html">Ropenstack::Nova</a>
120
+
121
+ <li><a href="../Ropenstack/OpenstackService.html">Ropenstack::OpenstackService</a>
122
+
123
+ <li><a href="../Ropenstack/Quantum.html">Ropenstack::Quantum</a>
124
+
125
+ <li><a href="../Ropenstack/Rest.html">Ropenstack::Rest</a>
126
+
127
+ <li><a href="../Ropenstack/RopenstackError.html">Ropenstack::RopenstackError</a>
128
+
129
+ <li><a href="../Ropenstack/TimeoutError.html">Ropenstack::TimeoutError</a>
130
+
131
+ <li><a href="../Ropenstack/UnauthorisedError.html">Ropenstack::UnauthorisedError</a>
132
+
133
+ </ul>
134
+ </nav>
135
+
136
+ </div>
137
+ </nav>
138
+
139
+ <div id="documentation">
140
+ <h1 class="class">class Ropenstack::Nova</h1>
141
+
142
+ <div id="description" class="description">
143
+ <ul><li>
144
+ <p>Name: <a href="Nova.html">Nova</a></p>
145
+ </li><li>
146
+ <p>Description: Implementation of the <a href="Nova.html">Nova</a> API Client
147
+ in Ruby</p>
148
+ </li><li>
149
+ <p>Author: Sam ‘Tehsmash’ Betts</p>
150
+ </li><li>
151
+ <p>Date: 01/15/2013</p>
152
+ </li></ul>
153
+
154
+ </div><!-- description -->
155
+
156
+
157
+
158
+
159
+ <section id="5Buntitled-5D" class="documentation-section">
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+ <!-- Methods -->
169
+
170
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
171
+ <h3 class="section-header">Public Instance Methods</h3>
172
+
173
+
174
+ <div id="method-i-action" class="method-detail ">
175
+
176
+ <div class="method-heading">
177
+ <span class="method-name">action</span><span
178
+ class="method-args">(id, act, *args)</span>
179
+ <span class="method-click-advice">click to toggle source</span>
180
+ </div>
181
+
182
+
183
+ <div class="method-description">
184
+
185
+ <p>Perform an action on a server on Openstack, by passing an id, and an
186
+ action, some actions require more data.</p>
187
+
188
+ <p>E.g. action(id, “reboot”, “hard”)</p>
189
+
190
+
191
+
192
+ <div class="method-source-code" id="action-source">
193
+ <pre><span class="ruby-comment"># File lib/ropenstack/nova.rb, line 64</span>
194
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">action</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">act</span>, *<span class="ruby-identifier">args</span>)
195
+ <span class="ruby-identifier">data</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">act</span>
196
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&quot;reboot&quot;</span> <span class="ruby-keyword">then</span> {<span class="ruby-string">'reboot'</span> =<span class="ruby-operator">&gt;</span>{<span class="ruby-string">&quot;type&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]}}
197
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&quot;vnc&quot;</span> <span class="ruby-keyword">then</span> {<span class="ruby-string">'os-getVNCConsole'</span> =<span class="ruby-operator">&gt;</span> { <span class="ruby-string">&quot;type&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;novnc&quot;</span> }}
198
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&quot;stop&quot;</span> <span class="ruby-keyword">then</span> {<span class="ruby-string">'os-stop'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'null'</span>}
199
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&quot;start&quot;</span> <span class="ruby-keyword">then</span> {<span class="ruby-string">'os-start'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'null'</span>}
200
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&quot;pause&quot;</span> <span class="ruby-keyword">then</span> {<span class="ruby-string">'pause'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'null'</span>}
201
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&quot;unpause&quot;</span> <span class="ruby-keyword">then</span> {<span class="ruby-string">'unpause'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'null'</span>}
202
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&quot;suspend&quot;</span> <span class="ruby-keyword">then</span> {<span class="ruby-string">'suspend'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'null'</span>}
203
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&quot;resume&quot;</span> <span class="ruby-keyword">then</span> {<span class="ruby-string">'resume'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">'null'</span>}
204
+ <span class="ruby-keyword">when</span> <span class="ruby-string">&quot;create_image&quot;</span> <span class="ruby-keyword">then</span> {<span class="ruby-string">'createImage'</span> =<span class="ruby-operator">&gt;</span> {<span class="ruby-string">'name'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>], <span class="ruby-string">'metadata'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">args</span>[<span class="ruby-value">1</span>]}}
205
+ <span class="ruby-keyword">else</span> <span class="ruby-identifier">raise</span> <span class="ruby-string">&quot;Invalid Action&quot;</span>
206
+ <span class="ruby-keyword">end</span>
207
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">post_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/servers/&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">+</span> <span class="ruby-string">&quot;/action&quot;</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
208
+ <span class="ruby-keyword">end</span></pre>
209
+ </div><!-- action-source -->
210
+
211
+ </div>
212
+
213
+
214
+
215
+
216
+ </div><!-- action-method -->
217
+
218
+
219
+ <div id="method-i-attach_volume" class="method-detail ">
220
+
221
+ <div class="method-heading">
222
+ <span class="method-name">attach_volume</span><span
223
+ class="method-args">(id, volume)</span>
224
+ <span class="method-click-advice">click to toggle source</span>
225
+ </div>
226
+
227
+
228
+ <div class="method-description">
229
+
230
+ <p>Attach a cinder volume to a server, by passing the server id and the volume
231
+ id.</p>
232
+
233
+
234
+
235
+ <div class="method-source-code" id="attach_volume-source">
236
+ <pre><span class="ruby-comment"># File lib/ropenstack/nova.rb, line 84</span>
237
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">attach_volume</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">volume</span>)
238
+ <span class="ruby-identifier">data</span> = { <span class="ruby-string">'volumeAttachment'</span> =<span class="ruby-operator">&gt;</span> { <span class="ruby-string">'volumeId'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">volume</span>, <span class="ruby-string">'device'</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;/dev/vdb&quot;</span> } }
239
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">post_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/servers/&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">+</span> <span class="ruby-string">&quot;/os-volume_attachments&quot;</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
240
+ <span class="ruby-keyword">end</span></pre>
241
+ </div><!-- attach_volume-source -->
242
+
243
+ </div>
244
+
245
+
246
+
247
+
248
+ </div><!-- attach_volume-method -->
249
+
250
+
251
+ <div id="method-i-create_server" class="method-detail ">
252
+
253
+ <div class="method-heading">
254
+ <span class="method-name">create_server</span><span
255
+ class="method-args">(name, image, flavor, network = nil, metadata = nil)</span>
256
+ <span class="method-click-advice">click to toggle source</span>
257
+ </div>
258
+
259
+
260
+ <div class="method-description">
261
+
262
+ <p>Creates a server on OpenStack.</p>
263
+
264
+
265
+
266
+ <div class="method-source-code" id="create_server-source">
267
+ <pre><span class="ruby-comment"># File lib/ropenstack/nova.rb, line 37</span>
268
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">create_server</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">image</span>, <span class="ruby-identifier">flavor</span>, <span class="ruby-identifier">network</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">metadata</span> = <span class="ruby-keyword">nil</span>)
269
+ <span class="ruby-identifier">data</span> = {
270
+ <span class="ruby-string">&quot;server&quot;</span> =<span class="ruby-operator">&gt;</span> {
271
+ <span class="ruby-string">&quot;name&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">name</span>,
272
+ <span class="ruby-string">&quot;imageRef&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">image</span>,
273
+ <span class="ruby-string">&quot;flavorRef&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">flavor</span>,
274
+ }
275
+ }
276
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">network</span>.<span class="ruby-identifier">nil?</span>
277
+ <span class="ruby-identifier">data</span>[<span class="ruby-string">&quot;server&quot;</span>][<span class="ruby-string">&quot;networks&quot;</span>] = [{<span class="ruby-string">&quot;uuid&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">network</span>}]
278
+ <span class="ruby-keyword">end</span>
279
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">post_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/servers&quot;</span>), <span class="ruby-identifier">data</span>, <span class="ruby-ivar">@token</span>)
280
+ <span class="ruby-keyword">end</span></pre>
281
+ </div><!-- create_server-source -->
282
+
283
+ </div>
284
+
285
+
286
+
287
+
288
+ </div><!-- create_server-method -->
289
+
290
+
291
+ <div id="method-i-delete_image" class="method-detail ">
292
+
293
+ <div class="method-heading">
294
+ <span class="method-name">delete_image</span><span
295
+ class="method-args">(id)</span>
296
+ <span class="method-click-advice">click to toggle source</span>
297
+ </div>
298
+
299
+
300
+ <div class="method-description">
301
+
302
+ <p>Delete an image stored on Openstack through the nova endpoint</p>
303
+
304
+
305
+
306
+ <div class="method-source-code" id="delete_image-source">
307
+ <pre><span class="ruby-comment"># File lib/ropenstack/nova.rb, line 108</span>
308
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_image</span>(<span class="ruby-identifier">id</span>)
309
+ <span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">&quot;http://&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@location</span>.<span class="ruby-identifier">host</span> <span class="ruby-operator">+</span> <span class="ruby-string">&quot;:&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@location</span>.<span class="ruby-identifier">port</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-string">&quot;/v2/images/&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">id</span>)
310
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">delete_request</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-ivar">@token</span>)
311
+ <span class="ruby-keyword">end</span></pre>
312
+ </div><!-- delete_image-source -->
313
+
314
+ </div>
315
+
316
+
317
+
318
+
319
+ </div><!-- delete_image-method -->
320
+
321
+
322
+ <div id="method-i-delete_server" class="method-detail ">
323
+
324
+ <div class="method-heading">
325
+ <span class="method-name">delete_server</span><span
326
+ class="method-args">(id)</span>
327
+ <span class="method-click-advice">click to toggle source</span>
328
+ </div>
329
+
330
+
331
+ <div class="method-description">
332
+
333
+ <p>Deletes a server from Openstack based on an id</p>
334
+
335
+
336
+
337
+ <div class="method-source-code" id="delete_server-source">
338
+ <pre><span class="ruby-comment"># File lib/ropenstack/nova.rb, line 54</span>
339
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_server</span>(<span class="ruby-identifier">id</span>)
340
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">delete_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/servers/&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">id</span>), <span class="ruby-ivar">@token</span>)
341
+ <span class="ruby-keyword">end</span></pre>
342
+ </div><!-- delete_server-source -->
343
+
344
+ </div>
345
+
346
+
347
+
348
+
349
+ </div><!-- delete_server-method -->
350
+
351
+
352
+ <div id="method-i-detach_volume" class="method-detail ">
353
+
354
+ <div class="method-heading">
355
+ <span class="method-name">detach_volume</span><span
356
+ class="method-args">(id, attachment)</span>
357
+ <span class="method-click-advice">click to toggle source</span>
358
+ </div>
359
+
360
+
361
+ <div class="method-description">
362
+
363
+ <p>Remove a cinder volume from a server, by passing the server id and the
364
+ attachment id.</p>
365
+
366
+
367
+
368
+ <div class="method-source-code" id="detach_volume-source">
369
+ <pre><span class="ruby-comment"># File lib/ropenstack/nova.rb, line 93</span>
370
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">detach_volume</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">attachment</span>)
371
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">delete_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/servers/&quot;</span><span class="ruby-operator">+</span><span class="ruby-identifier">id</span><span class="ruby-operator">+</span><span class="ruby-string">&quot;/os-volume_attachments/&quot;</span><span class="ruby-operator">+</span><span class="ruby-identifier">volume</span>), <span class="ruby-ivar">@token</span>)
372
+ <span class="ruby-keyword">end</span></pre>
373
+ </div><!-- detach_volume-source -->
374
+
375
+ </div>
376
+
377
+
378
+
379
+
380
+ </div><!-- detach_volume-method -->
381
+
382
+
383
+ <div id="method-i-flavors" class="method-detail ">
384
+
385
+ <div class="method-heading">
386
+ <span class="method-name">flavors</span><span
387
+ class="method-args">()</span>
388
+ <span class="method-click-advice">click to toggle source</span>
389
+ </div>
390
+
391
+
392
+ <div class="method-description">
393
+
394
+ <p>Get a list of flavors that Servers can be</p>
395
+
396
+
397
+
398
+ <div class="method-source-code" id="flavors-source">
399
+ <pre><span class="ruby-comment"># File lib/ropenstack/nova.rb, line 116</span>
400
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">flavors</span>()
401
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/flavors/detail&quot;</span>), <span class="ruby-ivar">@token</span>)
402
+ <span class="ruby-keyword">end</span></pre>
403
+ </div><!-- flavors-source -->
404
+
405
+ </div>
406
+
407
+
408
+
409
+
410
+ </div><!-- flavors-method -->
411
+
412
+
413
+ <div id="method-i-images" class="method-detail ">
414
+
415
+ <div class="method-heading">
416
+ <span class="method-name">images</span><span
417
+ class="method-args">()</span>
418
+ <span class="method-click-advice">click to toggle source</span>
419
+ </div>
420
+
421
+
422
+ <div class="method-description">
423
+
424
+ <p>Retrieve a list of images from Openstack through the nova endpoint</p>
425
+
426
+
427
+
428
+ <div class="method-source-code" id="images-source">
429
+ <pre><span class="ruby-comment"># File lib/ropenstack/nova.rb, line 100</span>
430
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">images</span>()
431
+ <span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-string">&quot;http://&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@location</span>.<span class="ruby-identifier">host</span> <span class="ruby-operator">+</span> <span class="ruby-string">&quot;:9292/v2/images&quot;</span>)
432
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-ivar">@token</span>)
433
+ <span class="ruby-keyword">end</span></pre>
434
+ </div><!-- images-source -->
435
+
436
+ </div>
437
+
438
+
439
+
440
+
441
+ </div><!-- images-method -->
442
+
443
+
444
+ <div id="method-i-quotas" class="method-detail ">
445
+
446
+ <div class="method-heading">
447
+ <span class="method-name">quotas</span><span
448
+ class="method-args">()</span>
449
+ <span class="method-click-advice">click to toggle source</span>
450
+ </div>
451
+
452
+
453
+ <div class="method-description">
454
+
455
+ <p>Get a tenants compute quotas</p>
456
+
457
+
458
+
459
+ <div class="method-source-code" id="quotas-source">
460
+ <pre><span class="ruby-comment"># File lib/ropenstack/nova.rb, line 123</span>
461
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">quotas</span>()
462
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/limits&quot;</span>), <span class="ruby-ivar">@token</span>)
463
+ <span class="ruby-keyword">end</span></pre>
464
+ </div><!-- quotas-source -->
465
+
466
+ </div>
467
+
468
+
469
+
470
+
471
+ </div><!-- quotas-method -->
472
+
473
+
474
+ <div id="method-i-servers" class="method-detail ">
475
+
476
+
477
+ <div class="method-heading">
478
+ <span class="method-callseq">
479
+ servers(id) &rarr; A single server with the id matching the parameter
480
+ </span>
481
+
482
+ <span class="method-click-advice">click to toggle source</span>
483
+
484
+ </div>
485
+
486
+ <div class="method-heading">
487
+ <span class="method-callseq">
488
+ servers() &rarr; All servers visible to the tenant making the request
489
+ </span>
490
+
491
+ </div>
492
+
493
+
494
+
495
+ <div class="method-description">
496
+
497
+ <p>Gets a list of servers from OpenStack</p>
498
+
499
+
500
+
501
+ <div class="method-source-code" id="servers-source">
502
+ <pre><span class="ruby-comment"># File lib/ropenstack/nova.rb, line 19</span>
503
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">servers</span>(<span class="ruby-identifier">id</span>)
504
+ <span class="ruby-identifier">endpoint</span> = <span class="ruby-string">&quot;/servers&quot;</span>
505
+ <span class="ruby-keyword">unless</span> <span class="ruby-identifier">id</span>.<span class="ruby-identifier">nil?</span>
506
+ <span class="ruby-identifier">endpoint</span> = <span class="ruby-identifier">endpoint</span> <span class="ruby-operator">+</span> <span class="ruby-string">&quot;/&quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">id</span>
507
+ <span class="ruby-keyword">end</span>
508
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-identifier">endpoint</span>), <span class="ruby-ivar">@token</span>)
509
+ <span class="ruby-keyword">end</span></pre>
510
+ </div><!-- servers-source -->
511
+
512
+ </div>
513
+
514
+
515
+
516
+
517
+ </div><!-- servers-method -->
518
+
519
+
520
+ <div id="method-i-servers_detailed" class="method-detail ">
521
+
522
+ <div class="method-heading">
523
+ <span class="method-name">servers_detailed</span><span
524
+ class="method-args">()</span>
525
+ <span class="method-click-advice">click to toggle source</span>
526
+ </div>
527
+
528
+
529
+ <div class="method-description">
530
+
531
+ <p>Gets a more detailed list of servers from openstack.</p>
532
+
533
+
534
+
535
+ <div class="method-source-code" id="servers_detailed-source">
536
+ <pre><span class="ruby-comment"># File lib/ropenstack/nova.rb, line 30</span>
537
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">servers_detailed</span>()
538
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">get_request</span>(<span class="ruby-identifier">address</span>(<span class="ruby-string">&quot;/servers/detail&quot;</span>), <span class="ruby-ivar">@token</span>)
539
+ <span class="ruby-keyword">end</span></pre>
540
+ </div><!-- servers_detailed-source -->
541
+
542
+ </div>
543
+
544
+
545
+
546
+
547
+ </div><!-- servers_detailed-method -->
548
+
549
+
550
+ </section><!-- public-instance-method-details -->
551
+
552
+ </section><!-- 5Buntitled-5D -->
553
+
554
+ </div><!-- documentation -->
555
+
556
+
557
+ <footer id="validator-badges">
558
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
559
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
560
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
561
+ </footer>
562
+