.. _image_reference:

Docker Image Reference
======================

The |cp| images are available on `Docker Hub <https://hub.docker.com/u/confluentinc/>`_. 
The source files for the images are available on the GitHub repos. From GitHub 
you can extend and rebuild the images and upload them to your own DockerHub
repository.

The following table lists the available images and the Confluent software
packages that they contain. Some images are identified as
```cp-enterprise-${component_name}```. These images include proprietary
components that must be licensed from Confluent when deployed.

+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| Component       | Image Name                          | License                      | Packages Included                        | GitHub Repo                                                                           |
+=================+=====================================+==============================+==========================================+=======================================================================================+
| Base Image      | cp-base-new                         | |community-license|          | - zulu-openjdk-8                         | `common-docker <https://github.com/confluentinc/common-docker>`__                     |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |c3-short|      | cp-enterprise-control-center        | |commercial-license|         | - confluent-control-center               | `control-center-images <https://github.com/confluentinc/control-center-images>`__     |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |cs|            | cp-server :sup:`*`                  | |commercial-license|         | - cp-server                              | `kafka-images <https://github.com/confluentinc/kafka-images>`__                       |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |ak|            | cp-kafka :sup:`*`                   | |community-license|          | - confluent-kafka-|scala_version|        | `kafka-images <https://github.com/confluentinc/kafka-images>`__                       |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |ak|            | cp-kafka-mqtt                       | |commercial-license|         | - confluent-kafka-mqtt                   | `kafka-mqtt-images <https://github.com/confluentinc/kafka-mqtt-images>`__             |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |ak|            | cp-kafkacat                         | |community-license|          | - kafkacat                               | `kafkacat-images <https://github.com/confluentinc/kafkacat-images>`__                 |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |ak|            | cp-enterprise-kafka :sup:`*`        | |commercial-license|         | - confluent-kafka-|scala_version|        | `kafka-images <https://github.com/confluentinc/kafka-images>`__                       |
|                 |                                     |                              | - confluent-rebalancer                   |                                                                                       |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |kconnect-long| | cp-kafka-connect :sup:`**`          | |community-license|          | - confluent-schema-registry              | `kafka-images <https://github.com/confluentinc/kafka-images>`__                       |
|                 |                                     |                              | - confluent-control-center               |                                                                                       |
|                 |                                     |                              | - confluent-kafka-connect-elasticsearch  |                                                                                       |
|                 |                                     |                              | - confluent-kafka-connect-jdbc           |                                                                                       |
|                 |                                     |                              | - confluent-kafka-connect-s3             |                                                                                       |
|                 |                                     |                              | - confluent-monitoring-interceptors      |                                                                                       |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |kconnect-long| | cp-kafka-connect-base               | |community-license|          | - confluent-common                       | `kafka-images <https://github.com/confluentinc/kafka-images>`__                       |
|                 |                                     |                              | - confluent-schema-registry              |                                                                                       |
|                 |                                     |                              | - confluent-control-center               |                                                                                       |
|                 |                                     |                              | - confluent-control-center-fe            |                                                                                       |
|                 |                                     |                              | - confluent-hub-client                   |                                                                                       |
|                 |                                     |                              | - confluent-kafka-|scala_version|        |                                                                                       |
|                 |                                     |                              | - confluent-rebalancer                   |                                                                                       |
|                 |                                     |                              | - confluent-rest-utils                   |                                                                                       |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |kconnect-long| | cp-server-connect                   | |commercial-license|         | - confluent-kafka-connect-jdbc           | `kafka-images <https://github.com/confluentinc/kafka-images>`__                       |
|                 |                                     |                              | - confluent-kafka-connect-elasticsearch  |                                                                                       |
|                 |                                     |                              | - confluent-kafka-connect-storage-common |                                                                                       |
|                 |                                     |                              | - confluent-kafka-connect-s3             |                                                                                       |
|                 |                                     |                              | - confluent-kafka-connect-jms            |                                                                                       |
|                 |                                     |                              | - kafka-connect-gcs                      |                                                                                       |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |kconnect-long| | cp-server-connect-base              | |commercial-license|         | - confluent-schema-registry              | `kafka-images <https://github.com/confluentinc/kafka-images>`__                       |
|                 |                                     |                              | - confluent-control-center               |                                                                                       |
|                 |                                     |                              | - confluent-security                     |                                                                                       |
|                 |                                     |                              | - confluent-hub-client                   |                                                                                       |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |ksqldb| CLI    | cp-ksqldb-cli                       | |community-license|          | - ksqldb-cli                             | `ksql-images <https://github.com/confluentinc/ksql-images>`__                         |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |ksqldb| Server | cp-ksqldb-server :sup:`**`          | |community-license|          | - ksqldb-server                          | `ksql-images <https://github.com/confluentinc/ksql-images>`__                         |
|                 |                                     |                              | - confluent-monitoring-interceptors      |                                                                                       |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |crep|          | cp-enterprise-replicator            | |commercial-license|         | - confluent-kafka-replicator             | `kafka-replicator-images <https://github.com/confluentinc/kafka-replicator-images>`__ |
|                 |                                     |                              | - confluent-schema-registry              |                                                                                       |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |crep|          | cp-enterprise-replicator-executable | |commercial-license|         | - confluent-kafka-replicator             | `kafka-replicator-images <https://github.com/confluentinc/kafka-replicator-images>`__ |
| Executable      |                                     |                              | - confluent-schema-registry              |                                                                                       |
|                 |                                     |                              | - confluent-control-center               |                                                                                       |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |crest|         | cp-kafka-rest                       | |community-license|          | - confluent-kafka-rest                   | `kafka-rest-images <https://github.com/confluentinc/kafka-rest-images>`__             |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |sr|            | cp-schema-registry                  | |community-license|          | - confluent-schema-registry              | `schema-registry-images <https://github.com/confluentinc/schema-registry-images>`__   |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+
| |zk|            | cp-zookeeper                        | |community-license|          | - confluent-kafka                        | `kafka-images <https://github.com/confluentinc/kafka-images>`__                       |
+-----------------+-------------------------------------+------------------------------+------------------------------------------+---------------------------------------------------------------------------------------+

[*] The **cp-kafka** image includes Community Version of |ak|.  The
**cp-enterprise-kafka** image includes everything in the cp-kafka image and adds
confluent-rebalancer (ADB). The **cp-server** image includes additional
commercial features that are only part of the :ref:`confluent-server package
<confluent-server-package>`. The cp-enterprise-kafka image will be deprecated in
a future version and will be replaced by cp-server.

[**] The **cp-kafka-connect** and **cp-ksqldb-server** images contain Confluent monitoring
interceptors. The monitoring interceptors enable connectors and SQL queries to
collect the  metrics that can be visualized in |c3|. The |kconnect| image
includes |c3-short| in its entirety while the |ksqldb| Server image just
includes the monitoring interceptors. No explicit license is required when
using the |kconnect| or the |ksqldb| Server image on their own.
   
|cp| image tags
---------------

The |cp| Docker images are tagged as follows.

::

   <cp_version>-<image_release_number>-<os_type>

``<image_release_number>`` is incremented when an updated image needs to be
uploaded for the same ``<cp-version>``.

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.

  :: 

   <cp_version>

- To identify the most recent version of the image of the default OS type.

  ::
    
   latest

For the supported OS types in |cp| |version|, see :ref:`Supported Versions for
Confluent Docker Images <docker-sys-req>`.

For example, for |cp| 5.5 images with Debian 8 being the default OS, the available tags are as follow.

- The RHEL UBI 8 cp-base-new image tag:

  .. codewithvars:: bash

    |release|-1-ubi8

- The Debian 8 cp-base-new image tags:

  .. codewithvars:: bash

    |release|-1-deb8
    |release|
    latest