MTV-1590 Improved hooks description #586

RichardHoch · 2024-11-17T16:14:53Z

MTV 2.8

Resolves https://issues.redhat.com/browse/MTV-1590 by revising section 6.4. of the MTV user guide, "https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/2.7/html-single/installing_and_using_the_migration_toolkit_for_virtualization/index#adding-hooks-migration-plan-using-api"

Preview: https://file.corp.redhat.com/rhoch/improved_hook_description/html-single/#adding-hooks-mtv-migration-plan

anarnold97 · 2024-12-18T18:35:03Z

documentation/modules/about-hooks-for-migration-plans.adoc

+.. Mounts the `configmap` to the container.
+
+The Ansible hook imports the Secret that the user previously entered.
+. The job runs a prehook or a posthook as follows:


Suggested change

. The job runs a prehook or a posthook as follows:

. The job runs a pre-migration hook or a post-migration hook as follows:

I would probably be explicit... as I do not like prehook and posthook (but this is your choice not mine)

anarnold97 · 2024-12-18T18:36:01Z

documentation/modules/about-hooks-for-migration-plans.adoc

+
+
+
+
+
+
+


You know what i am going to say :)

Suggested change

anarnold97 · 2024-12-18T18:37:06Z

documentation/modules/about-hooks-for-migration-plans.adoc

+.. Mounts the `configmap` to the container.
+
+The Ansible hook imports the Secret that the user previously entered.
+. The job runs a prehook or a posthook as follows:


OR... use the style you use later

Suggested change

. The job runs a prehook or a posthook as follows:

. The job runs a `PreHook` or a `PostHook` as follows:

anarnold97 · 2024-12-18T18:49:42Z

documentation/modules/adding-hook-using-cli.adoc

+----
+apiVersion: v1
+data:
+  key: VGhpcyB3YXMgZ2VuZXJhdGVkIHdpdGggc3NoLWtleWdlbiBwdXJlbHkgZm9yIHRoaXMgZXhhbXBsZS4KSXQgaXMgbm90IHVzZWQgYW55d2hlcmUuCi0tLS0tQkVHSU4gT1BFTlNTSCBQUklWQVRFIEtFWS0tLS0tCmIzQmxibk56YUMxclpYa3RkakVBQUFBQUJHNXZibVVBQUFBRWJtOXVaUUFBQUFBQUFBQUJBQUFCbHdBQUFBZHpjMmd0Y24KTmhBQUFBQXdFQUFRQUFBWUVBMzVTTFRReDBFVjdPTWJQR0FqcEsxK2JhQURTTVFuK1NBU2pyTGZLNWM5NGpHdzhDbnA4LwovRHErZHFBR1pxQkg2ZnAxYmVJM1BZZzVWVDk0RVdWQ2RrTjgwY3dEcEo0Z1R0NHFUQ1gzZUYvY2x5VXQyUC9zaTNjcnQ0CjBQdi9wVnZXU1U2TlhHaDJIZC93V0MwcGh5Z0RQOVc5SHRQSUF0OFpnZmV2ZnUwZHpraVl6OHNVaElWU2ZsRGpaNUFqcUcKUjV2TVVUaGlrczEvZVlCeTdiMkFFSEdzYU8xN3NFbWNiYUlHUHZuUFVwWmQrdjkyYU1JdWZoYjhLZkFSbzZ3Ty9ISW1VbQovdDdHWFBJUmxBMUhSV0p1U05odTQzZS9DY3ZYd3Z6RnZrdE9kYXlEQzBMTklHMkpVaURlNWd0UUQ1WHZXc1p3MHQvbEs1CklacjFrZXZRNUJsYWNISmViV1ZNYUQvdllpdFdhSFo4OEF1Y0czaGh2bjkrOGNSTGhNVExiVlFSMWh2UVpBL1JtQXN3eE0KT3VJSmRaUmtxTThLZlF4Z28zQThRNGJhQW1VbnpvM3Zwa0FWdC9uaGtIOTRaRE5rV2U2RlRhdThONStyYTJCZkdjZVA4VApvbjFEeTBLRlpaUlpCREVVRVc0eHdTYUVOYXQ3c2RDNnhpL1d5OURaQUFBRm1NRFBXeDdBejFzZUFBQUFCM056YUMxeWMyCkVBQUFHQkFOK1VpMDBNZEJGZXpqR3p4Z0k2U3RmbTJnQTBqRUova2dFbzZ5M3l1WFBlSXhzUEFwNmZQL3c2dm5hZ0JtYWcKUituNmRXM2lOejJJT1ZVL2VCRmxRblpEZk5ITUE2U2VJRTdlS2t3bDkzaGYzSmNsTGRqLzdJdDNLN2VORDcvNlZiMWtsTwpqVnhvZGgzZjhGZ3RLWWNvQXovVnZSN1R5QUxmR1lIM3IzN3RIYzVJbU0vTEZJU0ZVbjVRNDJlUUk2aGtlYnpGRTRZcExOCmYzbUFjdTI5Z0JCeHJHanRlN0JKbkcyaUJqNzV6MUtXWGZyL2RtakNMbjRXL0Nud0VhT3NEdnh5SmxKdjdleGx6eUVaUU4KUjBWaWJrallidU4zdnduTDE4TDh4YjVMVG5Xc2d3dEN6U0J0aVZJZzN1WUxVQStWNzFyR2NOTGY1U3VTR2E5WkhyME9RWgpXbkJ5WG0xbFRHZy83MklyVm1oMmZQQUxuQnQ0WWI1L2Z2SEVTNFRFeTIxVUVkWWIwR1FQMFpnTE1NVERyaUNYV1VaS2pQCkNuME1ZS053UEVPRzJnSmxKODZONzZaQUZiZjU0WkIvZUdRelpGbnVoVTJydkRlZnEydGdYeG5Iai9FNko5UTh0Q2hXV1UKV1FReEZCRnVNY0VtaERXcmU3SFF1c1l2MXN2UTJRQUFBQU1CQUFFQUFBR0JBSlZtZklNNjdDQmpXcU9KdnFua2EvakRrUwo4TDdpSE5mekg1TnRZWVdPWmRMTlk2L0lRa1pDeFcwTWtSKzlUK0M3QUZKZzBNV2Q5ck5PeUxJZDkxNjZoOVJsNG0xdFJjCnViZ1o2dWZCZ3hGVDlXS21mSEdCNm4zelh5b2pQOEFJTnR6ODVpaUVHVXFFRWtVRVdMd0RGSmdvcFllQ3l1VmZ2ZE92MUgKRm1WWmEwNVo0b3NQNkNENXVmc2djQ1RYQTR6VnZ5ZHVCYkxqdHN5RjdYZjNUdjZUQ1QxU0swZHErQk1OOXRvb0RZaXpwagpzbDh6NzlybXp3eUFyWFlVcnFUUkpsNmpwRkNrWHJLcy9LeG96MHhhbXlMY2RORk9hWE51LzlnTkpjRERsV2hPcFRqNHk4CkpkNXBuV1Jueis1RHJLRFdhY0loUW1CMUxVd2ZLWmQwbVFxaUpzMUMxcXZVUmlKOGExaThKUTI4bHFuWTFRRk9wbk13emcKWEpla2FndThpT1ExRFJlQkhaM0NkcVJUYnY3bVJZSGxramx0dXJmZGc4M3hvM0ErZ1JSR001eUVOcW5xSkplQjhJQVB5UwptMFp0dGdqbHNqNTJ2K1B1NmExMHoxZndKK1VML2N6dTRKeEpOYlp6WTFIMnpLODJBaVI1T3JYNmx2aUEvSWFSRVcwUUFBCkFNQndVeUJpcUc5bEZCUnltL2UvU1VORVMzdHpicUZNdTdIcy84WTV5SnAxKzR6OXUxNGtJR2ttV0Y5eE5HT3hrY3V0cWwKeHVUcndMbjFUaFNQTHQrTjUwTGhVdzR4ZjBhNUxqemdPbklPU0FRbm5HY1Nxa0dTRDlMR21obGE2WmpydFBHY29lQ3JHdAo5M1Vvcmx5YkxNRzFFRFAxWmpKS1RaZzl6OUMwdDlTTGd3ei9DbFhydW9UNXNQVUdKWnUrbHlIZXpSTDRtcHl6OEZMcnlOCkdNci9leVM5bWdISjNVVkZEYjNIZ3BaK1E1SUdBRU5rZVZEcHIwMGhCZXZndGd6YWtBQUFEQkFQVXQ1RitoMnBVby94V1YKenRkcVQvMzA4dFB5MXVMMU1lWFoydEJPQmRwSDJyd0JzdWt0aTIySGtWZUZXQjJFdUlFUXppMzY3MGc1UGdxR1p4Vng4dQpobEE0Rkg4ZXN1NTNQckZqVW9EeFJhb3d3WXBFcFh5Y2pnNUE1MStwR1VQcWljWjB0YjliaWlhc3BWWXZhWW5sdGlnVG5iClN0UExMY29nemNiL0dGcVYyaXlzc3lwTlMwKzBNRTUxcEtxWGNaS2swbi8vVHpZWWs4TW8vZzRsQ3pmUEZQUlZrVVM5blIKWU1pQzRlcEk0TERmbVdnM0xLQ2N1Zk85all3aWgwYlFBQUFNRUE2WEtldDhEMHNvc0puZVh5WFZGd0dyVyszNlhBVGRQTwpMWDdjaStjYzFoOGV1eHdYQWx3aTJJNFhxSmJBVjBsVEhuVGEycXN3Uy9RQlpJUUJWSkZlVjVyS1daZTc4R2F3d1pWTFZNCldETmNwdFFyRTFaM2pGNS9TdUVzdlVxSDE0Tkc5RUFXWG1iUkNzelE0Vlk3NzQrSi9sTFkvMnlDT1diNzlLYTJ5OGxvYUoKVXczWWVtSld3blp2R3hKNldsL3BmQ2xYN3lEVXlXUktLdGl0cWNjbmpCWVkyRE1tZURwdURDYy9ZdDZDc3dLRmRkMkJ1UwpGZGt5cDlZY3VMaDlLZEFBQUFIR3BoYzI5dVFFRlVMVGd3TWxVdWJXOXVkR3hsYjI0dWFXNTBjbUVCQWdNRUJRWT0KLS0tLS1FTkQgT1BFTlNTSCBQUklWQVRFIEtFWS0tLS0tCgo=


Not sure we need to include this secret.

Do you think we can abbreviate?

Suggested change

key: VGhpcyB3YXMgZ2VuZXJhdGVkIHdpdGggc3NoLWtleWdlbiBwdXJlbHkgZm9yIHRoaXMgZXhhbXBsZS4KSXQgaXMgbm90IHVzZWQgYW55d2hlcmUuCi0tLS0tQkVHSU4gT1BFTlNTSCBQUklWQVRFIEtFWS0tLS0tCmIzQmxibk56YUMxclpYa3RkakVBQUFBQUJHNXZibVVBQUFBRWJtOXVaUUFBQUFBQUFBQUJBQUFCbHdBQUFBZHpjMmd0Y24KTmhBQUFBQXdFQUFRQUFBWUVBMzVTTFRReDBFVjdPTWJQR0FqcEsxK2JhQURTTVFuK1NBU2pyTGZLNWM5NGpHdzhDbnA4LwovRHErZHFBR1pxQkg2ZnAxYmVJM1BZZzVWVDk0RVdWQ2RrTjgwY3dEcEo0Z1R0NHFUQ1gzZUYvY2x5VXQyUC9zaTNjcnQ0CjBQdi9wVnZXU1U2TlhHaDJIZC93V0MwcGh5Z0RQOVc5SHRQSUF0OFpnZmV2ZnUwZHpraVl6OHNVaElWU2ZsRGpaNUFqcUcKUjV2TVVUaGlrczEvZVlCeTdiMkFFSEdzYU8xN3NFbWNiYUlHUHZuUFVwWmQrdjkyYU1JdWZoYjhLZkFSbzZ3Ty9ISW1VbQovdDdHWFBJUmxBMUhSV0p1U05odTQzZS9DY3ZYd3Z6RnZrdE9kYXlEQzBMTklHMkpVaURlNWd0UUQ1WHZXc1p3MHQvbEs1CklacjFrZXZRNUJsYWNISmViV1ZNYUQvdllpdFdhSFo4OEF1Y0czaGh2bjkrOGNSTGhNVExiVlFSMWh2UVpBL1JtQXN3eE0KT3VJSmRaUmtxTThLZlF4Z28zQThRNGJhQW1VbnpvM3Zwa0FWdC9uaGtIOTRaRE5rV2U2RlRhdThONStyYTJCZkdjZVA4VApvbjFEeTBLRlpaUlpCREVVRVc0eHdTYUVOYXQ3c2RDNnhpL1d5OURaQUFBRm1NRFBXeDdBejFzZUFBQUFCM056YUMxeWMyCkVBQUFHQkFOK1VpMDBNZEJGZXpqR3p4Z0k2U3RmbTJnQTBqRUova2dFbzZ5M3l1WFBlSXhzUEFwNmZQL3c2dm5hZ0JtYWcKUituNmRXM2lOejJJT1ZVL2VCRmxRblpEZk5ITUE2U2VJRTdlS2t3bDkzaGYzSmNsTGRqLzdJdDNLN2VORDcvNlZiMWtsTwpqVnhvZGgzZjhGZ3RLWWNvQXovVnZSN1R5QUxmR1lIM3IzN3RIYzVJbU0vTEZJU0ZVbjVRNDJlUUk2aGtlYnpGRTRZcExOCmYzbUFjdTI5Z0JCeHJHanRlN0JKbkcyaUJqNzV6MUtXWGZyL2RtakNMbjRXL0Nud0VhT3NEdnh5SmxKdjdleGx6eUVaUU4KUjBWaWJrallidU4zdnduTDE4TDh4YjVMVG5Xc2d3dEN6U0J0aVZJZzN1WUxVQStWNzFyR2NOTGY1U3VTR2E5WkhyME9RWgpXbkJ5WG0xbFRHZy83MklyVm1oMmZQQUxuQnQ0WWI1L2Z2SEVTNFRFeTIxVUVkWWIwR1FQMFpnTE1NVERyaUNYV1VaS2pQCkNuME1ZS053UEVPRzJnSmxKODZONzZaQUZiZjU0WkIvZUdRelpGbnVoVTJydkRlZnEydGdYeG5Iai9FNko5UTh0Q2hXV1UKV1FReEZCRnVNY0VtaERXcmU3SFF1c1l2MXN2UTJRQUFBQU1CQUFFQUFBR0JBSlZtZklNNjdDQmpXcU9KdnFua2EvakRrUwo4TDdpSE5mekg1TnRZWVdPWmRMTlk2L0lRa1pDeFcwTWtSKzlUK0M3QUZKZzBNV2Q5ck5PeUxJZDkxNjZoOVJsNG0xdFJjCnViZ1o2dWZCZ3hGVDlXS21mSEdCNm4zelh5b2pQOEFJTnR6ODVpaUVHVXFFRWtVRVdMd0RGSmdvcFllQ3l1VmZ2ZE92MUgKRm1WWmEwNVo0b3NQNkNENXVmc2djQ1RYQTR6VnZ5ZHVCYkxqdHN5RjdYZjNUdjZUQ1QxU0swZHErQk1OOXRvb0RZaXpwagpzbDh6NzlybXp3eUFyWFlVcnFUUkpsNmpwRkNrWHJLcy9LeG96MHhhbXlMY2RORk9hWE51LzlnTkpjRERsV2hPcFRqNHk4CkpkNXBuV1Jueis1RHJLRFdhY0loUW1CMUxVd2ZLWmQwbVFxaUpzMUMxcXZVUmlKOGExaThKUTI4bHFuWTFRRk9wbk13emcKWEpla2FndThpT1ExRFJlQkhaM0NkcVJUYnY3bVJZSGxramx0dXJmZGc4M3hvM0ErZ1JSR001eUVOcW5xSkplQjhJQVB5UwptMFp0dGdqbHNqNTJ2K1B1NmExMHoxZndKK1VML2N6dTRKeEpOYlp6WTFIMnpLODJBaVI1T3JYNmx2aUEvSWFSRVcwUUFBCkFNQndVeUJpcUc5bEZCUnltL2UvU1VORVMzdHpicUZNdTdIcy84WTV5SnAxKzR6OXUxNGtJR2ttV0Y5eE5HT3hrY3V0cWwKeHVUcndMbjFUaFNQTHQrTjUwTGhVdzR4ZjBhNUxqemdPbklPU0FRbm5HY1Nxa0dTRDlMR21obGE2WmpydFBHY29lQ3JHdAo5M1Vvcmx5YkxNRzFFRFAxWmpKS1RaZzl6OUMwdDlTTGd3ei9DbFhydW9UNXNQVUdKWnUrbHlIZXpSTDRtcHl6OEZMcnlOCkdNci9leVM5bWdISjNVVkZEYjNIZ3BaK1E1SUdBRU5rZVZEcHIwMGhCZXZndGd6YWtBQUFEQkFQVXQ1RitoMnBVby94V1YKenRkcVQvMzA4dFB5MXVMMU1lWFoydEJPQmRwSDJyd0JzdWt0aTIySGtWZUZXQjJFdUlFUXppMzY3MGc1UGdxR1p4Vng4dQpobEE0Rkg4ZXN1NTNQckZqVW9EeFJhb3d3WXBFcFh5Y2pnNUE1MStwR1VQcWljWjB0YjliaWlhc3BWWXZhWW5sdGlnVG5iClN0UExMY29nemNiL0dGcVYyaXlzc3lwTlMwKzBNRTUxcEtxWGNaS2swbi8vVHpZWWs4TW8vZzRsQ3pmUEZQUlZrVVM5blIKWU1pQzRlcEk0TERmbVdnM0xLQ2N1Zk85all3aWgwYlFBQUFNRUE2WEtldDhEMHNvc0puZVh5WFZGd0dyVyszNlhBVGRQTwpMWDdjaStjYzFoOGV1eHdYQWx3aTJJNFhxSmJBVjBsVEhuVGEycXN3Uy9RQlpJUUJWSkZlVjVyS1daZTc4R2F3d1pWTFZNCldETmNwdFFyRTFaM2pGNS9TdUVzdlVxSDE0Tkc5RUFXWG1iUkNzelE0Vlk3NzQrSi9sTFkvMnlDT1diNzlLYTJ5OGxvYUoKVXczWWVtSld3blp2R3hKNldsL3BmQ2xYN3lEVXlXUktLdGl0cWNjbmpCWVkyRE1tZURwdURDYy9ZdDZDc3dLRmRkMkJ1UwpGZGt5cDlZY3VMaDlLZEFBQUFIR3BoYzI5dVFFRlVMVGd3TWxVdWJXOXVkR3hsYjI0dWFXNTBjbUVCQWdNRUJRWT0KLS0tLS1FTkQgT1BFTlNTSCBQUklWQVRFIEtFWS0tLS0tCgo=

key: VGhpcyB3YXMgZ2Vu ...

anarnold97 · 2024-12-18T18:57:48Z

documentation/modules/adding-hook-using-cli.adoc

+
+[NOTE]
+====
+You can also use a `here` document to encode a playbook:


could you explain a bit more, as i got a bit confused?

anarnold97 · 2024-12-18T19:04:44Z

documentation/modules/adding-hook-using-ui.adoc

+[id="adding-migration-hook-via-ui_{context}"]
+= Adding a migration hook to a migration plan using the {ocp} web console
+
+You can add a migration hook to an existing migration plan using the {ocp} web console. Note that you will need to execute one command in the {project-first} CLI.


Suggested change

You can add a migration hook to an existing migration plan using the {ocp} web console. Note that you will need to execute one command in the {project-first} CLI.

You can add a migration hook to an existing migration plan using the {ocp} web console. Note that you will need to run one command in the {project-first} CLI.

i think excute might be a problematic word

...and I'd remove "will"

anarnold97 · 2024-12-18T19:06:24Z

documentation/modules/adding-hook-using-ui.adoc

+
+[NOTE]
+====
+You can run one pre-migration hook, one post-migration hook, or one of each, per migration plan.


Suggested change

You can run one pre-migration hook, one post-migration hook, or one of each, per migration plan.

You can run one pre-migration hook, one post-migration hook, or one of each per migration plan.

anarnold97 · 2024-12-18T19:12:23Z

documentation/modules/adding-hook-using-ui.adoc

+.Prerequisites
+
+* Migration plan
+* Migration hook file, whose contents you will copy-paste into the web console.


Suggested change

* Migration hook file, whose contents you will copy-paste into the web console.

* Migration hook file, whose contents you will copy and paste into the web console.

And I'd remove "will". :-)

anarnold97 · 2024-12-18T19:13:48Z

documentation/modules/adding-hook-using-ui.adoc

+====
+
+* File containing the `Secret` for the source provider
+* {ocp} service account that has at least write-access permission for the namespace you are working in


Suggested change

* {ocp} service account that has at least write-access permission for the namespace you are working in

* {ocp} service account that has at least write access for the namespace you are working in

anarnold97 · 2024-12-18T19:20:20Z

documentation/modules/adding-hook-using-cli.adoc

+
+You can add a migration hook to an existing migration plan using the {project-first} CLI.
+
+You can add a `PreHook` or a `PostHook` Hook CR when you migrate a virtual machine from the command line by using the {project-full} API. A `PreHook` runs before a migration, a `PostHook`, after.


Suggested change

You can add a `PreHook` or a `PostHook` Hook CR when you migrate a virtual machine from the command line by using the {project-full} API. A `PreHook` runs before a migration, a `PostHook`, after.

You can add a `PreHook` or a `PostHook` Hook CR when you migrate a virtual machine from the command line by using the {project-full} API. A `PreHook` runs before a migration, a `PostHook`, after a migration.

Sometimes best to be explicit about this type of thing

anarnold97 · 2024-12-18T19:21:15Z

documentation/modules/adding-hook-using-cli.adoc

+You can retrieve additional information stored in a secret or in a `configMap` by using a `k8s` module.
+====
+
+For example, you can create a hook CR to install `cloud-init` on a VM and write a file before migration.


Suggested change

For example, you can create a hook CR to install `cloud-init` on a VM and write a file before migration.

For example, you can create a hook CR to install the `cloud-init` service on a VM and write a file before migration.

anarnold97 · 2024-12-18T19:21:52Z

documentation/modules/adding-hook-using-cli.adoc

+====
+
+* File containing the `Secret` for the source provider
+* {ocp} service account that has at least write-access permission for the namespace you are working in


Suggested change

* {ocp} service account that has at least write-access permission for the namespace you are working in

* {ocp} service account that has at least write access for the namespace you are working in

anarnold97 · 2024-12-18T19:27:38Z

documentation/modules/snip_example-hook-for-migration-plans.adoc

+
+.Example migration hook
+[source,yaml,subs="attributes+"]
+----


is there anything to called-out on this YAML?

nunzy1 · 2024-12-18T21:59:09Z

documentation/modules/about-hooks-for-migration-plans.adoc

+
+[IMPORTANT]
+====
+In order for a hook to run on a VM, the VM must be started and available via SSH.


Please check our standards. Not sure we use "via".

nunzy1 · 2024-12-19T00:44:36Z

documentation/modules/about-hooks-for-migration-plans.adoc

+
+You can add hooks to {project-first} migration plans using either the {project-short} CLI or the {project-short} user interface, which is located in the {ocp} web console.
+
+* Hooks that perform operations on VMs before migration are called _pre-migration_ hooks.  A pre-migration hook is performed on a VM that is located on the provider and prepares the VM for migration.


As always, up to you what you want to incorporate. :-)

Pre-migration hooks are hooks that perform operations on a VM that is located on a provider. This prepares the VM for migration.

nunzy1 · 2024-12-19T00:46:17Z

documentation/modules/about-hooks-for-migration-plans.adoc

+
+* Hooks that perform operations on VMs before migration are called _pre-migration_ hooks.  A pre-migration hook is performed on a VM that is located on the provider and prepares the VM for migration.
+
+* Hooks that perform operations on VMs after migration are called _post-migration_ hooks. A post-migration hook is performed on a VM after it has been migrated to {virt}.


Post-migration hooks are hooks that perform operations on a VM that has migrated to {virt}.

nunzy1 · 2024-12-19T00:48:56Z

documentation/modules/about-hooks-for-migration-plans.adoc

+An Ansible playbook that is provided as part of a migration hook is mounted into the hook container as a `configmap`. The hook container is run as a job on the desired cluster, using the default `ServiceAccount` in the `konveyor-forklift` namespace.
+
+
+When you add a hook, you must specify the namespace where the `Hook` CR is located, the name of the hook, and specify whether the hook is a pre-migration hook or a post-migration hook.


Don't think you need the second "specify."

nunzy1 · 2024-12-19T01:02:25Z

documentation/modules/images/updated_hooks_figure_from_martin_cropped.png

In the figure, looks like "post migration" is truncated.

nunzy1 · 2024-12-19T01:11:24Z

documentation/modules/about-hooks-for-migration-plans.adoc

+In order for a hook to run on a VM, the VM must be started and available via SSH.
+====
+
+The illustration that follows shows the general process of using a migration hook. Specific procedures are described in xref:adding-migration-hook-via-ui_{context}[Adding a migration hook to a migration plan using the {ocp} web console] and xref:adding-migration-hook-via-cli_{context}[Adding a migration hook to a migration plan using the CLI].


Maybe...

For specific procedures, see XXX. (If see is allowed per our standards. I felt that the procedures themselves are probably given versus "described.")

nunzy1 · 2024-12-19T01:28:38Z

documentation/modules/adding-hook-using-cli.adoc

+* VMs running on Microsoft Server only: Remote Execution enabled
+
+.Procedure
+. If needed, create a Secret with an SSH private key for the VM. You can either use an existing key or generate a key pair, install the public key on the VM, and base64 encode the private key in the Secret.


Maybe: If needed, create a Secret with an SSH private key for the VM.

(sub-steps) Choose an existing key or generate a key pair.

Install the public key on the VM.

Encode the private key in the secret to base64.

RichardHoch marked this pull request as draft November 17, 2024 16:15

RichardHoch force-pushed the improved_hook_description branch from 7ebbf4a to b68d6c3 Compare December 15, 2024 09:58

RichardHoch added 6 commits December 18, 2024 11:50

WIP New hooks description

7cfbcac

Figure description

472c929

Added UI module and Hook snippet

ca636f7

include ui section in master

58010da

hook snippet added correctly

43b1bda

new hook snippet and start of cli

931c4a2

RichardHoch force-pushed the improved_hook_description branch from c0e8df2 to 931c4a2 Compare December 18, 2024 09:51

RichardHoch added 4 commits December 18, 2024 13:49

Draft figure added

84696f7

began smoothing cli section

f680395

smoothing

f404ef6

xrefs

4fbce24

RichardHoch changed the title ~~WIP New hooks description~~ MTV-1590 Improved hooks description Dec 18, 2024

RichardHoch added 2 commits December 18, 2024 19:15

minor

2b8c7a7

minor

fc75f4c

RichardHoch marked this pull request as ready for review December 18, 2024 17:29

minor

7c24efb

anarnold97 reviewed Dec 18, 2024

View reviewed changes

nunzy1 reviewed Dec 18, 2024

View reviewed changes

nunzy1 reviewed Dec 19, 2024

View reviewed changes

documentation/modules/images/updated_hooks_figure_from_martin_cropped.png

Copy link

nunzy1 Dec 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the figure, looks like "post migration" is truncated.

nunzy1 reviewed Dec 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MTV-1590 Improved hooks description #586

MTV-1590 Improved hooks description #586

RichardHoch commented Nov 17, 2024 •

edited

Loading

anarnold97 Dec 18, 2024

anarnold97 Dec 18, 2024

anarnold97 Dec 18, 2024

anarnold97 Dec 18, 2024

anarnold97 Dec 18, 2024

anarnold97 Dec 18, 2024

anarnold97 Dec 18, 2024

nunzy1 Dec 19, 2024

anarnold97 Dec 18, 2024

anarnold97 Dec 18, 2024

nunzy1 Dec 19, 2024

anarnold97 Dec 18, 2024 •

edited

Loading

anarnold97 Dec 18, 2024

anarnold97 Dec 18, 2024

anarnold97 Dec 18, 2024

anarnold97 Dec 18, 2024

nunzy1 Dec 18, 2024

nunzy1 Dec 19, 2024 •

edited

Loading

nunzy1 Dec 19, 2024

nunzy1 Dec 19, 2024

nunzy1 Dec 19, 2024

nunzy1 Dec 19, 2024

nunzy1 Dec 19, 2024

	. The job runs a prehook or a posthook as follows:
	. The job runs a pre-migration hook or a post-migration hook as follows:

	. The job runs a prehook or a posthook as follows:
	. The job runs a `PreHook` or a `PostHook` as follows:

	You can add a migration hook to an existing migration plan using the {ocp} web console. Note that you will need to execute one command in the {project-first} CLI.
	You can add a migration hook to an existing migration plan using the {ocp} web console. Note that you will need to run one command in the {project-first} CLI.

	You can run one pre-migration hook, one post-migration hook, or one of each, per migration plan.
	You can run one pre-migration hook, one post-migration hook, or one of each per migration plan.

	* Migration hook file, whose contents you will copy-paste into the web console.
	* Migration hook file, whose contents you will copy and paste into the web console.

	* {ocp} service account that has at least write-access permission for the namespace you are working in
	* {ocp} service account that has at least write access for the namespace you are working in


		You can add a migration hook to an existing migration plan using the {project-first} CLI.

		You can add a `PreHook` or a `PostHook` Hook CR when you migrate a virtual machine from the command line by using the {project-full} API. A `PreHook` runs before a migration, a `PostHook`, after.

	For example, you can create a hook CR to install `cloud-init` on a VM and write a file before migration.
	For example, you can create a hook CR to install the `cloud-init` service on a VM and write a file before migration.


		You can add hooks to {project-first} migration plans using either the {project-short} CLI or the {project-short} user interface, which is located in the {ocp} web console.

		* Hooks that perform operations on VMs before migration are called _pre-migration_ hooks. A pre-migration hook is performed on a VM that is located on the provider and prepares the VM for migration.


		* Hooks that perform operations on VMs before migration are called _pre-migration_ hooks. A pre-migration hook is performed on a VM that is located on the provider and prepares the VM for migration.

		* Hooks that perform operations on VMs after migration are called _post-migration_ hooks. A post-migration hook is performed on a VM after it has been migrated to {virt}.

		An Ansible playbook that is provided as part of a migration hook is mounted into the hook container as a `configmap`. The hook container is run as a job on the desired cluster, using the default `ServiceAccount` in the `konveyor-forklift` namespace.


		When you add a hook, you must specify the namespace where the `Hook` CR is located, the name of the hook, and specify whether the hook is a pre-migration hook or a post-migration hook.

MTV-1590 Improved hooks description #586

Are you sure you want to change the base?

MTV-1590 Improved hooks description #586

Conversation

RichardHoch commented Nov 17, 2024 • edited Loading

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

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

Choose a reason for hiding this comment

anarnold97 Dec 18, 2024 • edited Loading

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

Choose a reason for hiding this comment

nunzy1 Dec 19, 2024 • edited Loading

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

Choose a reason for hiding this comment

RichardHoch commented Nov 17, 2024 •

edited

Loading

anarnold97 Dec 18, 2024 •

edited

Loading

nunzy1 Dec 19, 2024 •

edited

Loading