翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# PCS AWS 用の CloudFormation テンプレートの一部
CloudFormation テンプレートには、それぞれが特定の目的を果たす 1 つ以上のセクションがあります。 は、テンプレート内の標準形式、構文、言語 CloudFormation を定義します。詳細については、「*AWS CloudFormation ユーザーガイド*」の「[CloudFormation テンプレートの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-guide.html)」を参照してください。
CloudFormation テンプレートは高度にカスタマイズ可能であるため、形式は異なる場合があります。CloudFormation テンプレートの必要な部分を理解して PCS AWS クラスターを作成するには、提供されているサンプルテンプレートを調べてサンプルクラスターを作成することをお勧めします。このトピックでは、そのサンプルテンプレートのセクションを簡単に説明します。
**重要**
このトピックのコードサンプルは**完了していません**。省略記号 (`[...]`) は、表示されない追加のコードがあることを示します。完全な YAML 形式の CloudFormation テンプレートをダウンロードするには、「」を参照してください[CloudFormation サンプル PCS AWS クラスターを作成するための テンプレート](get-started-cfn-sample-templates.md)。
**Contents**
+ [ヘッダー](#get-started-cfn-template-parts-header)
+ [メタデータ](#get-started-cfn-template-parts-metadata)
+ [パラメータ](#get-started-cfn-template-parts-parameters)
+ [Mappings](#get-started-cfn-template-parts-mappings)
+ [リソース](#get-started-cfn-template-parts-resources)
+ [アウトプット](#get-started-cfn-template-parts-outputs)
## ヘッダー
```
AWSTemplateFormatVersion: '2010-09-09'
Transform: AWS::Serverless-2016-10-31
Description: AWS Parallel Computing Service "getting started" cluster
```
`AWSTemplateFormatVersion` は、テンプレートが準拠するテンプレート形式バージョンを識別します。詳細については、「 *AWS CloudFormation ユーザーガイド*」の[CloudFormation テンプレート形式のバージョン構文](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/format-version-structure.html)」を参照してください。
`Transform` は、CloudFormation がテンプレートの処理に使用するマクロを指定します。詳細については、「 *AWS CloudFormation ユーザーガイド*」の[CloudFormation テンプレート変換」セクション](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html)を参照してください。`AWS::Serverless-2016-10-31` 変換により、 CloudFormation は AWS Serverless Application Model (AWS SAM) 構文で記述されたテンプレートを処理できます。詳細については、「 *AWS CloudFormation ユーザーガイド*」の[`AWS::Serverless`「変換](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html)」を参照してください。
## メタデータ
```
### Stack metadata
Metadata:
AWS::CloudFormation::Interface:
ParameterGroups:
- Label:
default: PCS Cluster configuration
Parameters:
- SlurmVersion
- ManagedAccounting
- AccountingPolicyEnforcement
- Label:
default: PCS ComputeNodeGroups configuration
Parameters:
- NodeArchitecture
- KeyName
- ClientIpCidr
- Label:
default: HPC Recipes configuration
Parameters:
- HpcRecipesS3Bucket
- HpcRecipesBranch
```
CloudFormation テンプレートの `metadata`セクションには、テンプレート自体に関する情報が表示されます。サンプルテンプレートは、PCS を使用する完全なハイパフォーマンスコンピューティング (HPC) AWS クラスターを作成します。サンプルテンプレートのメタデータセクションは、 が対応するスタック CloudFormation を起動 (プロビジョニング) する方法を制御するパラメータを宣言します。アーキテクチャの選択 (`NodeArchitecture`)、Slurm バージョン (`SlurmVersion`)、アクセスコントロール (`KeyName` および ) を制御するパラメータがあります`ClientIpCidr`。
## パラメータ
このセクションでは、テンプレートのカスタムパラメータ`Parameters`を定義します。 CloudFormation は、これらのパラメータ定義を使用して、このテンプレートからスタックを起動するときに操作するフォームを構築および検証します。
```
Parameters:
NodeArchitecture:
Type: String
Default: x86
AllowedValues:
- x86
- Graviton
Description: Processor architecture for the login and compute node instances
SlurmVersion:
Type: String
Default: 25.05
Description: Version of Slurm to use
AllowedValues:
- 24.11
- 25.05
ManagedAccounting:
Type: String
Default: 'disabled'
AllowedValues:
- 'enabled'
- 'disabled'
Description: Monitor cluster usage, manage access control, and enforce resource limits with Slurm accounting. Requires Slurm 24.11 or newer.
AccountingPolicyEnforcement:
Description: Specify which Slurm accounting policies to enforce
Type: String
Default: none
AllowedValues:
- none
- 'associations,limits,safe'
KeyName:
Description: SSH keypair to log in to the head node
Type: AWS::EC2::KeyPair::KeyName
AllowedPattern: ".+" # Required
ClientIpCidr:
Description: IP(s) allowed to access the login node over SSH. We recommend that you restrict it with your own IP/subnet (x.x.x.x/32 for your own ip or x.x.x.x/24 for range. Replace x.x.x.x with your own PUBLIC IP. You can get your public IP using tools such as https://ifconfig.co/)
Default: 127.0.0.1/32
Type: String
AllowedPattern: (\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/(\d{1,2})
ConstraintDescription: Value must be a valid IP or network range of the form x.x.x.x/x.
HpcRecipesS3Bucket:
Type: String
Default: aws-hpc-recipes
Description: HPC Recipes for AWS S3 bucket
AllowedValues:
- aws-hpc-recipes
- aws-hpc-recipes-dev
HpcRecipesBranch:
Type: String
Default: main
Description: HPC Recipes for AWS release branch
AllowedPattern: '^(?!.*/\.git$)(?!.*/\.)(?!.*\\.\.)[a-zA-Z0-9-_\.]+$'
```
## Mappings
このセクションでは、特定の条件または依存関係に基づいて値を指定するキーと値のペア`Mappings`を定義します。
```
Mappings:
Architecture:
AmiArchParameter:
Graviton: arm64
x86: x86_64
LoginNodeInstances:
Graviton: c7g.xlarge
x86: c6i.xlarge
ComputeNodeInstances:
Graviton: c7g.xlarge
x86: c6i.xlarge
```
## リソース
このセクションでは、スタックの一部としてプロビジョニングおよび設定する AWS リソースを`Resources`宣言します。
```
Resources:
[...]
```
テンプレートは、サンプルクラスターインフラストラクチャをレイヤーにプロビジョニングします。VPC 設定`Networking`の場合は で始まります。ストレージは、共有ストレージ`EfsStorage`用と高性能ストレージ`FSxLStorage`用のデュアルシステムによって提供されます。コアクラスターは を通じて確立されます`PCSCluster`。
```
Networking:
Type: AWS::CloudFormation::Stack
Properties:
Parameters:
ProvisionSubnetsC: "False"
TemplateURL: !Sub 'https://${HpcRecipesS3Bucket}.s3.amazonaws.com/${HpcRecipesBranch}/recipes/net/hpc_large_scale/assets/main.yaml'
EfsStorage:
Type: AWS::CloudFormation::Stack
Properties:
Parameters:
SubnetIds: !GetAtt [ Networking, Outputs.DefaultPrivateSubnet ]
SubnetCount: 1
VpcId: !GetAtt [ Networking, Outputs.VPC ]
TemplateURL: !Sub 'https://${HpcRecipesS3Bucket}.s3.amazonaws.com/${HpcRecipesBranch}/recipes/storage/efs_simple/assets/main.yaml'
FSxLStorage:
Type: AWS::CloudFormation::Stack
Properties:
Parameters:
PerUnitStorageThroughput: 125
SubnetId: !GetAtt [ Networking, Outputs.DefaultPrivateSubnet ]
VpcId: !GetAtt [ Networking, Outputs.VPC ]
TemplateURL: !Sub 'https://${HpcRecipesS3Bucket}.s3.amazonaws.com/${HpcRecipesBranch}/recipes/storage/fsx_lustre/assets/persistent.yaml'
[...]
# Cluster
PCSCluster:
Type: AWS::PCS::Cluster
Properties:
Name: !Sub '${AWS::StackName}'
Size: SMALL
Scheduler:
Type: SLURM
Version: !Ref SlurmVersion
Networking:
SubnetIds:
- !GetAtt [ Networking, Outputs.DefaultPrivateSubnet ]
SecurityGroupIds:
- !GetAtt [ PCSSecurityGroup, Outputs.ClusterSecurityGroupId ]
```
コンピューティングリソースの場合、テンプレートは 2 つのノードグループを作成します。1 つのログインノード`PCSNodeGroupLogin`用と最大 4 つのコンピューティングノード`PCSNodeGroupCompute`用です。これらのノードグループは、 アクセス許可とインスタンス設定`PCSInstanceProfile`のために `PCSLaunchTemplate` でサポートされています。
```
# Compute Node groups
PCSInstanceProfile:
Type: AWS::CloudFormation::Stack
Properties:
Parameters:
# We have to regionalize this in case CX use the template in more than one region. Otherwise,
# the create action will fail since instance-role-${AWS::StackName} already exists!
RoleName: !Sub '${AWS::StackName}-${AWS::Region}'
TemplateURL: !Sub 'https://${HpcRecipesS3Bucket}.s3.amazonaws.com/${HpcRecipesBranch}/recipes/pcs/getting_started/assets/pcs-iip-minimal.yaml'
PCSLaunchTemplate:
Type: AWS::CloudFormation::Stack
Properties:
Parameters:
VpcDefaultSecurityGroupId: !GetAtt [ Networking, Outputs.SecurityGroup ]
ClusterSecurityGroupId: !GetAtt [ PCSSecurityGroup, Outputs.ClusterSecurityGroupId ]
SshSecurityGroupId: !GetAtt [ PCSSecurityGroup, Outputs.InboundSshSecurityGroupId ]
EfsFilesystemSecurityGroupId: !GetAtt [ EfsStorage, Outputs.SecurityGroupId ]
FSxLustreFilesystemSecurityGroupId: !GetAtt [ FSxLStorage, Outputs.FSxLustreSecurityGroupId ]
SshKeyName: !Ref KeyName
EfsFilesystemId: !GetAtt [ EfsStorage, Outputs.EFSFilesystemId ]
FSxLustreFilesystemId: !GetAtt [ FSxLStorage, Outputs.FSxLustreFilesystemId ]
FSxLustreFilesystemMountName: !GetAtt [ FSxLStorage, Outputs.FSxLustreMountName ]
TemplateURL: !Sub 'https://${HpcRecipesS3Bucket}.s3.amazonaws.com/${HpcRecipesBranch}/recipes/pcs/getting_started/assets/cfn-pcs-lt-efs-fsxl.yaml'
# Compute Node groups - Login Nodes
PCSNodeGroupLogin:
Type: AWS::PCS::ComputeNodeGroup
Properties:
ClusterId: !GetAtt [PCSCluster, Id]
Name: login
ScalingConfiguration:
MinInstanceCount: 1
MaxInstanceCount: 1
IamInstanceProfileArn: !GetAtt [ PCSInstanceProfile, Outputs.InstanceProfileArn ]
CustomLaunchTemplate:
TemplateId: !GetAtt [ PCSLaunchTemplate, Outputs.LoginLaunchTemplateId ]
Version: 1
SubnetIds:
- !GetAtt [ Networking, Outputs.DefaultPublicSubnet ]
AmiId: !GetAtt [PcsSampleAmi, AmiId]
InstanceConfigs:
- InstanceType: !FindInMap [ Architecture, LoginNodeInstances, !Ref NodeArchitecture ]
# Compute Node groups - Compute Nodes
PCSNodeGroupCompute:
Type: AWS::PCS::ComputeNodeGroup
Properties:
ClusterId: !GetAtt [PCSCluster, Id]
Name: compute-1
ScalingConfiguration:
MinInstanceCount: 0
MaxInstanceCount: 4
IamInstanceProfileArn: !GetAtt [ PCSInstanceProfile, Outputs.InstanceProfileArn ]
CustomLaunchTemplate:
TemplateId: !GetAtt [ PCSLaunchTemplate, Outputs.ComputeLaunchTemplateId ]
Version: 1
SubnetIds:
- !GetAtt [ Networking, Outputs.DefaultPrivateSubnet ]
AmiId: !GetAtt [PcsSampleAmi, AmiId]
InstanceConfigs:
- InstanceType: !FindInMap [ Architecture, ComputeNodeInstances, !Ref NodeArchitecture ]
```
ジョブのスケジュールは、 を通じて処理されます`PCSQueueCompute`。
```
PCSQueueCompute:
Type: AWS::PCS::Queue
Properties:
ClusterId: !GetAtt [PCSCluster, Id]
Name: demo
ComputeNodeGroupConfigurations:
- ComputeNodeGroupId: !GetAtt [PCSNodeGroupCompute, Id]
```
AMI の選択は、PcsAMILookupFn Lambda 関数および関連リソースを介して自動的に行われます。
```
PcsAMILookupRole:
Type: AWS::IAM::Role
[...]
PcsAMILookupFn:
Type: AWS::Lambda::Function
Properties:
Runtime: python3.12
Handler: index.handler
Role: !GetAtt PcsAMILookupRole.Arn
Code:
[...]
Timeout: 30
MemorySize: 128
# Example of using the custom resource to look up an AMI
PcsSampleAmi:
Type: Custom::AMILookup
Properties:
ServiceToken: !GetAtt PcsAMILookupFn.Arn
OperatingSystem: 'amzn2'
Architecture: !FindInMap [ Architecture, AmiArchParameter, !Ref NodeArchitecture ]
SlurmVersion: !Ref SlurmVersion
```
## アウトプット
テンプレートは`ClusterId`、、、`PcsConsoleUrl`および を介してクラスター識別および管理 URLs を出力します`Ec2ConsoleUrl`。
```
Outputs:
ClusterId:
Description: The Id of the PCS cluster
Value: !GetAtt [ PCSCluster, Id ]
PcsConsoleUrl:
Description: URL to access the cluster in the PCS console
Value: !Sub
- https://${ConsoleDomain}/pcs/home?region=${AWS::Region}#/clusters/${ClusterId}
- { ConsoleDomain: !If [ GovCloud, 'console.amazonaws-us-gov.com', !If [ China, 'console.amazonaws.cn', !Sub '${AWS::Region}.console.aws.amazon.com']],
ClusterId: !GetAtt [ PCSCluster, Id ]
}
Export:
Name: !Sub ${AWS::StackName}-PcsConsoleUrl
Ec2ConsoleUrl:
Description: URL to access instance(s) in the login node group via Session Manager
Value: !Sub
- https://${ConsoleDomain}/ec2/home?region=${AWS::Region}#Instances:instanceState=running;tag:aws:pcs:compute-node-group-id=${NodeGroupLoginId}
- { ConsoleDomain: !If [ GovCloud, 'console.amazonaws-us-gov.com', !If [ China, 'console.amazonaws.cn', !Sub '${AWS::Region}.console.aws.amazon.com']],
NodeGroupLoginId: !GetAtt [ PCSNodeGroupLogin, Id ]
}
Export:
Name: !Sub ${AWS::StackName}-Ec2ConsoleUrl
```