-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(prefect-worker): update docs on setting baseJobTemplate file (#368)
* fix(prefect-worker): update docs on setting baseJobTemplate file * maintainers
- Loading branch information
1 parent
da7c9ce
commit b1e92db
Showing
10 changed files
with
22 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -122,3 +122,6 @@ Chart.lock | |
|
||
# macs | ||
.DS_Store | ||
|
||
# for private values.yaml files | ||
*.private.y*ml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,6 +13,7 @@ Prefect Agent application bundle | |
| jamiezieziula | <[email protected]> | | | ||
| jimid27 | <[email protected]> | | | ||
| parkedwards | <[email protected]> | | | ||
| mitchnielsen | <[email protected]> | | | ||
|
||
## Source Code | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|