class Sfn::Planner

Interface for generating plan report

Constants

RUNTIME_MODIFIED

Value to flag runtime modification

Attributes

arguments[R]

@return [Array<String>] CLI arguments

config[R]

@return [Smash]

options[R]

@return [Hash] custom options

origin_stack[R]

@return [Miasma::Models::Orchestration::Stack] existing remote stack

ui[R]

@return [Bogo::Ui]

Public Class Methods

new(ui, config, arguments, stack, opts = {}) click to toggle source

Create a new planner instance

@param ui [Bogo::Ui] @param config [Smash] @param arguments [Array<String>] @param stack [Miasma::Models::Orchestration::Stack] @param opts [Hash]

@return [self]

# 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

Public Instance Methods

generate_plan(template, parameters) click to toggle source

Generate update report

@param template [Hash] updated template @param parameters [Hash] runtime parameters for update

@return [Miasma::Models::Orchestration::Stack::Plan] report

# File lib/sfn/planner.rb, line 45
def generate_plan(template, parameters)
  raise NotImplementedError
end