Plugin tasks deployment order documentation need to be updated

Bug #1526088 reported by Alex Schultz
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Fuel for OpenStack
Confirmed
Medium
Evgeny Konstantinov

Bug Description

I was attempting to follow the documentation about plugin task ordering located at https://wiki.openstack.org/wiki/Fuel/Plugins#How_the_deployment_order_works_in_specific_cases

When I create a plugin that leverages the stage ordering as mentioned in the documentation I get an error indicating the tasks are not in the graph.

Error
Tasks 'post_deployment/8100, post_deployment/8200, post_deployment/8300' can't be in requires|required_for|groups|tasks for [fuel-plugin-etckeeper-commit, fuel-plugin-etckeeper-configuration, fuel-plugin-etckeeper-installation] because they don't exist in the graph

My deployment_tasks.yaml can be viewed at http://paste.openstack.org/show/gNj0kzuY3XQ0sMwftjmp/

Tags: area-docs
Revision history for this message
Alex Schultz (alex-schultz) wrote :
Ilya Kutukov (ikutukov)
Changed in fuel:
assignee: nobody → Fuel Documentation Team (fuel-docs)
tags: added: area-docs
tags: added: area-plugins area-python
Changed in fuel:
importance: Undecided → High
Revision history for this message
Ilya Kutukov (ikutukov) wrote :

Bug is declared as outdated documentation, but it will be better if fuel developer take a look first to determine that is not a technical problem with plugins.

Changed in fuel:
assignee: Fuel Documentation Team (fuel-docs) → Fuel Python Team (fuel-python)
status: New → Confirmed
summary: - fuel plugin documentation about deployment order appears out of date
+ Plugin tasks "don't exist in the graph" problem
Revision history for this message
Ihor Kalnytskyi (ikalnytskyi) wrote : Re: Plugin tasks "don't exist in the graph" problem

Alex,

The thing is that you're trying to mix old tasks (tasks.yaml) and new tasks (deployment_tasks.yaml). We never supported priority (e.g. 'post_deployment/8100') in deployment_tasks.yaml. It's something we had in tasks.yaml, before granular deployment in Fuel.

In deployment_tasks.yaml we have 'requires' and 'required_for' fields, which should be used for making ordering between tasks.

So the bug is Invalid, actually.

One more thing - tasks.yaml doesn't go through global deployment graph.. moreover, they don't have any deployment graph, they are executing one-by-one according to priority specified in stage.

Changed in fuel:
status: Confirmed → Invalid
Revision history for this message
Alex Schultz (alex-schultz) wrote :

Guys, this bug is valid as original described. The documentation needs to be updated to reflect how to leverage the functionality. If it is no longer supported in plugins > v1 then the documentation needs to say this. As a user who wants to write a plugin, the documentation is not clear enough on how to leverage this functionality. A plugin user should not have to be a fuel developer and go digging in code to write a plugin or leverage functionality from the documentation. I would argue that the documentation is deficient around how to use each yaml file for the different plugin versions. Please update the documentation around the tasks.yaml and deployment_tasks.yaml to make it clear what is and is not supported between the versions.

Changed in fuel:
status: Invalid → Confirmed
Dmitry Pyzhov (dpyzhov)
Changed in fuel:
assignee: Fuel Python Team (fuel-python) → Fuel Documentation Team (fuel-docs)
tags: removed: area-python
tags: removed: area-plugins
summary: - Plugin tasks "don't exist in the graph" problem
+ Plugin tasks deployment order documentation need to be updated
Changed in fuel:
importance: High → Medium
assignee: Fuel Documentation Team (fuel-docs) → Evgeny Konstantinov (evkonstantinov)
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.