Mercury Operator (Beta)

Prerequisites:

• Kafka operator installed (minimum Strimzi version 0.26.x or 0.27.x)
• Camel-K operator installed (version 1.8.x)

Mercury Resources

Service Domain Infrastructure

The ServiceDomainInfra custom resource represents a set of resources shared by one or many service domains.

e.g.

apiVersion: mercury.redhat.io/v1alpha1
kind: ServiceDomainInfra
metadata:
  name: example-service-domain-infra
spec:
  kafka:
    replicas: 3
    storage:
      type: persitent-claim
      size: 10Gi

Supported Kafka storage types are:

• persistent-claim
• ephemeral

You can create an example ServiceDomainInfra from the examples folder:

kubectl create -f examples/crs/service-domain-infra.yaml

Service Domain

The ServiceDomain custom resource represents an implementation of a specific Service Domain. It basically consists of a gRPC service, a deployment and a Kafka Topic managed by the operator. If external access is required then use the expose parameter, then, the operator will create the Camel-K resources needed to expose the service through the available endpoints.

At the moment only the http endpoint is supported.

apiVersion: mercury.redhat.io/v1alpha1
kind: ServiceDomain
metadata:
  name: example-customer-offer
  labels:
    service-domain: customer-offer
spec:
  businessImage: quay.io/ecosystem-appeng/customer-offer-example:v1.0.3
  serviceDomainInfra: service-domain-infra
  type: CUSTOMER_OFFER
  expose:
    http:
      api-version: v1

• businessImage - the image to create the service container from.
• serviceDomainInfra - the name of the service domain infra this service domain is a part of.
• type - the type of the service domain.
• expose - how to expose the service. It will use the api-version v1.

You can create an example ServiceDomain from the examples folder:

kubectl create -f examples/crs/example-customer-offer.yaml

Functionality

This operator is responsible for the deployment of the Mercury infrastructure and different services that will be part of a BIAN ecosystem.

• On ServiceDomainInfra object creation the operator will create a ``Kafka` broker.
• Upon the successful creation of the Kafka broker, its URL will be displayed in the Service Domain Infra status.
• On ServiceDomain object creation, the operator will create a Deployment, a Service and a Kafka Topic.
• If the ServiceDomain has to be exposed, it will also create the Camel-K integrations.

Preparation

Common

The following resources must be created where the integrations are going to be built only if you are using the development version.

• A configMap containing a Maven settings.

kubectl create cm mercury-mvn-settings --from-file=settings.xml=./deploy/config/camel-k/mercury-mvn-settings.xml

• An Integration Platform pointing to this configMap.

oc apply -f ./deploy/config/camel-k/integration-platform.yaml

On Minikube

You will require the registry addon and then create the IntegrationPlatform pointing to the local registry. Check the Camel-K documentation to set up a different registry

First extract the registry address:

export REGISTRY_ADDRESS=$(kubectl -n kube-system get service registry -o jsonpath='{.spec.clusterIP}')

Then use the existing integration platform definition with your internal registry configuration:

faq -f yaml -o yaml --args $REGISTRY_ADDRESS '.spec.build.registry = {address: $ARGS.positional[0], insecure: true}' ./deploy/config/camel-k/integration-platform.yaml | kubectl create -f -

On Openshift

Just create the integration platform:

kubectl apply -f ./deploy/config/camel-k/integration-platform.yaml

Simple Installation

The operator will be created in the mercury namespace so make sure the mercury namespace exists.

To install the operator run:

kubectl apply -n mercury -f ./deploy/

Installation with OLM

We have created a Catalog containing the Mercury Operator. You can install this catalog on the Operator Lifecycle Manager and then just create a Subscription via the user interface.

kubectl apply -n olm -f ./deploy/olm-catalog/1.0.3/catalog-source.yaml