Skip to content

Add upgrade warnings #19061

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
kisunji merged 2 commits into from
Oct 4, 2023
Merged

Add upgrade warnings #19061

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebdb3f1
Add upgrade warnings
Oct 4, 2023
86ff649
PR feedback
Oct 4, 2023
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
22 changes: 22 additions & 0 deletions website/content/docs/upgrading/upgrade-specific.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ After Consul 1.17.0, only timestamps will be included in rotated log file names.

## Consul 1.16.x

#### Vault Enterprise as CA

@jkirschner-hashicorp jkirschner-hashicorp Oct 4, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should add to KNOWN ISSUES in the changelog

The changelog content can link to the applicable upgrade guidance section in our docs (here) once published.

The changelog PR can be separate (since it won't be backported in any way).

Using Vault as CA with Consul version 1.16.2 will fail to initialize the CA if [`namespace`](/consul/docs/connect/ca/vault#namespace) is set
but [`intermediate_pki_namespace`](/consul/docs/connect/ca/vault#intermediatepkinamespace) or [`root_pki_namespace`](/consul/docs/connect/ca/vault#rootpkinamespace)
are empty. This is a bug which will be fixed in a future version.
To work around this issue, users must explicitly set [`intermediate_pki_namespace`](/consul/docs/connect/ca/vault#intermediatepkinamespace) and
Comment thread
kisunji marked this conversation as resolved.
[`root_pki_namespace`](/consul/docs/connect/ca/vault#rootpkinamespace) to the same value as [`namespace`](/consul/docs/connect/ca/vault#namespace).

#### Known issues

Service mesh in Consul versions 1.16.0 and 1.16.1 may have issues when a snapshot restore is performed and the servers are hosting xDS streams.
Expand All @@ -44,6 +51,14 @@ This change removes the backward-compatibility behavior introduced in Consul 1.1

## Consul 1.15.x

#### Vault Enterprise as CA
Using Vault as CA with Consul version 1.15.6 will fail to initialize the CA if [`namespace`](/consul/docs/connect/ca/vault#namespace) is set
but [`intermediate_pki_namespace`](/consul/docs/connect/ca/vault#intermediatepkinamespace) or [`root_pki_namespace`](/consul/docs/connect/ca/vault#rootpkinamespace)
are empty. This is a bug which will be fixed in a future version.

Comment thread
kisunji marked this conversation as resolved.
Outdated
To work around this issue, users must explicitly set [`intermediate_pki_namespace`](/consul/docs/connect/ca/vault#intermediatepkinamespace) and
[`root_pki_namespace`](/consul/docs/connect/ca/vault#rootpkinamespace) to the same value as [`namespace`](/consul/docs/connect/ca/vault#namespace).

#### Service mesh compatibility ((#service-mesh-compatibility-1-15))

Upgrade to **Consul version 1.15.2 or later**.

@jkirschner-hashicorp jkirschner-hashicorp Oct 4, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do these all belong within a "service mesh compatibility" section (like exists for 1.15 and 1.14)?

And would it affect our upgrade guidance here? Like ... upgrade to Consul 1.15.2 or later, but avoid 1.15.6 if [using Vault Enterprise as a CA](link to anchor tag).

@kisunji kisunji Oct 4, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved around the sections so they fall under "service mesh compatibility" except for 1.16 which didn't have the section.

Expand Down Expand Up @@ -176,6 +191,13 @@ In Consul v1.15 and higher:

## Consul 1.14.x

#### Vault Enterprise as CA
Using Vault as CA with Consul version 1.14.10 will fail to initialize the CA if [`namespace`](/consul/docs/connect/ca/vault#namespace) is set
but [`intermediate_pki_namespace`](/consul/docs/connect/ca/vault#intermediatepkinamespace) or [`root_pki_namespace`](/consul/docs/connect/ca/vault#rootpkinamespace)
are empty. This is a bug which will be fixed in a future version.
To work around this issue, users must explicitly set [`intermediate_pki_namespace`](/consul/docs/connect/ca/vault#intermediatepkinamespace) and
[`root_pki_namespace`](/consul/docs/connect/ca/vault#rootpkinamespace) to the same value as [`namespace`](/consul/docs/connect/ca/vault#namespace).

### Service Mesh Compatibility
Prior to Consul 1.14, cluster peering and Consul service mesh were disabled by default.
A breaking change was made in Consul 1.14 that:
Expand Down