Integreatly Operator

A Kubernetes Operator based on the Operator SDK for installing and reconciling Integreatly products.

Project status: alpha

This is a proof of concept/alpha version. Most functionality is present but it is highly likely there are bugs and improvements needed.

Installed products

Currently the operator installs the following products:

AMQ Online
AMQ Streams
Codeready
Fuse
Launcher
Nexus
RHSSO (both a cluster instance and a user instance)
3scale
Integreatly solution explorer

Prerequisites

operator-sdk version v0.10.0.
go version 1.12+
moq
oc version v3.11+
Access to an Openshift v4.1.0+ cluster
A user with administrative privileges in the OpenShift cluster
AWS account with permissions to create S3 buckets

After installation, the following commands must be run to avoid a known issue related to the Moq package:

go get -u .
go install github.com/matryer/moq

Local Setup

Download the integreatly-operator project:

mkdir -p $GOPATH/src/github.com/integr8ly
cd $GOPATH/src/github.com/integr8ly
git clone https://github.com/integr8ly/integreatly-operator
cd integreatly-operator

Some products require certain credentials to be present in the namespace before installation can proceed:

3scale requires AWS credentials for backups to an S3 bucket. The bucket should have all public access turned off
RHSSO requires Github OAuth credentials to create a Github Identity Provider for Launcher (see here for creating a Github OAuth app) and Codeready

Note: If these secrets aren't created, the integreatly preflight checks will fail

# The project name for the integreatly operator to watch 
export NAMESPACE="integreatly-test"

# 3scale requires AWS credentials for backups to S3
export AWS_ACCESS_KEY_ID=<access key>
export AWS_SECRET_ACCESS_KEY=<access secret>
export AWS_BUCKET=<bucket name>

# RHSSO requires Github OAuth credentials to setup a Github identity provider
# for Fabric8 Launcher and Codeready
export GH_CLIENT_ID=<client id>
export GH_CLIENT_SECRET=<client secret>

# Bootstrap the project
make cluster/prepare/local

An Installation custom resource can now be created which will kick of the installation of the integreatly products, once the operator is running:

# Create the installation custom resource
oc create -f deploy/crds/examples/installation.cr.yaml

# The operator can now be run locally
make code/run

Logging in to SSO

In the OpenShift UI, in Projects > integreatly-rhsso > Networking > Routes, select the sso route to open up the SSO login page.

Bootstrap the project

make cluster/prepare/local

Configuring Github OAuth

Log in to RHSSO (see above) and click Identity Providers in the left sidebar. In the Github identity provider, find the Redirect URI and paste this URL into the Homepage URL and Authorization callback URL fields of your Github OAuth app.

Deploying to a Cluster with OLM

Make sure to export the variables above (see local setup), then run:

make cluster/prepare

Within a few minutes, the Integreatly operator should be visible in the OperatorHub (Catalog > OperatorHub). To create a new subscription, click on the Install button, choose to install the operator in the created namespace and keep the approval strategy on automatic.

Once the subscription shows a status of installed, a new Integreatly Installation custom resource can be created which will begin to install the supported products.

In Catalog > Developer Catalog, choose the Integreatly Installation and click create. An example installation CR can be found below:

apiVersion: integreatly.org/v1alpha1
kind: Installation
metadata:
  name: example-installation
spec:
  type: workshop
  namespacePrefix: integreatly-
  selfSignedCerts: true

Set up dedicated admins

To setup your cluster to have dedicated admins run the setup/dedicated target which installs the dedicated admin operator:

make setup/dedicated

If you want to remove the dedicated admin operator, run:

make clean/dedicated

Tests

Running unit tests:

make test/unit

Release

Update the operator version in the following files:

Update version/version.go (Version = "<version>")
Update TAG and PREVIOUS_TAG (the previous version) in the Makefile
Update the operator image version in deploy/operator.yaml (image: quay.io/integreatly/integreatly-operator:v<version>)
Generate a new CSV:

make gen/csv

Commit changes and open pull request. When the PR is accepted, create a new release tag:

git tag v<version> && git push upstream v<version>

davidffrench/integreatly-operator