Skip to content

docs: specification update #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devshawn merged 1 commit into from
Aug 13, 2020
Merged

docs: specification update #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions docs/specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

?> Current version: `1.0.1`
?> Current version: `1.0.2`

The desired state file consists of:

Expand Down Expand Up @@ -84,14 +84,18 @@ services:

**Example kafka connect cluster**:

?> **NOTE**: The `group-id` property is optional and defaults to the service name.
?> **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.

```yaml
services:
my-kafka-connect-cluster-name:
type: kafka-connect
principal: User:my-connect-principal
group-id: optional-group-id-override
storage-topics:
config: optional-custom-config-topic
offset: optional-custom-offset-topic
status: optional-custom-status-topic
connectors:
my-source-connector-name:
produces:
Expand Down Expand Up @@ -195,3 +199,4 @@ customUserAcls:

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

[services]: /services.md