Skip to content

docs: Manual backport for v1.21 docs #22353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
boruszak merged 23 commits into from
May 22, 2025
Merged

docs: Manual backport for v1.21 docs #22353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
edcd855
Initialise release for consul 1.21 (#22195)
abhishek-hashicorp Mar 3, 2025
0e77b55
Upgrade go version to 1.23 (#22204)
abhishek-hashicorp Mar 6, 2025
7de8e29
security: Upgrade crypto, oauth, go-jose (#22207)
abhishek-hashicorp Mar 6, 2025
7665dd3
Add the missing Service TaggedAddresses and Check Type fields to Txn …
nitin-sachdev-29 Mar 13, 2025
d299ad0
[Feature] Invalidate session check if associated session is deleted (…
srahul3 Mar 20, 2025
8946d7d
build(deps): bump go version to go1.23.7 (#22237)
dduzgun-security Mar 26, 2025
3bd8e97
Fixes a couple of DNS token example commands (#22224)
nickwales Mar 26, 2025
9bd863d
Refactor Txn API to use AgentService and add TaggedAddresses support …
nitin-sachdev-29 Apr 2, 2025
616de64
Document Azure service principal auth in snapshot/agent.mdx (#21942)
SuyashHashiCorp Apr 3, 2025
1af00f7
Fix catalog service endpoint when querying for a peer service (#22189)
jorgemarey Apr 16, 2025
3b44455
Update lock.mdx (Node Health Check and TTL) (#22258)
natemollica-nm Apr 16, 2025
519fb0a
CVE Fix (#22268)
nitin-sachdev-29 Apr 17, 2025
570651a
Upgraded go to 1.23.8 (#22273)
nitin-sachdev-29 Apr 17, 2025
2e8f955
suppressing alpine CVEs as there is no fix yet (#22278)
nitin-sachdev-29 Apr 18, 2025
f3c5d71
feature: Adding configurable value to disable XDS Load balancing
Vikramarjuna Apr 29, 2025
9b63877
Go discover dependency upgrade (#22313)
nitin-sachdev-29 May 5, 2025
3485862
Update iframe to VideoEmbed (#22302)
im2nguyen May 5, 2025
9b9e3f9
Consul Documentation restructure according to IA & content strategy (…
boruszak May 5, 2025
4a3ae1e
feature: add LUA script Envoy extension support for API gateway (#22321)
Vikramarjuna May 9, 2025
1e46394
docs: Lua page fix (#22338)
boruszak May 13, 2025
1256aa5
update: remove 1.15 as LTS, remove1.20 as CE (#22341)
sreeram77 May 14, 2025
eef91f2
Update version compatibility matricies for v1.21.x (#22328)
boruszak May 15, 2025
ee6806d
Merge remote-tracking branch 'origin/main' into docs/compatibility-ma…
boruszak May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/content/api-docs/catalog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,7 @@ The table below shows this endpoint's support for
- `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data.

- `peer` `(string: "")` - Specifies the imported service's peer. Applies only to imported services.
- `peer` `(string: "")` - Specifies the name of the peer that exported the service. Does not apply when no cluster peering connections exist.

- `merge-central-config` - Include this flag in a request for `connect-proxy` kind or `*-gateway` kind
services to return a fully resolved service definition that includes merged values from the
Expand Down
2 changes: 1 addition & 1 deletion website/content/commands/operator/usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Total 3

#### Command Options

- `-all-datacenters` - Display service counts from all known datacenters.
- `-all-datacenters` - Display service counts from all known federated datacenters.
Default is `false`.

- `-billable` - Display only billable service information. Default is `false`.
Expand Down
9 changes: 8 additions & 1 deletion website/content/commands/snapshot/agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,9 +396,16 @@ These options cannot be used when using `backup_destinations` in a config file.
- `-azure-blob-container-name` - Container to use. Required for Azure blob storage, and setting this
disables local storage.

* `-azure-blob-environment` - Environment to use. Defaults to AZUREPUBLICCLOUD. Other valid environments
- `-azure-blob-environment` - Environment to use. Defaults to AZUREPUBLICCLOUD. Other valid environments
are AZURECHINACLOUD, AZUREGERMANCLOUD and AZUREUSGOVERNMENTCLOUD. Introduced in Consul 1.7.3.

~> The following options were introduced in v1.20.1+ent.

- `-azure-blob-service-principal-id` - The ID of the service principal that owns the blob object.
- `-azure-blob-service-principal-secret` - The secret of the service principal that owns the blob object.

- `-azure-blob-tenant-id` - The ID of the tenant that owns the Azure blob.

#### Google Cloud Storage options

~> This option is deprecated when used with a top-level `google_storage` object in a config file. Use `snapshot_agent -> backup_destinations -> google_storage[0]` in a config file instead.
Expand Down
8 changes: 1 addition & 7 deletions website/content/docs/connect/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,7 @@ This page provides an overview of Consul's service mesh features and their confi

## Introduction

<iframe
src="https://www.youtube.com/embed/8T8t4-hQY74"
frameborder="0"
allowfullscreen="true"
width="560"
height="315"
></iframe>
<VideoEmbed url="https://www.youtube.com/embed/8T8t4-hQY74"/>

In addition to the service discovery operations available to the Consul instance
that runs on the same node as your workload, you can use Consul to deploy Envoy
Expand Down
10 changes: 3 additions & 7 deletions website/content/docs/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,9 @@ The core Consul workflow consists of the following stages:

Consul increases application resilience, bolsters uptime, accelerates application deployment, and improves security across service-to-service communications. HashiCorp co-founder and CTO Armon Dadgar explains how Consul solves networking challenges.

<iframe
src="https://www.youtube.com/embed/mxeMdl0KvBI"
frameborder="0"
allowfullscreen="true"
width="560"
height="315"
></iframe>
<VideoEmbed url="https://www.youtube.com/embed/mxeMdl0KvBI"/>

To learn more about Consul and how it compares to similar products, refer to [Consul use cases](/consul/docs/use-case).

To learn more about Consul and how it compares to similar products, refer to [Consul use cases](/consul/docs/use-case).

Expand Down
26 changes: 4 additions & 22 deletions website/content/docs/reference/proxy/envoy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,7 @@ patch releases to ensure users can benefit from bug and security fixes in Envoy.
Unless otherwise noted, rows in the following compatibility table
apply to both Consul Enterprise and Consul community edition (CE).

| Consul Version | Compatible Envoy Versions |
| -------------- | -------------------------------------- |
| 1.20.x CE | 1.31.x, 1.30.x, 1.29.x, 1.28.x |
| 1.19.x CE | 1.29.x, 1.28.x, 1.27.x, 1.26.x |
| 1.18.x CE | 1.28.x, 1.27.x, 1.26.x, 1.25.x |
| 1.17.x | 1.27.x, 1.26.x, 1.25.x, 1.24.x |
| 1.16.x | 1.26.x, 1.25.x, 1.24.x, 1.23.x |
@include 'tables/compatibility/envoy/standard-release.mdx'

#### Enterprise Long Term Support releases

Expand All @@ -73,10 +67,7 @@ Active Consul Enterprise
releases expand their Envoy version compatibility window
until the LTS release reaches its end of maintenance.

| Consul Version | Compatible Envoy Versions |
| -------------- | -----------------------------------------------------------------------------------|
| 1.18.x Ent | 1.29.x, 1.28.x, 1.27.x, 1.26.x, 1.25.x |
| 1.15.x Ent | 1.29.x, 1.28.x, 1.27.x, 1.26.x, 1.25.x, 1.24.x, 1.23.x, 1.22.x |
@include 'tables/compatibility/envoy/lts.mdx'

### Envoy and Consul Dataplane

Expand Down Expand Up @@ -106,13 +97,7 @@ the following differences with Consul dataplane compatibility:
Unless otherwise noted, rows in the following compatibility table
apply to both Consul Enterprise and Consul community edition (CE).

| Consul Version | Default `consul-dataplane` Version | Other compatible `consul-dataplane` Versions |
| -------------- | -------------------------------------|----------------------------------------------|
| 1.20.x CE | 1.6.x (Envoy 1.31.x) | 1.5.x (Envoy 1.29.x) |
| 1.19.x CE | 1.5.x (Envoy 1.29.x) | 1.4.x (Envoy 1.28.x) |
| 1.18.x CE | 1.4.x (Envoy 1.28.x) | 1.3.x (Envoy 1.27.x) |
| 1.17.x | 1.3.x (Envoy 1.27.x) | 1.4.x (Envoy 1.28.x), 1.2.x (Envoy 1.26.x) |
| 1.16.x | 1.2.x (Envoy 1.26.x) | 1.3.x (Envoy 1.27.x), 1.1.x (Envoy 1.25.x) |
@include 'tables/compatibility/consul-dataplane/standard-release.mdx'

#### Enterprise Long Term Support releases

Expand All @@ -121,10 +106,7 @@ Active Consul Enterprise
releases expand their Envoy version compatibility window
until the LTS release reaches its end of maintenance.

| Consul Version | Default `consul-dataplane` Version | Other compatible `consul-dataplane` Versions |
| -------------- | -------------------------------------|----------------------------------------------|
| 1.18.x Ent | 1.4.x (Envoy 1.28.x) | 1.3.x (Envoy 1.27.x) |
| 1.15.x Ent | 1.1.x (Envoy 1.26.x) | 1.4.x (Envoy 1.28.x) - 1.0.x (Envoy 1.24.x) |
@include 'tables/compatibility/consul-dataplane/lts.mdx'

#### Consul dataplane releases that span Envoy major versions

Expand Down
5 changes: 5 additions & 0 deletions website/content/partials/tables/compatibility/consul-dataplane/lts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
| Consul Version | Default `consul-dataplane` Version | Other compatible `consul-dataplane` Versions |
| -------------- | -------------------------------------|----------------------------------------------|
| 1.21.x Ent | 1.7.x (Envoy 1.32.x) | 1.6.x (Envoy 1.31.x) |
| 1.18.x Ent | 1.4.x (Envoy 1.28.x) | 1.3.x (Envoy 1.27.x) |
| 1.15.x Ent | 1.1.x (Envoy 1.26.x) | 1.4.x (Envoy 1.28.x) - 1.0.x (Envoy 1.24.x) |
8 changes: 8 additions & 0 deletions ...ite/content/partials/tables/compatibility/consul-dataplane/standard-release.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
| Consul Version | Default `consul-dataplane` Version | Other compatible `consul-dataplane` Versions |
| -------------- | -------------------------------------|----------------------------------------------|
| 1.21.x CE | 1.7.x (Envoy 1.32.x) | 1.6.x (Envoy 1.31.x) |
| 1.20.x CE | 1.6.x (Envoy 1.31.x) | 1.5.x (Envoy 1.29.x) |
| 1.19.x CE | 1.5.x (Envoy 1.29.x) | 1.4.x (Envoy 1.28.x) |
| 1.18.x CE | 1.4.x (Envoy 1.28.x) | 1.3.x (Envoy 1.27.x) |
| 1.17.x | 1.3.x (Envoy 1.27.x) | 1.4.x (Envoy 1.28.x), 1.2.x (Envoy 1.26.x) |
| 1.16.x | 1.2.x (Envoy 1.26.x) | 1.3.x (Envoy 1.27.x), 1.1.x (Envoy 1.25.x) |
5 changes: 5 additions & 0 deletions website/content/partials/tables/compatibility/envoy/lts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
| Consul Version | Compatible Envoy Versions |
| -------------- | -----------------------------------------------------------------------------------|
| 1.21.x Ent | 1.33.x, 1.32.x, 1.31.x, 1.30.x
| 1.18.x Ent | 1.29.x, 1.28.x, 1.27.x, 1.26.x, 1.25.x |
| 1.15.x Ent | 1.29.x, 1.28.x, 1.27.x, 1.26.x, 1.25.x, 1.24.x, 1.23.x, 1.22.x |
8 changes: 8 additions & 0 deletions website/content/partials/tables/compatibility/envoy/standard-release.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
| Consul Version | Compatible Envoy Versions |
| -------------- | -------------------------------------- |
| 1.21.x CE | 1.33.x, 1.32.x, 1.31.x, 1.30.x |
| 1.20.x CE | 1.31.x, 1.30.x, 1.29.x, 1.28.x |
| 1.19.x CE | 1.29.x, 1.28.x, 1.27.x, 1.26.x |
| 1.18.x CE | 1.28.x, 1.27.x, 1.26.x, 1.25.x |
| 1.17.x | 1.27.x, 1.26.x, 1.25.x, 1.24.x |
| 1.16.x | 1.26.x, 1.25.x, 1.24.x, 1.23.x |
Loading