fix: fixinventory -> fix

someengineering · Feb 28, 2024 · b47abe0 · b47abe0
1 parent 534a207
commit b47abe0
Show file tree

Hide file tree

Showing 60 changed files with 112 additions and 112 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -22,7 +22,7 @@ config show <id>
 ## 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
@@ -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
@@ -30,7 +30,7 @@ scrape_configs:
 
 | Option                                               | Description                          | Default                  |
 | ---------------------------------------------------- | ------------------------------------ | ------------------------ |
-| `--subscriber-id <SUBSCRIBER_ID>`                    | Unique subscriber ID                 | `fixinventory.worker`    |
+| `--subscriber-id <SUBSCRIBER_ID>`                    | Unique subscriber ID                 | `fix.worker`             |
 | `--psk <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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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.
 
 <DocCardList />
diff --git 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
@@ -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
@@ -25,7 +25,7 @@ somecr.io/someengineering/fixinventoryworker:{{imageTag}}
 
 | Option                                               | Description                          | Default                  |
 | ---------------------------------------------------- | ------------------------------------ | ------------------------ |
-| `--subscriber-id <SUBSCRIBER_ID>`                    | Unique subscriber ID                 | `fixinventory.worker`    |
+| `--subscriber-id <SUBSCRIBER_ID>`                    | Unique subscriber ID                 | `fix.worker`             |
 | `--psk <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
@@ -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: