Upgrading Control Center

Important

  • By default, the upgrade process will preserve the last 15 minutes of historical data. We have two properties that allow you to control how much history will be preserved: confluent.metrics.topic.skip.backlog.minutes for broker metrics and confluent.monitoring.interceptor.topic.skip.backlog.minutes for stream monitoring. Preserving history for longer will slow down restore time of Control Center after the upgrade, while preserving less history will speed the process up.
  • Every version of Confluent Control Center (even minor upgrades) will re-create a new set of topics, since topic names contain the full version number. It is a good idea to remove the old ones to avoid confusion.
  • For Confluent Platform version compatibility, see the compatibility matrix.

Upgrading from version 3.1.x and 3.2.x

  1. Upgrade Kafka brokers to Confluent Platform 3.3.1. Follow instructions in Confluent Platform Upgrade Guide.

  2. Upgrade the monitoring interceptors in all Kafka clients to Confluent Platform 3.3 (Optional if you are running at least Confluent Platform 3.1 version of the interceptors)

  3. Stop the Control Center process

  4. Copy the 3.1.x or 3.2.x configuration file

    $ sudo cp /etc/confluent-control-center/control-center.properties /etc/confluent-control-center/control-center-3.1.properties
    
  5. Upgrade Control Center packages to Confluent Platform 3.3

  6. Edit the Control Center properties file. Some configuration property names have changed

    • If you are running against a secured cluster you need to update your security configs. Properties named confluent.controlcenter.streams.{producer,consumer}.{sasl,ssl}.* are now confluent.controlcenter.streams.{sasl,ssl}.*
    • You can control the amount of historical stream monitoring data Control Center will process after the upgrade (which can take some time), by setting confluent.metrics.topic.skip.backlog.minutes for broker metrics and confluent.monitoring.interceptor.topic.skip.backlog.minutes for stream monitoring. They default to 15 minutes. Setting them to shorter period will allow Control Center to catch up and show current data faster, at the expense of not processing old data.
  7. Start Control Center

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

Upgrading from version 3.0.x

  1. Upgrade Kafka brokers to Confluent Platform 3.1

  2. Upgrade the monitoring interceptors in all Kafka clients to Confluent Platform 3.1

  3. Stop the Control Center process

  4. Copy the 3.0.x configuration file

    $ sudo cp /etc/confluent-control-center/control-center.properties /etc/confluent-control-center/control-center-3.0.properties
    
  5. Upgrade Control Center packages to Confluent Platform 3.1

  6. Reset the application (deleting internal state)

    $ # Use the same properties file you used to launch |c3-short|
    $ # 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
    
  7. Edit the Control Center properties file. Some configuration property names 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.
    • You can control the amount of historical stream monitoring data Control Center will process after the upgrade (which can take some time), by setting confluent.metrics.topic.skip.backlog.minutes for broker metrics and confluent.monitoring.interceptor.topic.skip.backlog.minutes for stream monitoring. They default to 15 minutes. Setting them to shorter period will allow Control Center to catch up and show current data faster, at the expense of not processing old data.
  8. Start Control Center

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