Update wiki Home page for splunk-hec

Home.md

@@ -1,21 +1,41 @@
-# Deploy the Project on CamelX Platform
+# Splunk HEC
 
-Deploy on CamelX Platform in three steps
+The splunk component allows publishing events in Splunk using the HTTP Event Collector.
 
-## Step 1: Create a release
+## Metadata
-From the project space, click on **"Create a release"**
 
-The new version is automatically available in the list
+| Property | Value |
+|----------|-------|
+| Scheme | `splunk-hec` |
+| Support Level | Stable |
+| Labels | monitoring |
+| Version | 4.10.2 |
 
-## Step 2: Deploy
+## Maven Dependency
-Click on **"Deploy"**
 
-- **Version:** Select the desired release
+```xml
-- **Environment:** Choose `Development`, `Staging`, or `Production` 
+<dependency>
-- **Configuration:** Select the configuration source
+    <groupId>org.apache.camel</groupId>
-- **Resources:** Set CPU and Memory
+    <artifactId>camel-splunk-hec</artifactId>
+    <version>4.10.2</version>
+</dependency>
+```
 
-## Step 3: Expose
+## Endpoint Properties
-Enable **"Expose"**
 
-Choose an **API Gateway** (Internal, Public, etc.)
+| Name | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `splunkURL` | string | ✓ |  | Splunk Host and Port (example: my_splunk_server:8089) |
+| `bodyOnly` | boolean |  | `false` | Send only the message body |
+| `headersOnly` | boolean |  | `false` | Send only message headers |
+| `host` | string |  |  | Splunk host field of the event message. This is not the Splunk host to connect to. |
+| `index` | string |  | `camel` | Splunk index to write to |
+| `source` | string |  | `camel` | Splunk source argument |
+| `sourceType` | string |  | `camel` | Splunk sourcetype argument |
+| `splunkEndpoint` | string |  | `/services/collector/event` | Splunk endpoint Defaults to /services/collector/event To write RAW data like JSON use /services/collector/raw For a list of all endpoints refer to splunk documentation (HTTP Event Collector REST API endpoints) Example for Spunk 8.2.x: https://docs.splunk.com/Documentation/SplunkCloud/8.2.2203/Data/HECRESTendpoints To extract timestamps in Splunk8.0 /services/collector/eventauto_extract_timestamp=true Remember to utilize RAW{} for questionmarks or slashes in parameters. |
+| `sslContextParameters` | object |  |  | SSL configuration |
+| `time` | integer |  |  | Time this even occurred. By default, the time will be when this event hits the splunk server. |
+| `lazyStartProducer` | boolean |  | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
+| `https` | boolean |  | `true` | Contact HEC over https. |
+| `skipTlsVerify` | boolean |  | `false` | Splunk HEC TLS verification. |
+| `token` | string | ✓ |  | Splunk HEC token (this is the token created for HEC and not the user's token) |