Skip to content

Commit

Permalink
In text: FixInventory -> Fix Inventory
Browse files Browse the repository at this point in the history
  • Loading branch information
aquamatthias committed Feb 27, 2024
1 parent 70e4295 commit 630e369
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center"><img src="https://raw.githubusercontent.com/someengineering/fixinventory/main/misc/fixinventory_200.png" alt="FixInventory"/></p>
<p align="center"><img src="https://raw.githubusercontent.com/someengineering/fixinventory/main/misc/fixinventory_200.png" alt="Fix Inventory"/></p>
<h1 align="center">Sync infrastructure data to a single place.</h1>

<p align="center"><img src="https://raw.githubusercontent.com/someengineering/fixinventory/main/misc/fixinventory_banner.png"/></p>
Expand All @@ -20,15 +20,15 @@


## Overview
🔍 Search Infrastructure: FixInventory maps out your cloud infrastructure in a [graph](https://inventory.fix.security/docs/concepts/graph) and provides a simple [search syntax](https://inventory.fix.security/docs/concepts/search).
🔍 Search Infrastructure: Fix Inventory maps out your cloud infrastructure in a [graph](https://inventory.fix.security/docs/concepts/graph) and provides a simple [search syntax](https://inventory.fix.security/docs/concepts/search).

📊 Generate Reports: FixInventory keeps track of and reports infrastructure changes over time, making it easy to [audit resource usage and cleanup](https://inventory.fix.security/docs/concepts/cloud-data-sync).
📊 Generate Reports: Fix Inventory keeps track of and reports infrastructure changes over time, making it easy to [audit resource usage and cleanup](https://inventory.fix.security/docs/concepts/cloud-data-sync).

🤖 Automate Tasks: Tedious tasks like rule enforcement, resource tagging, and cleanup can be [automated using jobs](https://inventory.fix.security/docs/concepts/automation).

![FixInventory UI Graph View](./misc/fix_graph.gif)
![Fix Inventory UI Graph View](./misc/fix_graph.gif)

Currently, FixInventory can collect [AWS](plugins/aws), [Google Cloud](plugins/gcp), [DigitalOcean](plugins/digitalocean), [VMWare Vsphere](plugins/vsphere), [OneLogin](plugins/onelogin), and [Slack](plugins/slack) resources. If the cloud you are using is not listed, it is easy to write your own collectors. An example can be found [here](plugins/example_collector).
Currently, Fix Inventory can collect [AWS](plugins/aws), [Google Cloud](plugins/gcp), [DigitalOcean](plugins/digitalocean), [VMWare Vsphere](plugins/vsphere), [OneLogin](plugins/onelogin), and [Slack](plugins/slack) resources. If the cloud you are using is not listed, it is easy to write your own collectors. An example can be found [here](plugins/example_collector).

## Getting started

Expand All @@ -37,7 +37,7 @@ Continue reading [the Quick Start Guide](https://inventory.fix.security/docs/get

# Component list
- [`fixcore`](fixcore) the platform maintaining the [MultiDiGraph](https://en.wikipedia.org/wiki/Multigraph#Directed_multigraph_(edges_with_own_identity)).
- [`fixshell`](fixshell) the FixInventory shell to interact with the core.
- [`fixshell`](fixshell) the Fix Inventory shell to interact with the core.
- [`fixworker`](fixworker) provides workers that load [plugins](plugins) to perform collect and cleanup operations.
- [`fixmetrics`](fixmetrics) is a [Prometheus](https://prometheus.io/) [exporter](https://prometheus.io/docs/instrumenting/exporters/).
- [`plugins`](plugins) are a collection of worker plugins like [AWS](plugins/aws)
Expand Down
4 changes: 2 additions & 2 deletions fixcore/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# `fixcore`
FixInventory core graph platform
Fix Inventory core graph platform


## Table of contents
Expand All @@ -11,7 +11,7 @@ FixInventory core graph platform


## Overview
The FixInventory graph platfrom `fixcore` is the persistance and search backend of fix. It maintains the graph
The Fix Inventory graph platfrom `fixcore` is the persistance and search backend of fix. It maintains the graph
of resources and provides APIs to update and access them. Within `fixcore` there are workflows consisting of steps
that result in actions like `collect`, `cleanup` or `generate_metrics`. These actions are being received by components
like [`fixworker`](../fixworker/) and [`fixmetrics`](../fixmetrics/).
Expand Down
4 changes: 2 additions & 2 deletions fixcore/fixcore/cli/command.py
Original file line number Diff line number Diff line change
Expand Up @@ -1721,7 +1721,7 @@ class JqCommand(CLICommand, OutputTransformer):
Every element from the incoming stream is passed to jq.
See: https://stedolan.github.io/jq/ for a list of possible jq filter definitions.
FixInventory will rewrite attribute paths to match the defined section.
Fix Inventory will rewrite attribute paths to match the defined section.
Example:
```bash
# the accessed path is rewritten to jq .reported.name
Expand Down Expand Up @@ -4837,7 +4837,7 @@ class CertificateCommand(CLICommand):
```
Create a new TLS key and certificate based on the internal root CA certificate.
This can be used to create a self-signed certificate for additional components that communicate with FixInventory.
This can be used to create a self-signed certificate for additional components that communicate with Fix Inventory.
## Parameters
Expand Down
2 changes: 1 addition & 1 deletion fixcore/fixcore/config/core_config_handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ async def __update_model(self) -> None:
)
await self.config_handler.put_config_validation(ConfigValidation(FixReportCheck, external_validation=True))

log.debug("FixInventory core config model updated.")
log.debug("Fix Inventory core config model updated.")
except Exception as ex:
log.error(f"Could not update fix core config model: {ex}", exc_info=ex)

Check warning on line 250 in fixcore/fixcore/config/core_config_handler.py

View check run for this annotation

Codecov / codecov/patch

fixcore/fixcore/config/core_config_handler.py#L250

Added line #L250 was not covered by tests

Expand Down
4 changes: 2 additions & 2 deletions fixcore/fixcore/db/db_access.py
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ def create_database(
log.info(
"Database is using an empty password. "
"Secure the root account with the provided user password. "
"Login to the FixInventory database via provided username and password. "
"Login to the Fix Inventory database via provided username and password. "
"Login to the System database via `root` and provided password!"
)
if not change:
Expand All @@ -251,7 +251,7 @@ def create_database(
"Database or user does not exist or does not have enough permissions. "
f"Attempt to create user/database via default system account is not possible. Reason: {ex}. "
"You can provide the password of the root user via --graphdb-root-password to setup "
"a FixInventory user and database automatically."
"a Fix Inventory user and database automatically."
)

# Only used during startup.
Expand Down
2 changes: 1 addition & 1 deletion fixcore/fixcore/model/json_schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ def json_schema(model: Model) -> Json:
return {
"$id": f"https://inventory.fix.security/schemas/{version()}/resources.json",
"$schema": "https://json-schema.org/draft/2020-12/schema", # latest draft
"title": "FixInventory Resource Model Schema",
"title": "Fix Inventory Resource Model Schema",
"oneOf": [
ref_type(model, k)
for k in kinds
Expand Down
4 changes: 2 additions & 2 deletions fixlib/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# `fixlib`
FixInventory common library
Fix Inventory common library


## Table of contents
Expand All @@ -10,7 +10,7 @@ FixInventory common library


## Overview
This is the FixInventory common library. Any functionality that is required by more than one of [our components](https://github.com/someengineering/fixinventory#component-list) will be put in here.
This is the Fix Inventory common library. Any functionality that is required by more than one of [our components](https://github.com/someengineering/fixinventory#component-list) will be put in here.

## Contact
If you have any questions feel free to [join our Discord](https://discord.gg/someengineering) or [open a GitHub issue](https://github.com/someengineering/fixinventory/issues/new).
Expand Down

0 comments on commit 630e369

Please sign in to comment.