Kafka CDS Events

The Kafka Integration is a Self-Service integration that can be configured on a CDS Project. If you are a CDS Administrator, you can configure this integration to be available on all CDS Projects.

An example of use case could be that you want to generate some svg badge. Then you can just add an event integration for your workflow and plug the badge microservice on this kafka topic.

Notice that Kafka communication is done using SASL and TLS enable only.

Configure with WebUI

You can add a Kafka Integration on your CDS Project.

Configure with cdsctl

Import a Kafka Integration on your CDS Project

Create a file project-configuration.yml:

name: your-kafka-integration
model:
  name: Kafka
  identifier: github.com/ovh/cds/integration/builtin/kafka
  event: true
config:
  broker url:
    value: n1.o1.your-broker:9093,n2.o1.n1.o1.your-broker:9093,n3.o1.n1.o1.your-broker:9093
    type: string
  password:
    value: "**********"
    type: password
  username:
    value: kafka-username
    type: string
  topic:
    value: your-topic
    type: string
  version:
    value: "2.1.1"
    type: string

Import the integration on your CDS Project with:

cdsctl project integration import PROJECT_KEY project-configuration.yml

Then, as a standard user, you can use your kafka integration for workflow notifications.

One Integration, two use case

You can use an integration kafka for two use cases: Event and Hooks. Example of file public-configuration.yml:

name: your-kafka-integration
event: true
hook: true
public: true

SASL / TLS

For testing purpose only, you can disable TLS / SASL with the disableTLS and disableSASL attributes.

Example of Public Integration with TLS and SASL disabled:

name: myPublicKafkaIntegration
event: true
public: true
public_configurations:
  myPublicKafkaIntegration:
    "broker url":
      type: string
      value: "localhost:9092"
    "topic":
      type: string
      value: "test.eventspublic"
    "disableTLS":
      type: string
      value: "true"
    "disableSASL":
      type: string
      value: "true"
    version:
      value: "2.1.1"
      type: string

Kafka Version

If the attribute version could be not defined, default value is 0.10.0.1