.. _ce-quickstart:

|cp| Quick Start (Local)
========================

Download `Confluent Platform <https://www.confluent.io/download/>`_ and use this quick start to get up and running with
|cp| and its main components in a development environment. This quick start demonstrates both the basic and most powerful capabilities of |cp|,
including using |c3-short| for topic management and event stream processing using KSQL. In this quick start you create
|ak-tm| topics, use |kconnect-long| to generate mock data to those topics, and create KSQL streaming queries on those
topics. You then go to |c3-short| to monitor and analyze the streaming queries.

.. include:: includes/cp-auto-demo.rst

.. important::
                .. include:: ../includes/java-snippet.rst

.. include:: includes/non-docker-prereqs.rst
   :start-line: 2
   :end-line: 5

.. _download-start-cp:

Step 1: Download and Start |cp|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

#.  Go to the `downloads page <https://www.confluent.io/download/>`_ and choose **Confluent Platform**.

    .. tip:: Download a previous version from `Previous Versions <https://www.confluent.io/previous-versions/>`_.

#.  Provide your name and email and select **Download**, and then choose the desired format ``.tar.gz`` or ``.zip``.

#.  Decompress the file. You should have the directories, such as ``bin`` and ``etc``.

#.  Set the environment variable for the |cp| directory.
    
    ::
      
        export CONFLUENT_HOME=<path-to-confluent>
        
#.  Add the |cp| ``bin`` directory to your
    `PATH <https://askubuntu.com/questions/720678/what-does-export-path-somethingpath-mean>`_.

    ::

        export PATH=$PATH:$CONFLUENT_HOME/bin

#.  .. include:: includes/quickstart-step3.rst
        :start-after: step-3-mid
        :end-before: step-3-run-instance-start

    .. code:: bash

              $CONFLUENT_HOME/bin/confluent-hub install \
              --no-prompt confluentinc/kafka-connect-datagen:latest

    Your output should resemble:

    .. code:: bash

       Running in a "--no-prompt" mode
       ...
       Completed

#.  Start |cp| using the |confluent-cli| :ref:`confluent_local_start` command. This command starts all of the |cp| components;
    including |ak|, |zk|, |sr|, HTTP REST Proxy for |ak|, |kconnect-long|, KSQL, and |c3-short|.

    .. include:: ../includes/cli.rst
       :start-after: cli_limitations_start
       :end-before: cli_limitations_end

    .. sourcecode:: bash

       confluent local start

    Your output should resemble:

    .. include:: ../includes/cli.rst
        :start-after: CE_CLI_startup_output
        :end-before: COS_CP_CLI_startup_output

.. step 2

.. include:: includes/ce-quickstart-step2.rst

.. step 3

.. include:: includes/quickstart-step3.rst
   :start-after: step-3-start
   :end-before: step-3-mid

.. tip:: The Kafka Connect Datagen connector was installed manually in :ref:`download-start-cp`. If you 
         encounter issues locating the Datagen Connector, refer to the :ref:`whereis_datagen_local` in the 
         Troubleshooting section.

#.  .. include:: includes/quickstart-step3.rst
       :start-after: step-3-run-instance-start
       :end-before: step-3-run-instance-end

    .. include:: includes/ce-quickstart-datagen-pageviews.rst

#.  .. include:: includes/quickstart-step3.rst
        :start-after: step-3-run-instance-end
        :end-before: step-3-run-another-instance-end

    .. include:: includes/ce-quickstart-datagen-users.rst

.. step 4

.. _ce_create_stream_table:

.. include:: includes/ce-quickstart-step4.rst
    :start-after: intro_start
    :end-before: intro_end

.. _ce-ksql-quickstart:

.. tip:: You can also run these commands using the :ref:`KSQL CLI <install_ksql>` from your terminal
         with this command: ``<path-to-confluent>/bin/ksql http://localhost:8088``.

.. include:: includes/ce-quickstart-step4.rst
    :start-after: intro_end

.. step 5

.. include:: includes/ce-quickstart-step5.rst

.. step 6

Step 6: Stop |cp|
^^^^^^^^^^^^^^^^^^^^^

When you are done working with the local install, you can stop |cp|.

#.  Stop |cp| using the :ref:`Confluent CLI <cli>` :ref:`confluent_local_stop` command.

    .. sourcecode:: bash

       <path-to-confluent>/bin/confluent local stop

#.  Destroy the data in the |cp| instance with the :ref:`confluent_local_destroy` command.

    .. codewithvars:: bash

       <path-to-confluent>/bin/|confluent_destroy|

You can start the local install of |cp| again with the :ref:`confluent_local_start` command.

.. troubleshoot reuse ce local

.. include:: includes/ce-local-quickstart-troubleshoot.rst

.. next steps

.. include:: includes/ce-quickstart-next-steps.rst