Skip to content

Commit

Permalink
chore: update structure descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@adityathebe
adityathebe committed Feb 20, 2024
1 parent 440cd5e commit 7eb080e
Show file tree
Hide file tree
Showing 7 changed files with 131 additions and 140 deletions.
70 changes: 35 additions & 35 deletions mission-control/docs/config-db/scrapers/aws.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,51 +75,51 @@ spec:
| Field | Description | Scheme | Required |
| ----------- | ---------------------------------------------------------------------------------- | -------------------------------------------- | -------- |
| `logLevel` | Specify the level of logging. | `string` | `false` |
| `schedule` | Specify the interval to scrape in cron format. Defaults to every 60 minutes. | `string` | `false` |
| `full` | Set to `true` to extract changes from scraped configurations. Defaults to `false`. | `bool` | `false` |
| `logLevel` | Specify the level of logging. | `string` | |
| `schedule` | Specify the interval to scrape in cron format. Defaults to every 60 minutes. | `string` | |
| `full` | Set to `true` to extract changes from scraped configurations. Defaults to `false`. | `bool` | |
| `retention` | Settings for retaining changes, analysis and scraped items | [`Retention`](/config-db/concepts/retention) | |
| `aws` | Specifies the list of AWS configurations to scrape. | [`[]AWS`](#aws-1) | `false` |
| `aws` | Specifies the list of AWS configurations to scrape. | [`[]AWS`](#aws-1) | |

### AWS

| Field | Description | Scheme | Required |
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | -------- |
| `id` | A static value or JSONPath expression to use as the ID for the resource. | `string` | `true` |
| `name` | A static value or JSONPath expression to use as the Name for the resource. Default value is the `id`. | `string` | `false` |
| `items` | A JSONPath expression to use to extract individual items from the resource | `string` | `false` |
| `type` | A static value or JSONPath expression to use as the type for the resource. | `string` | `true` |
| `transform` | Specify field to transform result | [`Transform`](../concepts/transform.md) | `false` |
| `format` | Format of config item, defaults to JSON, available options are JSON | `string` | `false` |
| `timestampFormat` | TimestampFormat is a Go time format string used to parse timestamps in createFields and DeletedFields. If not specified, the default is `RFC3339`. | `string` | `false` |
| `createFields` | CreateFields is a list of JSONPath expression used to identify the created time of the config. If multiple fields are specified, the first non-empty value will be used | `[]string` | `false` |
| `deleteFields` | DeleteFields is a JSONPath expression used to identify the deleted time of the config. If multiple fields are specified, the first non-empty value will be used | `[]string` | `false` |
| `compliance` | Toggle scraping of compliance metadata | _bool_ | |
| `patch_states` | Set boolean value for scraping of patch state status, and report | _bool_ | |
| `trusted_advisor_check` | Set boolean value for enabling/disabling trusted advisor | _bool_ | |
| `patch_details` | Set boolean value to enable/disable scraping of patch details | _bool_ | |
| [`cost_reporting`](#cost-reporting) | Specify cost reporting for scraping of data | [_CostReporting_](#cost-reporting) | |
| [`cloud_trail`](#cloudtrail-cloudtrail-cloudtrail) | Set CloudTrail specifications | [_CloudTrail_](#cloudtrail-cloudtrail) | |
| `include` | Specify AWS resources to include for scraping | _\[\]string_ | |
| `exclude` | Specify AWS resources to exclude from scraping | _\[\]string_ | |
| `inventory` | Toggle scrape of _metadata_ for AWS resources | _bool_ | |
| `properties` | Custom templatable properties for the scraped config items. | [`[]ConfigProperty`](../../reference/property) | |
| Field | Description | Scheme | Required |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- | -------- |
| `id` | A static value or JSONPath expression to use as the ID for the resource. | `string` | `true` |
| `name` | A static value or JSONPath expression to use as the Name for the resource. Default value is the `id`. | `string` | |
| `type` | A static value or JSONPath expression to use as the type for the resource. | `string` | `true` |
| `cloud_trail` | Set CloudTrail specifications | [`CloudTrail`](#cloudtrail-cloudtrail) | |
| `compliance` | Toggle scraping of compliance metadata | `bool` | |
| `cost_reporting` | Specify cost reporting for scraping of data | [`CostReporting`](#cost-reporting) | |
| `createFields` | List of JSONPath expression used to identify the created time of the config. If multiple fields are specified, the first non-empty value will be used. | `[]string` | |
| `deleteFields` | List of JSONPath expression used to identify the deleted time of the config. If multiple fields are specified, the first non-empty value will be used. | `[]string` | |
| `exclude` | AWS resources to exclude from scraping | `[]string` | |
| `format` | Format of config item, defaults to JSON, available options are JSON | `string` | |
| `include` | AWS resources to include for scraping | `[]string` | |
| `inventory` | Toggle scrape of _metadata_ for AWS resources | `bool` | |
| `items` | A JSONPath expression to use to extract individual items from the resource | `string` | |
| `patch_details` | Enable/disable scraping of patch details | `bool` | |
| `patch_states` | Scrape patch state status, and report | `bool` | |
| `properties` | Custom templatable properties for the scraped config items. | [`[]ConfigProperty`](../../reference/property) | |
| `timestampFormat` | TimestampFormat is a Go time format string used to parse timestamps in createFields and DeletedFields. If not specified, the default is `RFC3339`. | `string` | |
| `transform` | Field to transform result | [`Transform`](../concepts/transform.md) | |
| `trusted_advisor_check` | Enable/Disable scraping analyses from Trusted Advisor | `bool` | |

### CloudTrail (`cloudtrail`)
### CloudTrail

| Field | Description | Scheme | Required |
| --------- | --------------------------------------- | ------------ | -------- |
| `exclude` | Set events to be excluded from scraping | _\[\]string_ | |
| `max_age` | Set maximum age of events for scraping | _string_ | |
| Field | Description | Scheme | Required |
| --------- | --------------------------------------- | ---------- | -------- |
| `exclude` | Set events to be excluded from scraping | `[]string` | |
| `max_age` | Set maximum age of events for scraping | `string` | |

### Cost Reporting (`cost_reporting`)
### Cost Reporting

| Field | Description | Scheme | Required |
| ---------------- | -------------------------------------------------------------- | -------- | -------- |
| `s3_bucket_path` | Set path for S3 bucket to scrape published AWS billing reports | _string_ | |
| `table` | Specify table containing cost and usage data | _string_ | |
| `database` | Specify database containing cost and usage data | _string_ | |
| `region` | Specify region for S3 bucket | _string_ | |
| `s3_bucket_path` | Set path for S3 bucket to scrape published AWS billing reports | `string` | |
| `table` | Specify table containing cost and usage data | `string` | |
| `database` | Specify database containing cost and usage data | `string` | |
| `region` | Specify region for S3 bucket | `string` | |

### Supported Resources

Expand Down
Loading

0 comments on commit 7eb080e

Please sign in to comment.