Skip to content

Commit 8bcbe53

Browse files
mauri-melatosean-smith
authored andcommitted
[doc] Updated AWS services dependencies
Signed-off-by: Maurizio Melato <[email protected]>
1 parent cb54320 commit 8bcbe53

File tree

1 file changed

+69
-15
lines changed

1 file changed

+69
-15
lines changed

docs/source/aws_services.rst

Lines changed: 69 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,28 @@ For more details about AWS CloudFormation, see http://aws.amazon.com/cloudformat
2525
AWS Identity and Access Management (IAM)
2626
----------------------------------------
2727

28-
IAM is used within AWS ParallelCluster to provide an Amazon EC2 IAM Role for the instances. This role is a least privileged role specifically created for each cluster. AWS ParallelCluster instances are given access only to the specific API calls that are required to deploy and manage the cluster.
28+
AWS IAM is used within AWS ParallelCluster to provide an Amazon EC2 IAM Role for the instances. This role is a least privileged role specifically created for each cluster. AWS ParallelCluster instances are given access only to the specific API calls that are required to deploy and manage the cluster.
29+
30+
With AWS Batch clusters, IAM Roles are also created for the components involved with the Docker image building process at cluster creation time.
31+
These components include the Lambda functions allowed to add and delete Docker images to/from the ECR repository and to delete the S3 bucket created for the cluster and CodeBuild project. Then there are roles for the AWS Batch resources, instance, job.
2932

3033
For more details about AWS Identity and Access Management, see http://aws.amazon.com/iam/
3134

32-
Amazon SNS
33-
----------
35+
Amazon Simple Notification Service (SNS)
36+
----------------------------------------
37+
38+
Amazon SNS is used to receive notifications from Auto Scaling. These events are called life cycle events, and are generated when an instance launches or terminates in an Autoscaling Group. Within AWS ParallelCluster, the Amazon SNS topic for the Autoscaling Group is subscribed to an Amazon SQS queue.
3439

35-
Amazon Simple Notification Service is used to receive notifications from Auto Scaling. These events are called life cycle events, and are generated when an instance launches or terminates in an Autoscaling Group. Within AWS ParallelCluster, the Amazon SNS topic for the Autoscaling Group is subscribed to an Amazon SQS queue.
40+
The service is not used with AWS Batch clusters.
3641

3742
For more details about Amazon SNS, see http://aws.amazon.com/sns/
3843

39-
Amazon SQS
40-
----------
44+
Amazon Simple Queuing Service (SQS)
45+
-----------------------------------
46+
47+
Amazon SQS is used to hold notifications(messages) from Auto Scaling, sent through Amazon SNS and notifications from the ComputeFleet instances. This decouples the sending of notifications from the receiving and allows the Master to handle them through polling. The MasterServer runs Amazon SQSwatcher and polls the queue. AutoScaling and the ComputeFleet instances post messages to the queue.
4148

42-
Amazon Simple Queuing Service is used to hold notifications(messages) from Auto Scaling, sent through Amazon SNS and notifications from the ComputeFleet instances. This decouples the sending of notifications from the receiving and allows the Master to handle them through polling. The MasterServer runs Amazon SQSwatcher and polls the queue. AutoScaling and the ComputeFleet instances post messages to the queue.
49+
The service is not used with AWS Batch clusters.
4350

4451
For more details about Amazon SQS, see http://aws.amazon.com/sqs/
4552

@@ -50,30 +57,77 @@ Amazon EC2 provides the compute for AWS ParallelCluster. The MasterServer and Co
5057

5158
For more details about Amazon EC2, see http://aws.amazon.com/ec2/
5259

53-
Auto Scaling
54-
------------
60+
AWS Auto Scaling
61+
----------------
62+
63+
AWS Auto Scaling is used to manage the ComputeFleet instances. These instances are managed as an AutoScaling Group and can either be elastically driven by workload or static and driven by the config.
5564

56-
Auto Scaling is used to manage the ComputeFleet instances. These instances are managed as an AutoScaling Group and can either be elastically driven by workload or static and driven by the config.
65+
The service is not used with AWS Batch clusters.
5766

5867
For more details about Auto Scaling, see http://aws.amazon.com/autoscaling/
5968

60-
Amazon EBS
61-
----------
69+
Amazon Elastic Block Store (EBS)
70+
--------------------------------
6271

63-
Amazon EBS provides the persistent storage for the shared volume. Any EBS settings can be passed through the config. EBS volumes can either be initialized empty or from an existing EBS snapshot.
72+
Amazon EBS provides the persistent storage for the shared volumes. Any EBS settings can be passed through the config. EBS volumes can either be initialized empty or from an existing EBS snapshot.
6473

6574
For more details about Amazon EBS, see http://aws.amazon.com/ebs/
6675

6776
Amazon S3
6877
---------
6978

70-
Amazon S3 is used to store the AWS ParallelCluster templates. Each region has a bucket with all templates. AWS ParallelCluster can be configured to allow allow CLI/SDK tools to use S3.
79+
Amazon S3 is used to store the AWS ParallelCluster templates. Each region has a bucket with all templates. AWS ParallelCluster can be configured to allow allow CLI/SDK tools to use S3.
80+
81+
With an AWS Batch cluster, an S3 bucket in the customer's account is created to store artifacts used by the Docker image creation and the jobs scripts when submitting jobs from the user's machine.
7182

7283
For more details, see http://aws.amazon.com/s3/
7384

7485
Amazon DynamoDB
7586
---------------
7687

77-
Amazon DynamoDB is used to store minimal state of the cluster. The MasterServer tracks provisioned instances in a DynamoDB table.
88+
Amazon DynamoDB is used to store minimal state of the cluster. The MasterServer tracks provisioned instances in a DynamoDB table.
89+
90+
The service is not used with AWS Batch clusters.
7891

7992
For more details, see http://aws.amazon.com/dynamodb/
93+
94+
AWS Batch
95+
---------
96+
AWS Batch is the AWS managed job scheduler that dynamically provisions the optimal quantity and type of compute resources (e.g., CPU or memory optimized instances) based on the volume and specific resource requirements of the batch jobs submitted. With AWS Batch, there is no need to install and manage batch computing software or server clusters that you use to run your jobs.
97+
98+
The service is only used with AWS Batch clusters.
99+
100+
For more details, see https://aws.amazon.com/batch/
101+
102+
AWS CodeBuild
103+
-------------
104+
AWS CodeBuild is used to automatically and transparently build Docker images at cluster creation time.
105+
106+
The service is only used with AWS Batch clusters.
107+
108+
For more details, see https://aws.amazon.com/codebuild/
109+
110+
AWS Lambda
111+
----------
112+
AWS Lambda service runs the functions that orchestrate the Docker image creation and manage custom cluster resources cleanup, that are the created Docker images stored in the ECR repository and the S3 bucket for the cluster.
113+
114+
The service is only used with AWS Batch clusters.
115+
116+
For more details, see https://aws.amazon.com/lambda/
117+
118+
Amazon Elastic Container Registry (ECR)
119+
---------------------------------------
120+
121+
Amazon ECR stores the Docker images built at cluster creation time. The Docker images are then used by AWS Batch to run the containers for the submitted jobs.
122+
123+
The service is only used with AWS Batch clusters.
124+
125+
For more details, see https://aws.amazon.com/ecr/
126+
127+
Amazon CloudWatch
128+
-----------------
129+
Amazon CloudWatch is used to log Docker image build steps and the standard output and error of the AWS Batch jobs.
130+
131+
The service is only used with AWS Batch clusters.
132+
133+
For more details, see https://aws.amazon.com/cloudwatch/

0 commit comments

Comments
 (0)