Skip to content

Commit 656fbe0

Browse files
authored
docs: specification update (#27)
1 parent 68acce2 commit 656fbe0

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/specification.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This document describes the specification for how to write your Kafka cluster's desired state file. This currently must be a `YAML` file.
44

5-
?> Current version: `1.0.1`
5+
?> Current version: `1.0.2`
66

77
The desired state file consists of:
88

@@ -84,14 +84,18 @@ services:
8484

8585
**Example kafka connect cluster**:
8686

87-
?> **NOTE**: The `group-id` property is optional and defaults to the service name.
87+
?> **NOTE**: The `group-id` property is optional and defaults to the service name. The `storage-topics` property is also optional; the defaults can be found on the [services][services] page.
8888

8989
```yaml
9090
services:
9191
my-kafka-connect-cluster-name:
9292
type: kafka-connect
9393
principal: User:my-connect-principal
9494
group-id: optional-group-id-override
95+
storage-topics:
96+
config: optional-custom-config-topic
97+
offset: optional-custom-offset-topic
98+
status: optional-custom-status-topic
9599
connectors:
96100
my-source-connector-name:
97101
produces:
@@ -195,3 +199,4 @@ customUserAcls:
195199

196200
?> **NOTE**: The `principal` field can be left out here and it will be inherited from the user definition.
197201

202+
[services]: /services.md

0 commit comments

Comments
 (0)