From b47abe0ab7c424889bb88adae019c930accdacd7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20L=C3=B6sche?= Date: Wed, 28 Feb 2024 18:18:54 +0100 Subject: [PATCH] fix: fixinventory -> fix --- docs/concepts/resource-management/cleanup.mdx | 2 +- .../cleanup/clean-up-aws-cloudwatch-alarms.mdx | 2 +- .../cleanup/clean-up-aws-ebs-volumes.mdx | 2 +- .../cleanup/clean-up-aws-iam-access-keys.mdx | 2 +- .../cleanup/clean-up-aws-load-balancers.mdx | 2 +- .../cleanup/clean-up-aws-vpc-resources.mdx | 2 +- .../cleanup/clean-up-expired-resources.mdx | 2 +- .../cleanup/clean-up-untagged-resources.mdx | 2 +- .../data-sources/collect-aws-resource-data.mdx | 10 +++++----- .../collect-digitalocean-resource-data.mdx | 4 ++-- .../collect-google-cloud-resource-data.mdx | 6 +++--- .../collect-kubernetes-resource-data.mdx | 6 +++--- docs/reference/cli/config/list.mdx | 8 ++++---- docs/reference/cli/config/show.mdx | 2 +- docs/reference/cli/index.mdx | 4 ++-- docs/reference/components/metrics.mdx | 2 +- .../components/plugins/cleanup_aws_alarms.mdx | 2 +- .../plugins/cleanup_aws_loadbalancers.mdx | 2 +- .../components/plugins/cleanup_aws_vpcs.mdx | 2 +- .../components/plugins/cleanup_expired.mdx | 2 +- .../components/plugins/cleanup_untagged.mdx | 2 +- .../components/plugins/cleanup_volumes.mdx | 2 +- docs/reference/components/plugins/index.mdx | 2 +- docs/reference/components/plugins/protector.mdx | 2 +- .../components/plugins/tagvalidator.mdx | 2 +- docs/reference/components/worker.mdx | 2 +- docs/reference/configuration/core.mdx | 16 ++++++++-------- docs/reference/configuration/index.mdx | 14 +++++++------- docs/reference/events/index.mdx | 2 +- docs/reference/workflows/index.mdx | 2 +- .../concepts/resource-management/cleanup.mdx | 2 +- .../cleanup/clean-up-aws-cloudwatch-alarms.mdx | 2 +- .../cleanup/clean-up-aws-ebs-volumes.mdx | 2 +- .../cleanup/clean-up-aws-iam-access-keys.mdx | 2 +- .../cleanup/clean-up-aws-load-balancers.mdx | 2 +- .../cleanup/clean-up-aws-vpc-resources.mdx | 2 +- .../cleanup/clean-up-expired-resources.mdx | 2 +- .../cleanup/clean-up-untagged-resources.mdx | 2 +- .../data-sources/collect-aws-resource-data.mdx | 10 +++++----- .../collect-digitalocean-resource-data.mdx | 4 ++-- .../collect-google-cloud-resource-data.mdx | 6 +++--- .../collect-kubernetes-resource-data.mdx | 6 +++--- .../version-4.X/reference/cli/config/list.mdx | 8 ++++---- .../version-4.X/reference/cli/config/show.mdx | 2 +- .../version-4.X/reference/cli/index.mdx | 4 ++-- .../version-4.X/reference/components/metrics.mdx | 2 +- .../components/plugins/cleanup_aws_alarms.mdx | 2 +- .../plugins/cleanup_aws_loadbalancers.mdx | 2 +- .../components/plugins/cleanup_aws_vpcs.mdx | 2 +- .../components/plugins/cleanup_expired.mdx | 2 +- .../components/plugins/cleanup_untagged.mdx | 2 +- .../components/plugins/cleanup_volumes.mdx | 2 +- .../reference/components/plugins/index.mdx | 2 +- .../reference/components/plugins/protector.mdx | 2 +- .../components/plugins/tagvalidator.mdx | 2 +- .../version-4.X/reference/components/worker.mdx | 2 +- .../version-4.X/reference/configuration/core.mdx | 16 ++++++++-------- .../reference/configuration/index.mdx | 14 +++++++------- .../version-4.X/reference/events/index.mdx | 2 +- .../version-4.X/reference/workflows/index.mdx | 2 +- 60 files changed, 112 insertions(+), 112 deletions(-) diff --git a/docs/concepts/resource-management/cleanup.mdx b/docs/concepts/resource-management/cleanup.mdx index 00128e91..5676bf34 100644 --- a/docs/concepts/resource-management/cleanup.mdx +++ b/docs/concepts/resource-management/cleanup.mdx @@ -71,7 +71,7 @@ Resources can only be cleaned up if they are not [protected](./protection.mdx). To enable cleanup, execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash -> config edit fixinventory.worker +> config edit fix.worker ``` Then, modify the `fixworker` section of the configuration as follows: diff --git a/docs/how-to-guides/cleanup/clean-up-aws-cloudwatch-alarms.mdx b/docs/how-to-guides/cleanup/clean-up-aws-cloudwatch-alarms.mdx index 7bb84c6d..6dea7314 100644 --- a/docs/how-to-guides/cleanup/clean-up-aws-cloudwatch-alarms.mdx +++ b/docs/how-to-guides/cleanup/clean-up-aws-cloudwatch-alarms.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/docs/how-to-guides/cleanup/clean-up-aws-ebs-volumes.mdx b/docs/how-to-guides/cleanup/clean-up-aws-ebs-volumes.mdx index 99680996..deb85584 100644 --- a/docs/how-to-guides/cleanup/clean-up-aws-ebs-volumes.mdx +++ b/docs/how-to-guides/cleanup/clean-up-aws-ebs-volumes.mdx @@ -15,7 +15,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/docs/how-to-guides/cleanup/clean-up-aws-iam-access-keys.mdx b/docs/how-to-guides/cleanup/clean-up-aws-iam-access-keys.mdx index 680e0283..322dabda 100644 --- a/docs/how-to-guides/cleanup/clean-up-aws-iam-access-keys.mdx +++ b/docs/how-to-guides/cleanup/clean-up-aws-iam-access-keys.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/docs/how-to-guides/cleanup/clean-up-aws-load-balancers.mdx b/docs/how-to-guides/cleanup/clean-up-aws-load-balancers.mdx index b6668bfd..efac9945 100644 --- a/docs/how-to-guides/cleanup/clean-up-aws-load-balancers.mdx +++ b/docs/how-to-guides/cleanup/clean-up-aws-load-balancers.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/docs/how-to-guides/cleanup/clean-up-aws-vpc-resources.mdx b/docs/how-to-guides/cleanup/clean-up-aws-vpc-resources.mdx index cec39e53..c9f7404d 100644 --- a/docs/how-to-guides/cleanup/clean-up-aws-vpc-resources.mdx +++ b/docs/how-to-guides/cleanup/clean-up-aws-vpc-resources.mdx @@ -29,7 +29,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/docs/how-to-guides/cleanup/clean-up-expired-resources.mdx b/docs/how-to-guides/cleanup/clean-up-expired-resources.mdx index d1a007cf..a89de0bc 100644 --- a/docs/how-to-guides/cleanup/clean-up-expired-resources.mdx +++ b/docs/how-to-guides/cleanup/clean-up-expired-resources.mdx @@ -18,7 +18,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/docs/how-to-guides/cleanup/clean-up-untagged-resources.mdx b/docs/how-to-guides/cleanup/clean-up-untagged-resources.mdx index cb7c4e04..00d2b6df 100644 --- a/docs/how-to-guides/cleanup/clean-up-untagged-resources.mdx +++ b/docs/how-to-guides/cleanup/clean-up-untagged-resources.mdx @@ -18,7 +18,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/docs/how-to-guides/data-sources/collect-aws-resource-data.mdx b/docs/how-to-guides/data-sources/collect-aws-resource-data.mdx index 5048faec..7ffabc6d 100644 --- a/docs/how-to-guides/data-sources/collect-aws-resource-data.mdx +++ b/docs/how-to-guides/data-sources/collect-aws-resource-data.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Add `aws` to the list of collectors by modifying the configuration as follows: @@ -47,7 +47,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 2. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 3. Add the contents of your `credentials` file to the `fixworker` section of the configuration as follows: @@ -109,7 +109,7 @@ Access keys in the configuration are visible to anyone with access to your Fix I 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Modify the `aws` section of the configuration as follows: @@ -149,7 +149,7 @@ Access keys in the configuration are visible to anyone with access to your Fix I 2. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 3. Add the contents of your `credentials` file to the `fixworker` section of the configuration as follows: @@ -256,7 +256,7 @@ You can specify a profile using `AWS_PROFILE` and, for local testing, SSO authen 2. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 3. Modify the `aws` section of the configuration as follows, making sure that `aws.access_key_id` and `aws.secret_access_key` are set to `null`: diff --git a/docs/how-to-guides/data-sources/collect-digitalocean-resource-data.mdx b/docs/how-to-guides/data-sources/collect-digitalocean-resource-data.mdx index 9f9556a8..438216c3 100644 --- a/docs/how-to-guides/data-sources/collect-digitalocean-resource-data.mdx +++ b/docs/how-to-guides/data-sources/collect-digitalocean-resource-data.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Add `digitalocean` to the list of collectors by modifying the configuration as follows: @@ -43,7 +43,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Modify the `digitalocean` section of the configuration as follows, adding your API tokens and/or access keys: diff --git a/docs/how-to-guides/data-sources/collect-google-cloud-resource-data.mdx b/docs/how-to-guides/data-sources/collect-google-cloud-resource-data.mdx index d9be3b2b..322771d0 100644 --- a/docs/how-to-guides/data-sources/collect-google-cloud-resource-data.mdx +++ b/docs/how-to-guides/data-sources/collect-google-cloud-resource-data.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Add `gcp` to the list of collectors by modifying the configuration as follows: @@ -43,7 +43,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash -> config edit fixinventory.worker +> config edit fix.worker ``` 2. Add the contents of your service account JSON file(s) to the `fixworker` section of the configuration as follows: @@ -119,7 +119,7 @@ You can specify an empty string for the service account file, and Fix Inventory 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Modify the `gcp` section of the configuration as follows: diff --git a/docs/how-to-guides/data-sources/collect-kubernetes-resource-data.mdx b/docs/how-to-guides/data-sources/collect-kubernetes-resource-data.mdx index ea68549f..07df845a 100644 --- a/docs/how-to-guides/data-sources/collect-kubernetes-resource-data.mdx +++ b/docs/how-to-guides/data-sources/collect-kubernetes-resource-data.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Add `k8s` to the list of collectors by modifying the configuration as follows: @@ -45,7 +45,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Add the content of kubeconfig file(s) to the `fixworker` section as follows: @@ -139,7 +139,7 @@ The required values can be found in the [kubeconfig file](https://kubernetes.io/ 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Modify the `k8s` section of the configuration as follows: diff --git a/docs/reference/cli/config/list.mdx b/docs/reference/cli/config/list.mdx index a546ffb6..4978731c 100644 --- a/docs/reference/cli/config/list.mdx +++ b/docs/reference/cli/config/list.mdx @@ -18,9 +18,9 @@ config list ```bash > configs list # highlight-start -​fixinventory.core -​fixinventory.worker.1 -​fixinventory.worker.2 -​fixinventory.metrics +​fix.core +​fix.worker.1 +​fix.worker.2 +​fix.metrics # highlight-end ``` diff --git a/docs/reference/cli/config/show.mdx b/docs/reference/cli/config/show.mdx index b40471ee..e9b52935 100644 --- a/docs/reference/cli/config/show.mdx +++ b/docs/reference/cli/config/show.mdx @@ -22,7 +22,7 @@ config show ## Examples ```bash -> configs show fixinventory.core +> configs show fix.core ​fixcore: ​ # API related properties. ​ api: diff --git a/docs/reference/cli/index.mdx b/docs/reference/cli/index.mdx index 800e0830..06ff018d 100644 --- a/docs/reference/cli/index.mdx +++ b/docs/reference/cli/index.mdx @@ -77,7 +77,7 @@ You can pipe commands using `|` and chain commands using `;`. It is possible to create your own commands by combining existing commands with your own logic. -In [Fix Inventory Shell](../components/shell.mdx), type `config edit fixinventory.core.commands`. This will open a file and show all available custom commands. +In [Fix Inventory Shell](../components/shell.mdx), type `config edit fix.core.commands`. This will open a file and show all available custom commands. ### Custom Command Properties @@ -104,7 +104,7 @@ parameters: template: 'echo Hello {{person}}.' ``` -Once a custom command has been defined in the `fixinventory.core.commands` configuration, the command can be executed in [Fix Inventory Shell](../components/shell.mdx): +Once a custom command has been defined in the `fix.core.commands` configuration, the command can be executed in [Fix Inventory Shell](../components/shell.mdx): ```bash title="Usage of the new hello command" > help hello diff --git a/docs/reference/components/metrics.mdx b/docs/reference/components/metrics.mdx index fd5817bd..c22bbb44 100644 --- a/docs/reference/components/metrics.mdx +++ b/docs/reference/components/metrics.mdx @@ -30,7 +30,7 @@ scrape_configs: | Option | Description | Default | | ---------------------------------------------------- | ------------------------------------ | ------------------------ | -| `--subscriber-id ` | Unique subscriber ID | `fixinventory.worker` | +| `--subscriber-id ` | Unique subscriber ID | `fix.worker` | | `--psk ` | Pre-shared key | | | `--verbose`, `-v` | Verbose logging | | | `--quiet` | Only log errors | | diff --git a/docs/reference/components/plugins/cleanup_aws_alarms.mdx b/docs/reference/components/plugins/cleanup_aws_alarms.mdx index 64e759a8..0e592a90 100644 --- a/docs/reference/components/plugins/cleanup_aws_alarms.mdx +++ b/docs/reference/components/plugins/cleanup_aws_alarms.mdx @@ -15,7 +15,7 @@ The following resources are currently being marked for cleanup In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/docs/reference/components/plugins/cleanup_aws_loadbalancers.mdx b/docs/reference/components/plugins/cleanup_aws_loadbalancers.mdx index 5629b8a4..cdeab518 100644 --- a/docs/reference/components/plugins/cleanup_aws_loadbalancers.mdx +++ b/docs/reference/components/plugins/cleanup_aws_loadbalancers.mdx @@ -11,7 +11,7 @@ This plugin cleans up AWS ALB/ELB load balancers with no instances attached to t In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/docs/reference/components/plugins/cleanup_aws_vpcs.mdx b/docs/reference/components/plugins/cleanup_aws_vpcs.mdx index c02d2ae8..6a7ed7bd 100644 --- a/docs/reference/components/plugins/cleanup_aws_vpcs.mdx +++ b/docs/reference/components/plugins/cleanup_aws_vpcs.mdx @@ -25,7 +25,7 @@ The following resources are currently being marked for cleanup In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/docs/reference/components/plugins/cleanup_expired.mdx b/docs/reference/components/plugins/cleanup_expired.mdx index 8da12104..479b40f2 100644 --- a/docs/reference/components/plugins/cleanup_expired.mdx +++ b/docs/reference/components/plugins/cleanup_expired.mdx @@ -30,7 +30,7 @@ Each of them can be abbreviated down to one letter. E.g. `7d`, `24h`, `60m`, etc In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/docs/reference/components/plugins/cleanup_untagged.mdx b/docs/reference/components/plugins/cleanup_untagged.mdx index c8695f21..69342544 100644 --- a/docs/reference/components/plugins/cleanup_untagged.mdx +++ b/docs/reference/components/plugins/cleanup_untagged.mdx @@ -11,7 +11,7 @@ This plugin deletes cloud resources that are missing mandatory tags after a cert In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/docs/reference/components/plugins/cleanup_volumes.mdx b/docs/reference/components/plugins/cleanup_volumes.mdx index d26b2395..432f4f98 100644 --- a/docs/reference/components/plugins/cleanup_volumes.mdx +++ b/docs/reference/components/plugins/cleanup_volumes.mdx @@ -11,7 +11,7 @@ This plugin cleans up unused storage volumes. In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/docs/reference/components/plugins/index.mdx b/docs/reference/components/plugins/index.mdx index d74bc74d..54184f4f 100644 --- a/docs/reference/components/plugins/index.mdx +++ b/docs/reference/components/plugins/index.mdx @@ -1,5 +1,5 @@ # Plugins -Plugins can be used to perform actions whenever something happens within Fix Inventory. Cleanup plugins for instance exist for automated cleanup that is more complex than what a simple CLI search can do. Plugins are loaded by [Fix Inventory Worker](../worker.mdx) and often come with their own configuration. Enable or configure them using the [`config edit fixinventory.worker`](../../../reference/cli/config/edit.mdx) command. +Plugins can be used to perform actions whenever something happens within Fix Inventory. Cleanup plugins for instance exist for automated cleanup that is more complex than what a simple CLI search can do. Plugins are loaded by [Fix Inventory Worker](../worker.mdx) and often come with their own configuration. Enable or configure them using the [`config edit fix.worker`](../../../reference/cli/config/edit.mdx) command. diff --git a/docs/reference/components/plugins/protector.mdx b/docs/reference/components/plugins/protector.mdx index 547f0943..39379c60 100644 --- a/docs/reference/components/plugins/protector.mdx +++ b/docs/reference/components/plugins/protector.mdx @@ -11,7 +11,7 @@ This plugin protects important resources from deletion by Fix Inventory. In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/docs/reference/components/plugins/tagvalidator.mdx b/docs/reference/components/plugins/tagvalidator.mdx index 5b614328..717e47a0 100644 --- a/docs/reference/components/plugins/tagvalidator.mdx +++ b/docs/reference/components/plugins/tagvalidator.mdx @@ -11,7 +11,7 @@ This plugin validates the contents of expiration tags. With it you can enforce a In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/docs/reference/components/worker.mdx b/docs/reference/components/worker.mdx index 42652a34..b3e6935b 100644 --- a/docs/reference/components/worker.mdx +++ b/docs/reference/components/worker.mdx @@ -25,7 +25,7 @@ somecr.io/someengineering/fixinventoryworker:{{imageTag}} | Option | Description | Default | | ---------------------------------------------------- | ------------------------------------ | ------------------------ | -| `--subscriber-id ` | Unique subscriber ID | `fixinventory.worker` | +| `--subscriber-id ` | Unique subscriber ID | `fix.worker` | | `--psk ` | Pre-shared key | | | `--verbose`, `-v` | Verbose logging | | | `--quiet` | Only log errors | | diff --git a/docs/reference/configuration/core.mdx b/docs/reference/configuration/core.mdx index cf80c91f..d512ef49 100644 --- a/docs/reference/configuration/core.mdx +++ b/docs/reference/configuration/core.mdx @@ -6,12 +6,12 @@ sidebar_label: Core ## Network Interfaces -For security reasons, [Fix Inventory Core](../components/core.mdx) only listens on the loopback interface by default. This can be changed via the `fixcore.api.web_hosts` option in the `fixinventory.core` configuration. +For security reasons, [Fix Inventory Core](../components/core.mdx) only listens on the loopback interface by default. This can be changed via the `fixcore.api.web_hosts` option in the `fix.core` configuration. Execute the following command in [Fix Inventory Shell](../components/shell.mdx) to open the relevant configuration for editing: ```bash -> config edit fixinventory.core +> config edit fix.core ``` ```yaml title="Configuration to listen on all IPv6 and IPv4 interfaces" @@ -34,17 +34,17 @@ fixcore: Alternatively, you can use the [`config set` command](../cli/config/set.mdx): ```bash -> config set fixinventory.core fixcore.api.web_hosts=["::", "0.0.0.0"] +> config set fix.core fixcore.api.web_hosts=["::", "0.0.0.0"] ``` ## TLS Certificate -Fix Inventory attempts to find all local IP addresses and hostnames and add them to the subject alternative names (SAN) list of the x509 certificate. If your system has additional DNS names, you can add them to the SAN list via the `fixcore.api.host_certificate.san_dns_names` option in the `fixinventory.core` configuration. +Fix Inventory attempts to find all local IP addresses and hostnames and add them to the subject alternative names (SAN) list of the x509 certificate. If your system has additional DNS names, you can add them to the SAN list via the `fixcore.api.host_certificate.san_dns_names` option in the `fix.core` configuration. Execute the following command in [Fix Inventory Shell](../components/shell.mdx) to open the relevant configuration for editing: ```bash -> config edit fixinventory.core +> config edit fix.core ``` ```yaml title="Configuration with additional DNS names on SAN list" @@ -78,7 +78,7 @@ By default, the [`collect_and_cleanup` workflow](../../reference/workflows/index Execute the following command in [Fix Inventory Shell](../components/shell.mdx) to open the relevant configuration for editing: ```bash -> config edit fixinventory.core +> config edit fix.core ``` ```yaml @@ -98,7 +98,7 @@ fixcore: Alternatively, you can use the [`config set` command](../cli/config/set.mdx): ```bash title="Configure the collect_and_cleanup workflow to run twice per hour" -> config set fixinventory.core fixcore.workflows.collect_and_cleanup.schedule="0,30 * * * *" +> config set fix.core fixcore.workflows.collect_and_cleanup.schedule="0,30 * * * *" ``` ## Snapshot Schedules @@ -108,7 +108,7 @@ Fix Inventory allows you to set up automated snapshots. You can specify the numb Execute the following command in [Fix Inventory Shell](../components/shell.mdx) to open the relevant configuration for editing: ```bash -> config edit fixinventory.core.snapshots +> config edit fix.core.snapshots ``` Here's an example of a snapshot schedule configuration: diff --git a/docs/reference/configuration/index.mdx b/docs/reference/configuration/index.mdx index fd4f93b2..b6072901 100644 --- a/docs/reference/configuration/index.mdx +++ b/docs/reference/configuration/index.mdx @@ -22,17 +22,17 @@ Be sure to adjust the above PSK and Fix Inventory Core URI arguments to reflect Fix Inventory automatically creates the following configurations by default: -- `fixinventory.core` -- `fixinventory.core.commands` -- `fixinventory.worker` -- `fixinventory.metrics` +- `fix.core` +- `fix.core.commands` +- `fix.worker` +- `fix.metrics` ### Editing Configuration ```bash title="Edit the Fix Inventory Worker configuration" -> config edit fixinventory.worker +> config edit fix.worker ``` Upon execution of the above command, [Fix Inventory Shell](../components/shell.mdx) presents the specified configuration in [YAML format](https://yaml.org) using the local text editor as defined by the [`EDITOR` environment variable](#text-editor). @@ -87,7 +87,7 @@ This means that you will get an error if, for instance, you attempt to set the v Instead of editing a component's configuration in a text editor, it is also possible to set the values of specific properties using the [`config set` command](../cli/config/set.mdx). ```title="Modify a specific property of the Fix Inventory Worker configuration" -> config set fixinventory.worker fixworker.pool_size=5 +> config set fix.worker fixworker.pool_size=5 ``` ### Overriding Individual Properties @@ -143,7 +143,7 @@ or Default configurations can be restored simply by deleting the configuration and restarting the component. ```bash title="Delete the Fix Inventory Worker configuration" -> config delete fixinventory.worker +> config delete fix.worker ``` ```bash title="Restart Fix Inventory Worker" diff --git a/docs/reference/events/index.mdx b/docs/reference/events/index.mdx index 96003fb3..af8a7843 100644 --- a/docs/reference/events/index.mdx +++ b/docs/reference/events/index.mdx @@ -33,7 +33,7 @@ During the `cleanup_plan` phase, Fix Inventory computes which resources should b :::note -Fix Inventory ships with [built-in cleanup plugins](../components/plugins/index.mdx) that can be enabled in the `fixinventory.worker` configuration. +Fix Inventory ships with [built-in cleanup plugins](../components/plugins/index.mdx) that can be enabled in the `fix.worker` configuration. ::: diff --git a/docs/reference/workflows/index.mdx b/docs/reference/workflows/index.mdx index c00fdb2c..1fab945b 100644 --- a/docs/reference/workflows/index.mdx +++ b/docs/reference/workflows/index.mdx @@ -38,7 +38,7 @@ During the `cleanup_plan` phase, Fix Inventory computes which resources should b :::tip -Fix Inventory ships with built-in cleanup [plugins](../components/plugins/index.mdx) that can be enabled in the `fixinventory.worker` configuration. +Fix Inventory ships with built-in cleanup [plugins](../components/plugins/index.mdx) that can be enabled in the `fix.worker` configuration. ::: diff --git a/versioned_docs/version-4.X/concepts/resource-management/cleanup.mdx b/versioned_docs/version-4.X/concepts/resource-management/cleanup.mdx index 00128e91..5676bf34 100644 --- a/versioned_docs/version-4.X/concepts/resource-management/cleanup.mdx +++ b/versioned_docs/version-4.X/concepts/resource-management/cleanup.mdx @@ -71,7 +71,7 @@ Resources can only be cleaned up if they are not [protected](./protection.mdx). To enable cleanup, execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash -> config edit fixinventory.worker +> config edit fix.worker ``` Then, modify the `fixworker` section of the configuration as follows: diff --git a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-cloudwatch-alarms.mdx b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-cloudwatch-alarms.mdx index 7bb84c6d..6dea7314 100644 --- a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-cloudwatch-alarms.mdx +++ b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-cloudwatch-alarms.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-ebs-volumes.mdx b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-ebs-volumes.mdx index 99680996..deb85584 100644 --- a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-ebs-volumes.mdx +++ b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-ebs-volumes.mdx @@ -15,7 +15,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-iam-access-keys.mdx b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-iam-access-keys.mdx index 680e0283..322dabda 100644 --- a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-iam-access-keys.mdx +++ b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-iam-access-keys.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-load-balancers.mdx b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-load-balancers.mdx index b6668bfd..efac9945 100644 --- a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-load-balancers.mdx +++ b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-load-balancers.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-vpc-resources.mdx b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-vpc-resources.mdx index cec39e53..c9f7404d 100644 --- a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-vpc-resources.mdx +++ b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-aws-vpc-resources.mdx @@ -29,7 +29,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-expired-resources.mdx b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-expired-resources.mdx index d1a007cf..a89de0bc 100644 --- a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-expired-resources.mdx +++ b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-expired-resources.mdx @@ -18,7 +18,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-untagged-resources.mdx b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-untagged-resources.mdx index cb7c4e04..00d2b6df 100644 --- a/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-untagged-resources.mdx +++ b/versioned_docs/version-4.X/how-to-guides/cleanup/clean-up-untagged-resources.mdx @@ -18,7 +18,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Execute the following command in [Fix Inventory Shell](../../reference/components/shell.mdx) to open the [Fix Inventory Worker](../../reference/components/worker.mdx) configuration for editing: ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Enable cleanup by modifying the `fixworker` section of the configuration as follows: diff --git a/versioned_docs/version-4.X/how-to-guides/data-sources/collect-aws-resource-data.mdx b/versioned_docs/version-4.X/how-to-guides/data-sources/collect-aws-resource-data.mdx index 5048faec..7ffabc6d 100644 --- a/versioned_docs/version-4.X/how-to-guides/data-sources/collect-aws-resource-data.mdx +++ b/versioned_docs/version-4.X/how-to-guides/data-sources/collect-aws-resource-data.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Add `aws` to the list of collectors by modifying the configuration as follows: @@ -47,7 +47,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 2. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 3. Add the contents of your `credentials` file to the `fixworker` section of the configuration as follows: @@ -109,7 +109,7 @@ Access keys in the configuration are visible to anyone with access to your Fix I 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Modify the `aws` section of the configuration as follows: @@ -149,7 +149,7 @@ Access keys in the configuration are visible to anyone with access to your Fix I 2. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 3. Add the contents of your `credentials` file to the `fixworker` section of the configuration as follows: @@ -256,7 +256,7 @@ You can specify a profile using `AWS_PROFILE` and, for local testing, SSO authen 2. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 3. Modify the `aws` section of the configuration as follows, making sure that `aws.access_key_id` and `aws.secret_access_key` are set to `null`: diff --git a/versioned_docs/version-4.X/how-to-guides/data-sources/collect-digitalocean-resource-data.mdx b/versioned_docs/version-4.X/how-to-guides/data-sources/collect-digitalocean-resource-data.mdx index 9f9556a8..438216c3 100644 --- a/versioned_docs/version-4.X/how-to-guides/data-sources/collect-digitalocean-resource-data.mdx +++ b/versioned_docs/version-4.X/how-to-guides/data-sources/collect-digitalocean-resource-data.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Add `digitalocean` to the list of collectors by modifying the configuration as follows: @@ -43,7 +43,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Modify the `digitalocean` section of the configuration as follows, adding your API tokens and/or access keys: diff --git a/versioned_docs/version-4.X/how-to-guides/data-sources/collect-google-cloud-resource-data.mdx b/versioned_docs/version-4.X/how-to-guides/data-sources/collect-google-cloud-resource-data.mdx index d9be3b2b..322771d0 100644 --- a/versioned_docs/version-4.X/how-to-guides/data-sources/collect-google-cloud-resource-data.mdx +++ b/versioned_docs/version-4.X/how-to-guides/data-sources/collect-google-cloud-resource-data.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Add `gcp` to the list of collectors by modifying the configuration as follows: @@ -43,7 +43,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash -> config edit fixinventory.worker +> config edit fix.worker ``` 2. Add the contents of your service account JSON file(s) to the `fixworker` section of the configuration as follows: @@ -119,7 +119,7 @@ You can specify an empty string for the service account file, and Fix Inventory 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Modify the `gcp` section of the configuration as follows: diff --git a/versioned_docs/version-4.X/how-to-guides/data-sources/collect-kubernetes-resource-data.mdx b/versioned_docs/version-4.X/how-to-guides/data-sources/collect-kubernetes-resource-data.mdx index ea68549f..07df845a 100644 --- a/versioned_docs/version-4.X/how-to-guides/data-sources/collect-kubernetes-resource-data.mdx +++ b/versioned_docs/version-4.X/how-to-guides/data-sources/collect-kubernetes-resource-data.mdx @@ -17,7 +17,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Add `k8s` to the list of collectors by modifying the configuration as follows: @@ -45,7 +45,7 @@ This guide assumes that you have already [installed](../../getting-started/insta 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Add the content of kubeconfig file(s) to the `fixworker` section as follows: @@ -139,7 +139,7 @@ The required values can be found in the [kubeconfig file](https://kubernetes.io/ 1. Open the [Fix Inventory Worker configuration](../../reference/configuration/index.mdx) via the [`config` command](../../reference/cli/config) in [Fix Inventory Shell](../../reference/components/shell): ```bash - > config edit fixinventory.worker + > config edit fix.worker ``` 2. Modify the `k8s` section of the configuration as follows: diff --git a/versioned_docs/version-4.X/reference/cli/config/list.mdx b/versioned_docs/version-4.X/reference/cli/config/list.mdx index a546ffb6..4978731c 100644 --- a/versioned_docs/version-4.X/reference/cli/config/list.mdx +++ b/versioned_docs/version-4.X/reference/cli/config/list.mdx @@ -18,9 +18,9 @@ config list ```bash > configs list # highlight-start -​fixinventory.core -​fixinventory.worker.1 -​fixinventory.worker.2 -​fixinventory.metrics +​fix.core +​fix.worker.1 +​fix.worker.2 +​fix.metrics # highlight-end ``` diff --git a/versioned_docs/version-4.X/reference/cli/config/show.mdx b/versioned_docs/version-4.X/reference/cli/config/show.mdx index b40471ee..e9b52935 100644 --- a/versioned_docs/version-4.X/reference/cli/config/show.mdx +++ b/versioned_docs/version-4.X/reference/cli/config/show.mdx @@ -22,7 +22,7 @@ config show ## Examples ```bash -> configs show fixinventory.core +> configs show fix.core ​fixcore: ​ # API related properties. ​ api: diff --git a/versioned_docs/version-4.X/reference/cli/index.mdx b/versioned_docs/version-4.X/reference/cli/index.mdx index 800e0830..06ff018d 100644 --- a/versioned_docs/version-4.X/reference/cli/index.mdx +++ b/versioned_docs/version-4.X/reference/cli/index.mdx @@ -77,7 +77,7 @@ You can pipe commands using `|` and chain commands using `;`. It is possible to create your own commands by combining existing commands with your own logic. -In [Fix Inventory Shell](../components/shell.mdx), type `config edit fixinventory.core.commands`. This will open a file and show all available custom commands. +In [Fix Inventory Shell](../components/shell.mdx), type `config edit fix.core.commands`. This will open a file and show all available custom commands. ### Custom Command Properties @@ -104,7 +104,7 @@ parameters: template: 'echo Hello {{person}}.' ``` -Once a custom command has been defined in the `fixinventory.core.commands` configuration, the command can be executed in [Fix Inventory Shell](../components/shell.mdx): +Once a custom command has been defined in the `fix.core.commands` configuration, the command can be executed in [Fix Inventory Shell](../components/shell.mdx): ```bash title="Usage of the new hello command" > help hello diff --git a/versioned_docs/version-4.X/reference/components/metrics.mdx b/versioned_docs/version-4.X/reference/components/metrics.mdx index fd5817bd..c22bbb44 100644 --- a/versioned_docs/version-4.X/reference/components/metrics.mdx +++ b/versioned_docs/version-4.X/reference/components/metrics.mdx @@ -30,7 +30,7 @@ scrape_configs: | Option | Description | Default | | ---------------------------------------------------- | ------------------------------------ | ------------------------ | -| `--subscriber-id ` | Unique subscriber ID | `fixinventory.worker` | +| `--subscriber-id ` | Unique subscriber ID | `fix.worker` | | `--psk ` | Pre-shared key | | | `--verbose`, `-v` | Verbose logging | | | `--quiet` | Only log errors | | diff --git a/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_alarms.mdx b/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_alarms.mdx index 64e759a8..0e592a90 100644 --- a/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_alarms.mdx +++ b/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_alarms.mdx @@ -15,7 +15,7 @@ The following resources are currently being marked for cleanup In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_loadbalancers.mdx b/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_loadbalancers.mdx index 5629b8a4..cdeab518 100644 --- a/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_loadbalancers.mdx +++ b/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_loadbalancers.mdx @@ -11,7 +11,7 @@ This plugin cleans up AWS ALB/ELB load balancers with no instances attached to t In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_vpcs.mdx b/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_vpcs.mdx index c02d2ae8..6a7ed7bd 100644 --- a/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_vpcs.mdx +++ b/versioned_docs/version-4.X/reference/components/plugins/cleanup_aws_vpcs.mdx @@ -25,7 +25,7 @@ The following resources are currently being marked for cleanup In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/versioned_docs/version-4.X/reference/components/plugins/cleanup_expired.mdx b/versioned_docs/version-4.X/reference/components/plugins/cleanup_expired.mdx index 8da12104..479b40f2 100644 --- a/versioned_docs/version-4.X/reference/components/plugins/cleanup_expired.mdx +++ b/versioned_docs/version-4.X/reference/components/plugins/cleanup_expired.mdx @@ -30,7 +30,7 @@ Each of them can be abbreviated down to one letter. E.g. `7d`, `24h`, `60m`, etc In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/versioned_docs/version-4.X/reference/components/plugins/cleanup_untagged.mdx b/versioned_docs/version-4.X/reference/components/plugins/cleanup_untagged.mdx index c8695f21..69342544 100644 --- a/versioned_docs/version-4.X/reference/components/plugins/cleanup_untagged.mdx +++ b/versioned_docs/version-4.X/reference/components/plugins/cleanup_untagged.mdx @@ -11,7 +11,7 @@ This plugin deletes cloud resources that are missing mandatory tags after a cert In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/versioned_docs/version-4.X/reference/components/plugins/cleanup_volumes.mdx b/versioned_docs/version-4.X/reference/components/plugins/cleanup_volumes.mdx index d26b2395..432f4f98 100644 --- a/versioned_docs/version-4.X/reference/components/plugins/cleanup_volumes.mdx +++ b/versioned_docs/version-4.X/reference/components/plugins/cleanup_volumes.mdx @@ -11,7 +11,7 @@ This plugin cleans up unused storage volumes. In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/versioned_docs/version-4.X/reference/components/plugins/index.mdx b/versioned_docs/version-4.X/reference/components/plugins/index.mdx index d74bc74d..54184f4f 100644 --- a/versioned_docs/version-4.X/reference/components/plugins/index.mdx +++ b/versioned_docs/version-4.X/reference/components/plugins/index.mdx @@ -1,5 +1,5 @@ # Plugins -Plugins can be used to perform actions whenever something happens within Fix Inventory. Cleanup plugins for instance exist for automated cleanup that is more complex than what a simple CLI search can do. Plugins are loaded by [Fix Inventory Worker](../worker.mdx) and often come with their own configuration. Enable or configure them using the [`config edit fixinventory.worker`](../../../reference/cli/config/edit.mdx) command. +Plugins can be used to perform actions whenever something happens within Fix Inventory. Cleanup plugins for instance exist for automated cleanup that is more complex than what a simple CLI search can do. Plugins are loaded by [Fix Inventory Worker](../worker.mdx) and often come with their own configuration. Enable or configure them using the [`config edit fix.worker`](../../../reference/cli/config/edit.mdx) command. diff --git a/versioned_docs/version-4.X/reference/components/plugins/protector.mdx b/versioned_docs/version-4.X/reference/components/plugins/protector.mdx index 547f0943..39379c60 100644 --- a/versioned_docs/version-4.X/reference/components/plugins/protector.mdx +++ b/versioned_docs/version-4.X/reference/components/plugins/protector.mdx @@ -11,7 +11,7 @@ This plugin protects important resources from deletion by Fix Inventory. In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/versioned_docs/version-4.X/reference/components/plugins/tagvalidator.mdx b/versioned_docs/version-4.X/reference/components/plugins/tagvalidator.mdx index 5b614328..717e47a0 100644 --- a/versioned_docs/version-4.X/reference/components/plugins/tagvalidator.mdx +++ b/versioned_docs/version-4.X/reference/components/plugins/tagvalidator.mdx @@ -11,7 +11,7 @@ This plugin validates the contents of expiration tags. With it you can enforce a In `fixsh` execute ``` -> config edit fixinventory.worker +> config edit fix.worker ``` and find the following section diff --git a/versioned_docs/version-4.X/reference/components/worker.mdx b/versioned_docs/version-4.X/reference/components/worker.mdx index 42652a34..b3e6935b 100644 --- a/versioned_docs/version-4.X/reference/components/worker.mdx +++ b/versioned_docs/version-4.X/reference/components/worker.mdx @@ -25,7 +25,7 @@ somecr.io/someengineering/fixinventoryworker:{{imageTag}} | Option | Description | Default | | ---------------------------------------------------- | ------------------------------------ | ------------------------ | -| `--subscriber-id ` | Unique subscriber ID | `fixinventory.worker` | +| `--subscriber-id ` | Unique subscriber ID | `fix.worker` | | `--psk ` | Pre-shared key | | | `--verbose`, `-v` | Verbose logging | | | `--quiet` | Only log errors | | diff --git a/versioned_docs/version-4.X/reference/configuration/core.mdx b/versioned_docs/version-4.X/reference/configuration/core.mdx index cf80c91f..d512ef49 100644 --- a/versioned_docs/version-4.X/reference/configuration/core.mdx +++ b/versioned_docs/version-4.X/reference/configuration/core.mdx @@ -6,12 +6,12 @@ sidebar_label: Core ## Network Interfaces -For security reasons, [Fix Inventory Core](../components/core.mdx) only listens on the loopback interface by default. This can be changed via the `fixcore.api.web_hosts` option in the `fixinventory.core` configuration. +For security reasons, [Fix Inventory Core](../components/core.mdx) only listens on the loopback interface by default. This can be changed via the `fixcore.api.web_hosts` option in the `fix.core` configuration. Execute the following command in [Fix Inventory Shell](../components/shell.mdx) to open the relevant configuration for editing: ```bash -> config edit fixinventory.core +> config edit fix.core ``` ```yaml title="Configuration to listen on all IPv6 and IPv4 interfaces" @@ -34,17 +34,17 @@ fixcore: Alternatively, you can use the [`config set` command](../cli/config/set.mdx): ```bash -> config set fixinventory.core fixcore.api.web_hosts=["::", "0.0.0.0"] +> config set fix.core fixcore.api.web_hosts=["::", "0.0.0.0"] ``` ## TLS Certificate -Fix Inventory attempts to find all local IP addresses and hostnames and add them to the subject alternative names (SAN) list of the x509 certificate. If your system has additional DNS names, you can add them to the SAN list via the `fixcore.api.host_certificate.san_dns_names` option in the `fixinventory.core` configuration. +Fix Inventory attempts to find all local IP addresses and hostnames and add them to the subject alternative names (SAN) list of the x509 certificate. If your system has additional DNS names, you can add them to the SAN list via the `fixcore.api.host_certificate.san_dns_names` option in the `fix.core` configuration. Execute the following command in [Fix Inventory Shell](../components/shell.mdx) to open the relevant configuration for editing: ```bash -> config edit fixinventory.core +> config edit fix.core ``` ```yaml title="Configuration with additional DNS names on SAN list" @@ -78,7 +78,7 @@ By default, the [`collect_and_cleanup` workflow](../../reference/workflows/index Execute the following command in [Fix Inventory Shell](../components/shell.mdx) to open the relevant configuration for editing: ```bash -> config edit fixinventory.core +> config edit fix.core ``` ```yaml @@ -98,7 +98,7 @@ fixcore: Alternatively, you can use the [`config set` command](../cli/config/set.mdx): ```bash title="Configure the collect_and_cleanup workflow to run twice per hour" -> config set fixinventory.core fixcore.workflows.collect_and_cleanup.schedule="0,30 * * * *" +> config set fix.core fixcore.workflows.collect_and_cleanup.schedule="0,30 * * * *" ``` ## Snapshot Schedules @@ -108,7 +108,7 @@ Fix Inventory allows you to set up automated snapshots. You can specify the numb Execute the following command in [Fix Inventory Shell](../components/shell.mdx) to open the relevant configuration for editing: ```bash -> config edit fixinventory.core.snapshots +> config edit fix.core.snapshots ``` Here's an example of a snapshot schedule configuration: diff --git a/versioned_docs/version-4.X/reference/configuration/index.mdx b/versioned_docs/version-4.X/reference/configuration/index.mdx index fd4f93b2..b6072901 100644 --- a/versioned_docs/version-4.X/reference/configuration/index.mdx +++ b/versioned_docs/version-4.X/reference/configuration/index.mdx @@ -22,17 +22,17 @@ Be sure to adjust the above PSK and Fix Inventory Core URI arguments to reflect Fix Inventory automatically creates the following configurations by default: -- `fixinventory.core` -- `fixinventory.core.commands` -- `fixinventory.worker` -- `fixinventory.metrics` +- `fix.core` +- `fix.core.commands` +- `fix.worker` +- `fix.metrics` ### Editing Configuration ```bash title="Edit the Fix Inventory Worker configuration" -> config edit fixinventory.worker +> config edit fix.worker ``` Upon execution of the above command, [Fix Inventory Shell](../components/shell.mdx) presents the specified configuration in [YAML format](https://yaml.org) using the local text editor as defined by the [`EDITOR` environment variable](#text-editor). @@ -87,7 +87,7 @@ This means that you will get an error if, for instance, you attempt to set the v Instead of editing a component's configuration in a text editor, it is also possible to set the values of specific properties using the [`config set` command](../cli/config/set.mdx). ```title="Modify a specific property of the Fix Inventory Worker configuration" -> config set fixinventory.worker fixworker.pool_size=5 +> config set fix.worker fixworker.pool_size=5 ``` ### Overriding Individual Properties @@ -143,7 +143,7 @@ or Default configurations can be restored simply by deleting the configuration and restarting the component. ```bash title="Delete the Fix Inventory Worker configuration" -> config delete fixinventory.worker +> config delete fix.worker ``` ```bash title="Restart Fix Inventory Worker" diff --git a/versioned_docs/version-4.X/reference/events/index.mdx b/versioned_docs/version-4.X/reference/events/index.mdx index 96003fb3..af8a7843 100644 --- a/versioned_docs/version-4.X/reference/events/index.mdx +++ b/versioned_docs/version-4.X/reference/events/index.mdx @@ -33,7 +33,7 @@ During the `cleanup_plan` phase, Fix Inventory computes which resources should b :::note -Fix Inventory ships with [built-in cleanup plugins](../components/plugins/index.mdx) that can be enabled in the `fixinventory.worker` configuration. +Fix Inventory ships with [built-in cleanup plugins](../components/plugins/index.mdx) that can be enabled in the `fix.worker` configuration. ::: diff --git a/versioned_docs/version-4.X/reference/workflows/index.mdx b/versioned_docs/version-4.X/reference/workflows/index.mdx index c00fdb2c..1fab945b 100644 --- a/versioned_docs/version-4.X/reference/workflows/index.mdx +++ b/versioned_docs/version-4.X/reference/workflows/index.mdx @@ -38,7 +38,7 @@ During the `cleanup_plan` phase, Fix Inventory computes which resources should b :::tip -Fix Inventory ships with built-in cleanup [plugins](../components/plugins/index.mdx) that can be enabled in the `fixinventory.worker` configuration. +Fix Inventory ships with built-in cleanup [plugins](../components/plugins/index.mdx) that can be enabled in the `fix.worker` configuration. :::