Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use fully qualified image names #702

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

hhiroshell
Copy link

@hhiroshell hhiroshell commented May 1, 2024

Addresses the buildpacks/pack#1218, specifically the modifications to the documentation.

This PR changes the container image names used in the document to fully qualified names. Currently, I'm adopting the following policies:

  • Unless there is a specific reason not to, use registry.example.com for the hostname and example for the organization name.
    • Example: registry.example.com/example/my-app
    • One exception: In for-buildpack-authors/concepts/lifecycle-phases.md I used registry.fake as hostname. Because the name is already used in other parts of the page including terminal recordings, and it's too time-consuming to fix.
  • In tutorial pages or similar contexts where commands are expected to work, use an implied hostname to avoid breaking functioning commands.
    • Example: use docker.io/ubuntu:jammy instead of ubuntu:jammy
  • Do not add a remote registry name to an image that is built and used only within a local environment.

And I fixed some technical errors like typos found when I read through the documents.

@@ -42,8 +42,8 @@ Stacks are used by [builders][builder] and are configured through a builder's

[stack]
id = "com.example.stack"
build-image = "example/build"
run-image = "example/run"
build-image = "docker.io/example/build"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this image need a registry? I think this may meet your criteria of only being used in the local environment

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my understanding, this image means it is pulled from a remote registry to be used as a build environment, so I thought it should be specified with the registry name.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be okay, the daemon will happily accept some-image and index.docker.io/some-image interchangeably.

Side note, while docker.io/some-image is correct, all of our code will resolve a registry-less image name to index.docker.io/<image> so I think using the fully qualified domain would be clearer.

@hhiroshell hhiroshell force-pushed the fix-pack-1218 branch 2 times, most recently from 4fc4c20 to 8a4c3a5 Compare May 31, 2024 07:56
Signed-off-by: Hiroshi Hayakawa <[email protected]>
@hhiroshell hhiroshell marked this pull request as ready for review May 31, 2024 08:12
@hhiroshell hhiroshell requested a review from a team as a code owner May 31, 2024 08:12
@hhiroshell hhiroshell changed the title [WIP] Use fully qualified image names Use fully qualified image names May 31, 2024
Signed-off-by: Hiroshi Hayakawa <[email protected]>
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.

3 participants