Chapter 3. Installing the core components of Service Telemetry Framework

Procedure

1. Log in to your Red Hat OpenShift Container Platform environment where STF is hosted.

2. To store metrics in Prometheus, enable the Cluster Observability Operator by using the redhat-operators CatalogSource:

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

3. Verify that the ClusterServiceVersion for Cluster Observability Operator has a status of Succeeded:

   $ oc wait --for jsonpath="{.status.phase}"=Succeeded csv --namespace=openshift-operators -l operators.coreos.com/cluster-observability-operator.openshift-operators
   
   clusterserviceversion.operators.coreos.com/observability-operator.v0.0.26 condition met

Procedure

1. Log in to your Red Hat OpenShift Container Platform environment where STF is hosted.

2. Verify cert-manager is not already installed on the Red Hat OpenShift Container Platform cluster. If any results are returned, do not install another instance of cert-manager:

   $ oc get sub --all-namespaces -o json | jq '.items[] | select(.metadata.name | match("cert-manager")) | .metadata.name'

3. Create a namespace for the cert-manager Operator:

   $ oc create -f - <<EOF
   apiVersion: project.openshift.io/v1
   kind: Project
   metadata:
     name: cert-manager-operator
   spec:
     finalizers:
     - kubernetes
   EOF

4. Create an OperatorGroup for the cert-manager Operator:

   $ oc create -f - <<EOF
   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: cert-manager-operator
     namespace: cert-manager-operator
   spec:
     targetNamespaces:
     - cert-manager-operator
     upgradeStrategy: Default
   EOF

5. Subscribe to the cert-manager Operator by using the redhat-operators CatalogSource:

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

6. Validate your ClusterServiceVersion. Ensure that cert-manager Operator displays a phase of Succeeded:

   oc wait --for jsonpath="{.status.phase}"=Succeeded csv --namespace=cert-manager-operator --selector=operators.coreos.com/openshift-cert-manager-operator.cert-manager-operator
   
   clusterserviceversion.operators.coreos.com/cert-manager-operator.v1.12.1 condition met

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. 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.5
     installPlanApproval: Automatic
     name: service-telemetry-operator
     source: redhat-operators
     sourceNamespace: openshift-marketplace
   EOF

4. Validate the Service Telemetry Operator and the dependent operators have their phase as Succeeded:

   $ oc wait --for jsonpath="{.status.phase}"=Succeeded csv --namespace=service-telemetry -l operators.coreos.com/service-telemetry-operator.service-telemetry ; oc get csv --namespace service-telemetry
   
   clusterserviceversion.operators.coreos.com/service-telemetry-operator.v1.5.1700688542 condition met
   
   NAME                                         DISPLAY                                  VERSION          REPLACES                             PHASE
   amq7-interconnect-operator.v1.10.17          Red Hat Integration - AMQ Interconnect   1.10.17          amq7-interconnect-operator.v1.10.4   Succeeded
   observability-operator.v0.0.26               Cluster Observability Operator           0.1.0                                                 Succeeded
   service-telemetry-operator.v1.5.1700688542   Service Telemetry Operator               1.5.1700688542                                        Succeeded
   smart-gateway-operator.v5.0.1700688539       Smart Gateway Operator                   5.0.1700688539                                        Succeeded

Procedure

1. Edit the ServiceTelemetry object:

   $ oc edit stf default

2. Set the value of the backends.metrics.prometheus.enabled parameter to true:

   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     name: default
     namespace: service-telemetry
   spec:
     [...]
     backends:
       metrics:
         prometheus:
           enabled: true

Procedure

1. List the available storage classes:

   $ oc get storageclasses
   NAME                 PROVISIONER                RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
   csi-manila-ceph      manila.csi.openstack.org   Delete          Immediate              false                  20h
   standard (default)   kubernetes.io/cinder       Delete          WaitForFirstConsumer   true                   20h
   standard-csi         cinder.csi.openstack.org   Delete          WaitForFirstConsumer   true                   20h

2. Edit the ServiceTelemetry object:

   $ oc edit stf default

3. Set the value of the backends.metrics.prometheus.enabled parameter to true and the value of backends.metrics.prometheus.storage.strategy to persistent:

   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     name: default
     namespace: service-telemetry
   spec:
     [...]
     backends:
       metrics:
         prometheus:
           enabled: true
           storage:
             strategy: persistent
             persistent:
               storageClass: standard-csi
               pvcStorageRequest: 50G

Procedure

1. Edit the ServiceTelemetry object:

   $ oc edit stf default

2. Set the value of the backends.events.elasticsearch.enabled parameter to true and configure the hostUrl with the relevant Elasticsearch instance:

   apiVersion: infra.watch/v1beta1
   kind: ServiceTelemetry
   metadata:
     name: default
     namespace: service-telemetry
   spec:
     [...]
     backends:
       events:
         elasticsearch:
           enabled: true
           forwarding:
             hostUrl: https://external-elastic-http.domain:9200
             tlsServerName: ""
             tlsSecretName: elasticsearch-es-cert
             userSecretName: elasticsearch-es-elastic-user
             useBasicAuth: true
             useTls: true

3. Create the secret named in the userSecretName parameter to store the basic auth credentials

   $ oc create secret generic elasticsearch-es-elastic-user --from-literal=elastic='<PASSWORD>'

4. Copy the CA certificate into a file named EXTERNAL-ES-CA.pem, then create the secret named in the tlsSecretName parameter to make it available to STF

   $ cat EXTERNAL-ES-CA.pem
   -----BEGIN CERTIFICATE-----
   [...]
   -----END CERTIFICATE-----
   
   $ oc create secret generic elasticsearch-es-cert --from-file=ca.crt=EXTERNAL-ES-CA.pem