docker

package

v0.8.0 Latest Latest Go to latest Published: Jul 21, 2025 License: Apache-2.0 Imports: 27 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/PlanktoScope/forklift

Links

Open Source Insights

Documentation ¶

Overview ¶

Package docker provides a wrapper around Docker Compose's functionality

Index ¶

func CompareDeletedImages(i, j dti.DeleteResponse) int
func LoadAppDefinition(fsys core.PathedFS, name string, configPaths []string, env map[string]string, ...) (*dct.Project, error)
func NewOutStream(out io.Writer) *streams.Out
type Client
- func NewClient(opts ...ClientOption) (*Client, error)
type ClientOption
type Image

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CompareDeletedImages ¶ added in v0.1.6

func CompareDeletedImages(i, j dti.DeleteResponse) int

func LoadAppDefinition ¶ added in v0.2.0

func LoadAppDefinition(
	fsys core.PathedFS, name string, configPaths []string, env map[string]string, resolvePaths bool,
) (*dct.Project, error)

LoadAppDefinition parses the specified Docker Compose files from the provided fs as the current working directory, applies the provided environment variables, and returns a representation of the app as a Docker Compose project.

func NewOutStream ¶ added in v0.1.6

func NewOutStream(out io.Writer) *streams.Out

Types ¶

type Client ¶

type Client struct {
	Client  *dc.Client
	Compose api.Service
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(opts ...ClientOption) (*Client, error)

func (*Client) DeployApp ¶ added in v0.2.0

func (c *Client) DeployApp(
	ctx context.Context, app *dct.Project, waitTimeout time.Duration,
) error

func (*Client) InspectImage ¶ added in v0.1.6

func (c *Client) InspectImage(ctx context.Context, imageHash string) (Image, error)

func (*Client) ListApps ¶ added in v0.2.0

func (c *Client) ListApps(ctx context.Context) ([]api.Stack, error)

func (*Client) ListContainers ¶ added in v0.2.0

func (c *Client) ListContainers(ctx context.Context, appName string) ([]dtc.Summary, error)

func (*Client) ListImages ¶ added in v0.1.6

func (c *Client) ListImages(ctx context.Context, matchName string) ([]Image, error)

func (*Client) PruneUnusedImages ¶ added in v0.1.6

func (c *Client) PruneUnusedImages(ctx context.Context) (dti.PruneReport, error)

func (*Client) PullImage ¶ added in v0.1.6

func (c *Client) PullImage(
	ctx context.Context, taggedName, platform string, outStream *streams.Out,
) (trust.ImageRefAndAuth, error)

func (*Client) RemoveApps ¶ added in v0.2.0

func (c *Client) RemoveApps(ctx context.Context, names []string) error

type ClientOption ¶ added in v0.5.0

type ClientOption func(clientOptions) clientOptions

func WithConcurrencySafeOutput ¶ added in v0.5.0

func WithConcurrencySafeOutput() ClientOption

func WithErrorStream ¶ added in v0.8.0

func WithErrorStream(w io.Writer) ClientOption

func WithOutputStream ¶ added in v0.8.0

func WithOutputStream(w io.Writer) ClientOption

type Image ¶ added in v0.1.6

type Image struct {
	Repository string
	Tag        string
	ID         string
	Inspect    dti.InspectResponse
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL