.. _installing_cp: ========================== Install Confluent Platform ========================== You can install the Confluent Platform using a variety of formats, including Docker, ZIP, TAR, APT, and YUM. .. contents:: Contents :local: .. _system-requirements: System Requirements ------------------- ----------------- Operating Systems ----------------- .. include:: ../includes/installation.rst :start-line: 2 :end-line: 23 -------- Software -------- .. include:: ../includes/installation.rst :start-line: 25 :end-line: 30 ~~~~~~~~~~~~~~~~~~ Port Configuration ~~~~~~~~~~~~~~~~~~ By default the |CP| components use these ports to communicate. The following ports must be open: ================================= ================= Component Default Port ================================= ================= Apache Kafka brokers (plain text) 9092 Confluent Control Center 9021 Kafka Connect REST API 8083 KSQL Server REST API 8088 REST Proxy 8082 Schema Registry REST API 8081 ZooKeeper 2181 ================================= ================= .. _installation_archive: Installing |cp| --------------- Choose your installation platform: .. contents:: :local: ------ Docker ------ You can install the |CP| using Docker images. For instructions on how to install using Docker, see the :ref:`documentation `. **Important:** You can install the entire platform or the individual :ref:`component packages ` using Docker images. .. _zip-tar-archive: -------------------- ZIP and TAR archives -------------------- **Important:** You can install only the :ref:`entire platform ` with the ZIP or TAR archives. #. Download the archive. You can get the ZIP and TAR files from the `downloads page `_. 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. $ /bin/zookeeper-server-start /etc/kafka/zookeeper.properties # Start Kafka. Run this command in its own terminal. $ /bin/kafka-server-start /etc/kafka/server.properties # Start Schema Registry. Run this command in its own terminal. $ /bin/schema-registry-start \ /etc/schema-registry/schema-registry.properties # Start Connect in distributed mode. Run this command in its own terminal. $ /bin/connect-distributed \ /etc/schema-registry/connect-avro-distributed.properties For startup using systemd, see :ref:`installing-systemd-unit`. - **Development or Test Environment** .. include:: ../includes/cli.rst :start-after: cli_limitations_start :end-before: cli_limitations_end Run this command to start all |CP| services by using the CLI. .. sourcecode:: bash $ /bin/confluent start Your output should resemble this. .. include:: ../includes/cli.rst :start-after: CE_CLI_startup_output :end-before: COS_CP_CLI_startup_output For more information, see the :ref:`install-cp-next-steps`. .. _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 ` with the APT repositories. #. Install the Confluent public key, which is used to sign the packages in the APT repository. .. codewithvars:: bash $ wget -qO - https://packages.confluent.io/deb/|version|/archive.key | sudo apt-key add - #. Add the repository to your ``/etc/apt/sources.list``: .. codewithvars:: bash $ sudo add-apt-repository "deb [arch=amd64] https://packages.confluent.io/deb/|version| stable main" #. Run apt-get update and install |CP|. - Confluent Enterprise: .. codewithvars:: bash $ sudo apt-get update && sudo apt-get install confluent-platform-|scala_version| - Confluent Open Source: .. codewithvars:: bash $ sudo apt-get update && sudo apt-get install confluent-platform-oss-|scala_version| **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 ` section for a listing of packages. For more information, see the :ref:`install-cp-next-steps`. .. _installation_yum: --------------- RHEL and CentOS --------------- The YUM repositories provide packages for RHEL, CentOS, and Fedora-based distributions. #. Install the ``curl`` and ``which`` tools. .. codewithvars:: bash $ sudo yum install curl which #. Install the Confluent public key, which is used to sign packages in the YUM repository. .. codewithvars:: bash $ sudo rpm --import https://packages.confluent.io/rpm/|version|/archive.key #. Add the repository to your ``/etc/yum.repos.d/`` directory in a file named ``confluent.repo``. .. codewithvars:: ini [Confluent.dist] name=Confluent repository (dist) baseurl=https://packages.confluent.io/rpm/|version|/7 gpgcheck=1 gpgkey=https://packages.confluent.io/rpm/|version|/archive.key enabled=1 [Confluent] name=Confluent repository baseurl=https://packages.confluent.io/rpm/|version| gpgcheck=1 gpgkey=https://packages.confluent.io/rpm/|version|/archive.key enabled=1 #. Recommended: `Clear the YUM caches `_. .. sourcecode:: bash $ sudo yum clean all The repository is now ready for use. #. Install |CP|. - Confluent Enterprise: .. codewithvars:: bash $ sudo yum install confluent-platform-|scala_version| - Confluent Open Source: .. codewithvars:: bash $ sudo yum install confluent-platform-oss-|scala_version| **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 ` section for a listing of packages. For more information, see the :ref:`install-cp-next-steps`. .. _install-cp-next-steps: Next Steps ---------- * Try out the end-to-end :ref:`quickstart`. * Enable |cp| :ref:`metrics collection `.