Skip to content

Latest commit

 

History

History
72 lines (56 loc) · 2.28 KB

README.md

File metadata and controls

72 lines (56 loc) · 2.28 KB
Raw

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.10 environment:

  • import catalog containing Service Telemetry and Smart Gateway Operators via OperatorSource file
  • install the Certificate Manager for OpenShift 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.

  • prometheusManifest
  • alertmanagerConfigManifest
  • alertmanagerManifest
  • elasticsearchSecretManifest
  • interconnectManifest
  • elasticsearchManifest
  • grafanaManifest
  • smartgatewayCollectdMetricsManifest
  • smartgatewayCollectdEventsManifest
  • smartgatewayCeilometerEventsManifest
  • servicemonitorManifest
  • scrapeconfigManifest

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 CodeReady Containers environment.

crc setup
crc config set memory 16384
crc config set enable-cluster-monitoring true
crc start
crc console --credentials
oc login -u kubeadmin https://api.crc.testing:6443

To deploy a local build of the Service Telemetry Operator itself, start by running ansible-playbook build/run-ci.yaml. If you have code to coordinate across the supporting InfraWatch repositories, you can pass the working_branch paramater to the --extra-vars flag like so:

ansible-playbook \
    --extra-vars working_branch="username-new_feature" \
    build/run-ci.yaml

Additional flags for overriding various branch and path names is documented in build/stf-run-ci/README.md.