kafkasub

README

tibco-kafkasub

This trigger provides your flogo application with the ability to subscribe to messages from a kafka cluster and start a flow with the contents of the message. It is assumed that the messages plain text. The trigger supports TLS and SASL.
To make a TLS connection specifiy a trust dir containing the caroots for your kafka server and a broker URL which points to an SSL port. To use SASL simply provide the username and password in the settings config.

Installation

flogo install github.com/TIBCOSoftware/flogo-contrib/trigger/kafkasub

Schema

Settings, Outputs and Endpoint:

{
 "settings":[
    {
      "name": "BrokerUrl",
      "type": "string"
    },
    {
      "name": "user",
      "type": "string"
    },
    {
      "name": "password",
      "type": "string"
    },
    {
      "name": "truststore",
      "type": "string"
    }

  ],
  "outputs": [
    {
      "name": "message",
      "type": "string"
    }
  ],
  "handler": {
    "settings": [
      {
        "name": "Topic",
        "type": "string"
      },
      {
        "name": "partitions",
        "type": "string"
      },
      {
        "name": "group",
        "type": "string"
      },
      {
        "name": "offset",
        "type": "int"
      },
    ]
  }

Example Configurations

This example flow subscribes to the syslog subject of bilbo's kafka server using a plain text connection with no authentication.

{
  "name": "testkafka",
  "type": "flogo:app",
  "version": "0.0.1",
  "description": "My flogo application description",
  "triggers": [
    {
      "id": "my_kafka_trigger",
      "ref": "github.com/TIBCOSoftware/flogo-contrib/trigger/kafkasub",
      "settings": {
        "BrokerUrl": "bilbo:9092"
      },
      "handlers": [
        {
          "actionId": "my_simple_flow",
          "settings": {
            "Topic": "syslog"
          }
        }
      ]
    }
  ],
  "actions": [
    {
      "id": "my_simple_flow",
      "ref": "github.com/TIBCOSoftware/flogo-contrib/action/flow",
      "data": {
        "flow": {
          "attributes": [],
          "rootTask": {
            "id": 1,
            "type": 1,
            "tasks": [
              {
                "id": 2,
                "type": 1,
                "activityRef": "github.com/TIBCOSoftware/flogo-contrib/activity/log",
                "name": "log",
                "attributes": [
                  {
                    "name": "message",
                    "value": "Simple Log",
                    "type": "string"
                  }
                ],
                "inputMappings": [
                  {
                    "type": 1,
                    "value": "{T.message}",
                    "mapTo": "message"
                  }
                ]
              }
            ],
            "links": []
          }
        }
      }
    }
  ]
}```


To connect to a TLS port on a kafka cluster member:

  "triggers": [
    {
      "id": "my_kafka_trigger",
      "ref": "github.com/TIBCOSoftware/flogo-contrib/trigger/kafkasub",
      "settings": {
        "BrokerUrl": "bilbo:9093",
        "truststore": "/opt/kafka/kafka_2.11-0.10.2.0/keys/trust"
      },
      "handlers": [
        {
          "actionId": "my_simple_flow",
          "settings": {
            "Topic": "syslog"
          }
        }
      ]
    }
  ],
In this scenario the kafka server on bilbo is running TLS on port 9093.  The CACert used to sign the server's certificate has been copied to the truststore directory to allow clients to connect.  At this time mutual auth is not implemented.



To connect to a port on a kafka cluster where SASL authorization is enabled

  "triggers": [
    {
      "id": "my_kafka_trigger",
      "ref": "github.com/TIBCOSoftware/flogo-contrib/trigger/kafkasub",
      "settings": {
        "BrokerUrl": "bilbo:9094",
        "user": "foo",
        "password": "bar"
      },
      "handlers": [
        {
          "actionId": "my_simple_flow",
          "settings": {
            "Topic": "syslog"
          }
        }
      ]
    }
  ],
In this scenario the kafka server on bilbo is running SASL enabled port 9094. The user and password will be used to authenticate the user.

Documentation

Index

• func NewFactory(md *trigger.Metadata) trigger.Factory
• type KafkaSubTrigger
  • func (t *KafkaSubTrigger) Init(runner action.Runner)
  • func (t *KafkaSubTrigger) Metadata() *trigger.Metadata
  • func (t *KafkaSubTrigger) Start() error
  • func (t *KafkaSubTrigger) Stop() error
• type KafkasubFactory
  • func (t *KafkasubFactory) New(config *trigger.Config) trigger.Trigger

Functions

func NewFactory

func NewFactory(md *trigger.Metadata) trigger.Factory

NewFactory create a new Trigger factory

Types

type KafkaSubTrigger

type KafkaSubTrigger struct {
	// contains filtered or unexported fields
}

MqttTrigger is simple MQTT trigger

func (*KafkaSubTrigger) Init

func (t *KafkaSubTrigger) Init(runner action.Runner)

Init implements ext.Trigger.Init

func (*KafkaSubTrigger) Metadata

func (t *KafkaSubTrigger) Metadata() *trigger.Metadata

Metadata implements trigger.Trigger.Metadata

func (*KafkaSubTrigger) Start

func (t *KafkaSubTrigger) Start() error

Start implements ext.Trigger.Start

func (*KafkaSubTrigger) Stop

func (t *KafkaSubTrigger) Stop() error

Stop implements ext.Trigger.Stop

type KafkasubFactory

type KafkasubFactory struct {
	// contains filtered or unexported fields
}

KafkasubFactory Kafka subscriber Trigger factory

func (*KafkasubFactory) New

func (t *KafkasubFactory) New(config *trigger.Config) trigger.Trigger

New Creates a new trigger instance for a given id