Skip to content
This repository has been archived by the owner on Dec 21, 2023. It is now read-only.

Latest commit

 

History

History
131 lines (100 loc) · 2.58 KB

README.md

File metadata and controls

131 lines (100 loc) · 2.58 KB
Raw

Danger: Unmaintained Code Ahead

This repository is no longer maintained by Confluent. It has been superceded by the proprietary confluent-cli which provides significantly more functionality, including ACLs, RBAC, and Audit Log management for Confluent Platform.

Confluent Platform CLI

A CLI to start and manage Confluent Platform from command line.

Installation

  • Download and install Confluent Platform

  • Checkout confluent-cli by running:

    $ git clone [email protected]:confluentinc/confluent-cli.git

  • Set CONFLUENT_HOME environment variable to point to the location of Confluent Platform. For instance:

    $ export CONFLUENT_HOME=/usr/local/confluent-3.3.0

  • Install confluent-cli:

    $ cd confluent-cli; make install

Usage

To get a list of available commands, run:

$ export PATH=${CONFLUENT_HOME}/bin:${PATH};
$ confluent help

Examples:

  • Start all the services!
$ confluent start
  • Retrieve their status:
$ confluent status
  • Open the log file of a service:
$ confluent log connect
  • Access runtime stats of a service:
$ confluent top kafka
  • Discover the availabe Connect plugins:
$ confluent list plugins
  • or list the predefined connector names:
$ confluent list connectors
  • Load a couple connectors:
$ confluent load file-source
$ confluent load file-sink
  • Get a list with the currently loaded connectors:
$ confluent status connectors
  • Check the status of a loaded connector:
$ confluent status file-source
  • Read the configuration of a connector:
$ confluent config file-source
  • Reconfigure a connector:
$ confluent config file-source -d ./updated-file-source-config.json
  • or reconfigure using a properties file:
$ confluent config file-source -d ./updated-file-source-config.properties
  • Figure out where the data and the logs of the current confluent run are stored:
$ confluent current
  • Unload a specific connector:
$ confluent unload file-sink
  • Stop the services:
$ confluent stop
  • Start on a clean slate next time (deletes data and logs of a confluent run):
$ confluent destroy

Set CONFLUENT_CURRENT if you want to use a top directory for confluent runs other than your platform's tmp directory.

$ cd $CONFLUENT_HOME
$ mkdir -p var
$ export CONFLUENT_CURRENT=${CONFLUENT_HOME}/var
$ confluent current