Module: Kontena::Cli::Stacks::Common

Includes:
Kontena::Cli::Services::ServicesHelper
Included in:
BuildCommand, InstallCommand, ListCommand, MonitorCommand, Registry::PullCommand, Registry::PushCommand, Registry::RemoveCommand, Registry::SearchCommand, Registry::ShowCommand, RemoveCommand, ShowCommand, UpgradeCommand, ValidateCommand, StacksCache::RegistryClientFactory
Defined in:
lib/kontena/cli/stacks/common.rb

Defined Under Namespace

Modules: StackFileOrNameParam, StackNameOption, StackNameParam, StackValuesFromOption, StackValuesToOption

Instance Method Summary collapse

Methods included from Kontena::Cli::Services::ServicesHelper

#create_service, #delete_service, #deploy_service, #get_service, #health_status, #health_status_icon, #int_to_filesize, #parse_build_args, #parse_container_name, #parse_deploy_opts, #parse_health_check, #parse_image, #parse_links, #parse_log_opts, #parse_memory, #parse_ports, #parse_relative_time, #parse_secrets, #parse_service_id, #render_service_deploy_instances, #restart_service, #scale_service, #show_service, #show_service_containers, #show_service_instances, #start_service, #stop_service, #update_service, #wait_for_deploy_to_finish

Methods included from Common

#access_token=, #add_master, #any_key_to_continue, #any_key_to_continue_with_timeout, #api_url, #api_url=, #api_url_version, #ask, #clear_current_grid, #client, #cloud_auth?, #cloud_client, #config, #confirm, #confirm_command, #current_account, #current_grid, #current_grid=, #current_master, #current_master=, #current_master_index, #display_account_login_info, #display_login_info, #display_logo, #display_master_login_info, #error, #exit_with_error, #kontena_account, #logger, #pastel, #print, #prompt, #puts, #require_api_url, #require_current_account, #require_current_grid, #require_current_master, #require_token, #reset_client, #reset_cloud_client, #running_silent?, #running_verbose?, #settings, #settings_filename, #spinner, #sprint, #sputs, #stdin_input, #use_refresh_token, #vfakespinner, #vputs, #vspinner, #warning, #yes?

Instance Method Details

#abort_on_validation_errors(errors) ⇒ Object 



149
150
151
152
153
 
# File 'lib/kontena/cli/stacks/common.rb', line 149

def abort_on_validation_errors(errors)
  $stderr.puts "YAML validation failed! Aborting.".colorize(:red)
  display_notifications(errors, :red)
  abort
end

#current_dir ⇒ String

Returns:



136
137
138
 
# File 'lib/kontena/cli/stacks/common.rb', line 136

def current_dir
  File.basename(Dir.getwd)
end

#display_notifications(messages, color = :yellow) ⇒ Object 



140
141
142
 
# File 'lib/kontena/cli/stacks/common.rb', line 140

def display_notifications(messages, color = :yellow)
  $stderr.puts(Kontena.pastel.send(color, messages.to_yaml.gsub(/^---$/, '')))
end

#generate_services(yaml_services) ⇒ Object 



122
123
124
125
126
127
128
 
# File 'lib/kontena/cli/stacks/common.rb', line 122

def generate_services(yaml_services)
  return [] unless yaml_services
  yaml_services.map do |name, config|
    exit_with_error("Image is missing for #{name}. Aborting.") unless config['image'] # why isn't this a validation?
    ServiceGeneratorV2.new(config).generate.merge('name' => name)
  end
end

#generate_volumes(yaml_volumes) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/kontena/cli/stacks/common.rb', line 110

def generate_volumes(yaml_volumes)
  return [] unless yaml_volumes
  yaml_volumes.map do |name, config|
    if config['external'].is_a?(TrueClass)
      config['external'] = name
    elsif config['external']['name']
      config['external'] = config['external']['name']
    end
    config.merge('name' => name)
  end
end

#hint_on_validation_notifications(errors) ⇒ Object 



144
145
146
147
 
# File 'lib/kontena/cli/stacks/common.rb', line 144

def hint_on_validation_notifications(errors)
  $stderr.puts "YAML contains the following unsupported options and they were rejected:".colorize(:yellow)
  display_notifications(errors)
end

#reader_from_yaml(filename, name: nil, values: nil, defaults: nil) ⇒ Object 



64
65
66
67
68
69
70
71
 
# File 'lib/kontena/cli/stacks/common.rb', line 64

def reader_from_yaml(filename, name: nil, values: nil, defaults: nil)
  reader = Kontena::Cli::Stacks::YAML::Reader.new(filename, values: values, defaults: defaults)
  if reader.stack_name.nil?
    exit_with_error "Stack MUST have stack name in YAML top level field 'stack'! Aborting."
  end
  set_env_variables(name || reader.stack_name, current_grid)
  reader
end

#require_config_file(filename) ⇒ Object 



106
107
108
 
# File 'lib/kontena/cli/stacks/common.rb', line 106

def require_config_file(filename)
  exit_with_error("File #{filename} does not exist") unless File.exists?(filename)
end

#set_env_variables(stack, grid) ⇒ Object 



130
131
132
133
 
# File 'lib/kontena/cli/stacks/common.rb', line 130

def set_env_variables(stack, grid)
  ENV['STACK'] = stack
  ENV['GRID'] = grid
end

#stack_from_reader(reader) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/kontena/cli/stacks/common.rb', line 73

def stack_from_reader(reader)
  outcome = reader.execute

  hint_on_validation_notifications(outcome[:notifications]) unless outcome[:notifications].empty?
  abort_on_validation_errors(outcome[:errors]) unless outcome[:errors].empty?
  kontena_services = generate_services(outcome[:services])
  kontena_volumes = generate_volumes(outcome[:volumes])
  stack = {
    'name' => outcome[:name],
    'stack' => outcome[:stack],
    'expose' => outcome[:expose],
    'version' => outcome[:version],
    'source' => reader.raw_content,
    'registry' => outcome[:registry],
    'services' => kontena_services,
    'volumes' => kontena_volumes,
    'variables' => outcome[:variables]
  }
  stack
end

#stack_from_yaml(filename, name: nil, values: nil, defaults: nil) ⇒ Object 



94
95
96
97
 
# File 'lib/kontena/cli/stacks/common.rb', line 94

def stack_from_yaml(filename, name: nil, values: nil, defaults: nil)
  reader = reader_from_yaml(filename, name: name, values: values, defaults: defaults)
  stack_from_reader(reader)
end

#stack_name ⇒ Object 



60
61
62
 
# File 'lib/kontena/cli/stacks/common.rb', line 60

def stack_name
  @stack_name ||= self.name || stack_name_from_yaml(filename)
end

#stack_read_and_dump(filename, name: nil, values: nil, defaults: nil) ⇒ Object 



99
100
101
102
103
104
 
# File 'lib/kontena/cli/stacks/common.rb', line 99

def stack_read_and_dump(filename, name: nil, values: nil, defaults: nil)
  reader = reader_from_yaml(filename, name: name, values: values, defaults: defaults)
  stack = stack_from_reader(reader)
  dump_variables(reader) if values_to
  stack
end

#stacks_client ⇒ Object 



155
156
157
158
159
160
 
# File 'lib/kontena/cli/stacks/common.rb', line 155

def stacks_client
  return @stacks_client if @stacks_client
  Kontena.run('cloud login') unless cloud_auth?
  config.reset_instance
  @stacks_client = Kontena::StacksClient.new(.stacks_url, .token)
end