vagrant-cloudcenter 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d4c66986cae8f7c4095b70094c408b8da09ad0b
+  data.tar.gz: 887a35f63bdd429521a72c9bdcd48815030e3e1b
+SHA512:
+  metadata.gz: 88b0511d3d2cb3febb94e58d10c6034e1678e823c4358b02025d39f8ab050b8c6829f8f0bcccb99ecafad85d23f66c8ce74d1d412868a3f87f7c7753020013b5
+  data.tar.gz: ef1e21106b538189f6e81328f55aed0d0d48e4c09d624c534216b5ed917fc117e5a693077b140ed7b3fbc4c5de1147e7e1395a7445406eaad20f0f4ce7f87cb1

data/README.md

@@ -0,0 +1,143 @@
+# Cisco CloudCenter Vagrant Plugin - Proof of Concept
+
+This is a Vagrant plugin that adds a Cisco CloudCenter provider to Vagrant. It allows Vagrant to communicate with CloudCenter and have it control and provision machines in a number of public and private clouds. 
+
+This plugin is currently a Proof of Concept and has been developed and tested against Cisco CloudCenter 4.8.0 and Vagrant 1.2+
+
+![alt tag](https://github.com/conmurphy/vagrant-cloudcenter/blob/master/images/overview.png)
+
+Table of Contents
+=================
+
+* [Cisco CloudCenter Vagrant Plugin - Proof of Concept](#cisco-cloudcenter-vagrant-plugin---proof-of-concept)
+   * [Table of Contents](#table-of-contents)
+      * [Features](#features)
+      * [Usage](#usage)
+      * [Vagrantfile structure](#vagrantfile-structure)
+      * [Installation](#installation)
+      * [Box Format](#box-format)
+      * [Configuration](#configuration)
+      * [Deployment Config](#deployment-config)
+      * [Synced Folders](#synced-folders)
+      * [Guidelines and Limitations](#guidelines-and-limitations)
+      * [Development](#development)
+      
+Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
+
+## Features
+
+* Boot instances through CloudCenter
+* SSH into the instances
+* Provision the instances with any built-in Vagrant provisioner
+* Minimal synced folder support via `rsync`
+
+## Usage
+
+After installing the plugin use the `vagrant up` command an specify the `cloudcenter`  provider.
+
+```
+$ vagrant up --provider=cloudcenter
+...
+```
+
+The following additional plugin commands have been provided:
+
+* `vagrant cloudcenter init` - Create a template Vagrantfile and populate with your own configuration
+* `vagrant cloudcenter catalog` - Return a list of the current available catalog 
+* `vagrant cloudcenter jobs` - Return a list of service requests and their current status
+
+## Vagrantfile structure 
+
+You can either manually create a Vagrantfile that looks like the following, filling in
+your information where necessary, or run the `vagrant cloudcenter init` command to have an empty Vagrantfile created for you.
+
+```
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure(2) do |config|
+
+	config.vm.box = 'cloudcenter'
+	
+ 	config.ssh.private_key_path = ['/Users/MYUSERNAME/.ssh/id_rsa','/Users/MYUSERNAME/.vagrant.d/insecure_private_key']
+	config.ssh.insert_key = false
+	
+	config.vm.provider :cloudcenter do |cloudcenter|
+		cloudcenter.username = 'my_username'
+		cloudcenter.access_key = 'my_access_key'
+		cloudcenter.host_ip = 'cloudcenter_host_ip_address'
+		cloudcenter.deployment_config = 'sample_deployment_config.json'
+	end
+  
+  	config.vm.synced_folder '.', '/opt/my_files/', type: 'rsync'
+
+end
+```
+
+## Installation
+
+## Box Format
+
+The Vagrant CloudCenter plugin requires a box with configuration as outlined in this document.
+
+[Vagrant Box Format]( https://www.vagrantup.com/docs/boxes/base.html ) 
+
+* "vagrant" User
+* Root Password: "vagrant"
+* Password-less Sudo
+* SSH Tweaks
+
+## Configuration
+
+This provider exposes quite a few provider-specific configuration options:
+
+* `access_key` - The access key for accessing the Cisco CloudCenter API
+* `username` - The username for accessing the  CloudCenter API
+* `host_ip` - The host IP address of the CloudCenter Manager
+* `deployment_config` - A JSON file used by CloudCenter to deploy the desired infrastructure
+
+## Deployment Config
+
+This is a JSON file used by Cisco CloudCenter to deploy a new application into the environment of your choosing. It can be created by following these steps:
+
+1. Access the application from the CCM UI and click Applications
+2. Search for the required application in the Applications page
+3. Select `Deploy` 
+
+![alt tag](https://github.com/conmurphy/vagrant-cloudcenter/blob/master/images/AppProfiles.png)
+
+4. Complete the required fields
+5. Select `Restful JSON`
+
+![alt tag](https://github.com/conmurphy/vagrant-cloudcenter/blob/master/images/AppDeployment.png)
+
+6. Save the JSON output into a new file on your local machine - if sharing a single file amongst multiple people or for multiple projects be sure to change the deployment job name so there is no overlap. 
+7. Use this file in the `cloudcenter.deployment_config` setting
+
+## Synced Folders
+
+There is minimal support for synced folders. Upon `vagrant up`,
+`vagrant reload`, and `vagrant provision`, the CloudCenter provider will use
+`rsync` (if available) to uni-directionally sync the folder to
+the remote machine over SSH.
+
+See [Vagrant Synced folders: rsync](https://docs.vagrantup.com/v2/synced-folders/rsync.html)
+
+## Guidelines and Limitations
+
+* Currently tested with a single tier VM 
+
+## Development
+
+To work on the CloudCenter plugin, clone this repository then run the following commands to build and install the plugin.
+
+```
+$ gem build vagrant-cloudcenter.gemspec
+$ vagrant plugin install ./vagrant-cloudcenter-0.1.0.gem
+```
+
+To uninstall the plugin run `vagrant plugin uninstall vagrant-cloudcenter`
+
+WARNING:
+
+These scripts are meant for educational/proof of concept purposes only. Any use of these scripts and tools is at your own risk. There is no guarantee that they have been through thorough testing in a comparable environment and we are not responsible for any damage or data loss incurred with their use.

data/lib/vagrant-cloudcenter/action/deploy.rb

@@ -0,0 +1,146 @@
+
+require "log4r"
+require 'rest-client';
+require 'json';
+require 'base64'
+
+require 'vagrant/util/retryable'
+
+require 'vagrant-cloudcenter/util/timer'
+
+module VagrantPlugins
+  module Cloudcenter
+    module Action
+     
+      class Deploy
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("cloudcenter::action::connect")
+        end
+
+        def call(env)
+          
+          # Get the rest API key for authentication
+          access_key = env[:machine].provider_config.access_key
+          host_ip = env[:machine].provider_config.host_ip
+          username = env[:machine].provider_config.username
+  			
+          countdown = 24
+
+          #@logger.info("Deploying VM to Cloudcenter...")
+
+          begin
+
+            if !File.exists?(env[:machine].provider_config.deployment_config)
+              puts "\nMissing deployment_config file\n\n"
+              exit
+            end
+
+            deployment_config = File.read(env[:machine].provider_config.deployment_config)
+            tmp = JSON.parse(deployment_config)
+            env[:machine_name] = tmp["name"]
+
+            encoded = URI.encode("https://#{username}:#{access_key}@#{host_ip}/v2/jobs");           
+            
+            env[:cloudcenter_connect] = JSON.parse(RestClient::Request.execute(
+   									:method => :post,
+  									:url => encoded,
+                    :verify_ssl => false,
+                    :accept => "json",
+                    :payload => deployment_config,
+                    :headers => {"Content-Type" => "application/json"}
+									));
+
+            response = env[:cloudcenter_connect]
+            
+            jobID = response["id"]
+
+            encoded = URI.encode("https://#{username}:#{access_key}@#{host_ip}/v2/jobs/#{jobID}");           
+                      
+            response = JSON.parse(RestClient::Request.execute(
+              :method => :get,
+              :url => encoded,
+              :verify_ssl => false,
+              :accept => "json"
+                              
+            ))
+
+          rescue => e
+
+              error = JSON.parse(e.response) 
+              code = error["errors"][0]["code"] 
+
+              puts "\n Error code: #{error['errors'][0]['code']}\n"
+              puts "\n #{error['errors'][0]['message']}\n\n"
+
+              exit
+      
+          end
+
+            status = response["status"]
+
+                # Wait for SSH to be ready.
+                env[:ui].info(I18n.t("cloudcenter.waiting_for_ready"))
+               
+                while countdown > 0
+
+                  countdown -= 1
+                  
+                  # When an  instance comes up, it's networking may not be ready
+                  # by the time we connect.
+                  begin
+
+                      jobID = response["id"]
+
+                      encoded = URI.encode("https://#{username}:#{access_key}@#{host_ip}/v2/jobs/#{jobID}");           
+                      
+                      response = JSON.parse(RestClient::Request.execute(
+                              :method => :get,
+                              :url => encoded,
+                              :verify_ssl => false,
+                              :accept => "json"
+                              
+                      ))
+
+                      status = response["status"]
+                      
+                      
+                      if status == "JobRunning" then 
+                        env[:machine_state_id]= :created
+                        break
+                      elsif status == "JobStarting" || status == "JobSubmitted" || status == "JobInProgress" || status == "JobResuming"
+                        env[:ui].info(I18n.t("cloudcenter.waiting_for_ssh"))
+                      elsif status == "JobError" 
+                        puts "\nError deploying VM...\n"
+                        puts "\n#{response['jobStatusMessage']}\n\n"
+                        exit
+                      end
+                  
+                  rescue => e
+                    error = JSON.parse(e.response) 
+                    code = error["errors"][0]["code"] 
+
+                    puts "\n Error code: #{error['errors'][0]['code']}\n"
+                    puts "\n #{error['errors'][0]['message']}\n\n"
+
+                    exit
+                  end
+
+                  sleep 20
+                end
+             
+            env[:machine_public_ip] = response["accessLink"][7,response.length]
+        
+            # Ready and booted!
+            env[:ui].info(I18n.t("cloudcenter.ready"))
+         
+
+          @app.call(env)
+
+
+
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cloudcenter/action/is_created.rb

@@ -0,0 +1,88 @@
+module VagrantPlugins
+  module Cloudcenter
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is created and branch in the middleware.
+      class IsCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+
+              if !File.exists?(env[:machine].provider_config.deployment_config)
+                puts "Missing deployment_config file"
+                exit
+              end
+
+              if !env[:machine_name]
+                deployment_config = JSON.parse(File.read(env[:machine].provider_config.deployment_config))
+                env[:machine_name] = deployment_config["name"]
+              end
+
+              access_key = env[:machine].provider_config.access_key
+              host_ip = env[:machine].provider_config.host_ip
+              username = env[:machine].provider_config.username
+
+              begin 
+                encoded = URI.encode("https://#{username}:#{access_key}@#{host_ip}/v2/jobs?search=[deploymentEntity.name,fle,#{env[:machine_name]}]");           
+              
+                response = JSON.parse(RestClient::Request.execute(
+                        :method => :get,
+                        :url => encoded,
+                        :verify_ssl => false,
+                        :accept => "json",
+                        :headers => {"Content-Type" => "application/json"}
+                      ));
+               
+                if !response["jobs"].empty?
+                  jobID = response["jobs"][0]["id"]
+                end
+
+              rescue => e
+                error = JSON.parse(e.response) 
+                code = error["errors"][0]["code"] 
+
+                puts "\n Error code: #{error['errors'][0]['code']}\n"
+                puts "\n #{error['errors'][0]['message']}\n\n"
+
+                exit
+              end 
+
+              if !jobID.nil?
+                begin
+                  encoded = URI.encode("https://#{username}:#{access_key}@#{host_ip}/v2/jobs/#{jobID}");           
+              
+                  response = JSON.parse(RestClient::Request.execute(
+                    :method => :get,
+                    :url => encoded,
+                    :verify_ssl => false,
+                    :accept => "json"
+                  ));
+
+                rescue => e
+                  error = JSON.parse(e.response) 
+                  code = error["errors"][0]["code"] 
+
+                  puts "\n Error code: #{error['errors'][0]['code']}\n"
+                  puts "\n #{error['errors'][0]['message']}\n\n"
+
+                  exit
+                end 
+
+                env[:machine_public_ip] = response["accessLink"][7,response.length]
+                env[:machine_ssh_info] = { :host =>  env[:machine_public_ip], :port => 22, :username => "vagrant"}
+                env[:ssh_info]  = { :host =>  env[:machine_public_ip], :port => 22, :username => "vagrant"}
+                env[:result] = :created
+
+              else
+                env[:result] = :not_created
+              end
+           
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cloudcenter/action/is_stopped.rb

@@ -0,0 +1,97 @@
+module VagrantPlugins
+  module Cloudcenter
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is stopped and branch in the middleware.
+      class IsStopped
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+
+              if !File.exists?(env[:machine].provider_config.deployment_config)
+                puts "Missing deployment_config file"
+                exit
+              end
+              
+            if !env[:machine_name]
+                deployment_config = JSON.parse(File.read(env[:machine].provider_config.deployment_config))
+                env[:machine_name] = deployment_config["name"]
+              end
+
+              access_key = env[:machine].provider_config.access_key
+              host_ip = env[:machine].provider_config.host_ip
+              username = env[:machine].provider_config.username
+
+              begin 
+                encoded = URI.encode("https://#{username}:#{access_key}@#{host_ip}/v2/jobs?search=[deploymentEntity.name,fle,#{env[:machine_name]}]");           
+                response = JSON.parse(RestClient::Request.execute(
+                        :method => :get,
+                        :url => encoded,
+                        :verify_ssl => false,
+                        :accept => "json",
+                        :headers => {"Content-Type" => "application/json"}
+                      ));
+                if !response["jobs"].empty?
+                  jobID = response["jobs"][0]["id"]
+                end
+                
+              rescue => e
+                error = JSON.parse(e.response) 
+                code = error["errors"][0]["code"] 
+
+                if code ==  "DEPLOYMENT_STATUS_NOT_VALID_FOR_OPERATION"
+                  puts "\n Error code: #{error['errors'][0]['code']}\n"
+                  puts "\n #{error['errors'][0]['message']}\n\n"
+                  exit
+                else
+                  puts "\n Error code: #{error['errors'][0]['code']}\n"
+                  puts "\n #{error['errors'][0]['message']}\n\n"
+                end
+
+                exit
+              end 
+
+              if !jobID.nil?
+                begin
+                  encoded = URI.encode("https://#{username}:#{access_key}@#{host_ip}/v2/jobs/#{jobID}");           
+                  response = JSON.parse(RestClient::Request.execute(
+                    :method => :get,
+                    :url => encoded,
+                    :verify_ssl => false,
+                    :accept => "json",
+                  ));
+
+                rescue => e
+                  error = JSON.parse(e.response) 
+                  code = error["errors"][0]["code"] 
+
+                  if code ==  "DEPLOYMENT_STATUS_NOT_VALID_FOR_OPERATION"
+                    puts "\n Error code: #{error['errors'][0]['code']}\n"
+                    puts "\n #{error['errors'][0]['message']}\n\n"
+                    exit
+                  else
+                    puts "\n Error code: #{error['errors'][0]['code']}\n"
+                    puts "\n #{error['errors'][0]['message']}\n\n"
+                  end
+
+                  exit
+                end 
+
+                if response["deploymentEntity"]["attributes"]["health"] == "Healthy"
+                  env[:result] = :running
+                else 
+                  env[:result] = :stopped
+                end
+
+              else
+                env[:result] = :stopped
+              end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cloudcenter/action/read_ssh_info.rb

@@ -0,0 +1,90 @@
+require "log4r"
+require "json"
+
+module VagrantPlugins
+  module Cloudcenter
+    module Action
+      # This action reads the SSH info for the machine and puts it into the
+      # `:machine_ssh_info` key in the environment.
+      class ReadSSHInfo
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+              
+              if !File.exists?(env[:machine].provider_config.deployment_config)
+                puts "Missing deployment_config file"
+                exit
+              end
+
+          if !env[:machine_public_ip]
+            
+            begin
+              
+              if !env[:machine_name]
+                deployment_config = JSON.parse(File.read(env[:machine].provider_config.deployment_config))
+                env[:machine_name] = deployment_config["name"]
+              end
+
+              access_key = env[:machine].provider_config.access_key
+              host_ip = env[:machine].provider_config.host_ip
+              username = env[:machine].provider_config.username
+
+              encoded = URI.encode("https://#{username}:#{access_key}@#{host_ip}/v2/jobs?search=[deploymentEntity.name,fle,#{env[:machine_name]}]");           
+            
+              response = JSON.parse(RestClient::Request.execute(
+                      :method => :get,
+                      :url => encoded,
+                      :verify_ssl => false,
+                      :accept => "json",
+                      :headers => {"Content-Type" => "application/json"}
+                    ));
+              
+              jobID = response["jobs"][0]["id"]
+
+              rescue => e
+                error = JSON.parse(e.response) 
+                code = error["errors"][0]["code"] 
+
+                puts "\n Error code: #{error['errors'][0]['code']}\n"
+                puts "\n #{error['errors'][0]['message']}\n\n"
+
+                exit
+              end 
+
+              begin
+                encoded = URI.encode("https://#{username}:#{access_key}@#{host_ip}/v2/jobs/#{jobID}");           
+            
+                response = JSON.parse(RestClient::Request.execute(
+                  :method => :get,
+                  :url => encoded,
+                  :verify_ssl => false,
+                  :accept => "json"
+                ));
+              rescue => e
+                error = JSON.parse(e.response) 
+                code = error["errors"][0]["code"] 
+
+                puts "\n Error code: #{error['errors'][0]['code']}\n"
+                puts "\n #{error['errors'][0]['message']}\n\n"
+
+                exit
+              end 
+
+              env[:machine_public_ip] = response["accessLink"][7,response.length]
+
+          end 
+
+
+          env[:machine_ssh_info] = { :host =>  env[:machine_public_ip], :port => 22, :username => "vagrant",:private_key_path => env[:machine].config.ssh.private_key_path}
+
+          env[:ssh_info]  = { :host =>  env[:machine_public_ip], :port => 22, :username => "vagrant",:private_key_path => env[:machine].config.ssh.private_key_path}
+
+          @app.call(env)
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-cloudcenter/action/read_state.rb

@@ -0,0 +1,28 @@
+require "log4r"
+
+module VagrantPlugins
+  module Cloudcenter
+    module Action
+      # This action reads the state of the machine and puts it in the
+      # `:machine_state_id` key in the environment.
+      class ReadState
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("cloudcenter::action::read_state")
+        end
+
+        def call(env)
+          env[:machine_state_id] = read_state( env[:machine])
+
+          @app.call(env)
+        end
+
+        def read_state(machine)
+          return :not_created if machine.id.nil?
+
+          return env[:machine_state_id]
+        end
+      end
+    end
+  end
+end