kubernetes

Documentation

Overview

Package kubernetes provides the ability for Vela to integrate with Kubernetes as a runtime environment.

Usage:

import "github.com/go-vela/worker/runtime/kubernetes"

Index

• func New(opts ...ClientOpt) (*client, error)
• func NewMock(_pod *v1.Pod, opts ...ClientOpt) (*client, error)
• type ClientOpt
  • func WithConfigFile(file string) ClientOpt
  • func WithHostVolumes(volumes []string) ClientOpt
  • func WithNamespace(namespace string) ClientOpt
  • func WithPrivilegedImages(images []string) ClientOpt

Functions

func New

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

New returns an Engine implementation that integrates with a Kubernetes runtime.

nolint: golint // ignore returning unexported client

func NewMock

func NewMock(_pod *v1.Pod, opts ...ClientOpt) (*client, error)

NewMock returns an Engine implementation that integrates with a Kubernetes runtime.

This function is intended for running tests only.

nolint: golint // ignore returning unexported client

Types

type ClientOpt

type ClientOpt func(*client) error

ClientOpt represents a configuration option to initialize the runtime client.

func WithConfigFile

func WithConfigFile(file string) ClientOpt

WithConfigFile sets the Kubernetes config file in the runtime client.

func WithHostVolumes

func WithHostVolumes(volumes []string) ClientOpt

WithHostVolumes sets the Kubernetes host volumes in the runtime client.

func WithNamespace

func WithNamespace(namespace string) ClientOpt

WithNamespace sets the Kubernetes namespace in the runtime client.

func WithPrivilegedImages

func WithPrivilegedImages(images []string) ClientOpt

WithPrivilegedImages sets the Kubernetes privileged images in the runtime client.