Add new class ServiceContainerTemplate. #15429

lfu · 2017-06-22T15:53:54Z

Add new class ServiceContainerTemplate for container template provisioning.

Includes on ManageIQ/manageiq-providers-openshift#27.
Depends on #15475.

https://www.pivotaltracker.com/story/show/134027413

@miq-bot assign @gmcculloug
@miq-bot add_label enhancement, services, providers/containers

bzwei · 2017-06-22T21:47:36Z

app/models/service_container_template.rb

+    $log.log_hashes(opts)
+
+    params = process_parameters(opts[:parameters])
+    @created_objects = container_template.instantiate(params, opts[:container_project_name])


It is not safe to use an instance variable.

bzwei · 2017-06-23T22:09:50Z

@gmcculloug @lfu Evidently we need to remember created objects between steps in the state machine, and more importantly we are always requested to tell the user what objects are created in the provisioning.
There can be two approaches:

Directly add each object as a resource to the service.
Create a stack object and add each object as a resource to the stack. Add the stack as a resource to the service.

Approach No 2 is the way we handle Ansible provisioning. Although Ansible Tower job is a true object in provider, we never collect jobs through refresh. The job is directly created in VMDB. I see the similarity here.

gmcculloug · 2017-06-27T12:16:32Z

app/models/service_container_template.rb

+    # :dialog option should specify the project name, either an existing project or a new project name
+    dialog_options = options[:dialog]
+    existing = overrides.delete(:existing_project_name) || dialog_options['dialog_existing_project_name']
+    new = overrides.delete(:new_project_name) || dialog_options['dialog_new_project_name']


@lfu Avoid using keywords as variable names and would also expect this to be a more descriptive name. Suggest new_project_name

gmcculloug · 2017-06-27T12:17:40Z

app/models/service_container_template.rb

+  end
+
+  def stack(action)
+    service_resources.find_by(:name => action, :resource_type => 'OrchestrationStack').try(:resource)


@lfu @bzwei Are there going to be different stacks based on the action? I would expect there would only ever be one stack connected to service_resources.

right, we don't need to distinguish action. There is only one stack.

gmcculloug · 2017-06-27T12:20:42Z

@bzwei I am ok with the stack approach here, is there a container object this would normally be representing? What type of objects/data would you normally expect to represent as part of the stack?

gmcculloug · 2017-06-27T12:23:30Z

app/models/service_container_template.rb

+
+  def check_completed(action)
+    done = stack(action).provider_objects.all? { |obj| obj.resource_category.constantize.find_by(:name => obj.name) }
+    message = done ? "completed" : "not completed yet"


Do we have another message string we use besides "not completed yet"? I'm thinking "in progress" but we should be consistent here if possible.

There is no standard incomplete message. So I took "in progress".

bzwei · 2017-06-27T15:05:34Z

@lfu There are a few items missing from your implementation. I'll work with you offline.

lfu · 2017-06-27T15:14:58Z

@gmcculloug Container template may contain objects that would be created during the provisioning. An Orchestration stack is added into the service as an virtual layer to keep track of the created container objects. A list of these objects would be returned by container_template#instantiate as soon as the call is done. But these objects only appear in VMDB later after provider refresh.

Here is an example of the created container object.

{"apiVersion"=>"v1", "kind"=>"Route", "metadata"=>{"name"=>"dotnet-example"}, "spec"=>{"host"=>"", "to"=>{"kind"=>"Service", "name"=>"dotnet-example"}}}

gmcculloug · 2017-06-27T18:26:40Z

Another consideration around using stacks is retirement. The base model includes RetirementManagement but I do not think we have anything to do here. Does retirement need to be undefined for the subclassed model ManageIQ::Providers::ContainerManager::OrchestrationStack?

What would happen if retire_now was called on this instance?

bzwei · 2017-06-27T19:07:25Z

@gmcculloug Retirement should delete the objects in the provider and then the stack in VMDB

bzwei · 2017-06-28T13:19:07Z

app/models/service_container_template.rb

+  end
+
+  def stack
+    service_resources.find_by(:name => 'Provision', :resource_type => 'OrchestrationStack').try(:resource)


To be consistent do you want to use ResourceAction::PROVISION?

bzwei · 2017-06-28T13:27:10Z

app/models/service_container_template.rb

+    params
+  end
+
+  def get_job_options(action)


why job option? there is no concept of job in contain template provisioning.

bzwei · 2017-06-28T13:30:53Z

app/models/service_container_template.rb

+    "#{action.downcase}_job_options".to_sym
+  end
+
+  def parameters_from_dialog


consider to make a mix-in to be shared by a few similar service classes.

bzwei · 2017-06-28T15:12:45Z

app/models/service_container_template.rb

+  def check_completed(action)
+    return [true, 'not supported'] unless action == ResourceAction::PROVISION
+
+    done = stack.resources.all? do |obj|


move the logic to stack.raw_status method.

lfu · 2017-07-10T14:47:14Z

Travis test failure is due to the dependency on the changes in ManageIQ/manageiq-providers-openshift#27.

gmcculloug · 2017-07-12T12:36:09Z

@bzwei Can you give this one last review.

bzwei · 2017-07-12T15:28:13Z

app/models/manageiq/providers/container_manager/orchestration_stack.rb

+  private :add_provider_objects
+
+  def add_provider_object(object)
+    raise _("Provision with container template [#{container_template.name}] failed: #{object}") if object[:kind].blank?


can we not raise an error but mark the resource status failure, and stack status failure?

bzwei · 2017-07-12T15:30:36Z

app/models/manageiq/providers/container_manager/orchestration_stack.rb

+    raise MiqException::MiqOrchestrationProvisionError, err.to_s, err.backtrace
+  end
+
+  def self.status_class


any particular reason the status needs a subclass?

bzwei · 2017-07-12T19:01:33Z

app/models/manageiq/providers/container_manager/orchestration_stack.rb

+  belongs_to :container_template, :foreign_key => :orchestration_template_id, :class_name => "ContainerTemplate"
+
+  def self.create_stack(container_template, params, project_name)
+    new(:name                  => container_template.name,


I saw the other PR you created OrchestrationStack for OpenShift and its Status class. It then makes sense to revert your earlier code to use the Status subclass, but here you need to create the stack instance with the right class.

bzwei · 2017-07-12T19:04:17Z

app/models/manageiq/providers/container_manager/orchestration_stack.rb

+      miq_class.nil? || miq_obj
+    end
+
+    update_attributes(:status => 'succeeded') if done


need to update_attributes for the case in line 23.

bzwei · 2017-07-12T19:07:18Z

app/models/service_container_template.rb

+    $log.log_hashes(opts)
+
+    params = process_parameters(opts[:parameters])
+    new_stack = ManageIQ::Providers::Openshift::ContainerManager::OrchestrationStack.create_stack(container_template, params, opts[:container_project_name])


Derive the full OrchestrationStack class name from container manager.

https://www.pivotaltracker.com/story/show/134027413

…rovisioning. https://www.pivotaltracker.com/story/show/134027413

https://www.pivotaltracker.com/story/show/134027413

miq-bot · 2017-07-13T14:23:03Z

Checked commits lfu/manageiq@0ec3330~...b86af5a with ruby 2.2.6, rubocop 0.47.1, and haml-lint 0.20.0
5 files checked, 0 offenses detected
Everything looks fine. 🏆

lfu · 2017-07-13T14:47:50Z

@bzwei @gmcculloug Please review.

bzwei · 2017-07-13T18:31:21Z

Looks good.

miq-bot assigned gmcculloug Jun 22, 2017

miq-bot added enhancement providers/containers lifecycle/services labels Jun 22, 2017

bzwei reviewed Jun 22, 2017

View reviewed changes

lfu force-pushed the service_container_template branch from aec003d to 7b4dd4b Compare June 26, 2017 13:55

lfu mentioned this pull request Jun 26, 2017

Add OrchestrationStack for container template provisioning. ManageIQ/manageiq-providers-openshift#27

Merged

gmcculloug reviewed Jun 27, 2017

View reviewed changes

lfu force-pushed the service_container_template branch 2 times, most recently from 837e02b to 324abeb Compare June 27, 2017 14:58

lfu force-pushed the service_container_template branch from 324abeb to 51237c3 Compare June 27, 2017 23:24

bzwei reviewed Jun 28, 2017

View reviewed changes

lfu force-pushed the service_container_template branch from 51237c3 to 8d7902c Compare June 28, 2017 14:33

bzwei reviewed Jun 28, 2017

View reviewed changes

lfu force-pushed the service_container_template branch 4 times, most recently from 29be82b to 30d479e Compare July 5, 2017 19:04

lfu force-pushed the service_container_template branch from 30d479e to 990c224 Compare July 7, 2017 16:07

lfu force-pushed the service_container_template branch from 990c224 to a26e9f7 Compare July 11, 2017 21:18

lfu force-pushed the service_container_template branch from a26e9f7 to 9c87802 Compare July 12, 2017 14:21

bzwei reviewed Jul 12, 2017

View reviewed changes

lfu force-pushed the service_container_template branch from 9c87802 to ebc3a91 Compare July 12, 2017 18:50

bzwei reviewed Jul 12, 2017

View reviewed changes

Add new class ServiceContainerTemplate.

0ec3330

https://www.pivotaltracker.com/story/show/134027413

lfu force-pushed the service_container_template branch from ebc3a91 to e8669a5 Compare July 13, 2017 14:05

lfu added 2 commits July 13, 2017 10:17

Add OrchestrationStack to track the provider created objects during p…

a435352

…rovisioning. https://www.pivotaltracker.com/story/show/134027413

Add specs for ServiceContainerTemplate.

b86af5a

https://www.pivotaltracker.com/story/show/134027413

lfu force-pushed the service_container_template branch from e8669a5 to b86af5a Compare July 13, 2017 14:18

bzwei approved these changes Jul 13, 2017

View reviewed changes

gmcculloug merged commit a50d793 into ManageIQ:master Jul 13, 2017

gmcculloug added this to the Sprint 65 Ending Jul 24, 2017 milestone Jul 13, 2017

gmcculloug added the lifecycle/provisioning label Jul 13, 2017

lfu deleted the service_container_template branch October 16, 2017 20:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new class ServiceContainerTemplate. #15429

Add new class ServiceContainerTemplate. #15429

lfu commented Jun 22, 2017 •

edited

Loading

bzwei Jun 22, 2017

bzwei commented Jun 23, 2017 •

edited

Loading

gmcculloug Jun 27, 2017

gmcculloug Jun 27, 2017

bzwei Jun 27, 2017

gmcculloug commented Jun 27, 2017

gmcculloug Jun 27, 2017

lfu Jun 27, 2017

bzwei commented Jun 27, 2017

lfu commented Jun 27, 2017

gmcculloug commented Jun 27, 2017

bzwei commented Jun 27, 2017

bzwei Jun 28, 2017

bzwei Jun 28, 2017

bzwei Jun 28, 2017

bzwei Jun 28, 2017

lfu commented Jul 10, 2017

gmcculloug commented Jul 12, 2017

bzwei Jul 12, 2017

bzwei Jul 12, 2017

bzwei Jul 12, 2017

bzwei Jul 12, 2017

bzwei Jul 12, 2017

miq-bot commented Jul 13, 2017

lfu commented Jul 13, 2017

bzwei commented Jul 13, 2017

Add new class ServiceContainerTemplate. #15429

Add new class ServiceContainerTemplate. #15429

Conversation

lfu commented Jun 22, 2017 • edited Loading

Choose a reason for hiding this comment

bzwei commented Jun 23, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gmcculloug commented Jun 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bzwei commented Jun 27, 2017

lfu commented Jun 27, 2017

gmcculloug commented Jun 27, 2017

bzwei commented Jun 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lfu commented Jul 10, 2017

gmcculloug commented Jul 12, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

miq-bot commented Jul 13, 2017

lfu commented Jul 13, 2017

bzwei commented Jul 13, 2017

lfu commented Jun 22, 2017 •

edited

Loading

bzwei commented Jun 23, 2017 •

edited

Loading