Pushing the custom R algorithm container image to an Amazon ECR repository
In the previous recipe, we prepared and built the custom container image using the docker build
command. In this recipe, we will push the custom container image to an Amazon ECR repository. If this is your first time hearing about Amazon ECR, it is simply a fully managed container registry that helps us manage our container images. After pushing the container image to an Amazon ECR repository, we will use this image for training and deployment in the Using the custom R algorithm container image for training and inference with Amazon SageMaker Local Mode recipe.
Getting ready
Here are the prerequisites for this recipe:
- This recipe continues from the Building and testing the custom R algorithm container image recipe.
- Permission to manage the Amazon ECR resources if you're using an AWS IAM user with a custom URL.
How to do it...
The initial steps in this recipe focus on creating the ECR repository. Let's get started:
- Use the search bar in the AWS Console to navigate to the Elastic Container Registry console. Click Elastic Container Registry when you see it in the search results:
As we can see, we can use the search bar to quickly navigate to the Elastic Container Registry service.
- Click the Create repository button:
Here, the Create repository button is at the top right of the screen.
- In the Create repository form, specify a Repository name. Use the value of
$IMAGE_NAME
from the Building and testing the custom R algorithm container image recipe. In this case, we will usechap02_r
:Here, we have the Create repository form. For Visibility settings, we chose Private and we set the Tag immutability configuration to Disabled.
- Scroll down until you see the Create repository button. Leave the other configuration settings as-is and click Create repository:
Finally, to complete the repository creation process, click the Create repository button at the bottom of the page.
- Click chap02_r:
Here, we have a link under the Repository name column. Clicking this link should redirect us to a page containing details about the repository.
- Click View push commands:
The View push commands button can be found at the top right of the page.
- You can optionally copy the first command,
aws ecr get-login-password …
, from the dialog box:Here, we can see multiple commands that we can use. We will only need the first one (
aws ecr get-login-password …
). Click the icon with two overlapping boxes at the right-hand side of the code box to copy the entire line to the clipboard. - Navigate back to the AWS Cloud9 environment IDE and create a new Terminal. You can also reuse an existing one:
The preceding screenshot shows us how to create a new Terminal. We click the green plus button and then select New Terminal from the list of options. Note that the green plus button is right under the Editor pane.
- Navigate to the
ml-r
directory:cd /home/ubuntu/environment/opt/ml-r
- Get the account ID using the following commands:
ACCOUNT_ID=$(aws sts get-caller-identity | jq -r ".Account") echo $ACCOUNT_ID
- Specify the
IMAGE_URI
value and use the ECR repository name we specified while creating the repository in this recipe. In this case, we will runIMAGE_URI="chap02_r"
:IMAGE_URI="<insert ECR Repository URI>" TAG="1"
- Authenticate with Amazon ECR so that we can push our Docker container image to an Amazon ECR repository in our account later:
aws ecr get-login-password --region us-east-1 | docker login --username AWS --password-stdin $ACCOUNT_ID.dkr.ecr.us-east-1.amazonaws.com
Important note
Note that we have assumed that our repository is in the
us-east-1
region. Feel free to modify this region in the command if needed. This applies to all the commands in this chapter. - Use the
docker tag
command:docker tag $IMAGE_URI:$TAG $ACCOUNT_ID.dkr.ecr.us-east-1.amazonaws.com/$IMAGE_URI:$TAG
- Push the image to the Amazon ECR repository using the
docker push
command:docker push $ACCOUNT_ID.dkr.ecr.us-east-1.amazonaws.com/$IMAGE_URI:$TAG
Now that we have completed this recipe, we can proceed with using this custom algorithm container image with SageMaker in the next recipe. But before that, let's see how this works!
How it works…
In the Building and testing the custom R algorithm container image recipe, we used docker build
to prepare the custom container image. In this recipe, we created an Amazon ECR repository and pushed our custom container image to it. We also used the docker push
command to push the custom container image we built to the ECR repository.
Important note
Don't forget to include the api.r
file inside the container when writing this Dockerfile
and running the build step. The Python counterpart recipe copies the train
and serve
scripts to the /opt/ml
directory inside the container, while the R recipe copies the train
, serve
, and api.r
files to the /opt/ml
directory. If the api.r
file is not included, the following line in the serve
script file will trigger an error and cause the script to fail: pr <- plumb("/opt/ml/api.r")
.