aws-cdk-github-oidc 的安装和配置教程

项目基础介绍

aws-cdk-github-oidc 是一个开源项目，它提供了一套 AWS CDK 构造，用于将 GitHub Actions 配置为 OpenID Connect 身份提供者以认证 AWS IAM。通过使用这个项目，可以有效增强 AWS 部署的安全性，避免为 GitHub Actions 创建长期访问密钥，而是使用 OpenID Connect 进行身份验证。

该项目主要使用 TypeScript 编程语言编写。

项目使用的关键技术和框架

• AWS CDK (Cloud Development Kit)：AWS Cloud Development Kit 是一个开源软件开发框架，允许开发人员使用熟悉的编程语言来定义云基础设施。
• OpenID Connect (OIDC)：一种身份验证协议，用于允许用户通过第三方服务提供商进行身份验证。
• GitHub Actions：GitHub 的持续集成和持续部署服务，可自动化您的软件开发工作流程。

项目安装和配置的准备工作

在开始安装 aws-cdk-github-oidc 之前，请确保您已经完成了以下准备工作：

• 安装了 Node.js 和 npm。
• 安装了 AWS CLI 并配置了 AWS 访问权限。
• 在 GitHub 上创建了个人访问令牌（PAT），用于在安装过程中授权。

安装步骤

以下是 aws-cdk-github-oidc 的详细安装步骤：

1. 克隆仓库

   在您的本地环境中，使用 Git 克隆 aws-cdk-github-oidc 仓库：

   git clone https://github.com/aripalo/aws-cdk-github-oidc.git
   cd aws-cdk-github-oidc
   

2. 安装依赖

   在项目目录中，使用 npm 安装项目依赖：

   npm install
   

3. 构建项目

   使用以下命令构建项目：

   npm run build
   

4. 部署 OIDC 提供者和角色

   根据您的 AWS 账户和需求，使用 CDK 部署 OIDC 提供者和角色。以下是创建一个新的 OIDC 提供者配置的示例代码：

   import { GithubActionsIdentityProvider } from 'aws-cdk-github-oidc';
   
   const provider = new GithubActionsIdentityProvider(this, 'GithubProvider');
   

   然后，您可以定义一个 IAM 角色，GitHub Actions 工作流可以假设这个角色：

   import { GithubActionsRole } from 'aws-cdk-github-oidc';
   
   const role = new GithubActionsRole(this, 'MyRole', {
     provider: provider,
     owner: 'octo-org',
     repo: 'octo-repo',
     filter: 'ref:refs/tags/v*'
   });
   

5. 配置 GitHub Actions 工作流

   在您的 GitHub 仓库中，添加一个新的工作流文件（例如 .github/workflows/deploy.yml），并配置使用 aws-actions/configure-aws-credentials 来假设上面创建的角色。

   jobs:
     deploy:
       name: Deploy to AWS
       runs-on: ubuntu-latest
       steps:
         - name: Checkout
           uses: actions/checkout@v2
         - name: Configure AWS credentials
           uses: aws-actions/configure-aws-credentials@master
           with:
             role-to-assume: arn:aws:iam::123456789012:role/MyRole
             aws-region: us-east-1
         - name: Deploy to AWS
           run: |
             aws s3 sync . s3://my-example-bucket
   

完成以上步骤后，您就可以使用 aws-cdk-github-oidc 在 AWS 中安全地自动化您的 GitHub Actions 工作流了。