Skip to content

Commit

Permalink
chore: gen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
anasmuhmd committed Oct 6, 2024
1 parent cd31ff3 commit d322ab5
Show file tree
Hide file tree
Showing 4 changed files with 140 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/plugins/crowdstrike/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: blackstork/crowdstrike
weight: 20
plugin:
name: blackstork/crowdstrike
description: ""
tags: []
version: "v0.4.2"
source_github: "https://github.com/blackstork-io/fabric/tree/main/internal/crowdstrike/"
type: docs
hideInMenu: true
---

{{< plugin-header "blackstork/crowdstrike" "crowdstrike" "v0.4.2" >}}

## Installation

To install the plugin, add it to `plugin_versions` map in the Fabric global configuration block (see [Global configuration]({{< ref "configs.md#global-configuration" >}}) for more details), with a version constraint restricting which available versions of the plugin the codebase is compatible with:

```hcl
fabric {
plugin_versions = {
"blackstork/crowdstrike" = ">= v0.4.2"
}
}
```


## Data sources

{{< plugin-resources "crowdstrike" "data-source" >}}
87 changes: 87 additions & 0 deletions docs/plugins/crowdstrike/data-sources/falcon_cspm_ioms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
title: "`falcon_cspm_ioms` data source"
plugin:
name: blackstork/crowdstrike
description: "The `falcon_cspm_ioms` data source fetches cloud indicators of misconfigurations (IOMs) from the Falcon security posture management (CSPM) feature"
tags: []
version: "v0.4.2"
source_github: "https://github.com/blackstork-io/fabric/tree/main/internal/crowdstrike/"
resource:
type: data-source
type: docs
---

{{< breadcrumbs 2 >}}

{{< plugin-resource-header "blackstork/crowdstrike" "crowdstrike" "v0.4.2" "falcon_cspm_ioms" "data source" >}}

## Description
The `falcon_cspm_ioms` data source fetches cloud indicators of misconfigurations (IOMs) from the Falcon security posture management (CSPM) feature

## Installation

To use `falcon_cspm_ioms` data source, you must install the plugin `blackstork/crowdstrike`.

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/crowdstrike" = ">= v0.4.2"
}
}
```

Note the version constraint set for the plugin.

## Configuration

The data source supports the following configuration arguments:

```hcl
config data falcon_cspm_ioms {
# Client ID for accessing CrowdStrike Falcon Platform
#
# Required string.
# Must be non-empty
# For example:
client_id = "some string"
# Client Secret for accessing CrowdStrike Falcon Platform
#
# Required string.
# Must be non-empty
# For example:
client_secret = "some string"
# Member CID for MSSP
#
# Optional string.
# Default value:
member_cid = null
# Falcon cloud abbreviation
#
# Optional string.
# Must be one of: "autodiscover", "us-1", "us-2", "eu-1", "us-gov-1", "gov1"
# For example:
# client_cloud = "us-1"
#
# Default value:
client_cloud = null
}
```

## Usage

The data source supports the following execution arguments:

```hcl
data falcon_cspm_ioms {
# limit the number of queried items
#
# Required integer.
# For example:
size = 42
}
```
20 changes: 20 additions & 0 deletions docs/plugins/plugins.json
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,26 @@
}
]
},
{
"name": "blackstork/crowdstrike",
"version": "v0.4.2",
"shortname": "crowdstrike",
"resources": [
{
"name": "falcon_cspm_ioms",
"type": "data-source",
"config_params": [
"client_cloud",
"client_id",
"client_secret",
"member_cid"
],
"arguments": [
"size"
]
}
]
},
{
"name": "blackstork/elastic",
"version": "v0.4.2",
Expand Down
2 changes: 2 additions & 0 deletions tools/docgen/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
"github.com/spf13/pflag"

"github.com/blackstork-io/fabric/internal/builtin"
"github.com/blackstork-io/fabric/internal/crowdstrike"
"github.com/blackstork-io/fabric/internal/elastic"
"github.com/blackstork-io/fabric/internal/github"
"github.com/blackstork-io/fabric/internal/graphql"
Expand Down Expand Up @@ -278,6 +279,7 @@ func main() {
nistnvd.Plugin(version, nil),
snyk.Plugin(version, nil),
microsoft.Plugin(version, nil, nil, nil),
crowdstrike.Plugin(version, nil),
}
// generate markdown for each plugin
for _, p := range plugins {
Expand Down

0 comments on commit d322ab5

Please sign in to comment.