luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Backport of docs: Deprecations for connect-native SDK and specific connect native APIs into release/1.16.x (#17941) 

* backport of commit a8658bf7c88722c0b88481637c213ce838eb3c7c

* backport of commit 966673b5fe20854f815211fe97cfff30056a002d

* backport of commit 7cea575b3a5c28f014fb35c42f46079ccbeaeef0

* backport of commit 17e57a3abe52c19d323c4159b1521788298e8216

* backport of commit 86a7dc34657c4434cb89077fff95217744e596e5

* backport of commit 7f541fffaabb377de97e13b20e8052b9573643df

* backport of commit 4e46d282ff8f24418321e32924c466762dd3f459

* backport of commit 72d7b61634ffc539f4c5a70de6c648a51a74c9f4

* backport of commit 2b6169f7cb3bd374ce0a378fc174268790dd1d4b

* backport of commit b94a833ec952979e9fc7d6518ce30897b3477323

* backport of commit 74e0ec2a05ead2da243086dedab606ff16185afe

* backport of commit be0167b4920f2406f53f326780fff2f7633734d7

* backport of commit a92a3088b4d5431fc6668c1859cd46301e44af8e

* backport of commit 4b02d312d718ac9ea265d8d39463a7625e659c51

* backport of commit f131207d42ce1684a49e18c4096def2fa6d68a82

* backport of commit 3f0be37f49b0b006e5d9ecdba8e9a4af8c933230

* backport of commit 29ed7aaf6f7e080e41e896111b9f25b95af880a7

* backport of commit 8ae546707beaf3a52c28f2e5d8a9d85b965ee93c

* backport of commit 8ed74fcf442dd8cf5e9abb8317d106564c47cfd1

* backport of commit 36537bafb6962d2f966da754a19cbc6a23ef2535

* backport of commit ef7599d7789a216e688a4663538b2e9d06f82c07

---------

Co-authored-by: David Yu <dyu@hashicorp.com>
This commit is contained in:
hc-github-team-consul-core 2023-06-28 14:58:47 -05:00 committed by GitHub
parent 54ace0e072
commit 4cad4922a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 39 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
website/content/docs/connect/native/go.mdx
View File

@ -7,6 +7,13 @@ description: >-
# Service Mesh Native Integration for Go Applications # 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 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.
</Note>
We provide a library that makes it drop-in simple to integrate Consul service mesh 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 with most [Go](https://golang.org/) applications. This page shows examples
of integrating this library for accepting or establishing mesh-based of integrating this library for accepting or establishing mesh-based

15
website/content/docs/connect/native/index.mdx
View File

@ -7,10 +7,17 @@ description: >-
# Service Mesh Native App Integration Overview # Service Mesh Native App Integration Overview
~> **Note:** The Native App Integration does not support many of the Consul's service <Note>
mesh features, and is not under active development.
The [Envoy proxy](/consul/docs/connect/proxies/envoy) should be used for most production The Connect Native Golang SDK and `v1/agent/connect/authorize`, `v1/agent/connect/ca/leaf`,
environments. 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.
</Note>
Applications can natively integrate with Consul's service mesh API to support accepting 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 and establishing connections to other mesh services without the overhead of a

11
website/content/docs/connect/proxies/integrate.mdx
View File

@ -7,6 +7,17 @@ description: >-
# Custom Proxy Configuration for Service Mesh # Custom Proxy Configuration for Service Mesh
<Note>
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.
</Note>
This topic describes the process and API endpoints you can use to extend proxies for integration with Consul. This topic describes the process and API endpoints you can use to extend proxies for integration with Consul.
## Overview ## Overview

9
website/content/docs/release-notes/consul/v1_16_x.mdx
View File

@ -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. 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 ## Upgrading
For more detailed information, please refer to the [upgrade details page](/consul/docs/upgrading/upgrade-specific) and the changelogs. For more detailed information, please refer to the [upgrade details page](/consul/docs/upgrading/upgrade-specific) and the changelogs.