volumehelper

package
v2.10.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 5, 2026 License: BSD-3-Clause Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ContainerLabel = "com.getarcaneapp.volume-helper"
)

Variables

This section is empty.

Functions

func DownloadFileFromContainer added in v2.8.0

func DownloadFileFromContainer(
	ctx context.Context,
	dockerClient *client.Client,
	containerID string,
	containerPath string,
	cleanup func(),
) (io.ReadCloser, int64, error)

func HostConfig

func HostConfig(helperImage string, binds []string, mounts []mount.Mount) *container.HostConfig

HostConfig builds the host config shared by volume helper containers.

func Labels

func Labels() map[string]string

Labels returns the labels used for temporary internal volume helper containers.

func RemoveOptions

func RemoveOptions() client.ContainerRemoveOptions

RemoveOptions returns the container remove options used for volume helpers.

func ResolveArcaneRuntimeImage

func ResolveArcaneRuntimeImage(ctx context.Context, dockerClient *client.Client) mo.Option[RuntimeImage]

ResolveArcaneRuntimeImage resolves the current Arcane or Arcane agent image so internal helper commands can run without pulling an external helper image.

func ResolveHelperImage

func ResolveHelperImage(ctx context.Context, dockerClient *client.Client, toolsImage string) (string, error)

ResolveHelperImage returns an image suitable for temporary volume helper containers, pulling the tools image when it is not already present.

func ToolsImage added in v2.10.2

func ToolsImage(registry string) string

ToolsImage returns the shared Arcane tools image reference hosted on the given registry setting.

Types

type RuntimeImage

type RuntimeImage struct {
	Image      string
	Entrypoint []string
	Command    []string
	Source     string
}

RuntimeImage describes the Arcane runtime image that can run internal helper commands from inside temporary containers.

Jump to

Keyboard shortcuts

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