Merge branch '69-improve-getting-started-cfn' into 'main'

mwvaughn · mwvaughn · commit 30d4098b8cf9 · 2025-02-18T20:41:07.000Z
Resolve "Improve Getting Started Cfn asset descriptions, instructions"

Closes #69

See merge request mwvaughn/aws-hpc-recipes!169
diff --git a/recipes/pcs/getting_started/assets/cfn-pcs-lt-efs-fsxl.yaml b/recipes/pcs/getting_started/assets/cfn-pcs-lt-efs-fsxl.yaml
@@ -1,5 +1,10 @@
 AWSTemplateFormatVersion: 2010-09-09
-Description: Launch templates for AWS PCS login and compute node groups, supporting shared EFS and FSx for Lustre file systems
+Description: EC2 launch templates for AWS PCS login and compute node groups.
+  This template creates EC2 launch templates for AWS PCS login and compute node groups. 
+  It demonstrates mounting EFS and FSx for Lustre file systems, configuring EC2 instance tags, enabling Instance Metadata Service Version 2 (IMDSv2), and setting up the cluster security group for communication with the AWS PCS controller. 
+  Additionally, it shows how to configure inbound SSH access to the login nodes. 
+  Use this template as a starting point to create custom launch templates tailored to your specific requirements.
+  Check the Outputs tab of this stack for useful details about resources created by this template.
 
 Metadata:
   AWS::CloudFormation::Interface:
diff --git a/recipes/pcs/getting_started/assets/cluster.yaml b/recipes/pcs/getting_started/assets/cluster.yaml
@@ -1,6 +1,11 @@
 AWSTemplateFormatVersion: '2010-09-09'
 Transform: AWS::Serverless-2016-10-31
-Description: AWS Parallel Computing Service "getting started" cluster
+Description: AWS PCS "Getting Started" cluster. 
+  This template deploys a small HPC cluster with 1 login node and up to 4 compute nodes.  
+  It includes an EFS file system for shared storage and an FSx for Lustre file system for high-speed temporary storage.  
+  The cluster is deployed in a new VPC with both public and private subnets.  
+  It can be accessed via the browser using AWS Systems Manager Session Manager or over the internet via SSH.  
+  To access the cluster, check the Outputs tab of this stack for relevant links.  
 
 ### Stack metadata
 Metadata:
@@ -30,7 +35,7 @@ Parameters:
     AllowedValues:
       - x86
       - Graviton
-    Description: Architecture of the login and compute node instances
+    Description: Processor architecture for the login and compute node instances
 
   SlurmVersion:
     Type: String
@@ -41,12 +46,12 @@ Parameters:
          - 24.05
 
   KeyName:
-    Description: KeyPair to login to the head node
+    Description: SSH keypair to log in to the head node
     Type: AWS::EC2::KeyPair::KeyName
     AllowedPattern: ".+"  # Required
 
   ClientIpCidr:
-    Description: IP(s) allowed to directly access the login nodes. 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/)
+    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})
diff --git a/recipes/pcs/getting_started/assets/pcs-cfn.yaml b/recipes/pcs/getting_started/assets/pcs-cfn.yaml
diff --git a/recipes/pcs/getting_started/assets/pcs-cluster-sg.yaml b/recipes/pcs/getting_started/assets/pcs-cluster-sg.yaml
@@ -1,5 +1,8 @@
 AWSTemplateFormatVersion: 2010-09-09
-Description: Security group for communications between AWS PCS controller, compute nodes, and client nodes, plus optional inbound SSH security group.
+Description: Security group for AWS PCS clusters.
+  This template creates a self-referencing security group that enables communications between AWS PCS controller, compute nodes, and client nodes.
+  Optionally, it can also create a security group to enable SSH access to the cluster.
+  Check the Outputs tab of this stack for useful details about resources created by this template.
 
 Metadata:
   AWS::CloudFormation::Interface:
diff --git a/recipes/pcs/getting_started/assets/pcs-iip-minimal.yaml b/recipes/pcs/getting_started/assets/pcs-iip-minimal.yaml
@@ -1,5 +1,9 @@
 AWSTemplateFormatVersion: 2010-09-09
-Description: Minimal IAM instance profile for AWS PCS compute node groups
+Description: Minimal IAM instance profile for AWS PCS compute node groups.
+  This template creates an IAM instance profile with a role that has the minimum required permissions for AWS PCS compute node groups.
+  Optionally, the profile can be configured to enable the following services on PCS-managed instances:
+  AWS Systems Manager, Amazon S3 (read-only access), Amazon CloudWatch Agent.
+  Check the Outputs tab of this stack for useful details about resources created by this template.
 
 Metadata:
   AWS::CloudFormation::Interface:
diff --git a/recipes/pcs/getting_started/assets/pcs-lt-efs-fsxl.yaml b/recipes/pcs/getting_started/assets/pcs-lt-efs-fsxl.yaml
@@ -1,5 +1,10 @@
 AWSTemplateFormatVersion: 2010-09-09
-Description: Launch templates for AWS PCS login and compute node groups, supporting shared EFS and FSx for Lustre file systems
+Description: EC2 launch templates for AWS PCS login and compute node groups.
+  This template creates EC2 launch templates for AWS PCS login and compute node groups. 
+  It demonstrates mounting EFS and FSx for Lustre file systems, configuring EC2 instance tags, enabling Instance Metadata Service Version 2 (IMDSv2), and setting up the cluster security group for communication with the AWS PCS controller. 
+  Additionally, it shows how to configure inbound SSH access to the login nodes. 
+  Use this template as a starting point to create custom launch templates tailored to your specific requirements.
+  Check the Outputs tab of this stack for useful details about resources created by this template.
 
 Metadata:
   AWS::CloudFormation::Interface:
diff --git a/recipes/pcs/getting_started/assets/pcs-lt-efs.yaml b/recipes/pcs/getting_started/assets/pcs-lt-efs.yaml
@@ -1,5 +1,9 @@
 AWSTemplateFormatVersion: 2010-09-09
-Description: Create a launch template to support a PCS compute node group mounting EFS
+Description: EC2 launch templates for AWS PCS compute node groups.
+  This template creates EC2 launch templates for AWS PCS compute node groups. 
+  It demonstrates mounting an EFS file system, configuring EC2 instance tags, enabling Instance Metadata Service Version 2 (IMDSv2), and setting up the cluster security group for communication with the AWS PCS controller. 
+  Use this template as a starting point to create custom launch templates tailored to your specific requirements.
+  Check the Outputs tab of this stack for useful details about resources created by this template.
 
 Metadata:
   AWS::CloudFormation::Interface:
diff --git a/recipes/pcs/getting_started/assets/pcs-lt-simple.yaml b/recipes/pcs/getting_started/assets/pcs-lt-simple.yaml
@@ -1,5 +1,9 @@
 AWSTemplateFormatVersion: 2010-09-09
-Description: Simple launch template for an AWS PCS compute node group
+Description: Minimal EC2 launch template for an AWS PCS compute node group.
+  This template creates a minimal EC2 launch template for AWS PCS compute node groups.
+  It demonstrates how to configure EC2 instance tags, IMDSv2, and the cluster security group needed to communicate with the AWS PCS controller.
+  You can use it as a starting point for creating a custom launch template to meet your specific needs.
+  Check the Outputs tab of this stack for useful details about resources created by this template.
 
 Metadata:
   AWS::CloudFormation::Interface:
