vagrant-subutai 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d6d2a8545054356ac7b25e47d3d8645da0ef26a
+  data.tar.gz: 32d23a3c72eb1e0acbed5739e96208466dcec272
+SHA512:
+  metadata.gz: 35680eed7399518c665f5aacff2890f6990d84fc8256d331aeb35fddf1db76ae619a095342053a2556021b88cb7d435f7bcc23f181b907ed7b70453a51f8b2ff
+  data.tar.gz: 347b417244213eb2616e99895b1c936dcf6bfb084c561ac311f0179ea430c306f4184aa85372395c9ad75a108ef33cb040e515c278eeee41b0f2340fd36db269

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+.idea/
+.vagrant/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp
+*.gem
+pkg
+Gemfile.lock
+build.sh

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+	gem "vagrant", :git => "git://github.com/mitchellh/vagrant.git"
+end

data/README.md

@@ -0,0 +1,52 @@
+# Vagrant Subutai CLI
+
+Vagrant Subutai CLI - executes Subutai scripts in target hosts
+
+## Installation
+
+    $ vagrant plugin install vagrant-subutai
+
+## Usage
+```
+Usage: vagrant subutai command [command options] [arguments...]
+
+COMMANDS:
+       attach                  - attach to Subutai container
+       backup                  - backup Subutai container
+       batch                   - batch commands execution
+       checkpoint              - checkpoint/restore in user space
+       clone                   - clone Subutai container
+       cleanup                 - clean Subutai environment
+       config                  - edit container config
+       daemon                  - start Subutai agent
+       demote                  - demote Subutai container
+       destroy                 - destroy Subutai container
+       export                  - export Subutai container
+       import                  - import Subutai template
+       info                    - information about host system
+       hostname                - Set hostname of container or host
+       list                    - list Subutai container
+       log                     - print application logs
+       map                     - Subutai port mapping
+       metrics                 - list Subutai container
+       migrate                 - migrate Subutai container
+       p2p                     - P2P network operations
+       promote                 - promote Subutai container
+       proxy                   - Subutai reverse proxy
+       quota                   - set quotas for Subutai container
+       rename                  - rename Subutai container
+       restore                 - restore Subutai container
+       stats                   - statistics from host
+       start                   - start Subutai container
+       stop                    - stop Subutai container
+       tunnel                  - SSH tunnel management
+       update                  - update Subutai management, container or Resource host
+       vxlan                   - VXLAN tunnels operation
+       register                - register Subutai Peer to Hub
+       fingerprint             - shows fingerprint Subutai Console
+       disk                    - manage Subutai disk
+
+GLOBAL OPTIONS:
+       -h, --help              - show help
+```
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+Rake::TestTask.new do |t|
+    t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/Vagrantfile

@@ -0,0 +1,7 @@
+# Vagrant.plugin "subutai_cli"
+
+Vagrant::Config.run do |config|
+	config.vm.box = "theritty/test-fai"
+	config.ssh.username = "root"
+	config.ssh.password = "fai"
+end

data/lib/vagrant-subutai.rb

@@ -0,0 +1,12 @@
+require 'vagrant'
+require 'vagrant-subutai/command'
+require 'vagrant-subutai/config'
+require 'vagrant-subutai/plugin'
+require 'vagrant-subutai/rest'
+require 'vagrant-subutai/subutai_commands'
+require 'vagrant-subutai/version'
+require 'vagrant-subutai/rh_controller'
+require 'vagrant-subutai/models/resource_host'
+require 'vagrant-subutai/packer/subutai_config'
+require 'vagrant-subutai/packer/subutai_hooks'
+require 'vagrant-subutai/packer/subutai_net'

data/lib/vagrant-subutai/command.rb

@@ -0,0 +1,142 @@
+require_relative '../vagrant-subutai'
+require 'optparse'
+require 'io/console'
+require 'net/https'
+require_relative 'subutai_commands'
+require 'fileutils'
+
+module VagrantSubutai
+  module Subutai
+    class Command < Vagrant.plugin('2', :command)
+      # shows description when `vagrant list-commands` is triggered
+      def self.synopsis
+        'Vagrant Subutai CLI - executes Subutai scripts in target hosts'
+      end
+
+      def execute
+        cli_info
+
+        # Gets Subutai console url and box name from Vagrantfile
+        with_target_vms(nil, single_target: true) do |machine|
+          $SUBUTAI_BOX_NAME = machine.config.vm.box
+        end
+
+        subutai_cli = VagrantSubutai::Commands.new(ARGV, @env)
+
+        case ARGV[1]
+          when 'register'
+            check_subutai_console_url(subutai_cli)
+            subutai_cli.register(nil, nil)
+          when 'fingerprint'
+            check_subutai_console_url(subutai_cli)
+            subutai_cli.fingerprint($SUBUTAI_CONSOLE_URL)
+          when 'disk'
+            OptionParser.new do |opt|
+              opt.banner = 'Usage: vagrant subutai disk [options]'
+
+              opt.on('-s', '--size NUMBER', 'set your disk size') do |num|
+                disk = num.to_i
+
+                generated_disk = SubutaiConfig.get(:_SUBUTAI_DISK)
+
+                if generated_disk.nil?
+                  grow_by = disk - 100 # default Subutai disk is 100 gigabytes
+                else
+                  grow_by = disk - (generated_disk.to_i + 100) # HERE Applied math BEDMAS rule
+                end
+
+                if grow_by > 0
+                  SubutaiConfig.put(:SUBUTAI_DISK, num, true)
+                  STDOUT.puts "    \e[33mWarning the disk change cannot be applied until a restart of the VM.\e[0m"
+                else
+                  STDOUT.puts "    \e[33mWarning the operation will be ignored because it shrink operations are not supported.\e[0m"
+                end
+              end
+
+              opt.on('-i', '--info', 'shows Subutai disk capacity') do
+                disk = SubutaiConfig.get(:SUBUTAI_DISK)
+
+                if disk.nil?
+                  STDOUT.puts "    \e[32mSubutai disk capacity is 100 gb.\e[0m"
+                else
+                  STDOUT.puts "    \e[32mSubutai disk capacity is #{disk} gb.\e[0m"
+                end
+              end
+            end.parse!
+          when '-h'
+            STDOUT.puts cli_info
+          when '--help'
+            STDOUT.puts cli_info
+          else
+            # All Agent CLI commands implemented here
+
+            command = ARGV
+            command.shift
+
+            if command.empty?
+              STDOUT.puts cli_info
+            else
+              subutai_cli.ssh("#{subutai_cli.base} #{command.join(' ')}")
+            end
+        end
+      end
+
+      def check_subutai_console_url(subutai_cli)
+        ip = subutai_cli.info(VagrantCommand::ARG_IP_ADDR)
+
+        if ip.nil?
+          STDOUT.puts "We can't detect your Subutai Console ip address!"
+          exit
+        end
+        $SUBUTAI_CONSOLE_URL = "https://#{ip}:#{SubutaiConsoleAPI::PORT}"
+      end
+
+      def cli_info
+        commands = <<-EOF
+          
+Usage: vagrant subutai command [command options] [arguments...]
+
+COMMANDS:
+       attach                  - attach to Subutai container
+       backup                  - backup Subutai container
+       batch                   - batch commands execution
+       checkpoint              - checkpoint/restore in user space
+       clone                   - clone Subutai container
+       cleanup                 - clean Subutai environment
+       config                  - edit container config
+       daemon                  - start Subutai agent
+       demote                  - demote Subutai container
+       destroy                 - destroy Subutai container
+       export                  - export Subutai container
+       import                  - import Subutai template
+       info                    - information about host system
+       hostname                - Set hostname of container or host
+       list                    - list Subutai container
+       log                     - print application logs
+       map                     - Subutai port mapping
+       metrics                 - list Subutai container
+       migrate                 - migrate Subutai container
+       p2p                     - P2P network operations
+       promote                 - promote Subutai container
+       proxy                   - Subutai reverse proxy
+       quota                   - set quotas for Subutai container
+       rename                  - rename Subutai container
+       restore                 - restore Subutai container
+       stats                   - statistics from host
+       start                   - start Subutai container
+       stop                    - stop Subutai container
+       tunnel                  - SSH tunnel management
+       update                  - update Subutai management, container or Resource host
+       vxlan                   - VXLAN tunnels operation
+       register                - register Subutai Peer to Hub
+       fingerprint             - shows fingerprint Subutai Console
+       disk                    - manage Subutai disk
+
+GLOBAL OPTIONS:
+       -h, --help              - show help
+        EOF
+        commands
+      end
+    end
+  end
+end

data/lib/vagrant-subutai/config.rb

@@ -0,0 +1,52 @@
+require_relative '../vagrant-subutai'
+
+module SubutaiAgentCommand
+  BASE = "sudo /snap/bin/subutai"
+  UPDATE = " update"                   # arg required
+  LOG = " log"
+  INFO = " info"                       # arg required
+  TEMPLATE_IMPORT = " import ubuntu16"
+  TEMPLATE_CLONE = " clone ubuntu16"   # arg required
+  TEMPLATE_ATTACH = " attach"          # arg required
+  TEMPLATE_EXPORT = " export"          # arg required
+  LIST = " list"
+end
+
+module SubutaiConsoleAPI
+  PORT = "8443"
+  module V1
+    TOKEN = "/rest/v1/identity/gettoken"
+    REGISTER_HUB = "/rest/v1/hub/register?sptoken="
+    APPROVE = "/rest/v1/registration/requests"
+    FINGERPRINT = "/rest/v1/security/keyman/getpublickeyfingerprint"
+    REQUESTS = "/rest/v1/registration/requests?sptoken="
+  end
+end
+
+module VagrantSubutai
+  module Subutai
+    RH_FOLDER_NAME = "RH"
+
+    class Config < Vagrant.plugin('2', :config)
+      attr_accessor :url
+
+      def initialize
+        super
+        @url = UNSET_VALUE
+      end
+
+      def finalize!
+        @url = "" if @url == UNSET_VALUE
+      end
+    end
+  end
+end
+
+module VagrantCommand
+  INIT = "vagrant init"
+  UP = "vagrant up"
+  RH_UP = "SUBUTAI_PEER=false vagrant up"
+  PROVISION = "vagrant provision"
+  SUBUTAI_ID = "vagrant subutai --info id"
+  ARG_IP_ADDR = "ipaddr"
+end

data/lib/vagrant-subutai/models/resource_host.rb

@@ -0,0 +1,7 @@
+module VagrantSubutai
+  module Models
+    class Rh
+      attr_accessor :id, :hostname, :status, :isManagement, :isConnected
+    end
+  end
+end

data/lib/vagrant-subutai/packer/subutai_config.rb

@@ -0,0 +1,380 @@
+require 'yaml'
+require 'digest'
+require 'net/http'
+require 'json'
+
+require_relative 'subutai_net'
+require_relative 'subutai_hooks'
+
+# Vagrant Driven Subutai Configuration
+# noinspection RubyTooManyMethodsInspection
+module SubutaiConfig
+  LOG_MODES = %i[debug info warn error].freeze
+  PARENT_DIR = './.vagrant'.freeze
+  GENERATED_FILE = PARENT_DIR + '/generated.yml'.freeze
+  CONF_FILE = File.expand_path('./vagrant-subutai.yml').freeze
+  USER_CONF_FILE = File.expand_path('~/.vagrant-subutai/vagrant-subutai.yml').freeze
+  SUBUTAI_ENVIRONMENTS = %i[prod master dev sysnet].freeze
+
+  # Without a variable key listed here it will not get pulled in from
+  # the environment, or from any of the vagrant-subutai.yml conf files
+  USER_PARAMETERS = %i[
+    DESIRED_CONSOLE_PORT
+    DESIRED_SSH_PORT
+    ALLOW_INSECURE
+    SUBUTAI_ENV
+    SUBUTAI_CPU
+    SUBUTAI_RAM
+    SUBUTAI_PEER
+    SUBUTAI_SNAP
+    SUBUTAI_DESKTOP
+    SUBUTAI_MAN_TMPL
+    APT_PROXY_URL
+    PROVISION
+    BRIDGE
+    AUTHORIZED_KEYS
+    PASSWORD_OVERRIDE
+    SUBUTAI_DISK
+  ].freeze
+  
+  GENERATED_PARAMETERS = %i[
+    _BRIDGED
+    _CONSOLE_PORT
+    _BASE_MAC
+    _SSH_PORT
+    _LOG_MODE
+    _ALT_SNAP
+    _ALT_SNAP_MD5
+    _ALT_SNAP_MD5_LAST
+    _ALT_MANAGEMENT
+    _ALT_MANAGEMENT_MD5
+    _ALT_MANAGEMENT_MD5_LAST
+    _SUBUTAI_DISK
+    _SUBUTAI_DISK_PORT
+  ].freeze
+
+  # Used for testing
+  @conf_file_override = nil
+
+  # Vagrant command currently being executed, must not be nil
+  @cmd = nil
+
+  # Hash of generated/calculated settings preserved through commands
+  @generated = {}
+
+  # Smart defaults to use for configuration settings
+  @defaults = {
+    # Implemented configuration parameters
+    DESIRED_CONSOLE_PORT: 9999,      # integer for console port
+    DESIRED_SSH_PORT: 4567,          # integer for console port
+    ALLOW_INSECURE: false,           # boolean to enable insecure CDN and snap
+    SUBUTAI_ENV: :prod,              # subutai environment to use
+    SUBUTAI_PEER: true,              # to provision or not console (peer)
+    SUBUTAI_RAM: 4096,               # RAM memory assigned to the vm
+    SUBUTAI_CPU: 2,                  # virtual CPU's assign to the vm
+
+    # Configuration parameters below have not been implemented
+    SUBUTAI_SNAP: nil,               # alternative snap to provision
+    SUBUTAI_DESKTOP: false,          # install desktop with tray and p2p client
+    SUBUTAI_MAN_TMPL: nil,           # provision alternative management template
+    APT_PROXY_URL: nil,              # configure apt proxy URL
+    PROVISION: true                  # to provision or not to
+  }
+
+  # User provided configuration settings
+  @config = @defaults.clone
+
+  @logging = nil
+
+  @bridged = false
+
+  @url_of_cdn = 'https://cdn.subut.ai:8338/kurjun/rest'
+
+  def self.write?
+    raise 'SubutaiConfig.cmd not set' if @cmd.nil?
+    @cmd == 'up'
+  end
+
+  def self.delete?
+    raise 'SubutaiConfig.cmd not set' if @cmd.nil?
+    @cmd == 'destroy'
+  end
+
+  def self.read?
+    raise 'SubutaiConfig.cmd not set' if @cmd.nil?
+    @cmd != 'up'
+  end
+
+  def self.generated?(key)
+    GENERATED_PARAMETERS.include? key
+  end
+
+  def self.boolean?(key)
+    if get(key.to_sym) == 'true' || get(key.to_sym) == true
+      true
+    elsif get(key.to_sym) == 'false' || get(key.to_sym) == false
+      false
+    elsif get(key.to_sym).nil?
+      false
+    else
+      raise "#{key} value #{get(key.to_sym)} is not a boolean"
+    end
+  end
+
+  def self.provision_snap?
+    return false unless boolean?(:PROVISION)
+    return false if get(:_ALT_SNAP).nil?
+    return false if get(:_ALT_SNAP_MD5) == get(:_ALT_SNAP_MD5_LAST)
+    return false unless %w[up provision].include?(@cmd)
+    true
+  end
+
+  def self.snap_provisioned!
+    put(:_ALT_SNAP_MD5_LAST, get(:_ALT_SNAP_MD5), true) if provision_snap?
+  end
+
+  def self.bridged!
+    @bridged = true
+  end
+
+  def self.provision_management?
+    return false unless boolean?(:PROVISION)
+    return false if get(:_ALT_MANAGEMENT).nil?
+    return false if get(:_ALT_MANAGEMENT_MD5) == get(:_ALT_MANAGEMENT_MD5_LAST)
+    return false unless %w[up provision].include?(@cmd)
+    true
+  end
+
+  def self.management_provisioned!
+    put(:_ALT_MANAGEMENT_MD5_LAST, get(:_ALT_MANAGEMENT_MD5), true)\
+      if provision_management?
+  end
+
+  def self.cmd
+    @cmd
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.get_grow_by
+    disk = get(:SUBUTAI_DISK)
+    if disk.nil?
+      nil
+    else
+      disk = disk.to_i
+      generated_disk = get(:_SUBUTAI_DISK)
+      grow_by = 0
+
+      if generated_disk.nil?
+        grow_by = disk - 100 # default Subutai disk is 100 gigabytes
+      else
+        grow_by = disk - (generated_disk.to_i + 100) # HERE Applied math BEDMAS rule
+      end
+      grow_by
+    end
+  end
+
+  def self.url_of_cdn
+    @url_of_cdn
+  end
+  def self.override_conf_file(filepath)
+    @conf_file_override = filepath
+  end
+
+  def self.conf_file
+    return CONF_FILE if @conf_file_override.nil?
+    @conf_file_override
+  end
+
+  def self.get(key)
+    key_sym = key.to_sym
+
+    if key_sym == :SUBUTAI_ENV
+      env = @config[key_sym].to_sym
+      raise "#{env} invalid SUBUTAI_ENV" \
+        unless SUBUTAI_ENVIRONMENTS.include?(env)
+    end
+
+    @config[key_sym]
+  end
+
+  # Write through to save configuration values
+  def self.put(key, value, do_store)
+    raise "Undefined configuration parameter: #{key}" \
+      unless USER_PARAMETERS.include?(key.to_sym)     \
+      || GENERATED_PARAMETERS.include?(key.to_sym)
+    @config.store(key.to_sym, value)
+    @generated.store(key.to_sym, value) if generated? key
+
+    store if do_store
+    value
+  end
+
+  # Load generated values preserved across vagrant commands
+  def self.load_generated
+    return false unless File.exist?(GENERATED_FILE)
+    temp = YAML.load_file(GENERATED_FILE)
+    temp.each do |key, value|
+      @generated.store(key.to_sym, value)
+      @config.store(key.to_sym, value)
+    end
+  end
+
+  # Stores ONLY generated configuration from YAML files
+  def self.store
+    FileUtils.mkdir_p(PARENT_DIR) unless Dir.exist?(PARENT_DIR)
+    stringified = Hash[@generated.map { |k, v| [k.to_s, v.to_s] }]
+    File.open(GENERATED_FILE, 'w') { |f| f.write stringified.to_yaml }
+
+    stringified = Hash.new
+    @config.map do |k, v|
+      unless generated?(k)
+        if !k.nil? && !v.nil?
+          stringified.store(k.to_s, v.to_s)
+        end
+      end
+    end
+    File.open(CONF_FILE, 'w') { |f| f.write stringified.to_yaml }
+    true
+  end
+
+  def self.set_env(key, value)
+    raise "Invalid #{key} value of #{value}: use prod, master, or dev" \
+          unless SUBUTAI_ENVIRONMENTS.include?(value)
+    @config.store(key, value)
+  end
+
+  def self.load_config_file(config_file)
+    temp = YAML.load_file(config_file)
+    temp.each_key do |key|
+      raise "Invalid key in YAML file: '#{key}'" \
+          unless USER_PARAMETERS.include?(key.to_sym)
+
+      if key.to_sym == :SUBUTAI_ENV
+        set_env(key.to_sym, temp[key].to_sym)
+      elsif !temp[key].nil?
+        @config.store(key.to_sym, temp[key])
+      end
+    end
+  end
+
+  def self.do_handlers
+    return false unless %w[up provision].include? @cmd
+    file = snap_handler(get(:SUBUTAI_SNAP))
+    unless file.nil?
+      put(:_ALT_SNAP, file, true) if provision_snap?
+      put(:_ALT_SNAP_MD5, Digest::MD5.file(file).to_s, true) if provision_snap?
+    end
+
+    file = management_handler(get(:SUBUTAI_MAN_TMPL))
+    unless file.nil?
+      put(:_ALT_MANAGEMENT, file, true) if provision_management?
+      put(:_ALT_MANAGEMENT_MD5, Digest::MD5.file(file).to_s, true) \
+        if provision_management?
+    end
+    true
+  end
+
+  # NOTE: Console port ONLY needed in nat mode
+  # NOTE: SSH port only needed in bridged mode
+  def self.do_network(provider)
+    # set the next available console port if provisioning a peer in nat mode
+    put(:_CONSOLE_PORT, find_port(get(:DESIRED_CONSOLE_PORT)), true) \
+      if boolean?(:SUBUTAI_PEER) && get(:_CONSOLE_PORT).nil? && write?
+
+    # set the SSH port if we are using bridged mode
+    put(:_SSH_PORT, find_port(get(:DESIRED_SSH_PORT)), true) \
+      if @bridged && get(:_SSH_PORT).nil? && write?
+
+    put(:_BASE_MAC, find_mac(provider), true) \
+      if @bridged && get(:_BASE_MAC).nil? && write?
+
+    put(:_BRIDGED, @bridged, true) if write?
+  end
+
+  # Loads the generated and user configuration from YAML files
+  def self.load_config(cmd, provider)
+    raise 'SubutaiConfig.cmd not set' if cmd.nil?
+    @cmd = cmd
+
+    # Load YAML based user and local configuration if they exist
+    load_config_file(USER_CONF_FILE) if File.exist?(USER_CONF_FILE)
+    load_config_file(CONF_FILE) if File.exist?(CONF_FILE)
+    load_generated
+
+    # Load overrides from the environment, and generated configurations
+    ENV.each do |key, value|
+      put(key.to_sym, value, false) if USER_PARAMETERS.include? key.to_sym
+    end
+    do_handlers
+    do_network(provider)
+  end
+
+  def self.reset
+    @cmd = nil
+    @config = @defaults.clone
+    @generated = {}
+    @conf_file_override = nil
+  end
+
+  # Destroys the generated file if vagrant destroy is used
+  def self.cleanup
+    cleanup! if delete?
+  end
+
+  def self.cleanup!
+    reset
+    File.delete GENERATED_FILE if File.exist?(GENERATED_FILE)
+  end
+
+  def self.logging!(mode)
+    return (@logging = nil) if mode.nil?
+    raise "Invalid logging mode #{mode}" unless LOG_MODES.include?(mode)
+    @logging = mode
+    puts "Logging mode set to #{mode}"
+  end
+
+  def self.log(cmds, message)
+    return if @logging.nil?
+    puts message if !cmds.nil? && cmds.include?(@cmd)
+  end
+
+  def self.log_mode(modes, cmds, message)
+    return if @logging.nil?
+    puts message if cmds.include?(@cmd) && modes.include?(@logging)
+  end
+
+  def self.print
+    return if @logging.nil?
+    puts
+    puts ' ==> User provided configuration: '
+    puts ' --------------------------------------------------------------------'
+
+    @config.each do |key, value|
+      puts "#{('       ' + key.to_s).ljust(29)} => #{value}" \
+        unless generated? key
+    end
+
+    puts
+    puts ' ==> Generated settings preserved across command runs:'
+    puts ' --------------------------------------------------------------------'
+
+    @config.each do |key, value|
+      puts "#{('     + ' + key.to_s).ljust(29)} => #{value}" if generated? key
+    end
+  end
+
+  def self.get_latest_id_artifact(owner, artifact_name)
+    url = url_of_cdn + '/raw/info?owner=' + owner + '&name=' + artifact_name
+    uri = URI(url)
+    response = Net::HTTP.get(uri)
+    result = JSON.parse(response)
+    result[0]['id']
+  end
+end
+
+at_exit do
+  SubutaiConfig.cleanup unless SubutaiConfig.cmd.nil?
+end