Skip to content

Feat: Update Readme to add how to publish model engine image#766

Open
postevanus-scale wants to merge 1 commit intomainfrom
feat/add-readme-for-publishing-model-engine
Open

Feat: Update Readme to add how to publish model engine image#766
postevanus-scale wants to merge 1 commit intomainfrom
feat/add-readme-for-publishing-model-engine

Conversation

@postevanus-scale
Copy link
Collaborator

@postevanus-scale postevanus-scale commented Feb 24, 2026

Pull Request Summary

What is this PR changing? Why is this change being made? Any caveats you'd like to highlight? Link any relevant documents, links, or screenshots here if applicable.

Test Plan and Usage Guide

How did you validate that your PR works correctly? How do you run or demo the code? Provide enough detail so a reviewer can reasonably reproduce the testing procedure. Paste example command line invocations if applicable.

Greptile Summary

Adds documentation for publishing the Model Engine Docker image to the public ECR registry (public.ecr.aws/b2z8n5q1/model-engine). The new section covers building from the repo root, authenticating with the ml-admin AWS profile, and tagging/pushing the image.

  • New "Publishing the Docker Image" section appended to model-engine/README.md
  • Build instructions correctly reference the repo root as the Docker context with model-engine/Dockerfile
  • Authentication uses us-east-1 region as required by public ECR
  • No code changes; documentation only

Confidence Score: 5/5

  • This PR is safe to merge — it contains only documentation additions to the README with no code changes.
  • Score of 5 because this is a documentation-only change that adds accurate Docker publishing instructions. The build command, Dockerfile path, and ECR registry details are all consistent with the existing codebase. The AWS account ID was already present in the README. No functional code is modified.
  • No files require special attention.

Important Files Changed

Filename Overview
model-engine/README.md Adds a "Publishing the Docker Image" section with build, authenticate, tag, and push instructions for the public ECR registry. Documentation-only change with accurate commands.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["Build Image\n<code>docker build --platform linux/amd64 . -f model-engine/Dockerfile</code>"] --> B["Authenticate\n<code>aws ecr-public get-login-password</code>\nRegion: us-east-1, Profile: ml-admin"]
    B --> C["Tag Image\n<code>docker tag model-engine:TAG public.ecr.aws/b2z8n5q1/model-engine:TAG</code>"]
    C --> D["Push to Public ECR\n<code>docker push public.ecr.aws/b2z8n5q1/model-engine:TAG</code>"]
Loading

Last reviewed commit: d9df340

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants