From 528020fec7b4e109cb16aafa2878ed5f9007876e Mon Sep 17 00:00:00 2001 From: "kirby@puppetlabs.com" Date: Mon, 9 Jul 2018 14:29:35 -0700 Subject: [PATCH] (POOLER-109) Allow API to run independently This commit updates vmpooler to allow the API component and dashboard to run separately from pool_manager. Without this change vmpooler does not offer a mechanism to run only the API, or pool_manager components. Two instances of hardcoded puma environment settings are removed. This is still set in the init script explicitly as well as via an environment variable in the dockerfile. To extend the mechanism of running the API or pool_manager components to instances running in docker an entrypoint is added in the dockerfile. The entrypoint allows a user to specify whether to run the API or pool_manager components when running the application. The default behavior is preserved where both components are run. To support these changes vmpooler.rb is updated to allow more of the configuration to be specified via individual environment variables. It was already possible to specify the entire config block as an environment variable, but this is more difficult to manage and less of a standard implementation than specifying individual parameters. Where specified environment variable options will override a value configured via the configuration file or environment. The running pool configuration when starting pool_manager is loaded to redis at pool_manager start time. This allows the API to load the running pool configuration from redis and be able to run without requiring the pool configuration. Lastly, the dockerfile leveraging entrypoint will no longer start vmpooler with the init script or write logs to a file. Instead, LOGFILE is set to /dev/stdout and the vmpooler application is started directly. This behavior is preferred because the log file writes to disk are an unnecessary overhead. Without this change the docker installation will attempt to daemonize the vmpooler application and always requires puma. --- Dockerfile => docker/Dockerfile | 18 ++++--- Dockerfile-aio => docker/Dockerfile-aio | 0 docker/docker-entrypoint.sh | 6 +++ lib/vmpooler.rb | 66 ++++++++++++++++++++++--- lib/vmpooler/api.rb | 5 +- lib/vmpooler/dashboard.rb | 7 ++- lib/vmpooler/pool_manager.rb | 28 +++++++++++ spec/integration/dashboard_spec.rb | 5 +- vmpooler | 46 ++++++++++++----- 9 files changed, 144 insertions(+), 37 deletions(-) rename Dockerfile => docker/Dockerfile (59%) rename Dockerfile-aio => docker/Dockerfile-aio (100%) create mode 100644 docker/docker-entrypoint.sh diff --git a/Dockerfile b/docker/Dockerfile similarity index 59% rename from Dockerfile rename to docker/Dockerfile index 44998af..2c31894 100644 --- a/Dockerfile +++ b/docker/Dockerfile @@ -15,14 +15,16 @@ RUN mkdir -p /var/lib/vmpooler WORKDIR /var/lib/vmpooler ADD Gemfile* /var/lib/vmpooler/ -RUN bundle install --system - -RUN ln -s /opt/jruby/bin/jruby /usr/bin/jruby COPY . /var/lib/vmpooler +COPY ./docker/docker-entrypoint.sh /usr/local/bin/ -ENV VMPOOLER_LOG /var/log/vmpooler.log -CMD \ - /var/lib/vmpooler/scripts/vmpooler_init.sh start \ - && while [ ! -f ${VMPOOLER_LOG} ]; do sleep 1; done ; \ - tail -f ${VMPOOLER_LOG} +ENV LOGFILE=/dev/stdout \ + RACK_ENV=production + +RUN bundle install --system ; \ + ln -s /opt/jruby/bin/jruby /usr/bin/jruby ; \ + chmod +x /usr/local/bin/docker-entrypoint.sh \ + /var/lib/vmpooler/vmpooler + +ENTRYPOINT ["docker-entrypoint.sh"] diff --git a/Dockerfile-aio b/docker/Dockerfile-aio similarity index 100% rename from Dockerfile-aio rename to docker/Dockerfile-aio diff --git a/docker/docker-entrypoint.sh b/docker/docker-entrypoint.sh new file mode 100644 index 0000000..9d21ac0 --- /dev/null +++ b/docker/docker-entrypoint.sh @@ -0,0 +1,6 @@ +#!/bin/sh +set -e + +set -- /var/lib/vmpooler/vmpooler "$@" + +exec "$@" diff --git a/lib/vmpooler.rb b/lib/vmpooler.rb index 73042d9..2caf169 100644 --- a/lib/vmpooler.rb +++ b/lib/vmpooler.rb @@ -50,17 +50,55 @@ module Vmpooler end # Set some configuration defaults - parsed_config[:redis] ||= {} - parsed_config[:redis]['server'] ||= 'localhost' - parsed_config[:redis]['data_ttl'] ||= 168 + parsed_config[:config]['task_limit'] = ENV['TASK_LIMIT'] || parsed_config[:config]['task_limit'] || 10 + parsed_config[:config]['migration_limit'] = ENV['MIGRATION_LIMIT'] if ENV['MIGRATION_LIMIT'] + parsed_config[:config]['vm_checktime'] = ENV['VM_CHECKTIME'] || parsed_config[:config]['vm_checktime'] || 15 + parsed_config[:config]['vm_lifetime'] = ENV['VM_LIFETIME'] || parsed_config[:config]['vm_lifetime'] || 24 + parsed_config[:config]['prefix'] = ENV['VM_PREFIX'] || parsed_config[:config]['prefix'] || '' - parsed_config[:config]['task_limit'] ||= 10 - parsed_config[:config]['vm_checktime'] ||= 15 - parsed_config[:config]['vm_lifetime'] ||= 24 - parsed_config[:config]['prefix'] ||= '' + parsed_config[:config]['logfile'] = ENV['LOGFILE'] if ENV['LOGFILE'] + + parsed_config[:config]['site_name'] = ENV['SITE_NAME'] if ENV['SITE_NAME'] + parsed_config[:config]['domain'] = ENV['DOMAIN_NAME'] if ENV['DOMAIN_NAME'] + parsed_config[:config]['clone_target'] = ENV['CLONE_TARGET'] if ENV['CLONE_TARGET'] + parsed_config[:config]['timeout'] = ENV['TIMEOUT'] if ENV['TIMEOUT'] + parsed_config[:config]['vm_lifetime_auth'] = ENV['VM_LIFETIME_AUTH'] if ENV['VM_LIFETIME_AUTH'] + parsed_config[:config]['ssh_key'] = ENV['SSH_KEY'] if ENV['SSH_KEY'] + parsed_config[:config]['max_tries'] = ENV['MAX_TRIES'] if ENV['MAX_TRIES'] + parsed_config[:config]['retry_factor'] = ENV['RETRY_FACTOR'] if ENV['RETRY_FACTOR'] + parsed_config[:config]['create_folders'] = ENV['CREATE_FOLDERS'] if ENV['CREATE_FOLDERS'] + parsed_config[:config]['create_template_delta_disks'] = ENV['CREATE_TEMPLATE_DELTA_DISKS'] if ENV['CREATE_TEMPLATE_DELTA_DISKS'] + parsed_config[:config]['experimental_features'] = ENV['EXPERIMENTAL_FEATURES'] if ENV['EXPERIMENTAL_FEATURES'] + + parsed_config[:redis] = parsed_config[:redis] || {} if ENV['REDIS_SERVER'] + parsed_config[:redis]['server'] = ENV['REDIS_SERVER'] || parsed_config[:redis]['server'] || 'localhost' + parsed_config[:redis]['port'] = ENV['REDIS_PORT'] if ENV['REDIS_PORT'] + parsed_config[:redis]['password'] = ENV['REDIS_PASSWORD'] if ENV['REDIS_PASSWORD'] + parsed_config[:redis]['data_ttl'] = ENV['REDIS_DATA_TTL'] || parsed_config[:redis]['data_ttl'] || 168 + + parsed_config[:statsd] = parsed_config[:statsd] || {} if ENV['STATSD_SERVER'] + parsed_config[:statsd]['server'] = ENV['STATSD_SERVER'] if ENV['STATSD_SERVER'] + parsed_config[:statsd]['prefix'] = ENV['STATSD_PREFIX'] if ENV['STATSD_PREFIX'] + parsed_config[:statsd]['port'] = ENV['STATSD_PORT'] if ENV['STATSD_PORT'] + + parsed_config[:graphite] = parsed_config[:graphite] || {} if ENV['GRAPHITE_SERVER'] + parsed_config[:graphite]['server'] = ENV['GRAPHITE_SERVER'] if ENV['GRAPHITE_SERVER'] + + parsed_config[:auth] = parsed_config[:auth] || {} if ENV['AUTH_PROVIDER'] + parsed_config[:auth]['provider'] = ENV['AUTH_PROVIDER'] if ENV['AUTH_PROVIDER'] + parsed_config[:auth][:ldap] = parsed_config[:auth][:ldap] || {} if parsed_config[:auth]['provider'] == 'ldap' + parsed_config[:auth][:ldap]['server'] = ENV['LDAP_SERVER'] if ENV['LDAP_SERVER'] + parsed_config[:auth][:ldap]['port'] = ENV['LDAP_PORT'] if ENV['LDAP_PORT'] + parsed_config[:auth][:ldap]['base'] = ENV['LDAP_BASE'] if ENV['LDAP_BASE'] + parsed_config[:auth][:ldap]['user_object'] = ENV['LDAP_USER_OBJECT'] if ENV['LDAP_USER_OBJECT'] # Create an index of pool aliases parsed_config[:pool_names] = Set.new + unless parsed_config[:pools] + redis = new_redis(parsed_config[:redis]['server'], parsed_config[:redis]['port'], parsed_config[:redis]['password']) + parsed_config[:pools] = load_pools_from_redis(redis) + end + parsed_config[:pools].each do |pool| parsed_config[:pool_names] << pool['name'] if pool['alias'] @@ -84,9 +122,23 @@ module Vmpooler end parsed_config[:uptime] = Time.now + parsed_config end + def self.load_pools_from_redis(redis) + pools = [] + redis.smembers('vmpooler__pools').each do |pool| + pool_hash = {} + redis.hgetall("vmpooler__pool__#{pool}").each do |k, v| + pool_hash[k] = v + end + pool_hash['alias'] = pool_hash['alias'].split(',') + pools << pool_hash + end + pools + end + def self.new_redis(host = 'localhost', port = nil, password = nil) Redis.new(host: host, port: port, password: password) end diff --git a/lib/vmpooler/api.rb b/lib/vmpooler/api.rb index 25fa7f6..a9a9e83 100644 --- a/lib/vmpooler/api.rb +++ b/lib/vmpooler/api.rb @@ -4,8 +4,6 @@ module Vmpooler super end - set :environment, :production - not_found do content_type :json @@ -42,11 +40,10 @@ module Vmpooler use Vmpooler::API::Reroute use Vmpooler::API::V1 - def configure(config, redis, metrics, environment = :production) + def configure(config, redis, metrics) self.settings.set :config, config self.settings.set :redis, redis self.settings.set :metrics, metrics - self.settings.set :environment, environment end def execute! diff --git a/lib/vmpooler/dashboard.rb b/lib/vmpooler/dashboard.rb index 56259d6..046a1d9 100644 --- a/lib/vmpooler/dashboard.rb +++ b/lib/vmpooler/dashboard.rb @@ -1,8 +1,13 @@ module Vmpooler class Dashboard < Sinatra::Base + + def config + Vmpooler.config + end + get '/dashboard/?' do erb :dashboard, locals: { - site_name: $config[:config]['site_name'] || 'vmpooler' + site_name: config[:config]['site_name'] || 'vmpooler' } end end diff --git a/lib/vmpooler/pool_manager.rb b/lib/vmpooler/pool_manager.rb index 15e2dfb..46dd204 100644 --- a/lib/vmpooler/pool_manager.rb +++ b/lib/vmpooler/pool_manager.rb @@ -32,6 +32,31 @@ module Vmpooler $config end + # Place pool configuration in redis so an API instance can discover running pool configuration + def load_pools_to_redis + previously_configured_pools = $redis.smembers('vmpooler__pools') + currently_configured_pools = [] + config[:pools].each do |pool| + currently_configured_pools << pool['name'] + $redis.sadd('vmpooler__pools', pool['name']) + pool_keys = pool.keys + pool_keys.delete('alias') + to_set = {} + pool_keys.each do |k| + to_set[k] = pool[k] + end + to_set['alias'] = pool['alias'].join(',') if to_set.has_key?('alias') + $redis.hmset("vmpooler__pool__#{pool['name']}", to_set.to_a.flatten) unless to_set.empty? + end + previously_configured_pools.each do |pool| + unless currently_configured_pools.include? pool + $redis.srem('vmpooler__pools', pool) + $redis.del("vmpooler__pool__#{pool}") + end + end + return + end + # Check the state of a VM def check_pending_vm(vm, pool, timeout, provider) Thread.new do @@ -924,6 +949,9 @@ module Vmpooler end end + # Load running pool configuration into redis so API server can retrieve it + load_pools_to_redis + # Get pool loop settings $config[:config] = {} if $config[:config].nil? check_loop_delay_min = $config[:config]['check_loop_delay_min'] || CHECK_LOOP_DELAY_MIN_DEFAULT diff --git a/spec/integration/dashboard_spec.rb b/spec/integration/dashboard_spec.rb index 06d2a86..1616907 100644 --- a/spec/integration/dashboard_spec.rb +++ b/spec/integration/dashboard_spec.rb @@ -22,12 +22,9 @@ describe Vmpooler::API do end context '/dashboard/' do - let(:config) { { - config: {'site_name' => 'test pooler'} - } } + ENV['SITE_NAME'] = 'test pooler' before do - $config = config get '/dashboard/' end diff --git a/vmpooler b/vmpooler index 57478f9..eec75c0 100755 --- a/vmpooler +++ b/vmpooler @@ -10,29 +10,49 @@ redis_host = config[:redis]['server'] redis_port = config[:redis]['port'] redis_password = config[:redis]['password'] logger_file = config[:config]['logfile'] +api_logger_file = config[:config]['api_logfile'] metrics = Vmpooler.new_metrics(config) -api = Thread.new do - thr = Vmpooler::API.new - thr.helpers.configure(config, Vmpooler.new_redis(redis_host, redis_port, redis_password), metrics) - thr.helpers.execute! +torun_threads = [] +if ARGV.count == 0 + torun = ['api', 'manager'] +else + torun = [] + torun << 'api' if ARGV.include? 'api' + torun << 'manager' if ARGV.include? 'manager' + exit(2) if torun.empty? end -manager = Thread.new do - Vmpooler::PoolManager.new( - config, - Vmpooler.new_logger(logger_file), - Vmpooler.new_redis(redis_host, redis_port, redis_password), - metrics - ).execute! +if torun.include? 'api' + api = Thread.new do + thr = Vmpooler::API.new + redis = Vmpooler.new_redis(redis_host, redis_port, redis_password) + thr.helpers.configure(config, redis, metrics) + thr.helpers.execute! + end + torun_threads << api +end + +if torun.include? 'manager' + manager = Thread.new do + Vmpooler::PoolManager.new( + config, + Vmpooler.new_logger(logger_file), + Vmpooler.new_redis(redis_host, redis_port, redis_password), + metrics + ).execute! + end + torun_threads << manager end if ENV['VMPOOLER_DEBUG'] trap('INT') do puts 'Shutting down.' - [api, manager].each(&:exit) + torun_threads.each(&:exit) end end -[api, manager].each(&:join) +torun_threads.each do |th| + th.join +end