Documentation
¶
Overview ¶
Package paths provides centralized path construction for hypeman data directory.
Index ¶
- type Paths
- func (p *Paths) BuildConfig(id string) string
- func (p *Paths) BuildDir(id string) string
- func (p *Paths) BuildLog(id string) string
- func (p *Paths) BuildLogs(id string) string
- func (p *Paths) BuildMetadata(id string) string
- func (p *Paths) BuildSourceDir(id string) string
- func (p *Paths) BuildsDir() string
- func (p *Paths) CaddyBinary(version, arch string) string
- func (p *Paths) CaddyConfig() string
- func (p *Paths) CaddyConfigDir() string
- func (p *Paths) CaddyDataDir() string
- func (p *Paths) CaddyDir() string
- func (p *Paths) CaddyLogFile() string
- func (p *Paths) CaddyPIDFile() string
- func (p *Paths) DataDir() string
- func (p *Paths) DeviceDir(id string) string
- func (p *Paths) DeviceMetadata(id string) string
- func (p *Paths) DevicesDir() string
- func (p *Paths) GuestsDir() string
- func (p *Paths) ImageDigestDir(repository, digestHex string) string
- func (p *Paths) ImageDigestPath(repository, digestHex string) string
- func (p *Paths) ImageMetadata(repository, digestHex string) string
- func (p *Paths) ImageRepositoryDir(repository string) string
- func (p *Paths) ImageTagSymlink(repository, tag string) string
- func (p *Paths) ImagesDir() string
- func (p *Paths) IngressMetadata(id string) string
- func (p *Paths) IngressesDir() string
- func (p *Paths) InstanceAppLog(id string) string
- func (p *Paths) InstanceConfigDisk(id string) string
- func (p *Paths) InstanceDir(id string) string
- func (p *Paths) InstanceHypemanLog(id string) string
- func (p *Paths) InstanceLogs(id string) string
- func (p *Paths) InstanceMetadata(id string) string
- func (p *Paths) InstanceOverlay(id string) string
- func (p *Paths) InstanceSnapshotConfig(id string) string
- func (p *Paths) InstanceSnapshotLatest(id string) string
- func (p *Paths) InstanceSnapshots(id string) string
- func (p *Paths) InstanceSocket(id string, socketName string) string
- func (p *Paths) InstanceVMMLog(id string) string
- func (p *Paths) InstanceVolumeOverlay(instanceID, volumeID string) string
- func (p *Paths) InstanceVolumeOverlaysDir(instanceID string) string
- func (p *Paths) InstanceVsockSocket(id string) string
- func (p *Paths) OCICacheBlob(digestHex string) string
- func (p *Paths) OCICacheBlobDir() string
- func (p *Paths) OCICacheIndex() string
- func (p *Paths) OCICacheLayout() string
- func (p *Paths) SystemBinary(version, arch string) string
- func (p *Paths) SystemBuild(ref string) string
- func (p *Paths) SystemInitrd(arch string) string
- func (p *Paths) SystemInitrdDir(arch string) string
- func (p *Paths) SystemInitrdLatest(arch string) string
- func (p *Paths) SystemInitrdTimestamp(timestamp, arch string) string
- func (p *Paths) SystemKernel(version, arch string) string
- func (p *Paths) SystemOCICache() string
- func (p *Paths) VolumeData(id string) string
- func (p *Paths) VolumeDir(id string) string
- func (p *Paths) VolumeMetadata(id string) string
- func (p *Paths) VolumesDir() string
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 (*Paths) BuildConfig ¶
BuildConfig returns the path to the build config file (passed to builder VM).
func (*Paths) BuildMetadata ¶
BuildMetadata returns the path to build metadata.json.
func (*Paths) BuildSourceDir ¶
BuildSourceDir returns the path to the source directory for a build.
func (*Paths) CaddyBinary ¶
CaddyBinary returns the path to the caddy binary.
func (*Paths) CaddyConfig ¶
CaddyConfig returns the path to the caddy config file.
func (*Paths) CaddyConfigDir ¶
CaddyConfigDir returns the path to Caddy's config directory.
func (*Paths) CaddyDataDir ¶
CaddyDataDir returns the path to Caddy's data directory (for certs, etc.).
func (*Paths) CaddyLogFile ¶
CaddyLogFile returns the path to the caddy log file.
func (*Paths) CaddyPIDFile ¶
CaddyPIDFile returns the path to the caddy PID file.
func (*Paths) DeviceMetadata ¶
DeviceMetadata returns the path to device metadata.json.
func (*Paths) DevicesDir ¶
DevicesDir returns the root devices directory.
func (*Paths) ImageDigestDir ¶
ImageDigestDir returns the directory for a specific image digest.
func (*Paths) ImageDigestPath ¶
ImageDigestPath returns the path to the rootfs disk file for a digest.
func (*Paths) ImageMetadata ¶
ImageMetadata returns the path to metadata.json for a digest.
func (*Paths) ImageRepositoryDir ¶
ImageRepositoryDir returns the directory for an image repository.
func (*Paths) ImageTagSymlink ¶
ImageTagSymlink returns the path to a tag symlink.
func (*Paths) IngressMetadata ¶
IngressMetadata returns the path to ingress metadata.json.
func (*Paths) IngressesDir ¶
IngressesDir returns the root ingresses directory.
func (*Paths) InstanceAppLog ¶
InstanceAppLog returns the path to instance application log (guest serial console).
func (*Paths) InstanceConfigDisk ¶
InstanceConfigDisk returns the path to instance config disk.
func (*Paths) InstanceDir ¶
InstanceDir returns the directory for an instance.
func (*Paths) InstanceHypemanLog ¶
InstanceHypemanLog returns the path to instance hypeman operations log.
func (*Paths) InstanceLogs ¶
InstanceLogs returns the path to instance logs directory.
func (*Paths) InstanceMetadata ¶
InstanceMetadata returns the path to instance metadata.json.
func (*Paths) InstanceOverlay ¶
InstanceOverlay returns the path to instance overlay disk.
func (*Paths) InstanceSnapshotConfig ¶
InstanceSnapshotConfig returns the path to the snapshot config.json file. Cloud Hypervisor creates config.json in the snapshot directory.
func (*Paths) InstanceSnapshotLatest ¶
InstanceSnapshotLatest returns the path to the latest snapshot directory.
func (*Paths) InstanceSnapshots ¶
InstanceSnapshots returns the path to instance snapshots directory.
func (*Paths) InstanceSocket ¶
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 ¶
InstanceVMMLog returns the path to instance VMM log (Cloud Hypervisor stdout+stderr).
func (*Paths) InstanceVolumeOverlay ¶
InstanceVolumeOverlay returns the path to a volume's overlay disk for an instance.
func (*Paths) InstanceVolumeOverlaysDir ¶
InstanceVolumeOverlaysDir returns the directory for volume overlays.
func (*Paths) InstanceVsockSocket ¶
InstanceVsockSocket returns the path to instance vsock socket.
func (*Paths) OCICacheBlob ¶
OCICacheBlob returns the path to a specific blob in the OCI cache.
func (*Paths) OCICacheBlobDir ¶
OCICacheBlobDir returns the path to the OCI cache blobs directory.
func (*Paths) OCICacheIndex ¶
OCICacheIndex returns the path to the OCI cache index.json.
func (*Paths) OCICacheLayout ¶
OCICacheLayout returns the path to the OCI cache oci-layout file.
func (*Paths) SystemBinary ¶
SystemBinary returns the path to a VMM binary.
func (*Paths) SystemBuild ¶
SystemBuild returns the path to a system build directory.
func (*Paths) SystemInitrd ¶
SystemInitrd returns the path to the latest initrd symlink.
func (*Paths) SystemInitrdDir ¶
SystemInitrdDir returns the directory for initrd builds for an architecture.
func (*Paths) SystemInitrdLatest ¶
SystemInitrdLatest returns the path to the latest symlink (same as SystemInitrd).
func (*Paths) SystemInitrdTimestamp ¶
SystemInitrdTimestamp returns the path to a specific timestamped initrd build.
func (*Paths) SystemKernel ¶
SystemKernel returns the path to a kernel file.
func (*Paths) SystemOCICache ¶
SystemOCICache returns the path to the OCI cache directory.
func (*Paths) VolumeData ¶
VolumeData returns the path to the volume data file.
func (*Paths) VolumeMetadata ¶
VolumeMetadata returns the path to volume metadata.json.
func (*Paths) VolumesDir ¶
VolumesDir returns the root volumes directory.
Source Files