vcoworkflows 0.1.1
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.
- checksums.yaml +7 -0
- data/.coveralls.yml +1 -0
- data/.gitignore +19 -0
- data/.rubocop.yml +9 -0
- data/.travis.yml +3 -0
- data/CHANGELOG.md +12 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +203 -0
- data/README.md +290 -0
- data/Rakefile +21 -0
- data/bin/vcoworkflows +7 -0
- data/example.rb +45 -0
- data/lib/vcoworkflows.rb +34 -0
- data/lib/vcoworkflows/cli/auth.rb +27 -0
- data/lib/vcoworkflows/cli/execute.rb +109 -0
- data/lib/vcoworkflows/cli/query.rb +106 -0
- data/lib/vcoworkflows/constants.rb +44 -0
- data/lib/vcoworkflows/runner.rb +44 -0
- data/lib/vcoworkflows/vcosession.rb +48 -0
- data/lib/vcoworkflows/version.rb +4 -0
- data/lib/vcoworkflows/workflow.rb +304 -0
- data/lib/vcoworkflows/workflowexecutionlog.rb +40 -0
- data/lib/vcoworkflows/workflowparameter.rb +145 -0
- data/lib/vcoworkflows/workflowpresentation.rb +59 -0
- data/lib/vcoworkflows/workflowservice.rb +110 -0
- data/lib/vcoworkflows/workflowtoken.rb +111 -0
- data/spec/spec_helper.rb +4 -0
- data/spec/vcoworkflows/vcosession_spec.rb +33 -0
- data/spec/vcoworkflows/workflow_spec.rb +144 -0
- data/spec/vcoworkflows/workflowexecutionlog_spec.rb +22 -0
- data/spec/vcoworkflows/workflowparameter_spec.rb +67 -0
- data/spec/vcoworkflows/workflowpresentation_spec.rb +34 -0
- data/spec/vcoworkflows/workflowservice_spec.rb +113 -0
- data/spec/vcoworkflows/workflowtoken_spec.rb +64 -0
- data/vcoworkflows.gemspec +39 -0
- metadata +257 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: f0db2d5004d39e1e915ed6951c54a2dad6301f06
|
4
|
+
data.tar.gz: 93b6739926461ec0504308166cdf227bf0fbcc12
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d2782bfa11dc901f086ed0e80c5dc3b00fb10551d7bf6e0a16e01ea778549eb57c9faddfed25b6208d3566bb2e550f8fbc9a47b6c6c32d1ba478ea14f24f27be
|
7
|
+
data.tar.gz: 671989455477f0555aca1c0b5d677994b2f11a5bbb6c44307916806719668c849af13d90db548b30ddecc3b2c3c0b9ca9814c1ffdf178f130e5d0199b1c38e5f
|
data/.coveralls.yml
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
service_name: travis-ci
|
data/.gitignore
ADDED
data/.rubocop.yml
ADDED
data/.travis.yml
ADDED
data/CHANGELOG.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
vcoworkflows CHANGELOG
|
2
|
+
================
|
3
|
+
|
4
|
+
## 0.1.0
|
5
|
+
|
6
|
+
* Initial setup of gem framework.
|
7
|
+
|
8
|
+
*note, at this point the guard implementation throws errors when running. Not sure what the cause is...
|
9
|
+
|
10
|
+
|
11
|
+
Check the [Markdown Syntax Guide](http://daringfireball.net/projects/markdown/syntax) for help with Markdown.
|
12
|
+
The [Github Flavored Markdown page](http://github.github.com/github-flavored-markdown/) describes the differences between markdown on github and standard markdown.
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,203 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright 2014
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
203
|
+
-
|
data/README.md
ADDED
@@ -0,0 +1,290 @@
|
|
1
|
+
# Vcoworkflows
|
2
|
+
|
3
|
+
[][travis]
|
4
|
+
[](https://gemnasium.com/ActiveSCM/vcoworkflows)
|
5
|
+
[](https://coveralls.io/r/ActiveSCM/vcoworkflows)
|
6
|
+
[][inch]
|
7
|
+
|
8
|
+
[travis]: http://travis-ci.org/ActiveSCM/vcoworkflows
|
9
|
+
[gemnasium]: https://gemnasium.com/ActiveSCM/vcoworkflows
|
10
|
+
[coveralls]: https://coveralls.io/r/ActiveSCM/vcoworkflows
|
11
|
+
[inch]: http://inch-ci.org/github/ActiveSCM/vcoworkflows
|
12
|
+
|
13
|
+
`vcoworkflows` provides a Ruby API for finding and executing vCenter
|
14
|
+
Orchestrator workflows. You can search for a workflow either by name or
|
15
|
+
by GUID, populate the resulting `VcoWorkflows::Workflow` object's
|
16
|
+
`inputParameters` with the required values, and then request that the
|
17
|
+
the configured workflow be executed by vCenter Orchestrator.
|
18
|
+
|
19
|
+
Under the hood, communcations with vCenter Orchestrator is done via its
|
20
|
+
REST API, and all the REST heavy-lifting here is done by the fine and reliable
|
21
|
+
[`rest-client`](https://rubygems.org/gems/rest-client) gem. HTTP Basic
|
22
|
+
authentication is used with vCenter Orchestrator, and the username and
|
23
|
+
password can either be passed as command-line arguments or set as environment
|
24
|
+
variables (`$VCO_USER` and `$VCO_PASSWD`).
|
25
|
+
|
26
|
+
## Requirements
|
27
|
+
|
28
|
+
- [rest-client](https://github.com/rest-client/rest-client) is used for all the
|
29
|
+
communications with vCenter Orchestrator.
|
30
|
+
- [thor](http://whatisthor.com) is used for the command-line utilities.
|
31
|
+
|
32
|
+
The only external dependency is vCenter Orchestrator.
|
33
|
+
|
34
|
+
## Installation
|
35
|
+
|
36
|
+
`vcoworkflows` is distributed as a ruby gem.
|
37
|
+
|
38
|
+
Add this line to your application's Gemfile:
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
gem 'vcoworkflows'
|
42
|
+
```
|
43
|
+
|
44
|
+
And then execute:
|
45
|
+
|
46
|
+
$ bundle
|
47
|
+
|
48
|
+
Or install it yourself as:
|
49
|
+
|
50
|
+
$ gem install vcoworkflows
|
51
|
+
|
52
|
+
## Usage
|
53
|
+
|
54
|
+
Quick example:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
require 'vcoworkflows'
|
58
|
+
my_workflow = VcoWorkflows::Workflow.new(
|
59
|
+
'Request Component,
|
60
|
+
url: 'https://vco.example.com:8281/vco/api',
|
61
|
+
username: 'jdoe',
|
62
|
+
password: 's3cr3t',
|
63
|
+
|
64
|
+
)
|
65
|
+
|
66
|
+
```
|
67
|
+
|
68
|
+
All the necessary interactions with a Workflow in vCenter Orchestrator are
|
69
|
+
available via the [`VcoWorkflows::Workflow`](lib/vcoworkflows/Workflow.rb)
|
70
|
+
class.
|
71
|
+
|
72
|
+
### Selecting a Workflow
|
73
|
+
|
74
|
+
It is possible to select a Workflow by GUID (as divined by the vCenter
|
75
|
+
Orchestrator client) or by specifying the Workflow's name. If specifying by
|
76
|
+
name, however, an exeption will be raised if either no workflows are found,
|
77
|
+
or multiple workflows are found. Therefor, GUID is likely "safer". In either
|
78
|
+
case, however, the workflow name must be given, as in the example above.
|
79
|
+
|
80
|
+
Selecting a workflow by GUID is done by adding the `id:` parameter when
|
81
|
+
creating a new `Workflow` object:
|
82
|
+
|
83
|
+
```ruby
|
84
|
+
my_workflow = VcoWorkflows::Workflow.new(
|
85
|
+
'Request Component,
|
86
|
+
id: '6e04a460-4a45-4e16-9603-db2922c24462',
|
87
|
+
url: 'https://vco.example.com:8281/vco/api',
|
88
|
+
username: 'jdoe',
|
89
|
+
password: 's3cr3t',
|
90
|
+
verify_ssl: false
|
91
|
+
)
|
92
|
+
```
|
93
|
+
|
94
|
+
### Executing a workflow
|
95
|
+
|
96
|
+
To execute a workflow, set any input parameters to appropriate values (if
|
97
|
+
required), then send call `execute`. This will return an execution ID from
|
98
|
+
vCenter Orchestrator, which identifies the run you have requested. The
|
99
|
+
execution ID is also preserved in the `Workflow` object for simplicity.
|
100
|
+
|
101
|
+
```ruby
|
102
|
+
input_parameters = { 'name' => 'a string value',
|
103
|
+
'version' => '2',
|
104
|
+
'words' => %w(fe fi fo fum) }
|
105
|
+
# ...
|
106
|
+
input_parameters.each { |k, v| workflow.set_parameter(k, v) }
|
107
|
+
workflow.execute
|
108
|
+
```
|
109
|
+
|
110
|
+
### Checking an execution status
|
111
|
+
|
112
|
+
You can then get a Workflow Token from the Workflow, which will contain
|
113
|
+
state and result information for the execution.
|
114
|
+
|
115
|
+
```ruby
|
116
|
+
wf_token = workflow.token(workflow.execute)
|
117
|
+
```
|
118
|
+
|
119
|
+
The `WorkflowToken` can be used to determine the current state and disposition
|
120
|
+
of a Workflow execution. This can be used to periodically check up on the
|
121
|
+
execution, if you want to follow its status:
|
122
|
+
|
123
|
+
```ruby
|
124
|
+
finished = false
|
125
|
+
until finished
|
126
|
+
sleep 5
|
127
|
+
# Fetch a new workflow token to check the status of the workflow execution
|
128
|
+
wftoken = workflow.token
|
129
|
+
# If the execution is no longer alive, exit the loop and report the results.
|
130
|
+
unless wftoken.alive?
|
131
|
+
finished = true
|
132
|
+
wftoken.output_parameters.each { |k, v| puts " #{k}: #{v}" }
|
133
|
+
end
|
134
|
+
end
|
135
|
+
```
|
136
|
+
|
137
|
+
### Fetching the execution log
|
138
|
+
|
139
|
+
For any workflow execution, you can fetch the log:
|
140
|
+
|
141
|
+
```ruby
|
142
|
+
workflow.execute
|
143
|
+
# ... some time later
|
144
|
+
log = workflow.log
|
145
|
+
puts log
|
146
|
+
```
|
147
|
+
|
148
|
+
If you have the execution ID from a previous execution:
|
149
|
+
|
150
|
+
```ruby
|
151
|
+
log = workflow.log(execution_id)
|
152
|
+
puts log
|
153
|
+
```
|
154
|
+
|
155
|
+
### Querying a Workflow from the command line
|
156
|
+
|
157
|
+
The `vcoworkflows` command line allows you to query a vCO server for a
|
158
|
+
workflow, as well as executions and details on a specific execution.
|
159
|
+
|
160
|
+
```
|
161
|
+
$ vcoworkflows query "Request Component" \
|
162
|
+
--server=https://vco.example.com:8281/
|
163
|
+
|
164
|
+
Retrieving workflow 'Request Component' ...
|
165
|
+
|
166
|
+
Workflow: Request Component
|
167
|
+
ID: 6e04a460-4a45-4e16-9603-db2922c24462
|
168
|
+
Description:
|
169
|
+
Version: 0.0.33
|
170
|
+
|
171
|
+
Input Parameters:
|
172
|
+
coreCount (string) [required]
|
173
|
+
ramMB (string) [required]
|
174
|
+
onBehalfOf (string) [required]
|
175
|
+
machineCount (string) [required]
|
176
|
+
businessUnit (string) [required]
|
177
|
+
reservation (string) [required]
|
178
|
+
location (string) [required]
|
179
|
+
environment (string) [required]
|
180
|
+
image (string) [required]
|
181
|
+
runlist (Array/string) [required]
|
182
|
+
nodename (string) [required]
|
183
|
+
component (string) [required]
|
184
|
+
attributesJS (string) [required]
|
185
|
+
|
186
|
+
Output Parameters:
|
187
|
+
result (string) [required]
|
188
|
+
requestNumber (number) [required]
|
189
|
+
requestCompletionDetails (string) [required]
|
190
|
+
```
|
191
|
+
|
192
|
+
You can also retrieve a full list of executions, or only the last N:
|
193
|
+
|
194
|
+
```
|
195
|
+
$ vcoworkflows query "Request Component" \
|
196
|
+
--server=https://vco.example.com:8281/ \
|
197
|
+
--executions --last 5
|
198
|
+
|
199
|
+
Retrieving workflow 'Request Component' ...
|
200
|
+
|
201
|
+
|
202
|
+
Workflow: Request Component
|
203
|
+
ID: 6e04a460-4a45-4e16-9603-db2922c24462
|
204
|
+
Description:
|
205
|
+
Version: 0.0.33
|
206
|
+
|
207
|
+
Executions:
|
208
|
+
2014-12-19T20:38:18.457Z [ff8080814a1cb55c014a6445b85b7714] completed
|
209
|
+
2014-12-19T20:49:04.087Z [ff8080814a1cb55c014a644f925577cf] completed
|
210
|
+
2014-12-19T21:00:25.587Z [ff8080814a1cb55c014a6459f87278c0] completed
|
211
|
+
2014-12-19T21:25:04.170Z [ff8080814a1cb55c014a64708829797f] completed
|
212
|
+
2014-12-19T21:43:46.833Z [ff8080814a1cb55c014a6481a9927a78] completed
|
213
|
+
```
|
214
|
+
|
215
|
+
To get the logs from a specific execution:
|
216
|
+
|
217
|
+
```
|
218
|
+
vcoworkflows query "Request Component" \
|
219
|
+
--server=https://vco.example.com:8281/ \
|
220
|
+
--execution-id ff8080814a1cb55c014a6481a9927a78 \
|
221
|
+
--log
|
222
|
+
|
223
|
+
Retrieving workflow 'Request Component' ...
|
224
|
+
|
225
|
+
Fetching data for execution ff8080814a1cb55c014a6481a9927a78...
|
226
|
+
|
227
|
+
Execution ID: ff8080814a1cb55c014a6481a9927a78
|
228
|
+
Name: Request Component
|
229
|
+
Workflow ID: 6e04a460-4a45-4e16-9603-db2922c24462
|
230
|
+
State: completed
|
231
|
+
Start Date: 2014-12-19 13:43:46 -0800
|
232
|
+
End Date: 2014-12-19 13:55:24 -0800
|
233
|
+
Started By: user@example.com
|
234
|
+
|
235
|
+
Input Parameters:
|
236
|
+
coreCount = 2
|
237
|
+
ramMB = 2048
|
238
|
+
onBehalfOf = service_account@example.com
|
239
|
+
machineCount = 1
|
240
|
+
businessUnit = aw
|
241
|
+
reservation = nonprodlinux
|
242
|
+
location = us_east
|
243
|
+
environment = dev1
|
244
|
+
image = centos-6.6-x86_64-20141203-1
|
245
|
+
runlist =
|
246
|
+
- role[base]
|
247
|
+
- role[api]
|
248
|
+
nodename =
|
249
|
+
component = api
|
250
|
+
attributesJS =
|
251
|
+
|
252
|
+
Output Parameters:
|
253
|
+
result = SUCCESSFUL
|
254
|
+
requestNumber = 326.0
|
255
|
+
requestCompletionDetails = Request succeeded. Created vm00378.
|
256
|
+
|
257
|
+
2014-12-19 13:43:46 -0800 info: gruiz-ade: Workflow 'Request Component' has started
|
258
|
+
2014-12-19 13:43:59 -0800 info: gruiz-ade: Workflow is paused; Workflow 'Request Component' has paused while waiting on signal
|
259
|
+
2014-12-19 13:55:23 -0800 info: gruiz-ade: Workflow 'Request Component' has resumed
|
260
|
+
2014-12-19 13:55:24 -0800 info: gruiz-ade: Workflow 'Request Component' has completed
|
261
|
+
```
|
262
|
+
|
263
|
+
## Contributing
|
264
|
+
|
265
|
+
1. Fork it ( https://github.com/ActiveSCM/vcoworkflows/fork )
|
266
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
267
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
268
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
269
|
+
5. Create a new Pull Request
|
270
|
+
|
271
|
+
### License and Authors
|
272
|
+
|
273
|
+
- [Gregory Ruiz-Ade](https://github.com/gkra)
|
274
|
+
|
275
|
+
```
|
276
|
+
Copyright 2014 Active Network, LLC
|
277
|
+
|
278
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
279
|
+
you may not use this file except in compliance with the License.
|
280
|
+
You may obtain a copy of the License at
|
281
|
+
|
282
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
283
|
+
|
284
|
+
Unless required by applicable law or agreed to in writing, software
|
285
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
286
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
287
|
+
See the License for the specific language governing permissions and
|
288
|
+
limitations under the License.
|
289
|
+
```
|
290
|
+
|