Skip to content

Commit

Permalink
chore(docs): add upgrade guide for prefect-server (#431)
Browse files Browse the repository at this point in the history
* chore(docs): add upgrade guide for prefect-server

* link
  • Loading branch information
parkedwards authored Jan 28, 2025
1 parent 011ea67 commit 966c737
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions charts/prefect-server/UPGRADING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Upgrade guidelines

## > 2025.1.23213604

After version `2025.1.23213604`, the `prefect-server` chart [introduces the option to run background services as a separate deployment](https://github.com/PrefectHQ/prefect-helm/pull/425). Due to the numerous shared values between the `server` and `background-services` deployments, the `values.yaml` file has been consolidated in the following ways:

### Introduction of `global.prefect` key in `values.yaml`

`.Values.global.prefect` will contain shared configurations, many of which used to live under `.Values.server`, specifically:

- `.Values.server.image` => `.Values.global.prefect.image`
- `.Values.server.prefectApiUrl` => `.Values.global.prefect.prefectApiUrl`
- `.Values.server.prefectApiHost` => `.Values.global.prefect.prefectApiHost`

**Before**

```yaml
server:
image:
repository: prefecthq/prefect
prefectTag: 3-latest
pullPolicy: IfNotPresent
pullSecrets: []
prefectApiUrl: http://localhost:4200/api
prefectApiHost: 0.0.0.0
```
**After**
```yaml
global:
prefect:
image:
repository: prefecthq/prefect
prefectTag: 3-latest
pullPolicy: IfNotPresent
pullSecrets: []
prefectApiUrl: http://localhost:4200/api
prefectApiHost: 0.0.0.0
```

0 comments on commit 966c737

Please sign in to comment.