Skip to content

Document pushing images to remote registries - #354

Draft
chruffins wants to merge 1 commit into
hypeship/registry-push-apifrom
hypeship/registry-push-docs
Draft

Document pushing images to remote registries#354
chruffins wants to merge 1 commit into
hypeship/registry-push-apifrom
hypeship/registry-push-docs

Conversation

@chruffins

@chruffins chruffins commented Aug 5, 2026

Copy link
Copy Markdown

Layer 4 of remote registry push support (top of the stack: #348#350#353).

Adds user-facing docs for the outbound push feature:

  • Features bullet: remote registry push with docker-style borrowed credentials
  • Usage section with the docker-aligned credential model spelled out (credentials stay on the client, borrowed per push, never stored on the server; server's own logins as fallback)
  • curl examples: creating a push with lent ECR credentials (the aws ecr get-login-password flow) and polling the job
  • digest-preservation and ready-state notes

Docs-only; no code changes.


Note

Low Risk
Documentation-only changes with no runtime or security behavior changes in this PR.

Overview
README now documents exporting cached images to remote OCI registries via the authenticated API.

The Features list adds remote registry push with docker-style borrowed credentials. A new Pushing Images to Remote Registries section explains that client credentials are lent per push (not stored server-side), with fallback to the server’s ~/.docker/config.json, and includes curl examples for creating a push (including ECR password flow) and polling job status (queuedpushingpushed | failed). It also notes digest preservation and that only ready images can be pushed.

Reviewed by Cursor Bugbot for commit 19d5bbe. Bugbot is set up for automated code reviews on this repo. Configure here.

@chruffins
chruffins force-pushed the hypeship/registry-push-docs branch 2 times, most recently from 25be7fd to fdb7cd3 Compare August 5, 2026 19:18
@chruffins
chruffins force-pushed the hypeship/registry-push-docs branch from fdb7cd3 to 3821bf1 Compare August 5, 2026 19:43
@chruffins
chruffins force-pushed the hypeship/registry-push-docs branch from 3821bf1 to 72a31c9 Compare August 5, 2026 19:43
@chruffins
chruffins force-pushed the hypeship/registry-push-docs branch from 72a31c9 to a85bd7e Compare August 5, 2026 19:56
@chruffins
chruffins force-pushed the hypeship/registry-push-docs branch from a85bd7e to fd050e7 Compare August 5, 2026 20:03
@chruffins
chruffins force-pushed the hypeship/registry-push-docs branch from 8824006 to c411bbd Compare August 6, 2026 14:17
@chruffins

chruffins commented Aug 6, 2026

Copy link
Copy Markdown
Author

reviewed — accurate docs; all findings from the review are addressed in c411bbdd and 43740067 ($HYPEMAN_API_KEY in the curl examples, insecure and error-on-failure documented, ECR token hoisted, examples anchored to the real api.hostname/TLS-443 surface, and the api: config block documented).

status: all review findings addressed

@chruffins
chruffins force-pushed the hypeship/registry-push-docs branch from c411bbd to 4374006 Compare August 6, 2026 15:20
@chruffins
chruffins force-pushed the hypeship/registry-push-docs branch from 4374006 to 2a08542 Compare August 6, 2026 16:13
@chruffins
chruffins force-pushed the hypeship/registry-push-docs branch 2 times, most recently from 79b24ff to 0846452 Compare August 6, 2026 21:07
@chruffins
chruffins force-pushed the hypeship/registry-push-docs branch from 0846452 to 19d5bbe Compare August 6, 2026 21:10
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.

1 participant