Merge branch '70-improve-core-recipe-descriptions' into 'main'

Resolve "Improve descriptions for core recipes"

Closes #70

See merge request mwvaughn/aws-hpc-recipes!170

Author: mwvaughn

recipes/net/hpc_basic/assets/public-private.yaml

@@ -1,6 +1,14 @@
 ---
 AWSTemplateFormatVersion: '2010-09-09'
-Description: Create one public and one private subnet. Can create a VPC or use an existing one.
+Description: Basic VPC with Public/Private Subnets.
+  This template creates a simple VPC architecture with one public and one private subnet in a single Availability Zone.
+  The template offers flexibility by allowing you to either create a new VPC or use an existing one.
+  When creating a new VPC, it provisions an Internet Gateway for public subnet connectivity.
+  A NAT Gateway is deployed in the public subnet to enable outbound internet access for resources in the private subnet.
+  Appropriate route tables are configured to direct traffic between the subnets and the internet.
+  The template supports customizable CIDR ranges for both the VPC and subnet configurations.
+  Use this template as a starting point for creating basic two-tier architectures with public-facing and backend resources.
+  Refer to the Outputs tab of the deployed stack for important resource identifiers including VPC ID, subnet IDs, and internet gateway ID.
 
 ### Stack metadata
 Metadata:

recipes/net/hpc_large_scale/assets/main.yaml

@@ -1,5 +1,13 @@
 AWSTemplateFormatVersion: '2010-09-09'
-Description: Create public and private subnets in two or three AZs. Specified CIDR blocks allow 4096 IPs each. 
+Description: HPC-scale VPC with Multi-AZ Architecture.
+  This template creates a highly available VPC infrastructure optimized for HPC workloads across multiple Availability Zones.
+  It provisions both public and private subnets in two or optionally three AZs, with each subnet configured for 4096 IP addresses.
+  The template sets up NAT Gateways and Internet Gateway for secure outbound connectivity from private subnets.
+  VPC Flow Logs are enabled and directed to CloudWatch for comprehensive network traffic monitoring.
+  An S3 VPC Endpoint is configured to allow private subnet resources to access S3 without traversing the internet.
+  A VPC-wide security group is created to enable communication between resources within the VPC.
+  Use this template as a foundation for creating custom launch templates tailored to your specific HPC infrastructure requirements.
+  Refer to the Outputs tab of the deployed stack for important resource identifiers including VPC ID, subnet IDs, security group ID, and internet gateway ID.
 
 Metadata:
   AWS::CloudFormation::Interface:

recipes/net/hpc_zonal_networking/assets/network.cfn.yaml

@@ -6,8 +6,13 @@
 # Authors: J. Lowell Wofford <jlowellw@amazon.com>, Matthew Vaughn <mwvaughn@amazon.com>
 
 AWSTemplateFormatVersion: '2010-09-09'
-Description: >
-  Creates a 4-zone subnet structure for NIST 800-223-aligned HPC networking. Each AZ is allocated separate Access, Management, Storage, and Compute subnets corresponding to the 4 security zones. See https://csrc.nist.gov/pubs/sp/800/223/final for details. 
+Description: NIST 800-223 Aligned HPC Network Architecture.
+  This template creates separate Access, Management, Storage, and Compute subnets aligned with NIST SP 800-223 security zones (https://csrc.nist.gov/pubs/sp/800/223/final).
+  It automatically selects Availability Zones with HPC instance support and provides optional backup AZ subnets for high availability.
+  External connectivity can be configured through transit gateway, direct access, or full isolation modes.
+  NAT Gateways and route tables enforce proper network segmentation between zones.
+  Use this template as a foundation for building NIST-compliant HPC environments.
+  Refer to the Outputs tab for IDs of all created network resources.
 
 Parameters:
 

recipes/pcluster/latest/assets/launch.yaml

@@ -1,6 +1,11 @@
 AWSTemplateFormatVersion: '2010-09-09'
-Description: >
-  Deploy a demo of the latest AWS ParallelCluster release. 
+Description: AWS ParallelCluster Demo Environment.
+  This template deploys a demonstration HPC cluster using the latest AWS ParallelCluster release with key enterprise features.
+  It creates a VPC with public/private subnets, a head node with DCV support, and a dynamically scaling Slurm compute fleet.
+  The cluster supports multiple architectures (x86, Graviton, GPU) and operating systems with configurable queue sizes.
+  Shared storage is implemented through either EFS or EBS, with SSM integration for simplified access.
+  Use this template as a foundation for evaluating ParallelCluster capabilities and features.
+  Refer to the Outputs tab for the head node IP address and Systems Manager access URL.
 
 ### Stack metadata
 Metadata:

recipes/pcs/try_amd/assets/cluster.cfn.yaml

@@ -1,6 +1,12 @@
 AWSTemplateFormatVersion: '2010-09-09'
 Transform: AWS::Serverless-2016-10-31
-Description: Get started with AWS PCS and Amazon EC2 instances with AMD processors
+Description: AWS PCS Getting Started Environment with AMD Instances.
+  This template deploys a demonstration cluster using AMD-based instances and AWS Parallel Computing Service (PCS).
+  It configures a multi-tier network with FSx Lustre and EFS storage, EFA-enabled instances, and auto-scaling Slurm queues.
+  The cluster includes a login node (c7a.xlarge) and two compute queues - high-performance (hpc7a.48xlarge) and general purpose (c7a.xlarge).
+  Network security is managed through security groups with client IP restrictions and EFA support.
+  Use this template as a starting point for evaluating AWS PCS capabilities with AMD processors.
+  Refer to the Outputs tab for cluster access URLs and SSH key pair information.
 
 ### Stack metadata
 Metadata:

recipes/pcs/try_graviton/assets/cluster.cfn.yaml

@@ -1,6 +1,12 @@
 AWSTemplateFormatVersion: '2010-09-09'
 Transform: AWS::Serverless-2016-10-31
-Description: Get started with AWS PCS and Amazon EC2 instances with Graviton processors
+Description: AWS PCS Getting Started Environment with Graviton Instances.
+  This template deploys a demonstration cluster using Graviton-based instances and AWS Parallel Computing Service (PCS).
+  It configures a multi-tier network with FSx Lustre and EFS storage, EFA-enabled instances, and an auto-scaling Slurm queue.
+  The cluster includes a login node (c7g.2xlarge) and a compute queue with high-performance instances (hpc7g.16xlarge).
+  Network security is managed through security groups with client IP restrictions and EFA support.
+  Use this template as a starting point for evaluating AWS PCS capabilities with Graviton processors.
+  Refer to the Outputs tab for cluster access URLs and SSH key pair information.
 
 ### Stack metadata
 Metadata:

recipes/storage/efs_simple/assets/main.yaml

@@ -1,5 +1,11 @@
 AWSTemplateFormatVersion: '2010-09-09'
-Description: Creates an EFS filesystem, mount targets, and a client security group for access to the filesystem
+Description: EFS Filesystem with Multi-AZ Mount Targets.
+  This template creates an Amazon EFS filesystem with configurable mount targets across multiple Availability Zones.
+  It supports encrypted data at rest, enforced TLS for data in transit, and automatic backups through AWS Backup.
+  Security is managed through dedicated security groups that control NFS access to the filesystem.
+  Throughput can be configured for either bursting or elastic modes to match workload requirements.
+  Use this template as a foundation for deploying shared storage solutions with customized security and performance settings.
+  Refer to the Outputs tab for the filesystem ID and security group ID needed to mount the filesystem.
 
 Metadata:
   AWS::CloudFormation::Interface:

recipes/storage/fsx_lustre/assets/persistent.yaml

@@ -1,5 +1,11 @@
 AWSTemplateFormatVersion: '2010-09-09'
-Description: Creates a PERSISTENT_2 FSx for Lustre filesystem and a client security group for access to the filesystem
+Description: FSx for Lustre PERSISTENT_2 Filesystem.
+  This template creates a persistent FSx for Lustre filesystem optimized for high-performance workloads.
+  It configures a single-AZ deployment with customizable storage capacity, throughput, and compression settings.
+  Security groups are configured to enable required Lustre network ports (988, 1021-1023) between clients and servers.
+  The filesystem supports Lustre versions 2.12 and 2.15 with LZ4 compression for optimized storage efficiency.
+  Use this template as a foundation for deploying high-performance shared storage solutions.
+  Refer to the Outputs tab for the filesystem ID, mount name, and security group ID needed to mount the filesystem.
 
 ### Stack metadata
 Metadata:

recipes/storage/fsx_lustre/assets/scratch.yaml

@@ -1,5 +1,11 @@
 AWSTemplateFormatVersion: '2010-09-09'
-Description: Creates a SCRATCH FSx for Lustre filesystem and a client security group for access to the filesystem
+Description: FSx for Lustre SCRATCH_2 Filesystem.
+  This template creates a scratch FSx for Lustre filesystem optimized for temporary high-performance workloads.
+  It configures a single-AZ deployment with customizable storage capacity and compression settings.
+  Security groups are configured to enable required Lustre network ports (988, 1021-1023) between clients and servers.
+  The filesystem supports Lustre versions 2.12 and 2.15 with LZ4 compression for optimized storage efficiency.
+  Use this template as a foundation for deploying high-performance temporary storage solutions.
+  Refer to the Outputs tab for the filesystem ID, mount name, and security group ID needed to mount the filesystem.
 
 ### Stack metadata
 Metadata:

recipes/storage/fsx_ontap/assets/main.yaml

@@ -1,5 +1,11 @@
 AWSTemplateFormatVersion: '2010-09-09'
-Description: Creates a basic Single-AZ FSx for NetApp ONTAP file system and a storage virtual machine with a non-root volume.
+Description: FSx for NetApp ONTAP Single-AZ Filesystem.
+  This template creates a Single-AZ FSx for ONTAP filesystem with a storage virtual machine and non-root volume.
+  It supports FLEXVOL or FLEXGROUP volume types with customizable storage capacity and throughput settings.
+  Optional Active Directory integration enables Windows SMB client access with automatic CIFS share creation.
+  Security groups are configured to enable required NFS/SMB ports with client CIDR-based access control.
+  Use this template as a foundation for deploying enterprise storage solutions with NetApp ONTAP features.
+  Refer to the Outputs tab for filesystem, storage virtual machine, volume, and security group IDs.
 
 Metadata:
   AWS::CloudFormation::Interface: