.. _image_reference: Docker Image Reference for |cp| ############################### Using Docker images, you can install the entire Confluent Platform or individual components. The |cp| component images are available on `Docker Hub `_. The source files for the images are available in the GitHub repos. From GitHub you can extend and rebuild the images and upload them to your own DockerHub repository. The software required to build these images is covered by the |apache-2|. To learn more about configuring these images, see :ref:`config_reference`. The table below lists the available images and the Confluent software packages that they contain. The images that require the |ent| include proprietary components and must be licensed from Confluent when deployed. Image guide *********** The following sections list images by component type. In most cases, the license is noted for each package. For more information about package licenses, see :ref:`cp-license-overview`. Base images ----------- These images provide build files for the |cp| images. The license varies by package. +----------------------+------------------------------+---------------------------------------------------------------------------------------+ | Image Name | Packages | GitHub Repo | +======================+==============================+=======================================================================================+ | |cp-base-lite| | - zulu11-ca-jre-headless | `common-docker `__ | | | - curl | | +----------------------+------------------------------+---------------------------------------------------------------------------------------+ | |cp-base-new| | - zulu-openjdk-8 | `common-docker `__ | | | - curl | | | | - openSSL | | | | - python39 | | | | - additional utilities not | | | | listed | | +----------------------+------------------------------+---------------------------------------------------------------------------------------+ .. _ak-images: |ak| images ----------- The following images contain |ak-tm|. - |cp-kafka| is the Confluent official Docker image for |ak| and includes the Community Version of |ak|. - |confluent-local| is a |ak| package optimized for local development. This Docker image enables you to quickly start |ak| in |kraft| mode with no configuration setup. - Note that the :ref:`cp-server-image` package listed in the next section includes everything in |cp-kafka| and additional commercial features that are only available as a part of the cp-server package. +------------------------------+-------------------------------------------------+----------------------------------------------------------------------------+ | Image Name | Packages Included (License) | GitHub Repo | +==============================+=================================================+============================================================================+ | |cp-kafka| | - confluent-kafka (|apache-2|) | `kafka-images `__ | +------------------------------+-------------------------------------------------+----------------------------------------------------------------------------+ | |confluent-local| | - confluent-kafka (|apache-2|) | `kafka-images `__ | | | - confluent-kafka-rest (|comm|) | | +------------------------------+-------------------------------------------------+----------------------------------------------------------------------------+ .. _cp-server-image: Confluent Server image ---------------------- |cs| is a component of |cp| that includes everything in the :ref:`cp-kafka ` package and additional commercial features that are only available as a part of the cp-server package. Following are a few key features included in |cs|: - Role-based access control (RBAC). - Tiered Storage - Self-Balancing Clusters - Confluent for Kubernetes +------------------------------+-------------------------------------------------+----------------------------------------------------------------------------+ | Image Name | Packages Included (License) | GitHub Repo | +==============================+=================================================+============================================================================+ | |cp-server| | - cp-server (|ent|) | `kafka-images `__ | | | - cp-security (|ent|) | | | | - cp-rebalancer (|ent|) | | +------------------------------+-------------------------------------------------+----------------------------------------------------------------------------+ |sr| image ---------- |sr| provides a centralized repository for managing and validating schemas for topic message data, and for serialization and deserilazation of the data over the network. +--------------------------------------+--------------------------------------+---------------------------------------------------------------------------------------+ | Image Name |Packages Included (License) | GitHub Repo | +======================================+======================================+=======================================================================================+ | |cp-schema-registry| | - confluent-schema-registry (|comm|) | `schema-registry-images `__ | | | - confluent-telemetry (|ent|) | | | | - confluent-security (|ent|) | | +--------------------------------------+--------------------------------------+---------------------------------------------------------------------------------------+ Connect images -------------- |kconnect| is part of |ak| and is used to integrate external systems with |ak|. - The ``cp-server-connect`` and the ``cp-server-connect-base`` images are identical, as are the ``cp-kafka-connect`` and the ``cp-kafka-connect-base`` images. Prior to |cp| 6.0, the ``cp-server-connect`` and ``cp-kafka-connect`` images included some connectors pre-installed, but this is no longer the case. +-------------------------------------+--------------------------------------------------+------------------------------------------------------------------+ | Image Name | Packages Included (License) | GitHub Repo | +=====================================+==================================================+==================================================================+ | |cp-kafka-connect| | - confluent-schema-registry (|comm|) | `kafka-images `__ | | | - confluent-control-center (|ent|) | | | | - confluent-hub-client (|ent|) | | +-------------------------------------+--------------------------------------------------+------------------------------------------------------------------+ | |cp-kafka-connect-base| | - confluent-schema-registry (|comm|) | `kafka-images `__ | | | - confluent-control-center (|ent|) | | | | - confluent-hub-client (|ent|) | | +-------------------------------------+--------------------------------------------------+------------------------------------------------------------------+ | |cp-server-connect| | - confluent-schema-registry (|comm|) | `kafka-images `__ | | | - confluent-control-center (|ent|) | | | | - confluent-hub-client (|ent|) | | +-------------------------------------+--------------------------------------------------+------------------------------------------------------------------+ | |cp-server-connect-base| | - confluent-schema-registry (|comm|) | `kafka-images `__ | | | - confluent-control-center (|ent|) | | | | - confluent-hub-client (|ent|) | | +-------------------------------------+--------------------------------------------------+------------------------------------------------------------------+ |ksqldb| images --------------- |ksqldb| enables you to build event streaming applications leveraging your familiarity with relational databases. The ``cp-ksqldb-server`` image contains Confluent monitoring interceptors. The monitoring interceptors enable connectors and SQL queries to collect metrics that can be visualized in |c3|. +----------------------------+-------------------------------------+--------------------------------------------+---------------------------------------------------------------------------------------+ | Component | Image Name | Packages Included (License) | GitHub Repo | +============================+=====================================+============================================+=======================================================================================+ | |ksqldb| CLI | |cp-ksqldb-cli| | - ksqldb-cli (|comm|) | `ksql-images `__ | | | | - confluent-hub (|ent|) | | +----------------------------+-------------------------------------+--------------------------------------------+---------------------------------------------------------------------------------------+ | |ksqldb| Server | |cp-ksqldb-server| | - ksqldb-server (|comm|) | `ksql-images `__ | | | | - confluent-telemetry (|ent|) | | | | | - confluent-hub (|ent|) | | | | | - confluent-security (|ent|) | | +----------------------------+-------------------------------------+--------------------------------------------+---------------------------------------------------------------------------------------+ |crest| image ------------- |crest| provides a RESTful interface to an |ak| cluster, making it easy to produce and consume messages, view the state of the cluster, and perform administrative actions without using the native |ak| protocol or clients. The |crest| image provides Confluent monitoring interceptors in the ``confluent-control-center`` package. The monitoring interceptors enable connectors and SQL queries to collect the metrics that can be visualized in |c3|. +------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+ | Image Name | Packages Included (License) | GitHub Repo | +==============================+==========================================+=======================================================================================+ | |cp-kafka-rest| | - confluent-kafka-rest (|comm|) | `kafka-rest-images `__ | | | - confluent-control-center (|ent|) | | +------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+ |confluent-cli| image --------------------- The |confluent-cli| (CLI) enables developers to manage both |ccloud| and |cp| and is source-available under the Confluent Community License. +-------------------------------------+--------------------------------------------------+------------------------------------------------------------------+ | Image Name | Packages Included (License) | GitHub Repo | +=====================================+==================================================+==================================================================+ | |cli| | - confluent-cli (|comm|) | `cli `__ | +-------------------------------------+--------------------------------------------------+------------------------------------------------------------------+ |c3-short| image ---------------- |c3-short| is a self-hosted web-based tool for managing and monitoring key components of |cp|. +-------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------+ | Image Name | Packages Included/License | GitHub Repo | +=====================================+==================================================+=======================================================================================+ | |cp-enterprise-control-center| | - confluent-control-center (|ent|) | `control-center-images `__ | +-------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------+ kcat utility image ------------------ kcat is a command-line utility that you can use to test and debug |ak| deployments. +------------------------------+--------------------------------------------------+----------------------------------------------------------------------------+ | Image Name | Packages Included (License) | GitHub Repo | +==============================+==================================================+============================================================================+ | |cp-kcat| | - kafkacat (|apache-c|) | `kafkacat-images `__ | +------------------------------+--------------------------------------------------+----------------------------------------------------------------------------+ MQTT Proxy image ---------------- MQTT Proxy provides a scalable and lightweight interface that enables MQTT clients to produce messages to |ak| directly, in a |ak|-native way, that avoids redundant replication and increased lag. +------------------------------+--------------------------------------------------+----------------------------------------------------------------------------+ | Image Name | Packages Included (License) | GitHub Repo | +==============================+==================================================+============================================================================+ | |cp-kafka-mqtt| | - confluent-kafka-mqtt (|ent|) | `kafka-mqtt-images `__ | +------------------------------+--------------------------------------------------+------------------------------------------+---------------------------------+ |crep| images ------------- |crep| enables you to easily and reliably replicate topics from one |ak| cluster to another. +-----------------+---------------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+ | Component | Image Name | Packages Included (License) | GitHub Repo | +=================+=======================================+==========================================+=======================================================================================+ | |crep| | |cp-enterprise-replicator| | - confluent-kafka-replicator (|ent|) | `kafka-replicator-images `__ | +-----------------+---------------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+ | |crep| | |cp-enterprise-replicator-executable| | - confluent-kafka-replicator (|ent|) | `kafka-replicator-images `__ | | Executable | | | | +-----------------+---------------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+ |zk| image ---------- |ak| uses |zk| to store persistent cluster metadata and was a critical component of the |cp| deployment. Starting with |ak| 3.4, :ref:`KRraft` is the default for cluster metadata management. +-------------------------------------+--------------------------------+-----------------------------------------------------------------------------------+ | Image Name | Packages Included (License) | GitHub Repo | +=====================================+================================+===================================================================================+ | |cp-zookeeper| | - confluent-kafka (|apache-2|) | `kafka-images `__ | +-------------------------------------+--------------------------------+-----------------------------------------------------------------------------------+ |cp| image tags *************** The |cp| Docker images are tagged as follows: .. codewithvars:: text --. ```` is incremented when an updated image needs to be uploaded for the same ````. For example, for the |cp| |release| images with RHEL UBI 8 being the only supported and default OS, the available RHEL UBI 8 ``cp-base-new`` image tags are: .. codewithvars:: text |release|-1-ubi8.amd64 |release|.amd64 latest.amd64 |release|-1-ubi8 |release| latest |release|-1-ubi8.arm64 |release|.arm64 latest.arm64 Linux ARM64 Docker images can be used on Apple macOS with M1. Additional tags are applied to the image of the default OS type: - To identify the image as being the default image for a given release. .. codewithvars:: text - To identify the most recent version of the image of the default OS type. .. codewithvars:: text latest For the supported OS types in |cp| |version|, see :ref:`Supported Versions for Confluent Docker Images `. .. |comm| replace:: `Confluent Community License `__ .. |ent| replace:: Confluent Enterprise License .. |cli| replace:: `confluent-cli `__ .. |apache-c| replace:: `Apache Kafka C Driver License `__ .. |apache-2| replace:: `Apache 2 License `__ .. |cp-base-lite| replace:: `cp-base-lite `__ .. |cp-base-new| replace:: `cp-base-new `__ .. |cp-enterprise-control-center| replace:: `cp-enterprise-control-center `__ .. |cp-kafka-connect| replace:: `cp-kafka-connect `__ .. |cp-kafka-connect-base| replace:: `cp-kafka-connect-base `__ .. |cp-server-connect| replace:: `cp-server-connect `__ .. |cp-server-connect-base| replace:: `cp-server-connect-base `__ .. |cp-kafka| replace:: `cp-kafka `__ .. |confluent-local| replace:: `confluent-local `__ .. |cp-server| replace:: `cp-server `__ .. |cp-kafka-rest| replace:: `cp-kafka-rest `__ .. |cp-kcat| replace:: `cp-kcat `__ .. |cp-kafka-mqtt| replace:: `cp-kafka-mqtt `__ .. |cp-ksqldb-cli| replace:: `cp-ksqldb-cli `__ .. |cp-ksqldb-server| replace:: `cp-ksqldb-server `__ .. |cp-enterprise-replicator| replace:: `cp-enterprise-replicator `__ .. |cp-enterprise-replicator-executable| replace:: `cp-enterprise-replicator-executable `__ .. |cp-schema-registry| replace:: `cp-schema-registry `__ .. |cp-zookeeper| replace:: `cp-zookeeper `__