README.md

Communishift Authorization Operator

TODO: Introduction to what the CAO is.

Installation

Some notes about how to install the CommunishiftAuthorization Operator.

Requirements

Install the following dependencies, default versions in the f36 repos are fine.

  • golang
  • ansible
  • python-ansible-runner
  • python3-molecule

Install the operator-sdk, put it on your PATH:

git clone git@github.com:operator-framework/operator-sdk.git
cd operator-sdk
make

Openshift client oc, download and put it on your PATH: https://mirror.openshift.com/pub/openshift-v4/x86_64/clients/ocp/stable/openshift-client-linux.tar.gz

Download minikube, then put it on your PATH: curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64

Running the Operator locally against a cluster

First ensure you are logged into the cluster via the oc login --server=SERVER --token=TOKEN.

  • To install the CRD (custom resource definition) run make install
  • To install the RBAC (roles based access controls), deployments etc run make deploy
  • To run the operator locally run make run

Deploying the Operator to a cluster

First ensure you are logged into the cluster via the oc login --server=SERVER --token=TOKEN.

  • To install the CRD (custom resource definition) run make install
  • To install the RBAC (roles based access controls), deployments etc run make deploy

Testing

TODO: Some notes to explain how to run the molecule tests with minikube etc.

Contributing

TODO: Some notes about how to contribute to the development of the CommunishiftAuthorization Operator.

Licence

TODO: Notes about the licence covering the code etc

Resources