Add support for reading images from AWS ECR #16

ehdr · 2025-05-27T11:28:40Z

CLI-433

Adds support similar to modal.Image.from_aws_ecr(), related support for Secrets.

freider · 2025-05-27T12:02:04Z

modal-js/src/app.ts

+
+  async imageFromAwsEcr(tag: string, secret: Secret): Promise<Image> {
+    if (!secret.secretId) {
+      throw new Error("secret.secretId must not be null");


This error could be a bit more helpful, like secret must be a reference to an existing Secret, e.g. await Secret.from_name("my_secret")or similar - I wouldn't expect users to know how to get an object with asecretId` here otherwise

luiscape

Hi @ehdr, can you make the following changes:

implement the same functionality in Go
add tests to both secret and, ideally, imageFromAwsEcr
add examples

ekzhang

Lgtm just need to follow some language conventions and add tests! I think you'd likely have noticed the camelCase naming thing after writing the examples / tests since they would be inconsistent with the code around it.

Also what Luis mentioned above, we're trying to keep the code as similar as possible between Go and TS and avoid it drifting.

modal-js/src/secret.ts

modal-js/src/image.ts

modal-js/src/secret.ts

ekzhang · 2025-05-27T17:19:20Z

modal-js/src/app.ts

+    if (!secret.secretId) {
+      throw new Error(
+        "secret must be a reference to an existing Secret, e.g. `await Secret.from_name('my_secret')`",
+      );
+    }


I don't think this validation is needed or helpful since the Secret object, once constructed properly, must have a secret ID already.

I added it because it failed when I left out the await on Secret.from_name in await app.imageFromAwsEcr("alpine:3.21", await Secret.from_name("aws")). Do you think it makes sense, and/or is there a better way to guard for this?

Ah got it. Yeah that would be caught by TypeScript! A more direct check might be

if (!(secret instanceof Secret)) { throw new TypeError("..."); }

ehdr · 2025-05-27T20:16:22Z

Thanks @luiscape @ekzhang , great comments (and sorry for the Python casing... 🤦 ). I'll attend to these tomorrow.

ehdr · 2025-05-28T12:38:48Z

I fixed most of the comments now. Will have to pause this for a bit for customer related work, but will add example and update Go client later before merging!

ekzhang

Thank you for updating!

luiscape

Go implementation lgtm.

luiscape · 2025-06-04T13:55:36Z

modal-go/secret.go

+	RequiredKeys []string
+}
+
+func SecretFromName(ctx context.Context, name string, options SecretFromNameOptions) (*Secret, error) {


Add documentation

ehdr · 2025-06-08T20:33:49Z

I finally (after some other distractions) got around to finishing this, so I think all outstanding comments are fixed now! I also adapted it to #23 (e.g. the Go SDK accepts nil as default value for options etc.).

ekzhang

LGTM!

modal-js/examples/sandbox-private-image.ts

modal-js/src/config.ts

modal-go/secret.go

modal-go/test/secret_test.go

…ON` env var

ekzhang

Thank you!

ekzhang · 2025-06-09T21:29:59Z

modal-js/tsconfig.json

+    "*.config.ts",
+    "vitest.config.ts",
+    "tsup.config.ts"


Isn't this redundant?

Ah yes, good catch, fixed!

ehdr requested a review from freider May 27, 2025 11:28

ehdr force-pushed the ehdr/add-image-from-aws-ecr branch from 71d8457 to a6c05a4 Compare May 27, 2025 11:31

freider reviewed May 27, 2025

View reviewed changes

luiscape requested changes May 27, 2025

View reviewed changes

ekzhang reviewed May 27, 2025

View reviewed changes

ehdr force-pushed the ehdr/add-image-from-aws-ecr branch from a0ba483 to 4bb7820 Compare May 28, 2025 12:37

ekzhang approved these changes May 29, 2025

View reviewed changes

ehdr force-pushed the ehdr/add-image-from-aws-ecr branch from 4bb7820 to c598abe Compare June 4, 2025 13:09

ehdr changed the title ~~Add App.imageFromAwsEcr for reading images from AWS ECR~~ Add support for reading images from AWS ECR Jun 4, 2025

luiscape approved these changes Jun 4, 2025

View reviewed changes

ehdr force-pushed the ehdr/add-image-from-aws-ecr branch from c598abe to c908344 Compare June 8, 2025 20:30

ehdr force-pushed the ehdr/add-image-from-aws-ecr branch 2 times, most recently from cac5072 to a4751e7 Compare June 8, 2025 20:54

ekzhang approved these changes Jun 9, 2025

View reviewed changes

ehdr added 9 commits June 9, 2025 12:52

Optionally read image builder version from `MODAL_IMAGE_BUILDER_VERSI…

e0f7917

…ON` env var

Add imageFromAwsEcr to JS SDK

4a025d0

Add ImageFromAwsEcr to Go SDK

3fe6830

Add Secrets and imageFromAwsEcr to CHANGELOG

745b95a

Adapt to new Go API for passing options

0eb2b7f

Remove explicit environment from examples

ff2e6c0

Add examples to README

4984498

Read image builder version config from profile

8d678e6

Make image builder configurable in Go too

063e245

ehdr force-pushed the ehdr/add-image-from-aws-ecr branch from a4751e7 to 063e245 Compare June 9, 2025 17:39

Add and apply eslint/consistent-type-imports

8798e93

ehdr force-pushed the ehdr/add-image-from-aws-ecr branch from 5310419 to 8798e93 Compare June 9, 2025 18:39

ehdr force-pushed the ehdr/add-image-from-aws-ecr branch from 8912234 to 49cc720 Compare June 9, 2025 21:21

Add consistent-type-exports eslint and related changes

5302232

ehdr force-pushed the ehdr/add-image-from-aws-ecr branch from 49cc720 to 5302232 Compare June 9, 2025 21:22

ekzhang approved these changes Jun 9, 2025

View reviewed changes

Remove redundant includes

e505372

ehdr merged commit 473a9e0 into main Jun 9, 2025
5 of 6 checks passed

ehdr deleted the ehdr/add-image-from-aws-ecr branch June 9, 2025 21:45

Add support for reading images from AWS ECR #16

Add support for reading images from AWS ECR #16

Uh oh!

Conversation

ehdr commented May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

freider May 27, 2025

Choose a reason for hiding this comment

Uh oh!

ehdr May 27, 2025

Choose a reason for hiding this comment

Uh oh!

luiscape left a comment

Choose a reason for hiding this comment

Uh oh!

ekzhang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ekzhang May 27, 2025

Choose a reason for hiding this comment

Uh oh!

ehdr May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ekzhang May 29, 2025

Choose a reason for hiding this comment

Uh oh!

ehdr commented May 27, 2025

Uh oh!

ehdr commented May 28, 2025

Uh oh!

ekzhang left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

luiscape left a comment

Choose a reason for hiding this comment

Uh oh!

luiscape Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

ehdr commented Jun 8, 2025

Uh oh!

ekzhang left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ekzhang left a comment

Choose a reason for hiding this comment

Uh oh!

ekzhang Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

ehdr Jun 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ehdr commented May 27, 2025 •

edited

Loading

ehdr May 27, 2025 •

edited

Loading

ekzhang left a comment •

edited

Loading