기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

AWS CDK를 사용하여 AWS DevOps 에이전트 시작하기

개요

이 가이드에서는 AWS 클라우드 개발 키트(AWS CDK)를 사용하여 AWS DevOps 에이전트 리소스를 생성하고 배포하는 방법을 보여줍니다. AWS CDK 애플리케이션은 AWS CloudFormation을 통해 에이전트 공간, AWS 자격 증명 및 액세스 관리(IAM) 역할, 운영자 앱 및 AWS 계정 연결 생성을 자동화합니다.

AWS CDK 접근 방식은 필요한 모든 리소스를 코드형 인프라로 정의하여 CLI 온보딩 가이드에 설명된 수동 단계를 자동화합니다.

AWS DevOps 에이전트는 여러 AWS 리전에서 사용할 수 있습니다. 전체 목록은 지원되는 리전: 단원을 참조하십시오.

사전 조건

시작하기 전에 다음 사항을 갖췄는지 확인하세요.

npm install -g aws-cdk

이 가이드에서 다루는 내용

이 가이드는 다음 부분으로 나뉩니다.

생성할 리소스

1부: DevOpsAgentStack(모니터링 계정)

2부: ServiceStack(서비스 계정, 선택 사항)

3부: 자산 및 트리거(모니터링 계정, 선택 사항)

이 스택은 다음 리소스를 생성합니다.

설정

1단계: 샘플 리포지토리 복제

다음 명령을 실행하여 리포지토리를 복제하고 프로젝트 디렉터리로 변경합니다.

git clone https://github.com/aws-samples/sample-aws-devops-agent-cdk.git
cd sample-aws-devops-agent-cdk

2단계: 종속성 설치

다음 명령을 실행하여 프로젝트 종속성을 설치합니다.

npm install

1부: 에이전트 공간 배포

이 섹션에서는 모니터링 계정에 에이전트 공간, IAM 역할, 운영자 앱 및 AWS 연결을 생성합니다.

1단계: 모니터링 계정 ID 구성

lib/constants.ts를 열고 모니터링 계정 ID를 설정합니다.

다음 예제에서는 업데이트할 상수를 보여줍니다.

export const MONITORING_ACCOUNT_ID = "<YOUR_MONITORING_ACCOUNT_ID>";

2단계: AWS CDK 환경 부트스트랩

모니터링 계정에서 AWS CDK를 부트스트래핑하지 않은 경우 다음 명령을 실행합니다.

cdk bootstrap aws://<MONITORING_ACCOUNT_ID>/<REGION> --profile monitoring

3단계: 빌드 및 배포

다음 명령을 실행하여 TypeScript 코드를 빌드하고 스택을 배포합니다.

npm run build
cdk deploy DevOpsAgentStack --profile monitoring

4단계: 스택 출력 기록

배포가 완료되면 AWS CDK는 스택 출력을 인쇄합니다. 나중에 사용할 수 있도록 이러한 값을 기록합니다.

다음 예제에서는 예상 출력을 보여줍니다.

Outputs:
DevOpsAgentStack.AgentSpaceArn = arn:aws:aidevops:<REGION>:123456789012:agentspace/abc123
DevOpsAgentStack.AgentSpaceRoleArn = arn:aws:iam::123456789012:role/DevOpsAgentRole-AgentSpace
DevOpsAgentStack.OperatorRoleArn = arn:aws:iam::123456789012:role/DevOpsAgentRole-WebappAdmin
DevOpsAgentStack.AssociationId = assoc-xyz

2부를 완료하려는 경우 AgentSpaceArn 값을 저장합니다. 서비스 계정 스택을 구성하는 데 필요합니다.

스택은 에이전트 공간 ID가 아닌 에이전트 공간 ARN을 출력합니다. 이후 단계에서는 ARN에서 뒤에 오는 세그먼트인 IDagentspace/를 요청합니다. 앞의 예에서 ARN은 로 끝나agentspace/abc123므로 에이전트 공간 ID는 입니다abc123. 해당 값도 기록합니다.

5단계: 배포 확인

에이전트 공간이 성공적으로 생성되었는지 확인하려면 다음 AWS CLI 명령을 실행합니다.

aws devops-agent get-agent-space \
  --agent-space-id <AGENT_SPACE_ID> \
  --region <REGION>

이 시점에서 에이전트 공간은 운영자 앱이 활성화되고 모니터링 계정이 연결된 상태로 배포됩니다. 에이전트는이 계정의 문제를 모니터링할 수 있습니다.

2부(선택 사항): 교차 계정 모니터링 추가

이 섹션에서는 에이전트 공간이 두 번째 AWS 계정(서비스 계정)의 리소스를 모니터링할 수 있도록 설정을 확장합니다. 여기에는 다음 두 가지 작업이 포함됩니다.

1단계: 서비스 계정 ID 구성

서비스 계정 ID를 lib/constants.ts 열고 설정합니다.

다음 예제에서는 업데이트할 상수를 보여줍니다.

export const SERVICE_ACCOUNT_ID = "<YOUR_SERVICE_ACCOUNT_ID>";

DevOpsAgentStack은이 계정 ID를 사용하여 소스 AWS 연결을 생성합니다. 이 값을 설정하기 전에 DevOpsAgentStack을 배포한 경우 다시 배포하여 연결을 생성합니다.

다음 명령을 실행하여 재배포합니다.

npm run build
cdk deploy DevOpsAgentStack --profile monitoring

2단계: 에이전트 공간 ARN 설정

DevOpsAgentStack 출력(1부, 4단계)에서 AgentSpaceArn 값을 복사하고에서 설정합니다lib/constants.ts.

다음 예제에서는 업데이트할 상수를 보여줍니다.

export const AGENT_SPACE_ARN = "arn:aws:aidevops:<REGION>:<MONITORING_ACCOUNT_ID>:agentspace/<SPACE_ID>";

ServiceStack은이 값을 사용하여 보조 계정 역할에 대한 신뢰 정책의 범위를 지정합니다. ServiceStack은이 값이 설정된 경우에만 합성됩니다.

3단계: 서비스 계정 부트스트랩

서비스 계정에서 AWS CDK를 부트스트래핑하지 않은 경우 다음 명령을 실행합니다.

cdk bootstrap aws://<SERVICE_ACCOUNT_ID>/<REGION> --profile service

4단계: ServiceStack 배포

다음 명령을 실행하여 서비스 계정의 자격 증명을 사용하여 ServiceStack을 빌드하고 배포합니다.

npm run build
cdk deploy ServiceStack --profile service

이렇게 하면 서비스 계정에 다음 리소스가 생성됩니다.

5단계: 배포 확인

Lambda 함수가 성공적으로 배포되었는지 확인하려면 다음 명령을 실행하여 에코 서비스를 테스트합니다.

aws lambda invoke \
  --function-name echo-service \
  --payload '{"test": "hello world"}' \
  --profile service \
  response.json
cat response.json

3부(선택 사항): 스킬, 사용자 지정 에이전트 및 예약된 트리거 추가

이 섹션에서는 1부에서 생성한 에이전트 공간에 리소스 3개를 추가합니다. 관련될 때 에이전트가 로드하는 스킬과 에이전트의 범위를 특정 워크플로로 지정하는 사용자 지정 에이전트를 추가합니다. 또한 사용자 지정 에이전트를 자동으로 실행하는 예약된 트리거를 추가합니다. 이러한 리소스는 aws-cdk-lib/aws-devopsagent 모듈의 CfnAsset 및 CfnTrigger 구문을 사용합니다.

이러한 리소스에는 AWS 계정에 추가 요금이 발생할 수 있습니다. 작업을 마쳤을 때 제거하려면이 가이드의 끝에 있는 정리 섹션을 따르세요.

이 예제에서는 skill 및 custom_agent 자산 유형을 사용합니다. 동일한 CfnAsset 구문이 memory_store, agents_md및와 같은 모든 자산 유형을 생성합니다attachment. 다른 유형을 사용하려면 assetType 속성을 변경하고 유형에 필요한 메타데이터를 제공합니다. 자산 유형, 필수 메타데이터 및 속성 참조의 전체 목록은 섹션을 참조하세요자산 관리.

1단계: 콘텐츠 스택 생성

다음 콘텐츠를 가진 lib/content-stack.ts이라는 파일을 생성합니다: 시간 기반 트리거의 작업은 자산 ID별로 사용자 지정 에이전트를 형식으로 참조합니다custom:<assetId>. 스택은 사용자 지정 에이전트 속성의 값을 사용하여이 참조를 자동으로 연결합니다attrAssetId. 사용자 지정 에이전트의 skills 목록에는 이름이 아닌 자산 IDs도 포함되므로 스킬의를 사용합니다attrAssetId. 또한 스택에 암시적 종속성을 부여하므로 이를 연결하는 에이전트보다 먼저 스킬이 생성됩니다.

import * as cdk from 'aws-cdk-lib';
import { CfnAsset, CfnTrigger } from 'aws-cdk-lib/aws-devopsagent';
import { Construct } from 'constructs';

export interface ContentStackProps extends cdk.StackProps {
  readonly agentSpaceId: string;
}

export class ContentStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props: ContentStackProps) {
    super(scope, id, props);

    // A skill the agent loads when relevant
    const skill = new CfnAsset(this, 'ExampleSkill', {
      agentSpaceId: props.agentSpaceId,
      assetType: 'skill',
      metadata: {
        name: 'rds-performance-investigation',
        description: 'Investigation procedures for RDS performance issues.',
        agent_types: ['GENERIC'],
      },
      files: [
        {
          path: 'SKILL.md',
          contentText: [
            '# RDS Performance Investigation',
            'Use this skill when investigating database latency, connection',
            'errors, or query timeouts.',
          ].join('\n'),
        },
      ],
    });

    // A custom agent with attached skills that a trigger can invoke
    const customAgent = new CfnAsset(this, 'ExampleCustomAgent', {
      agentSpaceId: props.agentSpaceId,
      assetType: 'custom_agent',
      metadata: {
        name: 'rds-firefighter',
        skills: [skill.attrAssetId],
      },
      files: [
        {
          path: 'AGENT.md',
          contentText: ['# RDS Firefighter', 'Custom agent for RDS incidents.'].join('\n'),
        },
      ],
    });

    // A time-based trigger that runs the custom agent on a schedule
    const dailyTrigger = new CfnTrigger(this, 'DailyTrigger', {
      agentSpaceId: props.agentSpaceId,
      type: 'TIME_BASED',
      condition: {
        schedule: {
          expression: 'rate(1 day)',
        },
      },
      action: {
        actionType: 'create:task',
        task: {
          agent: `custom:${customAgent.attrAssetId}`,
        },
      },
      status: 'Active',
    });

    new cdk.CfnOutput(this, 'SkillAssetId', {
      description: 'The skill asset ID',
      value: skill.attrAssetId,
    });
    new cdk.CfnOutput(this, 'CustomAgentAssetId', {
      description: 'The custom agent asset ID',
      value: customAgent.attrAssetId,
    });
    new cdk.CfnOutput(this, 'TriggerId', {
      description: 'The trigger ID',
      value: dailyTrigger.attrTriggerId,
    });
  }
}

2단계: AWS CDK 앱에 스택 추가

앱 진입점(예: bin/app.ts)에서 스택을 인스턴스화하고 1부, 4단계에서 기록한 에이전트 공간 ID를 전달합니다. 전체 AgentSpaceArn 값이 abc123아닌와 같은 ID를 사용합니다.

new ContentStack(app, 'ContentStack', {
  env: { account: MONITORING_ACCOUNT_ID, region: process.env.CDK_DEFAULT_REGION },
  agentSpaceId: '<AGENT_SPACE_ID>',
});

3단계: 스택 배포

다음 명령을 실행하여 모니터링 계정 자격 증명을 사용하여 스택을 빌드하고 배포합니다.

npm run build
cdk deploy ContentStack --profile monitoring

자산의 agentSpaceId 및 assetType 속성은 트리거의 , agentSpaceIdtypecondition, 및 action 속성과 마찬가지로 생성 전용입니다. 둘 중 하나를 변경하면 리소스가 대체됩니다. 트리거의 status (Active 또는 Inactive)를 업데이트하여 삭제하지 않고 트리거Inactive를 일시 중지하도록 설정할 수 있습니다. 다른 자산 유형 및 전체 속성 참조에 대한 자세한 내용은 섹션을 참조하세요자산 관리.

4단계: 배포 확인

자산과 트리거가 생성되었는지 확인하려면 다음 AWS CLI 명령을 실행합니다.

aws devops-agent list-assets \
  --agent-space-id <AGENT_SPACE_ID> \
  --region <REGION>

aws devops-agent list-triggers \
  --agent-space-id <AGENT_SPACE_ID> \
  --region <REGION>

문제 해결

이 섹션에서는 일반적인 문제와 해결 방법을 설명합니다.

CfnAsset 또는 CfnTrigger는에서 내보내지 않습니다. aws-cdk-lib/aws-devopsagent

CloudFormation 리소스 유형을 찾을 수 없음

IAM 역할 생성 실패

"대상 계정에서 역할을 수임할 수 없음"과 함께 교차 계정 배포가 실패합니다.

IAM 전파 지연

정리

모든 리소스를 제거하려면 스택을 역순으로 삭제합니다.

다음 명령을 실행하여 스택을 삭제합니다.

# If you deployed the Part 3 ContentStack, destroy it first
cdk destroy ContentStack --profile monitoring
# If you deployed the ServiceStack, destroy it next
cdk destroy ServiceStack --profile service
# Then destroy the DevOpsAgentStack
cdk destroy DevOpsAgentStack --profile monitoring

경고:이 작업은 에이전트 공간과 모든 관련 데이터를 영구적으로 삭제합니다. 이 작업은 실행 취소할 수 없습니다. 계속하기 전에 중요한 정보를 백업했는지 확인합니다.

보안 고려 사항

다음 단계

AWS CDK를 사용하여 AWS DevOps 에이전트를 배포한 후:

추가 리소스