config

Documentation

Index

• func FormatWrite(fmtCtx formatter.Context, configs []swarm.Config) error
• func InspectFormatWrite(fmtCtx formatter.Context, refs []string, getRef inspect.GetRefFunc) error
• func NewConfigCommand(dockerCLI command.Cli) *cobra.Command
• func NewFormat(source string, quiet bool) formatter.Format
• func RunConfigCreate(ctx context.Context, dockerCLI command.Cli, options CreateOptions) error
• func RunConfigInspect(ctx context.Context, dockerCLI command.Cli, opts InspectOptions) error
• func RunConfigList(ctx context.Context, dockerCLI command.Cli, options ListOptions) error
• func RunConfigRemove(ctx context.Context, dockerCLI command.Cli, opts RemoveOptions) error
• type CreateOptions
• type InspectOptions
• type ListOptions
• type RemoveOptions

Functions

func FormatWrite

func FormatWrite(fmtCtx formatter.Context, configs []swarm.Config) error

FormatWrite writes the context

Deprecated: this function was only used internally and will be removed in the next release.

func InspectFormatWrite

func InspectFormatWrite(fmtCtx formatter.Context, refs []string, getRef inspect.GetRefFunc) error

InspectFormatWrite renders the context for a list of configs

Deprecated: this function was only used internally and will be removed in the next release.

func NewConfigCommand

func NewConfigCommand(dockerCLI command.Cli) *cobra.Command

NewConfigCommand returns a cobra command for `config` subcommands

Deprecated: Do not import commands directly. They will be removed in a future release.

func NewFormat

func NewFormat(source string, quiet bool) formatter.Format

NewFormat returns a Format for rendering using a config Context

Deprecated: this function was only used internally and will be removed in the next release.

func RunConfigCreate

func RunConfigCreate(ctx context.Context, dockerCLI command.Cli, options CreateOptions) error

RunConfigCreate creates a config with the given options.

Deprecated: this function was for internal use and will be removed in the next release.

func RunConfigInspect

func RunConfigInspect(ctx context.Context, dockerCLI command.Cli, opts InspectOptions) error

RunConfigInspect inspects the given Swarm config.

Deprecated: this function was for internal use and will be removed in the next release.

func RunConfigList

func RunConfigList(ctx context.Context, dockerCLI command.Cli, options ListOptions) error

RunConfigList lists Swarm configs.

Deprecated: this function was for internal use and will be removed in the next release.

func RunConfigRemove

func RunConfigRemove(ctx context.Context, dockerCLI command.Cli, opts RemoveOptions) error

RunConfigRemove removes the given Swarm configs.

Deprecated: this function was for internal use and will be removed in the next release.

Types

type CreateOptions

type CreateOptions struct {
	Name           string
	TemplateDriver string
	File           string
	Labels         opts.ListOpts
}

CreateOptions specifies some options that are used when creating a config.

Deprecated: this type was for internal use and will be removed in the next release.

type InspectOptions

type InspectOptions struct {
	Names  []string
	Format string
	Pretty bool
}

InspectOptions contains options for the docker config inspect command.

Deprecated: this type was for internal use and will be removed in the next release.

type ListOptions

type ListOptions struct {
	Quiet  bool
	Format string
	Filter opts.FilterOpt
}

ListOptions contains options for the docker config ls command.

Deprecated: this type was for internal use and will be removed in the next release.

type RemoveOptions

type RemoveOptions struct {
	Names []string
}

RemoveOptions contains options for the docker config rm command.

Deprecated: this type was for internal use and will be removed in the next release.