fog-openstack 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31a9071364facb7a54109c5a95e7c9b712c6f78a
-  data.tar.gz: 81f2374694077b420e017aad70ad1c52268c01ec
+  metadata.gz: d9ce654512cff2b2a3f28e0824d064b301545033
+  data.tar.gz: a77a6c8e6ae3407c2ca6cb0cda7778475937dfb4
 SHA512:
-  metadata.gz: 6c2f0405c2e7356ebd64426c7e4878a7526504180eb3bf5bfffb1556df985228688c74f6b9f93a253bc4eacd5441238dc2ff1d72c22d944938bc6720f79d5c94
-  data.tar.gz: 41c0cc5fbd768ba1fffb0729609fe1504daed6a746a3c6d9b744f90693443fe3c599eab228438a0e56e613883c070e1d89fa38200895d2d6ecb13379dac71283
+  metadata.gz: a854f60f8714a51c8e8942c4186bcc9c8a5e2964bba44f566486965f5d9b31da92ccb11598722421c39069b88bace1ddf8f0a3425f3d568f8b794cadc4736557
+  data.tar.gz: 93d5e4dd2500f120a2458c658e125d0a2bd79f461ffab55ff62fed458cd5032d2f7ebe8b2f8c933bc631457a94f8d7d7f8b66261e9a8c22ddfa2e690b3048a31

data/README.md

@@ -310,43 +310,26 @@ volume.destroy
 
 ### Image (Glance)
 
-Create Glance image from URL:
+Download Glance image:
 
 ```ruby
 
 image = Fog::Image::OpenStack.new(@connection_params)
 
-cirros_location = "http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img"
+image_out = File.open("/tmp/cirros-image-download", 'wb')
 
-image.images.create name:             "cirros",
-                    disk_format:      "qcow2",
-                    container_format: "bare",
-                    location:         cirros_location
-# =>   <Fog::Image::OpenStack::V2::Image
-#     id="4beedb46-e32f-4ef3-a87b-7f1234294dc1",
-#     name="cirros",
-#     visibility="private",
-#     tags=[],
-#     self="/v2/images/4beedb46-e32f-4ef3-a87b-7f1234294dc1",
-#     size=nil,
-#     disk_format="qcow2",
-#     container_format="bare",
-#     id="4beedb46-e32f-4ef3-a87b-7f1234294dc1",
-#     checksum=nil,
-#     self="/v2/images/4beedb46-e32f-4ef3-a87b-7f1234294dc1",
-#     file="/v2/images/4beedb46-e32f-4ef3-a87b-7f1234294dc1/file",
-#     min_disk=0,
-#     created_at="2016-03-07T14:28:10Z",
-#     updated_at="2016-03-07T14:28:10Z",
-#     protected=false,
-#     status="queued",
-#   >
+streamer = lambda do |chunk, _, _|
+  image_out.write chunk
+end
+
+image.download_image(image.images.first.id, response_block: streamer)
 
 ```
 
-Create Glance image from file:
+Create Glance image from file or URL:
 
 ```ruby
+
 cirros_location = "http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img"
 image_out = File.open("/tmp/cirros-image-#{SecureRandom.hex}", 'wb')
 
@@ -359,8 +342,9 @@ image_out.close
 
 image.images.create name:             "cirros",
                     disk_format:      "qcow2",
-                    container_format: "bare",
-                    location:         image_out.path
+                    container_format: "bare"
+
+image.upload_data File.binread(image_out.path)
 
 ```
 

data/docs/workflow.md

@@ -0,0 +1,129 @@
+# OpenStack Workflow (Mistral)
+
+This document explains how to get started using OpenStack Workflow (Mistral) with Fog. It assumes you have read the [Getting Started with Fog and the OpenStack](getting_started.md) document.
+
+Fog uses the [OpenStack Mistral API](http://docs.openstack.org/developer/mistral/developer/webapi/v2.html).
+
+## Workflow Service
+
+Get a handle for the Workflow service:
+
+```ruby
+service = Fog::Workflow::OpenStack.new({
+  :openstack_auth_url  => 'http://KEYSTONE_HOST:KEYSTONE_PORT/v2.0/tokens', # OpenStack Keystone endpoint
+  :openstack_username  => OPEN_STACK_USER,                                  # Your OpenStack Username
+  :openstack_tenant    => OPEN_STACK_TENANT,                                # Your tenant id
+  :openstack_api_key   => OPEN_STACK_PASSWORD,                              # Your OpenStack Password
+  :connection_options  => {}                                                # Optional
+})
+```
+
+## Executions
+
+A Workflow is a composition of one or more actions.
+
+To execute a workflow, we create an execution:
+
+```ruby
+workflow = "tripleo.plan_management.v1.create_default_deployment_plan"
+input = { :container => 'default' }
+response = service.create_execution(workflow, input)
+```
+
+Execution status and result can be checked by:
+
+```ruby
+workflow_execution_id = response.body["id"]
+response = mistral.get_execution(workflow_execution_id)
+state = response.body["state"]
+```
+
+To execute an individual action, we create an action execution:
+
+```ruby
+input = { :container => 'default' }
+service.create_action_execution("tripleo.get_capabilities", input)
+```
+
+For actions, the result is returned when create_action_execution completes.
+
+## Workflows
+
+### Create a workflow
+
+```ruby
+workflow_def = {
+  :version => "2.0",
+  :myworkflow => {
+    :type        => "direct",
+    :description => "description1",
+    :tasks => {
+      :create_vm => {
+        :description => "create vm"
+      }
+    }
+  }
+}
+response = service.create_workflow(workflow_def)
+workflow_id = response.body["workflows"][0]["id"]
+```
+
+### Validate a workflow before creating it
+
+```ruby
+service.validate_workflow(workflow_def)
+```
+
+### Update a workflow
+
+```ruby
+workflow_def_new = {
+  :version => "2.0",
+  :myworkflow => {
+    :type        => "direct",
+    :description => "description2",
+    :tasks => {
+      :create_vm => {
+        :description => "create vm"
+      }
+    }
+  }
+}
+service.update_workflow(workflow_def_new)
+```
+
+### List workflow
+
+```ruby
+service.list_workflows
+```
+
+### Delete workflow
+
+```ruby
+service.delete_workflow(workflow_id)
+```
+
+## Other Mistral resources
+
+In addition to workflows, the following Mistral resources are also supported:
+
+* Workbooks
+* Actions
+* Executions
+* Tasks
+* Action Executions
+* Cron Triggers
+* Environments
+* Validations
+
+For examples on how to interact with these resources, please refer to
+https://github.com/fog/fog-openstack/tree/master/examples/workflow/workflow-examples.rb
+
+## Information about Mistral
+
+* [Mistral Wiki](https://wiki.openstack.org/wiki/Mistral)
+* [Mistral DSL v2](http://docs.openstack.org/developer/mistral/dsl/dsl_v2.html)
+* [Mistral API v2](http://docs.openstack.org/developer/mistral/developer/webapi/v2.html)
+* [Mistral python client](https://github.com/openstack/python-mistralclient) Can be useful to see how to interact with the API.
+

data/examples/workflow/workflow-examples.rb

@@ -0,0 +1,387 @@
+require 'fog/openstack'
+require 'fog/openstack/workflow_v2'
+
+auth_url = "http://192.0.2.1:5000/v3/auth/tokens"
+username = "admin"
+password = "1b1d81f7e25b53e497246b168971823c5754f395"
+project  = "admin"
+
+@connection_params = {
+  :openstack_auth_url     => auth_url,
+  :openstack_username     => username,
+  :openstack_api_key      => password,
+  :openstack_project_name => project,
+  :openstack_domain_id    => "default",
+}
+
+mistral = Fog::Workflow::OpenStack.new(@connection_params)
+
+puts "INFO: create_execution"
+
+workflow = "tripleo.plan_management.v1.create_default_deployment_plan"
+input = { :container => 'default' }
+
+response = mistral.create_execution(workflow, input)
+
+puts response.body
+
+state = response.body["state"]
+workflow_execution_id = response.body["id"]
+puts "INFO: state #{state} execution_id #{workflow_execution_id}"
+
+while state == "RUNNING"
+  sleep 5
+  response = mistral.get_execution(workflow_execution_id)
+  state = response.body["state"]
+  workflow_execution_id = response.body["id"]
+  puts "INFO: state #{state} execution_id #{workflow_execution_id}"
+end
+
+puts response.body
+
+puts "INFO: list_executions"
+
+response = mistral.list_executions
+
+puts response.body
+
+puts "INFO: update_execution"
+
+response = mistral.update_execution(workflow_execution_id, "description",
+                                    "changed description")
+puts response.body
+
+puts "INFO: list_tasks #{workflow_execution_id}"
+
+response = mistral.list_tasks(workflow_execution_id)
+task_ex_id = response.body["tasks"][0]["id"]
+puts response.body
+
+puts "INFO: get_task #{task_ex_id}"
+
+response = mistral.get_task(task_ex_id)
+puts response.body
+
+puts "INFO: rerun_task #{task_ex_id}"
+
+response = mistral.rerun_task(task_ex_id)
+puts response.body
+
+puts "INFO: delete_execution"
+
+response = mistral.delete_execution(workflow_execution_id)
+puts response.body
+
+puts "INFO: create_action_execution"
+
+input = { :container => 'default' }
+response = mistral.create_action_execution("tripleo.get_capabilities", input)
+
+puts response.body
+
+puts "INFO: list_action_executions"
+
+response = mistral.list_action_executions
+
+puts response.body
+
+puts "INFO: get_action_execution"
+
+execution_id = response.body["id"]
+response = mistral.get_action_execution(execution_id)
+
+puts response.body
+
+puts "INFO: create_workbook"
+
+workbook_def = {
+  :version => "2.0",
+  :name => "workbook name",
+  :description => "workbook description",
+}
+response = mistral.create_workbook(workbook_def)
+workbook_name = response.body["name"]
+
+puts response.body
+
+puts "INFO: get_workbook"
+
+response = mistral.get_workbook(workbook_name)
+
+puts response.body
+
+puts "INFO: list_workbooks"
+
+response = mistral.list_workbooks
+
+puts response.body
+
+puts "INFO: update_workbook"
+
+workbook_def = {
+  :version => "2.0",
+  :name => "workbook name",
+  :description => "workbook description2",
+}
+
+response = mistral.update_workbook(workbook_def)
+
+puts response.body
+
+puts "INFO: get_workbook2"
+
+response = mistral.get_workbook(workbook_name)
+
+puts response.body
+
+puts "INFO: validate_workbook"
+
+response = mistral.validate_workbook(workbook_def)
+
+puts response.body
+
+puts "INFO: delete_workbook"
+
+response = mistral.delete_workbook(workbook_name)
+puts response.body
+
+puts "INFO: create_workflow"
+
+workflow_def = {
+  :version => "2.0",
+  :myworkflow => {
+    :type        => "direct",
+    :description => "description1",
+    :tasks => {
+      :create_vm => {
+        :description => "create vm"
+      }
+    }
+  }
+}
+response = mistral.create_workflow(workflow_def)
+workflow_id = response.body["workflows"][0]["id"]
+
+puts response.body
+
+puts "INFO: get_workflow #{workflow_id}"
+
+response = mistral.get_workflow(workflow_id)
+
+puts response.body
+
+puts "INFO: list_workflows"
+
+response = mistral.list_workflows
+
+puts response.body
+
+puts "INFO: list_workflows with params"
+
+params = { :limit => 1 }
+response = mistral.list_workflows(params)
+perm_workflow_id = response.body["workflows"][0]["id"]
+
+puts response.body
+
+puts "INFO: update_workflow"
+
+workflow_def = {
+  :version => "2.0",
+  :myworkflow => {
+    :type        => "direct",
+    :description => "description2",
+    :tasks => {
+      :create_vm => {
+        :description => "create vm"
+      }
+    }
+  }
+}
+response = mistral.update_workflow(workflow_def)
+
+puts response.body
+
+puts "INFO: get_workflow2"
+
+response = mistral.get_workflow(workflow_id)
+
+puts response.body
+
+puts "INFO: validate_workflow"
+
+response = mistral.validate_workflow(workflow_def)
+
+puts response.body
+
+puts "INFO: delete_workflow #{workflow_id}"
+
+response = mistral.delete_workflow(workflow_id)
+puts response.body
+
+puts "INFO: create_action"
+
+action_def = {
+  :version => "2.0",
+  :myaction => {
+    :input => ['execution_id'],
+    :base  => "std.email",
+    "base-input" => {
+      :to_addrs      => ['admin@mywebsite.org'],
+      :subject       => "subject1",
+      :body          => "body1",
+      :from_addr     => "mistral@openstack.org",
+      :smtp_server   => "smtp.test.com",
+      :smtp_password => "secret"
+    }
+  }
+}
+response = mistral.create_action(action_def)
+
+puts response.body
+
+puts "INFO: get_action"
+
+action_name = "myaction"
+response = mistral.get_action(action_name)
+
+puts response.body
+
+puts "INFO: list_actions"
+
+response = mistral.list_actions
+
+puts response.body
+
+puts "INFO: list_actions with params"
+
+params = { :limit => 1 }
+response = mistral.list_actions(params)
+
+puts response.body
+
+puts "INFO: update_action"
+
+action_def = {
+  :version => "2.0",
+  :myaction => {
+    :input => ['execution_id'],
+    :base  => "std.email",
+    "base-input" => {
+      :to_addrs      => ['admin@mywebsite.org'],
+      :subject       => "subject updated",
+      :body          => "body1",
+      :from_addr     => "mistral@openstack.org",
+      :smtp_server   => "smtp.test.com",
+      :smtp_password => "secret"
+    }
+  }
+}
+
+response = mistral.update_action(action_def)
+
+puts response.body
+
+puts "INFO: get_action2"
+
+response = mistral.get_action(action_name)
+
+puts response.body
+
+puts "INFO: validate_action"
+
+response = mistral.validate_action(action_def)
+
+puts response.body
+
+puts "INFO: delete_action"
+
+response = mistral.delete_action(action_name)
+puts response.body
+
+puts "INFO: create_cron_trigger #{perm_workflow_id}"
+
+cron_name = "mycron"
+workflow_input = { "container" => "test1" }
+response = mistral.create_cron_trigger(cron_name,
+                                       perm_workflow_id,
+                                       workflow_input)
+
+puts response.body
+
+puts "INFO: get_cron_trigger"
+
+response = mistral.get_cron_trigger(cron_name)
+
+puts response.body
+
+puts "INFO: list_cron_triggers"
+
+response = mistral.list_cron_triggers
+
+puts response.body
+
+puts "INFO: delete_cron_trigger"
+
+response = mistral.delete_cron_trigger(cron_name)
+
+puts response.body
+
+puts "INFO: create_environment"
+
+environment_def = {
+  "name" => "environment-1",
+  "variables" => {
+    "var1" => "value1",
+    "var2" => "value2"
+  }
+}
+response = mistral.create_environment(environment_def)
+puts response.body
+
+puts "INFO: get_environment"
+
+environment_name = environment_def["name"]
+response = mistral.get_environment(environment_name)
+
+puts response.body
+
+puts "INFO: list_environments"
+
+response = mistral.list_environments
+
+puts response.body
+
+puts "INFO: update_environment"
+
+environment_def = {
+  "name" => "environment-1",
+  "variables" => {
+    "var1" => "value3",
+    "var2" => "value4"
+  }
+}
+response = mistral.update_environment(environment_def)
+
+puts response.body
+
+puts "INFO: get_environment2"
+
+response = mistral.get_environment(environment_name)
+
+puts response.body
+
+puts "INFO: delete_environment"
+
+response = mistral.delete_environment(environment_name)
+puts response.body
+
+#
+# Services api is unsupported atm. Next call will fail.
+#
+
+puts "INFO: list_services"
+
+response = mistral.list_services
+
+puts response.body