Local KMS 模拟器安装与使用教程

1. 项目目录结构及介绍

在本地克隆 local-kms 项目后，您将看到以下基本目录结构：

.
├── cmd                    # 包含主程序的启动文件
│   └── local-kms          # 主服务的Go代码
├── config                 # 配置文件模板
│   └── config.yaml.example
├── internal               # 内部库和工具代码
├── testdata               # 测试数据
└── README.md              # 项目说明文档

• cmd/local-kms: 该项目的主程序入口点，用于启动模拟的 AWS KMS 服务。
• config/config.yaml.example: 示例配置文件，供参考和自定义设置。
• internal: 包含内部实现的服务组件和其他辅助工具。

2. 项目启动文件介绍

启动文件位于 cmd/local-kms/main.go。这个文件包含了初始化和运行 Local KMS 服务器的主要逻辑。要启动服务，通常不需要直接执行此文件，而是通过构建并运行可执行文件完成。以下是构建和启动 Local KMS 的步骤：

1. 确保已经安装了 Go 语言环境（测试时推荐版本 1.17 或以上）。
2. 克隆仓库到本地：git clone https://github.com/nsmithuk/local-kms.git
3. 进入项目目录：cd local-kms
4. 构建项目：go build ./cmd/local-kms
5. 运行 Local KMS 服务：./local-kms （或根据您的系统路径执行相应的二进制文件）

默认情况下，服务将在 localhost:4566 上运行，可以使用配置文件调整端口或其他参数。

3. 项目配置文件介绍

配置文件的默认路径是 config/config.yaml。您可以基于提供的示例文件 config/config.yaml.example 创建一个自己的配置文件。

以下是 config.yaml.example 中的一些关键配置项及其作用：

port: 4566       # 监听的TCP端口号，默认值为4566
authKey: "test"       # 默认的认证密钥
secretKey: "testing"   # 默认的密钥
region: "us-east-1"      # 默认的AWS区域
iamRoleForServiceAccounts: "localstack" # IAM角色名称，用于LocalStack中的服务账户
kmsAccountIds: ["123456789012"]    # 授权访问KMS的AWS账户ID列表
logLevel: "info"     # 日志级别，如debug、info、warn、error等

要使用配置文件启动 Local KMS，确保在运行命令时指定文件位置，例如：

./local-kms -c path/to/your/config.yaml

请注意，如果您使用的是 Docker 容器，可能还需要处理网络访问权限和卷挂载以允许 Local KMS 访问配置文件。

以上就是 Local KMS 的基本安装和使用教程。通过这个模拟器，开发和测试环境中可以方便地模拟 AWS KMS 的功能，而无需依赖真实的 AWS 资源。祝您使用愉快！