sidecar

Documentation

Overview

Package sidecar provides supporting infrastructure for Mutagen sidecar images and containers.

Index

• Constants
• func EnvironmentIsSidecar() bool
• func PathIsVolumeMountPoint(path string) (bool, string)
• func SetVolumeOwnershipAndPermissionsIfEmpty(name string, ownership *filesystem.OwnershipSpecification, ...) error

Constants

const (
	// BaseTag is the base tag name for the sidecar image.
	BaseTag = "mutagenio/sidecar"
)

Functions

func EnvironmentIsSidecar

func EnvironmentIsSidecar() bool

EnvironmentIsSidecar returns true if the current operating environment is a Mutagen sidecar container.

func PathIsVolumeMountPoint

func PathIsVolumeMountPoint(path string) (bool, string)

PathIsVolumeMountPoint returns whether or not a path is expected to be a volume mount point within a Mutagen sidecar container. If the path is a volume mount point, then the volume name is also returned. This function is only valid in the context of a Mutagen sidecar container.

func SetVolumeOwnershipAndPermissionsIfEmpty

func SetVolumeOwnershipAndPermissionsIfEmpty(name string, ownership *filesystem.OwnershipSpecification, mode filesystem.Mode) error

SetVolumeOwnershipAndPermissionsIfEmpty will set the ownership and permissions on a sidecar volume if (and only if) the volume is empty.