Most of them are outdated , but provide historical design context.
They are not user documentation and should not be treated as such.
Documentation is available here.
Detailed External Tasks
Adding External Jobs/Steps Support
Enable plug-in to inject tasks (Jobs) to the engine application using the REST API, change their statuses and track them from the UI. A task (Job) may have other nesting sub-tasks (Steps) under it.
Feature owner: Eli Mesika (emesika)
GUI Component owner: Eli Mesika (emesika)
REST Component owner: Eli Mesika (emesika)
Engine Component owner: Eli Mesika (emesika)
QA Owner: Yaniv Kaul (ykaul)
- Target Release: 3.3
- Status: Design
- Last updated date: APR 15 2013
Enable plug-in to inject tasks (Jobs) to the engine application using the REST API, change their statuses and track them from the UI. A task (Job) may have other nesting sub-tasks (Steps) under it. A Job is actually a container of nexted steps. each Step may have sub-steps under it. A steps represents one of the following: An external command that is invoked and monitored by the plug-in
A supported internal command that is invoked by the plug-in and monitored internally by the oVirt engine.
Each Job may have unlimited list of external/internal steps.
The following should be supported:
Adding a job Adding a step to a job or to a step (as sub-step) Ending a step Eding a job Displaying all Jobs Displaying a specific Job Displaying all Steps under a specific Job Dislaying a specific Step under a Job
Job can be in one of the following statuses:
STARTED - Job was started FINISHED - Job has been finished successfully FAILED - Job had failed ABORTED - Job was aborted UNKNOWN - Job is in unnknown state
Step can be in one of theabove statuses as in Job. In addition Step supports the following Step Types :
VALIDATING - Step is validating the requested operation EXECUTING - Step is executing the requested operation FINALIZING - Steps is finalysing the requested operation
Adding a flag named is_external to both Job and Step tables This flag indicates that the Job/Step was invoked as part of a plug-in operation and may be used in future to filter such jobs/steps
Adding isExternal flag to both JobDAODBFacadeImpl and StepDAODBFacadeImpl and wrap it with getter/setter
Adding is_external to Job and Step metadata in fixtures.xml
Adding the following to VdcActionParametersBase
jobId - The Job UUID stepId - The parent step UUID
This will be used by plug-ins in order to invoke internal oVirt commands and still let them appaer under the given Job/Step in the task Monitor In case that such a command is invoked not in the context of an external Job, its jobId and stepId will be null The ExecutionHandler::getJob is modified to test if the jobId and stepId are null and according to the result generate a new job or use the given one.
New Supported Commands
AddExternalJob - Adds an external Job and returns its UUID EndExternalJob - Ends the given Job AddExternalStep - Adds an external step to a Job directly or under an existing Step ` If command is an oVirt internal command, it cpould be added only if it is flagged as `**`Monitored`** EndExternalStep - Ends the given Step (For steps that represents plug-in operations only)
Add Job/Step Flow: use api/jobs to add a new job using POST and giving a job description as a parameter
use api/jobs/`<jobId>`/steps to add a new step using POST and giving a step `**`parentId`**` , `**`parentType`**`, `**`description`**` and `**`status`**` as parameters (The parentId is the UUID of the parent of the new created step, the parentType may be `**`Job`**` or `**`Step`**`)
''List Job(s)/Step(s): use api/jobs to list all jobs
End Job/Step Flow:
use api/jobs/`<jobId>`/steps/`<stepId>` /end to end a step using POST and giving a `**`stepId`**` `**`stepType`**` `**`status`**` and an optional `**`force`**` flag
A new permission to access those commands will be added by default only to superuser role. A new role that can inject External Tasks will be added and may be attached/added to any user in the system
Permissions on Entity Instances
Since each Job may have steps that invoke internal oVirt command or external plug-in comamnds, on internal oVirt command we have already permissions on entities and on external commands it is in teh plug-in scope. So, nothing have to be specifically written in oVirt to support that.
- Add the list of monitored commands to api/capabilities
- Add support for job_id and step_id parameters in QueryHelper such that commands can pass job_id and step_id in the URI
- Add Job business entity
- Add Step business entity
- Adding JobMapper to map backend to REST entities and vice versa
- Adding StepMapper to map backend to REST entities and vice versa
- Add JobsResource/BackendJobsResource implementation to handle add() & get operations
- Add StepsResource/BackendStepsResource implementation to handle add() & get operations
- Add JobResource/BackendJobResource implementation to handle actions on a specific resource
- Add StepResource/BackendStepResource implementation to handle actions on a specific resource
- Add signatures to meta-data file (rsdl_metadata_v-3.1.yaml)
- Add tests
Note that no update is required.
Add support for the following:
/api/jobs `/api/jobs/`<job_id> /api/jobs/`<job_id>`/steps `/api/jobs/`<job_id>`/steps/`<step_id>