Manual Install using ZIP and TAR Archives¶
This topic provides instructions for installing a production-ready Confluent Platform configuration in a multi-node environment with a replicated ZooKeeper ensemble.
With this installation method, you connect to every node manually, download the archive, and run the Confluent Platform installation commands.
You must complete these steps for each node in your cluster.
- Before installing Confluent Platform, your environment must have the following software and hardware requirements.
Get the Software¶
Go to the downloads page and choose your archive package or download directly by using curl.
- Confluent Platform
With this Confluent Platform package,
confluent-kafkais installed by default. If you want
confluent-server, you uninstall
confluent-serveras described in Migrate to Confluent Server.
Enterprise features, such as Replicator or RBAC, require
curl -O http://packages.confluent.io/archive/5.5/confluent-5.5.4-2.12.zip
curl -O http://packages.confluent.io/archive/5.5/confluent-5.5.4-2.12.tar.gz
- Confluent Platform using only Confluent Community components
curl -O http://packages.confluent.io/archive/5.5/confluent-community-5.5.4-2.12.zip
curl -O http://packages.confluent.io/archive/5.5/confluent-community-5.5.4-2.12.tar.gz
The installation package names end with the Scala version that the Kafka is built on. For example, the
confluent-platform-2.12package is for Confluent Platform 5.5.4 and is based on Scala 2.12.
The Zip and Tar packages contain the Confluent Platform version followed by the Scala version. For example, a Zip package,
confluent-5.5.4-2.12.zipdenotes Confluent Platform version 5.5.4 and Scala version 2.12.
Extract the contents of the archive. For ZIP files, run this command in a terminal.
For TAR files run this command:
tar xzf confluent-5.5.4-2.12.tar.gz
You should have these directories:
Folder Description /bin/ Driver scripts for starting and stopping services /etc/ Configuration files /lib/ Systemd services /logs/ Log files /share/ Jars and licenses /src/ Source files that require a platform-dependent build
Configure Confluent Platform¶
You can store passwords and other configuration data securely by using the confluent secret commands. For more information see Secrets.
Configure Confluent Platform with the individual component properties files. By default these are located in
You must minimally configure the following components.
These instructions assume you are running ZooKeeper in replicated mode. A minimum of three servers are required for replicated mode, and you must have an odd number of servers for failover. For more information, see the ZooKeeper documentation.
Navigate to the ZooKeeper properties file (
/etc/kafka/zookeeper.properties) file and modify as shown.
tickTime=2000 dataDir=/var/lib/zookeeper/ clientPort=2181 initLimit=5 syncLimit=2 server.1=zoo1:2888:3888 server.2=zoo2:2888:3888 server.3=zoo3:2888:3888 autopurge.snapRetainCount=3 autopurge.purgeInterval=24
This configuration is for a three node ensemble. This configuration file should be identical across all nodes in the ensemble.
clientPortare all set to typical single server values. The
syncLimitgovern how long following ZooKeeper servers can take to initialize with the current leader and how long they can be out of sync with the leader. In this configuration, a follower can take 10000 ms to initialize and can be out of sync for up to 4000 ms based on the
tickTimebeing set to 2000ms.
server.*properties set the ensemble membership. The format is
myidis the server identification number. There are three servers that each have a different
myidis set by creating a file named
dataDirthat contains a single integer in human readable ASCII text. This value must match one of the
myidvalues from the configuration file. You will see an error if another ensemble member is already started with a conflicting
leaderportis used by followers to connect to the active leader. This port should be open between all ZooKeeper ensemble members.
electionportis used to perform leader elections between ensemble members. This port should be open between all ZooKeeper ensemble members.
autopurge.purgeIntervalhave been set to purge all but three snapshots every 24 hours.
Navigate to the ZooKeeper log directory (e.g.,
/var/lib/zookeeper/) and create a file named
myidfile consists of a single line that contains the machine ID in the format
<machine-id>. When the ZooKeeper server starts up, it knows which server it is by referencing the
myidfile. For example, server 1 will have a
In a production environment, multiple brokers are required. During startup brokers register themselves in ZooKeeper to become a member of the cluster.
Navigate to the Apache Kafka® properties file (
/etc/kafka/server.properties) and customize the following:
Connect to the same ZooKeeper ensemble by setting the
zookeeper.connectin all nodes to the same value. Replace all instances of
localhostto the hostname or FQDN (fully qualified domain name) of your node. For example, if your hostname is
Configure the broker IDs for each node in your cluster using one of these methods.
Dynamically generate the broker IDs: add
broker.id.generation.enable=trueand comment out
broker.id. For example:
############################# Server Basics ############################# # The ID of the broker. This must be set to a unique integer for each broker. #broker.id=0 broker.id.generation.enable=true
Manually set the broker IDs: set a unique value for
broker.idon each node.
Configure how other brokers and clients communicate with the broker using
listeners, and optionally
listeners: Comma-separated list of URIs and listener names to listen on.
advertised.listeners: Comma-separated list of URIs and listener names for other brokers and clients to use. The
advertised.listenersparameter ensures that the broker advertises an address that is accessible from both local and external hosts.
For more information, see Production Configuration Options.
Configure security for your environment.
- For general security guidance, see Security.
- For role-based access control (RBAC), see Configure Metadata Service (MDS).
- For SSL encryption, SASL authentication, and authorization, see Security Tutorial.
Navigate to the Control Center properties file (
/etc/confluent-control-center/control-center-production.properties) and customize the following:
# host/port pairs to use for establishing the initial connection to the Kafka cluster bootstrap.servers=<hostname1:port1,hostname2:port2,hostname3:port3,...> # location for Control Center data confluent.controlcenter.data.dir=/var/lib/confluent/control-center # the Confluent license confluent.license=<your-confluent-license> # ZooKeeper connection string with host and port of a ZooKeeper servers zookeeper.connect=<hostname1:port1,hostname2:port2,hostname3:port3,...>
This configuration is for a three node multi-node cluster. For more information, see Control Center configuration details. For information about Confluent Platform licenses, see Managing Confluent Platform Licenses.
Navigate to the Kafka server configuration file (
/etc/kafka/server.properties) and enable Confluent Metrics Reporter.
##################### Confluent Metrics Reporter ####################### # Confluent Control Center and Confluent Auto Data Balancer integration # # Uncomment the following lines to publish monitoring data for # Confluent Control Center and Confluent Auto Data Balancer # If you are using a dedicated metrics cluster, also adjust the settings # to point to your metrics Kafka cluster. metric.reporters=io.confluent.metrics.reporter.ConfluentMetricsReporter confluent.metrics.reporter.bootstrap.servers=localhost:9092 # # Uncomment the following line if the metrics cluster has a single broker confluent.metrics.reporter.topic.replicas=1
Add these lines to the Kafka Connect properties file (
/etc/kafka/connect-distributed.properties) to add support for the interceptors.
# Interceptor setup consumer.interceptor.classes=io.confluent.monitoring.clients.interceptor.MonitoringConsumerInterceptor producer.interceptor.classes=io.confluent.monitoring.clients.interceptor.MonitoringProducerInterceptor
Navigate to the Schema Registry properties file (
and specify the following properties:
# Specify the address the socket server listens on, e.g. listeners = PLAINTEXT://your.host.name:9092 listeners=http://0.0.0.0:8081 # The host name advertised in ZooKeeper. This must be specified if your running Schema Registry # with multiple nodes. host.name=192.168.50.1 # List of Kafka brokers to connect to, e.g. PLAINTEXT://hostname:9092,SSL://hostname2:9092 kafkastore.bootstrap.servers=PLAINTEXT://hostname:9092,SSL://hostname2:9092
This configuration is for a three node multi-node cluster. For more information, see Running Schema Registry in Production.
Start Confluent Platform¶
Install Confluent Platform by using Kafka CLI commands.
ZooKeeper, Kafka, and Schema Registry must be started in this specific order, and must be started before any other components.
Start ZooKeeper. Run this command in its own terminal.
Start Kafka. Run this command in its own terminal.
Start Schema Registry. Run this command in its own terminal.
Start other Confluent Platform components as desired.
Confluent REST Proxy
Remove the Confluent directory. For example, if you have Confluent Platform 5.5.4 installed:
rm -rf confluent-5.5.4
Remove the Confluent Platform data files.
rm -rf /var/lib/<confluent-platform-data-files>
Try out the Apache Kafka Quick Start.