confluentinc / terraform-provider-confluent

Terraform Provider for Confluent
Apache License 2.0
118 stars 61 forks source link

Request for Documentation around Single-Message Transforms #363

Closed burkematthew closed 4 months ago

burkematthew commented 4 months ago

Hi there-

We recently started implementing Single-Message Transforms for our Postgres CDC Source Connector. Because there wasn't any documentation around the transforms in Terraform, we went ahead and started implementing directly in Confluent Cloud. However, the next time we executed a Plan of our Terraform Stack, we noticed that the state change would wipe out our Single-Message Transforms. Lo and behold there is in fact Terraform support for Transforms\Predicates related to Single-Message Transforms. So, my request would be to provide some sort of documentation around using these Transforms and Predicates in Terraform so that users are both aware that this is supported and so that users can properly implement this in their stack.

Thanks!

linouk23 commented 4 months ago

@burkematthew, thank you for creating this issue!

You can think of TF as a wrapper on top of our other APIs that adds a lot of new, exciting features every day. We'll make sure to share this feedback with Connect team internally.

As a rule of thumb, it might be a good idea to assume that TF resources (for example, confluent_connector) support every attribute/feature of the corresponding API (for example, the Connect API).

That said, all contributions are very welcome. If you find a moment to create a PR to add an example with SMT, we would be very excited to merge it.

Let us know if that helps!

burkematthew commented 4 months ago

@linouk23 ah yeah that makes sense. I'll look into building a PR after I get through some more of the implementation on my side of things. Appreciate the quick response!