Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

internal/elastic: add elastic_security_cases data source #138

Merged
merged 1 commit into from
Mar 30, 2024
Merged
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
4 changes: 4 additions & 0 deletions .mockery.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ packages:
config:
interfaces:
Client:
github.com/blackstork-io/fabric/internal/elastic/kbclient:
config:
interfaces:
Client:
github.com/blackstork-io/fabric/plugin/resolver:
config:
inpackage: true
Expand Down
68 changes: 68 additions & 0 deletions docs/plugins/elastic/data-sources/elastic_security_cases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: elastic_security_cases
plugin:
name: blackstork/elastic
description: ""
tags: []
version: "v0.4.0"
source_github: "https://github.com/blackstork-io/fabric/tree/main/internal/elastic/"
resource:
type: data-source
type: docs
---

{{< breadcrumbs 2 >}}

{{< plugin-resource-header "blackstork/elastic" "elastic" "v0.4.0" "elastic_security_cases" "data source" >}}

## Installation

To use `elastic_security_cases` data source, you must install the plugin `blackstork/elastic`.

To install the plugin, add the full plugin name to the `plugin_versions` map in the Fabric global configuration block (see [Global configuration]({{< ref "configs.md#global-configuration" >}}) for more details), as shown below:

```hcl
fabric {
plugin_versions = {
"blackstork/elastic" = ">= v0.4.0"
}
}
```

Note the version constraint set for the plugin.

## Configuration

The data source supports the following configuration parameters:

```hcl
config data elastic_security_cases {
api_key = <list of string> # optional
api_key_str = <string> # optional
kibana_endpoint_url = <string> # required
}
```

## Usage

The data source supports the following parameters in the data blocks:

```hcl
data elastic_security_cases {
assignees = <list of string> # optional
default_search_operator = <string> # optional
from = <string> # optional
owner = <list of string> # optional
reporters = <list of string> # optional
search = <string> # optional
search_fields = <list of string> # optional
severity = <string> # optional
size = <number> # optional
sort_field = <string> # optional
sort_order = <string> # optional
space_id = <string> # optional
status = <string> # optional
tags = <list of string> # optional
to = <string> # optional
}
```
Loading
Loading