konveyor / ci

Apache License 2.0
0 stars 12 forks source link

Document ways how to install Konveyor for devs and CI #45

Open aufi opened 2 months ago

aufi commented 2 months ago

There are multiple community memebers that needs write scripts/automation or need setup their development environment. In order to share and re-use install scripts and tools, we should summarize it to some README.

Draft (for begining)

Konveyor should work OpenShift as well as on vanilla Kubernetes (including Minikube). The main requirement on k8s environment is to have operators available (OLM).

Example enabling operators on minikube: https://github.com/konveyor/operator/blob/main/hack/start-minikube.sh

Primary source

The primary resposible component for installing Konveyors is Konveyor operator. The operator repository contains scripts that should be re-used.

Related link https://github.com/konveyor/operator/tree/main/hack

Secondary scripts

All Konveyor instllations scripts should be based on operator above and/or its scripts. This re-use should lead to finding and fixing issues faster since more people would use it.

Example of Hub, that call operator scripts: https://github.com/konveyor/tackle2-hub/blob/main/Makefile#L111-L135

Github actions

There are actions that can setup Konveyor in Github actions environment: https://github.com/konveyor/operator/tree/main/.github/actions Example of its usage from other repository workflow: https://github.com/konveyor/go-konveyor-tests/blob/main/.github/workflows/nightly-tier0.yml#L12-L17

TODO

Include UI or QE setup scripts and try re-use them where available. Links:

aufi commented 2 months ago

This might be relevant for multiple team members. @dymurray @djzager @mguetta1 @msajidmansoori12 @sshveta

msajidmansoori12 commented 2 months ago

@mail2nadeem92 ^^