From 9d049412efdbe12b163dd6190259aab50e7186b0 Mon Sep 17 00:00:00 2001 From: Edward Park Date: Fri, 2 Aug 2024 10:42:35 -0700 Subject: [PATCH 1/2] fix(prefect-worker): update docs on setting baseJobTemplate file --- .gitignore | 3 +++ charts/prefect-worker/README.md | 21 ++++++--------------- charts/prefect-worker/README.md.gotmpl | 2 +- 3 files changed, 10 insertions(+), 16 deletions(-) diff --git a/.gitignore b/.gitignore index 5f2c7a3c..c5035b06 100644 --- a/.gitignore +++ b/.gitignore @@ -122,3 +122,6 @@ Chart.lock # macs .DS_Store + +# for private values.yaml files +*.private.y*ml diff --git a/charts/prefect-worker/README.md b/charts/prefect-worker/README.md index 781db02c..a7d51f05 100644 --- a/charts/prefect-worker/README.md +++ b/charts/prefect-worker/README.md @@ -210,25 +210,16 @@ 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 --base-job-template ` 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 | | | -| jimid27 | | | -| parkedwards | | | -| mitchnielsen | | | +| Name | Email | Url | +| ---- | ------ | --- | +| jamiezieziula | | | +| jimid27 | | | +| parkedwards | | | ## Requirements diff --git a/charts/prefect-worker/README.md.gotmpl b/charts/prefect-worker/README.md.gotmpl index 383cebdd..780193ec 100644 --- a/charts/prefect-worker/README.md.gotmpl +++ b/charts/prefect-worker/README.md.gotmpl @@ -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" . }} From df1a53a900aa5be577d02133afcbdb7adcd75279 Mon Sep 17 00:00:00 2001 From: Edward Park Date: Fri, 2 Aug 2024 10:44:48 -0700 Subject: [PATCH 2/2] maintainers --- charts/prefect-agent/Chart.yaml | 2 ++ charts/prefect-agent/README.md | 1 + charts/prefect-server/Chart.yaml | 2 ++ charts/prefect-server/README.md | 1 + charts/prefect-worker/Chart.yaml | 2 ++ charts/prefect-worker/README.md | 1 + charts/prometheus-prefect-exporter/Chart.yaml | 2 ++ charts/prometheus-prefect-exporter/README.md | 1 + 8 files changed, 12 insertions(+) diff --git a/charts/prefect-agent/Chart.yaml b/charts/prefect-agent/Chart.yaml index 16fde756..e894541d 100644 --- a/charts/prefect-agent/Chart.yaml +++ b/charts/prefect-agent/Chart.yaml @@ -16,6 +16,8 @@ maintainers: email: jimi@prefect.io - name: parkedwards email: edward@prefect.io + - name: mitchnielsen + email: mitchell@prefect.io name: prefect-agent sources: - https://github.com/PrefectHQ/prefect-helm diff --git a/charts/prefect-agent/README.md b/charts/prefect-agent/README.md index e8858b4c..1f2db926 100644 --- a/charts/prefect-agent/README.md +++ b/charts/prefect-agent/README.md @@ -13,6 +13,7 @@ Prefect Agent application bundle | jamiezieziula | | | | jimid27 | | | | parkedwards | | | +| mitchnielsen | | | ## Source Code diff --git a/charts/prefect-server/Chart.yaml b/charts/prefect-server/Chart.yaml index ee604abb..3a579bb6 100644 --- a/charts/prefect-server/Chart.yaml +++ b/charts/prefect-server/Chart.yaml @@ -20,6 +20,8 @@ maintainers: email: jimi@prefect.io - name: parkedwards email: edward@prefect.io + - name: mitchnielsen + email: mitchell@prefect.io name: prefect-server sources: - https://github.com/PrefectHQ/prefect-helm diff --git a/charts/prefect-server/README.md b/charts/prefect-server/README.md index e2aeb2a5..70a339bd 100644 --- a/charts/prefect-server/README.md +++ b/charts/prefect-server/README.md @@ -101,6 +101,7 @@ No secrets are created when providing an existing secret. | jamiezieziula | | | | jimid27 | | | | parkedwards | | | +| mitchnielsen | | | ## Requirements diff --git a/charts/prefect-worker/Chart.yaml b/charts/prefect-worker/Chart.yaml index 147d54d4..56b7bbfd 100644 --- a/charts/prefect-worker/Chart.yaml +++ b/charts/prefect-worker/Chart.yaml @@ -16,6 +16,8 @@ maintainers: email: jimi@prefect.io - name: parkedwards email: edward@prefect.io + - name: mitchnielsen + email: mitchell@prefect.io name: prefect-worker sources: - https://github.com/PrefectHQ/prefect-helm diff --git a/charts/prefect-worker/README.md b/charts/prefect-worker/README.md index a7d51f05..b50a68ec 100644 --- a/charts/prefect-worker/README.md +++ b/charts/prefect-worker/README.md @@ -220,6 +220,7 @@ helm install prefect-worker prefect/prefect-worker -f values.yaml --set-file wor | jamiezieziula | | | | jimid27 | | | | parkedwards | | | +| mitchnielsen | | | ## Requirements diff --git a/charts/prometheus-prefect-exporter/Chart.yaml b/charts/prometheus-prefect-exporter/Chart.yaml index 7ab0d9ef..458a64ff 100644 --- a/charts/prometheus-prefect-exporter/Chart.yaml +++ b/charts/prometheus-prefect-exporter/Chart.yaml @@ -17,6 +17,8 @@ maintainers: email: jimi@prefect.io - name: parkedwards email: edward@prefect.io + - name: mitchnielsen + email: mitchell@prefect.io name: prometheus-prefect-exporter sources: - https://github.com/PrefectHQ/prefect-helm diff --git a/charts/prometheus-prefect-exporter/README.md b/charts/prometheus-prefect-exporter/README.md index 3a402baf..192d23af 100644 --- a/charts/prometheus-prefect-exporter/README.md +++ b/charts/prometheus-prefect-exporter/README.md @@ -48,6 +48,7 @@ Shoutout to @ialejandro for the original work on this chart! | jamiezieziula | | | | jimid27 | | | | parkedwards | | | +| mitchnielsen | | | ## Requirements