Bytemark command-line client

Installation

If you're just looking to get started you can find the most recent stable release on our download page.

If you wish to build, and install, the latest stable-release from source you can do so with:

go get github.com/BytemarkHosting/bytemark-client/cmd/bytemark

Tracking Development

If you prefer to track our in-development branch you can do that via:

go get -d github.com/BytemarkHosting/bytemark-client/cmd/bytemark
cd $GOPATH/src/github.com/BytemarkHosting/bytemark-client/
git checkout develop
cd cmd/bytemark
go build

If you have problems to report, or contributions to make, feel free to use the issue-tracker

Compatibility Guarantee

The following guarantee applies to versions of bytemark-client before 4.0. The major version 4 is reserved for an upcoming series of breaking changes. Versions 5 and onwards are expected to be compatible as normal. See the "Breaking API change" section below.

In go, semantic versioning is pretty hard. We (attempt to) guarantee that the following types of changes will not occur between minor versions within the lib package and all packages under its path (e.g. lib/brain)

• Publicly-exported functions and methods will not be removed, renamed, nor will their prototypes change.
• Publicly-exported struct-type fields will not be removed, renamed, nor will their types change.
• Publicly-exported variables and constants will not be removed, renamed, nor will their types change.

It's suggested that you avoid using struct embedding or interface composition with multiple types if any of those types are from bytemark-client/lib or any packages inside - bytemark-client's types are wont to have extra fields and methods added.

Breaking API change

The following changes are planned to occur during the 4.x version series and to be finalized in version 5.0:

• All request-making functions removed from lib.Client and replaced with requests in the relevant package under lib/requests.
• All requests in lib/requests rewritten in terms of new Pather types.
• lib.VirtualMachineName and lib.GroupName rewritten in terms of new Pather types.
• lib.VirtualMachineName and lib.GroupName will be moved into the lib/pathers package.

The following breaking API change to the lib package occurred in version 3.0

• These functions have been removed from lib

  • FormatAccount (replaced by brain.Account.PrettyPrint)
  • FormatVirtualMachine (replaced by brain.VirtualMachine.PrettyPrint)
  • FormatVirtualMachineSpec (replaced by brain.VirtualMachineSpec.PrettyPrint)
  • FormatImageInstall (replaced by brain.ImageInstall.PrettyPrint)

• These functions have been removed from lib

  • NewWithAuth has been removed - use lib.NewWithURLs. It is no longer possible to pass an auth3.Client directly, but this shouldn't be an issue.

• These functions have been altered:

  • lib.NewSimple has been renamed to lib.New - the old implementation of lib.New has been removed.

• These lib.Client methods have been deleted

  • ParseVirtualMachineName (replaced by lib.ParseVirtualMachineName)
  • ParseGroupName (replaced by lib.ParseGroupName)
  • ParseAccountName(replaced by lib.ParseAccountName)
  • AddUserAuthorizedKey (replaced by lib/requests/brain.AddUserAuthorizedKey)
  • DeleteUserAuthorizedKey (replaced by lib/requests/brain.DeleteUserAuthorizedKey)

• lib.NotAuthorizedError has been renamed to lib.ForbiddenError

Most lib.Client methods now take lib/brain/billing structs as values, rather than as pointers. See the lib/interface.go for the full list of methods available and their new type signatures.

Almost all lib.Client struct fields are now values or slices of values instead of pointers or slices of pointers - below is a list. Two notable exceptions are brain.VirtualMachineSpec.ImageInstall and brain.VirtualMachineSpec.IPs - which may need to be null, and so remain as pointers.

lib.Request is now an interface rather than a struct - and lib.Client.BuildRequest and lib.Client.BuildRequestNoAuth now return lib.Request instead of *lib.Request

• The type of brain.Account.Groups has changed from []*Group to []Group
• The type of brain.Backups has changed from []*Group to []Group
• The type of brain.BackupSchedules has changed from []*BackupSchedule to []BackupSchedule
• The type of brain.Group.VirtualMachines has changed from []*VirtualMachine to []VirtualMachine
• The type of brain.Head.CCAddress has changed from []*net.IP to []net.IP
• The type of brain.IP.IP has changed from []*net.IP to []net.IP
• The type of brain.IPRange.Available has changed from []*math/big.Int to []math/big.Int
• The type of brain.IPCreateRequest.IPs has changed from []*net.IP to []net.IP
• The type of brain.IPs has changed from []*net.IP to []net.IP
• The type of brain.NetworkInterface.ExtraIPs has changed from map[string]*net.IP to map[string]net.IP
• The type of brain.Privileges has changed from []*Privilege to []Privilege
• The type of brain.Tail.CCAddress has changed from *net.IP to net.IP
• The type of brain.VirtualMachine.Discs has changed from []*Disc to []Disc
• The type of brain.VirtualMachine.ManagementAddress has changed from *net.IP to net.IP
• The type of brain.VirtualMachine.NetworkInterfaces has changed from []*NetworkInterface to []NetworkInterface
• The type of brain.VirtualMachineSpec.VirtualMachine has changed from *VirtualMachine to VirtualMachine
• The type of brain.VLAN.IPRanges has changed from []*IPRange to []IPRange

If you require the old API for longer you can use gopkg.in/BytemarkHosting/bytemark-client.v2/lib to refer to the package prior to this change.