Documentation
¶
Overview ¶
Package linux provides the ability for Vela to integrate with a Linux as an operating system.
Usage:
import "github.com/go-vela/worker/executor/linux"
Index ¶
- Variables
- func Equal(a, b *client) bool
- func New(opts ...Opt) (*client, error)
- type Opt
- func WithBuild(b *library.Build) Opt
- func WithEnforceTrustedRepos(enforce bool) Opt
- func WithHostname(hostname string) Opt
- func WithLogStreamingTimeout(timeout time.Duration) Opt
- func WithLogger(logger *logrus.Entry) Opt
- func WithMaxLogSize(size uint) Opt
- func WithPipeline(p *pipeline.Build) Opt
- func WithPrivilegedImages(images []string) Opt
- func WithRepo(r *library.Repo) Opt
- func WithRuntime(r runtime.Engine) Opt
- func WithUser(u *library.User) Opt
- func WithVelaClient(cli *vela.Client) Opt
- func WithVersion(version string) Opt
Constants ¶
This section is empty.
Variables ¶
var ( // ErrUnrecognizedSecretType defines the error type when the // SecretType provided to the client is unsupported. ErrUnrecognizedSecretType = errors.New("unrecognized secret type") // ErrUnableToRetrieve defines the error type when the // secret is not able to be retrieved from the server. ErrUnableToRetrieve = errors.New("unable to retrieve secret") )
Functions ¶
Types ¶
type Opt ¶ added in v0.11.0
type Opt func(*client) error
Opt represents a configuration option to initialize the executor client for Linux.
func WithBuild ¶ added in v0.11.0
WithBuild sets the library build in the executor client for Linux.
func WithEnforceTrustedRepos ¶ added in v0.16.0
WithEnforceTrustedRepos configures trusted repo restrictions in the executor client for Linux.
func WithHostname ¶ added in v0.11.0
WithHostname sets the hostname in the executor client for Linux.
func WithLogStreamingTimeout ¶ added in v0.17.0
WithLogStreamingTimeout sets the log streaming timeout in the executor client for Linux.
func WithLogger ¶ added in v0.12.0
WithLogger sets the logger in the executor client for Linux.
func WithMaxLogSize ¶ added in v0.12.0
WithMaxLogSize sets the maximum log size (in bytes) in the executor client for Linux.
func WithPipeline ¶ added in v0.11.0
WithPipeline sets the pipeline build in the executor client for Linux.
func WithPrivilegedImages ¶ added in v0.16.0
WithPrivilegedImages sets the privileged images in the executor client for Linux.
func WithRuntime ¶ added in v0.11.0
WithRuntime sets the runtime engine in the executor client for Linux.
func WithVelaClient ¶ added in v0.11.0
WithVelaClient sets the Vela client in the executor client for Linux.
func WithVersion ¶ added in v0.11.0
WithVersion sets the version in the executor client for Linux.
Source Files