The highest tagged major version is v2.

usernet

package

v0.17.1 Latest Latest Go to latest Published: Aug 12, 2023 License: Apache-2.0 Imports: 27 Imported by: 4

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/lima-vm/lima

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func PIDFile(name string) (string, error)
func Sock(name string, sockType SockType) (string, error)
func SockWithDirectory(dir string, name string, sockType SockType) (string, error)
func Start(ctx context.Context, name string) error
func StartGVisorNetstack(ctx context.Context, gVisorOpts *GVisorNetstackOpts) error
func Stop(name string) error
type Client
- func NewClient(endpointSock string) *Client
- func (c *Client) ResolveAndForwardSSH(vmMacAddr string, sshPort int) error
- func (c *Client) UnExposeSSH(sshPort int) error
type GVisorNetstackOpts
type SockType
type UDPFileConn
- func (conn *UDPFileConn) Read(b []byte) (n int, err error)

Constants ¶

View Source

const (
	FDSock       = "fd"
	QEMUSock     = "qemu"
	EndpointSock = "ep"
)

Variables ¶

This section is empty.

Functions ¶

func PIDFile ¶

func PIDFile(name string) (string, error)

PIDFile returns a path for usernet PID file

func Sock ¶

func Sock(name string, sockType SockType) (string, error)

Sock returns a usernet socket based on name and sockType.

func SockWithDirectory ¶

func SockWithDirectory(dir string, name string, sockType SockType) (string, error)

SockWithDirectory return a usernet socket based on dir, name and sockType

func Start ¶

func Start(ctx context.Context, name string) error

Start starts a instance a usernet network with the given name. The name parameter must point to a valid network configuration name under <LIMA_HOME>/_config/networks.yaml with `mode: user-v2`

func StartGVisorNetstack ¶

func StartGVisorNetstack(ctx context.Context, gVisorOpts *GVisorNetstackOpts) error

func Stop ¶

func Stop(name string) error

Stop stops running instance a usernet network with the given name. The name parameter must point to a valid network configuration name under <LIMA_HOME>/_config/networks.yaml with `mode: user-v2`

Types ¶

type Client ¶

type Client struct {
	Directory string
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(endpointSock string) *Client

func (*Client) ResolveAndForwardSSH ¶

func (c *Client) ResolveAndForwardSSH(vmMacAddr string, sshPort int) error

func (*Client) UnExposeSSH ¶

func (c *Client) UnExposeSSH(sshPort int) error

type GVisorNetstackOpts ¶

type GVisorNetstackOpts struct {
	MTU int

	QemuSocket string
	FdSocket   string
	Endpoint   string

	Async bool

	DefaultLeases map[string]string
}

type SockType ¶

type SockType = string

type UDPFileConn ¶

type UDPFileConn struct {
	net.Conn
}

func (*UDPFileConn) Read ¶

func (conn *UDPFileConn) Read(b []byte) (n int, err error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL