Skip to content
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.

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

Fix gateway services cleanup where proxy deregistration happens after service deregistration #18831

Merged
merged 4 commits into from
Sep 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .changelog/18831.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
gateways: Fix a bug where gateway to service mappings weren't being cleaned up properly when externally registered proxies were being deregistered.
```
6 changes: 6 additions & 0 deletions agent/consul/state/catalog.go
Original file line number Diff line number Diff line change
Expand Up @@ -2065,6 +2065,12 @@ func (s *Store) deleteServiceTxn(tx WriteTxn, idx uint64, nodeName, serviceID st
if err := cleanupKindServiceName(tx, idx, sn, structs.ServiceKindConnectEnabled); err != nil {
return fmt.Errorf("failed to cleanup connect-enabled service name: %v", err)
}
// we need to do this if the proxy is deleted after the service itself
// as the guard after this might not be 1-1 between proxy and service
// names.
if err := cleanupGatewayWildcards(tx, idx, sn, false); err != nil {
return fmt.Errorf("failed to clean up gateway-service associations for %q: %v", psn.String(), err)
}
}
}

Expand Down
79 changes: 79 additions & 0 deletions agent/consul/state/catalog_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -8311,6 +8311,85 @@ func TestCatalog_cleanupGatewayWildcards_panic(t *testing.T) {
require.NoError(t, s.DeleteNode(6, "foo", nil, ""))
}

func TestCatalog_cleanupGatewayWildcards_proxy(t *testing.T) {
s := testStateStore(t)

require.NoError(t, s.EnsureNode(0, &structs.Node{
ID: "c73b8fdf-4ef8-4e43-9aa2-59e85cc6a70c",
Node: "foo",
}))
require.NoError(t, s.EnsureConfigEntry(1, &structs.ProxyConfigEntry{
Kind: structs.ProxyDefaults,
Name: structs.ProxyConfigGlobal,
Config: map[string]interface{}{
"protocol": "http",
},
}))

defaultMeta := structs.DefaultEnterpriseMetaInDefaultPartition()

require.NoError(t, s.EnsureConfigEntry(3, &structs.IngressGatewayConfigEntry{
Kind: "ingress-gateway",
Name: "my-gateway-2-ingress",
Listeners: []structs.IngressListener{
{
Port: 1111,
Protocol: "http",
Services: []structs.IngressService{
{
Name: "*",
EnterpriseMeta: *defaultMeta,
},
},
},
},
}))

// Register two services, a regular service, and a sidecar proxy for it
api := structs.NodeService{
ID: "api",
Service: "api",
Address: "127.0.0.2",
Port: 443,
EnterpriseMeta: *defaultMeta,
}
require.NoError(t, s.EnsureService(4, "foo", &api))
proxy := structs.NodeService{
Kind: structs.ServiceKindConnectProxy,
ID: "api-proxy",
Service: "api-proxy",
Address: "127.0.0.3",
Port: 443,
Proxy: structs.ConnectProxyConfig{
DestinationServiceName: "api",
DestinationServiceID: "api",
},
EnterpriseMeta: *defaultMeta,
}
require.NoError(t, s.EnsureService(5, "foo", &proxy))

// make sure we have only one gateway service
_, services, err := s.GatewayServices(nil, "my-gateway-2-ingress", defaultMeta)
require.NoError(t, err)
require.Len(t, services, 1)

// now delete the target service
require.NoError(t, s.DeleteService(6, "foo", "api", nil, ""))

// at this point we still have the gateway services because we have a connect proxy still
_, services, err = s.GatewayServices(nil, "my-gateway-2-ingress", defaultMeta)
require.NoError(t, err)
require.Len(t, services, 1)

// now delete the connect proxy
require.NoError(t, s.DeleteService(7, "foo", "api-proxy", nil, ""))

// make sure we no longer have any services
_, services, err = s.GatewayServices(nil, "my-gateway-2-ingress", defaultMeta)
require.NoError(t, err)
require.Len(t, services, 0)
}

func TestCatalog_DownstreamsForService(t *testing.T) {
defaultMeta := structs.DefaultEnterpriseMetaInDefaultPartition()

Expand Down