docker

package

v0.5.2 Latest Latest Go to latest Published: Sep 3, 2026 License: GPL-2.0 Imports: 19 Imported by: 0

Details

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

Repository

github.com/tech-arch1tect/berth-agent

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func NewRawClient() (*client.Client, error)
type Client
- func NewClient(logger *logging.Logger) (*Client, error)
type CommandExecutor
- func NewCommandExecutor(stackLocation string) *CommandExecutor
- func (e *CommandExecutor) ExecuteComposeCommand(stackName string, args ...string) (*exec.Cmd, error)
type ContainerRunSpec
type SystemPruneReport

Constants ¶

View Source

const (
	LabelComposeProject         = "com.docker.compose.project"
	LabelComposeService         = "com.docker.compose.service"
	LabelComposeContainerNumber = "com.docker.compose.container-number"
	LabelComposeWorkingDir      = "com.docker.compose.project.working_dir"
)

Variables ¶

View Source

var Module = fx.Options(
	fx.Provide(NewClient),
	fx.Provide(NewRawClient),
)

Functions ¶

func NewRawClient ¶

func NewRawClient() (*client.Client, error)

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(logger *logging.Logger) (*Client, error)

func (*Client) BuildCachePrune ¶

func (c *Client) BuildCachePrune(ctx context.Context, all bool) (build.CachePruneReport, error)

func (*Client) Close ¶

func (c *Client) Close() error

func (*Client) ContainerInspect ¶

func (c *Client) ContainerInspect(ctx context.Context, containerID string) (container.InspectResponse, error)

func (*Client) ContainerList ¶

func (c *Client) ContainerList(ctx context.Context, filterLabels map[string][]string) ([]container.Summary, error)

func (*Client) ContainerPrune ¶

func (c *Client) ContainerPrune(ctx context.Context) (container.PruneReport, error)

func (*Client) ContainerRemove ¶

func (c *Client) ContainerRemove(ctx context.Context, containerID string, removeVolumes, removeLinks, force bool) error

func (*Client) ContainerStart ¶ added in v0.5.1

func (c *Client) ContainerStart(ctx context.Context, containerID string) error

func (*Client) ContainerStats ¶

func (c *Client) ContainerStats(ctx context.Context, containerID string, stream bool) (container.StatsResponseReader, error)

func (*Client) ContainerStop ¶ added in v0.5.1

func (c *Client) ContainerStop(ctx context.Context, containerID string) error

func (*Client) CreateVolume ¶ added in v0.5.1

func (c *Client) CreateVolume(ctx context.Context, name, driver string, driverOpts, labels map[string]string) (volume.Volume, error)

func (*Client) GetNetworksByLabels ¶

func (c *Client) GetNetworksByLabels(ctx context.Context, labels map[string]string) ([]network.Summary, error)

func (*Client) GetVolumesByLabels ¶

func (c *Client) GetVolumesByLabels(ctx context.Context, labels map[string]string) ([]*volume.Volume, error)

func (*Client) ImageHistory ¶

func (c *Client) ImageHistory(ctx context.Context, imageID string) ([]image.HistoryResponseItem, error)

func (*Client) ImageInspect ¶

func (c *Client) ImageInspect(ctx context.Context, imageID string) (image.InspectResponse, error)

func (*Client) ImagePrune ¶

func (c *Client) ImagePrune(ctx context.Context, all bool) (image.PruneReport, error)

func (*Client) ImageRemove ¶

func (c *Client) ImageRemove(ctx context.Context, imageID string) ([]image.DeleteResponse, error)

func (*Client) InspectNetwork ¶

func (c *Client) InspectNetwork(ctx context.Context, networkID string) (network.Inspect, error)

func (*Client) InspectVolume ¶

func (c *Client) InspectVolume(ctx context.Context, volumeID string) (*volume.Volume, error)

func (*Client) ListNetworks ¶

func (c *Client) ListNetworks(ctx context.Context) ([]network.Summary, error)

func (*Client) ListVolumes ¶

func (c *Client) ListVolumes(ctx context.Context) (volume.ListResponse, error)

func (*Client) NetworkPrune ¶

func (c *Client) NetworkPrune(ctx context.Context) (network.PruneReport, error)

func (*Client) NetworkRemove ¶

func (c *Client) NetworkRemove(ctx context.Context, networkID string) error

func (*Client) RunContainer ¶ added in v0.5.1

func (c *Client) RunContainer(ctx context.Context, spec ContainerRunSpec, stdout, stderr io.Writer) (int, error)

func (*Client) SystemDiskUsage ¶

func (c *Client) SystemDiskUsage(ctx context.Context) (types.DiskUsage, error)

func (*Client) SystemInfo ¶

func (c *Client) SystemInfo(ctx context.Context) (system.Info, error)

func (*Client) SystemPrune ¶

func (c *Client) SystemPrune(ctx context.Context, all bool) (SystemPruneReport, error)

func (*Client) SystemVersion ¶

func (c *Client) SystemVersion(ctx context.Context) (types.Version, error)

func (*Client) VolumePrune ¶

func (c *Client) VolumePrune(ctx context.Context, all bool) (volume.PruneReport, error)

func (*Client) VolumeRemove ¶

func (c *Client) VolumeRemove(ctx context.Context, volumeID string) error

type CommandExecutor ¶

type CommandExecutor struct {
	// contains filtered or unexported fields
}

func NewCommandExecutor ¶

func NewCommandExecutor(stackLocation string) *CommandExecutor

func (*CommandExecutor) ExecuteComposeCommand ¶

func (e *CommandExecutor) ExecuteComposeCommand(stackName string, args ...string) (*exec.Cmd, error)

type ContainerRunSpec ¶ added in v0.5.1

type ContainerRunSpec struct {
	Image      string
	Entrypoint []string
	Cmd        []string
	Env        []string
	Mounts     []mount.Mount
	Labels     map[string]string
	WorkingDir string
}

type SystemPruneReport ¶

type SystemPruneReport struct {
	ContainersDeleted []string
	NetworksDeleted   []string
	CachesDeleted     []string
	ImagesDeleted     []image.DeleteResponse
	SpaceReclaimed    uint64
}

Source Files ¶

View all Source files

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