import "golang.org/x/build/buildlet"
Package buildlet contains client tools for working with a buildlet server.
buildletclient.go gce.go keypair.go kube.go remote.go
var ( // TODO(evanbrown): resource requirements should be // defined per-builder in dashboard/builders.go BuildletCPU = api.MustParse("2") // 2 Cores BuildletMemory = api.MustParse("2000000Ki") // 2,000,000Ki RAM )
var GCEGate func()
GCEGate optionally specifies a function to run before any GCE API call. It's intended to be used to bound QPS rate to GCE.
NoKeyPair is used by the coordinator to speak http directly to buildlets, inside their firewall, without TLS.
func DestroyVM(ts oauth2.TokenSource, proj, zone, instance string) error
DestroyVM sends a request to delete a VM. Actual VM description is currently (2015-01-19) very slow for no good reason. This function returns once it's been requested, not when it's done.
ListVMs lists all VMs.
type Client struct {
// contains filtered or unexported fields
}
A Client interacts with a single buildlet.
NewClient returns a *Client that will manipulate ipPort, authenticated using the provided keypair.
This constructor returns immediately without testing the host or auth.
StartNewVM boots a new VM on GCE and returns a buildlet client configured to speak to it.
func StartPod(ctx context.Context, kubeClient *kubernetes.Client, podName, builderType string, opts PodOpts) (*Client, error)
StartPod creates a new pod on a Kubernetes cluster and returns a buildlet client configured to speak to it.
Closes destroys and closes down the buildlet, destroying all state immediately.
DestroyVM shuts down the buildlet and destroys the VM instance.
Exec runs cmd on the buildlet.
Two errors are returned: one is whether the command succeeded remotely (remoteErr), and the second (execErr) is whether there were system errors preventing the command from being started or seen to completition. If execErr is non-nil, the remoteErr is meaningless.
GetTar returns a .tar.gz stream of the given directory, relative to the buildlet's work dir. The provided dir may be empty to get everything.
IsBroken reports whether this client is broken in some way.
ListDir lists the contents of a directory. The fn callback is run for each entry.
MarkBroken marks this client as broken in some way.
func (c *Client) ProxyRoundTripper() http.RoundTripper
ProxyRoundTripper returns a RoundTripper that sends HTTP requests directly through to the underlying buildlet, adding auth and X-Buildlet-Proxy headers as necessary. This is really only intended for use by the coordinator.
Put writes the provided file to path (relative to workdir) and sets mode.
PutTar writes files to the remote buildlet, rooted at the relative directory dir. If dir is empty, they're placed at the root of the buildlet's work directory. The dir is created if necessary. The Reader must be of a tar.gz file.
PutTarFromURL tells the buildlet to download the tar.gz file from tarURL and write it to dir, a relative directory from the workdir. If dir is empty, they're placed at the root of the buildlet's work directory. The dir is created if necessary. The url must be of a tar.gz file.
RemoteName returns the name of this client's buildlet on the coordinator. If this buildlet isn't a remote buildlet created via a buildlet, this returns the empty string.
RemoveAll deletes the provided paths, relative to the work directory.
SetDescription sets a short description of where the buildlet connection came from. This is used by the build coordinator status page, mostly for debugging.
SetHTTPClient replaces the underlying HTTP client. It should only be called before the Client is used.
SetOnHeartbeatFailure sets a function to be called when heartbeats against this builder fail, or when the client is destroyed with Close. The function fn is never called more than once. SetOnHeartbeatFailure must be set before any use of the buildlet.
Status returns an Status value describing this buildlet.
URL returns the buildlet's URL prefix, without a trailing slash.
WorkDir returns the absolute path to the buildlet work directory.
type CoordinatorClient struct { // Auth specifies how to authenticate to the coordinator. Auth UserPass // Instance optionally specifies the build coordinator to connect // to. If zero, the production coordinator is used. Instance build.CoordinatorInstance // contains filtered or unexported fields }
A CoordinatorClient makes calls to the build coordinator.
func (cc *CoordinatorClient) CreateBuildlet(buildletType string) (*Client, error)
CreateBuildlet creates a new buildlet of the given type on cc. It may expire at any time. To release it, call Client.Destroy.
func (cc *CoordinatorClient) NamedBuildlet(name string) (*Client, error)
NamedBuildlet returns a buildlet client for the named remote buildlet. Names are not validated. Use Client.Status to check whether the client works.
func (cc *CoordinatorClient) RemoteBuildlets() ([]RemoteBuildlet, error)
type DirEntry struct {
// contains filtered or unexported fields
}
DirEntry is the information about a file on a buildlet.
type ExecOpts struct { // Output is the output of stdout and stderr. // If nil, the output is discarded. Output io.Writer // Dir is the directory from which to execute the command. // It is optional. If not specified, it defaults to the directory of // the command, or the work directory if SystemLevel is set. Dir string // Args are the arguments to pass to the cmd given to Client.Exec. Args []string // ExtraEnv are KEY=VALUE pairs to append to the buildlet // process's environment. ExtraEnv []string // Path, if non-nil, specifies the PATH variable of the executed // process's environment. A non-nil empty list clears the path. // The following expansions apply: // - the string "$PATH" expands to any existing PATH element(s) // - the substring "$WORKDIR" expands to buildlet's temp workdir // After expansions, the list is joined with an OS-specific list // separator and supplied to the executed process as its PATH // environment variable. Path []string // SystemLevel controls whether the command is run outside of // the buildlet's environment. SystemLevel bool // Debug, if true, instructs to the buildlet to print extra debug // info to the output before the command begins executing. Debug bool // OnStartExec is an optional hook that runs after the 200 OK // response from the buildlet, but before the output begins // writing to Output. OnStartExec func() // Timeout is an optional duration before ErrTimeout is returned. Timeout time.Duration }
ExecOpts are options for a remote command invocation.
KeyPair is the TLS public certificate PEM file and its associated private key PEM file that a builder will use for its HTTPS server. The zero value means no HTTPs, which is used by the coordinator for machines running within a firewall.
Password returns the SHA1 of the KeyPEM. This is used as the HTTP Basic Auth password.
type ListDirOpts struct { // Recursive controls whether the directory is listed // recursively. Recursive bool // Skip are the directories to skip, relative to the directory // passed to ListDir. Each item should contain only forward // slashes and not start or end in slashes. Skip []string // Digest controls whether the SHA-1 digests of regular files // are returned. Digest bool }
ListDirOpts are options for Client.ListDir.
type PodOpts struct { // ProjectID is the GCE project ID. Required. ProjectID string // ImageRegistry specifies the Docker registry Kubernetes // will use to create the pod. Required. ImageRegistry string // TLS optionally specifies the TLS keypair to use. // If zero, http without auth is used. TLS KeyPair // Description optionally describes the pod. Description string // Labels optionally specify key=value strings that Kubernetes // can use to filter and group pods. Labels map[string]string // DeleteIn optionally specifies a duration at which // to delete the pod. DeleteIn time.Duration // OnPodCreating optionally specifies a hook to run synchronously // after the pod create request has been made, but before the create // has suceeded. OnPodCreating func() // OnPodCreated optionally specifies a hook to run synchronously // after the pod create request succeeds. OnPodCreated func() // OnGotPodInfo optionally specifies a hook to run synchronously // after the pod Get call. OnGotPodInfo func() }
PodOpts control how new pods are started.
type RemoteBuildlet struct { Type string // "openbsd-386" Name string // "buildlet-adg-openbsd-386-2" Created time.Time Expires time.Time }
Status provides status information about the buildlet.
A coordinator can use the provided information to decide what, if anything, to do with a buildlet.
type VM struct { // Name is the name of the GCE VM instance. // For example, it's of the form "mote-bradfitz-plan9-386-foo", // and not "plan9-386-foo". Name string IPPort string TLS KeyPair Type string }
type VMOpts struct { // Zone is the GCE zone to create the VM in. Required. Zone string // ProjectID is the GCE project ID. Required. ProjectID string // TLS optionally specifies the TLS keypair to use. // If zero, http without auth is used. TLS KeyPair // Optional description of the VM. Description string // Optional metadata to put on the instance. Meta map[string]string // to delete the VM. DeleteIn time.Duration // OnInstanceRequested optionally specifies a hook to run synchronously // after the computeService.Instances.Insert call, but before // waiting for its operation to proceed. OnInstanceRequested func() // OnInstanceCreated optionally specifies a hook to run synchronously // after the instance operation succeeds. OnInstanceCreated func() // OnInstanceCreated optionally specifies a hook to run synchronously // after the computeService.Instances.Get call. OnGotInstanceInfo func() // FallbackToFullPrice optionally specifies a hook to return a new // GCE instance name if the first one failed to launch // as preemptible. (If you use the same name, GCE complains about // resources already existing, even if it failed to be created) FallbackToFullPrice func() (newInstname string) }
VMOpts control how new VMs are started.
Package buildlet imports 32 packages (graph) and is imported by 4 packages. Updated 6 days ago. Refresh now. Tools for package owners.