Skip to content

Commit

Permalink
Minor docs fixes (#3782)
Browse files Browse the repository at this point in the history
  • Loading branch information
gadomsky authored Dec 9, 2022
1 parent 45a358c commit 9c2687d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
3 changes: 3 additions & 0 deletions dockerhub/nussknacker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ latest - always points to the latest, stable version

latest-staging - developer build with latest, not released yet features

# Prerequisites
Docker in version 20.10.14+

# How to use

Follow steps described in [Quickstart](https://nussknacker.io/documentation/quickstart/docker)
Expand Down
14 changes: 7 additions & 7 deletions docs/integration/KafkaIntegration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ sidebar_position: 1
## Prerequisites

To fully understand how Nussknacker works with Kafka topics, it's best to read the following first:
* [Kafka introduction](https://kafka.apache.org/intro)
* [Role of Schema Registry](/about/TypicalImplementation)
* [Confluent Schema Registry](https://docs.confluent.io/platform/current/schema-registry/index.html)
* [Kafka topic key](https://kafka.apache.org/intro)

If you want to use Flink engine, this is also recommended:
* [Flink keyed state](https://ci.apache.org/projects/flink/flink-docs-master/docs/concepts/stateful-stream-processing/#keyed-state)
Expand Down Expand Up @@ -47,12 +47,12 @@ At runtime Nussknacker determines the schema version of a message value and key
3. if the magic byte is not found, it assumes the schema version chosen by the user in the scenario.


# Configuration
## Configuration

## Common part
### Common part
The Kafka configuration is part of the Model configuration. All the settings below should be placed relative to `scenarioTypes.ScenarioTypeName.modelConfig` key. You can find the high level structure of the configuration file [here](/docs/installation_configuration_guide/#configuration-areas)

Both streaming Engines (Lite and Flink) share some of the common Kafka settings this section describes them, see respective sections below for details on configuring Kafka for particular Engine (e.g. the keys where the common settings should be placed at).
Both streaming Engines (Lite and Flink) share some common Kafka settings this section describes them, see respective sections below for details on configuring Kafka for particular Engine (e.g. the keys where the common settings should be placed at).

### Kafka connection configuration

Expand Down Expand Up @@ -110,7 +110,7 @@ to see where they should be set):
| additionalParams | {} | Map of fixed parameters that can be added to Kafka message |


## Configuration for Flink engine
### Configuration for Flink engine

With Flink engine, the Kafka sources and sinks are configured as any other component. In particular,
you can configure multiple Kafka component providers - e.g. when you want to connect to multiple clusters.
Expand Down Expand Up @@ -139,7 +139,7 @@ components.kafkaA {
}
}
}
components.kafkaA {
components.kafkaB {
providerType: "kafka"
componentPrefix: "clusterB-"
config: {
Expand All @@ -165,7 +165,7 @@ See [common config](../ModelConfiguration#kafka-connection-configuration) for th
| avroKryoGenericRecordSchemaIdSerialization | Low | boolean | true | Should AVRO messages from topics registered in schema registry be serialized in optimized way, by serializing only schema id, not the whole schema |

## Configuration for Lite engine
### Configuration for Lite engine

The Lite engine in Streaming processing mode uses Kafka as it's core part (e.g. delivery guarantees are based on Kafka transactions), so it's configured separately from other components. Therefore, it's only possible to use one Kafka cluster for one model configuration. This configuration is used for all
Kafka based sources and sinks (you don't need to configure them separately). See [common config](#kafka-connection-configuration) for the details.
Expand Down

0 comments on commit 9c2687d

Please sign in to comment.