config

package
v0.60.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 27, 2025 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var CustomConfigItems = []auconfigapi.ConfigItem{
	{
		Key:         config.KeyBasicAuthUsername,
		EnvName:     config.KeyBasicAuthUsername,
		Default:     "",
		Description: "username for basic-auth write access to this service",
		Validate:    auconfigenv.ObtainNotEmptyValidator(),
	},
	{
		Key:         config.KeyBasicAuthPassword,
		EnvName:     config.KeyBasicAuthPassword,
		Default:     "",
		Description: "password for basic-auth write access to this service",
		Validate:    auconfigenv.ObtainNotEmptyValidator(),
	},
	{
		Key:         config.KeyReviewerFallback,
		EnvName:     config.KeyReviewerFallback,
		Default:     "",
		Description: "default fallback reviewer username or groupname",
		Validate:    auconfigenv.ObtainNotEmptyValidator(),
	},
	{
		Key:         config.KeyGitCommitterName,
		EnvName:     config.KeyGitCommitterName,
		Default:     "",
		Description: "name to use for git commits",
		Validate:    auconfigenv.ObtainNotEmptyValidator(),
	},
	{
		Key:         config.KeyGitCommitterEmail,
		EnvName:     config.KeyGitCommitterEmail,
		Default:     "",
		Description: "email address to use for git commits",
		Validate:    auconfigenv.ObtainNotEmptyValidator(),
	},
	{
		Key:         config.KeyKafkaGroupIdOverride,
		EnvName:     config.KeyKafkaGroupIdOverride,
		Default:     "",
		Description: "optional: a kafka group id to use for subscribing to update events. Mainly useful on localhost. If empty, group id is derived from 3rd oktet of non-trivial local ip (as proxy for the k8s worker node)",
		Validate:    auconfigenv.ObtainPatternValidator("^(|[a-z0-9-]+)$"),
	},
	{
		Key:         config.KeyAuthOidcKeySetUrl,
		EnvName:     config.KeyAuthOidcKeySetUrl,
		Default:     "",
		Description: "keyset url of oidc identity provider",
		Validate:    auconfigenv.ObtainPatternValidator("^https?:.*$"),
	},
	{
		Key:         config.KeyAuthOidcTokenAudience,
		EnvName:     config.KeyAuthOidcTokenAudience,
		Default:     "",
		Description: "expected audience of oidc access token",
		Validate:    auconfigenv.ObtainNotEmptyValidator(),
	},
	{
		Key:         config.KeyAuthGroupWrite,
		EnvName:     config.KeyAuthGroupWrite,
		Default:     "",
		Description: "group name or id for write access to this service",
		Validate:    auconfigapi.ConfigNeedsNoValidation,
	},
	{
		Key:         config.KeyMetadataRepoUrl,
		EnvName:     config.KeyMetadataRepoUrl,
		Default:     "",
		Description: "git clone url for service-metadata repository",
		Validate:    auconfigenv.ObtainNotEmptyValidator(),
	},
	{
		Key:         config.KeyMetadataRepoMainline,
		EnvName:     config.KeyMetadataRepoMainline,
		Default:     "refs/heads/main",
		Description: "ref to use as mainline",
		Validate:    auconfigenv.ObtainNotEmptyValidator(),
	},
	{
		Key:         config.KeyUpdateJobIntervalMinutes,
		EnvName:     config.KeyUpdateJobIntervalMinutes,
		Default:     "5",
		Description: "time in minutes between cache update. Must be a divisor of 60 (used in cron expression) - pick one of the choices",
		Validate:    auconfigenv.ObtainPatternValidator("^(1|2|3|4|5|6|10|12|15|20|30)$"),
	},
	{
		Key:         config.KeyUpdateJobTimeoutSeconds,
		EnvName:     config.KeyUpdateJobTimeoutSeconds,
		Default:     "30",
		Description: "timeout for the cache update job in seconds. Must be less than 60 * UPDATE_JOB_INTERVAL_MINUTES",
		Validate:    auconfigenv.ObtainUintRangeValidator(10, 60),
	},
	{
		Key:      config.KeyAlertTargetRegex,
		EnvName:  config.KeyAlertTargetRegex,
		Default:  "",
		Validate: auconfigenv.ObtainIsRegexValidator(),
	},
	{
		Key:         config.KeyElasticApmDisabled,
		EnvName:     config.KeyElasticApmDisabled,
		Default:     "false",
		Description: "disable elastic apm middleware. supports all values supported by ParseBool (https://pkg.go.dev/strconv#ParseBool).",
		Validate:    auconfigenv.ObtainIsBooleanValidator(),
	},
	{
		Key:         config.KeyOwnerAliasPermittedRegex,
		EnvName:     config.KeyOwnerAliasPermittedRegex,
		Default:     "^[a-z](-?[a-z0-9]+)*$",
		Description: "regular expression to control the owner aliases that are permitted to be be created.",
		Validate:    auconfigenv.ObtainIsRegexValidator(),
	},
	{
		Key:         config.KeyOwnerAliasProhibitedRegex,
		EnvName:     config.KeyOwnerAliasProhibitedRegex,
		Default:     "^$",
		Description: "regular expression to control the owner aliases that are prohibited to be be created.",
		Validate:    auconfigenv.ObtainIsRegexValidator(),
	},
	{
		Key:         config.KeyOwnerAliasFilterRegex,
		EnvName:     config.KeyOwnerAliasFilterRegex,
		Default:     "^.*$",
		Description: "regular expression to filter owners based on their alias. Useful on localhost or for test instances to speed up service startup.",
		Validate:    auconfigenv.ObtainIsRegexValidator(),
	},
	{
		Key:         config.KeyOwnerAliasMaxLength,
		EnvName:     config.KeyOwnerAliasMaxLength,
		Default:     "28",
		Description: "maximum length of a valid owner alias.",
		Validate:    auconfigenv.ObtainIntRangeValidator(1, 100),
	},
	{
		Key:         config.KeyServiceNamePermittedRegex,
		EnvName:     config.KeyServiceNamePermittedRegex,
		Default:     "^[a-z](-?[a-z0-9]+)*$",
		Description: "regular expression to control the service names that are permitted to be be created.",
		Validate:    auconfigenv.ObtainIsRegexValidator(),
	},
	{
		Key:         config.KeyServiceNameProhibitedRegex,
		EnvName:     config.KeyServiceNameProhibitedRegex,
		Default:     "^$",
		Description: "regular expression to control the service names that are prohibited to be be created.",
		Validate:    auconfigenv.ObtainIsRegexValidator(),
	},
	{
		Key:         config.KeyServiceNameMaxLength,
		EnvName:     config.KeyServiceNameMaxLength,
		Default:     "28",
		Description: "maximum length of a valid service name.",
		Validate:    auconfigenv.ObtainIntRangeValidator(1, 100),
	},
	{
		Key:         config.KeyRepositoryNamePermittedRegex,
		EnvName:     config.KeyRepositoryNamePermittedRegex,
		Default:     "^[a-z](-?[a-z0-9]+)*$",
		Description: "regular expression to control the repository names that are permitted to be be created.",
		Validate:    auconfigenv.ObtainIsRegexValidator(),
	},
	{
		Key:         config.KeyRepositoryNameProhibitedRegex,
		EnvName:     config.KeyRepositoryNameProhibitedRegex,
		Default:     "^$",
		Description: "regular expression to control the repository names that are prohibited to be be created.",
		Validate:    auconfigenv.ObtainIsRegexValidator(),
	},
	{
		Key:         config.KeyRepositoryNameMaxLength,
		EnvName:     config.KeyRepositoryNameMaxLength,
		Default:     "64",
		Description: "maximum length of a valid repository name.",
		Validate:    auconfigenv.ObtainIntRangeValidator(1, 100),
	},
	{
		Key:         config.KeyRepositoryTypes,
		EnvName:     config.KeyRepositoryTypes,
		Default:     "",
		Description: "comma separated list of supported repository types.",
		Validate:    auconfigenv.ObtainPatternValidator("^|[a-z](-?[a-z0-9]+)*(,[a-z](-?[a-z0-9]+)*)*$"),
	},
	{
		Key:         config.KeyRepositoryKeySeparator,
		EnvName:     config.KeyRepositoryKeySeparator,
		Default:     ".",
		Description: "single character used to separate repository name from repository type. repository name and repository type must not contain separator.",
		Validate:    auconfigenv.ObtainSingleCharacterValidator(),
	},
	{
		Key:         config.KeyNotificationConsumerConfigs,
		EnvName:     config.KeyNotificationConsumerConfigs,
		Default:     "",
		Description: "configurations for consumers of change notifications.",
		Validate: func(key string) error {
			value := auconfigenv.Get(key)
			_, err := parseNotificationConsumerConfigs(value)
			return err
		},
	},
	{
		Key:         config.KeyRedisUrl,
		EnvName:     config.KeyRedisUrl,
		Default:     "",
		Description: "base url to the redis, including protocol. Uses in-memory caching if blank.",
		Validate:    auconfigapi.ConfigNeedsNoValidation,
	},
	{
		Key:         config.KeyRedisPassword,
		EnvName:     config.KeyRedisPassword,
		Default:     "",
		Description: "password used to access the redis",
		Validate:    auconfigapi.ConfigNeedsNoValidation,
	},
	{
		Key:         config.KeyPullRequestBuildUrl,
		EnvName:     config.KeyPullRequestBuildUrl,
		Default:     "",
		Description: "Url that pull request builds should link to.",
		Validate:    auconfigenv.ObtainPatternValidator("^https?://.*$"),
	},
	{
		Key:         config.KeyPullRequestBuildKey,
		EnvName:     config.KeyPullRequestBuildKey,
		Default:     "metadata-service",
		Description: "Key to use for pull request builds.",
		Validate:    auconfigapi.ConfigNeedsNoValidation,
	},
	{
		Key:         config.KeyGithubAppId,
		EnvName:     config.KeyGithubAppId,
		Default:     "",
		Description: "github app id",
		Validate:    ObtainPositiveInt64Validator(),
	},
	{
		Key:         config.KeyGithubAppInstallationId,
		EnvName:     config.KeyGithubAppInstallationId,
		Default:     "",
		Description: "github app installation id",
		Validate:    ObtainPositiveInt64Validator(),
	},
	{
		Key:         config.KeyGithubAppJwtSigningKeyPEM,
		EnvName:     config.KeyGithubAppJwtSigningKeyPEM,
		Default:     "",
		Description: "github app signing key PEM",
	},
	{
		Key:         config.KeyGithubAppWebhookSecret,
		EnvName:     config.KeyGithubAppWebhookSecret,
		Default:     "",
		Description: "secret for the github App webhooks",
	},
	{
		Key:         config.KeyWebhooksProcessAsync,
		EnvName:     config.KeyWebhooksProcessAsync,
		Description: "Webhooks handling async",
		Default:     "true",
		Validate:    auconfigapi.ConfigNeedsNoValidation,
	},
	{
		Key:         config.KeyYamlIndentation,
		EnvName:     config.KeyYamlIndentation,
		Description: "Number of spaces used for indentation of stored yaml files. Possible values are whole numbers between 1 and 10.",
		Default:     "4",
		Validate:    auconfigenv.ObtainIntRangeValidator(1, 10),
	},
	{
		Key:         config.KeyFormattingActionCommitMsgPrefix,
		EnvName:     config.KeyFormattingActionCommitMsgPrefix,
		Description: "Optional commit message prefix for the commits created by the fix-formatting action of the validation CheckRun",
		Default:     "",
		Validate:    auconfigapi.ConfigNeedsNoValidation,
	},
	{
		Key:         config.KeyCheckWarnMissingMainlineProtection,
		EnvName:     config.KeyCheckWarnMissingMainlineProtection,
		Description: "If true the GitHub check creates a warning annotation in a repository.yaml file if it is missing the 'requirePR' branch protection for ':MAINLINE:'",
		Default:     "false",
		Validate:    auconfigenv.ObtainIsBooleanValidator(),
	},
	{
		Key:         config.KeyCheckExpectedRequiredConditions,
		EnvName:     config.KeyCheckExpectedRequiredConditions,
		Description: "A JSON list defining all requiredConditions which will be checked for by the GitHub check for all repository.yaml files. Each entry contains the 'name' of the requiredCondition, the expected 'refMatcher' and the 'annotationLevel' (notice, warning or failure).",
		Default:     "[]",
		Validate: func(key string) error {
			value := auconfigenv.Get(key)
			_, err := parseCheckExpectedRequiredConditions(value)
			return err
		},
	},
	{
		Key:         config.KeyCheckExpectedExemptions,
		EnvName:     config.KeyCheckExpectedExemptions,
		Description: "A JSON list defining all expected exemptions which will be checked for by the GitHub check for all defined repository.yaml files. Each entry contains the 'name' of the exemption, the expected 'refMatcher' and the 'exemptions'.",
		Default:     "[]",
		Validate: func(key string) error {
			value := auconfigenv.Get(key)
			_, err := parseCheckExpectedExemptions(value)
			return err
		},
	},
}

Functions

func New 

func New() (librepo.Configuration, config.CustomConfiguration)

func ObtainPositiveInt64Validator added in v0.47.0 

func ObtainPositiveInt64Validator() func(key string) error

Types

type CustomConfigImpl 

type CustomConfigImpl struct {
	VBasicAuthUsername                  string
	VBasicAuthPassword                  string
	VReviewerFallback                   string
	VGitCommitterName                   string
	VGitCommitterEmail                  string
	VAuthOidcKeySetUrl                  string
	VAuthOidcTokenAudience              string
	VAuthGroupWrite                     string
	VKafkaGroupIdOverride               string
	VMetadataRepoUrl                    string
	VMetadataRepoMainline               string
	VUpdateJobIntervalCronPart          string
	VUpdateJobTimeoutSeconds            uint16
	VAlertTargetRegex                   *regexp.Regexp
	VElasticApmDisabled                 bool
	VOwnerAliasPermittedRegex           *regexp.Regexp
	VOwnerAliasProhibitedRegex          *regexp.Regexp
	VOwnerAliasMaxLength                uint16
	VOwnerAliasFilterRegex              *regexp.Regexp
	VServiceNamePermittedRegex          *regexp.Regexp
	VServiceNameProhibitedRegex         *regexp.Regexp
	VServiceNameMaxLength               uint16
	VRepositoryNamePermittedRegex       *regexp.Regexp
	VRepositoryNameProhibitedRegex      *regexp.Regexp
	VRepositoryNameMaxLength            uint16
	VRepositoryTypes                    string
	VRepositoryKeySeparator             string
	VNotificationConsumerConfigs        map[string]config.NotificationConsumerConfig
	VRedisUrl                           string
	VRedisPassword                      string
	VPullRequestBuildUrl                string
	VPullRequestBuildKey                string
	VWebhooksProcessAsync               bool
	VGithubAppId                        int64
	VGithubAppInstallationId            int64
	VGithubAppJwtSigningKeyPEM          []byte
	VGithubAppWebhookSecret             []byte
	VYamlIndentation                    int
	VFormattingActionCommitMsgPrefix    string
	VCheckWarnMissingMainlineProtection bool
	VCheckExpectedRequiredConditions    []config.CheckedRequiredConditions
	VCheckExpectedExemptions            []config.CheckedExpectedExemption

	VKafkaConfig  *kafka.Config
	GitUrlMatcher *regexp.Regexp
}

func (*CustomConfigImpl) AlertTargetRegex added in v0.38.4 

func (c *CustomConfigImpl) AlertTargetRegex() *regexp.Regexp

func (*CustomConfigImpl) AuthGroupWrite added in v0.13.0 

func (c *CustomConfigImpl) AuthGroupWrite() string

func (*CustomConfigImpl) AuthOidcKeySetUrl added in v0.13.0 

func (c *CustomConfigImpl) AuthOidcKeySetUrl() string

func (*CustomConfigImpl) AuthOidcTokenAudience added in v0.13.0 

func (c *CustomConfigImpl) AuthOidcTokenAudience() string

func (*CustomConfigImpl) BasicAuthPassword added in v0.12.0 

func (c *CustomConfigImpl) BasicAuthPassword() string

func (*CustomConfigImpl) BasicAuthUsername added in v0.12.0 

func (c *CustomConfigImpl) BasicAuthUsername() string

func (*CustomConfigImpl) CheckExpectedRequiredConditions added in v0.57.0 

func (c *CustomConfigImpl) CheckExpectedRequiredConditions() []config.CheckedRequiredConditions

func (*CustomConfigImpl) CheckWarnMissingMainlineProtection added in v0.57.0 

func (c *CustomConfigImpl) CheckWarnMissingMainlineProtection() bool

func (*CustomConfigImpl) CheckedExpectedExemptions added in v0.60.0 

func (c *CustomConfigImpl) CheckedExpectedExemptions() []config.CheckedExpectedExemption

func (*CustomConfigImpl) ElasticApmEnabled added in v0.5.0 

func (c *CustomConfigImpl) ElasticApmEnabled() bool

func (*CustomConfigImpl) FormattingActionCommitMsgPrefix added in v0.55.0 

func (c *CustomConfigImpl) FormattingActionCommitMsgPrefix() string

func (*CustomConfigImpl) GitCommitterEmail 

func (c *CustomConfigImpl) GitCommitterEmail() string

func (*CustomConfigImpl) GitCommitterName 

func (c *CustomConfigImpl) GitCommitterName() string

func (*CustomConfigImpl) GithubAppId added in v0.47.0 

func (c *CustomConfigImpl) GithubAppId() int64

func (*CustomConfigImpl) GithubAppInstallationId added in v0.47.0 

func (c *CustomConfigImpl) GithubAppInstallationId() int64

func (*CustomConfigImpl) GithubAppJwtSigningKeyPEM added in v0.47.0 

func (c *CustomConfigImpl) GithubAppJwtSigningKeyPEM() []byte

func (*CustomConfigImpl) GithubAppWebhookSecret added in v0.55.0 

func (c *CustomConfigImpl) GithubAppWebhookSecret() []byte

func (*CustomConfigImpl) Kafka added in v0.36.0 

func (c *CustomConfigImpl) Kafka() *kafka.Config

func (*CustomConfigImpl) KafkaGroupIdOverride 

func (c *CustomConfigImpl) KafkaGroupIdOverride() string

func (*CustomConfigImpl) MetadataRepoMainline added in v0.20.0 

func (c *CustomConfigImpl) MetadataRepoMainline() string

func (*CustomConfigImpl) MetadataRepoName added in v0.38.0 

func (c *CustomConfigImpl) MetadataRepoName() string

func (*CustomConfigImpl) MetadataRepoProject added in v0.38.0 

func (c *CustomConfigImpl) MetadataRepoProject() string

func (*CustomConfigImpl) MetadataRepoUrl 

func (c *CustomConfigImpl) MetadataRepoUrl() string

func (*CustomConfigImpl) NotificationConsumerConfigs added in v0.32.0 

func (c *CustomConfigImpl) NotificationConsumerConfigs() map[string]config.NotificationConsumerConfig

func (*CustomConfigImpl) Obtain 

func (c *CustomConfigImpl) Obtain(getter func(key string) string)

func (*CustomConfigImpl) OwnerAliasMaxLength added in v0.9.0 

func (c *CustomConfigImpl) OwnerAliasMaxLength() uint16

func (*CustomConfigImpl) OwnerAliasPermittedRegex added in v0.9.0 

func (c *CustomConfigImpl) OwnerAliasPermittedRegex() *regexp.Regexp

func (*CustomConfigImpl) OwnerAliasProhibitedRegex added in v0.9.0 

func (c *CustomConfigImpl) OwnerAliasProhibitedRegex() *regexp.Regexp

func (*CustomConfigImpl) OwnerFilterAliasRegex added in v0.9.0 

func (c *CustomConfigImpl) OwnerFilterAliasRegex() *regexp.Regexp

func (*CustomConfigImpl) PullRequestBuildKey added in v0.38.0 

func (c *CustomConfigImpl) PullRequestBuildKey() string

func (*CustomConfigImpl) PullRequestBuildUrl added in v0.38.0 

func (c *CustomConfigImpl) PullRequestBuildUrl() string

func (*CustomConfigImpl) RedisPassword added in v0.36.0 

func (c *CustomConfigImpl) RedisPassword() string

func (*CustomConfigImpl) RedisUrl added in v0.36.0 

func (c *CustomConfigImpl) RedisUrl() string

func (*CustomConfigImpl) RepositoryKeySeparator added in v0.9.0 

func (c *CustomConfigImpl) RepositoryKeySeparator() string

func (*CustomConfigImpl) RepositoryNameMaxLength added in v0.9.0 

func (c *CustomConfigImpl) RepositoryNameMaxLength() uint16

func (*CustomConfigImpl) RepositoryNamePermittedRegex added in v0.9.0 

func (c *CustomConfigImpl) RepositoryNamePermittedRegex() *regexp.Regexp

func (*CustomConfigImpl) RepositoryNameProhibitedRegex added in v0.9.0 

func (c *CustomConfigImpl) RepositoryNameProhibitedRegex() *regexp.Regexp

func (*CustomConfigImpl) RepositoryTypes added in v0.9.0 

func (c *CustomConfigImpl) RepositoryTypes() []string

func (*CustomConfigImpl) ReviewerFallback added in v0.47.0 

func (c *CustomConfigImpl) ReviewerFallback() string

func (*CustomConfigImpl) ServiceNameMaxLength added in v0.9.0 

func (c *CustomConfigImpl) ServiceNameMaxLength() uint16

func (*CustomConfigImpl) ServiceNamePermittedRegex added in v0.9.0 

func (c *CustomConfigImpl) ServiceNamePermittedRegex() *regexp.Regexp

func (*CustomConfigImpl) ServiceNameProhibitedRegex added in v0.9.0 

func (c *CustomConfigImpl) ServiceNameProhibitedRegex() *regexp.Regexp

func (*CustomConfigImpl) UpdateJobIntervalCronPart 

func (c *CustomConfigImpl) UpdateJobIntervalCronPart() string

func (*CustomConfigImpl) UpdateJobTimeoutSeconds 

func (c *CustomConfigImpl) UpdateJobTimeoutSeconds() uint16

func (*CustomConfigImpl) WebhooksProcessAsync added in v0.39.0 

func (c *CustomConfigImpl) WebhooksProcessAsync() bool

func (*CustomConfigImpl) YamlIndentation added in v0.54.0 

func (c *CustomConfigImpl) YamlIndentation() int

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.