Skip to content

[APIE-798] CMK API v2 attribute deprecation - TF #927

Open
Cynthia Qin (cqin-confluent) wants to merge 3 commits intomasterfrom
APIE-798
Open

[APIE-798] CMK API v2 attribute deprecation - TF #927
Cynthia Qin (cqin-confluent) wants to merge 3 commits intomasterfrom
APIE-798

Conversation

@cqin-confluent
Copy link
Member

@cqin-confluent Cynthia Qin (cqin-confluent) commented Jan 23, 2026

Release Notes

New Features

  • [Briefly describe new features introduced in this PR].

Bug Fixes

  • Deprecated the bootstrap_endpoint and rest_endpoint attributes for the confluent_kafka_cluster resource and data source, confluent_kafka_clusters data source, and confluent_cluster_link resource.
  • Deprecated the rest_endpoint attribute for the confluent_kafka_cluster_config resource, confluent_kafka_topic resource and data source, and confluent_kafka_mirror_topic resource.

Examples

  • [Briefly describe any Terraform configuration example updates in this PR].

Checklist

  • I can successfully build and use a custom Terraform provider binary for Confluent.
  • I have verified my PR with real Confluent Cloud resources in a pre-prod or production environment, or both.
  • I have attached manual Terraform verification results or screenshots in the Test & Review section below.
  • I have included appropriate Terraform acceptance or unit tests for any new resource, data source, or functionality.
  • I have included appropriate Terraform live testing for any new resource, data source, or functionality.
  • I have included a testing thread with main.tf file in #terraform-provider-development-testing.
  • I have included rate limit/load testing results.
  • I confirm that this PR introduces no breaking changes or backward compatibility issues.
  • I have updated the corresponding documentation and include relevant examples for this PR.
  • I have indicated the potential customer impact if something goes wrong in the Blast Radius section below.
  • I have put checkmarks below confirming that the feature associated with this PR is enabled in:
    • Confluent Cloud prod
    • Confluent Cloud stag
    • Check this box if the feature is enabled for certain organizations only

What

Deprecate the bootstrap_endpoint and rest_endpoint attributes in CMK API v2 in favour of endpoints map feature.

Blast Radius

No. This change will add a display of "deprecated" to users without impacting or blocking any existing user workflows.

References

APIE-759 CMK API v2 - Deprecate attributes

Test & Review

@cqin-confluent Cynthia Qin (cqin-confluent) requested a review from a team as a code owner January 23, 2026 02:26
Copilot AI review requested due to automatic review settings January 23, 2026 02:26
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR deprecates the rest_endpoint and bootstrap_endpoint attributes across multiple Kafka-related resources and data sources in the Terraform provider, directing users to use a new endpoint attribute instead.

Changes:

  • Added deprecation notices to rest_endpoint and bootstrap_endpoint attributes in resource and data source schema definitions
  • Updated documentation to mark these attributes as deprecated with guidance to use the endpoint attribute
  • Applied changes consistently across kafka_topic, kafka_cluster, kafka_cluster_config, kafka_mirror_topic, and cluster_link resources and their corresponding data sources

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
internal/provider/resource_kafka_topic.go Deprecated rest_endpoint attribute in kafka topic resource schema
internal/provider/resource_kafka_mirror_topic.go Deprecated rest_endpoint attribute in mirror topic resource schema
internal/provider/resource_kafka_cluster_config.go Deprecated rest_endpoint attribute in cluster config resource schema
internal/provider/resource_kafka_cluster.go Deprecated both bootstrap_endpoint and rest_endpoint computed attributes
internal/provider/resource_cluster_link.go Deprecated rest_endpoint and bootstrap_endpoint attributes in cluster link resource schema
internal/provider/data_source_kafka_topic.go Deprecated rest_endpoint attribute in kafka topic data source schema
internal/provider/data_source_kafka_clusters.go Deprecated bootstrap_endpoint and rest_endpoint attributes in kafka clusters data source schema
internal/provider/data_source_kafka_cluster.go Deprecated bootstrap_endpoint and rest_endpoint attributes in kafka cluster data source schema
docs/resources/confluent_kafka_topic.md Updated documentation to mark rest_endpoint as deprecated
docs/resources/confluent_kafka_mirror_topic.md Updated documentation to mark rest_endpoint as deprecated
docs/resources/confluent_kafka_cluster_config.md Updated documentation to mark rest_endpoint as deprecated
docs/resources/confluent_kafka_cluster.md Updated documentation to mark both endpoint attributes as deprecated
docs/resources/confluent_cluster_link.md Updated documentation to mark endpoint attributes as deprecated across all cluster configurations
docs/data-sources/confluent_kafka_topic.md Updated data source documentation to mark rest_endpoint as deprecated
docs/data-sources/confluent_kafka_clusters.md Updated data source documentation to mark endpoint attributes as deprecated
docs/data-sources/confluent_kafka_cluster.md Updated data source documentation to mark endpoint attributes as deprecated

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants