docs: Deprecations for connect-native SDK and specific connect native APIs#17937
Merged
docs: Deprecations for connect-native SDK and specific connect native APIs#17937
Conversation
david-yu
added
type/docs
added 2 commits
June 28, 2023 10:00
added 2 commits
June 28, 2023 10:10
added 2 commits
June 28, 2023 10:25
im2nguyen
approved these changes
Jun 28, 2023
added 2 commits
June 28, 2023 10:37
Contributor
trujillo-adam
left a comment
trujillo-adam
left a comment
There was a problem hiding this comment.
Made a few suggestions to address some punctuation and consistency issues.
| # Service Mesh Native Integration for Go Applications | ||
|
|
||
| -> **Note:** The Connect Native golang SDK is currently deprecated and will be removed in a future Consul release. | ||
| The eventual removal of the SDK is dependent on the delivery of proxyless GRPC via XDS which is tracked on [GH-10339](https://github.com/hashicorp/consul/issues/10339). |
Contributor
There was a problem hiding this comment.
Suggested change
| The eventual removal of the SDK is dependent on the delivery of proxyless GRPC via XDS which is tracked on [GH-10339](https://github.com/hashicorp/consul/issues/10339). | |
| We will replace the SDK functionality with proxy-less gRPC connections to Consul xDS. Refer to [GH-10339](https://github.com/hashicorp/consul/issues/10339) for additional information and to track progress toward the replacement functionality. |
Is it correct to characterize the upcoming functionality as a replacement for the SDK?
Contributor
Author
There was a problem hiding this comment.
Technically yes since all that is needed is the native golang package for XDS. I.e.
import _ "google.golang.org/grpc/xds"
Co-authored-by: trujillo-adam <[email protected]>
Co-authored-by: trujillo-adam <[email protected]>
Contributor
Author
|
Thanks @trujillo-adam and @im2nguyen I believe I have addressed all your comments. |
Contributor
|
@david-yu feel free to merge when ready! |
Contributor
Author
|
Addressed @mkeeler 's comments. |
mkeeler
approved these changes
Jun 28, 2023
4 tasks
Description
Deprecation of connect native SDK and specific connect native APIs to discourage new users from adopting connect native until a longer term solution exists (i.e. proxyless GRPC for XDS GH-10339) for native app integration into Consul Service Mesh.
Testing & Reproduction steps
Links
PR Checklist