Important

You are viewing documentation for an older version of Confluent Platform. For the latest, click here.

Auto-updating the Control Center user interface

The Auto-update feature enables access to the most current version of the Control Center user interface (UI) within a minor release. The feature provides a more frequent cadence of releases for Control Center between patch releases. Updates can include security enhancements, minor features, and bug fixes. The feature does not update the UI between minor or major release versions, such as from 5.4 to 5.5; or from 5.4 to 6.0 respectively. The feature is available from Confluent Platform version 5.4 and later.

The Auto-update feature does not install Control Center locally; it serves the most current frontend JavaScript assets to your client browser over an internet connection. If your internet connection or the service hosting the updated Control Center UI becomes unavailable, the UI version temporarily reverts to your local installed packaged version of Control Center. Banner messages and messages in the Updates tab inform you of the version you are using and its feature updates.

When the feature is enabled and an update is detected as available, a banner message instructs you to refresh your browser to access the updated UI. You can click the Refresh button on the Control Center Updates page, use the browser UI refresh controls, or use the command keys for your OS, such as Mac command + R.

The feature is disabled by default.

Advantages of enabling Auto-update:

  • All Control Center users are accessing the same version of the UI. The feature is enabled installation-wide for an instance.
  • Users have access to the most current version of Control Center. There is no waiting for a packaged Confluent Platform update.

Note

For Control Center 5.4.1 and earlier, if RBAC is enabled, the Auto-update feature cannot be used.

Enabling auto-updates UI

  1. In the appropriate control-center.properties file for your environment, uncomment (remove the hash # from) the #confluent.controlcenter.ui.autoupdate.enable=true configuration property.

  2. Restart Control Center and pass in the appropriate properties file.

    To disable the feature, set the option to false or comment it out again and restart Control Center.

    For more information about restarting Control Center and passing in its properties files, see Control Center properties files.

Viewing UI updates status

The Updates page provides:

  • Whether the Auto-update feature is enabled or disabled.
  • Status on the current user interface version you are using.
  • A Refresh button when an update is available.
  • Embedded release notes for the version updates. You can also view the interim release notes for Control Center UI Auto-updates, which will contain all interim releases listed by their version number.
  1. From the Administration menu, click Status & settings.

  2. Click the Updates tab.

    Auto UI updates status page current

    Auto UI updates status page up-to-date

    Auto UI updates status page needs refresh

    Auto UI updates status needs refresh

Troubleshooting auto-updates

A status message that indicates you are not using the most current UI version can occur under the following circumstances:

  • Your internet connection is down.
  • Your organization does not allow outside internet access.
  • No access to the Confluent CDN (Content Delivery Network). Supported client browsers must have access to all subdomains of *.confluent.io.
  • No access to Launch Darkly that manages certain Confluent features. Supported client browsers must have access to all subdomains of *.launchdarkly.com.

To remedy:

  • If your personal internet connection is down, contact your Internet Service Provider.

  • If your organization’s internet connection is down, or you require external internet access from behind a firewall, contact your system administrator.

    Note

    If your organization’s security policies prohibit external internet access, you cannot use the auto-update feature for interim releases. The auto-update features will become available in the packaged releases.

  • If your internet connection is up, and you do not have current UI access, the Confluent CDN or Launch Darkly connections for Confluent could be down. Contact Confluent Support for assistance.