Skip to content

Proxy envoy ADS requests to Consul server #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 8, 2022
Merged

Proxy envoy ADS requests to Consul server #4

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8fc7c83
Proxy envoy ADS requests to Consul server
jshahriddhi Aug 29, 2022
dc8c349
Start,stop,exit the grpc server gracefully
jshahriddhi Sep 2, 2022
4dd7652
Pass flags, add tests, cleanup and polish
jshahriddhi Sep 5, 2022
e2c2ec9
Semantic fixes
jshahriddhi Sep 6, 2022
943f7a7
Only allow local xds bind address
jshahriddhi Sep 7, 2022
cd799a4
Check loopback
jshahriddhi Sep 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions pkg/consuldp/bootstrap.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,12 @@ func (cdp *ConsulDataplane) bootstrapConfig(ctx context.Context) ([]byte, error)
Datacenter: rsp.Datacenter,
}

if cdp.localXDSServer != nil && cdp.localXDSServer.enabled {
if cdp.localXDSServer.listenerNetwork == "unix" {
args.GRPC.AgentSocket = cdp.localXDSServer.listenerAddress
} else {
xdsServerFullAddr := strings.Split(cdp.localXDSServer.listenerAddress, ":")
args.GRPC.AgentAddress = xdsServerFullAddr[0]
args.GRPC.AgentPort = xdsServerFullAddr[1]
}
if cdp.xdsServer.listenerNetwork == "unix" {
args.GRPC.AgentSocket = cdp.xdsServer.listenerAddress
} else {
xdsServerFullAddr := strings.Split(cdp.xdsServer.listenerAddress, ":")
args.GRPC.AgentAddress = xdsServerFullAddr[0]
args.GRPC.AgentPort = xdsServerFullAddr[1]
}

var bootstrapConfig bootstrap.BootstrapConfig
Expand Down
42 changes: 7 additions & 35 deletions pkg/consuldp/bootstrap_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ func TestBootstrapConfig(t *testing.T) {
Telemetry: &TelemetryConfig{
UseCentralConfig: false,
},
XDSServer: &XDSServer{BindAddress: "1.2.3.4", BindPort: xdsBindPort},
XDSServer: &XDSServer{BindAddress: "127.0.0.1", BindPort: xdsBindPort},
},
&pbdataplane.GetEnvoyBootstrapParamsResponse{
Service: "web",
Expand All @@ -82,7 +82,7 @@ func TestBootstrapConfig(t *testing.T) {
Telemetry: &TelemetryConfig{
UseCentralConfig: true,
},
XDSServer: &XDSServer{BindAddress: "1.2.3.4", BindPort: xdsBindPort},
XDSServer: &XDSServer{BindAddress: "127.0.0.1", BindPort: xdsBindPort},
},
&pbdataplane.GetEnvoyBootstrapParamsResponse{
Service: "web",
Expand Down Expand Up @@ -110,40 +110,14 @@ func TestBootstrapConfig(t *testing.T) {
Telemetry: &TelemetryConfig{
UseCentralConfig: false,
},
XDSServer: &XDSServer{BindAddress: "1.2.3.4", BindPort: xdsBindPort},
},
&pbdataplane.GetEnvoyBootstrapParamsResponse{
Service: "web",
NodeName: nodeName,
},
},
"local-xds-server": {
&Config{
Consul: &ConsulConfig{
GRPCPort: 1234,
},
Service: &ServiceConfig{
ServiceID: "web-proxy",
NodeName: nodeName,
},
Envoy: &EnvoyConfig{
AdminBindAddress: "127.0.0.1",
AdminBindPort: 19000,
},
Telemetry: &TelemetryConfig{
UseCentralConfig: false,
},
XDSServer: &XDSServer{BindAddress: "127.0.0.1", BindPort: xdsBindPort},
},
&pbdataplane.GetEnvoyBootstrapParamsResponse{
Service: "web",
NodeName: nodeName,
Config: makeStruct(map[string]any{
"envoy_dogstatsd_url": "this-should-not-appear-in-generated-config",
}),
},
},
"local-unix-socket-xds-server": {
"unix-socket-xds-server": {
&Config{
Consul: &ConsulConfig{
GRPCPort: 1234,
Expand Down Expand Up @@ -188,12 +162,10 @@ func TestBootstrapConfig(t *testing.T) {
dpServiceClient: client,
}

if checkLocalXDSServer(tc.cfg.XDSServer.BindAddress) {
if strings.HasPrefix(tc.cfg.XDSServer.BindAddress, "unix://") {
dp.localXDSServer = &localXDSServer{enabled: true, listenerAddress: socketPath, listenerNetwork: "unix"}
} else {
dp.localXDSServer = &localXDSServer{enabled: true, listenerAddress: fmt.Sprintf("127.0.0.1:%d", xdsBindPort)}
}
if strings.HasPrefix(tc.cfg.XDSServer.BindAddress, "unix://") {
dp.xdsServer = &xdsServer{listenerAddress: socketPath, listenerNetwork: "unix"}
} else {
dp.xdsServer = &xdsServer{listenerAddress: fmt.Sprintf("127.0.0.1:%d", xdsBindPort)}
}

bsCfg, err := dp.bootstrapConfig(ctx)
Expand Down
50 changes: 11 additions & 39 deletions pkg/consuldp/consul_dataplane.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ type consulServer struct {
grpcClientConn *grpc.ClientConn
}

type localXDSServer struct {
enabled bool
type xdsServer struct {
listener net.Listener
listenerAddress string
listenerNetwork string
Expand All @@ -45,7 +44,7 @@ type ConsulDataplane struct {
cfg *Config
consulServer *consulServer
dpServiceClient pbdataplane.DataplaneServiceClient
localXDSServer *localXDSServer
xdsServer *xdsServer
}

// NewConsulDP creates a new instance of ConsulDataplane
Expand All @@ -65,9 +64,8 @@ func NewConsulDP(cfg *Config) (*ConsulDataplane, error) {
})

return &ConsulDataplane{
logger: logger,
cfg: cfg,
localXDSServer: &localXDSServer{enabled: false},
logger: logger,
cfg: cfg,
}, nil
}

Expand All @@ -93,8 +91,8 @@ func validateConfig(cfg *Config) error {
return errors.New("logging settings not specified")
case cfg.XDSServer.BindAddress == "":
return errors.New("envoy xDS bind address not specified")
case cfg.XDSServer.BindPort == 0 && !checkLocalXDSServer(cfg.XDSServer.BindAddress):
return errors.New("envoy xDS bind port not specified")
case !strings.HasPrefix(cfg.XDSServer.BindAddress, "unix://") && cfg.XDSServer.BindAddress != "127.0.0.1" && cfg.XDSServer.BindAddress != "localhost":
Copy link
Contributor

@boxofrad boxofrad Sep 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: We might want to parse the address and use IsLoopback in case the user provides an IPv6 address.

return errors.New("non-local xDS bind address not allowed")
}
return nil
}
Expand Down Expand Up @@ -133,28 +131,6 @@ func (cdp *ConsulDataplane) setConsulServerSupportedFeatures(ctx context.Context
return nil
}

// checkLocalXDSServer checks if the specified xds bind address is local.
func checkLocalXDSServer(xdsBindAddr string) bool {
if strings.HasPrefix(xdsBindAddr, "unix://") || xdsBindAddr == "127.0.0.1" || xdsBindAddr == "localhost" {
return true
}
return false
}

// checkAndEnableLocalXDSServer checks if the specified xds bind address is local.
// If local, it enables the flag to configure consul-dataplane (later on in the setup process)
// with a gRPC server to serve envoy xDS requests.
// If not local, the flag remains turned off and it is assumed the xDS requests will be served
// by a remote gRPC server.
// Potential TODO: Explicitly allow specifying an option (xds.disable?) to disable configuring
// consul-dataplane as the xDS server in case xDS requests can be served on another port locally
// (example: consul server process on localhost).
func (cdp *ConsulDataplane) checkAndEnableLocalXDSServer() {
if checkLocalXDSServer(cdp.cfg.XDSServer.BindAddress) {
cdp.localXDSServer.enabled = true
}
}

func (cdp *ConsulDataplane) Run(ctx context.Context) error {
cdp.logger.Info("started consul-dataplane process")

Expand Down Expand Up @@ -187,16 +163,12 @@ func (cdp *ConsulDataplane) Run(ctx context.Context) error {
return fmt.Errorf("failed to set supported features: %w", err)
}

cdp.checkAndEnableLocalXDSServer()

if cdp.localXDSServer.enabled {
err = cdp.setupXDSServer()
if err != nil {
return err
}
go cdp.startXDSServer()
defer cdp.stopXDSServer()
err = cdp.setupXDSServer()
if err != nil {
return err
}
go cdp.startXDSServer()
defer cdp.stopXDSServer()

cfg, err := cdp.bootstrapConfig(ctx)
if err != nil {
Expand Down
49 changes: 2 additions & 47 deletions pkg/consuldp/consul_dataplane_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,11 @@ func TestNewConsulDPError(t *testing.T) {
expectErr: "envoy xDS bind address not specified",
},
{
name: "missing xds bind port when address not local",
name: "non-local xds bind address",
modFn: func(c *Config) {
c.XDSServer.BindPort = 0
c.XDSServer.BindAddress = "1.2.3.4"
},
expectErr: "envoy xDS bind port not specified",
expectErr: "non-local xDS bind address not allowed",
},
}
for _, tc := range testCases {
Expand Down Expand Up @@ -214,47 +213,3 @@ func TestSetConsulServerSupportedFeaturesError(t *testing.T) {
require.ErrorContains(t, consulDP.setConsulServerSupportedFeatures(context.Background()), "failure getting supported consul-dataplane features")
require.Empty(t, consulDP.consulServer.supportedFeatures)
}

func TestCheckAndEnableLocalXDSServer(t *testing.T) {
type testCase struct {
name string
modFn func(*Config)
expectLocalXDSServer bool
}

testCases := []testCase{
{
name: "localhost ip",
modFn: func(c *Config) { c.XDSServer.BindAddress = "127.0.0.1" },
expectLocalXDSServer: true,
},
{
name: "localhost name",
modFn: func(c *Config) { c.XDSServer.BindAddress = "localhost" },
expectLocalXDSServer: true,
},
{
name: "unix socket",
modFn: func(c *Config) { c.XDSServer.BindAddress = "unix:///var/run/xds.sock" },
expectLocalXDSServer: true,
},
{
name: "remote ip",
modFn: func(c *Config) {
c.XDSServer.BindAddress = "1.2.3.4"
c.XDSServer.BindPort = 1234
},
expectLocalXDSServer: false,
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
cfg := validConfig()
tc.modFn(cfg)
cdp, err := NewConsulDP(cfg)
require.NoError(t, err)
cdp.checkAndEnableLocalXDSServer()
require.Equal(t, tc.expectLocalXDSServer, cdp.localXDSServer.enabled)
})
}
}
2 changes: 1 addition & 1 deletion pkg/consuldp/testdata/TestBootstrapConfig/basic.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"endpoint": {
"address": {
"socket_address": {
"address": "1.2.3.4",
"address": "127.0.0.1",
"port_value": 1234
}
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/consuldp/testdata/TestBootstrapConfig/central-telemetry-config.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"endpoint": {
"address": {
"socket_address": {
"address": "1.2.3.4",
"address": "127.0.0.1",
"port_value": 1234
}
}
Expand Down
Loading