Help us shape the future of Go! Take the 2026 Go Developer Survey

packet

package
v0.13.0 Latest Latest
Warning

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

Go to latest
Published: Aug 1, 2019 License: Apache-2.0 Imports: 21 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type API

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

func New

func New(opts *Options) (*API, error)

func (*API) AddKey

func (a *API) AddKey(name, key string) (string, error)

func (*API) CreateDevice

func (a *API) CreateDevice(hostname string, conf *conf.Conf, console Console) (*packngo.Device, error)

console is optional, and is closed on error or when the device is deleted.

func (*API) DeleteDevice

func (a *API) DeleteDevice(deviceID string) error

func (*API) DeleteKey

func (a *API) DeleteKey(keyID string) error

func (*API) GC added in v0.8.0

func (a *API) GC(gracePeriod time.Duration) error

func (*API) GetDeviceAddress

func (a *API) GetDeviceAddress(device *packngo.Device, family int, public bool) string

func (*API) ListKeys added in v0.8.0

func (a *API) ListKeys() ([]packngo.SSHKey, error)

func (*API) PreflightCheck

func (a *API) PreflightCheck() error

type Console

type Console interface {
	io.WriteCloser
	SSHClient(ip, user string) (*ssh.Client, error)
}

type Options

type Options struct {
	*platform.Options

	// Config file. Defaults to $HOME/.config/packet.json.
	ConfigPath string
	// Profile name
	Profile string
	// API key (overrides config profile)
	ApiKey string
	// Project UUID (overrides config profile)
	Project string

	// Packet location code
	Facility string
	// Slug of the device type (e.g. "baremetal_0")
	Plan string
	// The Container Linux board name
	Board string
	// e.g. http://alpha.release.core-os.net/amd64-usr/current
	InstallerImageBaseURL string
	// e.g. https://alpha.release.core-os.net/amd64-usr/current/coreos_production_packet_image.bin.bz2
	ImageURL string

	// Options for Google Storage
	GSOptions *gcloud.Options
	// Google Storage base URL for temporary uploads
	// e.g. gs://users.developer.core-os.net/bovik/mantle
	StorageURL string
}

Jump to

Keyboard shortcuts

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