From 20f8c32bb69a294f78137108f26c912b4a16bd7a Mon Sep 17 00:00:00 2001 From: Evgeny Slutsky Date: Sun, 30 Jul 2023 15:36:34 +0300 Subject: [PATCH] CI Docs fixes Signed-off-by: Evgeny Slutsky --- README.md | 8 ++++---- ci/README.md | 22 +++++++++++----------- cluster/providers/README.md | 12 ++++++------ 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 7bd3da1..54737a9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # forkliftci -This repo contains collection of scripts,tools and gh actions for creating and deploying forklift cluster and running integration e2e tests against it. +This repository contains a collection of scripts, tools and GitHub actions for creating and deploying forklift cluster and running e2e integration 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) -* 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). +* Define migration source [providers](cluster/providers/README.md) +* Execute CI e2e jobs and GitHub [actions](ci/README.md) +* OKD single-node-OpenShift (SNO) deployment using Ansible [playbook](cluster/okd-on-ovirt/README.md). diff --git a/ci/README.md b/ci/README.md index 2bec5f6..579227f 100644 --- a/ci/README.md +++ b/ci/README.md @@ -1,23 +1,23 @@ # Forklift CI action collection -This section include reusuable standalone actions that can be used externally, consumed from the kubev2v/forklift repo (can be any other GH repo). +This section includes reusable standalone actions that can be used externally, consumed from the kubev2v/forklift repo (can be any other GH repo). ## build-and-setup Build and setup the forkliftci env with kind and prepare the env for e2e testing. -- install kind (k8s) with a local image docker registry -- deploy kubevirt using manifests. -- build forklift from source using bazel and push to the local registry. -- deploy forklift from the local registry. -- install source provider (openstack/ovirt/vsphere). +- Install kind (k8s) with a docker local image registry. +- Deploy kubevirt using manifests. +- Build forklift from source using bazel and push to the local registry. +- Deploy forklift from the local registry. +- Install source provider (openstack/ovirt/vsphere). ## prepare-ansible-secrets -the secrets stored in gh forklift and forkliftci settings. -they are stored in base64 and provide configuration +The secrets are stored in GitHub settings of the kubev2v/forklift and kubev2v/forkliftci repositories. +They are stored in base64 and provide configuration for other actions, used by create-self-runner. ## create-self-runner -- provision Self hosted runner from a fedora template. +- Provisions a self-hosted runner from a Fedora template. - join as GH hosted runner. ## run-suite @@ -25,7 +25,7 @@ Wrapper for running a forklift e2e testing suite, all the suites ## deploy-okd -Use ansible to deploy OKD SNO instance on top of oVirt for e2e testing,refer to this document for the deployment flow. +Use Ansible to deploy OKD SNO instance on top of oVirt for e2e testing, refer to this document for the deployment flow. ## save-artifacts -Collect K8s logs that are relevant for the forklift components. Usefull for troubleshooting e2e migration failures , store them under gh-project job. +Collect K8s logs that are relevant for the forklift components. Useful for troubleshooting e2e migration failures, store them under gh-project job. \ No newline at end of file diff --git a/cluster/providers/README.md b/cluster/providers/README.md index cb5ee62..5f38cf3 100644 --- a/cluster/providers/README.md +++ b/cluster/providers/README.md @@ -11,20 +11,20 @@ when `` can be either of: - vmware -## openstack -containerised [packstack](https://github.com/kubev2v/packstack-img) deployment that is tailor made for forklift migrations. +## Openstack +containerised [packstack](https://github.com/kubev2v/packstack-img) deployment that is tailor for forklift migrations. - Environment variables: | Name | Description | Required | | ----------- | ----------- | --- | - | NFS_IP_ADDRESS | NFS server address used by cinder | yes | + | NFS_IP_ADDRESS | NFS server address used by cinder and volume populator (csi-driver-nfs) | yes | | NFS_SHARE | NFS export path. | yes | | KEYSTONE_USE_SSL | deploy Keystone with SSL and self signed certs | no | -## ovirt +## oVirt [fakeovirt](https://github.com/kubev2v/fakeovirt) and [ovirt-imageio](https://github.com/kubev2v/ovirt-imageio-server) deployments : - Environment variables: @@ -34,6 +34,6 @@ containerised [packstack](https://github.com/kubev2v/packstack-img) deployment | NFS_SHARE | NFS export path. | yes | -## vmware -vmware/vcsim deployment and vsphere-provider with stub vddkInitImage [image](../../stub-images/vddk-test-vmdk/BUILD.bazel). +## VMware +[VMware/vcsim](https://github.com/vmware/govmomi/tree/main/vcsim) deployment and vsphere-provider with stub vddkInitImage [image](../../stub-images/vddk-test-vmdk/BUILD.bazel).