diff --git a/mission-control/docs/config-db/scrapers/aws.md b/mission-control/docs/config-db/scrapers/aws.md index 901c6014..ffbf1fb6 100644 --- a/mission-control/docs/config-db/scrapers/aws.md +++ b/mission-control/docs/config-db/scrapers/aws.md @@ -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 diff --git a/mission-control/docs/config-db/scrapers/azure-devops.md b/mission-control/docs/config-db/scrapers/azure-devops.md index 0452ce2f..a404916e 100644 --- a/mission-control/docs/config-db/scrapers/azure-devops.md +++ b/mission-control/docs/config-db/scrapers/azure-devops.md @@ -28,26 +28,26 @@ 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) | | -| `azureDevops` | Specifies the list of Azure DevOps configurations to scrape. | [`[]AzureDevops`](#azuredevops-1) | `false` | +| `azureDevops` | Specifies the list of Azure DevOps configurations to scrape. | [`[]AzureDevops`](#azuredevops-1) | | ### AzureDevops | 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` | +| `name` | A static value or JSONPath expression to use as the Name for the resource. Default value is the `id`. | `string` | | +| `items` | A JSONPath expression to use to extract individual items from the resource | `string` | | | `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` | +| `transform` | Specify field to transform result | [`Transform`](../concepts/transform.md) | | +| `format` | Format of config item, defaults to JSON, available options are JSON | `string` | | +| `timestampFormat` | TimestampFormat is a Go time format string used to parse timestamps in createFields and DeletedFields. If not specified, the default is `RFC3339`. | `string` | | +| `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` | | +| `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` | | | `organization` | Specifies the name of the Azure DevOps organization to scrape | `string` | `true` | | `personalAccessToken` | Specifies the personal access token to authenticate with Azure DevOps | []_EnvVar_ | `true` | -| `projects` | Specifies the Azure DevOps projects to scrape | `[]string` | `false` | -| `pipelines` | Specifies the Azure DevOps pipelines to scrape | `[]string` | `false` | +| `projects` | Specifies the Azure DevOps projects to scrape | `[]string` | | +| `pipelines` | Specifies the Azure DevOps pipelines to scrape | `[]string` | | diff --git a/mission-control/docs/config-db/scrapers/file.md b/mission-control/docs/config-db/scrapers/file.md index 7679892b..5b858e8f 100644 --- a/mission-control/docs/config-db/scrapers/file.md +++ b/mission-control/docs/config-db/scrapers/file.md @@ -22,25 +22,26 @@ For more examples of configuration file, please check the [GitHub repo](https:// | 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) | | -| `file` | Specifies the list of File configurations to scrape. | [`[]File`](#file-1) | `false` | +| `file` | Specifies the list of File configurations to scrape. | [`[]File`](#file-1) | | ### File | 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` | +| `name` | A static value or JSONPath expression to use as the Name for the resource. Default value is the `id`. | `string` | | +| `items` | A JSONPath expression to use to extract individual items from the resource | `string` | | | `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) | `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` | -| `url` | Specify URL e.g github repository containing the configuration(s) | `string` | `false` | +| `class` | A static value or JSONPath expression to use as the config class. _(Defaults to `type`)_ | `string` | | +| `transform` | Specify field to transform result | [`Transform`](../concepts/transform) | | +| `format` | Format of config item, defaults to JSON, available options are JSON | `string` | | +| `timestampFormat` | TimestampFormat is a Go time format string used to parse timestamps in createFields and DeletedFields. If not specified, the default is `RFC3339`. | `string` | | +| `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` | | +| `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` | | +| `url` | Specify URL e.g github repository containing the configuration(s) | `string` | | | `paths` | Specify paths to configuration(s) for scraping | `[]string` | `true` | -| `ignore` | Set configurations to ignore | `[]string` | `false` | +| `ignore` | Set configurations to ignore | `[]string` | | diff --git a/mission-control/docs/config-db/scrapers/kubernetes-file.md b/mission-control/docs/config-db/scrapers/kubernetes-file.md index 4cd1ae53..a4bda063 100644 --- a/mission-control/docs/config-db/scrapers/kubernetes-file.md +++ b/mission-control/docs/config-db/scrapers/kubernetes-file.md @@ -23,28 +23,28 @@ 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) | | -| `kubernetesFile` | Specifies the list of Kubernetes File configurations to scrape. | [`[]KubernetesFile`](#kubernetesfile-1) | `false` | +| `kubernetesFile` | Specifies the list of Kubernetes File configurations to scrape. | [`[]KubernetesFile`](#kubernetesfile-1) | | ### KubernetesFile -| 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` | -| `selector` | Specify Kubernetes resource for configuration based on `namespace`, `kind`, `name` and more. | [`ResourceSelector`](./resourceselector) | yes | -| `container` | Set container name | `string` | | -| `files` | Specify path to file contained in Pod | `[]File` | | +| 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` | | +| `items` | A JSONPath expression to use to extract individual items from the resource | `string` | | +| `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) | | +| `format` | Format of config item, defaults to JSON, available options are JSON | `string` | | +| `timestampFormat` | TimestampFormat is a Go time format string used to parse timestamps in createFields and DeletedFields. If not specified, the default is `RFC3339`. | `string` | | +| `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` | | +| `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` | | +| `selector` | Specify Kubernetes resource for configuration based on `namespace`, `kind`, `name` and more. | [`ResourceSelector`](../../reference/resource_selector) | `true` | +| `container` | Set container name | `string` | | +| `files` | Specify path to file contained in Pod | `[]File` | | ### File @@ -52,13 +52,3 @@ spec: | -------- | --------------------------------- | ---------- | -------- | | `path` | Set path to file contained in Pod | `[]string` | | | `format` | Specify format of file | `string` | | - -### ResourceSelector - -| Field | Description | Scheme | Required | -| --------------- | ----------------------------------------------------------------------------------------- | -------- | -------- | -| `namespace` | Specify Namespace for Kubernetes resource | `string` | | -| `kind` | Specify Kind of Kubernetes resource | `string` | | -| `name` | Specify name of Kubernetes resource | `string` | | -| `labelSelector` | Specify labels attached to Kubernetes resource | `string` | | -| `fieldSelector` | Specify Kubernetes resource based on value of resource fields. e.g `status.Phase=Running` | `string` | | diff --git a/mission-control/docs/config-db/scrapers/kubernetes.md b/mission-control/docs/config-db/scrapers/kubernetes.md index e3d32793..848e0c5e 100644 --- a/mission-control/docs/config-db/scrapers/kubernetes.md +++ b/mission-control/docs/config-db/scrapers/kubernetes.md @@ -41,25 +41,25 @@ 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) | | -| `kubernetes` | Specifies the list of Kubernetes configurations to scrape. | [`[]Kubernetes`](#kubernetes-1) | `false` | +| `kubernetes` | Specifies the list of Kubernetes configurations to scrape. | [`[]Kubernetes`](#kubernetes-1) | | ### Kubernetes | 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` | +| `id` | A static value or JSONPath expression to use as the ID for the resource. | `string` | | +| `name` | A static value or JSONPath expression to use as the Name for the resource. Default value is the `id`. | `string` | | +| `items` | A JSONPath expression to use to extract individual items from the resource | `string` | | +| `type` | A static value or JSONPath expression to use as the type for the resource. | `string` | | +| `transform` | Specify field to transform result | [`Transform`](../concepts/transform.md) | | +| `format` | Format of config item, defaults to JSON, available options are JSON | `string` | | +| `timestampFormat` | TimestampFormat is a Go time format string used to parse timestamps in createFields and DeletedFields. If not specified, the default is `RFC3339`. | `string` | | +| `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` | | +| `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` | | | `clusterName` | Specify cluster name | `string` | | | `namespace` | Specify namespace for scraping of Kubernetes resources | `string` | | | `useCache` | Specify boolean value to toggle fetching results from Kube-apiserver or fetch response from etcd | `bool` | | @@ -68,9 +68,9 @@ spec: | `selector` | Specify Kubernetes resource to scrape based on selector. e.g `matchLabels` | `string` | | | `fieldSelector` | Specify Kubernetes resource based on value of resource fields. e.g `status.Phase=Running` | `string` | | | `exclusions` | Specify Kubernetes resources to be excluded from scraping | `[]string` | | -| **`kubeconfig`** | Specify kubeconfig for access to your Kubernetes Cluster | []_EnvVar_ | yes | -| `event` | Specify configuration to handle Kubernetes events. | [`Event`](#sevent) | yes | -| `relationships` | Create relationships between kubernetes objects. | [`[]Relationship`](#kubernetes-relationship) | `false` | +| **`kubeconfig`** | Specify kubeconfig for access to your Kubernetes Cluster | []_EnvVar_ | | +| `event` | Specify configuration to handle Kubernetes events. | [`Event`](#sevent) | | +| `relationships` | Create relationships between kubernetes objects. | [`[]Relationship`](#kubernetes-relationship) | | ### Events @@ -80,15 +80,15 @@ In addition, you can also specify keywords used to identify the severity of the | Field | Description | Scheme | Required | | ------------------ | ------------------------------------------------------------------------------------------ | --------------------------------------- | -------- | -| `exclusions` | A list of keywords used to exclude event objects based on the reason | `[]string` | `false` | -| `severityKeywords` | Specify keywords used to identify the severity of the Kubernetes Event based on the reason | [`SeverityKeywords`](#severitykeywords) | `false` | +| `exclusions` | A list of keywords used to exclude event objects based on the reason | `[]string` | | +| `severityKeywords` | Specify keywords used to identify the severity of the Kubernetes Event based on the reason | [`SeverityKeywords`](#severitykeywords) | | ### SeverityKeywords | Field | Description | Scheme | Required | | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------- | -| `warn` | A list of keywords used to identify a warning severity from the reason. It could also be a match pattern: example "\*" to match all or "!badword" to exclude "badword" | `[]string` | `false` | -| `error` | Same as `warn` but used to map to error severity. | `[]string` | `false` | +| `warn` | A list of keywords used to identify a warning severity from the reason. It could also be a match pattern: example "\*" to match all or "!badword" to exclude "badword" | `[]string` | | +| `error` | Same as `warn` but used to map to error severity. | `[]string` | | ### Kubernetes Relationship diff --git a/mission-control/docs/config-db/scrapers/sql.md b/mission-control/docs/config-db/scrapers/sql.md index 12b1161f..88aabe03 100644 --- a/mission-control/docs/config-db/scrapers/sql.md +++ b/mission-control/docs/config-db/scrapers/sql.md @@ -75,25 +75,25 @@ 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) | | -| `sql` | Specifies the list of SQL configurations to scrape. | [`[]SQL`](#sql-1) | `false` | +| `sql` | Specifies the list of SQL configurations to scrape. | [`[]SQL`](#sql-1) | | ## SQL | 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` | +| `name` | A static value or JSONPath expression to use as the Name for the resource. Default value is the `id`. | `string` | | +| `items` | A JSONPath expression to use to extract individual items from the resource | `string` | | | `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) | `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` | +| `transform` | Specify field to transform result | [`Transform`](../concepts/transform) | | +| `format` | Format of config item, defaults to JSON, available options are JSON | `string` | | +| `timestampFormat` | TimestampFormat is a Go time format string used to parse timestamps in createFields and DeletedFields. If not specified, the default is `RFC3339`. | `string` | | +| `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` | | +| `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` | | | - | Specify connection details to the database | [Connection](#connection) | | -| `driver` | Specify the name of the driver to use for connecting to the database | `string` | `false` | +| `driver` | Specify the name of the driver to use for connecting to the database | `string` | | | `query` | Specify the SQL query to execute | `string` | `true` | diff --git a/mission-control/docs/config-db/scrapers/trivy.md b/mission-control/docs/config-db/scrapers/trivy.md index fb9ff922..3a210bae 100644 --- a/mission-control/docs/config-db/scrapers/trivy.md +++ b/mission-control/docs/config-db/scrapers/trivy.md @@ -26,30 +26,30 @@ _Fig: A detailed view of the analysis on the postgres container_ | 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) | | -| `trivy` | Specifies the list of Trivy configurations to scrape. | [`[]Trivy`](#trivy-1) | `false` | +| `trivy` | Specifies the list of Trivy configurations to scrape. | [`[]Trivy`](#trivy-1) | | ### Trivy | 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` | +| `name` | A static value or JSONPath expression to use as the Name for the resource. Default value is the `id`. | `string` | | +| `items` | A JSONPath expression to use to extract individual items from the resource | `string` | | | `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` | -| `version` | Specify the Trivy version to use. (default 0.40.0) | `string` | `false` | -| `compliance` | compliance report to generate(k8s-nsa, k8s-cis, k8s-pss-baseline, k8s-pss-restricted). | `string` | `false` | -| `ignoredLicenses` | specify a list of license to ignore. | `[]string` | `false` | -| `ignoreUnfixed` | display only fixed vulnerabilities. | `bool` | `false` | -| `licenseFull` | eagerly look for licenses in source code headers and license files. | `bool` | `false` | -| `severity` | severities of security issues to be displayed (comma separated)_(default "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL")_. | `string` | `false` | -| `vulnType` | comma-separated list of vulnerability types (comma separated)_(default "os,library")_. | `string` | `false` | +| `transform` | Specify field to transform result. | [`Transform`](../concepts/transform.md) | | +| `format` | Format of config item, defaults to JSON, available options are JSON. | `string` | | +| `timestampFormat` | TimestampFormat is a Go time format string used to parse timestamps in createFields and DeletedFields. If not specified, the default is `RFC3339`. | `string` | | +| `version` | Specify the Trivy version to use. (default 0.40.0) | `string` | | +| `compliance` | compliance report to generate(k8s-nsa, k8s-cis, k8s-pss-baseline, k8s-pss-restricted). | `string` | | +| `ignoredLicenses` | specify a list of license to ignore. | `[]string` | | +| `ignoreUnfixed` | display only fixed vulnerabilities. | `bool` | | +| `licenseFull` | eagerly look for licenses in source code headers and license files. | `bool` | | +| `severity` | severities of security issues to be displayed (comma separated)_(default "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL")_. | `string` | | +| `vulnType` | comma-separated list of vulnerability types (comma separated)_(default "os,library")_. | `string` | | | `kubernetes` | Specify the trivy option to scan kubernetes objects. | [`K8sOptions`](#k8soptions) | `true` | ### K8sOptions @@ -58,7 +58,7 @@ Trivy Options consist of selected few flags that are passed on to trivy. | Field | Description | Scheme | Required | | ------------ | -------------------------------------------------------------------------------------- | ---------- | -------- | -| `components` | Specify which components to scan*(default workload, infra).* | `[]string` | `false` | -| `kubeconfig` | Specify the kubeconfig file path to use as a static value or as a JSONPath expression. | `string` | `false` | +| `components` | Specify which components to scan*(default workload, infra).* | `[]string` | | +| `kubeconfig` | Specify the kubeconfig file path to use as a static value or as a JSONPath expression. | `string` | | | `namespace` | Specify a namespace to scan. | `string` | `true` | -| `context` | Specify a context to scan. | `string` | `false` | +| `context` | Specify a context to scan. | `string` | |