service-telemetry-operator
Umbrella Operator to instantiate all required components for Service Telemetry Framework.
Getting Started
You'll need to do the following steps in order to load the prerequisites for deploying to an OpenShift 4.x environment:
- import catalog containing Service Telemetry and Smart Gateway Operators via OperatorSource file
- install the AMQ Certificate Manager Operator before installing Service Telemetry Operator
- install the Service Telemetry Operator
Starting up Service Telemetry
In the OperatorHub, select "Service Telemetry Operator" and install it. You can use the defaults.
Once the Service Telemetry Operator is available in the Installed Operators page, select Service Telemetry Operator and select Create instance within the STF Cluster box under Provided APIs. Then press Create.
Overriding Default Manifests
The following variables can be passed to a new instance of STF Cluster (kind: ServiceTelemetry) via the YAML configuration to override the default manifests loaded for you.
- prometheus_manifest
- alertmanager_config_manifest
- alertmanager_manifest
- elasticsearch_secret_manifest
- interconnect_manifest
- elasticsearch_manifest
- smartgateway_metrics_manifest
- smartgateway_events_manifest
- servicemonitor_manifest
Development
The quickest way to start up Service Telemetry Framework for development is to
run the quickstart.sh
script located in the deploy/
directory after starting
up a Code Ready Containers environment.
To deploy a local build of the Service Telemetry Operator itself, start by
running build/build_ci.sh
. Once that's done, you can test new builds of the
core operator code like this:
./build/build.sh &&\
./build/push_container2ocp.sh &&\
oc delete po -l name=service-telemetry-operator
Tech Preview
See the official documentation for more information about installing for production-style use cases on OCP3.
Please use the legacy saf-ocp3 branch for all such installations.
CI
Travis
- Runs OLM and Ansible linting
Hybrid DIY CI
- We run an internal CI server that smoketests builds and publishes the results
- WIP - Not fully implemented yet