vagrant-lightsail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82b6fc2ea5e0e5fd4c462a2e74516426060ca956
+  data.tar.gz: 3a9418b432a35da4848f966695fa40b0ef2b5b2e
+SHA512:
+  metadata.gz: 51b0c4ba1515e68cf9cfa559e51f57708f4576d4a145f4875e3b8d4c9992ff0a1978a98ebf3bfdd49ab678ac02c728dea224021237f044d49dfd05c155c5afd6
+  data.tar.gz: 6b13ed86e7e12095f3dc5ab2961f8f6fbec18be9095ba8f27c65d352d1ca89ede07bb3ef566bf23a5eed1d834da71b71f1cd386b7933732ce7d839c14c62f5f7

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/.vagrant/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,26 @@
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.2.6

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git', tag: 'v1.8.7'
+end
+
+group :plugins do
+  gem 'vagrant-lightsail', path: '.'
+  gem 'vagrant-puppet-install', '~> 4.1'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alejandro Figueroa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+# Lightsail Vagrant Provider
+
+`vagrant-lightsail` is a [Vagrant](https://www.vagrantup.com/) 1.2+
+plugin that support managing [Lightsail](https://amazonlightsail.com/)
+instances.
+
+It can:
+- Create and destroy instances
+- Power on and off instances
+- Provision an instance
+- Setup an SSH public key for authentication
+
+It is based heavily
+on [vagrant-aws](https://github.com/mitchellh/vagrant-aws)
+and
+[vagrant-digitalocean](https://github.com/devopsgroup-io/vagrant-digitalocean).
+
+## Install
+
+Install the provider plugin using the Vagrant command-line interface:
+
+`vagrant plugin install vagrant-lightsail`
+
+## Quick Start
+
+After installing the plugin, specify all the details within the
+`config.vm.provider` block in your Vagrantfile.
+
+```
+Vagrant.configure('2') do |config|
+  config.ssh.private_key_path = 'PATH TO YOUR PRIVATE KEY'
+  config.ssh.username         = 'ubuntu'
+  config.vm.box               = 'lightsail'
+  config.vm.box_url           = 'https://github.com/thejandroman/vagrant-lightsail/raw/master/box/lightsail.box'
+
+  config.vm.provider :lightsail do |provider, override|
+    provider.access_key_id     = 'YOUR KEY'
+    provider.secret_access_key = 'YOUR SECRET KEY'
+    provider.keypair_name      = 'KEYPAIR NAME'
+  end
+end
+```
+
+And then run `vagrant up`.
+
+This will start an Ubuntu instance in the us-east-1a availability zone
+within your account.
+
+**Note:** if you don't configure `provider.access_key_id` or
+`provider.secret_access_key` it will attempt to read credentials from
+environment variables first and then from `$HOME/.aws/`. You can
+choose your AWS profile and files location by using
+`provider.aws_profile` and `provider.aws_dir`, however environment
+variables will always have precedence as defined by
+the
+[AWS documentation](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html).
+To use profile `vagrantDev` from your AWS files:
+
+ ```ruby
+provider.aws_dir = ENV['HOME'] + "/.aws/"
+provider.aws_profile = "vagrantDev"
+ ```
+
+## Configuration
+
+The following attributes are available to configure the provider:
+
+- `access_key_id`
+  * The access key for accessing AWS
+- `availability_zone`
+  * The availability zone within the region to launch the instance. If
+    nil, it will append `a` to the region.
+- `aws_dir`
+  * AWS config and credentials location. Defaults to *$HOME/.aws/*.
+- `aws_profile`
+  * AWS profile in your config files. Defaults to *default*.
+- `blueprint_id`
+  * The ID for a virtual private server image. Defaults to *ubuntu_16_04*.
+- `bundle_id`
+  * The bundle of specification information for the instance,
+    including the pricing plan. Defaults to *nano_1_0*.
+- `endpoint`
+  * A regional endpoint.
+- `keypair_name`
+  * The name to use when creating an SSH key for
+    authentication. Defaults to *vagrant*.
+- `region`
+  * The region to start the instance in. Defaults to *us-east-1*.
+- `secret_access_key`
+  * The secret access key for accessing AWS.
+- `session_token`
+  * The session token provided by STS.
+- `user_data`
+  * Plain text user data for the instance being booted.
+
+## Contributing
+
+- Fork and clone repo
+- Install bundler
+```
+gem install bundler -v 1.12.5
+```
+- Install dependencies
+```
+bundle install
+```
+- Run tests
+```
+bundle exec rake test
+```
+- Make code changes
+- Run tests again
+- Create a Pull Request!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task :shell_test do
+  result = sh 'bash test/test.sh'
+
+  if result
+    puts 'Success!'
+  else
+    puts 'Failure!'
+    exit 1
+  end
+end
+
+desc 'Run all tests: rubocop, shell_test'
+task test: [:rubocop, :shell_test]
+
+task default: :test

data/box/metadata.json

@@ -0,0 +1,3 @@
+{
+  "provider": "lightsail"
+}

data/lib/vagrant-lightsail/action/connect_lightsail.rb

@@ -0,0 +1,33 @@
+require 'aws-sdk'
+require 'log4r'
+
+module VagrantPlugins
+  module Lightsail
+    module Action
+      # This action connects to Lightsail, verifies credentials work,
+      # and puts the Lightsail connection object into the
+      # `:lightsail_client` key in the environment.
+      class ConnectLightsail
+        def initialize(app, _)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_lightsail::action::connect_lightsail')
+        end
+
+        def call(env)
+          aws_sdk_config = {
+            access_key_id: env[:machine].provider_config.access_key_id,
+            secret_access_key: env[:machine].provider_config.secret_access_key,
+            session_token: env[:machine].provider_config.session_token,
+            region: env[:machine].provider_config.region
+          }
+          aws_sdk_config[:endpoint] = env[:machine].provider_config.endpoint if env[:machine].provider_config.endpoint
+
+          @logger.info('Connecting to AWS Lightsail...')
+          env[:lightsail_client] = Aws::Lightsail::Client.new(aws_sdk_config)
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module Lightsail
+    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, _)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id != :not_created
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module Lightsail
+    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, _)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id == :stopped
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/action/message_already_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module Lightsail
+    module Action
+      class MessageAlreadyCreated
+        def initialize(app, _)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t('vagrant_lightsail.already_status', status: 'created'))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/action/message_not_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module Lightsail
+    module Action
+      class MessageNotCreated
+        def initialize(app, _)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info(I18n.t('vagrant_lightsail.not_created'))
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/action/message_will_not_destroy.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module Lightsail
+    module Action
+      class MessageWillNotDestroy
+        def initialize(app, _)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info I18n.t 'vagrant_lightsail.will_not_destroy', name: env[:machine].name
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'log4r'
+
+module VagrantPlugins
+  module Lightsail
+    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, _)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_lightsail::action::read_ssh_info')
+        end
+
+        def call(env)
+          env[:machine_ssh_info] = read_ssh_info(env[:lightsail_client],
+                                                 env[:machine])
+          @app.call(env)
+        end
+
+        def read_ssh_info(lightsail, machine)
+          return nil if machine.id.nil?
+
+          begin
+            # Find the machine
+            server = lightsail.get_instance(instance_name: machine.id)
+          rescue Aws::Lightsail::Errors::NotFoundException
+            # The machine can't be found
+            @logger.info('Machine could not be found, assuming it got destroyed.')
+            machine.id = nil
+            return nil
+          end
+
+          { host: server.instance.public_ip_address, port: 22 }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require 'log4r'
+
+module VagrantPlugins
+  module Lightsail
+    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, _)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_lightsail::action::read_state')
+        end
+
+        def call(env)
+          env[:machine_state_id] = read_state(env[:lightsail_client],
+                                              env[:machine])
+          @app.call(env)
+        end
+
+        def read_state(lightsail, machine)
+          return :not_created if machine.id.nil?
+
+          begin
+            server = lightsail.get_instance_state(instance_name: machine.id)
+          rescue Aws::Lightsail::Errors::NotFoundException
+            return machine_not_found(machine)
+          end
+
+          if [:'shutting-down', :terminated].include? server.state.name.to_sym
+            return machine_not_found(machine)
+          end
+
+          server.state.name.to_sym
+        end
+
+        private
+
+        def machine_not_found(machine)
+          @logger.info('Machine could not be found, assuming it got destroyed.')
+          machine.id = nil
+          :not_created
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/action/run_instance.rb

@@ -0,0 +1,89 @@
+require 'log4r'
+require 'vagrant/util/retryable'
+
+module VagrantPlugins
+  module Lightsail
+    module Action
+      # This runs the configured instance.
+      class RunInstance
+        include Vagrant::Util::Retryable
+
+        def initialize(app, _)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_lightsail::action::run_instance')
+        end
+
+        def call(env)
+          # Get the configs
+          availability_zone = env[:machine].provider_config.availability_zone
+          blueprint_id      = env[:machine].provider_config.blueprint_id
+          bundle_id         = env[:machine].provider_config.bundle_id
+          instance_name     = env[:machine].config.vm.hostname || env[:machine].name
+          keypair_name      = env[:machine].provider_config.keypair_name
+          region            = env[:machine].provider_config.region
+          user_data         = env[:machine].provider_config.user_data
+
+          # If there is no keypair then warn the user
+          unless keypair_name
+            env[:ui].warn(I18n.t('vagrant_lightsail.launch_no_keypair'))
+          end
+
+          # Launch!
+          env[:ui].info(I18n.t('vagrant_lightsail.launching_instance'))
+          env[:ui].info(" -- Availability Zone: #{availability_zone}") if availability_zone
+          env[:ui].info(" -- Blueprint ID: #{blueprint_id}")
+          env[:ui].info(" -- Bundle ID: #{bundle_id}")
+          env[:ui].info(" -- Instance Name: #{instance_name}")
+          env[:ui].info(" -- Keypair: #{keypair_name}") if keypair_name
+          env[:ui].info(" -- Region: #{region}")
+          env[:ui].info(" -- User Data: #{user_data}") if user_data
+          env[:ui].info(' -- User Data: yes') if user_data
+
+          options = {
+            availability_zone: availability_zone,
+            blueprint_id:      blueprint_id,
+            bundle_id:         bundle_id,
+            instance_names:    [instance_name],
+            key_pair_name:      keypair_name,
+            user_data:         user_data
+          }
+
+          begin
+            env[:lightsail_client].create_instances(options).operations[0]
+          rescue Aws::Lightsail::Errors => e
+            raise Errors::LightailError, message: e
+          end
+
+          server = env[:lightsail_client].get_instance(instance_name: instance_name).instance
+          env[:machine].id = server.name
+
+          # wait for ssh to be ready
+          retryable(tries: 120, sleep: 10) do
+            next if env[:interrupted]
+            env[:ui].info(I18n.t('vagrant_lightsail.waiting_for_ssh'))
+            raise 'not ready' unless env[:machine].communicate.ready?
+          end
+
+          env[:ui].info(I18n.t('vagrant_lightsail.ready'))
+
+          terminate(env) if env[:interrupted]
+
+          @app.call(env)
+        end
+
+        def recover(env)
+          return if env['vagrant.error'].is_a?(Vagrant::Errors::VagrantError)
+          terminate(env) if env[:machine].provider.state.id != :not_created
+        end
+
+        def terminate(env)
+          destroy_env = env.dup
+          destroy_env.delete(:interrupted)
+          destroy_env[:config_validate] = false
+          destroy_env[:force_confirm_destroy] = true
+          env[:action_runner].run(Action.destroy, destroy_env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/action/setup_key.rb

@@ -0,0 +1,55 @@
+require 'log4r'
+
+module VagrantPlugins
+  module Lightsail
+    module Action
+      # This sets up the configured SSH key
+      class SetupKey
+        def initialize(app, _)
+          @app = app
+          @logger = Log4r::Logger.new('vagrant_lightsail::action::setup_key')
+        end
+
+        def call(env)
+          keypair_name = env[:machine].provider_config.keypair_name
+
+          begin
+            env[:lightsail_client].get_key_pair(key_pair_name: keypair_name)
+          rescue Aws::Lightsail::Errors::NotFoundException
+            create_ssh_key(keypair_name, env)
+          end
+
+          @app.call(env)
+        end
+
+        private
+
+        def create_ssh_key(name, env)
+          pub_key = public_key env[:machine].config.ssh.private_key_path
+
+          env[:ui].info I18n.t('vagrant_lightsail.info.creating_key', name: name)
+
+          begin
+            env[:lightsail_client].import_key_pair(
+              key_pair_name: name,
+              public_key_base_64: pub_key
+            )
+          rescue Aws::Lightsail::Errors => e
+            raise Errors::LightailError, message: e
+          end
+        end
+
+        def public_key(private_key_path)
+          pub_key = if private_key_path.is_a? Array
+                      Pathname.new private_key_path[0].to_s + '.pub'
+                    else
+                      Pathname.new private_key_path.to_s + '.pub'
+                    end.expand_path
+          raise Errors::PublicKeyError, path: pub_key.to_s unless pub_key.file?
+
+          pub_key.read
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/action/start_instance.rb

@@ -0,0 +1,40 @@
+require 'log4r'
+require 'vagrant/util/retryable'
+
+module VagrantPlugins
+  module Lightsail
+    module Action
+      # This starts a stopped instance.
+      class StartInstance
+        include Vagrant::Util::Retryable
+
+        def initialize(app, _)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_lightsail::action::start_instance')
+        end
+
+        def call(env)
+          server = env[:lightsail_client].get_instance(instance_name: env[:machine].id).instance
+
+          env[:ui].info I18n.t 'vagrant_lightsail.starting'
+
+          begin
+            env[:lightsail_client].start_instance(instance_name: server.name).operations[0]
+          rescue Aws::Lightsail::Errors => e
+            raise Errors::LightailError, message: e
+          end
+
+          retryable(tries: 120, sleep: 10) do
+            break if env[:interrupted]
+            env[:ui].info I18n.t 'vagrant_lightsail.waiting_for_ssh'
+            raise 'not ready' unless env[:machine].communicate.ready?
+          end
+
+          env[:ui].info I18n.t('vagrant_lightsail.ready')
+
+          @app.call env
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-lightsail/action/stop_instance.rb

@@ -0,0 +1,28 @@
+require 'log4r'
+
+module VagrantPlugins
+  module Lightsail
+    module Action
+      # This stops the running instance.
+      class StopInstance
+        def initialize(app, _)
+          @app    = app
+          @logger = Log4r::Logger.new('vagrant_lightsail::action::stop_instance')
+        end
+
+        def call(env)
+          server = env[:lightsail_client].get_instance(instance_name: env[:machine].id).instance
+
+          if env[:machine].state.id == :stopped
+            env[:ui].info I18n.t('vagrant_lightsail.already_status', status: env[:machine].state.id)
+          else
+            env[:ui].info(I18n.t('vagrant_lightsail.stopping'))
+            env[:lightsail_client].stop_instance(instance_name: server.name)
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end