vagrant

Documentation

Overview

vagrant package contains Vagrant driver implementation

Index

• func NewDriver(store common.Storage) common.Driver
• type VagrantDriver
  • func (driver VagrantDriver) Add(entry common.EnvironmentEntry) error
  • func (driver VagrantDriver) Env(entry common.EnvironmentEntryWithState) (map[string]*string, error)
  • func (driver VagrantDriver) IsSupported() bool
  • func (driver VagrantDriver) List() <-chan common.EnvironmentEntryWithState
  • func (driver VagrantDriver) Name() string
  • func (driver VagrantDriver) Remove(entry common.EnvironmentEntry) error
  • func (driver VagrantDriver) Start(entry common.EnvironmentEntry) error
  • func (driver VagrantDriver) Stop(entry common.EnvironmentEntry) error
  • func (driver VagrantDriver) Store() common.Storage

Functions

func NewDriver

func NewDriver(store common.Storage) common.Driver

Returns an instance of VagrantDriver struct

Types

type VagrantDriver

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

Holds common.Driver interface implementation for Vagrant

func (VagrantDriver) Add

func (driver VagrantDriver) Add(entry common.EnvironmentEntry) error

Stores a Vagrant box into the dataset can fail on any storage failure (e.g. disk failure)

func (VagrantDriver) Env

func (driver VagrantDriver) Env(entry common.EnvironmentEntryWithState) (map[string]*string, error)

Returns environment variables for Vagrant entry, can fail if Vagrant box is not running, or while retrieving box's ip

func (VagrantDriver) IsSupported

func (driver VagrantDriver) IsSupported() bool

Checks if the driver is supported

func (VagrantDriver) List

func (driver VagrantDriver) List() <-chan common.EnvironmentEntryWithState

Lists all Vagrant boxes you added, can fail while retrieving Vagrant box status

func (VagrantDriver) Name

func (driver VagrantDriver) Name() string

Returns "vagrant" always

func (VagrantDriver) Remove

func (driver VagrantDriver) Remove(entry common.EnvironmentEntry) error

Deletes a Vagrant box from the dataset can fail on any storage failure (e.g. disk failure)

func (VagrantDriver) Start

func (driver VagrantDriver) Start(entry common.EnvironmentEntry) error

Starts the vagrant box

func (VagrantDriver) Stop

func (driver VagrantDriver) Stop(entry common.EnvironmentEntry) error

Stops the vagrant box

func (VagrantDriver) Store

func (driver VagrantDriver) Store() common.Storage

Returns the store currently in use