Connecting Schema Registry to Confluent Cloud

You can install and configure Schema Registry for Confluent Cloud.

Prerequisites

• Access to Confluent Cloud.
• Confluent Cloud CLI installed and configured.
• A Confluent Cloud instance is running.
• A local version of Confluent Platform is installed by using the Confluent CLI. See Confluent Platform Quick Start (Local) for basic instructions.

Note

The Confluent Platform installation provides the binaries for Schema Registry that run locally and connect to your Confluent Cloud cluster. You do not have to start the other Confluent Platform services.

1. Configure Schema Registry by modifying etc/schema-registry/schema-registry.properties. Refer to ~/.ccloud/config to get the Confluent Cloud properties settings to use. The minimally required Schema Registry property settings for Confluent Cloud are provided below:

   # If set to true, API requests that fail will include extra debugging information, including stack traces.
   debug=false
   
   # REQUIRED: Specifies the bootstrap servers for your Kafka cluster. It is used for selecting the master
   # Schema Registry instance and for storing the registered schema data. Note that the SASL_SSL:// prefix is required.
   kafkastore.bootstrap.servers=SASL_SSL://<bootstrap-servers>
   
   # REQUIRED: Specifies Confluent Cloud authentication. Refer to the SASL
   # properties in ``~/.ccloud/config`` to get this info.
   kafkastore.sasl.jaas.config=<sasl-jaas-config>
   
   # Configures Schema Registry to use SASL authentication.
   kafkastore.sasl.mechanism=PLAIN
   
   # Configures Schema Registry for SSL encryption.
   kafkastore.security.protocol=SASL_SSL
   
   # Specifies the name of the topic to store schemas in.
   kafkastore.topic=_schemas
   
   # Specifies the address the socket server listens on. The format is
   # "listeners = listener_name://host_name:port". For example, "listeners = PLAINTEXT://your.host.name:9092".
   listeners=http://0.0.0.0:8081
   
   For more information, see :ref:`Schema Registry configuration options <schema-reg-config>`
   and :ref:`Configuring PLAIN <auth-sasl-plain-schema-registry>`.
   

2. Start Schema Registry with the schema-registry.properties file specified.

   bin/schema-registry-start etc/schema-registry/schema-registry.properties
   

For more information about running a cluster, see the Schema Registry documentation.