🚀 SysOperator 项目
SysOperator 是一款功能强大的工具，它能有效简化 Ansible、Terraform 以及其他基础设施管理任务的操作流程，让相关工作变得更加轻松高效。
🚀 快速开始
SysOperator 可帮助你轻松完成 Ansible、Terraform 等基础设施管理任务。下面将为你介绍其安装、配置和使用方法。
✨ 主要特性
- Ansible Playbook 执行：支持执行任意 Ansible Playbook 文件，允许通过
--extra-vars参数传递额外变量，还能指定具体执行的--tags或跳过特定--skip-tags。 - Terraform 操作：提供
init、plan和apply三种操作模式，支持自动审批 (--autoApprove) 以实现 CI/CD 流水线集成，配合--useLocalstack参数，可无缝衔接 LocalStack 环境进行测试。 - AWS 操作：原生支持 AWS 服务调用，包括但不限于 EC2、S3 等资源操作，支持通过
--region参数指定操作区域，结合 LocalStack 使用，可以模拟真实 AWS 环境而不产生实际成本。
📦 安装指南
方法一：通过 npm 安装
你可以使用 npm 来全局安装 SysOperator：
npm install -g sysoperator
方法二：本地运行
如果你不想使用 npm，可以直接从项目仓库下载源代码并进行本地构建：
git clone https://github.com/your-repository/sysoperator.git
cd sysoperator
npm install
npm run build
💻 使用示例
基础用法
快速开始：运行样例 playbook
node localstack/sample_playbook.mjs
高级用法
Ansible Playbook 执行
sysoperator ansible-playbook \
--playbook "/path/to/playbook.yml" \
[--extra-vars "var1=value1 var2=value2"] \
[--tags "tag1,tag2"] \
[--skip-tags "skip_tag"]
Terraform 操作
sysoperator terraform \
--action "init|plan|apply" \
--workingDir "/path/to/terraform/project" \
[--autoApprove true|false] \
[--useLocalstack true|false] \
[--vars "key1=value1 key2=value2"]
AWS 操作
sysoperator aws \
--command "describe-instances|launch-instance" \
--region "us-west-2" \
[--useLocalstack true|false]
📚 详细文档
项目架构
sysoperator/
├── src/
│ ├── index.ts # 入口文件
│ └── ansible-mcp-server/ # 当前版本中暂用此命名，后续将改为 sysoperator/
│ ├── index.ts # SysOperator 核心实现
│ ├── common/ # 公共模块
│ │ ├── errors.ts # 错误处理
│ │ └── version.ts # 版本信息
│ └── handlers/ # 操作处理器
│ ├── ansible_handler.ts # Ansible 处理逻辑
│ ├── terraform_handler.ts # Terraform 处理逻辑
│ └── aws_handler.ts # AWS 操作处理逻辑
└── localstack/ # LocalStack 集成模块
└── integration.ts # LocalStack 环境集成实现
本地运行示例
启动 LocalStack 并执行 playbook
# 启动 LocalStack
localstack start --exclude docker,ecs,lambda
# 执行 playbook
sysoperator ansible-playbook \
--playbook localstack/sample_playbook.yml \
--extra-vars "aws_access_key_id=your_key_id aws_secret_access_key=your_secret" \
--tags "setup_ec2"
注意事项与限制
- 项目目前处于开发阶段，尚未完全成熟。
- 不建议在生产环境中直接使用未经测试的版本。
- 对于复杂场景，可能需要额外的配置和错误处理。
错误处理
SysOperator 提供了详细的错误日志输出机制，用户可以通过以下方式获取更多信息：
sysoperator --help
版本信息
当前版本：v1.0.0-rc1
项目仓库
免责声明
此工具目前仍处于开发阶段，可能存在不稳定性和潜在风险。在生产环境中使用前，请务必进行全面的测试和验证。
📄 许可证
<此处应放置具体的许可证内容>