Confluent Hub Client

The Confluent Hub client is a command-line tool that makes it easy to install and update components from Confluent Hub into a local Confluent Platform installation.

Learn more about the components of Kafka Connect in this free course.

Install the Confluent Hub Client

The Confluent Hub client is natively installed as a part of the complete Confluent Platform and located in the /bin directory. If you are using Confluent Community software, you can install the Confluent Hub client separately using the following instructions.

MacOS

  1. Tap the Confluent repository for the Confluent Hub client.

    brew tap confluentinc/homebrew-confluent-hub-client
    
  2. Install the Confluent Hub client.

    brew install --cask confluent-hub-client
    
  3. Optional: Verify your installation by typing confluent-hub in your terminal.

    confluent-hub
    

    Your output should look like this:

    usage: confluent-hub <command> [ <args> ]
    
    Commands are:
        help      Display help information
        install   install a component from either Confluent Hub or from a local file
    
    See 'confluent-hub help <command>' for more information on a specific command.
    

Linux

Download and unzip the Confluent Hub tarball.

  1. Copy and paste this link in your browser to download and unzip the Confluent Hub tarball.

    http://client.hub.confluent.io/confluent-hub-client-latest.tar.gz
    
  2. Add the contents of the bin directory to your PATH environment variable so that which confluent-hub finds the confluent-hub command.

  3. Optional: Verify your installation by typing confluent-hub in your terminal.

    confluent-hub
    

    Your output should look like this:

    usage: confluent-hub <command> [ <args> ]
    
    Commands are:
        help      Display help information
        install   install a component from either Confluent Hub or from a local file
    
    See 'confluent-hub help <command>' for more information on a specific command.
    

Install Components With Confluent Hub Client

You can find component-specific installation commands under the Installation section of a component on Confluent Hub. For additional installation help, see the self-managed connector installation documentation.

The following sections include both online and offline installation instructions.

Install while online

When connected to the internet, use the following instructions to install the Kafka Connect JDBC connector.

../../../_images/confluent-hub-1.png

Use the following Confluent Hub client command to install components from Confluent Hub into a local Confluent Platform installation:

confluent-hub install <owner>/<component>:<version>

where

  • <owner> is the name of component owner on Confluent Hub.
  • <component> is the name of the component on Confluent Hub.
  • <version> is either the version of the component on Confluent Hub, or the literal latest when you want to install the latest version of the component.

Tip

  • If the Installation section doesn’t provide the Confluent Hub installation command, contact the component owner.
  • If the Confluent Hub client needs to connect to the internet via a proxy server, you can set one by exporting the JAVA_TOOL_OPTIONS variable in your environment before running Confluent Hub. For example, setting export JAVA_TOOL_OPTIONS="-Dhttps.proxyHost=localhost -Dhttps.proxyPort=8080" will make Confluent Hub use a proxy server on localhost port 8080.

Install while offline (using a ZIP file)

If you are offline, you can install a connector by downloading the ZIP file from Confluent Hub. To install the connector, run the following command:

confluent-hub install <component>-<version>.zip

Restart the connector container

After you have installed the connector, you must restart the connector container. If you do not restart the connector container, the installed connector tile will not be displayed on the Connect page in Confluent Control Center.