Update wiki Home page for kafka-sink
parent
2d64ed3d9a
commit
2e6c94173f
45
Home.md
45
Home.md
@ -1,21 +1,38 @@
|
||||
# Deploy the Project on CamelX Platform
|
||||
# Kafka Sink
|
||||
|
||||
Deploy on CamelX Platform in three steps
|
||||
Send data to Kafka topics.
|
||||
|
||||
## Step 1: Create a release
|
||||
From the project space, click on **"Create a release"**
|
||||
## Metadata
|
||||
|
||||
The new version is automatically available in the list
|
||||
| Property | Value |
|
||||
|----------|-------|
|
||||
| Type | sink |
|
||||
| Group | Kafka |
|
||||
| Namespace | Kafka |
|
||||
| Support Level | Stable |
|
||||
| Provider | Apache Software Foundation |
|
||||
|
||||
## Step 2: Deploy
|
||||
Click on **"Deploy"**
|
||||
## Properties
|
||||
|
||||
- **Version:** Select the desired release
|
||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
||||
- **Configuration:** Select the configuration source
|
||||
- **Resources:** Set CPU and Memory
|
||||
| Name | Type | Required | Default | Description |
|
||||
|------|------|----------|---------|-------------|
|
||||
| `topic` | string | ✓ | | Comma separated list of Kafka topic names |
|
||||
| `bootstrapServers` | string | ✓ | | Comma separated list of Kafka Broker URLs |
|
||||
| `saslAuthType` | string | | `NONE` | Authentication type to use. Use NONE for no authentication, PLAIN or SCRAM_SHA_256/SCRAM_SHA_512 for username/password, SSL for certificate-based, OAUTH for OAuth 2.0, AWS_MSK_IAM for MSK, or KERBEROS for Kerberos. |
|
||||
| `saslUsername` | string | | | Username for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512. |
|
||||
| `saslPassword` | string | | | Password for SASL authentication. Required when saslAuthType is PLAIN, SCRAM_SHA_256, or SCRAM_SHA_512. |
|
||||
| `oauthClientId` | string | | | OAuth client ID. Required when saslAuthType is OAUTH. |
|
||||
| `oauthClientSecret` | string | | | OAuth client secret. Required when saslAuthType is OAUTH. |
|
||||
| `oauthTokenEndpointUri` | string | | | OAuth token endpoint URI. Required when saslAuthType is OAUTH. |
|
||||
| `oauthScope` | string | | | OAuth scope. Optional when saslAuthType is OAUTH. |
|
||||
| `sslTruststoreLocation` | string | | | The location of the trust store file. |
|
||||
| `sslTruststorePassword` | string | | | The password for the trust store file. |
|
||||
| `sslKeystoreLocation` | string | | | The location of the key store file. Used for mTLS authentication. |
|
||||
| `sslKeystorePassword` | string | | | The password for the key store file. |
|
||||
| `sslKeyPassword` | string | | | The password of the private key in the key store file. |
|
||||
|
||||
## Step 3: Expose
|
||||
Enable **"Expose"**
|
||||
## Dependencies
|
||||
|
||||
Choose an **API Gateway** (Internal, Public, etc.)
|
||||
- `camel:core`
|
||||
- `camel:kafka`
|
||||
- `camel:kamelet`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user