Merge pull request #2017 from SEKOIA-IO/fix/AutomationAutoGeneratedDoc

Automation: auto generated docs
SEKOIA-IO · Oct 15, 2024 · ae752c7 · ae752c7
2 parents 6f1e7d5 + 9d2b5e8
commit ae752c7
Show file tree

Hide file tree

Showing 199 changed files with 8,365 additions and 7,387 deletions.
diff --git a/_shared_content/automate/library/1password.md b/_shared_content/automate/library/1password.md
@@ -0,0 +1,32 @@
+# 1Password
+
+![1Password](/assets/playbooks/library/1password.png){ align=right width=150 }
+
+1Password's Enterprise Password Manager offers robust security features for businesses, enabling secure sharing and management of passwords and sensitive data across teams, with advanced admin controls and seamless integration into existing workflows.
+
+## Configuration
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `base_url` | `string` | 1Password base URL |
+| `api_token` | `string` | API token |
+
+## Triggers
+
+### [BETA] Fetch new events from 1Password EPM
+
+Get last events from 1Password EPM
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `frequency` | `integer` | Batch frequency in seconds |
+| `intake_server` | `string` | Server of the intake server (e.g. 'https://intake.sekoia.io') |
+| `intake_key` | `string` | Intake key to use when sending events |
+| `chunk_size` | `integer` | The max size of chunks for the batch processing |
+
+
+## Extra
+
+Module **`1Password` v1.0.0**
diff --git a/_shared_content/automate/library/atlassian-jira.md b/_shared_content/automate/library/atlassian-jira.md
@@ -0,0 +1,69 @@
+# Atlassian JIRA
+
+![Atlassian JIRA](/assets/playbooks/library/atlassian-jira.png){ align=right width=150 }
+
+Integrates with JIRA
+
+## Configuration
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `domain` | `string` | Your organization JIRA domain (e.g. 'sandbox.atlassian.net') |
+| `email` | `string` | Email of the user |
+| `api_key` | `string` | API Key to use to connect to JIRA API endpoints |
+
+## Actions
+
+### Change Status of an Issue
+
+Change status of an issue in JIRA
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `issue_key` | `string` | Issue key (e.g. PROJ-1) |
+| `status_name` | `string` | Exact name of the status (e.g. 'To Do') |
+
+### Comment Issue
+
+Add comment to an issue in JIRA
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `issue_key` | `string` | Issue key (e.g. PROJ-1) |
+| `comment` | `string` | Text of a comment |
+
+### Create Issue
+
+Create issue in JIRA
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `project_key` | `string` | Project key (e.g. 'PRJ') |
+| `summary` | `string` | Summary of an issue (e.g. 'Fix a bug') |
+| `issue_type` | `string` | Issue type (e.g. 'Task') |
+| `description` | `object` | Description text in ADF (Atlassian Document Format) |
+| `due_date` | `string` | Due date (e.g. '2023-10-31')' |
+| `labels` | `string` | Comma-separated labels (e.g. 'devops,support') |
+| `assignee` | `string` | Exact display name of an assignee (e.g. John Doe) |
+| `reporter` | `string` | Exact display name of a reporter (e.g. Jane Doe) |
+| `priority` | `string` | Issue priority (e.g. Highest) |
+| `parent_key` | `string` | Key of a parent issue (e.g. PRJ-1) |
+| `custom_fields` | `object` | JSON with custom fields (e.g. {"Some Field": "2"}) |
+
+
+**Outputs**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `issue_key` | `string` | Key of the created issue |
+
+
+## Extra
+
+Module **`Atlassian JIRA` v1.2.0**
diff --git a/_shared_content/automate/library/aws.md b/_shared_content/automate/library/aws.md
@@ -0,0 +1,177 @@
+# AWS
+
+![AWS](/assets/playbooks/library/aws.svg){ align=right width=150 }
+
+[AWS](https://aws.amazon.com/) is a one of the main cloud provider, supported by Amazon. It offers services for storage (S3, Glacier, EBS, ...), for networking (Snowball, CloudFront, ...), for computing (EC2, ECS, EKS, ...) and others.
+This module provides triggers to collect events from AWS
+
+## Configuration
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `aws_access_key` | `string` | The identifier of the access key |
+| `aws_secret_access_key` | `string` | The secret associated to the access key |
+| `aws_region_name` | `string` | The area hosting the AWS resources |
+
+## Triggers
+
+### Fetch CloudTrail logs (deprecated)
+
+Get the last records from CloudTrail (deprecated in flavor of Fetch new CloudTrail records on S3)
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `frequency` | `integer` | Batch frequency in seconds |
+| `bucket_name` | `string` | The bucket that contains CloudTrail logs |
+| `prefix` | `string` | Limits the response to keys that begin with the specified prefix |
+| `chunk_size` | `integer` | The size of chunks for the batch processing |
+
+
+**Outputs**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `records` | `array` | A list of CloudTrail log records |
+| `records_path` | `string` | The filename containing the records |
+
+
+### Fetch Flowlog records (deprecated)
+
+Get the last records from FlowLog (deprecated in flavor of Fetch new logs on S3)
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `frequency` | `integer` | Batch frequency in seconds |
+| `bucket_name` | `string` | The bucket that contains Flowlog records |
+| `prefix` | `string` | Limits the response to keys that begin with the specified prefix |
+| `chunk_size` | `integer` | The size of chunks for the batch processing |
+
+
+**Outputs**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `records` | `array` | A list of Flowlog records |
+| `records_path` | `string` | The filename containing the records |
+
+
+### Fetch new CloudFront logs on S3
+
+Get all CloudFront records from S3
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `frequency` | `integer` | Batch frequency in seconds |
+| `queue_name` | `string` | The name of the SQS queue that received the notifications of the creation of S3 objects |
+| `chunk_size` | `integer` | The size of chunks for the batch processing |
+| `separator` | `string` | The separator used between each records (default: the linefeed character '\n') |
+| `skip_first` | `integer` | The number of records to skip at the begining of each S3 object (default: 0) |
+| `intake_server` | `string` | Server of the intake server (e.g. 'https://intake.sekoia.io') |
+| `intake_key` | `string` | Intake key to use when sending events |
+
+
+### Fetch new Flowlogs on S3
+
+Get line-oriented Flowlog records from new S3 objects based on notifications
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `frequency` | `integer` | Batch frequency in seconds |
+| `queue_name` | `string` | The name of the SQS queue that received the notifications of the creation of S3 objects |
+| `chunk_size` | `integer` | The size of chunks for the batch processing |
+| `separator` | `string` | The separator used between each records (default: the linefeed character '\n') |
+| `skip_first` | `integer` | The number of records to skip at the begining of each S3 object (default: 0) |
+| `ignore_comments` | `boolean` | Flag to ignore commented lines (starting with the character `#`; default: false) |
+| `intake_server` | `string` | Server of the intake server (e.g. 'https://intake.sekoia.io') |
+| `intake_key` | `string` | Intake key to use when sending events |
+
+
+### Fetch new FlowLogs Parquet records on S3
+
+Get FlowLogs records from new S3 Parquet objects based on notifications
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `frequency` | `integer` | Batch frequency in seconds |
+| `queue_name` | `string` | The name of the SQS queue that received the notifications of the creation of S3 objects |
+| `chunk_size` | `integer` | The size of chunks for the batch processing |
+| `intake_server` | `string` | Server of the intake server (e.g. 'https://intake.sekoia.io') |
+| `intake_key` | `string` | Intake key to use when sending events |
+
+
+### Fetch new logs on S3
+
+Get line-oriented records from new S3 objects based on notifications
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `frequency` | `integer` | Batch frequency in seconds |
+| `queue_name` | `string` | The name of the SQS queue that received the notifications of the creation of S3 objects |
+| `chunk_size` | `integer` | The size of chunks for the batch processing |
+| `separator` | `string` | The separator used between each records (default: the linefeed character '\n') |
+| `skip_first` | `integer` | The number of records to skip at the begining of each S3 object (default: 0) |
+| `ignore_comments` | `boolean` | Flag to ignore commented lines (starting with the character `#`; default: false) |
+| `intake_server` | `string` | Server of the intake server (e.g. 'https://intake.sekoia.io') |
+| `intake_key` | `string` | Intake key to use when sending events |
+
+
+### Fetch new OCSF records on S3
+
+Get OSCF records from new S3 Parquet objects based on notifications
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `frequency` | `integer` | Batch frequency in seconds |
+| `queue_name` | `string` | The name of the SQS queue that received the notifications of the creation of S3 objects |
+| `chunk_size` | `integer` | The size of chunks for the batch processing |
+| `intake_server` | `string` | Server of the intake server (e.g. 'https://intake.sekoia.io') |
+| `intake_key` | `string` | Intake key to use when sending events |
+
+
+### Fetch new CloudTrail records on S3
+
+Get Cloudtrail records from new S3 objects based on notifications
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `frequency` | `integer` | Batch frequency in seconds |
+| `queue_name` | `string` | The name of the SQS queue that received the notifications of the creation of S3 objects |
+| `chunk_size` | `integer` | The size of chunks for the batch processing |
+| `intake_server` | `string` | Server of the intake server (e.g. 'https://intake.sekoia.io') |
+| `intake_key` | `string` | Intake key to use when sending events |
+
+
+### Fetch new messages from the SQS
+
+Get messages from SQS
+
+**Arguments**
+
+| Name      |  Type   |  Description  |
+| --------- | ------- | --------------------------- |
+| `frequency` | `integer` | Batch frequency in seconds |
+| `queue_name` | `string` | The name of the SQS queue |
+| `chunk_size` | `integer` | The size of chunks for the batch processing |
+| `intake_server` | `string` | Server of the intake server (e.g. 'https://intake.sekoia.io') |
+| `intake_key` | `string` | Intake key to use when sending events |
+
+
+## Extra
+
+Module **`AWS` v1.31.6**