.. _installing_cp:

==========================
Install Confluent Platform
==========================

You can install the Confluent Platform using a variety of formats, including Docker, ZIP, TAR, APT, and YUM.

.. contents::

.. _system-requirements:

System Requirements
-------------------

**Operating Systems**

.. include:: ../includes/installation.rst
    :start-line: 10
    :end-line: 31

**Software**

- Oracle Java 1.7 or later.

  **Tip:** You can check your Java version with this command:

  .. sourcecode:: bash

      $ java -version

- Optional: Docker version 1.11 or later. This is required if you are installing |CP| by using the :ref:`Docker images <cpdocker_intro>`.

**Port Configuration**

By default the |CP| components use these ports to communicate. The following ports must be open:

=================================    =================
Component                            Port
=================================    =================
Apache Kafka brokers (plain text)    9092
Confluent Control Center             9021
Kafka Connect REST API               8083
REST Proxy                           8082
Schema Registry REST API             8081
ZooKeeper                            2181
=================================    =================



.. _installation_archive:

Installation Formats
--------------------

Docker
~~~~~~

You can install the |CP| using Docker images. For instructions on how to install using Docker, see the :ref:`documentation <cpdocker_intro>`.

**Important:** You can install the entire platform or the individual :ref:`component packages <available_packages>` using Docker images.


ZIP and TAR archives
~~~~~~~~~~~~~~~~~~~~  

**Important:** You can install only the :ref:`entire platform <available_packages>` with the ZIP or TAR archives.

#. Download the archive. You can get the ZIP and TAR files from the `downloads page <http://confluent.io/download/>`_.  These archives contain the JARs, driver scripts, and configuration files in ZIP and TAR archives.

#. Uncompress the archive file.

#. Install |CP| using one of these methods based on your needs.

   -  **Production Environment**

      Start each |CP| service in its own terminal:

      .. sourcecode:: bash

              # Start ZooKeeper.  Run this command in its own terminal.
              $ <path-to-confluent>/bin/zookeeper-server-start <path-to-confluent>/etc/kafka/zookeeper.properties
              # Start Kafka.  Run this command in its own terminal.
              $ <path-to-confluent>/bin/kafka-server-start <path-to-confluent>/etc/kafka/server.properties
              # Start Schema Registry. Run this command in its own terminal.
              $ <path-to-confluent>/bin/schema-registry-start \
              <path-to-confluent>/etc/schema-registry/schema-registry.properties
              # Start Connect in distributed mode. Run this command in its own terminal.
              $ <path-to-confluent>/bin/connect-distributed \
              <path-to-confluent>/etc/schema-registry/connect-avro-distributed.properties

   -  **Development or Test Environment**

      .. include:: ../includes/installation.rst
          :start-line: 34
          :end-line: 37

      Run this command to start all |CP| services by using the CLI.

      .. sourcecode:: bash

            $ <path-to-confluent>/bin/confluent start

      Your output should resemble this.

      .. sourcecode:: bash

            Starting zookeeper
            zookeeper is [UP]
            Starting kafka
            kafka is [UP]
            Starting schema-registry
            schema-registry is [UP]
            Starting kafka-rest
            kafka-rest is [UP]
            Starting connect
            connect is [UP]



Next, try the :ref:`Quickstart<quickstart>` to test out the |CP| locally.

.. _installation_apt:

Debian and Ubuntu
~~~~~~~~~~~~~~~~~

The APT repositories provide packages for Debian-based Linux distributions such
as Debian and Ubuntu. 

**Important:** You can install the entire platform or the individual :ref:`component packages <available_packages>` with the APT repositories.

#. Install the Confluent public key, which is used to sign the packages in the APT repository.

    .. sourcecode:: bash

        $ wget -qO - https://packages.confluent.io/deb/4.0/archive.key | sudo apt-key add -

#. Add the repository to your ``/etc/apt/sources.list``:

    .. sourcecode:: bash

        $ sudo add-apt-repository "deb [arch=amd64] https://packages.confluent.io/deb/4.0 stable main"

#. Run apt-get update and install |CP|.

   - Confluent Enterprise:

     .. sourcecode:: bash

       $ sudo apt-get update && sudo apt-get install confluent-platform-2.11

   - Confluent Open Source:

     .. sourcecode:: bash

       $ sudo apt-get update && sudo apt-get install confluent-platform-oss-2.11

**Important:** The number at the end of the package name specifies the Scala version. Currently
supported versions are 2.11 (recommended) and 2.10. Individual components of
the |CP| are also available as standalone packages. See the
:ref:`Available Packages <available_packages>` section for a listing of packages.

Next, try the :ref:`Quickstart<quickstart>` to test out the |CP| locally.

.. _installation_yum:

RHEL and CentOS
~~~~~~~~~~~~~~~

The YUM repositories provide packages for RHEL, CentOS, and Fedora-based distributions. 

**Important:** You can install the entire platform or the individual :ref:`component packages <available_packages>` with the YUM repositories.

#. Install the Confluent public key, which is used to sign packages in the YUM repository.

   .. sourcecode:: bash

     $ sudo rpm --import https://packages.confluent.io/rpm/4.0/archive.key

#. Add the repository to your ``/etc/yum.repos.d/`` directory in a file named ``confluent.repo``.

   - If you are using RHEL/CentOS 6.8

     .. sourcecode:: ini

       [Confluent.dist]
       name=Confluent repository (dist)
       baseurl=https://packages.confluent.io/rpm/4.0/6
       gpgcheck=1
       gpgkey=https://packages.confluent.io/rpm/4.0/archive.keyt
       enabled=1

       [Confluent]
       name=Confluent repository
       baseurl=https://packages.confluent.io/rpm/4.0
       gpgcheck=1
       gpgkey=https://packages.confluent.io/rpm/4.0/archive.key
       enabled=1


   - If you are using RHEL/CentOS 7.2

     .. sourcecode:: ini

       [Confluent.dist]
       name=Confluent repository (dist)
       baseurl=https://packages.confluent.io/rpm/4.0/7
       gpgcheck=1
       gpgkey=https://packages.confluent.io/rpm/4.0/archive.key
       enabled=1
 
       [Confluent]
       name=Confluent repository
       baseurl=https://packages.confluent.io/rpm/4.0
       gpgcheck=1
       gpgkey=https://packages.confluent.io/rpm/4.0/archive.key
       enabled=1


#. Recommended: `Clear the YUM caches <https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Deployment_Guide/sec-Working_with_Yum_Cache.html>`_.

   .. sourcecode:: bash

      $ sudo yum clean all

   The repository is now ready for use.

#. Install |CP|.

   - Confluent Enterprise:

     .. sourcecode:: bash

          $ sudo yum install confluent-platform-2.11

   - Confluent Open Source:

     .. sourcecode:: bash

        $ sudo yum install confluent-platform-oss-2.11

   **Important:** The number at the end of the package name specifies the Scala version. Currently supported versions are 2.11 (recommended) and 2.10.  Individual components of the |CP| are also available as standalone packages. See the :ref:`Available Packages <available_packages>` section for a listing of packages.

Next, try the :ref:`Quickstart<quickstart>` to test out the |CP| locally.