upbound / provider-terraform

A @crossplane provider for Terraform
Apache License 2.0
142 stars 56 forks source link

Disable the client cache for Workspace lookups #253

Open toastwaffle opened 6 months ago

toastwaffle commented 6 months ago

Description of your changes

Fixes #243 (sort of)

This disables the cache used when getting Workspace resources at the start of each reconciliation to avoid a potential concurrent map iteration/write, caused by the client-go workqueue not being fully deduplicated. That's an upstream bug, for which this PR is a mitigation to prevent the provider crashing.

I'm not totally convinced that this is the right thing to do. If we are actually seeing concurrent reconciliations of the same workspace, maybe it is better to crash; the problem is that crashing has the potential to leave workspaces in an inconsistent state (i.e. half-applied, with the state lock left around), and causes all workspaces to be reconciled at once when the provider starts back up.

If we do see concurrent reconciles, we should still be protected by the terraform state lock, although we might see strange errors/status on the resource.

I have:

How has this code been tested

Unit tests passed; I intend to rely on the Github Action integration test to assert that the provider still works as intended, but the actual bug happens very rarely (With 100+ Workspaces we saw provider-terraform go 10 days without crashing) so it's hard to prove that this fixes the issue.

turkenf commented 1 week ago

/test-examples="examples/workspace-inline-aws.yaml"