Configuration
Here, you will find the configuration for the Confluent Cloud extension.
Configuration
You can configure the properties to connect to Confluent Cloud
through the Jikkou client configuration property jikkou.provider.confluent-cloud.
Example:
jikkou {
provider.confluent-cloud {
enabled = true
type = io.jikkou.extension.confluent.ConfluentCloudExtensionProvider
config = {
# URL to the Confluent Cloud REST API (default: https://api.confluent.cloud)
apiUrl = "https://api.confluent.cloud"
# Confluent Cloud API Key (must be a Cloud API Key, not a Cluster API Key)
apiKey = ${CONFLUENT_CLOUD_API_KEY}
# Confluent Cloud API Secret
apiSecret = ${CONFLUENT_CLOUD_API_SECRET}
# CRN pattern used to scope role binding list operations
crnPattern = ${CONFLUENT_CLOUD_CRN_PATTERN}
# HTTP proxy URL, e.g. 'http://proxy.example.com:3128' (optional)
proxyUrl = "http://proxy.example.com:3128"
# Username for proxy Basic authentication (optional)
proxyUsername = null
# Password for proxy Basic authentication (optional)
proxyPassword = null
# Comma-separated hosts that bypass the proxy (optional)
nonProxyHosts = "localhost,127.0.0.1"
# Enable debug logging (default: false)
debugLoggingEnabled = false
}
}
}
Configuration Properties
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiUrl | String | No | https://api.confluent.cloud | URL to the Confluent Cloud REST API. |
apiKey | String | Yes | Cloud API Key. Must be a Cloud API Key, not a Cluster API Key. | |
apiSecret | String | Yes | Cloud API Secret. | |
crnPattern | String | Yes | CRN pattern to scope role binding list operations. | |
proxyUrl | String | No | HTTP proxy URL, e.g. http://proxy.example.com:3128. When empty, JVM proxy system properties are used. | |
proxyUsername | String | No | Username for proxy Basic authentication. | |
proxyPassword | String | No | Password for proxy Basic authentication. | |
nonProxyHosts | String | No | Comma-separated hosts that bypass the proxy, e.g. localhost,*.internal. | |
debugLoggingEnabled | Boolean | No | false | Enable debug logging for REST API calls. |
If
proxyUrlis not set, Jikkou honors the standard JVM proxy system properties (-Dhttps.proxyHost,-Dhttp.proxyHost,-Dhttp.proxyUser,-Dhttp.proxyPassword,-Dhttp.nonProxyHosts), which can be supplied viaJAVA_TOOL_OPTIONS. The OS-levelhttp_proxy/https_proxyenvironment variables are not read by the JVM and have no effect.
Creating a Cloud API Key
Cloud API Keys can be created using the Confluent Cloud CLI:
confluent api-key create --resource cloud --description "Jikkou role binding management"
Important: You must use a Cloud API Key (organization-level), not a Cluster API Key. Cluster API Keys will result in a
401 Unauthorizederror.
CRN Pattern
The crnPattern property is required and scopes all list operations to a specific part of your organization hierarchy. Examples:
| Scope | CRN Pattern |
|---|---|
| Organization | crn://confluent.cloud/organization=org-abc123 |
| Environment | crn://confluent.cloud/organization=org-abc123/environment=env-def456 |
| Kafka Cluster | crn://confluent.cloud/organization=org-abc123/environment=env-def456/cloud-cluster=lkc-789 |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.