README.md

Installation Guide

To run you own project "Steward" you need a Kubernetes cluster. Currently Kubernetes 1.14 is recommended.

Install Tekton v0.8.0

Project "Steward" requires Tekton. Please read the Tekton installation instructions.

In short:

kubectl apply -f https://github.com/tektoncd/pipeline/releases/download/v0.8.0/release.yaml

Install Steward

Clone this repo

Clone the repo and change into the root directory, e.g.:

git clone "$THIS_REPO" stewardci-core
cd stewardci-core

Install via Steward Helm Chart

See the Steward Helm Chart documentation.

Prepare Namespaces for Clients

Each Steward client gets its own client namespace to interact with Steward.

Typically a client is a (Web) application that uses Steward as pipeline execution engine. Typically one Steward instance has only one client, but there can be any number of clients, e.g. in a test environment.

Example only:

# edit yaml and apply
kubectl apply -f ./backend-k8s/steward-client-example

See the yaml files in this folder for more details about configuration options.

More

As a next step you might want to test your project "Steward" by running example pipelines.