featureflags

Documentation

Index

• type FeatureFlag
  • func AccountManagement() FeatureFlag
  • func BuildSimpleClassicURL() FeatureFlag
  • func ConsistentUUIDGeneration() FeatureFlag
  • func DangerousCommands() FeatureFlag
  • func DownloadFilter() FeatureFlag
  • func DownloadFilterClassicConfigs() FeatureFlag
  • func DownloadFilterSettings() FeatureFlag
  • func DownloadFilterSettingsUnmodifiable() FeatureFlag
  • func Experimental() FeatureFlag
  • func ExtractScopeAsParameter() FeatureFlag
  • func FastDependencyResolver() FeatureFlag
  • func GenerateJSONSchemas() FeatureFlag
  • func ManagementZoneSettingsNumericIDs() FeatureFlag
  • func SkipVersionCheck() FeatureFlag
  • func UnescapeOnConvert() FeatureFlag
  • func UpdateNonUniqueByNameIfSingleOneExists() FeatureFlag
  • func VerifyEnvironmentType() FeatureFlag
  • func (ff FeatureFlag) Enabled() bool
  • func (ff FeatureFlag) EnvName() string

Types

type FeatureFlag

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

FeatureFlag represents a command line switch to turn certain features ON or OFF. Values are read from environment variables defined by the feature flag. The feature flag can have default values that are used when the resp. environment variable does not exist

func AccountManagement

func AccountManagement() FeatureFlag

func BuildSimpleClassicURL

func BuildSimpleClassicURL() FeatureFlag

BuildSimpleClassicURL returns the feature flag to controlling whether we attempt to create the Classic URL of a platform environment via string replacement before using the metadata API. As there may be networking/DNS edge-cases where the replaced URL is valid (GET returns 200) but is not actually a Classic environment, this feature flag allows deactivation of the feature.

func ConsistentUUIDGeneration

func ConsistentUUIDGeneration() FeatureFlag

ConsistentUUIDGeneration returns the feature flag controlling whether generated UUIDs use consistent separator characters regardless of OS This is default true and just exists to get old, technically buggy behavior on Windows again if needed. Introduced: 2023-05-25; v2.2.0

func DangerousCommands

func DangerousCommands() FeatureFlag

DangerousCommands returns the feature flag that tells whether dangerous commands for the CLI are enabled or not

func DownloadFilter

func DownloadFilter() FeatureFlag

DownloadFilter returns the feature flag controlling whether download filters out configurations that we believe can't be managed by config-as-code. Some users may still want to download everything on an environment, and turning off the filters allows them to do so.

func DownloadFilterClassicConfigs

func DownloadFilterClassicConfigs() FeatureFlag

DownloadFilterClassicConfigs returns the feature flag controlling whether download filters are applied to Classic Config API download.

func DownloadFilterSettings

func DownloadFilterSettings() FeatureFlag

DownloadFilterSettings returns the feature flag controlling whether general filters are applied to Settings download.

func DownloadFilterSettingsUnmodifiable

func DownloadFilterSettingsUnmodifiable() FeatureFlag

DownloadFilterSettingsUnmodifiable returns the feature flag controlling whether Settings marked as unmodifiable by their dtclient.SettingsModificationInfo are filtered out on download.

func Experimental

func Experimental() FeatureFlag

Experimental returns the feature flag to indicate whether a feature is under development

func ExtractScopeAsParameter

func ExtractScopeAsParameter() FeatureFlag

ExtractScopeAsParameter returns the feature flag to controlling whether the scope field of setting 2.0 objects shall be extracted as monaco parameter

func FastDependencyResolver

func FastDependencyResolver() FeatureFlag

FastDependencyResolver returns the feature flag controlling whether the fast (but memory intensive) Aho-Corasick algorithm based dependency resolver is used when downloading. If set to false, the old naive and CPU intensive resolver is used. This flag is permanent as the fast resolver has significant memory cost.

func GenerateJSONSchemas

func GenerateJSONSchemas() FeatureFlag

GenerateJSONSchemas toggles whether the 'generate schema' command is available

func ManagementZoneSettingsNumericIDs

func ManagementZoneSettingsNumericIDs() FeatureFlag

ManagementZoneSettingsNumericIDs returns the feature flag that tells whether configs of settings type builtin:management-zones are addressed directly via their object ID or their resolved numeric ID when they are referenced. Introduced: 2023-04-18; v2.0.1

func SkipVersionCheck

func SkipVersionCheck() FeatureFlag

SkipVersionCheck returns the feature flag to control disabling the version check that happens at the end of each monaco run

func UnescapeOnConvert

func UnescapeOnConvert() FeatureFlag

UnescapeOnConvert toggles whether converting will remove escape chars from v1 values. Introduced: 2023-09-01; v2.8.0

func UpdateNonUniqueByNameIfSingleOneExists

func UpdateNonUniqueByNameIfSingleOneExists() FeatureFlag

UpdateNonUniqueByNameIfSingleOneExists toggles whether we attempt update api.API configurations with NonUniqueName, by name if only a single one is found on the environment. As this causes issues if a project defines more than one config with the same name - they will overwrite each other, and keep a single on the environment - the feature flag is introduced to turn it off until a generally better solution is available. Introduced: 2023-09-01; v2.9.1

func VerifyEnvironmentType

func VerifyEnvironmentType() FeatureFlag

VerifyEnvironmentType returns the feature flag that tells whether the environment check at the beginning of execution is enabled or not. Introduced: before 2023-04-27; v2.0.0

func (FeatureFlag) Enabled

func (ff FeatureFlag) Enabled() bool

Enabled evaluates the feature flag. Feature flags are considered to be "enabled" if their resp. environment variable is set to 1, t, T, TRUE, true or True. Feature flags are considered to be "disabled" if their resp. environment variable is set to 0, f, F, FALSE, false or False.

func (FeatureFlag) EnvName

func (ff FeatureFlag) EnvName() string

EnvName gives back the environment variable name for the feature flag