Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fixinventory -> fix #9

Merged
merged 3 commits into from
Feb 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/concepts/resource-management/cleanup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ You will also need a valid routing key for your [PagerDuty](https://pagerduty.co

:::

3. Open the `fixinventory.core.commands` configuration:
3. Open the `fix.core.commands` configuration:

```bash
> config edit fixinventory.core.commands
> config edit fix.core.commands
```

4. Add the routing key copied in step 2 as the default value of the `routing_key` parameter in the `pagerduty` section. This will allow you to execute the `pagerduty` command without specifying the routing key parameter each time.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ You will also need the **Manage Webhooks** permission for the target text channe
A default webhook URL can be defined in the `discord` app configuration so that you can simply execute `discord --title="..."`:

```bash
> config edit fixinventory.apps.discord
> config edit fix.apps.discord
```

:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ You will also need a running installation of [Alertmanager](https://prometheus.i

## Directions

1. Open the `fixinventory.core.commands` configuration by executing the following command in [Fix Inventory Shell](../../../reference/components/shell.mdx):
1. Open the `fix.core.commands` configuration by executing the following command in [Fix Inventory Shell](../../../reference/components/shell.mdx):

```bash
> config edit fixinventory.core.commands
> config edit fix.core.commands
```

2. Add the following command definition to the configuration, replacing `http://localhost:9093` with the URL of your [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager) instance:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ This guide assumes that you have already [installed](../../../getting-started/in
A default webhook URL can be defined in the `slack` app configuration so that you can simply execute `slack --title="..."`:

```bash
> config edit fixinventory.apps.slack
> config edit fix.apps.slack
```

:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-guides/cleanup/clean-up-aws-ebs-volumes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 5 additions & 5 deletions docs/how-to-guides/data-sources/collect-aws-resource-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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`:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ This guide assumes that you have already [installed](../../getting-started/insta

By default, Fix Inventory passes the app a configuration that corresponds to the app name.

For example, when installing an app named `foobar`, Fix Inventory creates a default config named `fixinventory.apps.foobar`.
For example, when installing an app named `foobar`, Fix Inventory creates a default config named `fix.apps.foobar`.

If you would like to run the app with an alternative config, you can specify the config name using the `--config` argument.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/app/run.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ app run <app_name> [--dry-run] [--config <config_name>]

\* When using the `--dry-run` argument, the app will not be executed but the commands will be printed to the terminal.

\*\* By default, Fix Inventory passes the app a configuration that corresponds to the app name. (For example, when installing an app named `foobar`, Fix Inventory creates a default config named `fixinventory.apps.foobar`.) If you would like to run the app with an alternative config, you can specify the config name using the `--config` argument.
\*\* By default, Fix Inventory passes the app a configuration that corresponds to the app name. (For example, when installing an app named `foobar`, Fix Inventory creates a default config named `fix.apps.foobar`.) If you would like to run the app with an alternative config, you can specify the config name using the `--config` argument.

## Example

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/cli/config/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
2 changes: 1 addition & 1 deletion docs/reference/cli/config/show.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ config show <id>
## Examples

```bash
> configs show fixinventory.core
> configs show fix.core
​fixcore:
​ # API related properties.
​ api:
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/components/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 | |
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/components/plugins/cleanup_aws_alarms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/components/plugins/cleanup_aws_vpcs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/components/plugins/cleanup_expired.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/components/plugins/cleanup_untagged.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/components/plugins/cleanup_volumes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/components/plugins/index.mdx
Original file line number Diff line number Diff line change
@@ -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 />
2 changes: 1 addition & 1 deletion docs/reference/components/plugins/protector.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/components/plugins/tagvalidator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/components/worker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 | |
Expand Down
Loading