LibRdKafka Version 2.12-1 for VSI OpenVMS

Thank you for your interest in this port of the LibRdKafka API to VSI OpenVMS. The current release of LibRdKafka for OpenVMS is based on the 2.12.1 distribution.

LibRdKafka (https://github.com/edenhill/librdkafka) is a C/C++ library implementation of the Apache Kafka protocol and includes both producer and consumer support. Apache Kafka (https://kafka.apache.org/) is an open source message broker written in Java and Scala that aims to provide a unified, high-throughput, low-latency platform for handling real-time data feeds. LibRdKafka provides a portable C/C++ API that can be used by client applications to interact with the message broker.

This OpenVMS port of LibRdKafka includes all functionality provided by the open source 2.12.1 release.

Additional information about LibRdKafka and Apache Kafka can be found at https://github.com/edenhill/librdkafka and https://kafka.apache.org/.

VMS Software Inc. would like to acknowledge the work of Magnus Edenhill for the creation and ongoing evolution of LibRdKafka.

For details on new features and bug fixes included in this release, review the open source project home page (https://github.com/edenhill/librdkafka).

It should be noted that this release of LibRdKafka represents a significant version jump from the previous release of this library for VSI OpenVMS, with many additions to the API, as well as deprecations (in part driven by enhancements to Apache Kafka itself). A significant enhancement available in this release of LibRdKafka for VSI OpenVMS is the inclusion of support for authentication using SASL/SCRAM.

This release of LibRdKafka for OpenVMS also includes the KCAT utility – a generic producer and consumer command line utility for Apache Kafka (for details, see https://github.com/edenhill/kcat).

The kit you are receiving has been compiled and built using the operating system and compiler versions listed below. While it is highly likely that you will have no problems installing and using this kit on systems running higher versions of the products below, VSI does not recommend running the older versions.

It is assumed that the reader has a good knowledge of OpenVMS and software development in the OpenVMS environment.

It is recommended that developers read the documentation available in the LibRdKafka GitHub repository (https://github.com/edenhill/librdkafka) and examine the sample programs provided with the VSI LibRdKafka for OpenVMS kit before using the software.

The kit is provided as an OpenVMS PCSI kit that can be installed by a suitably privileged user using the following command:

$ PRODUCT INSTALL LIBRDKAFKA

The installation will then proceed as follows (output may differ slightly from that shown depending on architecture and other factors):

Performing product kit validation of signed kits ...

The following product has been selected:
    VSI X86VMS LIBRDKAFKA V2.12-1           Layered Product

Do you want to continue? [YES]

Configuration phase starting ...

You will be asked to choose options, if any, for each selected product and for any products that may be installed to satisfy software dependency requirements.

Configuring VSI X86VMS LIBRDKAFKA V2.12-1

    VMS Software Inc. & Magnus Edenhill

* This product does not have any configuration options.

Execution phase starting ...

The following product will be installed to destination:
    VSI X86VMS LIBRDKAFKA V2.12-1           DISK$X86SYS:[VMS$COMMON.]

Portion done: 0%...40%...90%...100%

The following product has been installed:
    VSI X86VMS LIBRDKAFKA V2.12-1           Layered Product

VSI X86VMS LIBRDKAFKA V2.12-1

    Post-installation tasks are required.


    To start librdkafka at system boot time, add the following lines 
    to SYS$MANAGER:SYSTARTUP_VMS.COM:

        $ file := SYS$STARTUP:LIBRDKAFKA$STARTUP.COM
        $ if f$search("''file'") .nes. "" then @'file'

    To stop Kafka at system shutdown, add the following lines to
    SYS$MANAGER:SYSHUTDWN.COM:

        $ file := SYS$STARTUP:LIBRDKAFKA$SHUTDOWN.COM
        $ if f$search("''file'") .nes. "" then @'file'

Maxjobs:         0  Fillm:       256  Bytlm:       128000
Maxacctjobs:     0  Shrfillm:      0  Pbytlm:           0
Maxdetach:       0  BIOlm:       150  JTquota:       4096
Prclm:          50  DIOlm:       150  WSdef:         4096
Prio:            4  ASTlm:       300  WSquo:         8192
Queprio:         4  TQElm:       100  WSextent:     16384
CPU:        (none)  Enqlm:      4000  Pgflquo:     256000

The directory LIBRDKAFKA$ROOT:[EXAMPLES] contains several simple example programs that can be used as a learning tool or as a source of inspiration. These examples can be compiled and linked using the provided build procedure (SAMPLES.COM). All examples are linked with the LIBRDKAFKA$SHR shareable image, although they could also be statically linked with the corresponding object library.