Important

You are viewing documentation for an older version of Confluent Platform. For the latest, click here.

Clustered Deployment Using SSL

This tutorial runs a secure three-node Kafka cluster and ZooKeeper ensemble with SSL. By the end of this tutorial, you will have successfully installed and run a simple deployment with SSL security enabled on Docker. If you’re looking for a simpler tutorial, please refer to the quick start guide, which is limited to a single node Kafka cluster.

Note

In this tutorial, Kafka and ZooKeeper are configured to store data locally in the Docker containers. For production deployments (or generally whenever you care about not losing data), you should use mounted volumes for persisting data in the event that a container stops running or is restarted. This is important when running a system like Kafka on Docker, as it relies heavily on the filesystem for storing and caching messages. For an example of how to add mounted volumes to the host machine, see the documentation on Docker external volumes.

Installing and Running Docker

For this tutorial, Docker is run using the Docker client. If you are interested in information on using Docker Compose to run the images, skip to the bottom of this guide.

To get started, you’ll need to first install Docker and get it running. The Confluent Platform Docker Images require Docker version 1.11 or greater.

Docker Client: Setting Up a Three Node Kafka Cluster

If you’re running on Windows or Mac OS X, you’ll need to use Docker Machine to start the Docker host. Docker runs natively on Linux, so the Docker host will be your local machine if you go that route. If you are running on Mac or Windows, be sure to allocate at least 4 GB of ram to the Docker Machine.

Now that you have all of the Docker dependencies installed, you can create a Docker machine and begin starting up Confluent Platform.

Note

In the following steps, each Docker container is run in detached mode and you are shown how to access to the logs for a running container. You can also run the containers in the foreground by replacing the -d flags with -it.

1. Create and configure the Docker machine.

   docker-machine create --driver virtualbox --virtualbox-memory 6000 confluent
   

   Next, configure your terminal window to attach it to your new Docker Machine:

   eval $(docker-machine env confluent)
   

2. Clone the git repository:

   git clone https://github.com/confluentinc/cp-docker-images
   cd cp-docker-images
   

3. Generate Credentials

   You must generate CA certificates (or use yours if you already have one) and then generate a keystore and truststore for brokers and clients. You can use the create-certs.sh script in examples/kafka-cluster-ssl/secrets to generate them. For production, use these scripts for generating certificates.

   This example uses the create-certs.sh that is available in the examples/kafka-cluster-ssl/secrets directory in the cp-docker-images repo. Make sure that you have OpenSSL and JDK installed. For more information about security, see the security documentation.

   cd $(pwd)/examples/kafka-cluster-ssl/secrets
   ./create-certs.sh
   (Type yes for all "Trust this certificate? [no]:" prompts.)
   cd -
   

   Set the environment variable for the secrets directory. This is used in later commands. Make sure that you are in the cp-confluent-images directory.

   export KAFKA_SSL_SECRETS_DIR=$(pwd)/examples/kafka-cluster-ssl/secrets
   

4. Start Up a 3-node ZooKeeper Ensemble by running the three commands below.

   docker run -d \
       --net=host \
       --name=zk-1 \
       -e ZOOKEEPER_SERVER_ID=1 \
       -e ZOOKEEPER_CLIENT_PORT=22181 \
       -e ZOOKEEPER_TICK_TIME=2000 \
       -e ZOOKEEPER_INIT_LIMIT=5 \
       -e ZOOKEEPER_SYNC_LIMIT=2 \
       -e ZOOKEEPER_SERVERS="localhost:22888:23888;localhost:32888:33888;localhost:42888:43888" \
       confluentinc/cp-zookeeper:4.1.5-SNAPSHOT
   

   docker run -d \
       --net=host \
       --name=zk-2 \
       -e ZOOKEEPER_SERVER_ID=2 \
       -e ZOOKEEPER_CLIENT_PORT=32181 \
       -e ZOOKEEPER_TICK_TIME=2000 \
       -e ZOOKEEPER_INIT_LIMIT=5 \
       -e ZOOKEEPER_SYNC_LIMIT=2 \
       -e ZOOKEEPER_SERVERS="localhost:22888:23888;localhost:32888:33888;localhost:42888:43888" \
       confluentinc/cp-zookeeper:4.1.5-SNAPSHOT
   

   docker run -d \
       --net=host \
       --name=zk-3 \
       -e ZOOKEEPER_SERVER_ID=3 \
       -e ZOOKEEPER_CLIENT_PORT=42181 \
       -e ZOOKEEPER_TICK_TIME=2000 \
       -e ZOOKEEPER_INIT_LIMIT=5 \
       -e ZOOKEEPER_SYNC_LIMIT=2 \
       -e ZOOKEEPER_SERVERS="localhost:22888:23888;localhost:32888:33888;localhost:42888:43888" \
       confluentinc/cp-zookeeper:4.1.5-SNAPSHOT
   

   Check the logs to confirm that the ZooKeeper servers have booted up successfully:

   docker logs zk-1
   

   You should see messages like this at the end of the log output:

   [2016-07-24 07:17:50,960] INFO Created server with tickTime 2000 minSessionTimeout 4000 maxSessionTimeout 40000 datadir /var/lib/zookeeper/log/version-2 snapdir /var/lib/zookeeper/data/version-2 (org.apache.zookeeper.server.ZooKeeperServer)
   [2016-07-24 07:17:50,961] INFO FOLLOWING - LEADER ELECTION TOOK - 21823 (org.apache.zookeeper.server.quorum.Learner)
   [2016-07-24 07:17:50,983] INFO Getting a diff from the leader 0x0 (org.apache.zookeeper.server.quorum.Learner)
   [2016-07-24 07:17:50,986] INFO Snapshotting: 0x0 to /var/lib/zookeeper/data/version-2/snapshot.0 (org.apache.zookeeper.server.persistence.FileTxnSnapLog)
   [2016-07-24 07:17:52,803] INFO Received connection request /127.0.0.1:50056 (org.apache.zookeeper.server.quorum.QuorumCnxManager)
   [2016-07-24 07:17:52,806] INFO Notification: 1 (message format version), 3 (n.leader), 0x0 (n.zxid), 0x1 (n.round), LOOKING (n.state), 3 (n.sid), 0x0 (n.peerEpoch) FOLLOWING (my state) (org.apache.zookeeper.server.quorum.FastLeaderElection)
   

   You can repeat the command for the two other ZooKeeper nodes. Next, you should verify that ZK ensemble is ready:

   for i in 22181 32181 42181; do
      docker run --net=host --rm confluentinc/cp-zookeeper:4.1.5-SNAPSHOT bash -c "echo stat | nc localhost $i | grep Mode"
   done
   

   You should see one leader and two follower instances.

   Mode: follower
   Mode: leader
   Mode: follower
   

5. Now that ZooKeeper is up and running, you can start a three node Kafka cluster.

   docker run -d \
      --net=host \
      --name=kafka-ssl-1 \
      -e KAFKA_ZOOKEEPER_CONNECT=localhost:22181,localhost:32181,localhost:42181 \
      -e KAFKA_ADVERTISED_LISTENERS=SSL://localhost:29092 \
      -e KAFKA_SSL_KEYSTORE_FILENAME=kafka.broker1.keystore.jks \
      -e KAFKA_SSL_KEYSTORE_CREDENTIALS=broker1_keystore_creds \
      -e KAFKA_SSL_KEY_CREDENTIALS=broker1_sslkey_creds \
      -e KAFKA_SSL_TRUSTSTORE_FILENAME=kafka.broker1.truststore.jks \
      -e KAFKA_SSL_TRUSTSTORE_CREDENTIALS=broker1_truststore_creds \
      -e KAFKA_SECURITY_INTER_BROKER_PROTOCOL=SSL \
      -v ${KAFKA_SSL_SECRETS_DIR}:/etc/kafka/secrets \
      confluentinc/cp-kafka:4.1.5-SNAPSHOT
   

   docker run -d \
      --net=host \
      --name=kafka-ssl-2 \
      -e KAFKA_ZOOKEEPER_CONNECT=localhost:22181,localhost:32181,localhost:42181 \
      -e KAFKA_ADVERTISED_LISTENERS=SSL://localhost:39092 \
      -e KAFKA_SSL_KEYSTORE_FILENAME=kafka.broker2.keystore.jks \
      -e KAFKA_SSL_KEYSTORE_CREDENTIALS=broker2_keystore_creds \
      -e KAFKA_SSL_KEY_CREDENTIALS=broker2_sslkey_creds \
      -e KAFKA_SSL_TRUSTSTORE_FILENAME=kafka.broker2.truststore.jks \
      -e KAFKA_SSL_TRUSTSTORE_CREDENTIALS=broker2_truststore_creds \
      -e KAFKA_SECURITY_INTER_BROKER_PROTOCOL=SSL \
      -v ${KAFKA_SSL_SECRETS_DIR}:/etc/kafka/secrets \
      confluentinc/cp-kafka:4.1.5-SNAPSHOT
   

   docker run -d \
      --net=host \
      --name=kafka-ssl-3 \
      -e KAFKA_ZOOKEEPER_CONNECT=localhost:22181,localhost:32181,localhost:42181 \
      -e KAFKA_ADVERTISED_LISTENERS=SSL://localhost:49092 \
      -e KAFKA_SSL_KEYSTORE_FILENAME=kafka.broker3.keystore.jks \
      -e KAFKA_SSL_KEYSTORE_CREDENTIALS=broker3_keystore_creds \
      -e KAFKA_SSL_KEY_CREDENTIALS=broker3_sslkey_creds \
      -e KAFKA_SSL_TRUSTSTORE_FILENAME=kafka.broker3.truststore.jks \
      -e KAFKA_SSL_TRUSTSTORE_CREDENTIALS=broker3_truststore_creds \
      -e KAFKA_SECURITY_INTER_BROKER_PROTOCOL=SSL \
      -v ${KAFKA_SSL_SECRETS_DIR}:/etc/kafka/secrets \
      confluentinc/cp-kafka:4.1.5-SNAPSHOT
   

   Check the logs to see the broker has booted up successfully:

   docker logs kafka-ssl-1
   docker logs kafka-ssl-2
   docker logs kafka-ssl-3
   

   You should see start see bootup messages. For example, docker logs kafka-ssl-3 | grep started should show the following:

   [2016-07-24 07:29:20,258] INFO [Kafka Server 1003], started (kafka.server.KafkaServer)
   [2016-07-24 07:29:20,258] INFO [Kafka Server 1003], started (kafka.server.KafkaServer)
   

   You should see the messages like the following on the broker acting as controller.

   [2016-07-24 07:29:20,283] TRACE Controller 1001 epoch 1 received response {error_code=0} for a request sent to broker localhost:29092 (id: 1001 rack: null) (state.change.logger)
   [2016-07-24 07:29:20,283] TRACE Controller 1001 epoch 1 received response {error_code=0} for a request sent to broker localhost:29092 (id: 1001 rack: null) (state.change.logger)
   [2016-07-24 07:29:20,286] INFO [Controller-1001-to-broker-1003-send-thread], Starting  (kafka.controller.RequestSendThread)
   [2016-07-24 07:29:20,286] INFO [Controller-1001-to-broker-1003-send-thread], Starting  (kafka.controller.RequestSendThread)
   [2016-07-24 07:29:20,286] INFO [Controller-1001-to-broker-1003-send-thread], Starting  (kafka.controller.RequestSendThread)
   [2016-07-24 07:29:20,287] INFO [Controller-1001-to-broker-1003-send-thread], Controller 1001 connected to localhost:49092 (id: 1003 rack: null) for sending state change requests (kafka.controller.RequestSendThread)
   

6. Test that the broker is working as expected.

   Now that the brokers are up, you can test that they’re working as expected by creating a topic.

   docker run \
     --net=host \
     --rm \
     confluentinc/cp-kafka:4.1.5-SNAPSHOT \
     kafka-topics --create --topic bar --partitions 3 --replication-factor 3 --if-not-exists --zookeeper localhost:32181
   

   You should see the following output:

   Created topic "bar".
   

   Now verify that the topic is created successfully by describing the topic.

   docker run \
      --net=host \
      --rm \
      confluentinc/cp-kafka:4.1.5-SNAPSHOT \
      kafka-topics --describe --topic bar --zookeeper localhost:32181
   

   You should see the following message in your terminal window:

   Topic:bar   PartitionCount:3    ReplicationFactor:3 Configs:
   Topic: bar  Partition: 0    Leader: 1003    Replicas: 1003,1002,1001    Isr: 1003,1002,1001
   Topic: bar  Partition: 1    Leader: 1001    Replicas: 1001,1003,1002    Isr: 1001,1003,1002
   Topic: bar  Partition: 2    Leader: 1002    Replicas: 1002,1001,1003    Isr: 1002,1001,1003
   

   Next, you can try generating some data to the bar topic that was just created.

   docker run \
     --net=host \
     --rm \
     -v ${KAFKA_SSL_SECRETS_DIR}:/etc/kafka/secrets \
     confluentinc/cp-kafka:4.1.5-SNAPSHOT \
     bash -c "seq 42 | kafka-console-producer --broker-list localhost:29092 --topic bar -producer.config /etc/kafka/secrets/host.producer.ssl.config && echo 'Produced 42 messages.'"
   

   The command above will pass 42 integers using the Console Producer that is shipped with Kafka. As a result, you should see something like this in your terminal:

   Produced 42 messages.
   

   It looked like things were successfully written, but now you can try reading the messages back using the Console Consumer and make sure they’re all accounted for.

   docker run \
     --net=host \
     --rm \
     -v ${KAFKA_SSL_SECRETS_DIR}:/etc/kafka/secrets \
     confluentinc/cp-kafka:4.1.5-SNAPSHOT \
     kafka-console-consumer --bootstrap-server localhost:29092 --topic bar --new-consumer --from-beginning --consumer.config /etc/kafka/secrets/host.consumer.ssl.config --max-messages 42
   

   You should see the following (it might take some time for this command to return data. Kafka has to create the __consumers_offset topic behind the scenes when you consume data for the first time and this may take some time):

   1
   4
   7
   10
   13
   16
   ....
   41
   Processed a total of 42 messages
   

Docker Compose: Setting Up a Three Node Confluent Platform Cluster with SSL

Before you get started, you will first need to install Docker and Docker Compose. Once you’ve done that, you can follow the steps below to start up the Confluent Platform services.

1. Clone the Confluent Platform Docker Images Github Repository.

   git clone https://github.com/confluentinc/cp-docker-images
   cd cp-docker-images/examples/kafka-cluster-ssl
   

   Follow section 3 on generating SSL credentials in Docker Client: Setting Up a Three Node Kafka Cluster to create the SSL credentials.

2. Start ZooKeeper and Kafka using Docker Compose up command.

   export KAFKA_SSL_SECRETS_DIR=$(pwd)/secrets
   docker-compose create
   docker-compose start
   

   In another terminal window, go to the same directory (kafka-cluster). Make sure the services are up and running

   docker-compose ps
   

   You should see the following:

      Name                         Command            State   Ports
   -------------------------------------------------------------------------
   kafkaclusterssl_kafka-ssl-1_1   /etc/confluent/docker/run   Up
   kafkaclusterssl_kafka-ssl-2_1   /etc/confluent/docker/run   Up
   kafkaclusterssl_kafka-ssl-3_1   /etc/confluent/docker/run   Up
   kafkaclusterssl_zookeeper-1_1   /etc/confluent/docker/run   Up
   kafkaclusterssl_zookeeper-2_1   /etc/confluent/docker/run   Up
   kafkaclusterssl_zookeeper-3_1   /etc/confluent/docker/run   Up
   

   Check the ZooKeeper logs to verify that ZooKeeper is healthy. For example, for service zookeeper-1:

   docker-compose logs zookeeper-1
   

   You should see messages like the following:

   zookeeper-1_1  | [2016-07-25 04:58:12,901] INFO Created server with tickTime 2000 minSessionTimeout 4000 maxSessionTimeout 40000 datadir /var/lib/zookeeper/log/version-2 snapdir /var/lib/zookeeper/data/version-2 (org.apache.zookeeper.server.ZooKeeperServer)
   zookeeper-1_1  | [2016-07-25 04:58:12,902] INFO FOLLOWING - LEADER ELECTION TOOK - 235 (org.apache.zookeeper.server.quorum.Learner)
   

   Verify that ZK ensemble is ready

   for i in 22181 32181 42181; do
      docker run --net=host --rm confluentinc/cp-zookeeper:4.1.5-SNAPSHOT bash -c "echo stat | nc localhost $i | grep Mode"
   done
   

   You should see one leader and two follower instances:

   Mode: follower
   Mode: leader
   Mode: follower
   

   Check the logs to see the broker has booted up successfully

   docker-compose logs kafka-ssl-1
   docker-compose logs kafka-ssl-2
   docker-compose logs kafka-ssl-3
   

   You should see start see bootup messages. For example, docker-compose logs kafka-ssl-3 | grep started shows the following

   kafka-ssl-3_1      | [2016-07-25 04:58:15,189] INFO [Kafka Server 3], started (kafka.server.KafkaServer)
   kafka-ssl-3_1      | [2016-07-25 04:58:15,189] INFO [Kafka Server 3], started (kafka.server.KafkaServer)
   

   You should see the messages like the following on the broker acting as controller.

   (Tip: `docker-compose logs | grep controller` makes it easy to grep through logs for all services.)
   
   kafka-ssl-3_1  | [2016-08-24 23:38:22,762] INFO [Controller-3-to-broker-1-send-thread], Controller 3 connected to localhost:19093 (id: 1 rack: null) for sending state change requests (kafka.controller.RequestSendThread)
   kafka-ssl-3_1  | [2016-08-24 23:38:22,763] INFO [Controller-3-to-broker-2-send-thread], Controller 3 connected to localhost:29093 (id: 2 rack: null) for sending state change requests (kafka.controller.RequestSendThread)
   kafka-ssl-3_1  | [2016-08-24 23:38:22,763] INFO [Controller-3-to-broker-2-send-thread], Controller 3 connected to localhost:29093 (id: 2 rack: null) for sending state change requests (kafka.controller.RequestSendThread)
   kafka-ssl-3_1  | [2016-08-24 23:38:22,763] INFO [Controller-3-to-broker-2-send-thread], Controller 3 connected to localhost:29093 (id: 2 rack: null) for sending state change requests (kafka.controller.RequestSendThread)
   kafka-ssl-3_1  | [2016-08-24 23:38:22,762] INFO [Controller-3-to-broker-1-send-thread], Controller 3 connected to localhost:19093 (id: 1 rack: null) for sending state change requests (kafka.controller.RequestSendThread)
   

3. Follow step 5 in the Docker Client: Setting Up a Three Node Kafka Cluster to test that your brokers are functioning as expected.

4. To stop the cluster, first stop Kafka nodes one-by-one and then stop the ZooKeeper cluster.

   docker-compose stop kafka-ssl-1
   docker-compose stop kafka-ssl-2
   docker-compose stop kafka-ssl-3
   docker-compose down