Skip to content

dCache/wlcgConverter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 

Repository files navigation

WlcgConverter setup guide

Version: 1.1 (2024-02-12)

Important Note: dCache v9.2 is a minimum requirement for the successful operation of the wlcgConverter.
Additionally a running Apache Kafka installation is required. More information on configuring dCache for the use with Kafka can be found here.

The "wlcgConverter" is a software tool that converts "site"-formatted json billing records to wlcg-formatted json billing records (providing for new 'key:value' mappings in the converted records).
It is run as a systemd service on any linux machine, that has a network connection to Kafka brokers providing the billing records.
The tool also offers further functionalities, such as:

  • sending the converted data via an encrypted channel (provided that a certificate and key file have been configured)
  • ip filtering of configurable subnets, that are to be excluded from transmission

To establish an encrypted transmission channel, three essential things must be provided beforehand:

  • a DN has to be whitelisted at Cern (Mail your request together with a DN to: wlcgmon-tf@cern.ch)
  • a certificate file
  • a corresponding key file

Getting started

Before you can start using the "wlcgConverter" some prerequisites have to be met.

  1. Make sure you have python3 and the necessary python libraries installed.
  2. Fill in all obligatory information into the "wlcgConverter_config.yaml" configuration file.
  3. Place files from "wlcgConverterPackage" directory into specified locations.
  4. Start the service.

Python prerequisites

The following python packages must be installed on the machine running the wlcgConverter:

  • python3           #tested with version 3.6.8
  • stomp.py          #tested with version 8.1.0
  • PyYAML==5.4.1
  • python-dateutil       #tested with version 2.8.2
  • kafka-python        #tested with version 2.0.2

In case you DO NOT have these packages installed, run the following commands as root on the command line:

Depending on your linux distro, e.g.:

yum install python3
yum install python3-pip   

and then:

pip3 install stomp.py
pip3 install PyYAML==5.4.1
pip3 install python-dateutil 
pip3 install kafka-python

How to configure the "wlcgConverter" service

  • Please open the "wlcgConverter_config.yaml" file and provide the fields denoted with ''obligatory".
  • You may configure the ones denoted "optional " as well if needed.
  • Read the commentaries carefully. Since changing some optional fields may make others obligatory.
  • Please do not enter or change information in fields that do not have commentaries indicating to do so.

Where to locate the provided files

In the "wlcgConverterPackage" directory you will find 3 files. These must be copied to the following locations.
Run these commands as root from within the directory:

cp wlcgConverter  /usr/bin/
chmod 755 /usr/bin/wlcgConverter

cp wlcgConverter.service /etc/systemd/system/

mkdir /etc/wlcg_converter/
cp wlcgConverter_config.yaml  /etc/wlcg_converter/

How to start the wlcgConverter service

Run the following commands as root:

systemctl daemon-reload
systemctl start wlcgConverter.service 
systemctl status wlcgConverter.service 

The latter command simply outputs the status of the service. If the shown status is "active (running)", everything is working as expected.

Troubleshooting

Troubleshooting the service is best done with the information provided by the following command:

journalctl -u wlcgConverter.service

You can file an issue via github.

NOTE: A more convenient packaging option for this software tool is currently being developed. Any help and contribution regarding this is most appreciated.

License

This software is licensed under Apache License 2.0. Find more information here.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages