dockercfg

Documentation

Overview

Package dockercfg contains a command helper to read .dockercfg files

Index

• Constants
• func GetDockerConfig(path []string) (cfg credentialprovider.DockerConfig, err error)
• func GetDockercfgFile(path string) string
• func ReadDockerConfigJsonFileGeneratedFromSecret(path []string) (cfg credentialprovider.DockerConfig, err error)
• type Helper
  • func NewHelper() *Helper
  • func (h *Helper) GetDockerAuth(imageName, authType string) (docker.AuthConfiguration, bool)
  • func (h *Helper) InstallFlags(flags *pflag.FlagSet)

Constants

const (
	PushAuthType       = "PUSH_DOCKERCFG_PATH"
	PullAuthType       = "PULL_DOCKERCFG_PATH"
	PullSourceAuthType = "PULL_SOURCE_DOCKERCFG_PATH_"
	// DockerConfigKey is the key of the required data for SecretTypeDockercfg secrets
	DockerConfigKey = ".dockercfg"
	// DockerConfigJsonKey is the key of the required data for SecretTypeDockerConfigJson secrets
	DockerConfigJsonKey = ".dockerconfigjson"
)

Functions

func GetDockerConfig

func GetDockerConfig(path []string) (cfg credentialprovider.DockerConfig, err error)

GetDockerConfig return docker config info by checking given paths

func GetDockercfgFile

func GetDockercfgFile(path string) string

GetDockercfgFile returns the path to the dockercfg file

func ReadDockerConfigJsonFileGeneratedFromSecret

func ReadDockerConfigJsonFileGeneratedFromSecret(path []string) (cfg credentialprovider.DockerConfig, err error)

ReadDockerConfigJsonFileGeneratedFromSecret return DockerConfig by reading specific file named .dockerconfigjson generated by secret from given paths.

Types

type Helper

type Helper struct {
}

Helper contains all the valid config options for reading the local dockercfg file

func NewHelper

func NewHelper() *Helper

NewHelper creates a Flags object with the default values set.

func (*Helper) GetDockerAuth

func (h *Helper) GetDockerAuth(imageName, authType string) (docker.AuthConfiguration, bool)

GetDockerAuth returns a valid Docker AuthConfiguration entry, and whether it was read from the local dockercfg file

func (*Helper) InstallFlags

func (h *Helper) InstallFlags(flags *pflag.FlagSet)

InstallFlags installs the Docker flag helper into a FlagSet with the default options and default values from the Helper object.