vcoworkflows 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4aecbf8d560cb33986bb7724cb185dd4c674f979
-  data.tar.gz: afa37f3f01dc4e31e70121a5acb764192d0ea1f0
+  metadata.gz: efbc875310f3ff7f2308404dc5f0b7b073a83749
+  data.tar.gz: 7bb2186ea102c06a8373c5ac3a3a9edb53ae09f4
 SHA512:
-  metadata.gz: 2be9992176d0cde2177ade9b116047cb3cc2ee922d795efcfb9035c627ddc00dfac1aa68ac71859d896e7beb796af76bd1d7db7d252f21c271d6d00a7250b0e8
-  data.tar.gz: e298f6c3070df696fad7e3132798a55ad85522ad5890b99038fff2800ef03689c812175bc62cf3e8f5f3956e04697d607dbec5c4873f3b5ebb506861241a9334
+  metadata.gz: 3c553b3ed30daa80c8da7862795327b6a5b80e87e38c805fbef9fe9b9068b2d19c8f2003c8260e6dd60fde85548fc4bdeebf3d06c89e0de88e9f6c62c81e73c1
+  data.tar.gz: 830e9a0a09d43545e95c80fd25e6e834345d10d9d6a7520d563cef97ce57420f8b1980576262522f82b661687c28788540c6edece11cff062966de8f03453d1d

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 vcoworkflows CHANGELOG
 ================
 
+## 0.2.1
+
+- Update README with configuration file instructions
+
 ## 0.2.0
 
 - Removes `VcoWorkflows::Cli::Auth`

data/README.md

@@ -59,18 +59,91 @@ Quick example:
 ```ruby
 require 'vcoworkflows'
 workflow = VcoWorkflows::Workflow.new(
-    'Request Component',
-    url: 'https://vco.example.com:8281/',
-    username: 'jdoe',
-    password: 's3cr3t'
+  'Request Component',
+  url: 'https://vco.example.com:8281/',
+  username: 'jdoe',
+  password: 's3cr3t'
 )
-
 ```
 
 All the necessary interactions with a Workflow in vCenter Orchestrator are
 available via the [`VcoWorkflows::Workflow`](lib/vcoworkflows/Workflow.rb)
 class.
 
+### Configuration
+
+#### Configuration File
+
+The configuration file format is a simple JSON document with the following keys:
+
+- `url` - (*Required*) The vCO server URL (i.e., 'https://vco.example.com:8281/')
+- `username` - (*Optional*) User to authenticate as. Likely in the form 
+    `DOMAIN\\username` (be sure to escape backslashes). If not present, this can
+    be provided via the command-line parameter `--username` or by setting
+    `$VCO_USER` in the environment.
+- `password` - (*Optional*) Password to authenticate with. If not present, this
+    can be provided via the command-line parameter `--password` or by setting
+    `$VCO_PASSWD` in the environment.
+- `verify_ssl` - (*Optional*) Whether to perform TLS/SSL certificate validation.
+    Defaults to `true`.
+    
+An example configuration file, then, would look like:
+
+```json
+{
+  "verify_ssl": true,
+  "password": "s3cr3t",
+  "username": "EXAMPLE\\jdoe",
+  "url": "https://vco.example.com:8281/"
+}
+```
+    
+If `url`, `username` and `password` are not provided when created a new
+`Workflow` object, `VcoWorkflows` will look for a configuration file at:
+
+```shell
+${HOME}/.vcoworkflows/config.json
+```
+    
+Alternately, you can specify a different configuration file when constructing
+the `Workflow` object:
+
+```ruby
+workflow = VcoWorkflows::Workflow.new(
+  'My Workflow',
+  config_file: '/tmp/vcoworkflow.json`
+)
+```
+
+#### `VcoWorkflows::Config` class
+
+For additional control, you can create a `VcoWorkflows::Config` object and
+hand that to the `Workflow` constructor. If you provide no parameters, it will
+attempt to load the default configuration file, as above:
+
+```ruby
+config = VcoWorkflows::Config.new
+workflow = VcoWorkflows::Workflow.new('My Workflow', config: config)
+```
+
+You can also specify a non-default configuration file:
+
+```ruby
+config = VcoWorkflows::Config.new(config_file: '/tmp/myconfig.json')
+```
+
+And, of course, you can set all the required parameters yourself if you don't
+want or need to use a configuration file:
+
+```ruby
+config = VcoWorkflows::Config.new(
+  url: 'https://vco.example.com:8281/',
+  username: 'jdoe',
+  password: 's3cr3t'
+)
+workflow = VcoWorkflows::Workflow.new('My Workflow', config: config)
+```
+
 ### Selecting a Workflow
 
 It is possible to select a Workflow by GUID (as divined by the vCenter
@@ -84,11 +157,11 @@ creating a new `Workflow` object:
 
 ```ruby
 workflow = VcoWorkflows::Workflow.new(
-    'Request Component',
-    id: '6e04a460-4a45-4e16-9603-db2922c24462',
-    url: 'https://vco.example.com:8281/',
-    username: 'jdoe',
-    password: 's3cr3t'
+  'My Workflow',
+  id: '6e04a460-4a45-4e16-9603-db2922c24462',
+  url: 'https://vco.example.com:8281/',
+  username: 'jdoe',
+  password: 's3cr3t'
 )
 ```
 

data/lib/vcoworkflows/version.rb

@@ -1,5 +1,5 @@
 # VcoWorkflows
 module VcoWorkflows
   # Gem Version
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcoworkflows
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Gregory Ruiz-ade