vagrant-openstack-plugin-tom 0.12.0

data/lib/vagrant-openstack-plugin/config.rb

@@ -0,0 +1,246 @@
+require "vagrant"
+
+module VagrantPlugins
+  module OpenStack
+    class Config < Vagrant.plugin("2", :config)
+      # The API key to access OpenStack.
+      #
+      # @return [String]
+      attr_accessor :api_key
+
+      # The endpoint to access OpenStack. If nil, it will default
+      # to DFW.
+      #
+      # @return [String]
+      attr_accessor :endpoint
+
+      # The flavor of server to launch, either the ID or name. This
+      # can also be a regular expression to partially match a name.
+      attr_accessor :flavor
+
+      # The name or ID of the image to use. This can also be a regular
+      # expression to partially match a name.
+      attr_accessor :image
+
+      # The name of the server. This defaults to the name of the machine
+      # defined by Vagrant (via `config.vm.define`), but can be overriden
+      # here.
+      attr_accessor :server_name
+
+      # The username to access OpenStack.
+      #
+      # @return [String]
+      attr_accessor :username
+
+      # The name of the keypair to use.
+      #
+      # @return [String]
+      attr_accessor :keypair_name
+
+      # Network configurations for the instance
+      #
+      # @return [String]
+      attr_accessor :network
+
+      # @return [Array]
+      attr_accessor :networks
+
+      # A specific address identifier to use when connecting.
+      # Overrides `network` above if both are set.
+      #
+      attr_accessor :address_id
+
+      # Pass hints to the OpenStack scheduler, e.g. { "cell": "some cell name" }
+      attr_accessor :scheduler_hints
+
+      # Specify the availability zone in which to create the instance
+      attr_accessor :availability_zone
+
+      # List of strings representing the security groups to apply.
+      # e.g. ['ssh', 'http']
+      #
+      # @return [Array[String]]
+      attr_accessor :security_groups
+
+      # The SSH username to use with this OpenStack instance. This overrides
+      # the `config.ssh.username` variable.
+      #
+      # @return [String]
+      attr_accessor :ssh_username
+
+      # The IP address family that will be used to connect to the instance
+      #
+      # @return [String]
+      attr_accessor :ssh_ip_family
+
+      # A Hash of metadata that will be sent to the instance for configuration
+      #
+      # @return [Hash]
+      attr_accessor :metadata
+
+      # The tenant to use.
+      #
+      # @return [String]
+      attr_accessor :tenant
+
+      # User data to be sent to the newly created OpenStack instance. Use this
+      # e.g. to inject a script at boot time.
+      #
+      # @return [String]
+      attr_accessor :user_data
+
+      # The floating IP address from the IP pool which will be assigned to the instance.
+      #
+      # @return [String]
+      attr_accessor :floating_ip
+
+      # The floating IP pool from which IP addresses can be allocated
+      #
+      # @return [String]
+      attr_accessor :floating_ip_pool
+
+      # The region to specify when the OpenStack cloud has multiple regions
+      #
+      # @return [String]
+      attr_accessor :region
+
+      # The region to specify when the OpenStack cloud has multiple regions
+      #
+      # @return [String]
+      attr_accessor :project_name
+
+      # The region to specify when the OpenStack cloud has multiple regions
+      #
+      # @return [String]
+      attr_accessor :project_domain
+
+      # The region to specify when the OpenStack cloud has multiple regions
+      #
+      # @return [String]
+      attr_accessor :user_domain
+
+      # The proxy to specify when making connection to OpenStack API.
+      #
+      # @return [String]
+      attr_accessor :proxy
+
+      # The disks to create as OpenStack volumes.
+      #
+      # @return [Array]
+      attr_accessor :disks
+
+      # Value for SSL_VERIFY_PEER, defaults to true.  Set to false for self
+      # signed ssl certificate
+      attr_accessor :ssl_verify_peer
+
+      # Heat orchestration configuration parameters.
+      attr_accessor :orchestration_stack_name
+      attr_accessor :orchestration_stack_destroy
+      attr_accessor :orchestration_cfn_template
+      attr_accessor :orchestration_cfn_template_file
+      attr_accessor :orchestration_cfn_template_url
+      attr_accessor :orchestration_cfn_template_parameters
+
+      def initialize
+        @api_key  = UNSET_VALUE
+        @endpoint = UNSET_VALUE
+        @flavor   = UNSET_VALUE
+        @image    = UNSET_VALUE
+        @server_name = UNSET_VALUE
+        @metatdata = UNSET_VALUE
+        @username = UNSET_VALUE
+        @keypair_name = UNSET_VALUE
+        @network  = UNSET_VALUE
+        @networks  = UNSET_VALUE
+        @address_id  = UNSET_VALUE
+        @scheduler_hints = UNSET_VALUE
+        @availability_zone = UNSET_VALUE
+        @security_groups = UNSET_VALUE
+        @ssh_username = UNSET_VALUE
+        @ssh_ip_family = UNSET_VALUE
+        @tenant = UNSET_VALUE
+        @user_data = UNSET_VALUE
+        @floating_ip = UNSET_VALUE
+        @floating_ip_pool = UNSET_VALUE
+        @region = UNSET_VALUE
+        @project_name = UNSET_VALUE
+        @project_domain = UNSET_VALUE
+        @user_domain = UNSET_VALUE
+        @proxy = UNSET_VALUE
+        @ssl_verify_peer = UNSET_VALUE
+        @disks = UNSET_VALUE
+        @orchestration_stack_name = UNSET_VALUE
+        @orchestration_stack_destroy = UNSET_VALUE
+        @orchestration_cfn_template = UNSET_VALUE
+        @orchestration_cfn_template_file = UNSET_VALUE
+        @orchestration_cfn_template_url = UNSET_VALUE
+        @orchestration_cfn_template_parameters = UNSET_VALUE
+      end
+
+      def finalize!
+        @api_key  = nil if @api_key == UNSET_VALUE
+        @endpoint = nil if @endpoint == UNSET_VALUE
+        @flavor   = /m1.tiny/ if @flavor == UNSET_VALUE
+        @image    = /cirros/ if @image == UNSET_VALUE
+        @server_name = nil if @server_name == UNSET_VALUE
+        @metadata = nil if @metadata == UNSET_VALUE
+        @username = nil if @username == UNSET_VALUE
+        @network = nil if @network == UNSET_VALUE
+        @networks = nil if @networks == UNSET_VALUE
+        @address_id = 'public' if @address_id == UNSET_VALUE
+
+        # Keypair defaults to nil
+        @keypair_name = nil if @keypair_name == UNSET_VALUE
+
+        @scheduler_hints = nil if @scheduler_hints == UNSET_VALUE
+        @availability_zone = nil if @availability_zone == UNSET_VALUE
+        @security_groups = nil if @security_groups == UNSET_VALUE
+
+        # The SSH values by default are nil, and the top-level config
+        # `config.ssh` values are used.
+        @ssh_username = nil if @ssh_username == UNSET_VALUE
+        @ssh_ip_family = nil if @ssh_ip_family == UNSET_VALUE
+
+        @tenant = nil if @tenant == UNSET_VALUE
+        @user_data = "" if @user_data == UNSET_VALUE
+        @floating_ip = nil if @floating_ip == UNSET_VALUE
+        @floating_ip_pool = nil if @floating_ip_pool == UNSET_VALUE
+
+        @region = nil if @region == UNSET_VALUE
+        @project_name = nil if @project_name == UNSET_VALUE
+        @project_domain = nil if @project_domain == UNSET_VALUE
+        @user_domain = nil if @user_domain == UNSET_VALUE
+
+        @disks = nil if @disks == UNSET_VALUE
+
+        @region = nil if @region == UNSET_VALUE
+        @proxy = nil if @proxy == UNSET_VALUE
+        @ssl_verify_peer = nil if @ssl_verify_peer == UNSET_VALUE
+
+        @orchestration_stack_name = nil if @orchestration_stack_name == UNSET_VALUE
+        @orchestration_stack_destroy = false if @orchestration_stack_destroy == UNSET_VALUE
+        @orchestration_cfn_template = nil if @orchestration_cfn_template == UNSET_VALUE
+        @orchestration_cfn_template_file = nil if @orchestration_cfn_template_file == UNSET_VALUE
+        @orchestration_cfn_template_url = nil if @orchestration_cfn_template_url == UNSET_VALUE
+        @orchestration_cfn_template_parameters = nil if @orchestration_cfn_template_parameters == UNSET_VALUE
+      end
+
+      def validate(machine)
+        errors = []
+
+        errors << I18n.t("vagrant_openstack.config.api_key_required") if !@api_key
+        errors << I18n.t("vagrant_openstack.config.username_required") if !@username
+
+        if @disks and @disks.any?{|a| not a.respond_to?("include?")}
+          errors << I18n.t("vagrant_openstack.config.disks.specification_required")
+        elsif @disks
+          errors << I18n.t("vagrant_openstack.config.disks.name_required") if @disks.any?{|a| not a.include?("name")}
+          errors << I18n.t("vagrant_openstack.config.disks.description_required") if @disks.any?{|a| not a.include?("description")}
+          errors << I18n.t("vagrant_openstack.config.disks.size_required") if @disks.any?{|a| not a.include?("size")}
+        end
+
+        { "OpenStack Provider" => errors }
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-plugin/errors.rb

@@ -0,0 +1,71 @@
+require "vagrant"
+
+module VagrantPlugins
+  module OpenStack
+    module Errors
+      class VagrantOpenStackError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_openstack.errors")
+      end
+
+      class VolumeBadState < VagrantOpenStackError
+        error_key(:volume_bad_state)
+      end
+
+      class CreateBadState < VagrantOpenStackError
+        error_key(:create_bad_state)
+      end
+
+      class NoMatchingFlavor < VagrantOpenStackError
+        error_key(:no_matching_flavor)
+      end
+
+      class NoMatchingImage < VagrantOpenStackError
+        error_key(:no_matching_image)
+      end
+
+      class RsyncError < VagrantOpenStackError
+        error_key(:rsync_error)
+      end
+
+      class SSHNoValidHost < VagrantOpenStackError
+        error_key(:ssh_no_valid_host)
+      end
+
+      class FloatingIPNotValid < VagrantOpenStackError
+        error_key(:floating_ip_not_valid)
+      end
+      
+      class FloatingIPNotFound < VagrantOpenStackError
+        error_key(:floating_ip_not_found)
+      end
+
+      class FloatingIPNotAllocated < VagrantOpenStackError
+        error_key(:floating_ip_not_allocated)
+      end
+
+      class FloatingUnassignedIPNotFound < VagrantOpenStackError
+        error_key(:floating_unassigned_ip_not_found)
+      end
+
+      class FloatingIPFailedAssociate < VagrantOpenStackError
+        error_key(:floating_ip_failed_associate)
+      end
+
+      class FloatingUnassignedRequiresPool < VagrantOpenStackError
+        error_key(:floating_unassigned_requires_pool)
+      end
+
+      class OrchestrationTemplateError < VagrantOpenStackError
+        error_key(:orchestration_template_error)
+      end
+
+      class OrchestrationNoTemplateFileError < VagrantOpenStackError
+        error_key(:orchestration_no_template_file_error)
+      end
+
+      class ServerNotDestroyed < VagrantOpenStackError
+        error_key(:server_not_destroyed)
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-plugin/plugin.rb

@@ -0,0 +1,45 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The OpenStack Cloud provider must be run within Vagrant."
+end
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < "1.1.0"
+  raise "OpenStack Cloud provider is only compatible with Vagrant 1.1+"
+end
+
+module VagrantPlugins
+  module OpenStack
+    module Action
+      class Plugin < Vagrant.plugin("2")
+        name "OpenStack Cloud"
+        description <<-DESC
+      This plugin enables Vagrant to manage machines in OpenStack Cloud.
+        DESC
+
+        config(:openstack, :provider) do
+          require_relative "config"
+          Config
+        end
+
+        provider(:openstack, parallel: true) do
+          # Setup some things
+          OpenStack.init_i18n
+          OpenStack.init_logging
+
+          # Load the actual provider
+          require_relative "provider"
+          Provider
+        end
+
+        command "openstack" do
+          require_relative "command"
+          Command
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-plugin/provider.rb

@@ -0,0 +1,50 @@
+require "vagrant"
+
+require "vagrant-openstack-plugin/action"
+
+module VagrantPlugins
+  module OpenStack
+    class Provider < Vagrant.plugin("2", :provider)
+      def initialize(machine)
+        @machine = machine
+      end
+
+      def action(name)
+        # Attempt to get the action method from the Action class if it
+        # exists, otherwise return nil to show that we don't support the
+        # given action.
+        action_method = "action_#{name}"
+        return Action.send(action_method) if Action.respond_to?(action_method)
+        nil
+      end
+
+      def ssh_info
+        # Run a custom action called "read_ssh_info" which does what it
+        # says and puts the resulting SSH info into the `:machine_ssh_info`
+        # key in the environment.
+        env = @machine.action("read_ssh_info")
+        env[:machine_ssh_info]
+      end
+
+      def state
+        # Run a custom action we define called "read_state" which does
+        # what it says. It puts the state in the `:machine_state_id`
+        # key in the environment.
+        env = @machine.action("read_state")
+
+        state_id = env[:machine_state_id]
+
+        # Get the short and long description
+        short = I18n.t("vagrant_openstack.states.short_#{state_id}")
+        long  = I18n.t("vagrant_openstack.states.long_#{state_id}")
+
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+
+      def to_s
+        "OpenStack Cloud"
+      end
+    end
+  end
+end

data/lib/vagrant-openstack-plugin/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module OpenStack
+    VERSION = '0.12.0'
+  end
+end

data/locales/en.yml

@@ -0,0 +1,154 @@
+en:
+  vagrant_openstack:
+    already_created: |-
+      The server is already created.
+    already_paused: |-
+      The server is already paused.
+    already_suspended: |-
+      The server is already suspended.
+    creating_disks: |-
+      Creating disks with the folowing settings...
+    deleting_server: |-
+      Deleting server...
+    deleting_volumes: |-
+      Deleting volumes...
+    finding_flavor: |-
+      Finding flavor for server...
+    finding_image: |-
+      Finding image for server...
+    finding_network: |-
+      Finding network for server...
+    hard_rebooting_server: |-
+      Hard rebooting server instance.
+    launching_server: |-
+      Launching a server with the following settings...
+    not_created: |-
+      The server hasn't been created yet. Run `vagrant up` first.
+    pausing_server: |-
+      The server instance has been paused.
+    ready: |-
+      The server is ready!
+    rebooting_server: |-
+      This server instance is rebooting!
+    snapshoting_server: |-
+      This server instance is snapshoting!
+    snapshot_done: |-
+      Snapshot is ok
+    snapshot_in_progress: |-
+      Snapshot is in progress
+    resuming_server: |-
+      The server instance has been resumed.
+    rsync_folder: |-
+      Rsyncing folder: %{hostpath} => %{guestpath}
+    server_running: |-
+        The instance '%{name}' is already running!
+    suspending_server: |-
+      The server instance has been suspended!
+    waiting_for_build: |-
+      Waiting for the server to be built...
+    waiting_for_ssh: |-
+      Waiting for SSH to become available...
+    warn_networks: |-
+      Warning! The OpenStack provider doesn't support any of the Vagrant
+      high-level network configurations (`config.vm.network`). They
+      will be silently ignored.
+    will_not_destroy: |-
+        The instance '%{name}' will not be destroyed, since the confirmation
+        was declined.
+    creating_orchestration_stack: |-
+        Creating orchestration stack...
+    deleting_orchestration_stacks: |-
+        Deleting orchestration stacks...
+    config:
+      api_key_required: |-
+        An API key is required.
+      username_required: |-
+        A username is required.
+      metadata_must_be_hash: |-
+        Metadata must be a hash.
+      disks:
+        specification_required: |-
+          A disk specification is required for a disk configuration (array of hashes including name, description and size keys).
+        name_required: |-
+          A disk name is required for all disk specifications.
+        description_required: |-
+          A disk description is required for all disk specifications.
+        size_required: |-
+          A disk size is required for all disk specifications.
+
+    errors:
+      volume_bad_state: |-
+        The OpenStack volume '%{volume}' requested is in an unexpected state:
+        '%{state}'
+        Please run `vagrant destroy` if you want to start over.
+      create_bad_state: |-
+        While creating the server, it transitioned to an unexpected
+        state: '%{state}', instead of properly booting. Run `vagrant status`
+        to find out what can be done about this state, or `vagrant destroy`
+        if you want to start over.
+      no_matching_flavor: |-
+        No matching flavor was found! Please check your flavor setting
+        to make sure you have a valid flavor chosen.
+      no_matching_image: |-
+        No matching image was found! Please check your image setting to
+        make sure you have a valid image chosen.
+      rsync_error: |-
+        There was an error when attemping to rsync a share folder.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+      ssh_no_valid_host: |-
+        Unable to determine what host to connect to. Run `vagrant up` in
+        debug mode to see a list of networks available to your tenant.
+        Then set either `os.network` or `os.address_id` to one of the
+        network names.
+      floating_ip_not_valid: |-
+        The floating IP specified in the Vagrantfile does not match an
+        available public IP address returned by OpenStack.
+      floating_ip_not_found: |-
+        A floating IP could not be allocated, as no available floating 
+        IPs were found in OpenStack
+      floating_ip_not_allocated: |-
+        A floating IP could not be allocated from the pool.
+      floating_unassigned_ip_not_found: |-
+        An unassigned floating IP could not be found in the specified pool.
+      floating_ip_failed_associate: |-
+        The selected IP failed to associate
+      floating_unassigned_requires_pool: |-
+        You must specifiy a pool in floating_ip_pool when using associate_unassigned
+      orchestration_template_error: |-
+        There was an error while reading orchestration template.
+        Error: %{err}
+      orchestration_no_template_file_error: |-
+        Orchestration template file not found (%{fname}).
+      server_not_destroyed: |-
+        OpenStack server was not fully destroyed.
+
+    states:
+      short_active: |-
+        active
+      long_active: |-
+        The server is up and running. Run `vagrant ssh` to access it.
+      short_build: |-
+        building
+      short_suspended: |-
+        suspended
+      short_paused: |-
+        paused
+      short_shutoff: |-
+        shutdown
+      long_build: |-
+        The server is currently being built. You must wait for this to
+        complete before you can access it. You can delete the server, however,
+        by running `vagrant destroy`.
+      short_error: |-
+        error
+      long_error: |-
+        The server is in an erroneous state. Destroy the machine with
+        `vagrant destroy`.
+      short_not_created: |-
+        not created
+      long_not_created: |-
+        The server is not created. Run `vagrant up` to create it.