Installing the Amazon ParallelCluster UI

Use an Amazon CloudFormation quick-create link to deploy an Amazon ParallelCluster UI stack with nested Amazon Cognito, API Gateway, and Amazon EC2 Systems Manager stacks.

1. Sign in to the Amazon Web Services Management Console.

2. Deploy the Amazon ParallelCluster UI by choosing an Amazon Web Services Region quick-create link from the table at the start of this section. This takes you to the CloudFormation Create Stack Wizard in the console.

3. Enter a valid email address for Admin's Email.

   After deployment completes successfully, the Amazon ParallelCluster UI sends you a temporary password to this email address. You use the temporary password to access the Amazon ParallelCluster UI. If you delete the email before you save or use the temporary password, you must delete the stack and reinstall the Amazon ParallelCluster UI.

4. Keep the rest of the form blank or enter values for (optional) parameters to customize the Amazon ParallelCluster UI build.

5. Note the stack name for use in later steps.

6. Navigate to Capabilities. Agree to the CloudFormation capabilities.

7. Choose Create. It takes about 15 minutes to complete the Amazon ParallelCluster API and Amazon ParallelCluster UI deployment.

8. View the stack details as the stack is created.

9. After the deployment completes, open the admin email that was sent to the address you entered. It contains a temporary password that you use to access the Amazon ParallelCluster UI. If you permanently delete the email and you haven’t yet logged in to the Amazon ParallelCluster UI, you must delete the Amazon ParallelCluster UI stack you created and reinstall the Amazon ParallelCluster UI.

10. In the Amazon CloudFormation console list of stacks, choose the link to the stack name that you noted in a previous step.

11. In Stack details, choose Outputs and select the link for the key named StacknameURL to open the Amazon ParallelCluster UI. Stackname is the name that you noted in a previous step.

12. Enter the temporary password. Follow the steps to create your own password and log in.

13. You are now on the home page of the Amazon ParallelCluster UI in the Amazon Web Services Region that you selected.

14. To get started using the Amazon ParallelCluster UI, see Configure and create a cluster with the Amazon ParallelCluster UI.

1. In the Amazon Web Services Management Console, navigate to API Gateway where you can see your Amazon ParallelCluster UI API listed.

2. In the navigation pane, choose Custom domain names.

3. Choose Create.

4. In Domain details, enter your domain name.

5. In Endpoint configuration, choose an existing ACM certificate, or choose Create a new ACM Certificate.

   (Optional) Create a certificate

   1. In the ACM console, choose Request.

   2. In Domain names, enter your domain name.

   3. In Validation method, choose a validation method.

      If you choose Email validation, an email is sent to the email address that is on file with the domain registrar.

   4. Select I approve to activate the certificate.

1. In API Gateway, Custom domain names, your-domain-name, choose Configure API mappings.

2. Choose Custom domain names.

3. Choose Add new mapping.

4. Choose the Amazon ParallelCluster UI API, the $default Stage, and Save.

5. In API Gateway domain name, copy the value for use in the next steps.

• Create a DNS CNAME rule that points your domain to the API Gateway domain. Enter only the domain. For example, don't add the stage, such as beta or prod. Replace abcde12345 with your API Gateway API ID, and replace us-east-2 with the API Amazon Web Services Region.

  Rule	Source	Destination
  CNAME	example.com	d-abcde12345.execute-api.us-east-2.amazonaws.com

1. Navigate to the Amazon Cognito console.

2. Select your user pool link.

3. Choose App integration.

4. In Domain, choose Actions, Create custom domain.

5. Enter your Custom domain and select your ACM certificate.

6. Choose Create custom domain.

1. Navigate to the Amazon Cognito console.

2. In your Amazon Cognito user pool App integration, App clients and analytics, select the application link.

3. In Hosted UI, choose Edit.

4. In Allowed callback URLs, choose Add another URL and enter a callback URL such as example.com/login.

1. Navigate to the Lambda console.

2. In the navigation pane, choose Functions.

3. Filter the list of functions to find the ParallelClusterUIFunction and select the link.

4. Choose Configuration, Environment variables.

5. Choose Edit.

6. For the SITE_URL value, enter your custom domain.

7. Navigate to your domain, such as example.com, and authenticate to connect to the Amazon ParallelCluster UI.

1. In the CloudFormation console, select the Amazon ParallelCluster UI stack that contains the Amazon Cognito user pool that you want to use with multiple Amazon ParallelCluster UI instances.

2. Navigate to the nested stack that created the Amazon Cognito userpool.

3. Select the Outputs tab.

4. Copy the values of the following parameters:

   • UserPoolId

   • UserPoolAuthDomain

   • SNSRole

5. Deploy a new Amazon ParallelCluster UI instance by using the quick-create link, and fill in all External Amazon ParallelCluster UI Amazon Cognito parameters with the outputs that you copied. This prevents the new Amazon ParallelCluster UI stack from creating a new pool and links it to the existing Amazon Cognito user pool that was created from a nested stack. You can deploy subsequent new Amazon ParallelCluster UI instances that have the same parameter values, and you can link them to the Amazon Cognito user pool.

1. Launch an Amazon Cognito-only stack by choosing a quick-create link labeled with same Amazon Web Services Region in which you deploy your Amazon ParallelCluster UI instances. See the quick-create links at the beginning of this section.

2. After stack creation completes, select the Outputs tab and copy the values of the following parameters:

   • UserPoolId

   • UserPoolAuthDomain

   • SNSRole

3. Deploy a new Amazon ParallelCluster UI instance by choosing an Amazon ParallelCluster UI quick-start link and filling in all External Amazon ParallelCluster UI Amazon Cognito parameters with the values that you copied. The new Amazon ParallelCluster UI instance links to the standalone Amazon Cognito user pool and doesn’t create a nested stack or a new user pool. You can deploy subsequent new Amazon ParallelCluster UI instances that have the same parameter values, and you can link them to the standalone Amazon Cognito user pool.

1. In the CloudFormation console, select an Amazon ParallelCluster UI stack.

2. Select the Parameters tab.

3. The Amazon ParallelCluster version is the value of the parameter Version.

4. The Amazon ParallelCluster UI version is at the end of the PublicEcrImageUri value. For example, if the value is public.ecr.aws/pcui/parallelcluster-ui-awslambda:2023.02, then the version is 2023.02.