dockersetup

Documentation

Index

• Constants
• type Options
  • func (o *Options) BindFlags(flags *pflag.FlagSet)
  • func (o *Options) Build() (*dockerclient.Client, error)
  • func (o *Options) SetDefaultOptions(flags *pflag.FlagSet)

Constants

const (
	// EnvEnableTLS is the name of the environment variable that can be used
	// to enable TLS for client connections. When set to a non-empty value, TLS
	// is enabled for API connections using TCP. For backward-compatibility, this
	// environment-variable can only be used to enable TLS, not to disable.
	//
	// Note that TLS is always enabled implicitly if the "--tls-verify" option
	// or "DOCKER_TLS_VERIFY" ([github.com/docker/docker/client.EnvTLSVerify])
	// env var is set to, which could be to either enable or disable TLS certification
	// validation. In both cases, TLS is enabled but, depending on the setting,
	// with verification disabled.
	EnvEnableTLS = "DOCKER_TLS"

	// DefaultCaFile is the default filename for the CA pem file
	DefaultCaFile = "ca.pem"
	// DefaultKeyFile is the default filename for the key pem file
	DefaultKeyFile = "key.pem"
	// DefaultCertFile is the default filename for the cert pem file
	DefaultCertFile = "cert.pem"
	// FlagTLSVerify is the flag name for the TLS verification option
	FlagTLSVerify = "tlsverify"
	// FormatHelp describes the --format flag behavior for list commands
	FormatHelp = `` /* 405-byte string literal not displayed */

	// InspectFormatHelp describes the --format flag behavior for inspect commands
	InspectFormatHelp = `` /* 249-byte string literal not displayed */

)

Types

type Options

type Options struct {
	Hosts      []string `env:"DOCKER_HOST"`
	TLS        bool
	TLSVerify  bool
	TLSOptions *tlsconfig.Options
	Context    string
	ConfigDir  string
}

ClientOptions are the options used to configure the client cli.

func (*Options) BindFlags

func (o *Options) BindFlags(flags *pflag.FlagSet)

InstallFlags adds flags for the common options on the FlagSet

func (*Options) Build

func (o *Options) Build() (*dockerclient.Client, error)

func (*Options) SetDefaultOptions

func (o *Options) SetDefaultOptions(flags *pflag.FlagSet)

SetDefaultOptions sets default values for options after flag parsing is complete