Skip to content

Commit

Permalink
Merge pull request #372 from grycap/dev-srisco
Browse files Browse the repository at this point in the history 
Add batch multinode parallel jobs support
  • Loading branch information
@srisco
srisco authored Mar 24, 2021
2 parents c472a8c + 9e6a4cf commit 0b7acfd
Show file tree
Hide file tree
Showing 13 changed files with 684 additions and 38 deletions.
28 changes: 19 additions & 9 deletions docs/source/batch.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ AWS Batch Integration
=======================

AWS Batch allows to efficiently execute batch computing jobs on AWS by dynamically provisioning the required underlying EC2 instances on which Docker-based jobs are executed.
SCAR allows to transparently integrate the execution of the jobs through `AWS Batch <https://aws.amazon.com/batch/>`_.
SCAR allows to transparently integrate the execution of the jobs through `AWS Batch <https://aws.amazon.com/batch/>`_.
Three execution modes are now available in SCAR:

* `lambda`: This is the default execution mode. All executions will be run on AWS Lambda.
* `lambda-batch`: Executions will be run on AWS Lambda. If the default timeout is reached, then the execution is automatically delegated to AWS Batch.
* `batch`: Executions will be automatically diverted to AWS Batch.

This way, you can use AWS Lambda as a highly-scalable cache for burts of short computational jobs while longer executions can be automatically delegated to AWS Batch.
This way, you can use AWS Lambda as a highly-scalable cache for burts of short computational jobs while longer executions can be automatically delegated to AWS Batch.
The very same `programming model <https://scar.readthedocs.io/en/latest/prog_model.html>`_ is maintained regardless of the service employed to perform the computation.

Set up your configuration file
Expand Down Expand Up @@ -47,20 +47,20 @@ The variables responsible for batch configuration are::
},
"service_role": "arn:aws:iam::{account_id}:role/service-role/AWSBatchServiceRole"
}
Since AWS Batch deploys Amazon EC2 instances, the REQUIRED variables are:

Since AWS Batch deploys Amazon EC2 instances, the REQUIRED variables are:
* `security_group_ids`: The EC2 security group that is associated with the instances launched in the compute environment. This allows to define the inbound and outbound network rules in order to allow or disallow TCP/UDP traffic generated from (or received by) the EC2 instance. You can choose the default VPC security group.
* `subnets`: The VPC subnet(s) identifier(s) on which the EC2 instances will be deployed. This allows to use multiple Availability Zones for enhanced fault-tolerance.

The remaining variables have default values that should be enough to manage standard batch jobs.
The remaining variables have default values that should be enough to manage standard batch jobs.
The default `fdl file <https://github.com/grycap/scar/blob/master/fdl-example.yaml>`_ explains briefly the remaining Batch variables and how are they used.

Additional info about the variables and the different values that can be assigned can be found in the `AWS API Documentation <https://docs.aws.amazon.com/batch/latest/APIReference/API_CreateComputeEnvironment.html>`_.

Set up your Batch IAM role
--------------------------

The default IAM role used in the creation of the EC2 for the Batch Compute Environment is **arn:aws:iam::$ACCOUNT_ID:instance-profile/**ecsInstanceRole****. Thus, if you want to provide S3 access to your Batch jobs you have to specify the corresponding policies in the aforementioned role.
The default IAM role used in the creation of the EC2 for the Batch Compute Environment is **arn:aws:iam::$ACCOUNT_ID:instance-profile/**ecsInstanceRole****. Thus, if you want to provide S3 access to your Batch jobs you have to specify the corresponding policies in the aforementioned role.
If you have a role aleredy configured, you can set it in the configuration file by changin the variable `batch.compute_resources.instance_role`.


Expand Down Expand Up @@ -105,10 +105,10 @@ And trigger the execution of the function by uploading a file to be processed to

SCAR automatically creates the compute environment in AWS Batch and submits a job to be executed. Input and output data files are transparently managed as well according to the programming model.

The CloudWatch logs will reveal the execution of the Lambda function as well as the execution of the AWS Batch job.
Notice that whenever the execution of the AWS Batch job has finished, the EC2 instances will be eventually terminated.
The CloudWatch logs will reveal the execution of the Lambda function as well as the execution of the AWS Batch job.
Notice that whenever the execution of the AWS Batch job has finished, the EC2 instances will be eventually terminated.
Also, the number of EC2 instances will increase and shrink to handle the incoming number of jobs.

Combine AWS Lambda and AWS Batch executions
-------------------------------------------
As explained in the section :doc:`/prog_model`, if you define an output bucket as the input bucket of another function, a workflow can be created.
Expand All @@ -127,3 +127,13 @@ To create the AWS Batch job, the Lambda function defines a Job with the payload
The payload limit can be avoided by redefining the script used and passing the large payload files using other service (e.g S3 or some bash command like 'wget' or 'curl' to download the information in execution time). As we didi with the plant classification example, where a `bootstrap script <https://github.com/grycap/scar/blob/master/examples/plant-classification/bootstrap-plants.sh>`_ was used to download the `executed script <https://github.com/grycap/scar/blob/master/examples/plant-classification/plant-classification-run.sh>`_.

Also, AWS Batch does not allow to override the container entrypoint so containers with an entrypoint defined can not execute an user script.

Multinode parallel jobs
-----------------------
You can execute multinode parallel jobs in batch by enabling this mode either in the scar.cfg file or in the configuration file for the job (functions->aws->batch->multi_node_parallel->enable).
You can also set the number of nodes and the index of the main node.
Please take into account that the index of the main node starts from 0 up to the number of nodes -1.

We included an `example <https://github.com/grycap/scar/tree/master/examples/mpi>`_ of MPI job that can be executed as multinode parallel job, showing a hello world from each CPU/node available for execution.
Both work in Amazon Lambda and Batch single node, you can use the included configuration files as a starting point.
For more details, please check the README.md that comes with the example.
48 changes: 48 additions & 0 deletions examples/mpi/Dockerfile
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
FROM debian:stretch-slim

ARG ADD_BASE_DIR=examples/mpi
ARG BUILD_PACKAGES=' wget git make gcc g++ iproute2 cmake build-essential gfortran curl '

ENV DEBIAN_FRONTEND=noninteractive
## Set to either lambda or batch
ENV EXEC_TYPE=lambda

ENV APP_PARAMS=""
ENV GIT_REPO=https://github.com/mpitutorial/mpitutorial
ENV GIT_REPO_REL_PATH_SRC=mpitutorial/tutorials/mpi-hello-world/code
ENV GIT_REPO_REL_PATH_EXEC=mpitutorial/tutorials/mpi-hello-world/code/mpi_hello_world
ENV APP_BIN=/opt/$GIT_REPO_REL_PATH_EXEC
ENV SSH_PRIV_FILE_KEY=ssh_host_rsa_key
ENV SSH_PUB_FILE_KEY=ssh_host_rsa_key.pub

ENV LANG en_US.UTF-8

ADD ${ADD_BASE_DIR}/run.sh /opt/

RUN apt-get update \
&& apt-get install -q -o=Dpkg::Use-Pty=0 -y $BUILD_PACKAGES perl locales \
&& locale-gen en_US.UTF-8 \
&& sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen \
&& dpkg-reconfigure --frontend=noninteractive locales \
&& update-locale LANG=en_US.UTF-8 \
&& wget -q --no-check-certificate -qO- https://download.open-mpi.org/release/open-mpi/v1.4/openmpi-1.4.3.tar.bz2 | tar xvfj - -C /tmp/ \
&& cd /tmp/openmpi-1.4.3/ \
&& ./configure --disable-pty-support --disable-doc \
&& make -j`nproc` \
&& make install \
&& ldconfig \
&& cd /opt/ \
&& git clone $GIT_REPO \
&& cd /opt/$GIT_REPO_REL_PATH_SRC \
&& make \
&& apt-get remove --purge -y $BUILD_PACKAGES gnupg* gnupg-agent* \
&& apt-get autoremove --purge -y \
&& rm -rf /tmp/* /var/lib/apt/lists/* \
&& ulimit -n 1024 \
&& chmod 755 /opt/$GIT_REPO_REL_PATH_EXEC \
&& chmod 755 /opt/run.sh \
&& echo $(date) > /build_date \
&& echo "Build date: $(cat /build_date)"


CMD /opt/run.sh
201 changes: 201 additions & 0 deletions examples/mpi/LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading

0 comments on commit 0b7acfd

Please sign in to comment.