기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
# AWS CDK를 사용하여 AWS Service Catalog 포트폴리오 및 제품 배포 자동화
*Sandeep Gawande, Viyoma Sachdeva, RAJNEESH TYAGI, Amazon Web Services*
## 요약
AWS Service Catalog를 사용하면 조직의 AWS 환경에서 사용하도록 승인된 IT 서비스 또는 *제품* 카탈로그를 중앙에서 관리할 수 있습니다. 제품 컬렉션을 *포트폴리오*라고 하며 포트폴리오에는 구성 정보도 포함됩니다. AWS Service Catalog를 사용하면 조직의 각 사용자 유형에 대해 사용자 지정 포트폴리오를 생성한 다음 해당 포트폴리오에 대한 액세스 권한을 부여할 수 있습니다. 그러면 해당 사용자는 포트폴리오 내에서 필요한 모든 제품을 신속하게 배포할 수 있습니다.
다중 리전 및 다중 계정 아키텍처와 같은 복잡한 네트워킹 인프라를 사용하는 경우 단일의 중앙 계정으로 Service Catalog 포트폴리오를 만들고 관리하는 것이 좋습니다. 이 패턴은 AWS Cloud Development Kit(AWS CDK)를 사용하여 중앙 계정에서 Service Catalog 포트폴리오를 자동으로 생성하고, 최종 사용자에게 포트폴리오에 대한 액세스 권한을 부여한 다음, 선택적으로 하나 이상의 대상 AWS 계정에서 제품을 프로비저닝하는 방법을 설명합니다. 바로 사용할 수 있는 이 솔루션은 소스 계정에 Service Catalog 포트폴리오를 생성합니다. 또한 선택적으로 AWS CloudFormation 스택을 사용하여 대상 계정의 제품을 프로비저닝하고 제품에 대한 TagOption을 구성하는 데 도움이 됩니다.
+ **AWS CloudFormation StackSets** - StackSet을 사용하여 여러 AWS 리전 및 계정에서 서비스 카탈로그 제품을 시작할 수 있습니다. 이 솔루션에서는 이 솔루션을 배포할 때 제품을 자동으로 프로비저닝할 수 있는 옵션이 있습니다. 자세한 내용은 [AWS CloudFormation StackSet 사용](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/using-stacksets.html)(Service Catalog 설명서) 및 [StackSet 개념](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html)(CloudFormation 설명서)을 참조하십시오.
+ **TagOption 라이브러리** - TagOption 라이브러리를 사용하여 프로비전된 제품의 태그를 관리할 수 있습니다. *TagOption*은 AWS Service Catalog에서 관리되는 키 값 쌍입니다. AWS 태그는 아니지만, TagOption을 기반으로 AWS 태그를 만들기 위한 템플릿 역할을 합니다. 자세한 내용은 [TagOption 라이브러러리](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/tagoptions.html)(Service Catalog 설명서)를 참조하십시오.
## 사전 조건 및 제한 사항
**사전 조건 **
+ Service Catalog 포트폴리오 관리를 위한 소스 계정으로 사용할 활성 AWS 계정.
+ 이 솔루션을 사용하여 하나 이상의 대상 계정에 제품을 프로비저닝하는 경우 대상 계정이 이미 존재하고 활성화되어 있어야 합니다.
+ AWS Service Catalog, AWS CloudFormation 및 AWS Identity and Access Management(IAM)에 접근하기 위한 AWS IAM 권한입니다.
**제품 버전**
+ AWS CDK 버전 2.27.0
## 아키텍처
**대상 기술 스택**
+ 중앙 집중식 AWS 계정의 Service Catalog 포트폴리오
+ 대상 계정에 배포된 Service Catalog 제품
**대상 아키텍처**
![\[AWS CDK를 사용하여 Service Catalog 포트폴리오 생성 및 대상 계정에 제품 프로비저닝.\]](http://docs.aws.amazon.com/ko_kr/prescriptive-guidance/latest/patterns/images/pattern-img/e8f217a7-aec4-4c85-8f6b-f91995506be0/images/1f027b82-14c3-485a-909b-1544e974b90a.png)
1. 포트폴리오(또는 *소스*) 계정에서 **config.json** 파일을 사용 사례에 맞는 AWS 계정, AWS 리전, IAM 역할, 포트폴리오 및 제품 정보로 업데이트합니다.
1. AWS CDK 애플리케이션을 배포합니다.
1. AWS CDK 애플리케이션은 배포 IAM 역할을 맡아 **config.json** 파일에 정의된 Service Catalog 포트폴리오 및 제품을 생성합니다.
대상 계정에 제품을 배포하도록 StackSet를 구성한 경우 프로세스가 계속됩니다. 제품을 프로비저닝하도록 StackSets를 구성하지 않은 경우 프로세스가 완료됩니다.
1. AWS CDK 애플리케이션은** StackSet 관리자** 역할을 맡아 **config.json** 파일에 정의한 AWS CloudFormation 스택 세트를 배포합니다.
1. 대상 계정에서 StackSet는 **StackSet 실행** 역할을 맡고 제품을 프로비저닝합니다.
## 도구
**서비스**
+ [AWS Cloud Development Kit(AWS CDK)](https://docs.aws.amazon.com/cdk/latest/guide/home.html)는 AWS 클라우드 인프라를 코드로 정의하고 프로비저닝하는 데 도움이 되는 소프트웨어 개발 프레임워크입니다.
+ [AWS CDK 툴킷](https://docs.aws.amazon.com/cdk/latest/guide/cli.html)은 AWS CDK 앱과 상호 작용하는 데 도움이 되는 명령줄 클라우드 개발 키트입니다.
+ [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html)을 사용하면 AWS 리소스를 설정하고, 빠르고 일관되게 프로비저닝하고, 전체 AWS 계정 및 리전에서 수명 주기 전반에 걸쳐 관리할 수 있습니다.
+ [AWS Identity and Access Management(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html)는 누구에게 인증 및 사용 권한이 있는지 제어하여 AWS 리소스에 대한 액세스를 안전하게 관리할 수 있도록 도와줍니다.
+ [AWS Service Catalog](https://docs.aws.amazon.com/servicecatalog/latest/adminguide/introduction.html)를 사용하면 AWS에 승인된 IT 서비스의 카탈로그를 중앙에서 관리할 수 있습니다. 최종 사용자는 조직에서 규정한 제약에 따라, 필요에 따라 승인된 IT 서비스만 신속하게 배포할 수 있습니다.
**코드 리포지토리**
이 패턴의 코드는 GitHub의 [aws-cdk-servicecatalog-automation](https://github.com/aws-samples/aws-cdk-servicecatalog-automation.git) 리포지토리에서 사용할 수 있습니다. 코드 리포지토리에는 다음 파일과 폴더가 포함되어 있습니다.
+ **cdk-sevicecatalog-app** - 이 폴더에는 이 솔루션에 대한 AWS CDK 애플리케이션이 들어 있습니다.
+ **구성** - 이 폴더에는 Service Catalog 포트폴리오의 제품을 배포하기 위한 **config.json** 파일과 CloudFormation 템플릿이 들어 있습니다.
+ **config/config.json** - 이 파일에는 모든 구성 정보가 들어 있습니다. 이 파일을 업데이트하여 사용 사례에 맞게 이 솔루션을 사용자 지정합니다.
+ **구성 및 템플릿** - 이 폴더에는 서비스 센터 제품에 대한 CloudFormation 템플릿이 들어 있습니다.
+ **setup.sh** - 이 스크립트는 솔루션을 배포합니다.
+ **uninstall.sh** - 이 스크립트는 이 솔루션을 배포할 때 생성된 스택과 모든 AWS 리소스를 삭제합니다.
샘플 코드를 사용하려면 [에픽](#automate-aws-service-catalog-portfolio-and-product-deployment-by-using-aws-cdk-epics) 섹션의 지침을 따르십시오.
## 모범 사례
+ 이 솔루션을 배포하는 데 사용되는 IAM 역할은 [최소 권한 원칙](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege)(IAM 설명서)을 준수해야 합니다.
+ [AWS CDK를 사용한 클라우드 애플리케이션 개발 모범 사례](https://aws.amazon.com/blogs/devops/best-practices-for-developing-cloud-applications-with-aws-cdk/)(AWS Blog 게시물)를 준수하십시오.
+ [AWS CloudFormation 모범 사례](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html)(CloudFormation 설명서)를 준수하십시오.
## 에픽
### 환경을 설정합니다
| 작업 | 설명 | 필요한 기술 |
| --- | --- | --- |
| AWS CDK 툴킷을 설치합니다. | AWS CDK 툴킷이 설치되어 있는지 확인하십시오. 다음 명령을 입력하여 설치 여부를 확인하고 버전을 확인합니다. cdk --version
AWS CDK가 설치되지 않은 경우에는 다음 명령을 실행하여 설치합니다.npm install -g aws-cdk@2.27.0
AWS CDK 툴킷 버전이 2.27.0 이전인 경우 다음 명령을 입력하여 버전 2.27.0으로 업데이트하십시오.npm install -g aws-cdk@2.27.0 --force
| AWS DevOps, DevOps 엔지니어 |
| 리포지토리를 복제합니다. | 다음 명령을 입력하십시오. [추가 정보](#automate-aws-service-catalog-portfolio-and-product-deployment-by-using-aws-cdk-additional) 섹션의 *리포지토리 복제*에서 리포지토리의 URL이 포함된 전체 명령을 복사할 수 있습니다. 이렇게 하면 GitHub의 [aws-cdk-servicecatalog-automation](https://github.com/aws-samples/aws-cdk-servicecatalog-automation) 리포지토리가 복제됩니다.git clone .git
그러면 대상 디렉터리에 `cd aws-cdk-servicecatalog-automation` 폴더가 생성됩니다. 다음 명령을 입력하여 이 폴더로 이동합니다.cd aws-cdk-servicecatalog-automation
| AWS DevOps, DevOps 엔지니어 |
| AWS 보안 인증을 설정합니다. | 다음 명령을 입력합니다. 이들은 스택을 배포하는 AWS 계정 및 리전을 정의하는 다음 변수를 내보냅니다.export CDK_DEFAULT_ACCOUNT=<12-digit AWS account number>
export CDK_DEFAULT_REGION=
AWS CDK용 AWS 보안 인증은 환경 변수를 통해 제공됩니다. | AWS DevOps, DevOps 엔지니어 |
| 최종 사용자 IAM 역할에 대해 권한을 구성하십시오. | IAM 역할을 사용하여 포트폴리오와 포트폴리오에 포함된 제품에 대한 액세스 권한을 부여하려는 경우 역할에 **servicecatalog.amazonaws.com** 서비스 보안 주체가 수임할 수 있는 권한이 있어야 합니다. 이러한 권한을 부여하는 방법에 대한 지침은 [Service Catalog를 통한 신뢰할 수 있는 액세스 활성화](https://docs.aws.amazon.com/organizations/latest/userguide/services-that-can-integrate-servicecatalog.html#integrate-enable-ta-servicecatalog)(AWS Organizations 설명서)를 참조하십시오. | AWS DevOps, DevOps 엔지니어 |
| StackSet에 필요한 IAM 역할을 구성합니다. | StackSet를 사용하여 대상 계정의 제품을 자동으로 프로비저닝하는 경우 스택 세트를 관리하고 실행하는 IAM 역할을 구성해야 합니다.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ko_kr/prescriptive-guidance/latest/patterns/automate-aws-service-catalog-portfolio-and-product-deployment-by-using-aws-cdk.html) | AWS DevOps, DevOps 엔지니어 |
### 솔루션 사용자 지정 및 배포
| 작업 | 설명 | 필요한 기술 |
| --- | --- | --- |
| CloudFormation 템플릿을 생성합니다. | 이 `config/templates` 폴더에서 포트폴리오에 포함하려는 모든 제품에 대한 CloudFormation 템플릿을 생성합니다. 더 자세한 내용은 [AWS CloudFormation 템플릿으로 작업하기](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-guide.html)(CloudFormation 설명서)를 참조하십시오. | 앱 개발자, AWS DevOps, DevOps 엔지니어 |
| 구성 파일을 사용자 지정합니다. | `config` 폴더에서 **config.json** 파일을 열고 사용 사례에 적합한 파라미터를 정의합니다. 달리 명시되지 않는 한 다음 파라미터가 요구됩니다.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ko_kr/prescriptive-guidance/latest/patterns/automate-aws-service-catalog-portfolio-and-product-deployment-by-using-aws-cdk.html)완성된 구성 파일의 예는 *추가 정보* 섹션의 [샘플 구성 파일](#automate-aws-service-catalog-portfolio-and-product-deployment-by-using-aws-cdk-additional)을 참조하십시오. | 앱 개발자, DevOps 엔지니어, AWS DevOps |
| 솔루션을 배포합니다. | 다음 명령을 입력하십시오. 그러면 AWS CDK 앱이 배포되고 **config.json** 파일에 지정된 대로 Service Catalog 포트폴리오 및 제품이 프로비저닝됩니다.sh +x setup.sh
| 앱 개발자, DevOps 엔지니어, AWS DevOps |
| 배포를 확인합니다. | 다음을 수행하여 배포가 성공했는지 확인하십시오.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ko_kr/prescriptive-guidance/latest/patterns/automate-aws-service-catalog-portfolio-and-product-deployment-by-using-aws-cdk.html) | 일반 AWS |
| (선택 사항) 포트폴리오와 제품을 업데이트하십시오. | 이 솔루션을 사용하여 포트폴리오 또는 제품을 업데이트하거나 새 제품을 제공하려는 경우:[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ko_kr/prescriptive-guidance/latest/patterns/automate-aws-service-catalog-portfolio-and-product-deployment-by-using-aws-cdk.html)예를 들면 포트폴리오를 추가하거나 리소스를 더 프로비저닝할 수 있습니다. AWS CDK 앱은 변경 사항만 구현합니다. 이전에 배포한 포트폴리오 또는 제품에 변경 사항이 없는 경우 재배포는 영향을 받지 않습니다. | 앱 개발자, DevOps 엔지니어, 일반 AWS |
### 솔루션 정리
| 작업 | 설명 | 필요한 기술 |
| --- | --- | --- |
| (선택 사항) 이 솔루션에서 배포한 AWS 리소스를 제거합니다. | 프로비전된 제품을 삭제하려면 [프로비저닝된 제품 삭제](https://docs.aws.amazon.com/servicecatalog/latest/userguide/enduser-delete.html)(Service Catalog 설명서)의 지침을 따르십시오.이 솔루션으로 생성된 리소스를 모두 삭제하려면 다음 명령을 입력하십시오.sh uninstall.sh
| AWS DevOps, DevOps 엔지니어, 앱 개발자 |
## 관련 리소스
+ [AWS Service Catalog 구성 라이브러리](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_servicecatalog-readme.html)(AWS API 참조)
+ [StackSet 개념](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html)(CloudFormation 설명서)
+ [AWS Service Catalog](https://aws.amazon.com/servicecatalog)(AWS 마케팅)
+ [AWS CDK와 함께 Service Catalog 사용](https://catalog.us-east-1.prod.workshops.aws/workshops/d40750d7-a330-49be-9945-cde864610de9/en-US/4-builders-devs/sc-cdk)(AWS 워크숍)
## 추가 정보
**리포지토리 복제**
명령줄에 다음을 입력하여GitHub에서 리포지토리를 복제합니다.
```
git clone https://github.com/aws-samples/aws-cdk-servicecatalog-automation.git
```
**샘플 구성 파일**
다음은 예제 값이 포함된 샘플 **config.json** 파일입니다.
```
{
"portfolios": [
{
"displayName": "EC2 Product Portfolio",
"providerName": "User1",
"description": "Test1",
"roles": [
""
],
"users": [
""
],
"groups": [
""
]
},
{
"displayName": "Autoscaling Product Portfolio",
"providerName": "User2",
"description": "Test2",
"roles": [
""
]
}
],
"tagOption": [
{
"key": "Group",
"value": [
"finance",
"engineering",
"marketing",
"research"
]
},
{
"key": "CostCenter",
"value": [
"01",
"02",
"03",
"04"
]
},
{
"key": "Environment",
"value": [
"dev",
"prod",
"stage"
]
}
],
"products": [
{
"portfolioName": "EC2 Product Profile",
"productName": "Ec2",
"owner": "owner1",
"productVersionName": "v1",
"templatePath": "../../config/templates/template1.json"
},
{
"portfolioName": "Autoscaling Product Profile",
"productName": "autoscaling",
"owner": "owner1",
"productVersionName": "v1",
"templatePath": "../../config/templates/template2.json",
"deployWithStackSets": {
"accounts": [
"012345678901",
],
"regions": [
"us-west-2"
],
"stackSetAdministrationRoleName": "AWSCloudFormationStackSetAdministrationRole",
"stackSetExecutionRoleName": "AWSCloudFormationStackSetExecutionRole"
}
}
]
}
```