Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

virtual

package

Go to main page

Versions in this module

v1

v1.0.3

Apr 24, 2024

v1.0.2

Apr 20, 2024

v1.0.1

Apr 19, 2024

v1.0.0

Feb 13, 2024

v0

v0.1.0

Mar 16, 2023

Changes in this version

+ const Error

+ const NOAVAILABLEFRONTEND

+ const NoVPN

+ const OnlyVPN

+ const Running

+ const Stopped

+ const Suspended

+ const VPNBrowser

+ var ContNotCreatedErr = errors.New("container is not created")

+ var DefaultClient *docker.Client

+ var DefaultLinkBridge *defaultBridge

+ var DigestFormatErr = errors.New("unexpected digest format")

+ var EmptyDigestErr = errors.New("empty digest")

+ var FileTransferRoot string

+ var InvalidHostBindingErr = errors.New("hostbing does not have correct format - (ip:)port")

+ var InvalidMountErr = errors.New("incorrect mount format - src:dest")

+ var NoAvailableIPsErr = errors.New("no available IPs")

+ var NoImageErr = errors.New("unable to find image")

+ var NoRegistriesToPullFromErr = errors.New("no registries to pull from")

+ var NoRemoteDigestErr = errors.New("unable to get digest from remote image")

+ var Registries = map[string]docker.AuthConfiguration

+ var TooLowMemErr = errors.New("memory needs to be atleast 50mb")

+ var UnexpectedIPErr = errors.New("unexpected IP range")

+ func CreateEventFolder(tag string) error

+ func CreateFileTransferRoot(path string) error

+ func CreateFolderLink(vm string, envTag string, guacUsername string) error

+ func CreateUserFolder(teamId string, eventTag string) error

+ func GetAvailablePort() uint

+ func GetContainerCount() (uint32, error)

+ func GetRunningVmCount() (uint32, error)

+ func RemoveEventFolder(eventTag string) error

+ func VBoxCmdContext(ctx context.Context, cmd string, cmds ...string) ([]byte, error)

+ type Container struct

+ Conf ContainerConfig

+ Id string

+ Linked []*Container

+ Network *docker.Network

+ func NewContainer(conf ContainerConfig) *Container

+ func (c *Container) BridgeAlias(alias string) (string, error)

+ func (c *Container) Close() error

+ func (c *Container) Create(ctx context.Context) error

+ func (c *Container) Info() InstanceInfo

+ func (c *Container) Run(ctx context.Context) error

+ func (c *Container) Start(ctx context.Context) error

+ func (c *Container) Stop() error

+ func (c *Container) Suspend(ctx context.Context) error

+ type ContainerConfig struct

+ Cmd []string

+ DNS []string

+ EnvVars map[string]string

+ Image string

+ Labels map[string]string

+ Mounts []string

+ Name string

+ PortBindings map[string]string

+ Resources *Resources

+ UseBridge bool

+ UsedPorts []string

+ User string

+ type Host interface

+ GetDockerHostIP func() (string, error)

+ func NewHost() Host

+ type IPPool struct

+ func (ipp *IPPool) Get() (string, error)

+ type Image struct

+ Registry string

+ Repo string

+ Tag string

+ func (i Image) IsPublic() bool

+ func (i Image) NameWithReg() string

+ func (i Image) String() string

+ type Instance interface

+ Create func(context.Context) error

+ Info func() InstanceInfo

+ Run func(context.Context) error

+ Start func(context.Context) error

+ Stop func() error

+ Suspend func(context.Context) error

+ type InstanceConfig struct

+ CPU float64

+ Image string

+ MemoryMB uint

+ type InstanceInfo struct

+ Id string

+ Image string

+ State State

+ Type string

+ type Network struct

+ Connected []*Container

+ IpPool map[uint]struct{}

+ IsVPN bool

+ Net *docker.Network

+ Subnet string

+ func NewNetwork(isVPN bool) (*Network, error)

+ func (n *Network) Close() error

+ func (n *Network) Connect(c *Container, ip ...int) (int, error)

+ func (n *Network) FormatIP(num int) string

+ func (n *Network) Interface() string

+ func (n *Network) SetIsVPN(isVPN bool)

+ type NoCredentialsErr struct

+ Registry string

+ func (err NoCredentialsErr) Error() string

+ type NoLocalDigestErr struct

+ func (err NoLocalDigestErr) Error() string

+ type NoLocalImageAvailableErr struct

+ func (err NoLocalImageAvailableErr) Error() string

+ type NoRemoteImageAvailableErr struct

+ func (err NoRemoteImageAvailableErr) Error() string

+ type ResourceResizer interface

+ SetCPU func(uint) error

+ SetRAM func(uint) error

+ type Resources struct

+ CPU float64

+ MemoryMB uint

+ type State int

+ func (s State) String() string

+ type VBoxErr struct

+ Action string

+ Output []byte

+ func (err *VBoxErr) Error() string

+ type VMOpt func(context.Context, *Vm) error

+ func SetBridge(nic string) VMOpt

+ func SetCPU(cores uint) VMOpt

+ func SetLocalRDP(ip string, port uint) VMOpt

+ func SetRAM(mb uint) VMOpt

+ type VboxLibrary struct

+ Known map[string]*Vm

+ Locks map[string]*sync.Mutex

+ M sync.Mutex

+ Pwd string

+ func NewLibrary(pwd string) *VboxLibrary

+ func (lib *VboxLibrary) GetCopy(ctx context.Context, conf InstanceConfig, vmOpts ...VMOpt) (*Vm, error)

+ func (lib *VboxLibrary) GetImagePath(file string) string

+ func (lib *VboxLibrary) IsAvailable(file string) bool

+ type Vm struct

+ Id string

+ Image string

+ Path string

+ Running bool

+ func NewVMWithSum(path, image string, checksum string, vmOpts ...VMOpt) *Vm

+ func VmExists(image string, checksum string) (*Vm, bool)

+ func (v *Vm) Info() InstanceInfo

+ func (v *Vm) LinkedClone(ctx context.Context, snapshot string, vmOpts ...VMOpt) (*Vm, error)

+ func (vm *Vm) Close() error

+ func (vm *Vm) Create(ctx context.Context) error

+ func (vm *Vm) Run(ctx context.Context) error

+ func (vm *Vm) Snapshot(name string) error

+ func (vm *Vm) Start(ctx context.Context) error

+ func (vm *Vm) Stop() error

+ func (vm *Vm) Suspend(ctx context.Context) error