add docs for migration source providers

Signed-off-by: Evgeny Slutsky <[email protected]>

README.md

@@ -1,7 +1,8 @@
 # forkliftci
-Scripts and tools and github-actions for creating and deploying forklift cluster infrastructure and running integration tests against it.
+This repo contains collection of scripts,tools and gh actions for creating and deploying forklift cluster  and running integration e2e tests against it.
 
 * How to [install forklift on _kind_](INSTALL_FORKLIFT_ON_KIND.md).
 * How to [build kubev2v-forklift and install it on _kind_](BUILD_AND_INSTALL_FORKLIFT_ON_KIND.md)
-* CI e2e jobs  reusuable [actions](ci/README.md) 
+* migration source  [providers](cluster/providers/README.md)
+* CI e2e jobs and gh [actions](ci/README.md) 
 * okd sno deployment ansible [playbook](cluster/okd-on-ovirt/README.md).

cluster/providers/README.md

@@ -0,0 +1,39 @@
+# Migration source providers
+
+## Installation
+Provider can be installed on a K8s cluster :
+
+`providers/install-provider.sh <provider-name>`
+
+when `<provider-name>` can be either of:
+- openstack
+- ovirt
+- vmware
+
+
+## openstack 
+containerised [packstack](https://github.com/kubev2v/packstack-img)  deployment  that is tailor made for forklift  migrations.
+
+
+- Environment variables:
+
+    | Name | Description | Required | 
+    | ----------- | ----------- | ---  |
+    | NFS_IP_ADDRESS |  NFS server  address used by cinder | yes | 
+    | NFS_SHARE |  NFS export path. | yes |
+    | KEYSTONE_USE_SSL | deploy  Keystone with SSL and self signed certs  | no |
+
+
+## ovirt 
+[fakeovirt](https://github.com/kubev2v/fakeovirt) and [ovirt-imageio](https://github.com/kubev2v/ovirt-imageio-server) deployments :
+- Environment variables:
+
+    | Name | Description | Required | 
+    | ----------- | ----------- | ---  |
+    | NFS_IP_ADDRESS |  NFS server  address used by cinder | yes | 
+    | NFS_SHARE |  NFS export path. | yes |
+
+
+## vmware
+vmware/vcsim  deployment  and vsphere-provider with stub vddkInitImage [image](../../stub-images/vddk-test-vmdk/BUILD.bazel).
+