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

Jump to bottom

[docs] Updating Kubernetes upgrade instruction #25286

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

[docs] Updating Kubernetes upgrade instruction #25286

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ecae6bb
[docs] Updating kubernetes upgrade instruction
framsouza Feb 8, 2024
579d3f9
Fixing code block
framsouza Feb 8, 2024
47db805
Merge branch 'main' into docs-fix-k8s-upgrade
peteski22 Mar 13, 2024
4cb538c
Update website/content/docs/platform/k8s/helm/run.mdx
framsouza Apr 16, 2024
88fc01c
Merge branch 'main' into docs-fix-k8s-upgrade
framsouza Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 20 additions & 1 deletion website/content/docs/platform/k8s/helm/run.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,26 @@ running:
$ kubectl delete pod <name of Vault pod>
```

If Vault is deployed using `ha` mode, the standby pods must be upgraded first.

If you deployed Vault in high availability (`ha`) mode, you must upgrade your
standby pods before upgrading the active pod.

Before deleting the standby pod, remove the associated node from the raft with
`vault operator raft remove-peer <server_id>`.

To confirm that the node was successfully removed from Raft, run
`vault operator raft list-peers`.

Once you confirm the removal succeeded, you can delete the pod.

<Warning title="Delete nodes to avoid unnecessary leader elections">

Removing a pod without deleting the node from its cluster first means that the
number of nodes Raft
will be unaware of the correct number of nodes in the cluster. This can trigger a leader election, potentially causing downtime.
Comment on lines +453 to +455
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Removing a pod without deleting the node from its cluster first means that the
number of nodes Raft
will be unaware of the correct number of nodes in the cluster. This can trigger a leader election, potentially causing downtime.
Removing a pod without first deleting the node from its cluster means that
Raft will be aware of the correct number of nodes in the cluster. Not knowing
the correct number of nodes can trigger a leader election, which can potentially
cause unneeded downtime.

Style correction: writein active voice, avoid "this" as a pronoun


</Warning>

Vault has K8s service discovery built in (when enabled in the server configuration) and
will automatically change the labels of the pod with its current leader status. These labels
can be used to filter the pods.
Expand Down