fog-zj 0.1.28

data/docs/workflow.md

@@ -0,0 +1,131 @@
+# 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
+})
+```
+
+Read more about the [Optional Connection Parameters](common/connection_params.md)
+
+## 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
+
+## Additional Resources
+
+* [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.
+* [more resources and feedback](common/resources.md)

data/examples/compute/basics.rb

@@ -0,0 +1,50 @@
+# OpenStack Compute (Nova) Example
+
+require 'fog/openstack'
+
+auth_url = "https://example.net/v2.0/tokens"
+username = 'admin@example.net'
+password = 'secret'
+tenant   = 'My Compute Tenant' # String
+
+compute_client ||= ::Fog::Compute.new(:provider           => :openstack,
+                                      :openstack_api_key  => password  ,
+                                      :openstack_username => username  ,
+                                      :openstack_auth_url => auth_url  ,
+                                      :openstack_tenant   => tenant)
+
+# Create VM
+# Options include metadata, availability zone, etc...
+
+begin
+  vm = compute_client.servers.create(:name => 'lucky',
+                                     :image_ref => 'fcd8f8a9',
+                                     :flavor_ref => 4)
+rescue => e
+  puts JSON.parse(e.response.body)['badRequest']['message']
+end
+
+# Destroy VM
+
+vm = compute_client.servers.get(vm.id) # Retrieve previously created vm by UUID
+floating_ips = vm.all_addresses # fetch and release its floating IPs
+floating_ips.each do |address|
+  compute_client.disassociate_address(uuid, address['ip'])
+  compute_client.release_address(address['id'])
+end
+vm.destroy
+
+# Images available at tenant
+image_names = compute_client.images.map { |image| image['name'] }
+
+# Floating IP address pools available at tenant
+compute_client.addresses.get_address_pools
+# response.body #=> { 'name' => 'pool1' }, { 'name' => 'pool2' }
+
+# VNC console
+vm.console.body # returns VNC url
+
+# "console" => {
+#                "url"  => "http://vmvncserver:6080/vnc_auto.html?token=231",
+#                "type" => "novnc"
+#              }

data/examples/compute/block_device_mapping_v2.rb

@@ -0,0 +1,30 @@
+# OpenStack Compute (Nova) Example
+
+require 'fog/openstack'
+
+auth_url = "https://example.net/v2.0/tokens"
+username = 'admin@example.net'
+password = 'secret'
+tenant   = 'My Compute Tenant' # String
+
+compute_client ||= ::Fog::Compute::OpenStack.new(
+  :openstack_api_key  => password,
+  :openstack_username => username,
+  :openstack_auth_url => auth_url,
+  :openstack_tenant   => tenant
+)
+
+_vm = compute_client.servers.create(
+  :name                    => name,
+  :flavor_ref              => flavor,
+  :block_device_mapping_v2 => [
+    {
+      :boot_index            => 0,
+      :device_name           => "vda",
+      :source_type           => "volume", # Or "snapshot"
+      :destination_type      => "volume",
+      :delete_on_termination => false,
+      :uuid                  => cinder_uddi,
+    }
+  ]
+)

data/examples/container_infra/basics.rb

@@ -0,0 +1,61 @@
+# OpenStack Container Infra (Magnum) Example
+require 'fog/openstack'
+
+# Initialize a connection to the Magnum API
+params = {
+  openstack_auth_url:     'https://example.net/v3/auth/tokens',
+  openstack_username:     'username',
+  openstack_api_key:      'password',
+  openstack_project_name: 'magnum'
+}
+
+container_infra = Fog::ContainerInfra::OpenStack.new(params)
+
+# Get the Fedora Atomic image
+image = Fog::Image::OpenStack.new(params)
+
+unless image.images.map(&:name).include?("fedora-atomic-latest")
+  puts "Couldn't find Fedora Atomic. Uploading to Glance..."
+  fedora = image.images.create name: "fedora-atomic-latest",
+                               disk_format: "qcow2",
+                               visibility: 'public',
+                               container_format: 'bare',
+                               copy_from: 'https://fedorapeople.org/groups/magnum/fedora-atomic-latest.qcow2',
+                               properties: {'os_distro' => 'fedora-atomic'}.to_json
+  fedora.wait_for { status == "active" }
+end
+
+# Create a cluster template for using Docker Swarm and Fedora Atomic
+params = {
+  name:                'swarm-cluster-template',
+  image_id:            'fedora-atomic-latest',
+  keypair_id:          'YOUR_KEYPAIR_NAME',
+  external_network_id: 'public',
+  master_flavor_id:    'm1.small',
+  flavor_id:           'm1.small',
+  coe:                 'swarm',
+  docker_volume_size:  3,
+  dns_nameserver:      '8.8.8.8',
+  tls_disabled:        true
+}
+
+cluster_template = container_infra.cluster_templates.create(params)
+puts "Created cluster template #{cluster_template.name} (#{cluster_template.uuid})"
+
+# Create a swarm cluster and wait for it to build
+params = {
+  name:                'swarm-cluster',
+  cluster_template_id: 'swarm-cluster-template',
+  master_count:        1,
+  node_count:          1
+}
+
+cluster = container_infra.clusters.create(params)
+start = Time.now
+puts "Building cluster #{cluster.name} (#{cluster.uuid})"
+
+cluster.wait_for { status != 'CREATE_IN_PROGRESS' }
+
+puts "Finished building #{cluster.name} in #{(Time.now - start).round} seconds. Status: #{cluster.status}."
+
+puts "More info: #{cluster.status_reason}" if cluster.status == 'CREATE_FAILED'

data/examples/event/basics.rb

@@ -0,0 +1,22 @@
+require 'fog/openstack'
+require 'time'
+
+auth_url = "http://10.0.0.101:5000/v2.0/tokens"
+username = 'admin'
+password = 'D78JVyRnzJG8j7Mb6fgpeUMp7'
+
+@connection_params = {
+    :openstack_auth_url     => auth_url,
+    :openstack_username     => username,
+    :openstack_api_key      => password,
+}
+
+puts "### SERVICE CONNECTION ###"
+
+event_service = Fog::Event::OpenStack.new(@connection_params)
+
+p event_service
+
+puts "### LIST EVENTS ###"
+
+p event_service.events.all

data/examples/identity/basics.rb

@@ -0,0 +1,67 @@
+# OpenStack Identity Service (Keystone) Example
+
+require 'fog/openstack'
+require 'pp'
+
+auth_url = "https://example.net/v2.0/tokens"
+username = 'admin@example.net'
+password = 'secret'
+
+keystone = Fog::Identity::OpenStack.new :openstack_auth_url => auth_url,
+                                        :openstack_username => username,
+                                        :openstack_api_key  => password
+                                        # Optional, self-signed certs
+                                        #:connection_options => { :ssl_verify_peer => false }
+
+#
+# Listing keystone tenants
+#
+keystone.tenants.each do |tenant|
+  # <Fog::Identity::OpenStack::Tenant
+  #   id="46b4ab...",
+  #   description=nil,
+  #   enabled=1,
+  #   name="admin@example.net"
+  # >
+  pp tenant
+end
+
+#
+# List users
+#
+keystone.users.each do |user|
+  # <Fog::Identity::OpenStack::User
+  #   id="c975f...",
+  #   email="quantum@example.net",
+  #   enabled=true,
+  #   name="quantum",
+  #   tenant_id="00928...",
+  #   password=nil
+  # >
+  # ...
+  pp user
+end
+
+#
+# Create a new tenant
+#
+tenant = keystone.tenants.create :name        => 'rubiojr@example.net',
+                                 :description => 'My foo tenant'
+
+#
+# Create a new user
+#
+user = keystone.users.create :name      => 'rubiojr@example.net',
+                             :tenant_id => tenant.id,
+                             :password  => 'rubiojr@example.net',
+                             :email     => 'rubiojr@example.net'
+
+# Find the recently created tenant
+tenant = keystone.tenants.find { |t| t.name == 'rubiojr@example.net' }
+# Destroy the tenant
+tenant.destroy
+
+# Find the recently created user
+user = keystone.users.find { |u| u.name == 'rubiojr@example.net' }
+# Destroy the user
+user.destroy

data/examples/identity/basics_v3.rb

@@ -0,0 +1,83 @@
+# OpenStack Identity Service (Keystone) Example
+
+require 'fog/openstack'
+require 'pp'
+
+auth_url = "https://example.net:35357/v3/auth/tokens"
+username = 'admin@example.net'
+password = 'secret'
+project = 'admin'
+domain = 'Default'
+
+
+
+keystone = Fog::Identity::OpenStack.new :openstack_auth_url => auth_url,
+                                        :openstack_username => username,
+                                        :openstack_api_key  => password,
+                                        :openstack_project_name => project,
+                                        :openstack_domain_name => domain
+                                        # Optional, self-signed certs
+                                        #:connection_options => { :ssl_verify_peer => false }
+
+#
+# List keystone projects
+#
+keystone.projects.each do |project|
+  #<Fog::Identity::OpenStack::V3::Project
+  #  id="17775c",
+  #  domain_id="default",
+  #  description="admin tenant",
+  #  enabled=true,
+  #  name="admin",
+  #  links={"self"=>"http://example.net:35357/..."},
+  #  parent_id=nil,
+  #  subtree=nil,
+  #  parents=nil
+  #>
+  # ...
+  pp project
+end
+
+#
+# List users
+#
+keystone.users.each do |user|
+  #<Fog::Identity::OpenStack::V3::User
+  #  id="02124b...",
+  #  default_project_id=2f534e...,
+  #  description=nil,
+  #  domain_id="default",
+  #  email="quantum@example.net",
+  #  enabled=true,
+  #  name="quantum",
+  #  links={"self"=>"http://example.net:35357/..."},
+  #  password=nil
+  #>
+  # ...
+  pp user
+end
+
+#
+# Create a new tenant
+#
+project = keystone.projects.create :name        => 'rubiojr@example.net',
+                                   :description => 'My foo tenant'
+
+#
+# Create a new user
+#
+user = keystone.users.create :name               => 'rubiojr@example.net',
+                             :default_project_id => project.id,
+                             :password           => 'rubiojr@example.net',
+                             :email              => 'rubiojr@example.net',
+                             :domain_id          => 'Default'
+
+# Find the recently created tenant
+project = keystone.projects.find { |t| t.name == 'rubiojr@example.net' }
+# Destroy the tenant
+project.destroy
+
+# Find the recently created user
+user = keystone.users.find { |u| u.name == 'rubiojr@example.net' }
+# Destroy the user
+user.destroy