Update wiki Home page for splunk-hec-sink

gitea_admin 2026-03-11 14:40:20 +00:00
parent b2a4c01c3b
commit 8b71d66f19

42
Home.md

@ -1,21 +1,35 @@
# Deploy the Project on CamelX Platform
# Splunk HEC Sink
Deploy on CamelX Platform in three steps
The Splunk HEC sink allows to send data to Splunk using the https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector[HTTP Event Collector].
## 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 | SPLUNK |
| Namespace | Monitoring |
| 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 |
|------|------|----------|---------|-------------|
| `splunkUrl` | string | ✓ | | The URL of your Splunk server. No need to set the protocol prefix. |
| `token` | string | ✓ | | The Token of the HEC. Note it is not the user's authentication token. |
| `hostPayload` | string | | | The host field set in the data sent to Splunk, it is not related to the Splunk URL or the connection to Splunk server. |
| `bodyOnly` | boolean | | `false` | Send to Splunk only data contained in the body. |
| `headersOnly` | boolean | | `false` | Send to Splunk only data contained in the headers. |
| `index` | string | | | Splunk index to write to. |
| `source` | string | | | The source named field of the data. |
| `sourceType` | string | | | The source named field of the data. |
| `skipTlsVerify` | boolean | | `false` | Skip TLS verification. |
| `https` | boolean | | `true` | Use a secure HTTPS connection. |
| `time` | string | | | Time this even occurred. By default, the time will be when this event hits the splunk server. |
## Step 3: Expose
Enable **"Expose"**
## Dependencies
Choose an **API Gateway** (Internal, Public, etc.)
- `camel:core`
- `camel:splunk-hec`
- `camel:kamelet`