linux

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 21, 2021 License: Apache-2.0 Imports: 20 Imported by: 0

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

Constants

This section is empty.

Variables

View Source
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 New

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

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

nolint: golint // ignore unexported type as it is intentional

Types

type Opt

type Opt func(*client) error

Opt represents a configuration option to initialize the client.

func WithBuild

func WithBuild(b *library.Build) Opt

WithBuild sets the library build in the client.

func WithHostname

func WithHostname(hostname string) Opt

WithHostname sets the hostname in the client.

func WithPipeline

func WithPipeline(p *pipeline.Build) Opt

WithPipeline sets the pipeline build in the client.

func WithRepo

func WithRepo(r *library.Repo) Opt

WithRepo sets the library repo in the client.

func WithRuntime

func WithRuntime(r runtime.Engine) Opt

WithRuntime sets the runtime engine in the client.

func WithUser

func WithUser(u *library.User) Opt

WithUser sets the library user in the client.

func WithVelaClient

func WithVelaClient(cli *vela.Client) Opt

WithVelaClient sets the Vela client in the client.

func WithVersion added in v0.7.0

func WithVersion(version string) Opt

WithVersion sets the version in the client.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL