Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ node_modules/
*.log
npm-debug.log*

# Internal scripts and metadata
scripts/
# Internal scratch metadata
workflow-metadata.json

# Build output (generated by scripts/build-catalog.mjs; uploaded to the CDN)
dist/

# Environment and secrets
.env
.env.*
Expand Down
385 changes: 150 additions & 235 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

605 changes: 75 additions & 530 deletions README.md

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/importing.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ The simplest way to import a single workflow.

### Example: Importing Hash Threat Check

1. Open [`workflows/security/detection/hash-threat-check.yaml`](../workflows/security/detection/hash-threat-check.yaml)
1. Open [`examples/security/detection/hash-threat-check.yaml`](../examples/security/detection/hash-threat-check.yaml)
2. Copy the content
3. In Kibana, create new workflow and paste
4. Update the VirusTotal API key:
Expand Down Expand Up @@ -104,7 +104,7 @@ curl -X POST "https://YOUR_KIBANA_URL/api/workflows" \

```bash
# Read file and escape for JSON
YAML_CONTENT=$(cat workflows/detection/hash-threat-check.yaml)
YAML_CONTENT=$(cat examples/security/detection/hash-threat-check.yaml)

curl -X POST "https://YOUR_KIBANA_URL/api/workflows" \
-H "kbn-xsrf: true" \
Expand All @@ -123,7 +123,7 @@ EOF
```bash
# Install jq if not available: brew install jq (macOS) or apt install jq (Linux)

cat workflows/detection/hash-threat-check.yaml | \
cat examples/security/detection/hash-threat-check.yaml | \
jq -Rs '{yaml: .}' | \
curl -X POST "https://YOUR_KIBANA_URL/api/workflows" \
-H "kbn-xsrf: true" \
Expand Down Expand Up @@ -239,7 +239,7 @@ Import multiple workflows at once.

KIBANA_URL="${KIBANA_URL:-https://your-kibana-url}"
API_KEY="${API_KEY:-your-api-key}"
WORKFLOW_DIR="${1:-workflows}"
WORKFLOW_DIR="${1:-examples}"

import_workflow() {
local file="$1"
Expand Down Expand Up @@ -280,10 +280,10 @@ echo "Import complete!"

```bash
# Import all workflows
./bulk_import.sh workflows/
./bulk_import.sh examples/

# Import specific category
./bulk_import.sh workflows/detection/
./bulk_import.sh examples/security/detection/

# With environment variables
KIBANA_URL=https://my-kibana.example.com API_KEY=abc123 ./bulk_import.sh
Expand Down Expand Up @@ -364,7 +364,7 @@ def bulk_import(directory):
print(f"Import complete: {success} succeeded, {failed} failed")

if __name__ == "__main__":
directory = sys.argv[1] if len(sys.argv) > 1 else "workflows"
directory = sys.argv[1] if len(sys.argv) > 1 else "examples"
bulk_import(directory)
```

Expand Down Expand Up @@ -470,7 +470,7 @@ Error: YAML parsing failed

**Solution:** Validate YAML with an online validator or `yamllint`:
```bash
yamllint workflows/detection/my-workflow.yaml
yamllint examples/security/detection/my-workflow.yaml
```

#### 2. Missing Required Fields
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
5 changes: 5 additions & 0 deletions kibana-versions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"latest": "main",
"oldest": "9.5.0",
"cataloguePer": "minor"
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ template-metadata:
possible root causes, then file a Case with the agent's analysis,
a generated title and description, the alert attached, and a
structured summary of the agent's reasoning steps as comments.
solutions: [security, observability]
categories: [root-cause-analysis, ai-agent, case-management]
install:
form:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ template-metadata:
Run a semantic search against a knowledge-base index using a natural
language query, with optional namespace and knowledge-type filters
applied as Elasticsearch term clauses.
solutions: [search]
categories: [search]
install:
form:
Expand Down
1 change: 1 addition & 0 deletions library/workflows/web-search/web-search.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ template-metadata:
Run a web search via the Brave Search API and return the raw result
set. Useful as a building block for enrichment, research, or
LLM-grounding workflows.
solutions: []
categories: [search]
icon: brave
install:
Expand Down
57 changes: 57 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 18 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"name": "@elastic/workflows-library",
"version": "0.0.0",
"private": true,
"description": "Source repo for the Kibana Workflow Template Library",
"license": "Apache-2.0",
"type": "module",
"engines": {
"node": ">=20"
},
"scripts": {
"build:catalog": "node scripts/build-catalog.mjs"
},
"dependencies": {
"js-yaml": "^4.2.0",
"semver": "^7.8.4"
}
}
Loading