config

Documentation

Overview

FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:

Index

• func FormatWrite(ctx formatter.Context, configs []swarm.Config) error
• func InspectFormatWrite(ctx 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(ctx formatter.Context, configs []swarm.Config) error

FormatWrite writes the context

func InspectFormatWrite

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

InspectFormatWrite renders the context for a list of configs

func NewConfigCommand

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

NewConfigCommand returns a cobra command for `config` subcommands

func NewFormat

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

NewFormat returns a Format for rendering using a config Context

func RunConfigCreate

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

RunConfigCreate creates a config with the given options.

func RunConfigInspect

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

RunConfigInspect inspects the given Swarm config.

func RunConfigList

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

RunConfigList lists Swarm configs.

func RunConfigRemove

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

RunConfigRemove removes the given Swarm configs.

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.

type InspectOptions

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

InspectOptions contains options for the docker config inspect command.

type ListOptions

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

ListOptions contains options for the docker config ls command.

type RemoveOptions

type RemoveOptions struct {
	Names []string
}

RemoveOptions contains options for the docker config rm command.