Class: Sfn::Planner

Inherits:
Object
  • Object
show all
Defined in:
lib/sfn/planner.rb,
lib/sfn/planner/aws.rb

Overview

Interface for generating plan report

Direct Known Subclasses

Aws

Defined Under Namespace

Classes: Aws

Constant Summary collapse

RUNTIME_MODIFIED =

Value to flag runtime modification

"__MODIFIED_REFERENCE_VALUE__"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ui, config, arguments, stack, opts = {}) ⇒ self

Create a new planner instance

Parameters:

  • ui (Bogo::Ui)
  • config (Smash)
  • arguments (Array<String>)
  • stack (Miasma::Models::Orchestration::Stack)
  • opts (Hash) (defaults to: {}) 


31
32
33
34
35
36
37
 
# File 'lib/sfn/planner.rb', line 31

def initialize(ui, config, arguments, stack, opts = {})
  @ui = ui
  @config = config
  @arguments = arguments
  @origin_stack = stack
  @options = opts
end

Instance Attribute Details

#arguments ⇒ Array<String> (readonly)

Returns CLI arguments.

Returns:

  • (Array<String>) —

    CLI arguments



16
17
18
 
# File 'lib/sfn/planner.rb', line 16

def arguments
  @arguments
end

#config ⇒ Smash (readonly)

Returns:

  • (Smash) 


14
15
16
 
# File 'lib/sfn/planner.rb', line 14

def config
  @config
end

#options ⇒ Hash (readonly)

Returns custom options.

Returns:

  • (Hash) —

    custom options



20
21
22
 
# File 'lib/sfn/planner.rb', line 20

def options
  @options
end

#origin_stack ⇒ Miasma::Models::Orchestration::Stack (readonly)

Returns existing remote stack.

Returns:

  • (Miasma::Models::Orchestration::Stack) —

    existing remote stack



18
19
20
 
# File 'lib/sfn/planner.rb', line 18

def origin_stack
  @origin_stack
end

#ui ⇒ Bogo::Ui (readonly)

Returns:

  • (Bogo::Ui) 


12
13
14
 
# File 'lib/sfn/planner.rb', line 12

def ui
  @ui
end

Instance Method Details

#generate_plan(template, parameters) ⇒ Miasma::Models::Orchestration::Stack::Plan

Generate update report

Parameters:

  • template (Hash) —

    updated template

  • parameters (Hash) —

    runtime parameters for update

Returns:

  • (Miasma::Models::Orchestration::Stack::Plan) —

    report

Raises:

  • (NotImplementedError) 


45
46
47
 
# File 'lib/sfn/planner.rb', line 45

def generate_plan(template, parameters)
  raise NotImplementedError
end