Skip to content
No description, website, or topics provided.
Go Makefile Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
bundle
cmd/manager
deploy
pkg
version
.gitignore
.osdk-scorecard.yaml
API.md
Makefile
README.md
go.mod
go.sum
tools.go

README.md

container-jfr-operator

A Kubernetes Operator to automate deployment of Container-JFR and provide an API to manage JDK Flight Recordings.

Using

Once deployed, the containerjfr instance can be accessed via web browser at the URL provided by oc get pod -l kind=containerjfr -o jsonpath='http://{$.items[0].metadata.annotations.redhat\.com/containerJfrUrl} '

Building

Requirements

Instructions

make image will create an OCI image to the local registry, tagged as quay.io/rh-jmc-team/container-jfr-operator. This tag can be overridden by setting the environment variable IMAGE_TAG.

To (re)build the Operator bundle for packaging in catalogs (ex. OperatorHub), use operator-courier, ex. operator-courier push bundle rh-jmc-team container-jfr-operator-bundle $VERSION $TOKEN , where $VERSION is the version string matching that within the bundle definition YAMLs, and $TOKEN has been replaced by your personal quay.io access token.

To make this bundle available within the OpenShift Console's Operator Catalog, add the custom Operator Source via oc apply -f bundle/openshift/operator-source.yaml

Setup / Deployment

UI-Guided Deployment

The operator can be deployed using the Operator Marketplace in the graphical OpenShift console by first adding a custom operator source. A YAML definition of such a custom source is at bundle/openshift/operator-source.yaml, which can be added to your cluster by oc create -f bundle/openshift/operator-source.yaml or simply make catalog. This method allows the latest released version of the operator to be installed into the cluster with the same method and in the same form that end users would receive it.

Configuration

Once deployed, the operator deployment will be active in the cluster, but no ContainerJFR instance will be created. To trigger its creation, add a ContainerJFR CR using the UI for operator "provided APIs". The spec field of the CR must contain the boolean property minimal: true|false. A full deployment includes ContainerJFR itself and its web client assets, as well as jfr-datasource and Grafana containers within the pod. A minimal deployment uses a ContainerJFR image with the web client assets removed and excludes the jfr-datasource and Grafana containers, resulting in a ContainerJFR deployment that can only be used headlessly and which consumes as few cluster resources as possible.

Manual Deployment

make deploy will deploy the operator using oc to whichever OpenShift cluster is configured with the local client. This also respects the IMAGE_TAG environment variable, so that different versions of the operator can be easily deployed.

Development

An invocation like export IMAGE_TAG=quay.io/some-user/container-jfr-operator make clean image && podman image push $IMAGE_TAG && make deploy is handy for local development testing using ex. CodeReady Containers.

Testing

Requirements

Instructions

make test will run the automated tests. This requires an OpenShift 4 cluster to be available and logged in with your oc OpenShift Client. The recommended setup for development testing is CodeReady Containers (crc).

Before the tests are run, all container-jfr and container-jfr-operator resources will be deleted to ensure a clean slate.

You can’t perform that action at this time.