Fix Inventory 项目安装与使用指南

Fix Inventory 项目安装与使用指南

fixinventory Fix Inventory consolidates user, resource, and configuration data from your cloud environments into a unified, graph-based asset inventory. 项目地址: https://gitcode.com/gh_mirrors/fi/fixinventory

1. 项目目录结构及介绍

Fix Inventory 项目的目录结构如下：

fixinventory/
├── contrib/
│   └── grafana-dashboards/
├── docker/
├── dockerV2/
├── fixcore/
├── fixlib/
├── fixmetrics/
├── fixshell/
├── fixworker/
├── misc/
├── plugins/
├── tools/
├── .dockerignore
├── .editorconfig
├── .gitignore
├── .imgbotconfig
├── .pylintrc
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── SECURITY.md
├── bump.sh
├── codecov.yml
├── docker-compose.yaml
├── requirements-all.txt
├── requirements-extra.txt
├── requirements.txt
└── setup_venv.sh

目录介绍

• contrib/: 包含与 Grafana 相关的仪表盘配置文件。
• docker/ 和 dockerV2/: 包含 Docker 相关的配置和脚本。
• fixcore/: 核心平台，维护 MultiDiGraph。
• fixlib/: 包含 Fix Inventory 的库文件。
• fixmetrics/: Prometheus 导出器。
• fixshell/: Fix Inventory 的 shell 交互工具。
• fixworker/: 提供加载插件的 worker，执行收集和清理操作。
• misc/: 杂项文件。
• plugins/: 包含各种插件，如 AWS、Google Cloud 等。
• tools/: 工具脚本。
• .dockerignore: Docker 忽略文件。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件。
• .imgbotconfig: ImgBot 配置文件。
• .pylintrc: Pylint 配置文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证。
• Makefile: 项目构建文件。
• README.md: 项目说明文档。
• SECURITY.md: 安全相关文档。
• bump.sh: 版本更新脚本。
• codecov.yml: Codecov 配置文件。
• docker-compose.yaml: Docker Compose 配置文件。
• requirements-all.txt: 所有依赖包列表。
• requirements-extra.txt: 额外依赖包列表。
• requirements.txt: 主要依赖包列表。
• setup_venv.sh: 虚拟环境设置脚本。

2. 项目启动文件介绍

Fix Inventory 项目的启动文件主要集中在 fixcore/ 和 fixshell/ 目录中。以下是主要的启动文件：

• fixcore/main.py: 核心平台的启动文件，负责初始化和运行 Fix Inventory 的核心服务。
• fixshell/main.py: Fix Inventory shell 的启动文件，提供与核心平台的交互接口。

启动步骤

1. 进入项目根目录。
2. 运行 python fixcore/main.py 启动核心平台。
3. 运行 python fixshell/main.py 启动交互 shell。

3. 项目配置文件介绍

Fix Inventory 项目的配置文件主要集中在以下几个文件中：

• docker-compose.yaml: Docker Compose 配置文件，用于定义和运行多个 Docker 容器。
• requirements.txt: Python 依赖包列表，用于安装项目所需的 Python 包。
• Makefile: 项目构建文件，包含各种构建和测试命令。
• .env: 环境变量配置文件，用于设置项目的运行环境变量。

配置步骤

1. 编辑 docker-compose.yaml 文件，配置 Docker 容器的参数。
2. 编辑 requirements.txt 文件，添加或删除 Python 依赖包。
3. 编辑 Makefile 文件，配置项目的构建和测试命令。
4. 编辑 .env 文件，设置项目的运行环境变量。

通过以上步骤，您可以成功安装和配置 Fix Inventory 项目，并启动核心平台和交互 shell。

fixinventory Fix Inventory consolidates user, resource, and configuration data from your cloud environments into a unified, graph-based asset inventory. 项目地址: https://gitcode.com/gh_mirrors/fi/fixinventory