|
1 | 1 | --- |
2 | | -title: Integrate Apache Kafka on Confluent Cloud with Service Connector |
3 | | -description: In this document, learn how to integrate Apache Kafka on Confluent Cloud into your application with Service Connector |
| 2 | +title: Use Service Connector to integrate Apache Kafka on Confluent Cloud |
| 3 | +description: Learn how to connect Apache Kafka on Confluent Cloud apps to supported Azure compute services by using Service Connector. |
4 | 4 | author: maud-lv |
5 | 5 | ms.author: malev |
6 | 6 | ms.service: service-connector |
7 | 7 | ms.topic: how-to |
8 | | -ms.date: 02/02/2024 |
| 8 | +ms.date: 04/01/2026 |
| 9 | +#customer intent: As an Apache Kafka on Confluent Cloud app developer, I want to learn how to use Service Connector so I can easily integrate my apps with supported Azure compute services. |
9 | 10 | --- |
10 | 11 |
|
11 | 12 | # Integrate Apache Kafka on Confluent Cloud with Service Connector |
12 | 13 |
|
13 | | -This page shows supported authentication methods and clients to connect Apache Kafka on Confluent Cloud to other cloud services using Service Connector. You might still be able to connect to Apache Kafka on Confluent Cloud in other programming languages without using Service Connector. This page also shows default environment variable names and values (or Spring Boot configuration) you get when you create the service connection. |
| 14 | +This article shows supported clients and authentication methods to connect Apache Kafka on Confluent Cloud to other cloud services by using Service Connector. This article also shows the default environment variables you need to create the service connections. |
| 15 | + |
| 16 | +>[!NOTE] |
| 17 | +>You might be able to connect to Apache Kafka on Confluent Cloud in other programming languages without using Service Connector. |
14 | 18 |
|
15 | 19 | ## Supported compute services |
16 | 20 |
|
17 | | -Service Connector can be used to connect the following compute services to Apache Kafka on Confluent Cloud: |
| 21 | +You can use Service Connector to connect the following Azure compute services to Apache Kafka on Confluent Cloud: |
18 | 22 |
|
19 | 23 | - Azure App Service |
20 | 24 | - Azure Container Apps |
21 | 25 | - Azure Functions |
22 | 26 | - Azure Kubernetes Service (AKS) |
23 | 27 | - Azure Spring Apps |
24 | 28 |
|
25 | | -## Supported Authentication types and client types |
| 29 | +## Supported clients and authentication type |
| 30 | + |
| 31 | +Apache Kafka on Confluent Cloud supports the following client types. To build Kafka client applications on Confluent Cloud, see [Kafka Client Examples for Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/examples.html#). |
| 32 | + |
| 33 | +- .NET |
| 34 | +- Java |
| 35 | +- Java Spring Boot |
| 36 | +- Node.js |
| 37 | +- Python |
| 38 | + |
| 39 | +### Authentication types |
26 | 40 |
|
27 | | -The table below shows which combinations of client types and authentication methods are supported for connecting your compute service to Apache Kafka on Confluent Cloud using Service Connector. A “Yes” indicates that the combination is supported, while a “No” indicates that it is not supported. |
| 41 | +Apache Kafka on Confluent Cloud supports only secret or connection string authentication. System-assigned managed identity, user-assigned managed identity, and service principal authentication aren't available. |
28 | 42 |
|
29 | | -| Client type | System-assigned managed identity | User-assigned managed identity | Secret / connection string | Service principal | |
30 | | -|--------------------|----------------------------------|--------------------------------|----------------------------|-------------------| |
31 | | -| .NET | No | No | Yes | No | |
32 | | -| Java | No | No | Yes | No | |
33 | | -| Java - Spring Boot | No | No | Yes | No | |
34 | | -| Node.js | No | No | Yes | No | |
35 | | -| Python | No | No | Yes | No | |
36 | | -| None | No | No | Yes | No | |
| 43 | +> [!IMPORTANT] |
| 44 | +> The secret or connection string authentication flow requires a high degree of trust in the application, and carries risks not present in other flows. You should use this flow only when more secure flows, such as managed identities, aren't available. |
37 | 45 |
|
38 | | -This table indicates that the only supported authentication method for all client types in the table is the Secret / connection string method. Other authentication methods are not supported for any of the client types. |
| 46 | +## Default environment variables |
39 | 47 |
|
40 | | -## Default environment variable names or application properties |
| 48 | +Use the following connection details to connect supported Azure compute services to Kafka. In the values, replace the following placeholders with the values for your app: |
41 | 49 |
|
42 | | -Use the connection details below to connect compute services to Kafka. For each example below, replace the placeholder texts `<server-name>`, `<Bootstrap-server-key>`, `<Bootstrap-server-secret>`, `<schema-registry-key>`, and `<schema-registry-secret>` with your server name, Bootstrap server key, Bootstrap server secret, schema registry key, and schema registry secret. For more information about naming conventions, check the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article. Refer to [Kafka Client Examples](https://docs.confluent.io/cloud/current/client-apps/examples.html#) to build Kafka client applications on Confluent Cloud. |
| 50 | +- `<server-name>` |
| 51 | +- `<Bootstrap-server-key>` |
| 52 | +- `<Bootstrap-server-secret>` |
| 53 | +- `<schema-registry-key>` |
| 54 | +- `<schema-registry-secret>` |
43 | 55 |
|
44 | | -### Secret / Connection String |
| 56 | +For more information about naming conventions, see [Configuration naming convention](concept-service-connector-internals.md#configuration-naming-convention). |
45 | 57 |
|
46 | | -> [!WARNING] |
47 | | -> Microsoft recommends that you use the most secure authentication flow available. The authentication flow described in this procedure requires a very high degree of trust in the application, and carries risks that are not present in other flows. You should only use this flow when other more secure flows, such as managed identities, aren't viable. |
| 58 | +### All clients except Spring Boot |
48 | 59 |
|
49 | | -#### SpringBoot client type |
| 60 | +The following table lists the default environmental variables you use to connect all Kafka client types except for Java Spring Boot to supported Azure compute services. |
50 | 61 |
|
51 | | -| Default environment variable name | Description | Example value | |
52 | | -| ------------------------------------------------------------ | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | |
53 | | -| spring.kafka.properties.bootstrap.servers | Your Kafka bootstrap server | `pkc-<server-name>.eastus.azure.confluent.cloud:9092` | |
54 | | -| spring.kafka.properties.sasl.jaas.config | Your Kafka SASL configuration | `org.apache.kafka.common.security.plain.PlainLoginModule required username='<Bootstrap-server-key>' password='<Bootstrap-server-secret>';` | |
55 | | -| spring.kafka.properties.schema.registry.url | Your Confluent registry URL | `https://psrc-<server-name>.westus2.azure.confluent.cloud` | |
56 | | -| spring.kafka.properties.schema.registry.basic.auth.user.info | Your Confluent registry user information | `<schema-registry-key>:<schema-registry-secret>` | |
| 62 | +| Default environment variable name | Description | Example value | |
| 63 | +|---------------------------|----------------------------|--------| |
| 64 | +| AZURE_CONFLUENTCLOUDKAFKA_BOOTSTRAPSERVER | Kafka bootstrap server | `pkc-<server-name>.eastus.azure.confluent.cloud:9092` | |
| 65 | +| AZURE_CONFLUENTCLOUDKAFKA_KAFKASASLCONFIG | Kafka Simple Authentication and Security Layer (SASL) configuration | `org.apache.kafka.common.security.plain.PlainLoginModule required username='<Bootstrap-server-key>' password='<Bootstrap-server-secret>';` | |
| 66 | +| AZURE_CONFLUENTCLOUDSCHEMAREGISTRY_URL | Confluent registry URL | `https://psrc-<server-name>.westus2.azure.confluent.cloud` | |
| 67 | +| AZURE_CONFLUENTCLOUDSCHEMAREGISTRY_USERINFO | Confluent registry user information | `<schema-registry-key>:<schema-registry-secret>`| |
57 | 68 |
|
58 | | -#### Other client types |
| 69 | +### Spring Boot clients |
59 | 70 |
|
60 | | -| Default environment variable name | Description | Example value | |
61 | | -|---------------------------------------------|------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| |
62 | | -| AZURE_CONFLUENTCLOUDKAFKA_BOOTSTRAPSERVER | Your Kafka bootstrap server | `pkc-<server-name>.eastus.azure.confluent.cloud:9092` | |
63 | | -| AZURE_CONFLUENTCLOUDKAFKA_KAFKASASLCONFIG | Your Kafka SASL configuration | `org.apache.kafka.common.security.plain.PlainLoginModule required username='<Bootstrap-server-key>' password='<Bootstrap-server-secret>';` | |
64 | | -| AZURE_CONFLUENTCLOUDSCHEMAREGISTRY_URL | Your Confluent registry URL | `https://psrc-<server-name>.westus2.azure.confluent.cloud` | |
65 | | -| AZURE_CONFLUENTCLOUDSCHEMAREGISTRY_USERINFO | Your Confluent registry user information | `<schema-registry-key>:<schema-registry-secret>` | |
| 71 | +The following table lists the default environmental variables you use to connect Java Spring Boot clients to supported Azure compute services. |
66 | 72 |
|
67 | | -## Next steps |
| 73 | +| Default environment variable name | Description | Example value | |
| 74 | +| ------------- | ------------------------- | ------ | |
| 75 | +| spring.kafka.properties.bootstrap.servers | Kafka bootstrap server | `pkc-<server-name>.eastus.azure.confluent.cloud:9092` | |
| 76 | +| spring.kafka.properties.sasl.jaas.config | Kafka SASL configuration | `org.apache.kafka.common.security.plain.PlainLoginModule required username='<Bootstrap-server-key>' password='<Bootstrap-server-secret>';` | |
| 77 | +| spring.kafka.properties.schema.registry.url | Confluent registry URL | `https://psrc-<server-name>.westus2.azure.confluent.cloud` | |
| 78 | +| spring.kafka.properties.schema.registry.basic.auth.user.info | Confluent registry user information | `<schema-registry-key>:<schema-registry-secret>` | |
68 | 79 |
|
69 | | -Follow the tutorials listed below to learn more about Service Connector. |
| 80 | +## Related content |
70 | 81 |
|
71 | | -> [!div class="nextstepaction"] |
72 | | -> [Learn about Service Connector concepts](./concept-service-connector-internals.md) |
| 82 | +- [Service Connector concepts](concept-service-connector-internals.md) |
| 83 | +- [Kafka Client Examples for Confluent Cloud](https://docs.confluent.io/cloud/current/client-apps/examples.html#) |
0 commit comments