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

feat(component): add better resource documentation #219

Merged
merged 7 commits into from
Oct 16, 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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Collect AWS Resource Data

# How to Collect AWS Resource Data

The [Amazon Web Services (AWS)](../../reference/unified-data-model/aws.mdx) collector is configured within the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell).
The [Amazon Web Services (AWS)](../../reference/unified-data-model/aws/index.mdx) collector is configured within the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell).

## Prerequisites

Expand Down Expand Up @@ -35,7 +35,7 @@ This guide assumes that you have already [installed](../../getting-started/insta

### 2. Authenticate with AWS

**Fix Inventory supports the authentication mechanisms described in the [Boto3 SDK documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html).** You can authenticate with [<abbr title="Amazon Web Services">AWS</abbr>](../../reference/unified-data-model/aws.mdx) via an instance profile, an access key, or profiles. These credentials can be defined in the Fix Inventory Worker configuration or as environment variables.
**Fix Inventory supports the authentication mechanisms described in the [Boto3 SDK documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html).** You can authenticate with [<abbr title="Amazon Web Services">AWS</abbr>](../../reference/unified-data-model/aws/index.mdx) via an instance profile, an access key, or profiles. These credentials can be defined in the Fix Inventory Worker configuration or as environment variables.

<Tabs>
<TabItem value="configuration" label="Fix Inventory Worker Configuration">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Collect Azure Resource Data

# How to Collect Azure Resource Data

The [Azure](../../../reference/unified-data-model/azure.mdx) collector is configured within the [Fix Inventory Worker configuration](../../../reference/configuration/index.mdx) via the [`config` command](../../../reference/cli/config/index.mdx) in [Fix Inventory Shell](../../../reference/components/shell.mdx).
The [Azure](../../../reference/unified-data-model/azure/index.mdx) collector is configured within the [Fix Inventory Worker configuration](../../../reference/configuration/index.mdx) via the [`config` command](../../../reference/cli/config/index.mdx) in [Fix Inventory Shell](../../../reference/components/shell.mdx).

## Prerequisites

Expand Down Expand Up @@ -212,7 +212,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
> workflow run collect
```

2. Once the collect run completes, you can view a summary of collected [Azure resources](../../../reference/unified-data-model/azure.mdx) using the following search:
2. Once the collect run completes, you can view a summary of collected [Azure resources](../../../reference/unified-data-model/azure/index.mdx) using the following search:

```bash
> search is(azure_resource) | count kind
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Collect DigitalOcean Resource Data

# How to Collect DigitalOcean Resource Data

The [DigitalOcean](../../reference/unified-data-model/digitalocean.mdx) collector is configured within the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config/index.mdx) in [Fix Inventory Shell](../../reference/components/shell.mdx).
The [DigitalOcean](../../reference/unified-data-model/digitalocean/index.mdx) collector is configured within the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config/index.mdx) in [Fix Inventory Shell](../../reference/components/shell.mdx).

## Prerequisites

Expand Down Expand Up @@ -106,7 +106,7 @@ This guide assumes that you have already [installed](../../getting-started/insta
> workflow run collect
```

2. Once the collect run completes, you can view a summary of collected [DigitalOcean resources](../../reference/unified-data-model/digitalocean.mdx) using the following search:
2. Once the collect run completes, you can view a summary of collected [DigitalOcean resources](../../reference/unified-data-model/digitalocean/index.mdx) using the following search:

```bash
> search is(digitalocean_resource) | count kind
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Collect Google Cloud Resource Data

# How to Collect Google Cloud Resource Data

The [Google Cloud](../../reference/unified-data-model/gcp.mdx) collector is configured within the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config/index.mdx) in [Fix Inventory Shell](../../reference/components/shell.mdx).
The [Google Cloud](../../reference/unified-data-model/gcp/index.mdx) collector is configured within the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config/index.mdx) in [Fix Inventory Shell](../../reference/components/shell.mdx).

## Prerequisites

Expand Down Expand Up @@ -35,7 +35,7 @@ This guide assumes that you have already [installed](../../getting-started/insta

### 2. Authenticate with Google Cloud

**You can authenticate with [Google Cloud](../../reference/unified-data-model/gcp.mdx) via service account JSON files or automatic discovery.**
**You can authenticate with [Google Cloud](../../reference/unified-data-model/gcp/index.mdx) via service account JSON files or automatic discovery.**

<Tabs>
<TabItem value="service-account-json" label="Service Account JSON">
Expand Down Expand Up @@ -149,7 +149,7 @@ You can specify an empty string for the service account file, and Fix Inventory
> workflow run collect
```

2. Once the collect run completes, you can view a summary of collected [Google Cloud resources](../../reference/unified-data-model/gcp.mdx) using the following search:
2. Once the collect run completes, you can view a summary of collected [Google Cloud resources](../../reference/unified-data-model/gcp/index.mdx) using the following search:

```bash
> search is(gcp_resource) | count kind
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_label: Collect Kubernetes Resource Data

# How to Collect Kubernetes Resource Data

The [Kubernetes](../../reference/unified-data-model/kubernetes.mdx) collector is configured within the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config/index.mdx) in [Fix Inventory Shell](../../reference/components/shell.mdx).
The [Kubernetes](../../reference/unified-data-model/k8s/index.mdx) collector is configured within the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config/index.mdx) in [Fix Inventory Shell](../../reference/components/shell.mdx).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_root_user` resources](../../../reference/unified-data-model/aws.mdx#aws_root_user).
The command output will list the details of all non-compliant [`aws_root_user` resources](../../../reference/unified-data-model/aws/iam/aws_root_user.mdx).

## Remediation

Expand All @@ -58,7 +58,7 @@ Please refer to the [AWS IAM documentation](http://docs.aws.amazon.com/IAM/lates

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_root_user` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_root_user)
- [`aws_root_user` Resource Data Model](../../../reference/unified-data-model/aws/iam/aws_root_user.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_root_user` resources](../../../reference/unified-data-model/aws.mdx#aws_root_user).
The command output will list the details of all non-compliant [`aws_root_user` resources](../../../reference/unified-data-model/aws/iam/aws_root_user.mdx).

## Remediation

Expand All @@ -64,7 +64,7 @@ Please refer to the [AWS IAM documentation](https://docs.aws.amazon.com/IAM/late

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_root_user` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_root_user)
- [`aws_root_user` Resource Data Model](../../../reference/unified-data-model/aws/iam/aws_root_user.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_root_user` resources](../../../reference/unified-data-model/aws.mdx#aws_root_user).
The command output will list the details of all non-compliant [`aws_root_user` resources](../../../reference/unified-data-model/aws/iam/aws_root_user.mdx).

## Remediation

Expand All @@ -64,7 +64,7 @@ Please refer to the [AWS IAM documentation](https://docs.aws.amazon.com/IAM/late

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_root_user` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_root_user)
- [`aws_root_user` Resource Data Model](../../../reference/unified-data-model/aws/iam/aws_root_user.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_account` resources](../../../reference/unified-data-model/aws.mdx#aws_account).
The command output will list the details of all non-compliant [`aws_account` resources](../../../reference/unified-data-model/aws/root/aws_account.mdx).

## Remediation

Expand All @@ -58,7 +58,7 @@ Please refer to the [AWS IAM documentation](https://docs.aws.amazon.com/awssuppo

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_account` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_account)
- [`aws_account` Resource Data Model](../../../reference/unified-data-model/aws/root/aws_account.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_account` resources](../../../reference/unified-data-model/aws.mdx#aws_account).
The command output will list the details of all non-compliant [`aws_account` resources](../../../reference/unified-data-model/aws/root/aws_account.mdx).

## Remediation

Expand All @@ -60,7 +60,7 @@ Please refer to the [AWS IAM documentation](https://docs.aws.amazon.com/IAM/late

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_account` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_account)
- [`aws_account` Resource Data Model](../../../reference/unified-data-model/aws/root/aws_account.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_account` resources](../../../reference/unified-data-model/aws.mdx#aws_account).
The command output will list the details of all non-compliant [`aws_account` resources](../../../reference/unified-data-model/aws/root/aws_account.mdx).

## Remediation

Expand All @@ -59,7 +59,7 @@ Please refer to the [AWS IAM documentation](https://docs.aws.amazon.com/IAM/late

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_account` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_account)
- [`aws_account` Resource Data Model](../../../reference/unified-data-model/aws/root/aws_account.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_ec2_instance` resources](../../../reference/unified-data-model/aws.mdx#aws_ec2_instance).
The command output will list the details of all non-compliant [`aws_ec2_instance` resources](../../../reference/unified-data-model/aws/ec2/aws_ec2_instance.mdx).

## Remediation

Expand All @@ -60,7 +60,7 @@ Please refer to the [AWS EC2 documentation](https://docs.aws.amazon.com/IAM/late

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_ec2_instance` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_ec2_instance)
- [`aws_ec2_instance` Resource Data Model](../../../reference/unified-data-model/aws/ec2/aws_ec2_instance.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_iam_access_key` resources](../../../reference/unified-data-model/aws.mdx#aws_iam_access_key).
The command output will list the details of all non-compliant [`aws_iam_access_key` resources](../../../reference/unified-data-model/aws/iam/aws_iam_access_key.mdx).

## Remediation

Expand All @@ -67,7 +67,7 @@ Please refer to the [AWS IAM documentation](https://docs.aws.amazon.com/IAM/late

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_iam_access_key` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_iam_access_key)
- [`aws_iam_access_key` Resource Data Model](../../../reference/unified-data-model/aws/iam/aws_iam_access_key.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_iam_access_key` resources](../../../reference/unified-data-model/aws.mdx#aws_iam_access_key).
The command output will list the details of all non-compliant [`aws_iam_access_key` resources](../../../reference/unified-data-model/aws/iam/aws_iam_access_key.mdx).

## Remediation

Expand All @@ -62,7 +62,7 @@ Please refer to the [AWS IAM documentation](https://docs.aws.amazon.com/IAM/late

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_iam_access_key` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_iam_access_key)
- [`aws_iam_access_key` Resource Data Model](../../../reference/unified-data-model/aws/iam/aws_iam_access_key.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_iam_policy` resources](../../../reference/unified-data-model/aws.mdx#aws_iam_policy).
The command output will list the details of all non-compliant [`aws_iam_policy` resources](../../../reference/unified-data-model/aws/iam/aws_iam_policy.mdx).

## Remediation

Expand All @@ -61,7 +61,7 @@ Please refer to the [AWS IAM documentation](https://docs.aws.amazon.com/IAM/late

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_iam_policy` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_iam_policy)
- [`aws_iam_policy` Resource Data Model](../../../reference/unified-data-model/aws/iam/aws_iam_policy.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_iam_user` resources](../../../reference/unified-data-model/aws.mdx#aws_iam_user).
The command output will list the details of all non-compliant [`aws_iam_user` resources](../../../reference/unified-data-model/aws/iam/aws_iam_user.mdx).

## Remediation

Expand All @@ -61,7 +61,7 @@ Please refer to the [AWS IAM documentation](https://docs.aws.amazon.com/IAM/late

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_iam_user` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_iam_user)
- [`aws_iam_user` Resource Data Model](../../../reference/unified-data-model/aws/iam/aws_iam_user.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_iam_user` resources](../../../reference/unified-data-model/aws.mdx#aws_iam_user).
The command output will list the details of all non-compliant [`aws_iam_user` resources](../../../reference/unified-data-model/aws/iam/aws_iam_user.mdx).

## Remediation

Expand All @@ -62,7 +62,7 @@ Please refer to the [AWS IAM documentation](https://docs.aws.amazon.com/IAM/late

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_iam_user` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_iam_user)
- [`aws_iam_user` Resource Data Model](../../../reference/unified-data-model/aws/iam/aws_iam_user.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_lambda_function` resources](../../../reference/unified-data-model/aws.mdx#aws_lambda_function).
The command output will list the details of all non-compliant [`aws_lambda_function` resources](../../../reference/unified-data-model/aws/lambda/aws_lambda_function.mdx).

## Remediation

Expand All @@ -58,7 +58,7 @@ Please refer to the [AWS Lambda documentation](https://docs.aws.amazon.com/secre

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_lambda_function` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_lambda_function)
- [`aws_lambda_function` Resource Data Model](../../../reference/unified-data-model/aws/lambda/aws_lambda_function.mdx)

## External Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
# highlight-end
```

The command output will list the details of all non-compliant [`aws_lambda_function` resources](../../../reference/unified-data-model/aws.mdx#aws_lambda_function).
The command output will list the details of all non-compliant [`aws_lambda_function` resources](../../../reference/unified-data-model/aws/lambda/aws_lambda_function.mdx).

## Remediation

Expand All @@ -58,7 +58,7 @@ Please refer to the [AWS Lambda documentation](https://docs.aws.amazon.com/lambd

- [Search](../../../reference/search/index.mdx)
- [Command-Line Interface](../../../reference/cli/index.mdx)
- [`aws_lambda_function` Resource Data Model](../../../reference/unified-data-model/aws.mdx#aws_lambda_function)
- [`aws_lambda_function` Resource Data Model](../../../reference/unified-data-model/aws/lambda/aws_lambda_function.mdx)

## External Links

Expand Down
Loading