Connecting Schema Registry to Confluent Cloud

You can install and configure Schema Registry for Confluent Cloud.

Prerequisites

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 the ~/.ccloud/config.json file 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 primary
    # Schema Registry instance and for storing the registered schema data.
    kafkastore.bootstrap.servers=<bootstrap-servers>
    
    # REQUIRED: Specifies Confluent Cloud authentication.
    kafkastore.sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required\
      username="<api-key>" \
      password="<api-secret>";
    
    # 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 Schema Registry configuration options and Configuring PLAIN.

  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.