Install TMF Usage Consumption Management Microservice

Perform this task to install the TM Forum (TMF) usage consumption management microservice implemented through TMF Gateway.

Before you begin

The TMF service activation and configuration microservice communicates with MATRIXX Engine through Traffic Routing Agent (TRA), so you must identify the host and port that the microservice uses to communicate with the TRA.

Note: This microservice does not require any extension to your MATRIXX Engine configuration.

Procedure

Obtain the following TMF usage consumption management image and Helm chart and source these two resources in your own registry:
- tmf-usage-consumption-management-version-build.tar.sig — The TMF usage consumption management microservice image.
- tmf-usage-consumption-management-helm-chart-version-build.tgz — The TMF usage consumption management Helm chart.
For information about obtaining images, see the discussion about obtaining and hosting images in MATRIXX Installation and Upgrade.

Configure the TMF usage consumption management microservice (including the TRA host and port) in your Helm values file as shown in the following example:

# Default values for tmf-usage-consumption-management.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.
 
registry:
  name: <YOUR_IMAGES_REGISTRY_URL>
  username: <YOUR_IMAGES_REGISTRY_LOGIN_USER>  password: <YOUR_IMAGES_REGISTRY_LOGIN_PASSWORD>  
  pullPolicy: Always
  pullSecretName: <REGISTRY_SECRET_NAME>
  createSecret: true
image:
  nameOverride: "" # Leave blank unless you want to use a different tmf-usage-consumption-management image name
  versionOverride: "" # Leave blank unless you want to use a different tmf-usage-consumption-management image name
replicaCount: 1
resources:
  limits:
    memory: 1024Mi
env:
  LOG_LEVEL: DEBUG
  engine.host: <TRA_HOST>
  engine.port: <TRA_PORT>
  http.instances: 4
  http.oauth2.enable: false # Set to true to add OAuth authentication
  http.oauth2.clientId: my-client # Add your OAuth client id
  http.oauth2.clientSecret: secret # Add your OAuth client secret
  http.oauth2.site: http://hydra:4445 # Add your OAuth URL
  http.oauth2.introspectionPath: /oauth2/introspect # Add your OAuth introspection path
  http.serviceUrl: http://tmf-service:8080 # Configure your tmf-usage-consumption-management service URL required to form the TMF response href

Create the matrixx-tmf namespace:
kubectl create ns matrixx-tmf
Install the TMF usage consumption management microservice in the matrixx-tmf namespace:
helm install tmf <YOUR_REGISTRY>/tmf-usage-consumption-management --version release-version -f <TMF677-CUSTOM-VALUES-FILE> -n matrixx-tmf