pm-file-converter/README.md

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