features

Documentation

Overview

Package features sets the feature gates that source-controller supports, and their default states.

Index

• Constants
• func Disable(feature string)
• func Enabled(feature string) (bool, error)
• func FeatureGates() map[string]bool

Constants

const (
	// OptimizedGitClones decreases resource utilization for GitRepository
	// reconciliations. It supports both go-git and libgit2 implementations
	// when cloning repositories using branches or tags.
	//
	// When enabled, avoids full clone operations by first checking whether
	// the last revision is still the same at the target repository,
	// and if that is so, skips the reconciliation.
	OptimizedGitClones = "OptimizedGitClones"
	// ForceGoGitImplementation ignores the value set for gitImplementation
	// and ensures that go-git is used for all GitRepository objects.
	//
	// Libgit2 is built in C and we use the Go bindings provided by git2go
	// to cross the C-GO chasm. Unfortunately, when libgit2 is being used the
	// controllers are known to panic over long periods of time, or when
	// under high GC pressure.
	//
	// This feature gate enables the gradual deprecation of libgit2 in favour
	// of go-git, which so far is the most stable of the pair.
	//
	// When enabled, libgit2 won't be initialized, nor will any git2go CGO
	// code be called.
	ForceGoGitImplementation = "ForceGoGitImplementation"
)

Functions

func Disable

func Disable(feature string)

Disable disables the specified feature. If the feature is not present, it's a no-op.

func Enabled

func Enabled(feature string) (bool, error)

Enabled verifies whether the feature is enabled or not.

This is only a wrapper around the Enabled func in pkg/runtime/features, so callers won't need to import both packages for checking whether a feature is enabled.

func FeatureGates

func FeatureGates() map[string]bool

DefaultFeatureGates contains a list of all supported feature gates and their default values.