linux

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

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

func Equal

func Equal(a, b *client) bool

Equal returns true if the other client is the equivalent.

func New

func New(opts ...Opt) (*client, error)

New returns an Executor implementation that integrates with a Linux instance.

Types

type Opt

type Opt func(*client) error

Opt represents a configuration option to initialize the executor client for Linux.

func WithBuild

func WithBuild(b *library.Build) Opt

WithBuild sets the library build in the executor client for Linux.

func WithEnforceTrustedRepos

func WithEnforceTrustedRepos(enforce bool) Opt

WithEnforceTrustedRepos configures trusted repo restrictions in the executor client for Linux.

func WithHostname

func WithHostname(hostname string) Opt

WithHostname sets the hostname in the executor client for Linux.

func WithLogStreamingTimeout

func WithLogStreamingTimeout(timeout time.Duration) Opt

WithLogStreamingTimeout sets the log streaming timeout in the executor client for Linux.

func WithLogger

func WithLogger(logger *logrus.Entry) Opt

WithLogger sets the logger in the executor client for Linux.

func WithMaxLogSize

func WithMaxLogSize(size uint) Opt

WithMaxLogSize sets the maximum log size (in bytes) in the executor client for Linux.

func WithPipeline

func WithPipeline(p *pipeline.Build) Opt

WithPipeline sets the pipeline build in the executor client for Linux.

func WithPrivilegedImages

func WithPrivilegedImages(images []string) Opt

WithPrivilegedImages sets the privileged images in the executor client for Linux.

func WithRepo

func WithRepo(r *library.Repo) Opt

WithRepo sets the library repo in the executor client for Linux.

func WithRuntime

func WithRuntime(r runtime.Engine) Opt

WithRuntime sets the runtime engine in the executor client for Linux.

func WithUser

func WithUser(u *library.User) Opt

WithUser sets the library user in the executor client for Linux.

func WithVelaClient

func WithVelaClient(cli *vela.Client) Opt

WithVelaClient sets the Vela client in the executor client for Linux.

func WithVersion

func WithVersion(version string) Opt

WithVersion sets the version in the executor client for Linux.