AWS parallelcluster documentation change
Summary
Clarified munge key rotation steps
Security assessment
Minor phrasing change to existing security-related process (munge key management) but does not add new security documentation.
Diff
diff --git a/parallelcluster/latest/ug/Scheduling-v3.md b/parallelcluster/latest/ug/Scheduling-v3.md index 225d11382..de0e39086 100644 --- a//parallelcluster/latest/ug/Scheduling-v3.md +++ b//parallelcluster/latest/ug/Scheduling-v3.md @@ -569 +569 @@ The type of the compute resources that the Slurm queue uses. Supported values ar -If you set the `CapacityType` to `SPOT`, your account must have an `AWSServiceRoleForEC2Spot` service-linked role. You can create this role by using the following AWS CLI command. +If you set the `CapacityType` to `SPOT`, your account must have an `AWSServiceRoleForEC2Spot` service-linked role. You can use the following AWS CLI command to create this role. @@ -594 +594 @@ Default: `lowest-price` - * If you use `CapacityType = SPOT`, Amazon EC2 Fleet launches instances from the lowest price Spot Instance pool that has available capacity. If a pool runs out of capacity before fulfilling your required capacity, Amazon EC2 Fleet fulfills your request by launching instances for you. In particular, Amazon EC2 Fleet launches instances from the lowest price Spot Instance pool that has available capacity. Amazon EC2 Fleet might launch Spot Instances from several different pools. + * If you use `CapacityType = SPOT`, Amazon EC2 Fleet launches instances from the lowest price Spot Instance pool that has available capacity. If a pool runs out of capacity before it fulfills your required capacity, Amazon EC2 Fleet fulfills your request by launching instances for you. In particular, Amazon EC2 Fleet launches instances from the lowest price Spot Instance pool that has available capacity. Amazon EC2 Fleet might launch Spot Instances from several different pools. @@ -657 +657 @@ You can only specify Slurm configuration parameters that aren't deny-listed in ` -AWS ParallelCluster only checks whether a parameter is in a deny list. AWS ParallelCluster doesn't validate your custom Slurm configuration parameter syntax or semantics. You are responsible for validating your custom Slurm configuration parameters. Invalid custom Slurm configuration parameters can cause Slurm daemon failures that can lead to cluster create and update failures. +AWS ParallelCluster only checks whether a parameter is in a deny list. AWS ParallelCluster doesn't validate your custom Slurm configuration parameter syntax or semantics. It is your responsibility to validate your custom Slurm configuration parameters. Invalid custom Slurm configuration parameters can cause Slurm daemon failures that can lead to cluster create and update failures. @@ -741 +741 @@ At the end of the health check, the `Gpu` health check restores these services a - * If a compute node receives 2 or more `Gpu` health check requests at the same time, only the first health check runs and the others are skipped. This is also the case for health checks targeting node GPUs. You can check the log files for additional information regarding this situation. + * If a compute node receives 2 or more `Gpu` health check requests at the same time, only the first health check runs and the others are skipped. This is also the case for health checks that target node GPUs. You can check the log files for additional information regarding this situation. @@ -843 +843 @@ For AWS ParallelCluster 3 versions prior to version 3.3.1: -Changing this parameter and updating a cluster creates a new managed FSx for Lustre file system and deletes the existing managed FSx for Lustre file system without preserving the existing data. This results in data loss. Before you proceed, make sure you back up the data from the existing FSx for Lustre file system if you want to preserve data. For more information, see [Working with backups](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html) in the _FSx for Lustre User Guide_. +If you change this parameter and update a cluster this creates a new managed FSx for Lustre file system and deletes the existing managed FSx for Lustre file system without preserving the existing data. This results in data loss. Before you proceed, make sure you back up the data from the existing FSx for Lustre file system if you want to preserve data. For more information, see [Working with backups](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html) in the _FSx for Lustre User Guide_. @@ -875 +875 @@ For AWS ParallelCluster 3 versions prior to version 3.3.0: -Changing this parameter and updating a cluster creates a new managed FSx for Lustre file system and deletes the existing managed FSx for Lustre file system without preserving the existing data. This results in data loss. Make sure to back up the data from the existing FSx for Lustre file system if you want to preserve data. For more information, see [Working with backups](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html) in the _FSx for Lustre User Guide_. +If you change this parameter and update a cluster this creates a new managed FSx for Lustre file system and deletes the existing managed FSx for Lustre file system without preserving the existing data. This results in data loss. Make sure to back up the data from the existing FSx for Lustre file system if you want to preserve data. For more information, see [Working with backups](https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html) in the _FSx for Lustre User Guide_. @@ -1185 +1185 @@ The maximum number of instances that the Slurm compute resource uses. The defaul -When using `CapacityType = CAPACITY_BLOCK`, `MaxCount` must be equal to `MinCount` and greater than 0, because all the instances part of the Capacity Block reservation are managed as static nodes. +When you use `CapacityType = CAPACITY_BLOCK`, `MaxCount` must be equal to `MinCount` and greater than 0, because all the instances part of the Capacity Block reservation are managed as static nodes. @@ -1187 +1187 @@ When using `CapacityType = CAPACITY_BLOCK`, `MaxCount` must be equal to `MinCoun -At cluster creation time, the head node waits for all the static nodes to be ready before signaling the success of cluster creation. However, when using `CapacityType = CAPACITY_BLOCK`, the nodes part of the compute resources associated to Capacity Blocks won’t be considered for this check. The cluster will be created even if not all the configured Capacity Blocks are active. +At cluster creation time, the head node waits for all the static nodes to be ready before signaling the success of cluster creation. However, when you use `CapacityType = CAPACITY_BLOCK`, the nodes part of the compute resources associated to Capacity Blocks won't be considered for this check. The cluster will be created even if not all the configured Capacity Blocks are active. @@ -1498 +1498 @@ You can only specify Slurm configuration parameters that aren't deny-listed in ` -AWS ParallelCluster only checks whether a parameter is in a deny list. AWS ParallelCluster doesn't validate your custom Slurm configuration parameter syntax or semantics. You are responsible for validating your custom Slurm configuration parameters. Invalid custom Slurm configuration parameters can cause Slurm daemon failures that can lead to cluster create and update failures. +AWS ParallelCluster only checks whether a parameter is in a deny list. AWS ParallelCluster doesn't validate your custom Slurm configuration parameter syntax or semantics. It is your responsibility to validate your custom Slurm configuration parameters. Invalid custom Slurm configuration parameters can cause Slurm daemon failures that can lead to cluster create and update failures. @@ -2026 +2026 @@ If the secret value in the secret ARN is modified while the ARN remains the same -After running the command, you can resume both the compute fleet and login nodes: the newly provisioned compute and login nodes will automatically start using the new munge key. +After you run the command, you can resume both the compute fleet and login nodes: the newly provisioned compute and login nodes will automatically start using the new munge key. @@ -2073 +2073 @@ The time this strategy needs to replace all of the queue nodes with changed para -The default value of the `QueueUpdateStrategy` parameter. With this setting, updating parameters under the SlurmQueues section requires you to [stop the compute fleet](./pcluster.update-compute-fleet-v3.html) before performing a cluster update: +The default value of the `QueueUpdateStrategy` parameter. With this setting, updating parameters under the SlurmQueues section requires you to [stop the compute fleet](./pcluster.update-compute-fleet-v3.html) before you perform a cluster update: @@ -2173 +2173 @@ You can only specify Slurm configuration parameters that aren't deny-listed in ` -AWS ParallelCluster only checks whether a parameter is in a deny list. AWS ParallelCluster doesn't validate your custom Slurm configuration parameter syntax or semantics. You are responsible for validating your custom Slurm configuration parameters. Invalid custom Slurm configuration parameters can cause Slurm daemon failures that can lead to cluster create and update failures. +AWS ParallelCluster only checks whether a parameter is in a deny list. AWS ParallelCluster doesn't validate your custom Slurm configuration parameter syntax or semantics. It is your responsibility to validate your custom Slurm configuration parameters. Invalid custom Slurm configuration parameters can cause Slurm daemon failures that can lead to cluster create and update failures. @@ -2204 +2204 @@ You can only specify Slurm configuration parameters that aren't deny-listed in ` -AWS ParallelCluster only checks whether a parameter is in a deny list. AWS ParallelCluster doesn't validate your custom Slurm configuration parameter syntax or semantics. You are responsible for validating your custom Slurm configuration parameters. Invalid custom Slurm configuration parameters can cause Slurm daemon failures that can lead to cluster create and update failures. +AWS ParallelCluster only checks whether a parameter is in a deny list. AWS ParallelCluster doesn't validate your custom Slurm configuration parameter syntax or semantics. It is your responsibility to validate your custom Slurm configuration parameters. Invalid custom Slurm configuration parameters can cause Slurm daemon failures that can lead to cluster create and update failures. @@ -2268 +2268 @@ The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains t -When creating a secret using the AWS Secrets Manager console be sure to select "Other type of secret", select plaintext, and only include the password text in the secret. +When you create a secret using the AWS Secrets Manager console be sure to select "Other type of secret", select plaintext, and only include the password text in the secret.