View a markdown version of this page

Reviewing environment variables reference - Amazon SageMaker AI
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Reviewing environment variables reference

The following environment variables are defined and used in the tutorial of Setting up multiple controller nodes for a SageMaker HyperPod Slurm cluster. These environment variables are only available in the current session unless explicitly preserved. They are defined using the $variable_name syntax. Variables with key/value pairs represent Amazon-created resources, while variables without keys are user-defined.

Environment variables reference
Variable Description
$BACKUP_SUBNET

  • Example key: BackupPrivateSubnet

  • Example value: subnet-04a8ab51748510a51

  • Description: The backup private subnet ID used for HyperPod Slurm cluster creation.
$COMPUTE_IG_NAME

  • Example value: compute-nodes

  • Description: The name of the compute instance group used for cluster creation.
$COMPUTE_NODE_ROLE

  • Example key: AmazonSagemakerClusterExecutionRoleArn

  • Example value: arn:aws:iam::111122223333:role/sagemaker-hyperpod-AmazonSagemakerClusterExecutionR-123OTacPcKk1

  • Description: The Amazon Resource Name (ARN) of the IAM role for the compute instance group.
$CONTOLLER_IG_NAME

  • Example value: controller-machine

  • Description: The name of the controller instance group for cluster creation.
$DB_USER_NAME
$EMAIL
$PRIMARY_SUBNET

  • Example key: PrimaryPrivateSubnet

  • Example value: subnet-01a56ebc42df102a7

  • Description: The primary private subnet ID used for HyperPod Slurm cluster creation.
$POLICY

  • Example value: arn:aws:iam::111122223333:policy/AmazonSagemakerExecutionPolicy

  • Description: The IAM policy ARN you create and attach to the Slurm execution role for the controller instance group.
$REGION

  • Example value: us-east-1

  • Description: The Amazon Web Services Region where you create all the resources.
$ROOT_BUCKET_NAME

  • Example key: SecurityGroup

  • Example value: sagemaker-lifecycle-ab214000

  • Description: The name of the Amazon S3 bucket where lifecycle scripts are uploaded.
$SECURITY_GROUP
$SLURM_DB_ENDPOINT_ADDRESS

  • Example key: SlurmDBEndpointAddress

  • Example value: sagemaker-hyperpod-mh-slurmdbinstance-sxcmatjv0ei0.clplgxt06ysb.us-east-1.rds.amazonaws.com

  • Description: The Amazon RDS database endpoint used in cluster creation.
$SLURM_DB_SECRET_ARN

  • Example key: SlurmDBSecretArn

  • Example value: arn:aws:secretsmanager:us-east-1:111122223333:secret:sagemaker-hyperpod-mh-db-secret-us-east-1-dmz72K

  • Description: The database secret ARN used in cluster creation.
$SLURM_EXECUTION_ROLE_ARN

  • Example key: SlurmExecutionRoleArn

  • Example value: arn:aws:iam::111122223333:role/sagemaker-hyperpod-mhSlurmExecutionRole-us-east-1

  • Description: The IAM role ARN for the controller instance group, used in cluster creation.
$SLURM_FSX_DNS_NAME
$SLURM_FSX_MOUNT_NAME
$SLURM_SNS_FAILOVER_TOPIC_ARN

  • Example key: SlurmFailOverSNSTopicArn

  • Example value: arn:aws:sns:us-east-1:111122223333:sagemaker-hyperpod-mhSlurmFailOverTopic-us-east-1

  • Description: The Amazon SNS topic ARN, used in Create configuration file.