Integrate with AWS Batch

This quickstart guide will walk you through integrating Nextmv with AWS Batch running in your account. At the end of the walk-through you will be able to run your Nextmv-managed models in your AWS account while still being able to view all of the run’s details and results in Nextmv. You can use your compute integration for any capability in Nextmv including running experiments, ensemble runs, or shadow runs.

This tutorial assumes that you have familiarity with:

• Pushing a model to Nextmv (using either Nextmv CLI or Nextmv Python SDK).
• Managing instances used to run your model.

Once you've completed the setup you'll have an environment described by the following diagram:

The steps that occur are:

1. When you submit a run, the Nextmv control plane assumes an AWS IAM role internally that has permission to assume the cross-account role created when you set up the AWS Batch environment. It then assumes the cross-account role in your account.
2. The control plane executes a SubmitJob to AWS Batch in your account, specifying the Batch Queue and Batch Job Definition you configured.
3. AWS Batch runtime starts the container in the cluster.
4. The cluster pulls the Docker image created based on your definition from a repository and initiates execution.
5. The Nextmv driver interacts with the Nextmv session gateway to complete the run.

1. Set up AWS Batch

This first section will walk through the steps and requirements to set up an AWS Batch environment that allows the Nextmv integration connection. In order to proceed you will need the Nextmv AWS Batch installation package distributed by request, and a Nextmv account.

Install AWS Batch to your AWS Account

Follow those installation instructions in the package for specific steps. In order to run the script you must have AWS admin permissions and python 3.9 or above installed. For the purposes of this quick start we used the base name of acme with a job definition name of python_3_11. You control these values when you install the AWS Batch integration package.

2. Configure your app manifest

...
python:
  # All listed packages will get bundled with the app.
  pip-requirements: requirements.txt # if your app contains additional python requirements
  arch: amd64
  version: 3.11
...

Once you have matched the compute environment of your AWS Batch container, no other changes are required to your app manifest.

3. Set up Nextmv integration

Once your AWS account is configured, you can create an integration in Nextmv that holds the relevant AWS Batch information. This integration can then be assigned to application runs which will execute in your account. In Nextmv, integrations are created at the account level and applied at the app level. You can constrain the applications that are allowed to use the integration when setting it up.

In this section we are going to create a new AWS Batch integration and a new app that uses the integration. Note that while the tutorial walks through the process of creating a new app, if you have an existing Nextmv application that you would like to connect to AWS Batch, you can use that application in place of the new one created in this tutorial.

Create the integration

First we will create the integration at the account level. In the top navigation bar, click on Team Settings and then in the left sidebar click on Integrations and then click the + button in the upper right to create a new integration.

The create integration screen is essentially divided into two parts: the first part is the configuration of the integration on the Nextmv side, the second part is for the AWS Batch details.

Here is a breakdown of the fields for the first part:

• Name, ID, and description: these fields are for your use and reference only. The name and ID are required, the description is optional. Note that the ID cannot be edited once created, but you can always delete the integration and re-create it with a different ID. IDs need to be unique within your account.
• Permissions: this field sets access for which apps in Nextmv are allowed to use the integration. If Enable access for all applications is toggled on, then all applications have access to the integration. If you toggle the switch off, an additional interface will appear to allow you to select specific applications that can use the integration; any app not on the list will not have access to the integration. For this tutorial we are going to enable global access, if you decide to limit access just make sure the app you want to use the AWS Batch integration with is granted access.
• Integration provider: This dropdown select box is for choosing which kind of integration you are creating. The provider is the service you are integrating with — in this case, AWS Batch. The fields below are populated based on the selection in this dropdown.

Once the fields above have been filled out, the create new form should look something like this:

You can enter your own name and ID or you can match the fields shown in the screenshot above. Having different values from what’s shown in the screenshot above will not affect your integration.

The AWS Batch integration requires seven fields:

• Integration type: This field is set by default by the AWS integration and there is only one option: Compute. This field communicates the integration type to the Nextmv driver; in this case a compute integration, which means it’s used as an execution environment.
• Execution types: There are three different execution types: Python, Java, and Binary. You can select one or more of the types that match up with your application and the capabilities of your container image. The default example container image created by the AWS Batch integration supports binary or Python 3.11 apps. To run both types on your integration you would select Python and Binary in the drop down list.
• AWS Account ID: This is the AWS account ID where you deployed the AWS Batch integration. The value is a 12 digit number found in your AWS console.
• AWS Region: The region for your AWS Batch integration deployment. This selection only allows US based regions (us-east-1, us-east-2, us-west-1, us-west-2).
• Source Role ARN: This value can be found in the Outputs tab of the CloudFormation stack in the AWS Console for your deployed integration. Copy and paste the value here.
• Job Definition Name: This value can be found in Outputs tab of the CloudFormation stack. It will of the form nextmv-<basename>-<job definition-name> where basename and job-definition-name were specified in your deployment configuration.
• Job Queue Name: This value can be found in the Batch service in the AWS console. It will be of the form nextmv-<basename>-batch-queue.

Once you have these fields filled out, click the Create integration button. (Note that your exact values will be different than what is shown in the screenshot above.)

The integration will run a check that the security configuration resolves correctly and display a message on the result, which should indicate Healthy.

Create an app

Next, in Nextmv Console, create a new app by clicking on the Apps & Workflows main navigation link in the top header and then clicking the + button in the upper right. Select New custom app and then follow the steps to create a new custom app.

After filling out the name, ID, and description fields and clicking Create.

Push updated binary

On the dashboard view for your app, at the top, copy the app’s ID to use for the push commands below.

First, if you made any updates to your app’s app.yaml file in section 2, make sure that these changes are saved. Then push your model to your app with either Nextmv CLI or the Python SDK. Examples for each are shown below (note the <YOUR_APP_ID> is the app ID you copied at the beginning of this step).

nextmv cloud app push -a <YOUR_APP_ID>

Once the push has completed, proceed to the next step.

Attach integration to Latest instance

In this step you will configure your Latest instance to use the AWS Batch integration so that whenever an application run is made with the Latest instance, the AWS Batch integration is initiated automatically and the run executed in AWS Batch.

Note that you do not need an instance to use integrations for runs. You can apply the AWS Batch integration directly to an application run via the advanced run settings menu; which is especially useful when you are doing ad hoc application runs. You could also programmatically apply the integration on a per run basis within your systems. However, in this tutorial, the integration will be configured on the Latest instance and used via the instance.

In your application in Nextmv Console, navigate to your Instances page and you should see an instance named Latest. (Note that you may need to refresh the page.)

Click on this Latest instance to view the details. The integration is applied by way of the Execution Class field. Click the Edit button in the top right to edit your Latest instance.

On the edit view, in the Execution class dropdown, select integration as the execution class. Once selected, a new select dropdown box should appear beneath it that will allow you to select your integration. Select which integration you would like to use and then click Save to apply your changes.

Run with the Integration

Now that the integration is attached to the Latest instance, when you create a new run using that instance, your run will be executed in AWS Batch instead of in Nextmv’s infrastructure. However, you’ll still be able to view the input, output, metadata, and any other custom assets or metrics from your model runs in the Nextmv Console.

To create a run:

1. In Nextmv, on the left sidebar of your application navigation, click the New run button (at the bottom of the list).
2. Add the input for your model.
3. In the Instance dropdown menu, select the Latest instance if it’s not already selected. Note that if your Nextmv role is Operator, the dropdown for selecting the instance will be in the advanced menu in the upper right.
4. Click the Start run button to start the run.

If you navigate to AWS Batch in the AWS console, and search for jobs in your job queue, you should see your job initiated.

You can click into this run to view the output of the run and its details. This run will also be in Nextmv and you can view the run input and output like normally.

🎉🎉🎉 Congratulations, you have finished setting up your Nextmv integration!

Further

You can use the instance with the AWS Batch integration just like you would any other instance. Whatever version is assigned to the instance is the version that will run in AWS Batch. And any configuration set on the instance will be applied to the run sent to AWS Batch (likewise for any run-specific configuration). And when you run scenario tests with an instance with the AWS Batch integration, the runs for that test will execute in AWS Batch.