nukengprodservice/ami-tools

Nuk Engineering Productivity ami-tools 镜像文档

概述

Nuk Engineering Productivity ami-tools 镜像（以下简称“ami-tools镜像”）是Nuk工程团队开发的生产力工具集镜像，集成了ami-tools仓库，旨在为工程团队提供一站式的工程效率提升工具。该镜像专注于提供与AMI（Amazon Machine Image）相关的工程生产力工具，支持在工程流程中对AMI进行管理、配置、部署及相关效率优化操作，适用于基于AWS环境的工程团队提升日常工作效率。

核心功能与特性

1. AMI管理工具集

• 提供AMI创建、复制、共享及生命周期管理的命令行工具
• 支持AMI版本控制与元数据管理
• 集成AMI合规性检查与安全扫描工具

2. 工程配置自动化工具

• 包含AMI配置模板生成器，支持自定义配置参数
• 提供环境变量注入与配置文件自动化生成工具
• 支持多环境（开发、测试、生产）配置隔离

3. 部署流程辅助工具

• 集成AMI部署流程脚本生成器
• 提供部署进度监控与日志收集工具
• 支持与CI/CD流程（如Jenkins、GitHub Actions）集成

4. 工程效率优化功能

• 工具集轻量化设计，启动快速，资源占用低
• 支持命令别名与快捷操作配置，减少重复操作
• 提供工具使用统计与效率分析报告功能

使用场景

1. AWS环境下的AMI管理

工程团队在AWS云环境中管理自定义AMI时，可通过该镜像快速调用ami-tools工具集，完成AMI的创建、复制、权限配置等操作，简化AMI管理流程。

2. 工程部署流程标准化

需要统一团队部署流程时，可利用镜像中的配置自动化与部署辅助工具，生成标准化的AMI部署脚本，确保不同环境下的部署一致性。

3. CI/CD流水线集成

在CI/CD流水线中集成该镜像，作为AMI相关操作的工具节点，实现从代码构建到AMI部署的全流程自动化，提升流水线运行效率。

4. 工程团队生产力提升

团队成员可通过该镜像快速获取全套ami-tools工具，无需手动配置依赖环境，降低工具使用门槛，提升团队整体工程效率。

使用方法与配置说明

前提条件

• 已安装Docker Engine（20.10+版本）
• 若需连接AWS服务，需提前配置AWS CLI凭证（或通过环境变量注入）

获取镜像

通过Docker Hub或私有仓库拉取镜像：

bash
docker pull docker.xuanyuan.run/nuk/engineering-productivity-ami-tools:latest

基本使用示例

1. 交互式运行工具集

bash
docker run -it --rm \
  -e AWS_ACCESS_KEY_ID=<your-aws-access-key> \
  -e AWS_SECRET_ACCESS_KEY=<your-aws-secret-key> \
  -e AWS_REGION=us-west-2 \
  docker.xuanyuan.run/nuk/engineering-productivity-ami-tools:latest /bin/bash

进入容器后，可直接调用ami-tools命令，例如查看工具版本：

bash
ami-tools --version

2. 执行单次AMI管理命令

bash
docker run --rm \
  -e AWS_ACCESS_KEY_ID=<your-aws-access-key> \
  -e AWS_SECRET_ACCESS_KEY=<your-aws-secret-key> \
  -e AWS_REGION=us-west-2 \
  docker.xuanyuan.run/nuk/engineering-productivity-ami-tools:latest \
  ami-tools ami list --filter "name=my-ami-*"

上述命令将列出名称匹配"my-ami-*"的AMI信息。

环境变量配置

持久化配置示例

如需持久化工具配置，可挂载本地配置目录至容器内：

bash
docker run -it --rm \
  -e AWS_ACCESS_KEY_ID=<your-aws-access-key> \
  -e AWS_SECRET_ACCESS_KEY=<your-aws-secret-key> \
  -v /local/ami-tools/config:/etc/ami-tools \
  docker.xuanyuan.run/nuk/engineering-productivity-ami-tools:latest

本地目录/local/ami-tools/config中的配置文件将覆盖容器默认配置。

注意事项

• 使用前需确保AWS凭证具有足够权限执行目标AMI操作
• 工具集版本更新可能导致配置文件格式变化，建议定期备份配置
• 生产环境使用时，建议通过私有仓库拉取指定版本镜像（如:v1.0.0），避免最新版兼容性问题