Chapter 3. Installing the core components of Service Telemetry Framework

Procedure

1. Create a namespace to contain the STF components, for example, service-telemetry:

   $ oc new-project service-telemetry

2. Create an OperatorGroup in the namespace so that you can schedule the Operator pods:

   $ oc create -f - <<EOF
   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: service-telemetry-operator-group
     namespace: service-telemetry
   spec:
     targetNamespaces:
     - service-telemetry
   EOF

   For more information, see OperatorGroups.

3. Enable the OperatorHub.io Community Catalog Source to install data storage and visualization Operators:

   Warning

   Red Hat supports the core Operators and workloads, including AMQ Interconnect, AMQ Certificate Manager, Service Telemetry Operator, and Smart Gateway Operator. Red Hat does not support the community Operators or workload components, inclusive of ElasticSearch, Prometheus, Alertmanager, Grafana, and their Operators.

   $ oc create -f - <<EOF
   apiVersion: operators.coreos.com/v1alpha1
   kind: CatalogSource
   metadata:
     name: operatorhubio-operators
     namespace: openshift-marketplace
   spec:
     sourceType: grpc
     image: quay.io/operatorhubio/catalog:latest
     displayName: OperatorHub.io Operators
     publisher: OperatorHub.io
   EOF

4. Subscribe to the AMQ Certificate Manager Operator by using the redhat-operators CatalogSource:

   Note

   The AMQ Certificate Manager deploys to the openshift-operators namespace and is then available to all namespaces across the cluster. As a result, on clusters with a large number of namespaces, it can take several minutes for the Operator to be available in the service-telemetry namespace. The AMQ Certificate Manager Operator is not compatible with the dependency management of Operator Lifecycle Manager when you use it with other namespace-scoped operators.

   $ oc create -f - <<EOF
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: amq7-cert-manager-operator
     namespace: openshift-operators
   spec:
     channel: 1.x
     installPlanApproval: Automatic
     name: amq7-cert-manager-operator
     source: redhat-operators
     sourceNamespace: openshift-marketplace
   EOF

5. Validate your ClusterServiceVersion. Ensure that amq7-cert-manager.v1.0.1 displays a phase of Succeeded:

   $ oc get --namespace openshift-operators csv
   
   NAME                       DISPLAY                                         VERSION   REPLACES                   PHASE
   amq7-cert-manager.v1.0.3   Red Hat Integration - AMQ Certificate Manager   1.0.3     amq7-cert-manager.v1.0.2   Succeeded

6. If you plan to store events in ElasticSearch, you must enable the Elastic Cloud on Kubernetes (ECK) Operator. To enable the ECK Operator, create the following manifest in your Red Hat OpenShift Container Platform environment:

   $ oc create -f - <<EOF
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: elasticsearch-eck-operator-certified
     namespace: service-telemetry
   spec:
     channel: stable
     installPlanApproval: Automatic
     name: elasticsearch-eck-operator-certified
     source: certified-operators
     sourceNamespace: openshift-marketplace
   EOF

7. Verify that the ClusterServiceVersion for Elastic Cloud on Kubernetes Succeeded:

   $ oc get csv
   
   NAME                                          DISPLAY                        VERSION   REPLACES                                     PHASE
   ...
   elasticsearch-eck-operator-certified.1.9.1   Elasticsearch (ECK) Operator                    1.9.1                                Succeeded
   ...

8. Create the Smart Gateway Operator subscription to manage the Smart Gateway instances:

   $ oc create -f - <<EOF
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: smart-gateway-operator
     namespace: service-telemetry
   spec:
     channel: stable-1.3
     installPlanApproval: Automatic
     name: smart-gateway-operator
     source: redhat-operators
     sourceNamespace: openshift-marketplace
   EOF

9. Create the Service Telemetry Operator subscription to manage the STF instances:

   $ oc create -f - <<EOF
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: service-telemetry-operator
     namespace: service-telemetry
   spec:
     channel: stable-1.3
     installPlanApproval: Automatic
     name: service-telemetry-operator
     source: redhat-operators
     sourceNamespace: openshift-marketplace
   EOF

10. Validate the Service Telemetry Operator and the dependent operators:

    $ oc get csv --namespace service-telemetry
    
    NAME                                         DISPLAY                                         VERSION          REPLACES                             PHASE
    amq7-cert-manager.v1.0.3                     Red Hat Integration - AMQ Certificate Manager   1.0.3            amq7-cert-manager.v1.0.2             Succeeded
    amq7-interconnect-operator.v1.10.5           Red Hat Integration - AMQ Interconnect          1.10.5           amq7-interconnect-operator.v1.10.4   Succeeded
    elasticsearch-eck-operator-certified.1.9.1   Elasticsearch (ECK) Operator                    1.9.1                                                 Succeeded
    prometheusoperator.0.47.0                    Prometheus Operator                             0.47.0           prometheusoperator.0.37.0            Succeeded
    service-telemetry-operator.v1.3.1635451892   Service Telemetry Operator                      1.3.1635451892                                        Succeeded
    smart-gateway-operator.v3.0.1635451893       Smart Gateway Operator                          3.0.1635451893                                        Succeeded

Procedure

1. To create a ServiceTelemetry object that results in an STF deployment that uses the default values, create a ServiceTelemetry object with an empty spec parameter:

   $ oc apply -f - <<EOF
   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     name: default
     namespace: service-telemetry
   spec: {}
   EOF

   To override a default value, define the parameter that you want to override. In this example, enable ElasticSearch by setting enabled to true:

   $ oc apply -f - <<EOF
   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     name: default
     namespace: service-telemetry
   spec:
     backends:
       events:
         elasticsearch:
           enabled: true
   EOF

   Creating a ServiceTelemetry object with an empty spec parameter results in an STF deployment with the following default settings:

   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     name: default
   spec:
     alerting:
       alertmanager:
         storage:
           persistent:
             pvcStorageRequest: 20G
             storageSelector: {}
           receivers:
             snmpTraps:
               enabled: false
               target: 192.168.24.254
           strategy: persistent
       enabled: true
     backends:
       events:
         elasticsearch:
           enabled: false
           storage:
             persistent:
               pvcStorageRequest: 20Gi
               storageSelector: {}
             strategy: persistent
       metrics:
         prometheus:
           enabled: true
           scrapeInterval: 10s
           storage:
             persistent:
               pvcStorageRequest: 20G
               storageSelector: {}
             retention: 24h
             strategy: persistent
     graphing:
       enabled: false
       grafana:
         adminPassword: secret
         adminUser: root
         disableSignoutMenu: false
         ingressEnabled: false
         baseImage: docker.io/grafana/grafana:8.1.2
     highAvailability:
       enabled: false
     transports:
       qdr:
         enabled: true
         web:
           enabled: false
     clouds:
       - name: cloud1
         metrics:
           collectors:
             - collectorType: collectd
               subscriptionAddress: collectd/telemetry
               debugEnabled: false
             - collectorType: ceilometer
               subscriptionAddress: anycast/ceilometer/metering.sample
               debugEnabled: false
             - collectorType: sensubility
               subscriptionAddress: sensubility/telemetry
               debugEnabled: false
         events:
           collectors:
             - collectorType: collectd
               subscriptionAddress: collectd/notify
               debugEnabled: false
             - collectorType: ceilometer
               subscriptionAddress: anycast/ceilometer/event.sample
               debugEnabled: false

   To override these defaults, add the configuration to the spec parameter.

2. View the STF deployment logs in the Service Telemetry Operator:

   $ oc logs --selector name=service-telemetry-operator
   
   ...
   --------------------------- Ansible Task Status Event StdOut  -----------------
   
   PLAY RECAP *********************************************************************
   localhost                  : ok=57   changed=0    unreachable=0    failed=0    skipped=20   rescued=0    ignored=0

Procedure

1. Deleting the namespace.
2. Removing the catalog source.