client

Documentation

Index

• type BuildInfo
  • func (bi *BuildInfo) ID() string
  • func (bi *BuildInfo) ImageChecksum() string
  • func (bi *BuildInfo) ImageSize() int64
  • func (bi *BuildInfo) IsComplete() bool
  • func (bi *BuildInfo) LibraryRef() string
  • func (bi *BuildInfo) LibraryURL() string
• type BuildOption
  • func OptBuildArchitecture(arch string) BuildOption
  • func OptBuildLibraryPullBaseURL(libraryURL string) BuildOption
  • func OptBuildLibraryRef(imageRef string) BuildOption
• type Client
  • func NewClient(opts ...Option) (*Client, error)
  • func (c *Client) Cancel(ctx context.Context, buildID string) error
  • func (c *Client) GetOutput(ctx context.Context, buildID string, w io.Writer) error
  • func (c *Client) GetStatus(ctx context.Context, buildID string) (*BuildInfo, error)
  • func (c *Client) GetVersion(ctx context.Context) (string, error)
  • func (c *Client) Submit(ctx context.Context, definition io.Reader, opts ...BuildOption) (*BuildInfo, error)
• type Option
  • func OptBaseURL(url string) Option
  • func OptBearerToken(token string) Option
  • func OptHTTPClient(c *http.Client) Option
  • func OptUserAgent(agent string) Option

Types

type BuildInfo

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

BuildInfo contains the details of an individual build.

func (*BuildInfo) ID

func (bi *BuildInfo) ID() string

func (*BuildInfo) ImageChecksum

func (bi *BuildInfo) ImageChecksum() string

func (*BuildInfo) ImageSize

func (bi *BuildInfo) ImageSize() int64

func (*BuildInfo) IsComplete

func (bi *BuildInfo) IsComplete() bool

func (*BuildInfo) LibraryRef

func (bi *BuildInfo) LibraryRef() string

func (*BuildInfo) LibraryURL

func (bi *BuildInfo) LibraryURL() string

type BuildOption

type BuildOption func(*buildOptions) error

func OptBuildArchitecture

func OptBuildArchitecture(arch string) BuildOption

OptBuildArchitecture sets the build architecture to arch.

func OptBuildLibraryPullBaseURL

func OptBuildLibraryPullBaseURL(libraryURL string) BuildOption

OptBuildLibraryPullBaseURL sets the base URL to pull images from when a build involves pulling one or more image(s) from a Library source.

func OptBuildLibraryRef

func OptBuildLibraryRef(imageRef string) BuildOption

OptBuildLibraryRef sets the Library image ref to push to.

type Client

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

Client describes the client details.

func NewClient

func NewClient(opts ...Option) (*Client, error)

NewClient returns a Client configured according to opts.

By default, the Sylabs Build Service is used. To override this behaviour, use OptBaseURL.

By default, requests are not authenticated. To override this behaviour, use OptBearerToken.

func (*Client) Cancel

func (c *Client) Cancel(ctx context.Context, buildID string) error

Cancel cancels an existing build. The context controls the lifetime of the request.

func (*Client) GetOutput

func (c *Client) GetOutput(ctx context.Context, buildID string, w io.Writer) error

GetOutput streams build output for the provided buildID to w. The context controls the lifetime of the request.

func (*Client) GetStatus

func (c *Client) GetStatus(ctx context.Context, buildID string) (*BuildInfo, error)

GetStatus gets the status of a build from the Build Service by build ID. The context controls the lifetime of the request.

func (*Client) GetVersion

func (c *Client) GetVersion(ctx context.Context) (string, error)

GetVersion gets version information from the build service. The context controls the lifetime of the request.

func (*Client) Submit

func (c *Client) Submit(ctx context.Context, definition io.Reader, opts ...BuildOption) (*BuildInfo, error)

Submit sends a build job to the Build Service. The context controls the lifetime of the request.

By default, the built image will be pushed to an ephemeral location in the Library associated with the Remote Builder. To publish to a non-ephemeral location, consider using OptBuildLibraryRef.

By default, the image will be built for the architecture returned by runtime.GOARCH. To override this behaviour, consider using OptBuildArchitecture.

By default, if definition involves pulling one or more images from a Library reference that does not contain a hostname, they will be pulled from the Library associated with the Remote Builder. To override this behaviour, consider using OptBuildLibraryPullBaseURL.

type Option

type Option func(co *clientOptions) error

Option are used to populate co.

func OptBaseURL

func OptBaseURL(url string) Option

OptBaseURL sets the base URL of the build server to url.

func OptBearerToken

func OptBearerToken(token string) Option

OptBearerToken sets the bearer token to include in the "Authorization" header of each request.

func OptHTTPClient

func OptHTTPClient(c *http.Client) Option

OptHTTPClient sets the client to use to make HTTP requests.

func OptUserAgent

func OptUserAgent(agent string) Option

OptUserAgent sets the HTTP user agent to include in the "User-Agent" header of each request.