cli
cli copied to clipboard
HUB-374: Adding deprecation warning message when user installs a deprecated connector version
trafficstars
Release Notes
New Features
- Confluent Platform: Adds a new WARN message when installing a self-managed connector version that has been deprecated and marked for End-of-Life by Confluent. This message will be shown when
confluent connect plugin installcommand is run for a deprecated plugin. The WARN message, however, will have no impact on the plugin installation.
Checklist
- [x] I have successfully built and used a custom CLI binary, without linter issues from this PR.
- [x] I have clearly specified in the
Whatsection below whether this PR applies to Confluent Cloud, Confluent Platform, or both. - [ ] I have verified this PR in Confluent Cloud pre-prod or production environment, if applicable.
- [x] I have verified this PR in Confluent Platform on-premises environment, if applicable.
- [x] I have attached manual CLI verification results or screenshots in the
Test & Reviewsection below. - [x] I have added appropriate CLI integration or unit tests for any new or updated commands and functionality.
- [x] I confirm that this PR introduces no breaking changes or backward compatibility issues.
- [x] I have indicated the potential customer impact if something goes wrong in the
Blast Radiussection below. - [ ] I have put checkmarks below confirming that the feature associated with this PR is enabled in:
- [ ] Confluent Cloud prod
- [ ] Confluent Cloud stag
- [x] Confluent Platform
- [ ] Check this box if the feature is enabled for certain organizations only
What
- This PR applies to Confluent Platform.
- As part of Connector Lifecycle Policy, we want to warn users if they are installing a connector version that has been deprecated and is marked for End of Life. See the requirements here - https://confluentinc.atlassian.net/browse/INIT-8736
- Implementation wise, we've updated the Hub REST API to expose deprecation information field
end_of_life_at(and others) which can be used by clients to determine if a given plugin version has been deprecated or not. - The CLI code has been updated to make use of
end_of_life_atfield and show a warning message to users who are installing a version which is nearing EOL. - What happens when EOL date is reached? The given plugin version will be removed from the Hub API itself, along with its archive download links.
- Why are we using a hard-coded reference doc link for CP 7.8 supported connector versions? In its current state, the Hub API has no knowledge of CP version being used by the customer and neither does the CLI. In near future with Hub revamp, we intend to add this knowledge in Hub so that it can be used by clients to make CP aware decisions about deprecation. In short, the current implementation is mainly being done for CP 7.8 and will be generalized with advances in Hub planned for later this year.
Blast Radius
- Blast radius is very minimal but it will be limited to Confluent Platform customers since we're slightly modifying the plugin installation command used for self-managed connector versions.
References
- Product Jira - https://confluentinc.atlassian.net/browse/INIT-8736
- Connector Lifecycle Policy - https://confluentinc.atlassian.net/wiki/x/fwb4uQ
- Wiki for changes in Hub API - https://confluentinc.atlassian.net/wiki/x/7QSC_g
- CLI changes Jira - https://confluentinc.atlassian.net/browse/HUB-374
Test & Review
- Unit tests and integration tests
- Manual test by building CLI locally and pointing to non-prod Hub API (see screenshot with WARN message)
:tada: All Contributor License Agreements have been signed. Ready to merge.
Please push an empty commit if you would like to re-run the checks to verify CLA status for all contributors.
This PR is on hold due to https://confluent.slack.com/archives/C209F54E8/p1742481319459419.
Closing for now, will re-open when there is more clarity around this.