Skip to content

Commit

Permalink
add docs for reusable actions
Browse files Browse the repository at this point in the history
each action can be consumed from another repo.

Signed-off-by: Evgeny Slutsky <[email protected]>
  • Loading branch information
eslutsky authored and ahadas committed Aug 2, 2023
1 parent 952642c commit d1f31c1
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ Scripts and tools and github-actions for creating and deploying forklift cluster

* 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)
* okd sno deployment ansible [playbook](cluster/okd-on-ovirt/README.md).
31 changes: 31 additions & 0 deletions ci/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

# 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).

## 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).

## prepare-ansible-secrets
the secrets stored in gh forklift and forkliftci settings.
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.
- join as GH hosted runner.

## run-suite
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.

## save-artifacts
Collect K8s logs that are relevant for the forklift components. Usefull for troubleshooting e2e migration failures , store them under gh-project job.

0 comments on commit d1f31c1

Please sign in to comment.