Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 2059190

Summary: [MTV][DOC][HOOK] Readme is missing some info how to run hooks on migrating VMs
Product: Migration Toolkit for Virtualization Reporter: Igor Braginsky <ibragins>
Component: User ExperienceAssignee: Arik <ahadas>
Status: CLOSED MIGRATED QA Contact: Ilanit Stein <istein>
Severity: high Docs Contact: Richard Hoch <rhoch>
Priority: unspecified    
Version: 2.3.0CC: ahadas, asriram, istein, jortel
Target Milestone: ---   
Target Release: Future   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-01-02 14:44:45 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Igor Braginsky 2022-02-28 13:09:21 UTC 
Description of problem: Readme is missing some info how to use hooks, that may confuse people that will want to use this feature
Link to the readme: 
https://github.com/jmontleon/forklift-controller/blob/c26ed2cfb5f3b4d0cc495569ba1dce45d5e23675/docs/hooks.md

What is missing:

1. Doc is explaining how to create secret, but it not mentioned that playbook itself should use it, usual user could expect this secret to be used in some CR, not in a playbook itself

2. No explanation what exactly this hook is doing, it took me a while and serious effort to get that provided example should be used as pre-hook only and only with VMWare source provider

3. No mention that VM should be started and available by SSH for pre-hook to run on it. 

4. Will be great to add examples of pre-hook with RHV sourve provider and post-hook which can run on migrated VMs