[APIE-798] CMK API v2 attribute deprecation - TF #927
Open
Cynthia Qin (cqin-confluent) wants to merge 3 commits intomasterfrom
Open
[APIE-798] CMK API v2 attribute deprecation - TF #927Cynthia Qin (cqin-confluent) wants to merge 3 commits intomasterfrom
Cynthia Qin (cqin-confluent) wants to merge 3 commits intomasterfrom
Conversation
There was a problem hiding this comment.
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_endpointandbootstrap_endpointattributes in resource and data source schema definitions - Updated documentation to mark these attributes as deprecated with guidance to use the
endpointattribute - 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release Notes
New Features
Bug Fixes
bootstrap_endpointandrest_endpointattributes for the confluent_kafka_cluster resource and data source, confluent_kafka_clusters data source, and confluent_cluster_link resource.rest_endpointattribute for the confluent_kafka_cluster_config resource, confluent_kafka_topic resource and data source, and confluent_kafka_mirror_topic resource.Examples
Checklist
Test & Reviewsection below.Blast Radiussection below.What
Deprecate the
bootstrap_endpointandrest_endpointattributes 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