Add a Docker image compatible with Studio Classic to Amazon ECR

Important

As of November 30, 2023, the previous Amazon SageMaker Studio experience is now named Amazon SageMaker Studio Classic. The following section is specific to using the Studio Classic application. For information about using the updated Studio experience, see Amazon SageMaker Studio.

You perform the following steps to add a container image to Amazon ECR:

• Create an Amazon ECR repository.

• Authenticate to Amazon ECR.

• Build a Docker image compatible with Studio Classic.

• Push the image to the Amazon ECR repository.

Note

The Amazon ECR repository must be in the same AWS Region as Studio Classic.

To build and add a container image to Amazon ECR

1. Create an Amazon ECR repository using the AWS CLI. To create the repository using the Amazon ECR console, see Creating a repository.

   aws ecr create-repository \
       --repository-name smstudio-custom \
       --image-scanning-configuration scanOnPush=true

   The response should look similar to the following.

   {
       "repository": {
           "repositoryArn": "arn:aws:ecr:us-east-2:acct-id:repository/smstudio-custom",
           "registryId": "acct-id",
           "repositoryName": "smstudio-custom",
           "repositoryUri": "acct-id.dkr.ecr.us-east-2.amazonaws.com/smstudio-custom",
           ...
       }
   }

2. Build the Dockerfile using the Studio Classic image build CLI. The period (.) specifies that the Dockerfile should be in the context of the build command. This command builds the image and uploads the built image to the ECR repo. It then outputs the image URI.

   sm-docker build . --repository smstudio-custom:custom

   The response should look similar to the following.

   Image URI: <acct-id>.dkr.ecr.<region>.amazonaws.com/<image_name>