Skip to content

Commit

Permalink
fix(prefect-worker): update docs on setting baseJobTemplate file (#368)
Browse files Browse the repository at this point in the history
* fix(prefect-worker): update docs on setting baseJobTemplate file

* maintainers
  • Loading branch information
parkedwards authored Aug 2, 2024
1 parent da7c9ce commit b1e92db
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 16 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,6 @@ Chart.lock

# macs
.DS_Store

# for private values.yaml files
*.private.y*ml
2 changes: 2 additions & 0 deletions charts/prefect-agent/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ maintainers:
email: [email protected]
- name: parkedwards
email: [email protected]
- name: mitchnielsen
email: [email protected]
name: prefect-agent
sources:
- https://github.com/PrefectHQ/prefect-helm
Expand Down
1 change: 1 addition & 0 deletions charts/prefect-agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Prefect Agent application bundle
| jamiezieziula | <[email protected]> | |
| jimid27 | <[email protected]> | |
| parkedwards | <[email protected]> | |
| mitchnielsen | <[email protected]> | |

## Source Code

Expand Down
2 changes: 2 additions & 0 deletions charts/prefect-server/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ maintainers:
email: [email protected]
- name: parkedwards
email: [email protected]
- name: mitchnielsen
email: [email protected]
name: prefect-server
sources:
- https://github.com/PrefectHQ/prefect-helm
Expand Down
1 change: 1 addition & 0 deletions charts/prefect-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ No secrets are created when providing an existing secret.
| jamiezieziula | <[email protected]> | |
| jimid27 | <[email protected]> | |
| parkedwards | <[email protected]> | |
| mitchnielsen | <[email protected]> | |

## Requirements

Expand Down
2 changes: 2 additions & 0 deletions charts/prefect-worker/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ maintainers:
email: [email protected]
- name: parkedwards
email: [email protected]
- name: mitchnielsen
email: [email protected]
name: prefect-worker
sources:
- https://github.com/PrefectHQ/prefect-helm
Expand Down
22 changes: 7 additions & 15 deletions charts/prefect-worker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,25 +210,17 @@ prefect work-pool get-default-base-job-template --type kubernetes > base-job-tem
3. Install the chart as you usually would, making sure to use the `--set-file` command to pass in the `base-job-template.json` file as a paramater:

```bash
helm install prefect-worker prefect/prefect-worker -f values.yaml --set-file worker.config.baseJobTemplate=base-job-template.json
helm install prefect-worker prefect/prefect-worker -f values.yaml --set-file worker.config.baseJobTemplate.configuration=base-job-template.json
```

#### Updating the Base Job Template

If a base job template is set through Helm (via either `.Values.worker.config.baseJobTemplate.configuration` or `.Values.worker.config.baseJobTemplate.existingConfigMapName`), we'll run an optional `initContainer` that will sync the template configuration to the work pool named in `.Values.worker.config.workPool`.
Any time the base job template is updated, the subsequent `initContainer` run will run `prefect work-pool update <work-pool-name> --base-job-template <template-json>` and sync this template to the API.
Please note that updating JSON inside of a `baseJobTemplate.existingConfigMapName` will require a manual restart of the `prefect-worker` Deployment in order to kick off the `initContainer`. However, updating the `baseJobTemplate.configuration` value will automatically roll the Deployment.
## Maintainers

| Name | Email | Url |
|---------------|-----------------------|-----|
| jamiezieziula | <[email protected]> | |
| jimid27 | <[email protected]> | |
| parkedwards | <[email protected]> | |
| mitchnielsen | <[email protected]> | |
| Name | Email | Url |
| ---- | ------ | --- |
| jamiezieziula | <[email protected]> | |
| jimid27 | <[email protected]> | |
| parkedwards | <[email protected]> | |
| mitchnielsen | <[email protected]> | |

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion charts/prefect-worker/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ prefect work-pool get-default-base-job-template --type kubernetes > base-job-tem
3. Install the chart as you usually would, making sure to use the `--set-file` command to pass in the `base-job-template.json` file as a paramater:

```bash
helm install prefect-worker prefect/prefect-worker -f values.yaml --set-file worker.config.baseJobTemplate=base-job-template.json
helm install prefect-worker prefect/prefect-worker -f values.yaml --set-file worker.config.baseJobTemplate.configuration=base-job-template.json
```

{{ template "chart.maintainersSection" . }}
Expand Down
2 changes: 2 additions & 0 deletions charts/prometheus-prefect-exporter/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ maintainers:
email: [email protected]
- name: parkedwards
email: [email protected]
- name: mitchnielsen
email: [email protected]
name: prometheus-prefect-exporter
sources:
- https://github.com/PrefectHQ/prefect-helm
Expand Down
1 change: 1 addition & 0 deletions charts/prometheus-prefect-exporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Shoutout to @ialejandro for the original work on this chart!
| jamiezieziula | <[email protected]> | |
| jimid27 | <[email protected]> | |
| parkedwards | <[email protected]> | |
| mitchnielsen | <[email protected]> | |

## Requirements

Expand Down

0 comments on commit b1e92db

Please sign in to comment.