mirror of
https://github.com/pomerium/pomerium.git
synced 2025-04-28 18:06:34 +02:00
5e94b2f8f1
* Refactor trace config to match supported otel options * use duration instead of int64 for otel timeouts * change 'trace client updated' log level to debug
102 lines
3.9 KiB
Go
102 lines
3.9 KiB
Go
package config
|
|
|
|
import (
|
|
"fmt"
|
|
"regexp"
|
|
|
|
clusterv3 "github.com/envoyproxy/go-control-plane/envoy/config/cluster/v3"
|
|
)
|
|
|
|
// KeyAction defines the Pomerium behavior when it encounters a deprecated config field
|
|
type KeyAction string
|
|
|
|
// FieldCheckMsg is a log message to print for a config option
|
|
type FieldCheckMsg string
|
|
|
|
const (
|
|
// KeyActionWarn would result in warning to log
|
|
KeyActionWarn = KeyAction("warn")
|
|
// KeyActionError would result in error in log and possibly program stop
|
|
KeyActionError = KeyAction("error")
|
|
// UnknownFieldAction default behavior when observing an unknown field is to warn
|
|
UnknownFieldAction = KeyActionWarn
|
|
// FieldCheckMsgRemoved log message when field was removed
|
|
FieldCheckMsgRemoved = FieldCheckMsg("config option was removed")
|
|
// FieldCheckMsgUnknown log message for unrecognized / unhandled config option
|
|
FieldCheckMsgUnknown = FieldCheckMsg("unknown config option")
|
|
)
|
|
|
|
var reKeyPath = regexp.MustCompile(`\[\d+\]`)
|
|
|
|
var (
|
|
// options that were deprecated in the config
|
|
removedConfigFields = map[string]string{
|
|
"client_ca": "https://www.pomerium.com/docs/deploy/core/upgrading#new-downstream-mtls-settings",
|
|
"client_ca_file": "https://www.pomerium.com/docs/deploy/core/upgrading#new-downstream-mtls-settings",
|
|
"idp_service_account": "https://docs.pomerium.com/docs/overview/upgrading#idp-directory-sync",
|
|
"idp_refresh_directory_timeout": "https://docs.pomerium.com/docs/overview/upgrading#idp-directory-sync",
|
|
"idp_refresh_directory_interval": "https://docs.pomerium.com/docs/overview/upgrading#idp-directory-sync",
|
|
"idp_qps": "https://docs.pomerium.com/docs/overview/upgrading#idp-directory-sync",
|
|
"routes.allowed_groups": "https://docs.pomerium.com/docs/overview/upgrading#idp-groups-policy",
|
|
"routes.set_authorization_header": "https://www.pomerium.com/docs/deploy/core/upgrading#set-authorization-header",
|
|
"tracing_datadog_address": "https://docs.pomerium.com/docs/overview/upgrading#removed-tracing-options",
|
|
"tracing_jaeger_collector_endpoint": "https://docs.pomerium.com/docs/overview/upgrading#removed-tracing-options",
|
|
"tracing_jaeger_agent_endpoint": "https://docs.pomerium.com/docs/overview/upgrading#removed-tracing-options",
|
|
"tracing_zipkin_endpoint": "https://docs.pomerium.com/docs/overview/upgrading#removed-tracing-options",
|
|
"tracing_provider": "https://docs.pomerium.com/docs/overview/upgrading#removed-tracing-options",
|
|
"tracing_sample_rate": "https://docs.pomerium.com/docs/overview/upgrading#removed-tracing-options",
|
|
}
|
|
|
|
ignoreConfigFields = map[string]struct{}{
|
|
// set_response_headers is handled separately from mapstructure
|
|
"set_response_headers": {},
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
// mapstructure has issues with embedded protobuf structs that we should ignore
|
|
envoyOptsFields := (*clusterv3.Cluster)(nil).ProtoReflect().Descriptor().Fields()
|
|
for i := range envoyOptsFields.Len() {
|
|
field := envoyOptsFields.Get(i)
|
|
ignoreConfigFields[fmt.Sprintf("routes.%s", field.Name())] = struct{}{}
|
|
}
|
|
}
|
|
|
|
// FieldMsg returns information
|
|
type FieldMsg struct {
|
|
Key string
|
|
DocsURL string
|
|
FieldCheckMsg
|
|
KeyAction
|
|
}
|
|
|
|
// CheckUnknownConfigFields returns list of messages to be emitted about unrecognized fields
|
|
func CheckUnknownConfigFields(fields []string) []FieldMsg {
|
|
out := make([]FieldMsg, 0, len(fields))
|
|
|
|
for _, key := range fields {
|
|
path := reKeyPath.ReplaceAllString(key, "")
|
|
|
|
if docsURL, ok := removedConfigFields[path]; ok {
|
|
out = append(out, FieldMsg{
|
|
Key: path,
|
|
DocsURL: docsURL,
|
|
KeyAction: KeyActionError,
|
|
FieldCheckMsg: FieldCheckMsgRemoved,
|
|
})
|
|
continue
|
|
}
|
|
|
|
if _, ok := ignoreConfigFields[path]; ok {
|
|
continue
|
|
}
|
|
|
|
out = append(out, FieldMsg{
|
|
Key: path,
|
|
KeyAction: KeyActionWarn,
|
|
FieldCheckMsg: FieldCheckMsgUnknown,
|
|
})
|
|
}
|
|
|
|
return out
|
|
}
|