Skip to content
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

Backport of docs: Fix broken doc in consul-k8s upgrade page into release/1.15.x #16864

Merged
merged 1 commit into from
Apr 3, 2023
Merged

Backport of docs: Fix broken doc in consul-k8s upgrade page into release/1.15.x #16864

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions website/content/docs/k8s/upgrade/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ For example, if you installed Consul with `connectInject.enabled: false` and you
```

**Before performing the upgrade, be sure you read the other sections on this page,
continuing at [Determining What Will Change](#determining-what-will-change).**
continuing at [Determine scope of changes](#determine-scope-of-changes).**

~> Note: You should always set the `--version` flag when upgrading Helm. Otherwise Helm uses the most up-to-date version in its local cache, which may result in an unintended upgrade.
~> Note: You should always set the `--version` flag when upgrading Helm. Otherwise, Helm uses the most up-to-date version in its local cache, which may result in an unintended upgrade.

### Upgrade Helm chart version

Expand Down Expand Up @@ -87,7 +87,7 @@ If you want to upgrade to the latest `0.40.0` version, use the following procedu
```

**Before performing the upgrade, be sure you've read the other sections on this page,
continuing at [Determining What Will Change](#determining-what-will-change).**
continuing at [Determine scope of changes](#determine-scope-of-changes).**

### Upgrade Consul version

Expand Down Expand Up @@ -126,9 +126,9 @@ to update to the new version. Before you upgrade to a new version:
```

**Before performing the upgrade, be sure you have read the other sections on this page,
continuing at [Determining What Will Change](#determining-what-will-change).**
continuing at [Determine scope of changes](#determine-scope-of-changes).**

~> Note: You should always set the `--version` flag when upgrading Helm. Otherwise Helm uses the most up-to-date version in its local cache, which may result in an unintended upgrade.
~> Note: You should always set the `--version` flag when upgrading Helm. Otherwise, Helm uses the most up-to-date version in its local cache, which may result in an unintended upgrade.

## Determine scope of changes

Expand Down Expand Up @@ -175,7 +175,7 @@ that can be used.
Initiate the server upgrade:

1. Change the `global.image` value to the desired Consul version.
1. Set the `server.updatePartition` value to the number of server replicas. By default there are 3 servers, so you would set this value to `3`.
1. Set the `server.updatePartition` value to the number of server replicas. By default, there are 3 servers, so you would set this value to `3`.
1. Set the `updateStrategy` for clients to `OnDelete`.

<CodeBlockConfig filename="values.yaml">
Expand Down Expand Up @@ -228,15 +228,15 @@ If you upgrade Consul from a version that uses client agents to a version the us
type: OnDelete
```

1. Add `consul.hashicorp.com/consul-k8s-version: 1.0.0` to the annotations for each pod you upgrade.
1. Add `consul.hashicorp.com/consul-k8s-version: 1.0.0` to the annotations for each pod you upgrade.

1. Follow our [recommended procedures to upgrade servers](#upgrading-consul-servers) on Kubernetes deployments to upgrade Helm values for the new version of Consul.

1. Run `kubectl rollout restart` to restart your service mesh applications. Restarting service mesh application causes Kubernetes to re-inject them with the webhook for dataplanes.

1. Restart all gateways in your service mesh.

1. Disable client agents in your Helm chart by deleting the `client` stanza or setting `client.enabled` to `false`.
1. Disable client agents in your Helm chart by deleting the `client` stanza or setting `client.enabled` to `false`.

## Configuring TLS on an existing cluster

Expand Down