Documentation
¶
Overview ¶
Package utils is for commonly used functions.
Package utils is for commonly used functions
Index ¶
- Constants
- func CreateDirectory(path string, mode os.FileMode) error
- func DownloadToFile(ctx context.Context, src, dst string) (err error)
- func DownloadToFileWithChecksum(ctx context.Context, src, dst, checksum, cacheBaseName string) (err error)
- func FilterDebianLinux(h *cluster.ZarfHost) bool
- func FilterEngineAlreadyPopulated(h *cluster.ZarfHost) bool
- func FilterEnterpriseLinux(h *cluster.ZarfHost) bool
- func IdentifySource(src string) (string, error)
- func InvalidPath(path string) bool
- func IsDebianLinux(con os.Configurer) bool
- func IsEnterpriseLinux(con os.Configurer) bool
- func MakeTempDir(basePath string) (string, error)
- func PrintJSON(obj any) string
- func RandomString(length int) (string, error)
- func ReadByteStrict(data []byte, destConfig any) error
- func ReadYAMLStrict(path string, destConfig any) error
- func ResolveCachePath(cachePath string) (string, error)
Constants ¶
const ( // TmpPathPrefix is the shared prefix used for all temporary directories TmpPathPrefix = "cargoship-" // ReadWriteExecuteUser is used for any directory or executable not normally used by the end user or containing sensitive data ReadWriteExecuteUser = 0700 )
const CacheDir = "cargoship"
CacheDir is the subdirectory name used under the OS user cache directory for cargoship's shared cache.
Variables ¶
This section is empty.
Functions ¶
func CreateDirectory ¶ added in v0.3.0
CreateDirectory creates a directory for the given path and file mode.
func DownloadToFile ¶ added in v0.3.0
DownloadToFile downloads a given URL to the target filepath (including the cosign key if necessary). When src contains an inline checksum in the form URL@sha256, that checksum is used. For struct-based callers, prefer DownloadToFileWithChecksum.
func DownloadToFileWithChecksum ¶ added in v0.13.0
func DownloadToFileWithChecksum(ctx context.Context, src, dst, checksum, cacheBaseName string) (err error)
DownloadToFileWithChecksum downloads src to dst, using checksum (if non-empty) for validation and caching. checksum SHOULD come from structured config (e.g. ZarfFile.Shasum) rather than being encoded into src.
func FilterDebianLinux ¶
FilterDebianLinux is a function used to filter whether a host is a Debian based OS
func FilterEngineAlreadyPopulated ¶
FilterEngineAlreadyPopulated is a function used to filter whether a host already has distro files populated
func FilterEnterpriseLinux ¶
FilterEnterpriseLinux is a function used to filter whether a host is an Enterprise Linux OS
func IdentifySource ¶
IdentifySource returns the source type for the given source string.
func InvalidPath ¶ added in v0.3.0
InvalidPath checks if the given path is valid (if it is a permissions error it is there we just don't have access)
func IsDebianLinux ¶
func IsDebianLinux(con os.Configurer) bool
IsDebianLinux is true if the os.Configurer is of a type of Debian based OS
func IsEnterpriseLinux ¶
func IsEnterpriseLinux(con os.Configurer) bool
IsEnterpriseLinux is true if the os.Configurer is of a type of Enterprise Linux
func MakeTempDir ¶ added in v0.3.0
MakeTempDir creates a temp directory with the zarf- prefix.
func RandomString ¶
RandomString returns a string of hexadecimal characters of a given length that is cryptographically secure, or an error
func ReadByteStrict ¶
ReadByteStrict reads a byte array and tries to place it in the provided "destConfig" object
func ReadYAMLStrict ¶
ReadYAMLStrict reads a YAML file into a struct, with strict parsing
func ResolveCachePath ¶ added in v0.13.0
ResolveCachePath returns cachePath if non-empty, otherwise falls back to filepath.Join(os.UserCacheDir(), "cargoship") which respects XDG_CACHE_HOME on Linux.
Types ¶
This section is empty.
Source Files
Directories