Skip to main content

使用 AWS CloudFormation 部署 AWS 资源

此示例演示了如何使用AWS CloudFormation 模板，通过 Port Actions 部署 AWS 资源。

我们将使用一个名为aws-actions/aws-cloudformation-github-deploy 的 AWS 管理的 GitHub Action。

步骤​

  1. 创建以下 GitHub 操作secret:
    1. PORT_CLIENT_ID - Port 客户端 IDlearn more.
    2. PORT_CLIENT_SECRET - Port客户端secretlearn more.
    3. AWS_ACCESS_KEY_ID - AWS 凭据。
    4. AWS_SECRET_ACCESS_KEY - AWS 凭据。 5.AWS_REGION - 要将资源部署到的 AWS 区域名称。 2.点击here 安装 Port 的 GitHub 应用程序。 3.使用以下 JSON 定义创建 Port 蓝图(选择所需资源):
Port EC2 Instance Blueprint
{
  "identifier": "ec2_instance",
  "description": "AWS EC2 Instance",
  "title": "EC2 Instance",
  "icon": "EC2",
  "schema": {
    "properties": {
      "instance_name": {
        "title": "Instance Name",
        "type": "string"
      },
      "instance_type": {
        "title": "Instance Type",
        "type": "string"
      },
      "image_id": {
        "title": "Image ID",
        "type": "string"
      },
      "key_pair_name": {
        "title": "Key Pair Name",
        "type": "string"
      },
      "security_group_ids": {
        "title": "Security Group IDs",
        "type": "string"
      }
    },
    "required": [
      "instance_name",
      "instance_type",
      "image_id",
      "key_pair_name",
      "security_group_ids"
    ]
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "relations": {}
}

  1. 使用以下 JSON 定义创建 Port Action:
请确保修改 GITHUB_ORG、GITHUB_REPO 和 GITHUB_WORKFLOW_FILE 占位符，使其与您的环境相匹配。
Port Action
{
  "identifier": "deploy_ec2_instance",
  "title": "Deploy EC2 Instance",
  "icon": "EC2",
  "userInputs": {
    "properties": {
      "instance_name": {
        "title": "Instance Name",
        "type": "string"
      },
      "instance_type": {
        "title": "Instance Type",
        "type": "string",
        "default": "t2.micro",
        "enum": ["t2.micro", "t2.small"],
        "enumColors": {
          "t2.micro": "lightGray",
          "t2.small": "lightGray"
        }
      },
      "image_id": {
        "title": "Image ID",
        "type": "string"
      },
      "key_pair_name": {
        "title": "Key Pair Name",
        "type": "string"
      },
      "security_group_ids": {
        "title": "Security Group IDs",
        "icon": "DefaultProperty",
        "type": "string",
        "description": "Use comma delimited values for multiple SGs"
      }
    },
    "required": [
      "instance_name",
      "instance_type",
      "image_id",
      "key_pair_name",
      "security_group_ids"
    ],
    "order": [
      "instance_name",
      "instance_type",
      "image_id",
      "key_pair_name",
      "security_group_ids"
    ]
  },
  "invocationMethod": {
    "type": "GITHUB",
    "omitPayload": false,
    "omitUserInputs": false,
    "reportWorkflowStatus": true,
    "org": "<GITHUB_ORG>",
    "repo": "<GITHUB_REPO>",
    "workflow": "<GITHUB_WORKFLOW_FILE>"
  },
  "trigger": "CREATE",
  "requiredApproval": false
}

5.在 GitHub 仓库中创建 CloudFormation 模板文件:

AWS CloudFormation Template
AWSTemplateFormatVersion: "2010-09-09"
Description: CloudFormation Template to Deploy an EC2 Instance

Parameters:
  InstanceName:
    Description: Name for the EC2 instance
    Type: String
    MinLength: 1
    MaxLength: 255
    Default: MyEC2InstanceName
    ConstraintDescription: Instance name must not be empty

  InstanceType:
    Description: EC2 instance type
    Type: String
    Default: t2.micro
    AllowedValues:
      - t2.micro
      - t2.small
      - t2.medium
      # Add more instance types as needed
    ConstraintDescription: Must be a valid EC2 instance type

  ImageId:
    Description: ID of the Amazon Machine Image (AMI) to use
    Type: AWS::EC2::Image::Id
    ConstraintDescription: Must be a valid AMI ID

  KeyPairName:
    Description: Name of the key pair for SSH access
    Type: String
    MinLength: 1
    MaxLength: 255
    ConstraintDescription: Key pair name must not be empty

  SecurityGroupIds:
    Description: List of Security Group IDs for the EC2 instance
    Type: List<AWS::EC2::SecurityGroup::Id>
    ConstraintDescription: Must be a list of valid Security Group IDs

Resources:
  EC2Instance:
    Type: AWS::EC2::Instance
    Properties:
      InstanceType: !Ref InstanceType
      ImageId: !Ref ImageId
      KeyName: !Ref KeyPairName
      SecurityGroupIds: !Ref SecurityGroupIds
      Tags:
        - Key: Name
          Value: !Ref InstanceName

Outputs:
  InstanceId:
    Description: ID of the created EC2 instance
    Value: !Ref EC2Instance

6.在.github/workflows/deploy-cloudformation-template.yml下创建一个工作流文件，内容如下:

请确保修改 CF_TEMPLATE_FILE 占位符以匹配 CloudFormation 模板文件路径。
GitHub workflow
name: Deploy CloudFormation - EC2 Instance

on:
  workflow_dispatch:
    inputs:
      instance_name:
        required: true
        type: string
        description: instance name
      instance_type:
        required: true
        type: string
        description: instance type
      image_id:
        required: true
        type: string
        description: image id
      key_pair_name:
        required: true
        type: string
        description: key pair name
      security_group_ids:
        required: true
        type: string
        description: security group ids
      port_payload:
        required: true
        description:
          Port's payload, including details for who triggered the action and
          general context (blueprint, run id, etc...)
        type: string

jobs:
  deploy-cloudformation-template:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Configure AWS Credentials 🔒
        id: aws-credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ${{ secrets.AWS_REGION }}

      - name: Deploy to AWS CloudFormation
        uses: aws-actions/aws-cloudformation-github-deploy@v1
        with:
          name: ${{ inputs.instance_name }}
          template: <CF_TEMPLATE_FILE>
          parameter-overrides: >-
            InstanceName=${{ inputs.instance_name }},
            InstanceType=${{ inputs.instance_type }},
            ImageId=${{ inputs.image_id }},
            KeyPairName=${{ inputs.key_pair_name }},
            SecurityGroupIds="${{ inputs.security_group_ids }}"

      - name: UPSERT EC2 Instance Entity in Port
        uses: port-labs/port-github-action@v1
        with:
          identifier: ${{ inputs.instance_name }}
          title: ${{ inputs.instance_name }}
          team: "[]"
          icon: EC2
          blueprint: ec2_instance
          properties: |-
            {
              "instance_name": "${{ inputs.instance_name }}",
              "instance_type": "${{ inputs.instance_type }}",
              "image_id": "${{ inputs.image_id }}",
              "key_pair_name": "${{ inputs.key_pair_name }}",
              "security_group_ids": "${{ inputs.security_group_ids }}"
            }
          relations: "{}"
          clientId: ${{ secrets.PORT_CLIENT_ID }}
          clientSecret: ${{ secrets.PORT_CLIENT_SECRET }}
          operation: UPSERT
          runId: ${{fromJson(inputs.port_payload).context.runId}}

7.从 Port 应用程序的Self-service 标签触发操作。

#What's next?

  • Connect Port's AWS exporter 以确保从 AWS 自动摄取所有属性和实体。
    • 您可以了解如何设置 Port 的 AWS 输出程序here 。
    • 您可以查看示例配置和用例here 。