Install TMF Party Management Microservice
Perform this task to install the TM Forum (TMF) party management microservice implemented through TMF Gateway.
Before you begin
Procedure
-
Obtain the following TMF party management image and Helm chart and source these two resources in your own registries:
tmf-party-management-version-build.tar.sig
— The TMF party management microservice image.tmf-party-management-helm-chart-version-build.tgz
— The TMF party management Helm chart.
For information about obtaining images, see the discussion about obtaining and hosting images in MATRIXX Installation and Upgrade. -
Add the TMF MATRIXX Data Containers (MDCs) to the MATRIXX Engine configuration directly in the custom Helm values file for MATRIXX Engine.
Use a
configMap
typeconfigurationSources
, as shown in this example:global: image: registry: createSecret: false monitoring: enabled: true tracing: enabled: ${KTX_TELEMETRY_TEMPO_ENABLED} openTelemetry: endpoint: host: otel-collector-opentelemetry-collector.open-telemetry development: true configurationSources: examplePricing: docker: image: example-pricing-sideloader:${MTX_IMAGE_VERSION} engine-tmf-config: configmap: name: engine-tmf-config-20220907-1019 data: tmf_create_config.info: |- # Private MDC definitions Do you want to add any private MDCs (y/n)?y How many private MDCs do you want to add?25 Added MDC:00001:What is the container's name?TMFPartyUser Added MDC:00001:What is the container's key?-1 Added MDC:00001:What is the name of the base container (if any)?MtxUserExtension Added MDC:00001:What is the created schema version?2 Added MDC:00001:What is the deleted schema version?0 Added MDC:00002:What is the container's name? Attachment Added MDC:00002:What is the container's key?-2
Note: This example is not a complete MDC configuration. For details about all the MDCs and MDC fields to add, see the discussion about mapping TMF APIs to MDCs. -
Configure the TMF party management microservice using the Helm properties and values shown in the following example:
This includes configuring the TRA host and port and all the other custom values required for your installation. For descriptions of the TMF configuration properties, see the discussion about TMF Open API Gateway configuration.# Default values for tmf-party-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-party-management image name versionOverride: "" # Leave blank unless you want to use a different tmf-party-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-party-management service URL required to form the TMF response href
-
Create a namespace for the TMF microservices if it does not exist
already:
kubectl create ns matrixx-tmf
-
Install the TMF party management microservice in the TMF microservices namespace:
helm install tmf <YOUR_REGISTRY>/tmf-party-management --version release-version -f TMF-CUSTOM-VALUES-FILE -n matrixx-tmf