Skip to content

Commit aec131e

Browse files
authored
feat(component): add better resource documentation (#219)
1 parent 325415f commit aec131e

File tree

3,900 files changed

+284559
-135620
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

3,900 files changed

+284559
-135620
lines changed

docs/how-to-guides/data-sources/collect-aws-resource-data.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_label: Collect AWS Resource Data
44

55
# How to Collect AWS Resource Data
66

7-
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).
7+
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).
88

99
## Prerequisites
1010

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

3636
### 2. Authenticate with AWS
3737

38-
**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.
38+
**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.
3939

4040
<Tabs>
4141
<TabItem value="configuration" label="Fix Inventory Worker Configuration">

docs/how-to-guides/data-sources/collect-azure-resource-data/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_label: Collect Azure Resource Data
44

55
# How to Collect Azure Resource Data
66

7-
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).
7+
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).
88

99
## Prerequisites
1010

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

215-
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:
215+
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:
216216

217217
```bash
218218
> search is(azure_resource) | count kind

docs/how-to-guides/data-sources/collect-digitalocean-resource-data.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_label: Collect DigitalOcean Resource Data
44

55
# How to Collect DigitalOcean Resource Data
66

7-
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).
7+
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).
88

99
## Prerequisites
1010

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

109-
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:
109+
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:
110110

111111
```bash
112112
> search is(digitalocean_resource) | count kind

docs/how-to-guides/data-sources/collect-google-cloud-resource-data.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_label: Collect Google Cloud Resource Data
44

55
# How to Collect Google Cloud Resource Data
66

7-
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).
7+
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).
88

99
## Prerequisites
1010

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

3636
### 2. Authenticate with Google Cloud
3737

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

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

152-
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:
152+
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:
153153

154154
```bash
155155
> search is(gcp_resource) | count kind

docs/how-to-guides/data-sources/collect-kubernetes-resource-data.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_label: Collect Kubernetes Resource Data
44

55
# How to Collect Kubernetes Resource Data
66

7-
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).
7+
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).
88

99
## Prerequisites
1010

docs/how-to-guides/security/access-management/detect-use-of-aws-account-root-user-credentials.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
4242
# highlight-end
4343
```
4444

45-
The command output will list the details of all non-compliant [`aws_root_user` resources](../../../reference/unified-data-model/aws.mdx#aws_root_user).
45+
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).
4646

4747
## Remediation
4848

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

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

6363
## External Links
6464

docs/how-to-guides/security/access-management/find-aws-account-root-users-with-access-keys.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
4646
# highlight-end
4747
```
4848

49-
The command output will list the details of all non-compliant [`aws_root_user` resources](../../../reference/unified-data-model/aws.mdx#aws_root_user).
49+
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).
5050

5151
## Remediation
5252

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

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

6969
## External Links
7070

docs/how-to-guides/security/access-management/find-aws-account-root-users-without-hardware-mfa-enabled.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
4646
# highlight-end
4747
```
4848

49-
The command output will list the details of all non-compliant [`aws_root_user` resources](../../../reference/unified-data-model/aws.mdx#aws_root_user).
49+
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).
5050

5151
## Remediation
5252

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

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

6969
## External Links
7070

docs/how-to-guides/security/access-management/find-aws-accounts-missing-iam-support-roles.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
4242
# highlight-end
4343
```
4444

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

4747
## Remediation
4848

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

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

6363
## External Links
6464

docs/how-to-guides/security/access-management/find-aws-accounts-that-do-not-preent-reuse-of-the-last-24-passwords.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
4444
# highlight-end
4545
```
4646

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

4949
## Remediation
5050

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

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

6565
## External Links
6666

0 commit comments

Comments
 (0)