argotunnel

Documentation

Index

• Constants
• func AddHook(hook logrus.Hook)
• func EnableMetrics(updateFrequency time.Duration)
• func GetLevel() logrus.Level
• func SetFormatter(formatter logrus.Formatter)
• func SetLevel(level logrus.Level)
• func SetOutput(out io.Writer)
• func SetRepairBackoff(delay time.Duration, jitter float64, steps uint)
• func SetTagLimit(limit int)
• func SetVersion(version string)
• func TransportLogger() *logrus.Logger
• type Controller
  • func NewController(client kubernetes.Interface, log *logrus.Logger, options ...Option) *Controller
  • func (c *Controller) Run(stopCh <-chan struct{}) (err error)
• type Option
  • func IngressClass(s string) Option
  • func RequeueLimit(i int) Option
  • func ResyncPeriod(d time.Duration) Option
  • func Secret(name, namespace string) Option
  • func SecretGroups(v cloudflare.OriginSecrets) Option
  • func WatchNamespace(s string) Option
  • func Workers(i int) Option

Constants

const (
	// IngressClassDefault defines the default class of ingresses managed by the controller
	IngressClassDefault = "argo-tunnel"

	// ResyncPeriodDefault defines the default duration prior to synchronization
	ResyncPeriodDefault = 5 * time.Minute

	// RequeueLimitDefault defines the default processing attempts before dropping the item
	RequeueLimitDefault = 2

	// WorkersDefault defines the default number of workers processing items from the queue
	WorkersDefault = 2
)

const (
	// RepairDelayDefault the default base time to wait between repairs
	RepairDelayDefault = 100 * time.Millisecond
	// RepairJitterDefault the default linear jitter applied to the wait on repair
	RepairJitterDefault = 0.5
	// RepairStepsDefault the default exponential steps used during repair
	RepairStepsDefault = 4
	// TagLimitDefault the default number of unique tags
	TagLimitDefault = 32
)

Functions

func AddHook

func AddHook(hook logrus.Hook)

AddHook adds a hook to the standard logger hooks.

func EnableMetrics

func EnableMetrics(updateFrequency time.Duration)

EnableMetrics configures the metrics used by all tunnels

func GetLevel

func GetLevel() logrus.Level

GetLevel returns the standard logger level.

func SetFormatter

func SetFormatter(formatter logrus.Formatter)

SetFormatter sets the standard logger formatter.

func SetLevel

func SetLevel(level logrus.Level)

SetLevel sets the standard logger level.

func SetOutput

func SetOutput(out io.Writer)

SetOutput sets the standard logger output.

func SetRepairBackoff

func SetRepairBackoff(delay time.Duration, jitter float64, steps uint)

SetRepairBackoff configures the repair backoff used by all tunnels

func SetTagLimit

func SetTagLimit(limit int)

SetTagLimit configures unique tag limit

func SetVersion

func SetVersion(version string)

SetVersion configures the version used by all tunnels

func TransportLogger

func TransportLogger() *logrus.Logger

TransportLogger returns the proto logger

Types

type Controller

type Controller struct {
	// contains filtered or unexported fields
}

Controller translates kubernetes events into tunnels.

func NewController

func NewController(client kubernetes.Interface, log *logrus.Logger, options ...Option) *Controller

NewController create a new controller

func (*Controller) Run

func (c *Controller) Run(stopCh <-chan struct{}) (err error)

Run starts processing

type Option

type Option func(*options)

Option provides behavior overrides

func IngressClass

func IngressClass(s string) Option

IngressClass defines the ingress class for the controller

func RequeueLimit

func RequeueLimit(i int) Option

RequeueLimit defines the processing attempts before dropping the item

func ResyncPeriod

func ResyncPeriod(d time.Duration) Option

ResyncPeriod defines the duration prior to synchronization

func Secret

func Secret(name, namespace string) Option

Secret defines the default secret used by tunnels

func SecretGroups

func SecretGroups(v cloudflare.OriginSecrets) Option

SecretGroups maps secrets used by specific origin tunnels

func WatchNamespace

func WatchNamespace(s string) Option

WatchNamespace restricts Ingress, Secret, and Service monitoring

func Workers

func Workers(i int) Option

Workers defines the number of queue consumers