client

Documentation

Overview

Package client provides Docker client initiatialisation functions.

Index

• func CreateContext(contextName string, user string, port string) error
• func DeleteContext(name string) error
• func GetContext(contextName string) (contextStore.Metadata, error)
• func GetRegistryTags(img reference.Named) ([]string, error)
• func GetVolumeNames(volumes []*volume.Volume) []string
• func GetVolumes(cl *client.Client, ctx context.Context, server string, fs filters.Args) ([]*volume.Volume, error)
• func New(serverName string) (*client.Client, error)
• func RemoveVolumes(cl *client.Client, ctx context.Context, volumeNames []string, force bool, ...) error
• func StoreSecret(cl *client.Client, secretName, secretValue, server string) error
• type Context

Functions

func CreateContext

func CreateContext(contextName string, user string, port string) error

func DeleteContext

func DeleteContext(name string) error

func GetContext

func GetContext(contextName string) (contextStore.Metadata, error)

func GetRegistryTags

func GetRegistryTags(img reference.Named) ([]string, error)

GetRegistryTags retrieves all tags of an image from a container registry.

func GetVolumeNames

func GetVolumeNames(volumes []*volume.Volume) []string

func GetVolumes

func GetVolumes(cl *client.Client, ctx context.Context, server string, fs filters.Args) ([]*volume.Volume, error)

func New

func New(serverName string) (*client.Client, error)

New initiates a new Docker client. New client connections are validated so that we ensure connections via SSH to the daemon can succeed. It takes into account that you may only want the local client and not communicate via SSH. For this use-case, please pass "default" as the contextName.

func RemoveVolumes

func RemoveVolumes(cl *client.Client, ctx context.Context, volumeNames []string, force bool, retries int) error

func StoreSecret

func StoreSecret(cl *client.Client, secretName, secretValue, server string) error

Types

type Context

type Context = contextStore.Metadata