Class: Miasma::Models::Orchestration

Inherits:
Types::Api show all
Defined in:
lib/miasma/models/orchestration.rb,
lib/miasma/models/orchestration/event.rb,
lib/miasma/models/orchestration/stack.rb,
lib/miasma/models/orchestration/events.rb,
lib/miasma/models/orchestration/stacks.rb,
lib/miasma/models/orchestration/resource.rb,
lib/miasma/models/orchestration/resources.rb

Overview

Abstract orchestration API

Defined Under Namespace

Classes: Stack, Stacks

Constant Summary collapse

RESOURCE_MAPPING =

Returns mapping of remote type to internal type.

Returns:

  • (Smash) —

    mapping of remote type to internal type

Smash.new
VALID_RESOURCE_STATES =

Returns valid resource states.

Returns:

  • (Array<Symbol>) —

    valid resource states

[
  :create_complete, :create_in_progress, :create_failed,
  :delete_complete, :delete_in_progress, :delete_failed,
  :rollback_complete, :rollback_in_progress, :rollback_failed,
  :update_complete, :update_in_progress, :update_failed,
  :update_rollback_complete, :update_rollback_in_progress,
  :update_rollback_failed, :unknown
]

Constants inherited from Types::Api

Types::Api::MAX_REQUEST_RETRIES, Types::Api::REQUEST_RETRY_DELAY, Types::Api::VALID_REQUEST_RETRY_METHODS

Instance Method Summary collapse

Methods inherited from Types::Api

#api_for, #connect, #connection, #custom_setup, #endpoint, #format_response, #from_json, #from_xml, #initialize, #make_request, #provider, #request, #retryable_request

Methods included from Utils::Memoization

#_memo, #clear_memoizations!, #memoize, #unmemoize

Methods included from Utils::Lazy

included

Constructor Details

This class inherits a constructor from Miasma::Types::Api

Instance Method Details

#event_all(stack) ⇒ Array<Models::Orchestration::Stack::Event>

Return all events for stack

Parameters:

Returns:

Raises:

  • (NotImplementedError) 


107
108
109
 
# File 'lib/miasma/models/orchestration.rb', line 107

def event_all(stack)
  raise NotImplementedError
end

#event_all_new(events) ⇒ Array<Models::Orchestration::Stack::Event>

Return all new events for event collection

Parameters:

Returns:

Raises:

  • (NotImplementedError) 


115
116
117
 
# File 'lib/miasma/models/orchestration.rb', line 115

def event_all_new(events)
  raise NotImplementedError
end

#event_reload(event) ⇒ Models::Orchestration::Event

Reload the stack event data from the API

Parameters:

Returns:

  • (Models::Orchestration::Event)

Raises:

  • (NotImplementedError) 


123
124
125
 
# File 'lib/miasma/models/orchestration.rb', line 123

def event_reload(event)
  raise NotImplementedError
end

#resource_all(stack) ⇒ Array<Models::Orchestration::Stack::Resource>

Return all resources for stack

Parameters:

Returns:

Raises:

  • (NotImplementedError) 


91
92
93
 
# File 'lib/miasma/models/orchestration.rb', line 91

def resource_all(stack)
  raise NotImplementedError
end

#resource_reload(resource) ⇒ Models::Orchestration::Resource

Reload the stack resource data from the API

Parameters:

Returns:

  • (Models::Orchestration::Resource)

Raises:

  • (NotImplementedError) 


99
100
101
 
# File 'lib/miasma/models/orchestration.rb', line 99

def resource_reload(resource)
  raise NotImplementedError
end

#stack_all(options = {}) ⇒ Array<Models::Orchestration::Stack>

Return all stacks

Parameters:

  • options (Hash) (defaults to: {}) —

    filter

Returns:

Raises:

  • (NotImplementedError) 


67
68
69
 
# File 'lib/miasma/models/orchestration.rb', line 67

def stack_all(options={})
  raise NotImplementedError
end

#stack_destroy(stack) ⇒ TrueClass, FalseClass

Delete the stack

Parameters:

Returns:

  • (TrueClass, FalseClass)

Raises:

  • (NotImplementedError) 


59
60
61
 
# File 'lib/miasma/models/orchestration.rb', line 59

def stack_destroy(stack)
  raise NotImplementedError
end

#stack_reload(stack) ⇒ Models::Orchestration::Stack

Reload the stack data from the API

Parameters:

Returns:

Raises:

  • (NotImplementedError) 


51
52
53
 
# File 'lib/miasma/models/orchestration.rb', line 51

def stack_reload(stack)
  raise NotImplementedError
end

#stack_save(stack) ⇒ Models::Orchestration::Stack

Save the stack

Parameters:

Returns:

Raises:

  • (NotImplementedError) 


43
44
45
 
# File 'lib/miasma/models/orchestration.rb', line 43

def stack_save(stack)
  raise NotImplementedError
end

#stack_template_load(stack) ⇒ Smash

Fetch stack template

Parameters:

Returns:

  • (Smash) —

    stack template

Raises:

  • (NotImplementedError) 


75
76
77
 
# File 'lib/miasma/models/orchestration.rb', line 75

def stack_template_load(stack)
  raise NotImplementedError
end

#stack_template_validate(stack) ⇒ NilClass, String

Validate stack template

Parameters:

Returns:

  • (NilClass, String) —

    nil if valid, string error message if invalid

Raises:

  • (NotImplementedError) 


83
84
85
 
# File 'lib/miasma/models/orchestration.rb', line 83

def stack_template_validate(stack)
  raise NotImplementedError
end

#stacks(args = {}) ⇒ Types::Collection<Models::Orchestration::Stack>

Orchestration stacks

Parameters:

  • filter (Hash) —

    filtering options

Returns:



33
34
35
36
37
 
# File 'lib/miasma/models/orchestration.rb', line 33

def stacks(args={})
  memoize(:stacks) do
    Stacks.new(self)
  end
end