Support for "addon" resources in syndesis-operator

For integrating with external systems (e.g. Prometheus, Grafana) it would be very valuable when the Syndesis operator would install arbitrary resources stored in a directory within the operator image.

A sample workflow would look like this:

• Within the Operator image, there is a directory /addons which can contain any possible Kubernetes resource in YAML foramt. This can also be also custom resources like a ServiceMonitor for the Prometheus Operator. The syndesis-operator build process should be modified to pick up those file from somewhere and put it into this directory.
• When the syndesis-operator is running and someone deploys a Syndesis resource, after the operator has installed syndesis, it checks this directory and for every resource found in this directory:
  • Adds an ownerReference to the Syndesis resource
  • Adds a label/annotation indicating that it has been installed on behalf of the operator (e.g. syndesis.io/addon-resource)
  • Applies this resource to the current namespace

This ensures, that when the Syndesis resources are deleted, also the addon resources are deleted.

The Installation of an Operator would do the following steps;

• The new operator gets started. During startup, and when it detects an upgrade situation (e.g. a Syndesis resource is already installed) it checks for all resources with a label `syndesis.io/addon-resource’ and then for each delete the resource.
• When an existing installation needs to be updated, just install the addon resources from the new operator image after the update process has finished.

@jamesnetherton @alexkieling @lgarciaaco I hope this summarizes our discussion accurately.

@heiko-braun this feature is requested by Integreatly so that Syndesis could be monitored by an external, integreatly provided Prometheus instance. Is there a way that we can schedule this work into one of our next releases ?

[astefanutti]

I’ve rebased the PR on top of #4460.

@heiko-braun I’ve changed the activation behaviour so that the --addons option must be explicitly set for the addons to be applied.

[chirino]

https://github.com/syndesisio/syndesis/pull/6256 Sydnesis 1.7 now changes how these addons are activated. You have to update the CR like this:

apiVersion: "syndesis.io/v1alpha1"
kind: "Syndesis"
metadata:
  name: app
spec:
  addons:
    ops:
      enabled: "true"