Confluent Kafka REST Proxy Spoke

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read

    • Integrates your ServiceNow instances with the Kafka cluster through Confluent Kafka REST Proxy API.

    Request apps on the Store

    Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    Integration Hub subscription

    This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.

    Supported versions

    This spoke was built for Confluent REST Proxy API v2.

    Spoke dependencies

    If you’re having trouble installing the app, ensure that the dependent plugin, ServiceNow IntegrationHub Runtime (com.glide.hub.integration.runtime) is installed.

    Note:
    The plugin is a licensable feature and requires appropriate licenses, if used outside the spoke implementation.

    Spoke actions

    The Confluent Kafka REST Proxy spoke provides actions to automate tasks when events occurs in your ServiceNow instance. Available actions include:

    Action Description
    Assign Consumer Instance to Topic Partition Assigns a list of partitions to this consumer manually.
    Commit Consumer Offsets Commits a list of offsets for the consumer. When the post body is empty, all the records that have been fetched by the consumer instance are committed.
    Create a Consumer Instance within a Consumer Group Creates a consumer instance within Kafka consumer group.
    Delete Consumer Instance Destroys the consumer instance.
    Get Kafka Partition Details For A Topic Retrieves partition details for a Kafka topic.
    Get Messages Retrieves messages from a Kafka topic.
    Publish Message Produces messages to a Kafka topic.

    Connection and credential alias requirements

    Integration Hub uses aliases to manage connection and credential information, and OAuth credentials. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection.

    For information about setting up the spoke, see Set up the Confluent Kafka REST Proxy spoke.

    Set up the Confluent Kafka REST Proxy spoke

    Integrate Confluent Kafka REST proxy with your ServiceNow instance using basic authentication.

    Before you begin

    • Request Integration Hub subscription.
    • Activate Confluent Kafka REST Proxy spoke.
    • Role required: admin
    Note:
    This procedure outlines steps to set up Confluent Kafka REST Proxy spoke using basic authentication. However, based on your customisations, you can also set up the spoke using ay other HTTP authentication mechanism that is currently supported by the ServiceNow Platform.

    Procedure

    1. Create a credential record for the Confluent Kafka REST Proxy spoke.
      1. Navigate to Connections & Credentials > Credentials.
      2. Click New.
        The system displays the message What type of Credentials would you like to create?.
      3. Select Basic Auth Credentials.
        A blank Basic Auth Credentials form displays.
      4. Enter these values.
        Field Value required
        Name Name to uniquely identify the record. For example, enter Kafka spoke Credentials.
        User name User name to connect to the Confluent Kafka REST Proxy API endpoint.
        Password Password to connect to the Confluent Kafka REST Proxy API endpoint.
        Active Option to actively use the record.
        Order Order to apply this credential. For example, enter 100.
      5. Click Submit.
    2. Create a connection record for the Confluent Kafka REST Proxy spoke.
      1. Navigate to Connections & Credentials > Connection & Credential Aliases.
      2. Open for the record, Kafka REST .
      3. From the Connections tab, click New.
        The system displays a blank HTTP(s) Connection form.
      4. Enter these values.
        Field Value required
        Name Name to uniquely identify the connection record. For example, enter Kafka spoke Connection.
        Credential Credential record you created for the Confluent Kafka REST Proxy spoke. For example, select Kafka spoke Credentials.
        Connection URL URL to connect to the Confluent Kafka REST Proxy API.
      5. Click Submit.