konveyor / konveyor/ci

Document ways how to install Konveyor for devs and CI

Open
#45 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
0
Forks
17
Avg merge
4h 26m
Merged PRs (30d)
10

Description

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
- [install-tackle.sh](https://github.com/konveyor/operator/blob/main/hack/install-tackle.sh) is more simple install script
- [install-konveyor.sh](https://github.com/konveyor/operator/blob/main/hack/install-konveyor.sh) allows more deployment customization

## 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:
- https://github.com/konveyor/tackle2-ui/pull/1818

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the operator scripts install-tackle.sh, install-konveyor.sh, and start-minikube.sh, plus the referenced GitHub Actions and examples in tackle2-hub/Makefile and go-konveyor-tests/.github/workflows/nightly-tier0.yml. Done means a README documents reusable development and CI installation paths for OpenShift and vanilla Kubernetes, including Minikube and OLM, while addressing the UI/QE setup TODO.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, kubernetes, shell
Domain
devops, documentation, infrastructure
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.