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"

	// GitManagedTransport implements a managed transport for GitRepository
	// objects that use the libgit2 implementation.
	//
	// When enabled, improves the reliability of libgit2 reconciliations,
	// by enforcing timeouts and ensuring libgit2 cannot hijack the process
	// and hang it indefinitely.
	GitManagedTransport = "GitManagedTransport"
)

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.