Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #117

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #117

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09dc68a
Update README.md
Mar 31, 2022
4380693
Merge branch 'main' into readmeupdate
shreddedbacon Jun 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,33 @@
This project is comprised of controllers responsible for handling Kubernetes and Openshift build deploy and removal of environments for Lagoon.
It also handles Lagoon tasks that are triggered via the Lagoon UI, and also more advanced tasks that Lagoon can leverage.

## Install
## Table of Contents
1. Project Description
2. Usage
3. Contribution

See [lagoon-charts](https://github.com/uselagoon/lagoon-charts)
## Project description
- longer project description -

## Usage

The controllers have the ability to start with and without messaging queue support.

### Installation

See [lagoon-charts](https://github.com/uselagoon/lagoon-charts).

### With MQ

This is the preferred way to be installed, it reads messages from dedicated queues that are sent from Lagoon.
This is the preferred way to install, it reads messages from dedicated queues that are sent from Lagoon.
The recieved message contains everything that the LagoonBuild or LagoonTask spec needs to start doing the work in the destination cluster.

### Without MQ

This is handy for testing scenarios, a [K3D](https://github.com/rancher/k3d) or [KinD](https://github.com/kubernetes-sigs/kind) can be started locally and the controllers installed into it.

A user can then define or craft a LagoonBuild or LagoonTask spec manually and apply it to the local cluster.
There is currently no documentation for how to do this, we may release more information on how to do this after some more testing has been done.

## Contribution
- info here -