pm-file-converter/README.md

   1
   2 ## PM Data Producer
   3
   4 The latest documentation can be found here:
   5 https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/latest/pm-file-converter/index.html
   6
   7
   8 The comonent is part of the RAM PM use case, which is described here:
   9 https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric-plt-ranpm/en/latest/overview.html#overview
  10
  11 ### Manual build, tag and push to image repo
  12
  13 Build for docker or local kubernetes\
  14 `./build.sh no-push`
  15
  16 Build for remote kubernetes - an externally accessible image repo (e.g. docker hub) is needed  \
  17 `./build.sh <external-image-repo>`
  18
  19 ### Function
  20
  21 Producer supporting data types for pm xml to json conversion, pm json filtering with output to kafka or influx db.
  22
  23 ### Configuration
  24
  25 The app expects the following environment variables:
  26
  27 - CREDS_GRANT_TYPE :  Grant type (keycloak)
  28 - CREDS_CLIENT_SECRET: Client secret (keycloak)
  29 - CREDS_CLIENT_ID : Client id (keycloak)
  30 - AUTH_SERVICE_URL : Url to keycloak for fetching tokens
  31 - KAFKA_SERVER : Host and port to kafka bootstrap server
  32 - ICS : Host and port to the Information Coordination Service
  33 - SELF: Host and port of this app
  34
  35 The following env vars are optional
  36 FILES_VOLUME : Path to persistent file storage (optional)
  37 FILESTORE_USER : Minio filestore user
  38 FILESTORE_PWD : Minio filestore password
  39 FILESTORE_SERVER: Host and port of the minio filestore
  40 KP : Id of the app
  41
  42 The app can be configured to read file from a mounted file system or from a filestore server (minio).
  43
  44 Mounted files:
  45 Configure ´FILES_VOLUME´ and leave var starting with FILESTORE empty.
  46
  47 Filestore:
  48 Configure env var starting with FILESTORE and leave ´FILES_VOLUME´empty.
  49
  50
  51
  52 ## License
  53
  54 Copyright (C) 2023 Nordix Foundation. All rights reserved.
  55 Licensed under the Apache License, Version 2.0 (the "License");
  56 you may not use this file except in compliance with the License.
  57 You may obtain a copy of the License at
  58
  59      http://www.apache.org/licenses/LICENSE-2.0
  60
  61 Unless required by applicable law or agreed to in writing, software
  62 distributed under the License is distributed on an "AS IS" BASIS,
  63 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  64 See the License for the specific language governing permissions and
  65 limitations under the License.