Skip to content

Commit 21d6730

Browse files
committed
Update PGO upgrade docs
When upgrading to v5.4, Kustomize installations will require deletion of the pgo-upgrade deployment. Issue: [sc-16349]
1 parent 4fcae2a commit 21d6730

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

docs/content/upgrade/helm.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ draft: false
55
weight: 70
66
---
77

8-
Once PGO v5.0.x has been installed with Helm, it can then be upgraded using the `helm upgrade` command.
8+
Once PGO v5 has been installed with Helm, it can then be upgraded using the `helm upgrade` command.
99
However, before running the `upgrade` command, any CustomResourceDefinitions (CRDs) must first be
1010
manually updated (this is specifically due to a [design decision in Helm v3][helm-crd-limits],
1111
in which any CRDs in the Helm chart are only applied when using the `helm install` command).
@@ -33,3 +33,5 @@ Then, perform the upgrade using Helm:
3333
```shell
3434
helm upgrade <name> -n <namespace> helm/install
3535
```
36+
PGO versions earlier than v5.4.0 include a pgo-upgrade deployment. When upgrading to v5.4.x, users
37+
should expect the pgo-upgrade deployment to be deleted automatically.

docs/content/upgrade/kustomize.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ draft: false
55
weight: 50
66
---
77

8+
## Upgrading to v5.4.0 from v5.3.x
9+
10+
Apply the new version of the Kubernetes installer:
11+
12+
```bash
13+
kubectl apply --server-side -k kustomize/install/default
14+
```
15+
16+
PGO versions from 5.1.x through 5.3.x include a pgo-upgrade deployment, which
17+
is no longer needed after upgrading to v5.4.x. Delete the deployment:
18+
19+
```bash
20+
kubectl delete deployment pgo-upgrade
21+
```
22+
823
## Upgrading from PGO v5.0.0 Using Kustomize
924

1025
Starting with PGO v5.0.1, both the Deployment and ServiceAccount created when installing PGO via

0 commit comments

Comments
 (0)