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 WithLogger(logger *logrus.Entry) ClientOpt
  • func WithNamespace(namespace string) ClientOpt
  • func WithPodsTemplate(name string, path string) ClientOpt
  • func WithPrivilegedImages(images []string) ClientOpt
• type MockKubernetesRuntime

Functions

func New

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

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

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.

Types

type ClientOpt

type ClientOpt func(*client) error

ClientOpt represents a configuration option to initialize the runtime client for Kubernetes.

func WithConfigFile

func WithConfigFile(file string) ClientOpt

WithConfigFile sets the config file in the runtime client for Kubernetes.

func WithHostVolumes

func WithHostVolumes(volumes []string) ClientOpt

WithHostVolumes sets the host volumes in the runtime client for Kubernetes.

func WithLogger

func WithLogger(logger *logrus.Entry) ClientOpt

WithLogger sets the logger in the runtime client for Kubernetes.

func WithNamespace

func WithNamespace(namespace string) ClientOpt

WithNamespace sets the namespace in the runtime client for Kubernetes.

func WithPodsTemplate

func WithPodsTemplate(name string, path string) ClientOpt

WithPodsTemplate sets the PipelinePodsTemplateName or loads the PipelinePodsTemplate from file in the runtime client for Kubernetes.

func WithPrivilegedImages

func WithPrivilegedImages(images []string) ClientOpt

WithPrivilegedImages sets the privileged images in the runtime client for Kubernetes.

type MockKubernetesRuntime

type MockKubernetesRuntime interface {
	MarkPodTrackerReady()
	SimulateResync(*v1.Pod)
}

MockKubernetesRuntime makes it possible to use the client mocks in other packages.

This interface is intended for running tests only.