occi-cli 4.3.1 → 4.3.2

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 (6) hide show
  1. checksums.yaml +4 -4
  2. data/doc/occi.1 +213 -0
  3. data/lib/occi/cli/occi_opts/cli_examples.erb +1 -1
  4. data/lib/occi/cli/version.rb +1 -1
  5. data/occi-cli.gemspec +1 -1
  6. metadata +6 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 7bedcce92c789c099d96b589f32fdba7896f97ed
4
- data.tar.gz: 57fb91cabc6a44189149ada8c1ab69aa26bf57bc
3
+ metadata.gz: 2c64f0a254a8ad13bf87a32afd212cb92b565fe7
4
+ data.tar.gz: 9404dabf53b0b0b32b33a5943ae104402e0d32a8
5
5
  SHA512:
6
- metadata.gz: 8440b8022533fdcd5b63c5a49b442e6baa2e35f3499dffa4fc0a7dc1da7a65e553fd86b379891ecf4b9c531ea645acedd5ade8b3d5a6961db1c489d1a4a35f20
7
- data.tar.gz: 11cfb76d768d46478c558980071d6a7a089c0800f5f5d501252c29c41f62b2b0cec1ab65d9b565bdff2f784434fda5aa845174026c1f4014326ed9ef17c27911
6
+ metadata.gz: d9ee1c0c68c62028270518d0cbe267e1f1e143309150eeb01354354f1d132f4c66d345ff5f013ff76c53b8fd75e39439fc499935f747eee476badfe5ef4f81e2
7
+ data.tar.gz: 6c8780431ac94e0522802823d316d2cfea6fd4366e647070ee160f63a784c0973bf2ed89447d0940ea0be06db1f4365c9dcb116a283fd9e4cb4719aac486cf9f
data/doc/occi.1 ADDED
@@ -0,0 +1,213 @@
1
+ .TH OCCI 1 "August 2014" "CESNET" "Ruby OCCI"
2
+
3
+
4
+ .SH NAME
5
+ occi \- Open Cloud Computing Interface Client
6
+
7
+
8
+ .SH SYNOPSIS
9
+ \fBocci\fR [\fIOPTIONS\fR]
10
+
11
+
12
+ .SH DESCRIPTION
13
+ Client implementation of the Open Cloud Computing Interface in Ruby.
14
+
15
+
16
+ .SH OPTIONS
17
+ .TP
18
+ \fB-a\fR, \fP--action\fR \fIACTION\fR
19
+ Action to be performed on a resource instance, required.
20
+
21
+ .TP
22
+ \fB-c\fR, \fP--ca-path\fR \fIPATH\fR [/etc/grid-security/certificates]
23
+ Path to CA certificates director.
24
+
25
+ .TP
26
+ \fB-d\fR, \fP--debug\fR
27
+ Enable debugging messages.
28
+
29
+ .TP
30
+ \fB-e\fR, \fP--endpoint\fR \fIURI\fR [http://localhost:3000]
31
+ OCCI server URI.
32
+
33
+ .TP
34
+ \fB-g\fR, \fP--trigger-action\fR \fIACTION\fR
35
+ Action to be triggered on the resource, formatted as SCHEME#TERM or TERM.
36
+
37
+ .TP
38
+ \fB-h\fR, \fP--help\fR
39
+ Show this message.
40
+
41
+ .TP
42
+ \fB-j\fR, \fP--link\fR \fIURI\fR
43
+ URI of an instance to be linked with the given resource, applicable only for action 'link'.
44
+
45
+ .TP
46
+ \fB-l\fR, \fP--log-to\fR \fIOUTPUT\fR [stderr]
47
+ Log to the specified device, only: {\fBstdout\fR|\fBstderr\fR}.
48
+
49
+ .TP
50
+ \fB-M\fR, \fP--mixin\fR \fIIDENTIFIER\fR
51
+ Identifier of a mixin, formatted as SCHEME#TERM or SHORT_SCHEME#TERM.
52
+
53
+ .TP
54
+ \fB-n\fR, \fP--auth\fR \fIMETHOD\fR [none]
55
+ Authentication method. Only {\fBx509\fR|\fBbasic\fR|\fBdigest\fR|\fBnone\fR}.
56
+
57
+ .TP
58
+ \fB-f\fR, \fP--ca-file\fR \fIPATH\fR
59
+ Path to CA certificates in a file.
60
+
61
+ .TP
62
+ \fB-F\fR, \fP--filter\fR \fICATEGORY\fR
63
+ Category type identifier to filter categories from model. Must be used together with the \fB-m\fR option.
64
+
65
+ .TP
66
+ \fB-k\fR, \fP--timeout\fR \fITIMEOUT\fR
67
+ Default timeout for all HTTP connections, in seconds.
68
+
69
+ .TP
70
+ \fB-m\fR, \fP--dump-model\fR
71
+ Contact the endpoint and dump its model.
72
+
73
+ .TP
74
+ \fB-o, --output-format FORMAT\fR [plain]
75
+ Output format, only: {\fBjson\fR|\fBplain\fR|\fBjson_pretty\fR|\fBjson_extended\fR|\fBjson_extended_pretty\fR}.
76
+
77
+ .TP
78
+ \fB-p\fR, \fP--password\fR \fIPASSWORD\fR
79
+ Password for basic, digest and x509 authentication.
80
+
81
+ .TP
82
+ \fB-r\fR, \fP--resource\fR \fIRESOURCE\fR
83
+ Term, identifier or URI of a resource to be queried, required.
84
+
85
+ .TP
86
+ \fB-t\fR, \fP--attribute\fR \fIATTRIBUTE\fR
87
+ An "attribute='value'" pair, mandatory attributes for creating new resource instances: [occi.core.title].
88
+
89
+ .TP
90
+ \fB-T\fR, \fP--context\fR \fICTX_VAR\fR
91
+ A "context_variable='value'" pair for new 'compute' resource instances, only: {\fBpublic_key\fR|\fBuser_data\fR}.
92
+
93
+ .TP
94
+ \fB-s\fR, \fP--skip-ca-check\fR
95
+ Skip server certificate verification [NOT recommended].
96
+
97
+ .TP
98
+ \fB-u\fR, \fP--username\fR \fIUSER\fR [anonymous]
99
+ Username for basic or digest authentication.
100
+
101
+ .TP
102
+ \fB-v\fR, \fP--version\fR
103
+ Show version.
104
+
105
+ .TP
106
+ \fB-x\fR, \fP--user-cred\fR \fIFILE\fR [~/.globus/usercred.pem]
107
+ Path to user's x509 credentials.
108
+
109
+ .TP
110
+ \fB-X\fR, \fP--voms\fR
111
+ Using VOMS credentials; modifies behavior of the X509 authN module.
112
+
113
+ .TP
114
+ \fB-y\fR, \fP--media-type\fR \fIMEDIA_TYPE\fR [text/plain,text/occi]
115
+ Media type for client <-> server communication. Only: {\fBapplication/occi+json\fR|\fBtext/plain\fR,\fBtext/occi\fR|\fBtext/plain\fR|\fBtext/occi\fR}.
116
+
117
+ .TP
118
+ \fB-z\fR, \fP--examples\fR
119
+ Show usage examples.
120
+
121
+
122
+ .SH
123
+ EXAMPLES
124
+
125
+ .SS Quick reference guide
126
+
127
+ occi --endpoint http://localhost:3000/ --action list --resource os_tpl
128
+ occi --endpoint http://localhost:3000/ --action list --resource resource_tpl
129
+ occi --endpoint http://localhost:3000/ --action describe --resource os_tpl#debian6
130
+ occi --endpoint http://localhost:3000/ --action create --resource compute --mixin os_tpl#debian6 --mixin resource_tpl#small --attribute occi.core.title="My rOCCI VM"
131
+ occi --endpoint http://localhost:3000/ --action delete --resource /compute/65sd4f654sf65g4-s5fg65sfg465sfg-sf65g46sf5g4sdfg
132
+
133
+ .SS Listing resources
134
+
135
+ occi --endpoint http://localhost:3000/ --action list --resource compute
136
+ occi --endpoint http://localhost:3000/ --action list --resource network
137
+ occi --endpoint http://localhost:3000/ --action list --resource storage
138
+ occi --endpoint http://localhost:3000/ --action list --resource os_tpl
139
+ occi --endpoint http://localhost:3000/ --action list --resource resource_tpl
140
+
141
+ .SS Describing resources
142
+
143
+ occi --endpoint http://localhost:3000/ --action describe --resource compute
144
+ occi --endpoint http://localhost:3000/ --action describe --resource network
145
+ occi --endpoint http://localhost:3000/ --action describe --resource storage
146
+ occi --endpoint http://localhost:3000/ --action describe --resource os_tpl
147
+ occi --endpoint http://localhost:3000/ --action describe --resource resource_tpl
148
+
149
+ .SS Creating resources
150
+
151
+ occi --endpoint http://localhost:3000/ --action create [ --attribute attribute_name='attribute_value' ]+ [ --mixin mixin_type#mixin_term ]+ --resource compute
152
+ occi --endpoint http://localhost:3000/ --action create [ --attribute attribute_name='attribute_value' ]+ [ --mixin mixin_type#mixin_term ]+ --resource network
153
+ occi --endpoint http://localhost:3000/ --action create [ --attribute attribute_name='attribute_value' ]+ [ --mixin mixin_type#mixin_term ]+ --resource storage
154
+
155
+ .SS Linking/unlinking resources
156
+
157
+ occi --endpoint http://localhost:3000/ --action link --resource /compute/instance_id --link /network/instance_id
158
+ occi --endpoint http://localhost:3000/ --action link --resource /compute/instance_id --link /storage/instance_id
159
+
160
+ .SS Deleting resources
161
+
162
+ occi --endpoint http://localhost:3000/ --action delete --resource compute
163
+ occi --endpoint http://localhost:3000/ --action delete --resource network
164
+ occi --endpoint http://localhost:3000/ --action delete --resource storage
165
+
166
+ .SS Triggering actions on resources
167
+
168
+ occi --endpoint http://localhost:3000/ --action trigger --trigger-action action_scheme#action_term [ --attribute attribute_name='attribute_value' ]+ --resource computeocci --endpoint http://localhost:3000/ --action trigger --trigger-action action_term [ --attribute attribute_name='attribute_value' ]+ --resource compute
169
+ occi --endpoint http://localhost:3000/ --action trigger --trigger-action action_scheme#action_term [ --attribute attribute_name='attribute_value' ]+ --resource networkocci --endpoint http://localhost:3000/ --action trigger --trigger-action action_term [ --attribute attribute_name='attribute_value' ]+ --resource network
170
+ occi --endpoint http://localhost:3000/ --action trigger --trigger-action action_scheme#action_term [ --attribute attribute_name='attribute_value' ]+ --resource storageocci --endpoint http://localhost:3000/ --action trigger --trigger-action action_term [ --attribute attribute_name='attribute_value' ]+ --resource storage
171
+
172
+ .SS Authentication
173
+
174
+ occi --endpoint http://localhost:3000/ [ --auth none ]
175
+ occi --endpoint http://localhost:3000/ --auth basic [ --username user ] [ --password pass ]
176
+ occi --endpoint http://localhost:3000/ --auth digest [ --username user ] [ --password pass ]
177
+ occi --endpoint http://localhost:3000/ --auth x509 [ --user-cred /home/user/.globus/usercred.pem ] [ --ca-file /etc/grid-security/certificates/ca.pem ] [ --ca-path /etc/grid-security/certificates ] [ --voms ] [ --password pass ]
178
+ occi --endpoint http://localhost:3000/ --auth x509 --user-cred /home/user/.globus/usercred.pem
179
+ occi --endpoint http://localhost:3000/ --auth x509 --user-cred /tmp/x509_1000 --voms
180
+ occi --endpoint http://localhost:3000/ --auth x509 --user-cred /tmp/x509_1000 --ca-path /etc/grid-security/certificates --voms
181
+
182
+ .SS Media types
183
+
184
+ occi --endpoint http://localhost:3000/ [ ... ] --media-type application/occi+json
185
+ occi --endpoint http://localhost:3000/ [ ... ] --media-type text/plain,text/occi
186
+ occi --endpoint http://localhost:3000/ [ ... ] --media-type text/plain
187
+ occi --endpoint http://localhost:3000/ [ ... ] --media-type text/occi
188
+
189
+ .SS Output formats
190
+
191
+ occi --endpoint http://localhost:3000/ [ ... ] --output-format json
192
+ occi --endpoint http://localhost:3000/ [ ... ] --output-format plain
193
+ occi --endpoint http://localhost:3000/ [ ... ] --output-format json_pretty
194
+ occi --endpoint http://localhost:3000/ [ ... ] --output-format json_extended
195
+ occi --endpoint http://localhost:3000/ [ ... ] --output-format json_extended_pretty
196
+
197
+ .SS Attribute values (type-casting)
198
+
199
+ occi --endpoint http://localhost:3000/ [ ... ] --attribute attribute_name='attribute_value'
200
+ occi --endpoint http://localhost:3000/ [ ... ] --attribute attribute_name='num(attribute_value)'
201
+ occi --endpoint http://localhost:3000/ [ ... ] --attribute attribute_name='float(attribute_value)'
202
+ occi --endpoint http://localhost:3000/ [ ... ] --attribute attribute_name='bool(attribute_value)'
203
+
204
+
205
+ .SH BUGS
206
+ Please report all bugs to EGI-TF rOCCI-cli issue tracker available at
207
+ .I https://github.com/EGI-FCTF/rOCCI-cli/issues
208
+
209
+
210
+ .SH AUTHORS
211
+ EGI-FCTF, CESNET
212
+
213
+ GWDG
data/lib/occi/cli/occi_opts/cli_examples.erb CHANGED
@@ -38,7 +38,7 @@ occi --endpoint <%= ENDPOINT -%> --action delete --resource <%= res -%>
38
38
 
39
39
  ## Triggering actions on resources
40
40
  <% %w(compute network storage).each do |res| %>
41
- occi --endpoint <%= ENDPOINT -%> --action trigger --trigger-action action_scheme#action_term [ --attribute attribute_name='attribute_value' ]+ --resource <%= res -%>
41
+ occi --endpoint <%= ENDPOINT -%> --action trigger --trigger-action action_scheme#action_term [ --attribute attribute_name='attribute_value' ]+ --resource <%= res %>
42
42
  occi --endpoint <%= ENDPOINT -%> --action trigger --trigger-action action_term [ --attribute attribute_name='attribute_value' ]+ --resource <%= res -%>
43
43
  <% end %>
44
44
 
data/lib/occi/cli/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  module Occi
2
2
  module Cli
3
- VERSION = "4.3.1" unless defined?(::Occi::Cli::VERSION)
3
+ VERSION = "4.3.2" unless defined?(::Occi::Cli::VERSION)
4
4
  end
5
5
  end
data/occi-cli.gemspec CHANGED
@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
19
19
  gem.test_files = `git ls-files -- {test,spec}/*`.split("\n")
20
20
  gem.require_paths = ['lib']
21
21
 
22
- gem.add_dependency 'occi-api', '~> 4.3', '>= 4.3.1'
22
+ gem.add_dependency 'occi-api', '~> 4.3', '>= 4.3.3'
23
23
  gem.add_dependency 'json', '~> 1.8', '>= 1.8.1'
24
24
  gem.add_dependency 'highline', '~> 1.6', '>= 1.6.21'
25
25
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: occi-cli
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.3.1
4
+ version: 4.3.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Florian Feldhaus
@@ -10,7 +10,7 @@ authors:
10
10
  autorequire:
11
11
  bindir: bin
12
12
  cert_chain: []
13
- date: 2014-10-13 00:00:00.000000000 Z
13
+ date: 2015-11-26 00:00:00.000000000 Z
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
16
16
  name: occi-api
@@ -21,7 +21,7 @@ dependencies:
21
21
  version: '4.3'
22
22
  - - ">="
23
23
  - !ruby/object:Gem::Version
24
- version: 4.3.1
24
+ version: 4.3.3
25
25
  type: :runtime
26
26
  prerelease: false
27
27
  version_requirements: !ruby/object:Gem::Requirement
@@ -31,7 +31,7 @@ dependencies:
31
31
  version: '4.3'
32
32
  - - ">="
33
33
  - !ruby/object:Gem::Version
34
- version: 4.3.1
34
+ version: 4.3.3
35
35
  - !ruby/object:Gem::Dependency
36
36
  name: json
37
37
  requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,7 @@ files:
95
95
  - bin/occi
96
96
  - config/warble.rb
97
97
  - doc/macosx.md
98
+ - doc/occi.1
98
99
  - lib/occi-cli.rb
99
100
  - lib/occi/cli/errors.rb
100
101
  - lib/occi/cli/errors/formatter_input_type_error.rb
@@ -144,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
144
145
  version: '0'
145
146
  requirements: []
146
147
  rubyforge_project:
147
- rubygems_version: 2.2.2
148
+ rubygems_version: 2.4.6
148
149
  signing_key:
149
150
  specification_version: 4
150
151
  summary: Executable OCCI client