Documentation
¶
Index ¶
- Constants
- func DownloadFileFromContainer(ctx context.Context, dockerClient *client.Client, containerID string, ...) (io.ReadCloser, int64, error)
- func HostConfig(helperImage string, binds []string, mounts []mount.Mount) *container.HostConfig
- func Labels() map[string]string
- func RemoveOptions() client.ContainerRemoveOptions
- func ResolveArcaneRuntimeImage(ctx context.Context, dockerClient *client.Client) mo.Option[RuntimeImage]
- func ResolveHelperImage(ctx context.Context, dockerClient *client.Client, toolsImage string) (string, error)
- func ToolsImage(registry string) string
- type RuntimeImage
Constants ¶
View Source
const (
ContainerLabel = "com.getarcaneapp.volume-helper"
)
Variables ¶
This section is empty.
Functions ¶
func DownloadFileFromContainer ¶ added in v2.8.0
func HostConfig ¶
HostConfig builds the host config shared by 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
ToolsImage returns the shared Arcane tools image reference hosted on the given registry setting.
Types ¶
Click to show internal directories.
Click to hide internal directories.