.. title: Manage Kafka Clusters Using Control Center for Confluent Platform .. meta:: :description: This document describes managing Kafka clusters using the Confluent Control Center user interface. Control Center enables dynamic broker configurations, which means that no restart is necessary. You can also use Control Center to edit a cluster name, work with Self-Balancing Clusters, and configure Tiered Storage. .. _controlcenter_userguide_cluster_settings: .. _controlcenter_userguide_clusters: Manage |ak| Clusters Using |c3-short| for |cp| ============================================== The Clusters page enables you to view tiles for healthy and unhealthy clusters at a glance or search for a cluster being managed by |c3-short|. What you see on the Clusters page varies depending on whether you are running |c3-short| in :ref:`Normal or Reduced infrastructure mode `. The following image shows a example of the Clusters page in Normal mode. Click on a cluster tile for a view of metrics for that cluster. .. figure:: ../images/c3-clusters-main-page.png :width: 400px :alt: Clusters at a glance Clusters - Normal mode .. _controlcenter_userguide_cluster_overview: Cluster overview page --------------------- The overview page for a single |ak-tm| cluster provides a summary view of the cluster and its connected services. .. figure:: ../images/basics-c3-cluster-overview.png :width: 800 :alt: Normal mode and Reduced infrastructure mode The following table describes the panels found on the Clusters page by mode. All of the panels are clickable and navigate you directly to the relevant sections. .. list-table:: :widths: 15 35 35 :header-rows: 1 * - Section - Normal mode - Reduced infrastructure mode * - :ref:`Brokers overview ` - Total brokers with production and consumption throughput. - Not visible in Reduced infrastructure mode. * - :ref:`Topics overview ` - Total topics, total partitions, under replicated partitions, out of sync replicas. - Total topics and total partitions. * - :ref:`Connect overview ` - Number of |kconnect| clusters and connector status. - Same as Normal mode. * - :ref:`ksqlDB overview ` - Number of |ksqldb| clusters and persistent queries. - Same as Normal mode. You can view and edit cluster properties and broker configurations in the Cluster settings pages. When you click the Cluster settings sub-menu for a cluster, the **General** tab appears by default. .. _edit_cluster_name: Edit a cluster name ------------------- You can edit the cluster name and view the host details. The host field lock icon indicates it cannot be changed. To change the cluster name: #. Click the cluster from the cluster navigation bar. #. Click the **Cluster settings** menu. #. Edit the cluster name in **Cluster Name** field. You should choose a human-friendly name for the cluster that follows these rules: - Cluster names can only include characters from the English alphabet, numbers, underscores (_), and dashes (-). - Cluster names are case-sensitive. The new cluster name is saved to the :ref:`cluster-registry`, if it is enabled. #. Click **Save changes** to apply your changes. .. figure:: /images/c3-cluster-settings-kafka.png :width: 400px :alt: Cluster settings Kafka tab .. _view_broker_config: View-only cluster configuration ------------------------------- View the cluster configuration. If broker configuration editing is :ref:`disabled`, the view is read-only and the :ref:`Edit Settings` feature is not available. .. important:: If :ref:`RBAC ` is enabled for |c3-short|, it takes precedence over Access Control settings. The privileges associated with your assigned roles determine what you can view and access. To view a cluster configuration: #. Click the cluster from the cluster navigation bar. #. Click the **Cluster settings** menu. #. Click the **Cluster defaults** tab. .. figure:: /images/c3-broker-defaults.png :scale: 70% :alt: Expected different config values for brokers Each setting section indicates if there are overrrides applied to that setting. .. _edit_broker_config: Edit dynamic cluster configuration settings ------------------------------------------- The dynamic cluster configuration option is :ref:`enabled by default `. The feature allows editing cluster configurations within |c3-short| that do not require a restart. Any configuration option that has a ``per-broker`` or ``cluster-wide`` Dynamic Update Mode can be edited. Any options designated as ``read-only`` for the dynamic update mode requires a restart and cannot be edited dynamically. For information about available broker configuration options, including the dynamic update mode per option, see :ref:`cp-config-brokers`. To edit the cluster configuration: #. Click the cluster from the cluster navigation bar. #. Click the **Cluster settings** menu. #. Click the **Cluster defaults** tab. #. Find the section for the setting you want to edit, and click **Edit settings**. #. Hover over the info icon for a configuration option to view its description. #. Make your configuration changes. #. Notice a blue undo icon indicates the setting was modified from the default value and you can set it back to the default by clicking the arrow. A gray undo icon indicates the settings is set to its default. .. figure:: /images/c3-broker-configs-edit.png :width: 400px :alt: Edit cluster settings on a cluster #. Click **Save** to save your changes, or **Cancel** to cancel edits to settings. To see examples of changing broker configurations dynamically using the |ak| command line kafka-configs tool, see :ref:`kafka_dyn_broker_config`. .. _ff_c3_edit_broker_configs: Enable and disable dynamic editing of broker configurations ----------------------------------------------------------- The Dynamic Cluster Configuration feature that allows editing settings without a restart is enabled by default. The feature can be disabled in |c3-short| if an organization does not want any users to access the feature. After disabling the feature, the Edit Settings button in the Brokers tab in the |c3-short| UI is no longer visible. .. important:: If :ref:`RBAC ` is enabled for |c3-short|, it takes precedence over :ref:`Access Control ` settings. To disable the edit broker config settings feature in |c3-short|: #. Set the ``confluent.controlcenter.broker.config.edit.enable`` option in your ``control-center.properties`` file to ``false``. .. code:: bash ... confluent.controlcenter.broker.config.edit.enable=false ... .. note:: Make the change in the appropriate |c3-short| properties files configured for your environments, including ``control-center-dev.properties`` or ``control-center-production.properties``. The properties files are located in ``/path-to-confluent/etc/confluent-control-center/``. #. Restart |c3-short| and pass in the properties file for the configuration to take effect. For more information, see :ref:`c3_properties_files`. - Local (dev) environment: .. important:: Do not use :confluent-cli:`confluent local|command-reference/local/index.html` for production use. .. sourcecode:: bash confluent local services control-center stop confluent local services control-center start --config ../etc/confluent-control-center/control-center.properties - Production environment: .. sourcecode:: bash ./bin/control-center-stop ./bin/control-center-start ../etc/confluent-control-center/control-center.properties To enable the feature again, set the option back to ``true`` and restart |c3-short| with the updated properties file. .. _c3-sbc: Work with |sbc-long| -------------------- For a complete guide to |sbc-long|, see :ref:`sbc`, including a primer on :ref:`sbc-config-and-monitor` and comprehensive hands-on :ref:`tutorial `. Monitor and configure |sbc| ~~~~~~~~~~~~~~~~~~~~~~~~~~~ #. Click the cluster from the cluster navigation bar. #. Click the **Cluster settings** menu. #. Click the **Self-balancing** tab. .. figure:: ../images/sbc-c3.png #. To change dynamic configurations, click **Edit Settings**. |sbc| has several dynamic properties which can be configured while the cluster is running, including options to: - Turn |sbc| **On** or **Off**. In the example ``server.properties`` file that ships with |cp|, :ref:`sbc-config-enable` is set to ``true``, which means |sbc| is on. - Override the default throttle value (10485760 or 10MB/sec), which determines the maximum network bandwidth available for |sbc|. (:ref:`sbc-config-throttle`) - Toggle the trigger condition for rebalance to either **Only when brokers are added or removed** (the default) or **Anytime**. (:ref:`sbc-config-heal-uneven-load`) #. Make changes and click **Save**. When |sbc| is on and set to trigger **Only when brokers are added or removed** (the default), the card on the Brokers overview shows "Workload optimizer" as "Disabled". .. figure:: ../images/sbc-c3-card-empty-broker.png :scale: 70% When |sbc| is on, and set to trigger **Anytime**, the card on the Brokers overview shows "Workload optimizer" as "Balanced" if rebalancing is not in progress, or one of the work-in-progress statuses during a rebalance. .. figure:: ../images/sbc-c3-card-any-uneven-load.png :scale: 70% .. _c3-sbc-remove-broker: Remove a broker ~~~~~~~~~~~~~~~ If you remove a broker from the cluster, |sbc| will redistribute topic data to the other brokers. A summary of this procedure is shown below. For a more detailed walkthrough, see :ref:`sbc-tutorial-c3-remove-broker` in the context of the :ref:`sbc-tutorial`. .. include:: ../clusters/includes/sbc-remove-broker-tips.rst #. Remove a broker using the |c3-short| option on the **Brokers overview** page. - Select **Brokers**, scroll to the bottom of the Overview page to view the list of brokers currently online. - Select a broker to remove, to drill down to its monitoring details. .. figure:: ../images/sbc-c3-select-a-broker.png :scale: 70% - At the bottom of this page, click **Remove broker**, then type REMOVE in the input field to verify that you want to take this action. When the broker removal is completed, click the confirm option to acknowledge. .. note:: If you get an :ref:`error message ` that broker removal failed due to insufficient metrics, |sbc| is still :ref:`initializing `, which can take up to 30 minutes. If this happens, retry broker removal after several minutes, and it should succeed. #. Use the |c3-short| to monitor the rebalance. On |c3-short| click **Cluster settings** > **Self-balancing** to track the progress. When the rebalance is complete, both the **Brokers overview** page and **Cluster settings** > **Broker defaults** will show only the remaining brokers, and not the one you removed. Suggested Resources ~~~~~~~~~~~~~~~~~~~ - To learn more, see :ref:`sbc`. - For troubleshooting related to |sbc| and |c3-short|, see :ref:`sbc-not-on-c3-troubleshoot`, :ref:`sbc-broker-metrics-not-shown-on-c3-troubleshoot`, and :ref:`sbc-ignore-consumer-lag-on-c3-troubleshoot` in the :ref:`Self-balancing Clusters troubleshooting section`. .. _c3-tiered-storage: Configure Tiered Storage ------------------------ For a complete guide to setting up and working with Tiered Storage, see :ref:`tiered-storage`. To configure and work with Tiered Storage starting from |c3-short|: #. Click the cluster from the cluster navigation bar. #. Click the **Cluster settings** menu. #. Click the **Tiered storage** tab. .. figure:: ../images/c3-storage.png :scale: 70% You can hide or show the on-screen setup instructions, which walk through cloud provider setup as fully described in :ref:`tiered-storage`. #. To view and edit dynamic settings, click **Edit settings**. .. figure:: ../images/c3-storage-dynamic-configs.png :width: 400 View or change settings and click **Cancel** or **Save changes** as appropriate. #. To set up storage, choose a cloud provider (click the **GCS** or **S3** tab). The S3 configuration options are shown here as an example. .. figure:: ../images/c3-storage-setup-s3.png :scale: 70% #. Specify property values and paths to your credentials, then click **Generate configurations**. .. figure:: ../images/c3-storage-setup-example.png :scale: 70% #. Copy the generated configurations block and paste it into the properties files for your brokers (for example, ``$CONFLUENT_HOME/etc/kafka/server.properties``). .. figure:: ../images/c3-storage-gen-configs-output.png :scale: 70% .. important:: - The same bucket must be used across all brokers within a Tiered Storage enabled cluster. This applies to all supported platforms. - The Tiered Storage internal topic defaults to a replication factor of ``3``. If you use ``confluent local services start`` to run a single broker cluster such as that described in :ref:`quickstart`,' you must add an additional line to the broker file, ``$CONFLUENT_HOME/etc/kafka/server.properties``: ``confluent.tier.metadata.replication.factor=1`` - As a recommended best practice, do not set a retention policy on the cloud storage (such as an AWS S3 bucket) because this may conflict with the |ak| topic retention policy. #. After you update these configurations to enable Tiered Storage, restart the brokers. This can be done in a :ref:`rolling ` fashion. #. View cluster-wide metrics for **Tiered Storage** are shown on the **Tiered Storage** card on the **Brokers** overview page for the cluster. .. figure:: ../images/c3-tiered-storage-metrics-overview.png :scale: 70% :alt: Tiered Storage panel enabled Click into these initial stats to view a metrics chart for Tiered Storage. .. figure:: ../images/c3-tiered-storage-metrics.png :scale: 70% :alt: Tiered Storage metrics chart Hover and slide the cursor over a chart to get details on data at any particular point in time. .. figure:: ../images/c3-tiered-storage-metrics-details.png :scale: 70% :alt: Tiered Storage metrics detail on hover #. To get storage metrics on a specific topic, navigate to the topic (choose **Cluster > Topics**, select a topic from the list). The **Storage** card is shown on the Overview page for the topic. .. figure:: ../images/c3-tiered-storage-metrics-on-topic.png :scale: 70% :alt: Tiered Storage metrics on a single topic To learn more, see :ref:`tiered-storage`.