Skip to content

Commit 8ddfb8c

Browse files
committed
docs(kafka-connect): wrap cluster config in 'config' block
The example configuration nested 'clusters' directly under 'jikkou.provider.kafkaconnect', but the runtime only forwards the nested 'config' block to a provider's configure(...) method. Following the documented form caused the provider to resolve an empty cluster list and fail with KafkaConnectClusterNotFoundException. Aligns the example with every other provider doc (Kafka, Schema Registry, Aiven, Confluent Cloud, Iceberg, AWS) and fixes a 'locahost' typo. Closes #764
1 parent c5c335a commit 8ddfb8c

1 file changed

Lines changed: 39 additions & 37 deletions

File tree

  • docs/content/en/docs/Providers/Kafka Connect/Configuration

docs/content/en/docs/Providers/Kafka Connect/Configuration/_index.md

Lines changed: 39 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -21,43 +21,45 @@ through the Jikkou client configuration property: `jikkou.provider.kafkaconnect`
2121
```hocon
2222
jikkou {
2323
provider.kafkaconnect {
24-
enabled: true
25-
type: io.jikkou.kafka.connect.KafkaConnectExtensionProvider
26-
# Array of Kafka Connect clusters configurations.
27-
clusters = [
28-
{
29-
# Name of the cluster (e.g., dev, staging, production, etc.)
30-
name = "locahost"
31-
# URL of the Kafka Connect service
32-
url = "http://localhost:8083"
33-
# Method to use for authenticating on Kafka Connect. Available values are: [none, basicauth, ssl]
34-
authMethod = none
35-
# Use when 'authMethod' is 'basicauth' to specify the username for Authorization Basic header
36-
basicAuthUser = null
37-
# Use when 'authMethod' is 'basicauth' to specify the password for Authorization Basic header
38-
basicAuthPassword = null
39-
# Enable debug logging
40-
debugLoggingEnabled = false
41-
42-
# Ssl Config: Use when 'authMethod' is 'ssl'
43-
# The location of the key store file.
44-
sslKeyStoreLocation = "/certs/registry.keystore.jks"
45-
# The file format of the key store file.
46-
sslKeyStoreType = "JKS"
47-
# The password for the key store file.
48-
sslKeyStorePassword = "password"
49-
# The password of the private key in the key store file.
50-
sslKeyPassword = "password"
51-
# The location of the trust store file.
52-
sslTrustStoreLocation = "/certs/registry.truststore.jks"
53-
# The file format of the trust store file.
54-
sslTrustStoreType = "JKS"
55-
# The password for the trust store file.
56-
sslTrustStorePassword = "password"
57-
# Specifies whether to ignore the hostname verification.
58-
sslIgnoreHostnameVerification = true
59-
}
60-
]
24+
enabled = true
25+
type = io.jikkou.kafka.connect.KafkaConnectExtensionProvider
26+
config = {
27+
# Array of Kafka Connect clusters configurations.
28+
clusters = [
29+
{
30+
# Name of the cluster (e.g., dev, staging, production, etc.)
31+
name = "localhost"
32+
# URL of the Kafka Connect service
33+
url = "http://localhost:8083"
34+
# Method to use for authenticating on Kafka Connect. Available values are: [none, basicauth, ssl]
35+
authMethod = none
36+
# Use when 'authMethod' is 'basicauth' to specify the username for Authorization Basic header
37+
basicAuthUser = null
38+
# Use when 'authMethod' is 'basicauth' to specify the password for Authorization Basic header
39+
basicAuthPassword = null
40+
# Enable debug logging
41+
debugLoggingEnabled = false
42+
43+
# Ssl Config: Use when 'authMethod' is 'ssl'
44+
# The location of the key store file.
45+
sslKeyStoreLocation = "/certs/registry.keystore.jks"
46+
# The file format of the key store file.
47+
sslKeyStoreType = "JKS"
48+
# The password for the key store file.
49+
sslKeyStorePassword = "password"
50+
# The password of the private key in the key store file.
51+
sslKeyPassword = "password"
52+
# The location of the trust store file.
53+
sslTrustStoreLocation = "/certs/registry.truststore.jks"
54+
# The file format of the trust store file.
55+
sslTrustStoreType = "JKS"
56+
# The password for the trust store file.
57+
sslTrustStorePassword = "password"
58+
# Specifies whether to ignore the hostname verification.
59+
sslIgnoreHostnameVerification = true
60+
}
61+
]
62+
}
6163
}
6264
}
6365
```

0 commit comments

Comments
 (0)