Skip to content

Latest commit

 

History

History
115 lines (101 loc) · 3.5 KB

adding-hook-using-cli.adoc

File metadata and controls

115 lines (101 loc) · 3.5 KB

Adding a migration hook to a migration plan using the CLI

You can use a Hook CR to add a pre-migration hook or a post-migration hook to an existing migration plan using the {project-first} CLI.

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

Note

You can run one pre-migration hook, one post-migration hook, or one of each per migration plan. Each hook needs its own Hook CR, but a Plan CR contains data for all the hooks it uses.
Note

You can retrieve additional information stored in a secret or in a ConfigMap by using a k8s module.
Prerequisites

  • Migration plan

  • Migration hook image or the playbook containing the hook image

  • File containing the Secret for the source provider

  • {ocp} service account called by the hook and that has at least write access for the namespace you are working in

  • SSH access for VMs you want to migrate with the public key installed on the VMs

  • VMs running on Microsoft Server only: Remote Execution enabled

Additional resources

For instructions for creating a service account, see Understanding and creating service accounts.

Procedure

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

    1. Choose an existing key or generate a key pair.

    2. Install the public key on the VM.

    3. Encode the private key in the Secret to base64.

      apiVersion: v1
data:
  key: VGhpcyB3YXMgZ2Vu...
kind: Secret
metadata:
  name: ssh-credentials
  namespace: openshift-mtv
type: Opaque

  2. Encode your playbook by concatenating a file and piping it for Base64 encoding, for example:

    $ cat playbook.yml | base64 -w0

  3. Create a Hook CR:

    $  cat << EOF | {oc} apply -f -
apiVersion: forklift.konveyor.io/v1beta1
kind: Hook
metadata:
  name: <hook>
  namespace: <namespace>
spec:
  image: quay.io/konveyor/hook-runner
  serviceAccount:<service account> (1)
  playbook: |
    LS0tCi0gbm... (2)
EOF

    1. (Optional) {ocp} service account. The serviceAccount must be provided if you want to manipulate any resources of the cluster.

    2. Base64-encoded Ansible Playbook. If you specify a playbook, the image must include an ansible-runner.

      Note

      You can use the default hook-runner image or specify a custom image. If you specify a custom image, you do not have to specify a playbook.
      Note

      To decode an attached playbook, retrieve the resource with custom output and pipe it to base64. For example:

      $ oc get -n konveyor-forklift hook playbook -o \
    go-template='{{ .spec.playbook }}' | base64 -d

  4. In the Plan CR of the migration, for each VM, add the following section to the end of the CR:

      vms:
    - id: <vm_id>
      hooks:
        - hook:
            namespace: <namespace>
            name: <name_of_hook>
          step: <type_of_hook> (1)

    1. Options are PreHook, to run the hook before the migration, and PostHook, to run the hook after the migration.

Important

In order for a PreHook to run on a VM, the VM must be started and available via SSH.