diff --git a/Home.md b/Home.md index 93a012c..e90f096 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,45 @@ -# Deploy the Project on CamelX Platform +# Splunk Source -Deploy on CamelX Platform in three steps +Retrieve data from Splunk and outputs in json format. -## Step 1: Create a release -From the project space, click on **"Create a release"** +For the fields accepting time specifiers like `earliestTime`, it accepts a wide variety of formats, please check https://docs.splunk.com/Documentation/Splunk/9.0.0/Search/Specifytimemodifiersinyoursearch[Splunk documentation] for more information. -The new version is automatically available in the list +## Metadata -## Step 2: Deploy -Click on **"Deploy"** +| Property | Value | +|----------|-------| +| Type | source | +| Group | SPLUNK | +| Namespace | Monitoring | +| Support Level | Stable | +| Provider | Apache Software Foundation | -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +## Properties -## Step 3: Expose -Enable **"Expose"** +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `serverHostname` | string | ✓ | | The address of your Splunk server. | +| `serverPort` | integer | | `8089` | The address of your Splunk server. | +| `username` | string | ✓ | | The username to authenticate to Splunk Server. | +| `password` | string | ✓ | | The password to authenticate to Splunk Server. | +| `index` | string | | | Splunk index to write to. | +| `protocol` | string | | `https` | Connection Protocol to Splunk server. | +| `source` | string | | | The source named field of the data. | +| `sourceType` | string | | | The source named field of the data. | +| `app` | string | | | The app name in Splunk. | +| `connectionTimeout` | integer | | | Timeout in milliseconds when connecting to Splunk server | +| `count` | integer | | | The maximum number of entities to return. | +| `repeat` | integer | | | The maximum number of fires. | +| `delay` | integer | | | The number of milliseconds before the next poll. | +| `query` | string | ✓ | | The Splunk query to run. | +| `earliestTime` | string | | | Earliest time of the search time window. | +| `initEarliestTime` | string | ✓ | | Initial start offset of the first search. | +| `latestTime` | string | | | Latest time of the search time window. | -Choose an **API Gateway** (Internal, Public, etc.) +## Dependencies + +- `camel:jackson` +- `camel:core` +- `camel:splunk` +- `camel:kamelet` +- `mvn:com.fasterxml.jackson.datatype:jackson-datatype-joda:2.12.5`