machine

package
v5.0.0 Latest Latest
Warning

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

 Go to latest Published: Mar 19, 2024 License: Apache-2.0 Imports: 32 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	NamedPipePrefix = "npipe:////./pipe/"
	GlobalNamedPipe = "docker_engine"

	// machine wait is longer since we must hard fail
	MachineNameWait = 5 * time.Second
	GlobalNameWait  = 250 * time.Millisecond
)
View Source 
const (
	DefaultMachineName string = "podman-machine-default"
)
View Source 
const WM_QUIT = 0x12

Variables

View Source 
var (
	ForwarderBinaryName = "gvproxy"
)

Functions

func CleanupGVProxy 

func CleanupGVProxy(f define.VMFile) error

CleanupGVProxy reads the --pid-file for gvproxy attempts to stop it

func CommonSSH 

func CommonSSH(username, identityPath, name string, sshPort int, inputArgs []string) error

CommonSSH is a common function for ssh'ing to a podman machine using system-connections and a port TODO This should probably be taught about an machineconfig to reduce input

func CommonSSHSilent 

func CommonSSHSilent(username, identityPath, name string, sshPort int, inputArgs []string) error

func CommonSSHWithStdin 

func CommonSSHWithStdin(username, identityPath, name string, sshPort int, inputArgs []string, stdin io.Reader) error

func CreateSSHKeys 

func CreateSSHKeys(writeLocation string) (string, error)

CreateSSHKeys makes a priv and pub ssh key for interacting the a VM.

func CreateSSHKeysPrefix 

func CreateSSHKeysPrefix(identityPath string, passThru bool, skipExisting bool, prefix ...string) (string, error)

func DetermineMachineArch 

func DetermineMachineArch() string

func DialNamedPipe 

func DialNamedPipe(ctx context.Context, path string) (net.Conn, error)

func DownloadImage 

func DownloadImage(d DistributionDownload) error

func DownloadVMImage 

func DownloadVMImage(downloadURL *url2.URL, imageName string, localImagePath string) error

DownloadVMImage downloads a VM image from url to given path with download status

func FindExecutablePeer 

func FindExecutablePeer(name string) (string, error)

func GetDevNullFiles 

func GetDevNullFiles() (*os.File, *os.File, error)

GetDevNullFiles returns pointers to Read-only and Write-only DevNull files

func GetEnvSetString 

func GetEnvSetString(env string, val string) string

func GetProcessState 

func GetProcessState(pid int) (active bool, exitCode int)

func GetSSHKeys 

func GetSSHKeys(identityPath string) (string, error)

GetSSHKeys checks to see if there is a ssh key at the provided location. If not, we create the priv and pub keys. The ssh key is then returned.

func GetWinProxyStateDir 

func GetWinProxyStateDir(name string, vmtype define.VMType) (string, error)

func LaunchWinProxy 

func LaunchWinProxy(opts WinProxyOpts, noInfo bool)

func PipeNameAvailable 

func PipeNameAvailable(pipeName string, maxWait time.Duration) bool

func PrintRootlessWarning 

func PrintRootlessWarning(name string)

func RemoveImageAfterExpire 

func RemoveImageAfterExpire(dir string, expire time.Duration) error

func SetRootful 

func SetRootful(rootful bool, name, rootfulName string) error

SetRootful modifies the machine's default connection to be either rootful or rootless

func StopWinProxy 

func StopWinProxy(name string, vmtype define.VMType) error

func UpdatePodmanDockerSockService 

func UpdatePodmanDockerSockService(mc *vmconfigs.MachineConfig) error

func WaitAPIAndPrintInfo 

func WaitAPIAndPrintInfo(forwardState APIForwardingState, name, helper, forwardSock string, noInfo, rootful bool)

WaitAPIAndPrintInfo prints info about the machine and does a ping test on the API socket

func WaitAndPingAPI 

func WaitAndPingAPI(sock string)

func WaitPipeExists 

func WaitPipeExists(pipeName string, retries int, checkFailure func() error) error

func WriteConfig 

func WriteConfig(configPath string, v VM) error

WriteConfig writes the machine's JSON config file

Types

type APIForwardingState 

type APIForwardingState int
const (
	NoForwarding APIForwardingState = iota
	ClaimUnsupported
	NotInstalled
	MachineLocal
	DockerGlobal
)

type CleanupCallback 

type CleanupCallback struct {
	Funcs []func() error
	// contains filtered or unexported fields
}

func CleanUp 

func CleanUp() CleanupCallback

func (*CleanupCallback) Add 

func (c *CleanupCallback) Add(anotherfunc func() error)

func (*CleanupCallback) CleanIfErr 

func (c *CleanupCallback) CleanIfErr(err *error)

func (*CleanupCallback) CleanOnSignal 

func (c *CleanupCallback) CleanOnSignal()

type ConnectionConfig 

type ConnectionConfig struct {
	// PodmanSocket is the exported podman service socket
	PodmanSocket *define.VMFile `json:"PodmanSocket"`
	// PodmanPipe is the exported podman service named pipe (Windows hosts only)
	PodmanPipe *define.VMFile `json:"PodmanPipe"`
}

ConnectionConfig contains connections like sockets, etc.

type DistributionDownload 

type DistributionDownload interface {
	HasUsableCache() (bool, error)
	Get() *Download
	CleanCache() error
}

func NewGenericDownloader 

func NewGenericDownloader(vmType define.VMType, vmName, pullPath string) (DistributionDownload, error)

NewGenericDownloader is used when the disk image is provided by the user

type Download 

type Download struct {
	Arch                  string
	Artifact              define.Artifact
	CacheDir              string
	CompressionType       compression.ImageCompression
	DataDir               string
	Format                define.ImageFormat
	ImageName             string
	LocalPath             string
	LocalUncompressedFile string
	Sha256sum             string
	Size                  int64
	URL                   *url.URL
	VMKind                define.VMType
	VMName                string
}

func (Download) AcquireAlternateImage 

func (dl Download) AcquireAlternateImage(inputPath string) (*define.VMFile, error)

AcquireAlternateImage downloads the alternate image the user provided, which can be a file path or URL

func (Download) GetLocalUncompressedFile 

func (dl Download) GetLocalUncompressedFile(dataDir string) string

type GenericDownload 

type GenericDownload struct {
	Download
}

GenericDownload is used when a user provides a URL or path for an image

func (GenericDownload) CleanCache 

func (g GenericDownload) CleanCache() error

CleanCache cleans out downloaded uncompressed image files

func (GenericDownload) Get 

func (g GenericDownload) Get() *Download

func (GenericDownload) HasUsableCache 

func (g GenericDownload) HasUsableCache() (bool, error)

type ImageConfig 

type ImageConfig struct {
	// IgnitionFile is the path to the filesystem where the
	// ignition file was written (if needs one)
	IgnitionFile define.VMFile `json:"IgnitionFilePath"`
	// ImageStream is the update stream for the image
	ImageStream string
	// ImageFile is the fq path to
	ImagePath define.VMFile `json:"ImagePath"`
}

ImageConfig describes the bootable image for the VM

type InspectInfo 

type InspectInfo struct {
	ConfigDir          define.VMFile
	ConnectionInfo     ConnectionConfig
	Created            time.Time
	LastUp             time.Time
	Name               string
	Resources          vmconfigs.ResourceConfig
	SSHConfig          vmconfigs.SSHConfig
	State              define.Status
	UserModeNetworking bool
	Rootful            bool
}

type InspectOptions 

type InspectOptions struct{}

type ListOptions 

type ListOptions struct{}

type ListResponse 

type ListResponse struct {
	Name               string
	CreatedAt          time.Time
	LastUp             time.Time
	Running            bool
	Starting           bool
	Stream             string
	VMType             string
	CPUs               uint64
	Memory             strongunits.MiB
	DiskSize           strongunits.GiB
	Port               int
	RemoteUsername     string
	IdentityPath       string
	UserModeNetworking bool
}

type RemoveOptions 

type RemoveOptions struct {
	Force        bool
	SaveImage    bool
	SaveIgnition bool
}

type ResetOptions 

type ResetOptions struct {
	Force bool
}

type SSHOptions 

type SSHOptions struct {
	Username string
	Args     []string
}

type StartOptions 

type StartOptions struct {
	NoInfo bool
	Quiet  bool
}

type StopOptions 

type StopOptions struct{}

type VM 

type VM interface {
	Init(opts define.InitOptions) (bool, error)
	Inspect() (*InspectInfo, error)
	Remove(name string, opts RemoveOptions) (string, func() error, error)
	Set(name string, opts define.SetOptions) ([]error, error)
	SSH(name string, opts SSHOptions) error
	Start(name string, opts StartOptions) error
	State(bypass bool) (define.Status, error)
	Stop(name string, opts StopOptions) error
}

TODO This can be removed when WSL is refactored into podman 5

type VirtIoFs 

type VirtIoFs struct {
	VolumeKind
	ReadOnly bool
	Source   string
	Tag      string
	Target   string
}

func MountToVirtIOFs 

func MountToVirtIOFs(mnt *vmconfigs.Mount) VirtIoFs

func NewVirtIoFsMount 

func NewVirtIoFsMount(src, target string, readOnly bool) VirtIoFs

NewVirtIoFsMount describes a machine volume mount for virtio-fs. With virtio-fs the source/target are described as a "shared dir". With this style of volume mount the Tag is used as the descriptor value for the mount (in Linux).

func (VirtIoFs) Kind 

func (v VirtIoFs) Kind() string

func (VirtIoFs) ToMount 

func (v VirtIoFs) ToMount() vmconfigs.Mount

type Virtualization 

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

TODO THis should be able to be removed once WSL is refactored for podman5

func NewVirtualization 

func NewVirtualization(artifact define.Artifact, compression compression.ImageCompression, format define.ImageFormat, vmKind define.VMType) Virtualization

func (*Virtualization) Artifact 

func (p *Virtualization) Artifact() define.Artifact

func (*Virtualization) Compression 

func (p *Virtualization) Compression() compression.ImageCompression

func (*Virtualization) Format 

func (p *Virtualization) Format() define.ImageFormat

func (*Virtualization) NewDownload 

func (p *Virtualization) NewDownload(vmName string) (Download, error)

func (*Virtualization) VMType 

func (p *Virtualization) VMType() define.VMType

type Volume 

type Volume interface {
	Kind() VolumeKind
}

type VolumeKind 

type VolumeKind string
var (
	VirtIOFsVk VolumeKind = "virtiofs"
	NinePVk    VolumeKind = "9p"
)

type WinProxyOpts 

type WinProxyOpts struct {
	Name           string
	IdentityPath   string
	Port           int
	RemoteUsername string
	Rootful        bool
	VMType         define.VMType
}

Source Files

View all Source files

Directories

Path Synopsis
vfkit
vsock
command
diskpull
wsl
wutil

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.