Important

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

Control Center properties files

Several Control Center example properties files reside in the etc/confluent-control-center directory located in your CONFLUENT_HOME directory. These files contain critical configuration options, some of which are set to defaults or commented out. Not all of the available configuration options are present in the properties files. For instance, the majority of the Access Control options are not present by default and must be added manually. Depending on the requirements of your environments, there are additional configuration options documented in the Control Center Configuration Reference that you can add and configure within your properties files. Defaults are typically different between the available properties file templates.

Note

Parameters are provided in the form of key/value pairs. Lines beginning with # are ignored. To uncomment an option, remove the hash (pound) that precedes it.

Available Control Center properties files:

control-center.properties
Default properties file.
control-center-dev.properties
Properties file for a development environment, including single broker under a developer license. The dev properties file is passed in by default with the start commands.
control-center-production.properties
Properties file for a production environment. Options must be set for production, such as a data directory other than /tmp, hostnames set rather than localhost, security features configured, and so forth.
control-center-minimal.properties
Properties file optimized for a local environment. Typically used for laptop demonstration purposes.

Passing in a Control Center properties file

By default, Control Center is aware of its properties files that reside in the $CONFLUENT_HOME/etc/confluent-control-center directory and reads them automatically when restarting using CLI commands. It is not necessary to explicitly pass in the properties file name when starting Control Center unless:

  • The properties file has a custom name. You might differentiate properties file names for testing purposes.
  • The properties file does not reside in the default directory. Control Center needs the full path to the properties file in this case.
  • The .minimal properties file must always be explicitly passed with a start command.
  • The properties file must always be passed in when using the bin start script.

Restarting Control Center

Follow these instructions for stopping and starting Control Center. Examples of passing in a properties file when necessary or not are provided.

Note

Make the change in the appropriate Control Center properties file or files configured for your environments, including control-center.properties, control-center-dev.properties, control-center-production.properties, and control-center-minimal.properties. The properties files are located in /path-to-confluent/etc/confluent-control-center/.

Example 1: Standard production environment

Example restarting Control Center and passing in the default properties file for the configuration to take effect:

./bin/control-center-stop
./bin/control-center-start ../etc/confluent-control-center/control-center.properties

Example 2: Custom properties filename and location

Example starting Control Center with the bin start script and passing in a custom properties filename and location:

./control-center-stop
./control-center-start /Users/myUserName/confluent/configs/c3.properties-rbac

The example assumes you are in the /bin directory.

Example 3: Local development environment

Example starting Control Center in a local (dev) environment with the local CLI. This example assumes you have configured your $CONFLUENT_HOME. There is no need to pass in the properties filename; Control Center passes in control-center-dev.properties automatically.

Important

Do not use confluent local for production use.

confluent local stop
confluent local start

Example properties file excerpts

This section shows a few fundamental differences between a development and production Control Center properties file.

Example excerpt from the production properties (control-center-production.properties) file:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
############################# Server Basics #############################

# A comma-separated list of Apache Kafka cluster host names (required)
# NOTE: should not be localhost
#bootstrap.servers=kafka1:9092
...

############################# Control Center Settings ###################

...
# Directory for Control Center to store data
# NOTE: this should be changed to point to a reliable directory
confluent.controlcenter.data.dir=/var/lib/confluent/control-center
...

Example excerpt from the development properties (control-center-dev.properties) file:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
############################# Server Basics #############################

# A comma-separated list of Apache Kafka cluster host names (required)
bootstrap.servers=localhost:9092
...

############################# Control Center Settings ###################

...
# Directory for Control Center to store data
# NOTE: this should be changed to point to a reliable directory
confluent.controlcenter.data.dir=/tmp/confluent/control-center
...

.. note:  The ``.dev`` file is pre-configured with
          ``localhost`` where applicable.  The data directory points to
          a ``/tmp`` directory.