From 6f660e5e258157201fed2f118f5a845a1082cd55 Mon Sep 17 00:00:00 2001 From: David Yu Date: Wed, 28 Jun 2023 12:45:46 -0700 Subject: [PATCH] docs: Deprecations for connect-native SDK and specific connect native APIs (#17937) * Update v1_16_x.mdx * Update connect native golang page --------- Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --- website/content/docs/connect/native/go.mdx | 7 +++++++ website/content/docs/connect/native/index.mdx | 15 +++++++++++---- .../content/docs/connect/proxies/integrate.mdx | 11 +++++++++++ .../content/docs/release-notes/consul/v1_16_x.mdx | 11 ++++++++++- 4 files changed, 39 insertions(+), 5 deletions(-) diff --git a/website/content/docs/connect/native/go.mdx b/website/content/docs/connect/native/go.mdx index df9080f17f..e3068058fd 100644 --- a/website/content/docs/connect/native/go.mdx +++ b/website/content/docs/connect/native/go.mdx @@ -7,6 +7,13 @@ description: >- # Service Mesh Native Integration for Go Applications + + +The Connect Native golang SDK is currently deprecated and will be removed in a future Consul release. +The SDK will be removed when the long term replacement to native application integration (such as a proxyless gRPC service mesh integration) is delivered. Refer to [GH-10339](https://github.com/hashicorp/consul/issues/10339) for additional information and to track progress toward one potential solution that is tracked as replacement functionality. + + + We provide a library that makes it drop-in simple to integrate Consul service mesh with most [Go](https://golang.org/) applications. This page shows examples of integrating this library for accepting or establishing mesh-based diff --git a/website/content/docs/connect/native/index.mdx b/website/content/docs/connect/native/index.mdx index e8cc421af8..3cf64f346c 100644 --- a/website/content/docs/connect/native/index.mdx +++ b/website/content/docs/connect/native/index.mdx @@ -7,10 +7,17 @@ description: >- # Service Mesh Native App Integration Overview -~> **Note:** The Native App Integration does not support many of the Consul's service -mesh features, and is not under active development. -The [Envoy proxy](/consul/docs/connect/proxies/envoy) should be used for most production -environments. + + +The Connect Native Golang SDK and `v1/agent/connect/authorize`, `v1/agent/connect/ca/leaf`, +and `v1/agent/connect/ca/roots` APIs are deprecated and will be removed in a future release. Although Connect Native +will still operate as designed, we do not recommend leveraging this feature because it is deprecated and will be removed +removed when the long term replacement to native application integration (such as a proxyless gRPC service mesh integration) is delivered. Refer to [GH-10339](https://github.com/hashicorp/consul/issues/10339) for additional information and to track progress toward one potential solution that is tracked as replacement functionality. + +The Native App Integration does not support many of the Consul's service mesh features, and is not under active development. +The [Envoy proxy](/consul/docs/connect/proxies/envoy) should be used for most production environments. + + Applications can natively integrate with Consul's service mesh API to support accepting and establishing connections to other mesh services without the overhead of a diff --git a/website/content/docs/connect/proxies/integrate.mdx b/website/content/docs/connect/proxies/integrate.mdx index 1ad9f4b911..d00e01d1bd 100644 --- a/website/content/docs/connect/proxies/integrate.mdx +++ b/website/content/docs/connect/proxies/integrate.mdx @@ -7,6 +7,17 @@ description: >- # Custom Proxy Configuration for Service Mesh + + + The Connect Native Golang SDK and `v1/agent/connect/authorize`, `v1/agent/connect/ca/leaf`, + and `v1/agent/connect/ca/roots` APIs are deprecated and will be removed in a future release. Although Connect Native + will still operate as designed, we do not recommend leveraging this feature because it is deprecated and will be removed when the long term replacement to native application integration (such as a proxyless gRPC service mesh integration) is delivered. Refer to [GH-10339](https://github.com/hashicorp/consul/issues/10339) for additional information and to track progress toward one potential solution that is tracked as replacement functionality. + + The Native App Integration does not support many of the Consul's service mesh features, and is not under active development. + The [Envoy proxy](/consul/docs/connect/proxies/envoy) should be used for most production environments. + + + This topic describes the process and API endpoints you can use to extend proxies for integration with Consul. ## Overview diff --git a/website/content/docs/release-notes/consul/v1_16_x.mdx b/website/content/docs/release-notes/consul/v1_16_x.mdx index 33241b6b84..616104a709 100644 --- a/website/content/docs/release-notes/consul/v1_16_x.mdx +++ b/website/content/docs/release-notes/consul/v1_16_x.mdx @@ -51,6 +51,15 @@ We are pleased to announce the following Consul updates. Consul's API gateway is the recommended alternative to ingress gateway. For ingress gateway features not currently supported by API gateway, equivalent functionality will be added to API gateway over the next several releases of Consul. +- **Connect Native Golang SDK:** The Connect Native [Golang SDK](https://github.com/hashicorp/consul/tree/main/connect) is deprecated and will be removed in a future release. No further enhancements or maintenance is expected in the future releases. We will remove the SDK when the long term replacement to native application integration (such as a proxyless gRPC service mesh integration) is delivered. Refer to [GH-10339](https://github.com/hashicorp/consul/issues/10339) for additional information and to track progress toward one potential solution that is tracked as replacement functionality. + +- **Connect Native APIs:** The following APIs for Connect Native are deprecated: + - `v1/agent/connect/authorize` - used by the SDK to perform intention based authorization checks + - `v1/agent/connect/ca/leaf` - used by the SDK to get a leaf cert for a locally registered service + - `v1/agent/connect/ca/roots` - use to retrieved cached CA roots form the local client agent + + The `v1/agent/connect/authorize` and `v1/agent/connect/ca/leaf` endpoints have corresponding gRPC APIs. We will remove these APIs when the gRPC API for `v1/agent/connect/ca/roots` and HTTP endpoints for all three APIs are available. + ## Upgrading For more detailed information, please refer to the [upgrade details page](/consul/docs/upgrading/upgrade-specific) and the changelogs. @@ -61,4 +70,4 @@ The changelogs for this major release version and any maintenance versions are l These links take you to the changelogs on the GitHub website. -- [1.16.0](https://github.com/hashicorp/consul/releases/tag/v1.16.0) \ No newline at end of file +- [1.16.0](https://github.com/hashicorp/consul/releases/tag/v1.16.0)