realestate/stackup

Stackup 镜像文档

概述

Stackup 是一个用于AWS CloudFormation的工具，提供简单的CLI（命令行界面）和Ruby API，旨在简化CloudFormation堆栈的创建、更新和管理流程。相比直接使用awscli或AWS SDK，Stackup提供了更便捷的堆栈操作方式，特别适合需要高效处理CloudFormation资源的场景。

核心功能与特性

Stackup 相比直接使用awscli或AWS SDK具有以下核心优势：

• 同步堆栈变更处理：将堆栈变更（创建、更新等）视为同步操作，流式传输堆栈事件，直至堆栈达到稳定状态，便于实时监控操作进度。

• 简化的创建/更新流程：通过 Stack#up 外观方法统一处理堆栈的创建与更新操作，无需手动判断目标堆栈是否已存在，降低使用复杂度。

• 幂等性操作支持：变更操作（大部分场景下）具备幂等性，对于无实际效果的操作（如删除不存在的堆栈、执行无模板变更的更新等），会被优雅处理，不会返回错误。

使用场景

Stackup 适用于以下场景：

• CloudFormation堆栈自动化管理：在开发或运维工作流中，需要通过脚本或程序自动化创建、更新CloudFormation堆栈的场景。

• 同步监控堆栈状态：需要实时跟踪堆栈变更过程，确保操作完成后再进行后续步骤的场景（如CI/CD流水线中部署依赖堆栈资源）。

• 幂等操作需求：需要确保重复执行相同操作不会导致错误或非预期结果的场景（如定时任务中的堆栈检查与更新）。

使用方法

基本使用方式

CLI 使用

通过命令行界面操作CloudFormation堆栈，核心命令示例：

bash
# 创建或更新堆栈（无需判断堆栈是否存在）
stackup my-stack up --template template.yaml

# 删除堆栈
stackup my-stack delete

# 查看堆栈事件
stackup my-stack events

Ruby API 使用

通过Ruby代码调用Stackup API操作堆栈，示例：

ruby
require 'stackup'

stack = Stackup::Stack.new('my-stack')

# 创建或更新堆栈
stack.up(template: 'template.yaml')

# 删除堆栈
stack.delete

配置说明

Stackup 依赖AWS凭证进行认证，可通过以下方式配置：

• 环境变量：设置 AWS_ACCESS_KEY_ID 和 AWS_SECRET_ACCESS_KEY
• AWS凭证文件：默认路径 ~/.aws/credentials
• IAM角色：在EC2实例或EKS Pod中使用IAM角色进行权限授予

具体配置细节可参考AWS SDK的凭证配置文档。