chore(docs): document how to set imagePullSecrets in baseJobTemplate #446
Conversation
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
Documents how to set imagePullSecrets in the baseJobTemplate. Will be expanded as part of https://linear.app/prefect/issue/PLA-1020/expand-documentation-on-how-to-use-basejobtemplate Closes https://linear.app/prefect/issue/PLA-1029/document-how-to-set-image-pull-secrets-in-the-base-job-template
'.Values' is how values are referenced from within Helm templates, not how end users set it.
mitchnielsen
commented
Feb 10, 2025
charts/prefect-worker/README.md
Outdated
Comment on lines
259
to
268
| "spec": { | ||
| "template": { | ||
| "spec": { | ||
| "imagePullSecrets": [ | ||
| { | ||
| "name": "my-pull-secret" | ||
| } | ||
| ] | ||
| } | ||
| } |
There was a problem hiding this comment.
$ k explain deployment.spec.template.spec.imagePullSecrets
GROUP: apps
KIND: Deployment
VERSION: v1
FIELD: imagePullSecrets <[]LocalObjectReference>
DESCRIPTION:
ImagePullSecrets is an optional list of references to secrets in the same
namespace to use for pulling any of the images used by this PodSpec. If
specified, these secrets will be passed to individual puller implementations
for them to use. More info:
https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
FIELDS:
name <string>
Name of the referent. This field is effectively required, but due to
backwards compatibility is allowed to be empty. Instances of this type with
an empty value here are almost certainly wrong. More info:
https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
mitchnielsen
commented
Feb 11, 2025
|
|
||
| 1. Define the base job template in a local file. To get a formatted template, run the following command & store locally in `base-job-template.json` | ||
| **Note**: if the target work pool (`config.workPool`) already exists, the base job template passed **will be ignored**. |
There was a problem hiding this comment.
Is this definitely true? In my testing, I was able to modify the base job template and each time it would update the configuration seen in the UI - even though I created the work pool before attaching the worker.
There was a problem hiding this comment.
hm good question. it is true i think - but maybe with the addition of the init container it is no longer true for our helm charts.
There was a problem hiding this comment.
I bet that's it, since we're directly using prefect work-pool update <json-file> now. I'll remove that warning.
Now that we have the initContainer that calls `prefect work-pool update`, updates are indeed respected.
jamiezieziula
approved these changes
Feb 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Documents how to set imagePullSecrets in the baseJobTemplate.
Will be expanded as part of https://linear.app/prefect/issue/PLA-1020/expand-documentation-on-how-to-use-basejobtemplate
Closes https://linear.app/prefect/issue/PLA-1029/document-how-to-set-image-pull-secrets-in-the-base-job-template
Testing
I installed the
prefect-serverchart, and then deployed theprefect-workerchart with this config:I then confirmed the configuration appeared as expected in the UI.