Documentation ¶
Index ¶
- Variables
- func GetLocalLXDErr(err error) error
- func SaveConfig(c *Config, fname string) error
- func WebsocketDial(dialer websocket.Dialer, url string) (*websocket.Conn, error)
- type Client
- func (c *Client) Action(name string, action shared.ContainerAction, timeout int, force bool, ...) (*Response, error)
- func (c *Client) AddMyCertToServer(pwd string) error
- func (c *Client) Addresses() ([]string, error)
- func (c *Client) AmTrusted() bool
- func (c *Client) AssignProfile(container, profile string) (*Response, error)
- func (c *Client) AsyncWaitMeta(resp *Response) (*shared.Jmap, error)
- func (c *Client) CertificateAdd(cert *x509.Certificate, name string) error
- func (c *Client) CertificateList() ([]shared.CertInfo, error)
- func (c *Client) CertificateRemove(fingerprint string) error
- func (c *Client) ContainerDeviceAdd(container, devname, devtype string, props []string) (*Response, error)
- func (c *Client) ContainerDeviceDelete(container, devname string) (*Response, error)
- func (c *Client) ContainerInfo(name string) (*shared.ContainerInfo, error)
- func (c *Client) ContainerListDevices(container string) ([]string, error)
- func (c *Client) ContainerState(name string) (*shared.ContainerState, error)
- func (c *Client) CopyImage(image string, dest *Client, copy_aliases bool, aliases []string, public bool, ...) error
- func (c *Client) Delete(name string) (*Response, error)
- func (c *Client) DeleteAlias(alias string) error
- func (c *Client) DeleteImage(image string) error
- func (c *Client) Exec(name string, cmd []string, env map[string]string, stdin io.ReadCloser, ...) (int, error)
- func (c *Client) ExportImage(image string, target string) (string, error)
- func (c *Client) GetAlias(alias string) string
- func (c *Client) GetContainerConfig(container string) ([]string, error)
- func (c *Client) GetImageInfo(image string) (*shared.ImageInfo, error)
- func (c *Client) GetLog(container string, log string) (io.Reader, error)
- func (c *Client) GetMigrationSourceWS(container string) (*Response, error)
- func (c *Client) GetProfileConfig(profile string) (map[string]string, error)
- func (c *Client) GetServerConfig() (*Response, error)
- func (c *Client) GetServerConfigString() ([]string, error)
- func (c *Client) ImageFromContainer(cname string, public bool, aliases []string, properties map[string]string) (string, error)
- func (c *Client) Init(name string, imgremote string, image string, profiles *[]string, ...) (*Response, error)
- func (c *Client) IsAlias(alias string) (bool, error)
- func (c *Client) IsPublic() bool
- func (c *Client) ListAliases() (shared.ImageAliases, error)
- func (c *Client) ListContainers() ([]shared.ContainerInfo, error)
- func (c *Client) ListImages() ([]shared.ImageInfo, error)
- func (c *Client) ListProfiles() ([]string, error)
- func (c *Client) ListSnapshots(container string) ([]shared.SnapshotInfo, error)
- func (c *Client) LocalCopy(source string, name string, config map[string]string, profiles []string, ...) (*Response, error)
- func (c *Client) MigrateFrom(name string, operation string, certificate string, secrets map[string]string, ...) (*Response, error)
- func (c *Client) Monitor(types []string, handler func(interface{})) error
- func (c *Client) PostAlias(alias string, desc string, target string) error
- func (c *Client) PostImage(imageFile string, rootfsFile string, properties []string, public bool, ...) (string, error)
- func (c *Client) PostImageURL(imageFile string, public bool, aliases []string) (string, error)
- func (c *Client) ProfileConfig(name string) (*shared.ProfileConfig, error)
- func (c *Client) ProfileCopy(name, newname string, dest *Client) error
- func (c *Client) ProfileCreate(p string) error
- func (c *Client) ProfileDelete(p string) error
- func (c *Client) ProfileDeviceAdd(profile, devname, devtype string, props []string) (*Response, error)
- func (c *Client) ProfileDeviceDelete(profile, devname string) (*Response, error)
- func (c *Client) ProfileListDevices(profile string) ([]string, error)
- func (c *Client) PullFile(container string, p string) (int, int, int, io.ReadCloser, error)
- func (c *Client) PushFile(container string, p string, gid int, uid int, mode string, buf io.ReadSeeker) error
- func (c *Client) PutImageInfo(name string, p shared.BriefImageInfo) error
- func (c *Client) PutProfile(name string, profile shared.ProfileConfig) error
- func (c *Client) Rename(name string, newName string) (*Response, error)
- func (c *Client) RestoreSnapshot(container string, snapshotName string, stateful bool) (*Response, error)
- func (c *Client) ServerStatus() (*shared.ServerState, error)
- func (c *Client) SetContainerConfig(container, key, value string) error
- func (c *Client) SetProfileConfigItem(profile, key, value string) error
- func (c *Client) SetServerConfig(key string, value string) (*Response, error)
- func (c *Client) Snapshot(container string, snapshotName string, stateful bool) (*Response, error)
- func (c *Client) SnapshotInfo(snapName string) (*shared.SnapshotInfo, error)
- func (c *Client) UpdateContainerConfig(container string, st shared.BriefContainerInfo) error
- func (c *Client) UpdateServerConfig(ss shared.BriefServerState) (*Response, error)
- func (c *Client) WaitFor(waitURL string) (*shared.Operation, error)
- func (c *Client) WaitForSuccess(waitURL string) error
- type Config
- type ConnectInfo
- type RemoteConfig
- type Response
- type ResponseType
Constants ¶
This section is empty.
Variables ¶
var DefaultConfig = Config{ Remotes: DefaultRemotes, DefaultRemote: "local", Aliases: map[string]string{ "shell": "exec @ARGS@ -- login -f root", }, }
var DefaultRemotes = map[string]RemoteConfig{ "images": ImagesRemote, "local": LocalRemote, "ubuntu": UbuntuRemote, "ubuntu-daily": UbuntuDailyRemote}
var ImagesRemote = RemoteConfig{ Addr: "https://images.linuxcontainers.org", Public: true}
var ( // LXDErrors are special errors; the client library hoists error codes // to these errors internally so that user code can compare against // them. We probably shouldn't hoist BadRequest or InternalError, since // LXD passes an error string along which is more informative than // whatever static error message we would put here. LXDErrors = map[int]error{ http.StatusNotFound: fmt.Errorf("not found"), } )
var LocalRemote = RemoteConfig{ Addr: "unix://", Static: true, Public: false}
var StaticRemotes = map[string]RemoteConfig{ "local": LocalRemote, "ubuntu": UbuntuRemote, "ubuntu-daily": UbuntuDailyRemote}
var UbuntuDailyRemote = RemoteConfig{ Addr: "https://cloud-images.ubuntu.com/daily", Static: true, Public: true, Protocol: "simplestreams"}
var UbuntuRemote = RemoteConfig{ Addr: "https://cloud-images.ubuntu.com/releases", Static: true, Public: true, Protocol: "simplestreams"}
Functions ¶
func GetLocalLXDErr ¶
GetLocalLXDErr determines whether or not an error is likely due to a local LXD configuration issue, and if so, returns the underlying error. GetLocalLXDErr can be used to provide customized error messages to help the user identify basic system issues, e.g. LXD daemon not running.
Returns syscall.ENOENT, syscall.ECONNREFUSED or syscall.EACCES when a local LXD configuration issue is detected, nil otherwise.
func SaveConfig ¶
SaveConfig writes the provided configuration to the config file.
Types ¶
type Client ¶
type Client struct { BaseURL string BaseWSURL string Config Config Name string Remote *RemoteConfig Transport string Certificate string Http http.Client // contains filtered or unexported fields }
Client can talk to a LXD daemon.
func NewClientFromInfo ¶
func NewClientFromInfo(info ConnectInfo) (*Client, error)
NewClientFromInfo returns a new LXD client.
func (*Client) AddMyCertToServer ¶
func (*Client) AssignProfile ¶
func (*Client) CertificateAdd ¶
func (c *Client) CertificateAdd(cert *x509.Certificate, name string) error
func (*Client) CertificateRemove ¶
func (*Client) ContainerDeviceAdd ¶
func (*Client) ContainerDeviceDelete ¶
func (*Client) ContainerInfo ¶
func (c *Client) ContainerInfo(name string) (*shared.ContainerInfo, error)
func (*Client) ContainerListDevices ¶
func (*Client) ContainerState ¶
func (c *Client) ContainerState(name string) (*shared.ContainerState, error)
func (*Client) DeleteAlias ¶
func (*Client) DeleteImage ¶
func (*Client) Exec ¶
func (c *Client) Exec(name string, cmd []string, env map[string]string, stdin io.ReadCloser, stdout io.WriteCloser, stderr io.WriteCloser, controlHandler func(*Client, *websocket.Conn), width int, height int) (int, error)
Exec runs a command inside the LXD container. For "interactive" use such as `lxc exec ...`, one should pass a controlHandler that talks over the control socket and handles things like SIGWINCH. If running non-interactive, passing a nil controlHandler will cause Exec to return when all of the command output is sent to the output buffers.
func (*Client) ExportImage ¶
func (*Client) GetContainerConfig ¶
* return string array representing a container's full configuration
func (*Client) GetImageInfo ¶
func (*Client) GetMigrationSourceWS ¶
func (*Client) GetProfileConfig ¶
func (*Client) GetServerConfig ¶
func (*Client) GetServerConfigString ¶
func (*Client) ImageFromContainer ¶
func (*Client) Init ¶
func (c *Client) Init(name string, imgremote string, image string, profiles *[]string, config map[string]string, devices shared.Devices, ephem bool) (*Response, error)
Init creates a container from either a fingerprint or an alias; you must provide at least one.
func (*Client) ListAliases ¶
func (c *Client) ListAliases() (shared.ImageAliases, error)
func (*Client) ListContainers ¶
func (c *Client) ListContainers() ([]shared.ContainerInfo, error)
func (*Client) ListProfiles ¶
func (*Client) ListSnapshots ¶
func (c *Client) ListSnapshots(container string) ([]shared.SnapshotInfo, error)
func (*Client) MigrateFrom ¶
func (*Client) PostImageURL ¶
func (*Client) ProfileConfig ¶
func (c *Client) ProfileConfig(name string) (*shared.ProfileConfig, error)
func (*Client) ProfileCreate ¶
func (*Client) ProfileDelete ¶
func (*Client) ProfileDeviceAdd ¶
func (*Client) ProfileDeviceDelete ¶
func (*Client) ProfileListDevices ¶
func (*Client) PutImageInfo ¶
func (c *Client) PutImageInfo(name string, p shared.BriefImageInfo) error
func (*Client) PutProfile ¶
func (c *Client) PutProfile(name string, profile shared.ProfileConfig) error
func (*Client) RestoreSnapshot ¶
func (*Client) ServerStatus ¶
func (c *Client) ServerStatus() (*shared.ServerState, error)
func (*Client) SetContainerConfig ¶
func (*Client) SetProfileConfigItem ¶
func (*Client) SetServerConfig ¶
func (*Client) SnapshotInfo ¶
func (c *Client) SnapshotInfo(snapName string) (*shared.SnapshotInfo, error)
func (*Client) UpdateContainerConfig ¶
func (c *Client) UpdateContainerConfig(container string, st shared.BriefContainerInfo) error
func (*Client) UpdateServerConfig ¶
func (c *Client) UpdateServerConfig(ss shared.BriefServerState) (*Response, error)
func (*Client) WaitForSuccess ¶
type Config ¶
type Config struct { // DefaultRemote holds the remote daemon name from the Remotes map // that the client should communicate with by default. // If empty it defaults to "local". DefaultRemote string `yaml:"default-remote"` // Remotes defines a map of remote daemon names to the details for // communication with the named daemon. // The implicit "local" remote is always available and communicates // with the local daemon over a unix socket. Remotes map[string]RemoteConfig `yaml:"remotes"` // Command line aliases for `lxc` Aliases map[string]string `yaml:"aliases"` // This is the path to the config directory, so the client can find // previously stored server certs, give good error messages, and save // new server certs, etc. // // We don't need to store it, because of course once we've loaded this // structure we already know where it is :) ConfigDir string `yaml:"-"` }
Config holds settings to be used by a client or daemon.
func LoadConfig ¶
LoadConfig reads the configuration from the config path; if the path does not exist, it returns a default configuration.
func (*Config) ConfigPath ¶
func (*Config) ParseRemote ¶
func (*Config) ParseRemoteAndContainer ¶
func (*Config) ServerCertPath ¶
type ConnectInfo ¶
type ConnectInfo struct { // Name is a simple identifier for the remote server. In 'lxc' it is // the name used to lookup the address and other information in the // config.yml file. Name string // RemoteConfig is the information about the Remote that we are // connecting to. This includes information like if the remote is // Public and/or Static. RemoteConfig RemoteConfig // ClientPEMCert is the PEM encoded bytes of the client's certificate. // If Addr indicates a Unix socket, the certificate and key bytes will // not be used. ClientPEMCert string // ClientPEMKey is the PEM encoded private bytes of the client's key associated with its certificate ClientPEMKey string // ClientPEMCa is the PEM encoded client certificate authority (if any) ClientPEMCa string // ServerPEMCert is the PEM encoded server certificate that we are // connecting to. It can be the empty string if we do not know the // server's certificate yet. ServerPEMCert string }
ConnectInfo contains the information we need to connect to a specific LXD server
type RemoteConfig ¶
type RemoteConfig struct { Addr string `yaml:"addr"` Public bool `yaml:"public"` Protocol string `yaml:"protocol,omitempty"` Static bool `yaml:"-"` }
RemoteConfig holds details for communication with a remote daemon.
type Response ¶
type Response struct { Type ResponseType `json:"type"` /* Valid only for Sync responses */ Status string `json:"status"` StatusCode int `json:"status_code"` /* Valid only for Async responses */ Operation string `json:"operation"` /* Valid only for Error responses */ Code int `json:"error_code"` Error string `json:"error"` /* Valid for Sync and Error responses */ Metadata json.RawMessage `json:"metadata"` }
func HoistResponse ¶
func HoistResponse(r *http.Response, rtype ResponseType) (*Response, error)
HoistResponse hoists a regular http response into a response of type rtype or returns a golang error.
func ParseResponse ¶
ParseResponse parses a lxd style response out of an http.Response. Note that this does _not_ automatically convert error responses to golang errors. To do that, use ParseError. Internal client library uses should probably use HoistResponse, unless they are interested in accessing the underlying Error response (e.g. to inspect the error code).
type ResponseType ¶
type ResponseType string
const ( Sync ResponseType = "sync" Async ResponseType = "async" Error ResponseType = "error" )
Directories ¶
Path | Synopsis |
---|---|
Package main is a generated protocol buffer package.
|
Package main is a generated protocol buffer package. |
lxd-bridge
|
|
This is a FLEXible file which can be used by both client and daemon.
|
This is a FLEXible file which can be used by both client and daemon. |
gnuflag
Package flag implements command-line flag parsing in the GNU style.
|
Package flag implements command-line flag parsing in the GNU style. |
test
|
|
deps
* An example of how to use lxd's golang /dev/lxd client.
|
* An example of how to use lxd's golang /dev/lxd client. |