Skip to content

Commit d3a44f4

Browse files
LangStream Documentation Teamgitbook-bot
LangStream Documentation Team
authored andcommitted
GITBOOK-145: deploying
1 parent d1db156 commit d3a44f4

File tree

2 files changed

+11
-21
lines changed

2 files changed

+11
-21
lines changed

configuration-resources/connectors/camel.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Using Apache Camel connectors
1+
# Apache Camel
22

33
Configuration for LangStream Sources using Apache Camel.
44

5-
### Deplying the component into your LangStream application
5+
### Deploying the component into your LangStream application
66

77
LangStream doesn't bundle all the Camel connectors, but you can easily deploy them into your application.
88

@@ -23,12 +23,10 @@ configuration:
2323
2424
You have to bundle all the jars needed by the connector - in this example the Apache Camel GitHub component requires the org.eclipse.egit.github.core jar file.
2525
26-
The jar files are downloaded by the LangStream CLI when you are deploying the application and then copied to the java/lib directory.
27-
You are not required to use this mechanism - you can manually copy the jar files if you prefer - but if you use the dependency mechanism, the LangStream CLI will check the sha512sum of the files to make sure that they are not corrupted.
26+
The jar files are downloaded by the LangStream CLI when you are deploying the application and then copied to the java/lib directory. You are not required to use this mechanism - you can manually copy the jar files if you prefer - but if you use the dependency mechanism, the LangStream CLI will check the sha512sum of the files to make sure that they are not corrupted.
2827
2928
We recommend adding a .gitignore file into your application so you don't commit the jar file into your git repository.
3029
31-
3230
### Apache Camel Sources
3331
3432
Once you have your connector deployed into your application, you can use it in your pipeline.
@@ -60,6 +58,4 @@ pipeline:
6058
6159
You must provide the component-uri and the component-options in the "configuration" section.
6260
63-
All component-options are passed to the component as additional parameters in the query string, appended to the component-uri.
64-
This mechanism helps you in defining each property in a separate secret, so that you can easily rotate the secrets without changing the pipeline configuration.
65-
Additionally, the camel-source agent will automatically URL-encode the values of the parameters passed to the query string.
61+
All component-options are passed to the component as additional parameters in the query string, appended to the component-uri. This mechanism helps you in defining each property in a separate secret, so that you can easily rotate the secrets without changing the pipeline configuration. Additionally, the camel-source agent will automatically URL-encode the values of the parameters passed to the query string.

configuration-resources/connectors/kafka-connect.md

+7-13
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Using Apache Kafka Connect connectors
1+
# Apache Kafka Connect
22

33
Configuration for LangStream Sources and Sinks using Kafka Connect.
44

5-
### Deplying the connector into your LangStream application
5+
### Deploying the connector into your LangStream application
66

77
LangStream doesn't bundle all the Kafka Connect connectors, but you can easily deploy them into your application.
88

@@ -17,12 +17,10 @@ configuration:
1717
type: "java-library"
1818
```
1919
20-
The jar file is downloaded by the LangStream CLI when you are deploying the application and it is copied to the java/lib directory.
21-
You are not required to use this mechanism - you can manually copy the jar files if you prefer - but if you use the dependency mechanism, the LangStream CLI will check the sha512sum of the files to make sure that they are not corrupted.
20+
The jar file is downloaded by the LangStream CLI when you are deploying the application and it is copied to the java/lib directory. You are not required to use this mechanism - you can manually copy the jar files if you prefer - but if you use the dependency mechanism, the LangStream CLI will check the sha512sum of the files to make sure that they are not corrupted.
2221
2322
We recommend adding a .gitignore file into your application so you don't commit the jar file into your git repository.
2423
25-
2624
### Kafka Connect Sinks
2725
2826
Once you have your connector deployed into your application, you can use it in your pipeline.
@@ -52,17 +50,13 @@ pipeline:
5250
topic.input-topic.vsearch.products.mapping: "id=value.id,description=value.description,name=value.name"
5351
```
5452
55-
Provide the configuration for the connector in the "configuration" section of the yaml file.
56-
You must provide `connector.class`, `name`, `key.converter` and `value.converter`, as you would for any other Kafka Connect connector.
57-
Check the reference documentation of the connector you are using for more details about its configuration properties.
53+
Provide the configuration for the connector in the "configuration" section of the yaml file. You must provide `connector.class`, `name`, `key.converter` and `value.converter`, as you would for any other Kafka Connect connector. Check the reference documentation of the connector you are using for more details about its configuration properties.
5854

5955
### Kafka Connect Sources
6056

61-
Kafka Connect source connectors work the same way as sinks, but you have to provide an additional system topic that Kafka Connect uses to store the state of the source connector.
62-
In this example the system topic is named "offset-topic".
57+
Kafka Connect source connectors work the same way as sinks, but you have to provide an additional system topic that Kafka Connect uses to store the state of the source connector. In this example the system topic is named "offset-topic".
6358

64-
To make the Kafka Connect runtime happy you have to set the `cleanup.policy` config value to "compact" for the offset-topic.
65-
And you have to configure it in the configuration of the agent with the offset.storage.topic property.
59+
To make the Kafka Connect runtime happy you have to set the `cleanup.policy` config value to "compact" for the offset-topic. And you have to configure it in the configuration of the agent with the offset.storage.topic property.
6660

6761
This is not a special requirement of LangStream, please checkout the Kafka Connect documentation for more details.
6862

@@ -87,4 +81,4 @@ This is not a special requirement of LangStream, please checkout the Kafka Conne
8781
connector.class: myconnector.ClassName
8882
num-messages: 5
8983
offset.storage.topic: "offset-topic"
90-
```
84+
```

0 commit comments

Comments
 (0)