Files
dokku/plugins/registry/report.go
T
Jose Diaz-Gonzalez 624eea1959 feat: add registry:auth-status to read back login state
There was no way to ask whether Dokku was already logged in to a registry with a given credential, so tooling converging a declared state onto a server had to re-run `registry:login` on every pass purely to discover that nothing needed to change. The new `registry:auth-status` command compares a supplied credential against the stored one and reports the result through its exit code alone, distinguishing a server with no credential from one whose credential differs, and from one whose secret a docker credential helper or an identity token puts out of reach. An `auth-servers` triad on `registry:report` exposes which servers have credentials without emitting any part of one.
2026-09-19 19:19:57 -04:00

199 lines
6.5 KiB
Go

package registry
import (
"os"
"path/filepath"
"strings"
"github.com/dokku/dokku/plugins/common"
)
// ReportSingleApp is an internal function that displays the registry report for one or more apps
func ReportSingleApp(appName string, format string, infoFlag string) error {
if appName != "--global" {
if err := common.VerifyAppName(appName); err != nil {
return err
}
}
var flags map[string]common.ReportFunc
if appName == "--global" {
flags = map[string]common.ReportFunc{
"--registry-computed-auth-servers": reportComputedAuthServers,
"--registry-global-auth-servers": reportGlobalAuthServers,
"--registry-computed-push-on-release": reportComputedPushOnRelease,
"--registry-global-push-on-release": reportGlobalPushOnRelease,
"--registry-computed-server": reportComputedServer,
"--registry-global-server": reportGlobalServer,
"--registry-computed-image-repo-template": reportComputedImageRepoTemplate,
"--registry-global-image-repo-template": reportGlobalImageRepoTemplate,
"--registry-computed-push-extra-tags": reportComputedPushExtraTags,
"--registry-global-push-extra-tags": reportGlobalPushExtraTags,
}
} else {
flags = map[string]common.ReportFunc{
"--registry-auth-servers": reportAuthServers,
"--registry-computed-auth-servers": reportComputedAuthServers,
"--registry-global-auth-servers": reportGlobalAuthServers,
"--registry-computed-image-repo": reportComputedImageRepo,
"--registry-image-repo": reportImageRepo,
"--registry-computed-push-on-release": reportComputedPushOnRelease,
"--registry-global-push-on-release": reportGlobalPushOnRelease,
"--registry-push-on-release": reportPushOnRelease,
"--registry-computed-server": reportComputedServer,
"--registry-global-server": reportGlobalServer,
"--registry-computed-image-repo-template": reportComputedImageRepoTemplate,
"--registry-global-image-repo-template": reportGlobalImageRepoTemplate,
"--registry-image-repo-template": reportImageRepoTemplate,
"--registry-server": reportServer,
"--registry-tag-version": reportTagVersion,
"--registry-push-extra-tags": reportPushExtraTags,
"--registry-global-push-extra-tags": reportGlobalPushExtraTags,
"--registry-computed-push-extra-tags": reportComputedPushExtraTags,
}
}
flagKeys := []string{}
for flagKey := range flags {
flagKeys = append(flagKeys, flagKey)
}
infoFlags := common.CollectReport(appName, infoFlag, flags)
return common.ReportSingleApp(common.ReportSingleAppInput{
ReportType: "registry",
AppName: appName,
InfoFlag: infoFlag,
InfoFlags: infoFlags,
InfoFlagKeys: flagKeys,
Format: format,
TrimPrefix: true,
UppercaseFirstCharacter: true,
EmitLegacyPrefix: true,
})
}
func reportComputedImageRepo(appName string) string {
imageRepo := strings.TrimSpace(reportImageRepo(appName))
if imageRepo == "" {
imageRepo, _ = getImageRepoFromTemplate(appName)
}
if imageRepo == "" {
imageRepo = common.GetAppImageRepo(appName)
}
return imageRepo
}
func reportImageRepo(appName string) string {
return common.PropertyGet("registry", appName, "image-repo")
}
func reportComputedPushOnRelease(appName string) string {
value := reportPushOnRelease(appName)
value = strings.TrimSpace(value)
if value == "" {
value = reportGlobalPushOnRelease(appName)
}
if value == "" {
value = DefaultProperties["push-on-release"]
}
return value
}
func reportGlobalPushOnRelease(appName string) string {
return common.PropertyGet("registry", "--global", "push-on-release")
}
func reportPushOnRelease(appName string) string {
return common.PropertyGet("registry", appName, "push-on-release")
}
func reportComputedServer(appName string) string {
server := getRegistryServerForApp(appName)
return strings.TrimSpace(server)
}
func reportImageRepoTemplate(appName string) string {
return common.PropertyGet("registry", appName, "image-repo-template")
}
func reportGlobalImageRepoTemplate(appName string) string {
return common.PropertyGet("registry", "--global", "image-repo-template")
}
func reportComputedImageRepoTemplate(appName string) string {
value := strings.TrimSpace(reportImageRepoTemplate(appName))
if value == "" {
value = reportGlobalImageRepoTemplate(appName)
}
return value
}
func reportGlobalServer(appName string) string {
return common.PropertyGet("registry", "--global", "server")
}
func reportServer(appName string) string {
return common.PropertyGet("registry", appName, "server")
}
func reportTagVersion(appName string) string {
tagVersion := common.PropertyGet("registry", appName, "tag-version")
return strings.TrimSpace(tagVersion)
}
func reportPushExtraTags(appName string) string {
return common.PropertyGet("registry", appName, "push-extra-tags")
}
func reportGlobalPushExtraTags(appName string) string {
return common.PropertyGet("registry", "--global", "push-extra-tags")
}
func reportComputedPushExtraTags(appName string) string {
value := strings.TrimSpace(reportPushExtraTags(appName))
if value == "" {
value = reportGlobalPushExtraTags(appName)
}
if value == "" {
value = DefaultProperties["push-extra-tags"]
}
return value
}
// reportAuthServers lists the servers the app has its own credentials for
func reportAuthServers(appName string) string {
return authServersFromConfigPath(GetAppRegistryConfigPath(appName))
}
// reportGlobalAuthServers lists the servers the global config has credentials for
func reportGlobalAuthServers(appName string) string {
return authServersFromConfigPath(GetGlobalRegistryConfigPath())
}
// reportComputedAuthServers lists the servers whose credentials dokku would use
// for the app. Docker is pointed at one config directory or the other rather
// than a merge of both, so an app with any credential of its own shadows the
// global config entirely.
func reportComputedAuthServers(appName string) string {
return authServersFromConfigPath(filepath.Join(GetComputedAppRegistryConfigDir(appName), "config.json"))
}
// authServersFromConfigPath lists the servers a docker config holds credentials for
func authServersFromConfigPath(configPath string) string {
contents, err := os.ReadFile(configPath)
if err != nil {
return ""
}
config, err := parseDockerConfig(contents)
if err != nil {
return ""
}
return strings.Join(authServersFromConfig(config), ",")
}