package xds import ( "fmt" envoy_core_v3 "github.com/envoyproxy/go-control-plane/envoy/config/core/v3" "github.com/hashicorp/go-version" ) var ( // minSupportedVersion is the oldest mainline version we support. This should always be // the zero'th point release of the last element of proxysupport.EnvoyVersions. minSupportedVersion = version.Must(version.NewVersion("1.17.0")) // add min version constraints for associated feature flags when necessary, for example: // minVersionAllowingEmptyGatewayClustersWithIncrementalXDS = version.Must(version.NewVersion("1.16.0")) specificUnsupportedVersions = []unsupportedVersion{} ) type unsupportedVersion struct { Version *version.Version UpgradeTo string Why string } type supportedProxyFeatures struct { // add version dependent feature flags here // // For example, we previously had flags for Envoy < 1.16 called: // // GatewaysNeedStubClusterWhenEmptyWithIncrementalXDS // IncrementalXDSUpdatesMustBeSerial // // Which then manifested in the code for checks with this struct populated. // By dropping support for 1.15, we no longer have any special flags here // but leaving this flagging functionality for future one-offs. } func determineSupportedProxyFeatures(node *envoy_core_v3.Node) (supportedProxyFeatures, error) { version := determineEnvoyVersionFromNode(node) return determineSupportedProxyFeaturesFromVersion(version) } func determineSupportedProxyFeaturesFromString(vs string) (supportedProxyFeatures, error) { version := version.Must(version.NewVersion(vs)) return determineSupportedProxyFeaturesFromVersion(version) } func determineSupportedProxyFeaturesFromVersion(version *version.Version) (supportedProxyFeatures, error) { if version == nil { // This would happen on either extremely old builds OR perhaps on // custom builds. Should we error? return supportedProxyFeatures{}, nil } if version.LessThan(minSupportedVersion) { return supportedProxyFeatures{}, fmt.Errorf("Envoy %s is too old and is not supported by Consul", version) } for _, uv := range specificUnsupportedVersions { if version.Equal(uv.Version) { return supportedProxyFeatures{}, fmt.Errorf( "Envoy %s is too old of a point release and is not supported by Consul because it %s. "+ "Please upgrade to version %s.", version, uv.Why, uv.UpgradeTo, ) } } sf := supportedProxyFeatures{} // add version constraints to populate feature flags here when necessary, for example: /* if version.LessThan(minVersionAllowingEmptyGatewayClustersWithIncrementalXDS) { sf.GatewaysNeedStubClusterWhenEmptyWithIncrementalXDS = true } */ return sf, nil } func determineEnvoyVersionFromNode(node *envoy_core_v3.Node) *version.Version { if node == nil { return nil } if node.UserAgentVersionType == nil { return nil } if node.UserAgentName != "envoy" { return nil } bv, ok := node.UserAgentVersionType.(*envoy_core_v3.Node_UserAgentBuildVersion) if !ok { // NOTE: we could sniff for *envoycore.Node_UserAgentVersion and do more regex but official builds don't have this problem. return nil } if bv.UserAgentBuildVersion == nil { return nil } v := bv.UserAgentBuildVersion.Version return version.Must(version.NewVersion( fmt.Sprintf("%d.%d.%d", v.GetMajorNumber(), v.GetMinorNumber(), v.GetPatch(), ), )) }