Skip to content

fix(config): scope library/ prefix to Docker Hub #4022

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.

Sign up for GitHub

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

Open
louis-kauer wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(config): scope library/ prefix to Docker Hub #4022

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2121,8 +2121,8 @@ func (i *Image) String() (ref string) {
if i.Registry != "" {
ref = i.Registry + "/"
}

if i.Registry != "" && i.Repository != "" && !strings.ContainsRune(i.Repository, '/') {
if isDockerHub(i.Registry) && i.Repository != "" && !strings.ContainsRune(i.Repository, '/') {
ref += "library/"
}
ref += i.Repository
Expand All @@ -2134,6 +2134,18 @@ func (i *Image) String() (ref string) {
return ref
}

const (
dockerHubRegistry = "index.docker.io"
dockerHubRegistryAlias = "docker.io"
)

// isDockerHub reports whether the registry refers to Docker Hub. The
// "library/" namespace is a Docker Hub implementation detail and must not be
// applied to any other registry
func isDockerHub(registry string) bool {
return registry == dockerHubRegistry || registry == dockerHubRegistryAlias
}

type ImagePullSecretName struct {
// Name of the image pull secret to use.
Name string `json:"name,omitempty"`
Expand Down
48 changes: 46 additions & 2 deletions config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,13 +443,57 @@ func TestImage_String(t *testing.T) {
expected: "alpine",
},
{
name: "omit repo but not registry is library",
name: "omit repo on non-docker-hub registry does not add library prefix",
image: Image{
Registry: "ghcr.io",
Repository: "alpine",
Tag: "3.20",
},
expected: "ghcr.io/library/alpine:3.20",
expected: "ghcr.io/alpine:3.20",
},
{
name: "docker hub canonical registry preserves library prefix",
image: Image{
Registry: "index.docker.io",
Repository: "alpine",
Tag: "3.20",
},
expected: "index.docker.io/library/alpine:3.20",
},
{
name: "docker hub alias registry preserves library prefix",
image: Image{
Registry: "docker.io",
Repository: "alpine",
Tag: "3.20",
},
expected: "docker.io/library/alpine:3.20",
},
{
name: "registry.k8s.io single-segment repo does not add library prefix",
image: Image{
Registry: "registry.k8s.io",
Repository: "pause",
Tag: "3.9",
},
expected: "registry.k8s.io/pause:3.9",
},
{
name: "private registry with port and single-segment repo",
image: Image{
Registry: "my-registry.example.com:443",
Repository: "app",
},
expected: "my-registry.example.com:443/app",
},
{
name: "non docker hub multi-segment repo unchanged",
image: Image{
Registry: "ghcr.io",
Repository: "loft-sh/vcluster",
Tag: "0.20.0",
},
expected: "ghcr.io/loft-sh/vcluster:0.20.0",
},
{
name: "registry may have port",
Expand Down