Redis sink Connector, version 0.9.1

Redis

If you already have a publicly accessible deployment of Redis, you can skip ahead and Configure and install a connector, using the Axual Self-Service UI. Use the configuration instructions below.
If you don’t have one available, the following section instructs you to deploy a publicly available instance of Redis.

The Redis Kafka Connector mentioned in this document is currently in Early Access. As such, it is subject to potential changes in configuration and functionality in future releases. Please refer to the official Redis Kafka Connector documentation here for the most current information and updates.

Deploying a Redis instance

  1. Sign up for a free trial account with Redis Cloud. You can simply sign up with Google.
    Click "Let’s start free". A Redis instance will be created for you.

  2. Go to the Subscriptions page. There should be a database created.

  3. Click the database .
    A detail page will open.

    • Note down the Username. We’ll use it later when configuring the Connector-Application, for the redis.username property.

    • Scroll down until the Default user password field. Click the Copy button next to the password.
      Note down the password. We’ll use it later when configuring the Connector-Application, for the redis.password property.

Configuring a new sink Connector

  1. Follow the Creating streams documentation in order to create one stream and deploy it onto an environment.
    The name of the stream will be my_redis_stream.
    The key/value types will be JSON/JSON.

  2. Produce some data as JSON/JSON events to this stream.
    It’s not important what message-key you use: we only care about the value.

  3. Follow the Configure and install a connector documentation to set up a new Connector-Application.
    Let’s call it my_redis_sink.
    The plugin name is com.redis.kafka.connect.RedisSinkConnector.
    If a plugin isn’t available, ask a platform operator to install plugins.

  4. Provide the following minimal configuration in order to connect to the previously configured Redis instance.
    For advanced configuration, see the official sink connector documentation.

    topics

    my_redis_stream

    connect.redis.uri
    Specify the Redis URI in the redis.uri property For complete Redis URI syntax see Redis URI Syntax

    Example value:
    redis://[username]:[password]@redis-18275.c56.east-us.azure.redns.redis-cloud.com:18275

    connect.redis.password
    The password for the default user, which you noted down at the beginning.

    Example value:
    1234567890ABCDefghijklmnopqrstuvwxyz

    connect.redis.username
    The username for the default user, which you noted down at the beginning

    Example value:
    default

  5. Authorize the my_redis_sink sink Connector-Application to consume the my_redis_stream stream.

  6. You can now start the sink Connector-Application.

  7. You can check if the events you produced to kafka made their way into Redis by checking the database dashboard in your browser.

    • Open the Databases page and click your database.

    • Click the Metrics tab.

    • Look for the graph titled Total keys. You should see that number increase from zero.

Cleanup

Once you are done, stop the Connector-Application and cleanup the unused axual resources.

Cleanup of Redis resources:

  1. Go to the Subscriptions page and scroll down to the Danger zone. Expand it.

  2. Delete database: Click the Delete button.

  3. When prompted, select Delete both in order to delete both the database and your subscription.

License

Redis sink-Connector is licensed under the Apache License, Version 2.0.

Source code

The source code for the Connect-Plugin can be found at https://github.com/redis-field-engineering/redis-kafka-connect.