.. _controlcenter_upgrade:

Upgrading
=========

.. note::
  The upgrade process will not preserve historical data older
  than the configured retention time ``confluent.monitoring.interceptor.topic.retention.ms`` for the
  stream monitoring topic and ``confluent.metrics.topic.retention.ms`` for broker metrics

Upgrading from version 3.1.x
----------------------------

 #. Upgrade Kafka brokers to CP 3.2

 #. Upgrade the monitoring interceptors in all Kafka clients to CP 3.2 (Optional if you are running at least CP 3.1 version of the interceptors)

 #. Stop the Control Center process

 #. Copy the 3.1.x configuration file

     .. sourcecode:: bash

       $ sudo cp /etc/confluent-control-center/control-center.properties /etc/confluent-control-center/control-center-3.1.properties

 #. Upgrade Control Center packages to CP 3.2

 #. Edit the Control Center properties file.  Some :ref:`configuration property names <controlcenter_configuration>` have changed

     * If you are running against a secured cluster you need to update your :ref:`security configs<kafka_encryption_authentication_authorization_settings>`. Properties named confluent.controlcenter.streams.{producer,consumer}.{sasl,ssl}.* are now confluent.controlcenter.streams.{sasl,ssl}.*
     * If you do not want to re-process any historical stream monitoring data (which can take some time), set ``confluent.controlcenter.streams.consumer.auto.offset.reset=latest``. Doing this will allow Control Center to catch up and show current data faster, at the expense of not processing old data.

 #. Start Control Center

     .. sourcecode:: bash

       $ /usr/bin/control-center-start /etc/confluent-control-center/control-center.properties


Upgrading from version 3.0.x
----------------------------

 #. Upgrade Kafka brokers to CP 3.1

 #. Upgrade the monitoring interceptors in all Kafka clients to CP 3.1

 #. Stop the Control Center process

 #. Copy the 3.0.x configuration file

     .. sourcecode:: bash

       $ sudo cp /etc/confluent-control-center/control-center.properties /etc/confluent-control-center/control-center-3.0.properties

 #. Upgrade Control Center packages to CP 3.1

 #. Reset the application (deleting internal state)

     .. sourcecode:: bash

       $ # Use the same properties file you used to launch Control Center
       $ # From 3.0.1
       $ /usr/bin/control-center-3_0_1-reset /etc/confluent-control-center/control-center-3.0.properties
       $ # From 3.0.0
       $ /usr/bin/control-center-3_0_0-reset /etc/confluent-control-center/control-center-3.0.properties

 #. Edit the Control Center properties file.  Some :ref:`configuration property names <controlcenter_configuration>` have changed

     * If you had set the ``confluent.controlcenter.name`` parameter, we suggest changing the value to reflect the new version (e.g. _confluent-controlcenter-3-1-0). This isn't strictly necessary but a good precaution in case any step of the reset failed.
     * If you do not want to re-process any historical stream monitoring data (which can take some time), set ``confluent.controlcenter.streams.consumer.auto.offset.reset=latest``.

 #. Start Control Center

     .. sourcecode:: bash

       $ /usr/bin/control-center-start /etc/confluent-control-center/control-center.properties