Backport of Fix gateway services cleanup where proxy deregistration happens after service deregistration into release/1.16.x (#18861)

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

* Fix gateway services cleanup where proxy deregistration happens after service deregistration

* Add test

* Add changelog

* Fix comment
This commit is contained in:
Andrew Stucki 2023-09-18 16:52:21 -04:00 committed by GitHub
parent 3b280f7b12
commit 400d9def83
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 88 additions and 0 deletions

3
.changelog/18831.txt Normal file
View File

@ -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.
```

View File

@ -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 { if err := cleanupKindServiceName(tx, idx, sn, structs.ServiceKindConnectEnabled); err != nil {
return fmt.Errorf("failed to cleanup connect-enabled service name: %v", err) 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)
}
} }
} }

View File

@ -8311,6 +8311,85 @@ func TestCatalog_cleanupGatewayWildcards_panic(t *testing.T) {
require.NoError(t, s.DeleteNode(6, "foo", nil, "")) 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) { func TestCatalog_DownstreamsForService(t *testing.T) {
defaultMeta := structs.DefaultEnterpriseMetaInDefaultPartition() defaultMeta := structs.DefaultEnterpriseMetaInDefaultPartition()