Late-initialize spec.forProvider.user of Broker.mq iff spec.initProvi…

…der.user is not specified - Move spec.forProvider.user of the Broker.mq dependency to spec.initProvider.user in the User.mq example manifest. Signed-off-by: Alper Rifat Ulucinar <[email protected]>
crossplane-contrib · May 24, 2024 · 29aa8ba · 29aa8ba
1 parent 1ff091d
commit 29aa8ba
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/apis/mq/v1beta1/zz_broker_terraformed.go b/apis/mq/v1beta1/zz_broker_terraformed.go
diff --git a/config/mq/config.go b/config/mq/config.go
@@ -49,6 +49,18 @@ func Configure(p *config.Provider) {
 			}
 			return conn, nil
 		}
+		// we need to prevent a race between the Broker.mq & User.mq
+		// controllers when the users are specified under the spec.forProvider.
+		// This configuration will prevent the upjet runtime from
+		// late-initializing spec.forProvider.user when the bootstrap users
+		// are specified under spec.initProvider. Without this configuration,
+		// spec.forProvider gets initialized even if the bootstrap users are
+		// specified under spec.initProvider.
+		r.LateInitializer = config.LateInitializer{
+			ConditionalIgnoredFields: []string{
+				"user",
+			},
+		}
 	})
 
 	p.AddResourceConfigurator("aws_mq_user", func(r *config.Resource) {

diff --git a/examples/mq/v1alpha1/user.yaml b/examples/mq/v1alpha1/user.yaml
@@ -7,7 +7,6 @@ kind: User
 metadata:
   annotations:
     meta.upbound.io/example-id: mq/v1alpha1/user
-    upjet.upbound.io/manual-intervention: "Note that there is a race between Broker and User controllers."
   labels:
     testing.upbound.io/example-name: example
   name: example
@@ -47,6 +46,17 @@ spec:
     engineType: ActiveMQ
     engineVersion: 5.17.6
     hostInstanceType: mq.t3.micro
+  # bootstrap users must be specified under spec.initProvider if the Broker.mq
+  # MR is to be used together with User.mq MRs, as the controllers for these
+  # MRs race on the external ActiveMQ broker users if the bootstrap users are
+  # specified under spec.forProvider, and the AWS CreateBroker/mq
+  # REST operation requires at least one user to be specified while
+  # provisioning a broker. Other techniques, such as pausing reconciliations
+  # for the Broker.mq object using the pause annotation, or preventing updates
+  # using the management policies will also prevent this race between
+  # the controllers but the "XRM way" is to use the spec.initProvider API in
+  # this situation.
+  initProvider:
     user:
     - passwordSecretRef:
         key: password