paths

package
v0.0.7 Latest Latest
Warning

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

 Go to latest Published: Mar 3, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package paths provides centralized path construction for hypeman data directory.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Paths 

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

Paths provides typed path construction for the hypeman data directory.

func New 

func New(dataDir string) *Paths

New creates a new Paths instance for the given data directory.

func (*Paths) BuildConfig 

func (p *Paths) BuildConfig(id string) string

BuildConfig returns the path to the build config file (passed to builder VM).

func (*Paths) BuildDir 

func (p *Paths) BuildDir(id string) string

BuildDir returns the directory for a specific build.

func (*Paths) BuildLog 

func (p *Paths) BuildLog(id string) string

BuildLog returns the path to the main build log file.

func (*Paths) BuildLogs 

func (p *Paths) BuildLogs(id string) string

BuildLogs returns the path to build logs directory.

func (*Paths) BuildMetadata 

func (p *Paths) BuildMetadata(id string) string

BuildMetadata returns the path to build metadata.json.

func (*Paths) BuildSourceDir 

func (p *Paths) BuildSourceDir(id string) string

BuildSourceDir returns the path to the source directory for a build.

func (*Paths) BuildsDir 

func (p *Paths) BuildsDir() string

BuildsDir returns the root builds directory.

func (*Paths) CaddyBinary 

func (p *Paths) CaddyBinary(version, arch string) string

CaddyBinary returns the path to the caddy binary.

func (*Paths) CaddyConfig 

func (p *Paths) CaddyConfig() string

CaddyConfig returns the path to the caddy config file.

func (*Paths) CaddyConfigDir 

func (p *Paths) CaddyConfigDir() string

CaddyConfigDir returns the path to Caddy's config directory.

func (*Paths) CaddyDataDir 

func (p *Paths) CaddyDataDir() string

CaddyDataDir returns the path to Caddy's data directory (for certs, etc.).

func (*Paths) CaddyDir 

func (p *Paths) CaddyDir() string

CaddyDir returns the caddy data directory.

func (*Paths) CaddyLogFile 

func (p *Paths) CaddyLogFile() string

CaddyLogFile returns the path to the caddy log file.

func (*Paths) CaddyPIDFile 

func (p *Paths) CaddyPIDFile() string

CaddyPIDFile returns the path to the caddy PID file.

func (*Paths) DataDir 

func (p *Paths) DataDir() string

DataDir returns the root data directory.

func (*Paths) DeviceDir 

func (p *Paths) DeviceDir(id string) string

DeviceDir returns the directory for a device.

func (*Paths) DeviceMetadata 

func (p *Paths) DeviceMetadata(id string) string

DeviceMetadata returns the path to device metadata.json.

func (*Paths) DevicesDir 

func (p *Paths) DevicesDir() string

DevicesDir returns the root devices directory.

func (*Paths) FirecrackerBinary added in v0.0.7 

func (p *Paths) FirecrackerBinary(version, arch string) string

FirecrackerBinary returns the path to a firecracker VMM binary.

func (*Paths) GuestsDir 

func (p *Paths) GuestsDir() string

GuestsDir returns the root guests directory.

func (*Paths) ImageDigestDir 

func (p *Paths) ImageDigestDir(repository, digestHex string) string

ImageDigestDir returns the directory for a specific image digest.

func (*Paths) ImageDigestPath 

func (p *Paths) ImageDigestPath(repository, digestHex string) string

ImageDigestPath returns the path to the rootfs disk file for a digest. Uses .erofs on Linux (compressed) and .ext4 on Darwin (VZ kernel lacks erofs support).

func (*Paths) ImageMetadata 

func (p *Paths) ImageMetadata(repository, digestHex string) string

ImageMetadata returns the path to metadata.json for a digest.

func (*Paths) ImageRepositoryDir 

func (p *Paths) ImageRepositoryDir(repository string) string

ImageRepositoryDir returns the directory for an image repository. 

func (p *Paths) ImageTagSymlink(repository, tag string) string

ImageTagSymlink returns the path to a tag symlink.

func (*Paths) ImagesDir 

func (p *Paths) ImagesDir() string

ImagesDir returns the root images directory.

func (*Paths) IngressMetadata 

func (p *Paths) IngressMetadata(id string) string

IngressMetadata returns the path to ingress metadata.json.

func (*Paths) IngressesDir 

func (p *Paths) IngressesDir() string

IngressesDir returns the root ingresses directory.

func (*Paths) InstanceAppLog 

func (p *Paths) InstanceAppLog(id string) string

InstanceAppLog returns the path to instance application log (guest serial console).

func (*Paths) InstanceConfigDisk 

func (p *Paths) InstanceConfigDisk(id string) string

InstanceConfigDisk returns the path to instance config disk.

func (*Paths) InstanceDir 

func (p *Paths) InstanceDir(id string) string

InstanceDir returns the directory for an instance.

func (*Paths) InstanceHypemanLog 

func (p *Paths) InstanceHypemanLog(id string) string

InstanceHypemanLog returns the path to instance hypeman operations log.

func (*Paths) InstanceLogs 

func (p *Paths) InstanceLogs(id string) string

InstanceLogs returns the path to instance logs directory.

func (*Paths) InstanceMetadata 

func (p *Paths) InstanceMetadata(id string) string

InstanceMetadata returns the path to instance metadata.json.

func (*Paths) InstanceOverlay 

func (p *Paths) InstanceOverlay(id string) string

InstanceOverlay returns the path to instance overlay disk.

func (*Paths) InstanceSnapshotConfig 

func (p *Paths) InstanceSnapshotConfig(id string) string

InstanceSnapshotConfig returns the path to the snapshot config.json file. Cloud Hypervisor creates config.json in the snapshot directory.

func (*Paths) InstanceSnapshotLatest 

func (p *Paths) InstanceSnapshotLatest(id string) string

InstanceSnapshotLatest returns the path to the latest snapshot directory.

func (*Paths) InstanceSnapshots 

func (p *Paths) InstanceSnapshots(id string) string

InstanceSnapshots returns the path to instance snapshots directory.

func (*Paths) InstanceSocket 

func (p *Paths) InstanceSocket(id string, socketName string) string

InstanceSocket returns the path to instance API socket. The socketName should be obtained from hypervisor.Type.SocketName() to ensure it stays within Unix socket path length limits (SUN_LEN ~108 bytes).

func (*Paths) InstanceVMMLog 

func (p *Paths) InstanceVMMLog(id string) string

InstanceVMMLog returns the path to instance VMM log (Cloud Hypervisor stdout+stderr).

func (*Paths) InstanceVolumeOverlay 

func (p *Paths) InstanceVolumeOverlay(instanceID, volumeID string) string

InstanceVolumeOverlay returns the path to a volume's overlay disk for an instance.

func (*Paths) InstanceVolumeOverlaysDir 

func (p *Paths) InstanceVolumeOverlaysDir(instanceID string) string

InstanceVolumeOverlaysDir returns the directory for volume overlays.

func (*Paths) InstanceVsockSocket 

func (p *Paths) InstanceVsockSocket(id string) string

InstanceVsockSocket returns the path to instance vsock socket.

func (*Paths) OCICacheBlob 

func (p *Paths) OCICacheBlob(digestHex string) string

OCICacheBlob returns the path to a specific blob in the OCI cache.

func (*Paths) OCICacheBlobDir 

func (p *Paths) OCICacheBlobDir() string

OCICacheBlobDir returns the path to the OCI cache blobs directory.

func (*Paths) OCICacheIndex 

func (p *Paths) OCICacheIndex() string

OCICacheIndex returns the path to the OCI cache index.json.

func (*Paths) OCICacheLayout 

func (p *Paths) OCICacheLayout() string

OCICacheLayout returns the path to the OCI cache oci-layout file.

func (*Paths) SystemBinary 

func (p *Paths) SystemBinary(version, arch string) string

SystemBinary returns the path to a VMM binary.

func (*Paths) SystemBuild 

func (p *Paths) SystemBuild(ref string) string

SystemBuild returns the path to a system build directory.

func (*Paths) SystemInitrd 

func (p *Paths) SystemInitrd(arch string) string

SystemInitrd returns the path to the latest initrd symlink.

func (*Paths) SystemInitrdDir 

func (p *Paths) SystemInitrdDir(arch string) string

SystemInitrdDir returns the directory for initrd builds for an architecture.

func (*Paths) SystemInitrdLatest 

func (p *Paths) SystemInitrdLatest(arch string) string

SystemInitrdLatest returns the path to the latest symlink (same as SystemInitrd).

func (*Paths) SystemInitrdTimestamp 

func (p *Paths) SystemInitrdTimestamp(timestamp, arch string) string

SystemInitrdTimestamp returns the path to a specific timestamped initrd build.

func (*Paths) SystemKernel 

func (p *Paths) SystemKernel(version, arch string) string

SystemKernel returns the path to a kernel file.

func (*Paths) SystemOCICache 

func (p *Paths) SystemOCICache() string

SystemOCICache returns the path to the OCI cache directory.

func (*Paths) VolumeData 

func (p *Paths) VolumeData(id string) string

VolumeData returns the path to the volume data file.

func (*Paths) VolumeDir 

func (p *Paths) VolumeDir(id string) string

VolumeDir returns the directory for a volume.

func (*Paths) VolumeMetadata 

func (p *Paths) VolumeMetadata(id string) string

VolumeMetadata returns the path to volume metadata.json.

func (*Paths) VolumesDir 

func (p *Paths) VolumesDir() string

VolumesDir returns the root volumes directory.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.